vlib-api/vlibmemory/unix_shared_memory_queue.h

   1 /*
   2  *------------------------------------------------------------------
   3  * unix_shared_memory_queue.h - shared-memory queues
   4  *
   5  * Copyright (c) 2009 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #ifndef included_unix_shared_memory_queue_h
  21 #define included_unix_shared_memory_queue_h
  22
  23 #include <pthread.h>
  24 #include <vppinfra/mem.h>
  25
  26 typedef struct _unix_shared_memory_queue {
  27     pthread_mutex_t mutex;      /* 8 bytes */
  28     pthread_cond_t condvar;     /* 8 bytes */
  29     int head;
  30     int tail;
  31     int cursize;
  32     int maxsize;
  33     int elsize;
  34     int consumer_pid;
  35     int signal_when_queue_non_empty;
  36     char data[0];
  37 } unix_shared_memory_queue_t;
  38
  39 unix_shared_memory_queue_t *
  40 unix_shared_memory_queue_init(int nels,
  41                               int elsize,
  42                               int consumer_pid,
  43                               int signal_when_queue_non_empty);
  44 void unix_shared_memory_queue_free(unix_shared_memory_queue_t *q);
  45 int unix_shared_memory_queue_add (unix_shared_memory_queue_t *q,
  46                                   u8 *elem, int nowait);
  47 int unix_shared_memory_queue_sub(unix_shared_memory_queue_t *q,
  48                                  u8 *elem, int nowait);
  49 void unix_shared_memory_queue_lock (unix_shared_memory_queue_t *q);
  50 void unix_shared_memory_queue_unlock (unix_shared_memory_queue_t *q);
  51 int unix_shared_memory_queue_is_full (unix_shared_memory_queue_t *q);
  52 int unix_shared_memory_queue_add_nolock (unix_shared_memory_queue_t *q,
  53                                          u8 *elem);
  54
  55 int unix_shared_memory_queue_sub_raw (unix_shared_memory_queue_t *q,
  56                                       u8 *elem);
  57 int unix_shared_memory_queue_add_raw (unix_shared_memory_queue_t *q,
  58                                       u8 *elem);
  59
  60 #endif /* included_unix_shared_memory_queue_h */