FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
ssvm.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __included_ssvm_h__
16 #define __included_ssvm_h__
17 
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <sys/types.h>
21 #include <sys/mman.h>
22 #include <sys/stat.h>
23 #include <netinet/in.h>
24 #include <signal.h>
25 #include <pthread.h>
26 #include <unistd.h>
27 #include <time.h>
28 #include <fcntl.h>
29 #include <string.h>
30 #include <vppinfra/clib.h>
31 #include <vppinfra/vec.h>
32 #include <vppinfra/hash.h>
33 #include <vppinfra/bitmap.h>
34 #include <vppinfra/fifo.h>
35 #include <vppinfra/time.h>
36 #include <vppinfra/mheap.h>
37 #include <vppinfra/heap.h>
38 #include <vppinfra/pool.h>
39 #include <vppinfra/format.h>
40 
41 #define MMAP_PAGESIZE (4<<10)
42 #define SSVM_N_OPAQUE 7
43 
44 typedef struct
45 {
46  /* Spin-lock */
47  volatile u32 lock;
48  volatile u32 owner_pid;
50  u32 tag; /* for debugging */
51 
52  /* The allocation arena */
53  void *heap;
54 
55  /* Segment must be mapped at this address, or no supper */
57  /* The actual mmap size */
61  u8 *name;
62  void *opaque[SSVM_N_OPAQUE];
63 
64  /* Set when the master application thinks it's time to make the donuts */
65  volatile u32 ready;
66 
67  /* Needed to make unique MAC addresses, etc. */
70 
71 typedef struct
72 {
77  u8 *name;
83 
84 always_inline void
86 {
87  if (h->owner_pid == my_pid)
88  {
89  h->recursion_count++;
90  return;
91  }
92 
93  while (__sync_lock_test_and_set (&h->lock, 1))
94  ;
95 
96  h->owner_pid = my_pid;
97  h->recursion_count = 1;
98  h->tag = tag;
99 }
100 
101 always_inline void
103 {
104  if (--h->recursion_count == 0)
105  {
106  h->owner_pid = 0;
107  h->tag = 0;
109  h->lock = 0;
110  }
111 }
112 
113 static inline void *
115 {
116  u8 *oldheap;
117  oldheap = clib_mem_set_heap (sh->heap);
118  return ((void *) oldheap);
119 }
120 
121 static inline void
122 ssvm_pop_heap (void *oldheap)
123 {
124  clib_mem_set_heap (oldheap);
125 }
126 
127 #define foreach_ssvm_api_error \
128 _(NO_NAME, "No shared segment name", -10) \
129 _(NO_SIZE, "Size not set (master)", -11) \
130 _(CREATE_FAILURE, "Create failed", -12) \
131 _(SET_SIZE, "Set size failed", -13) \
132 _(MMAP, "mmap failed", -14) \
133 _(SLAVE_TIMEOUT, "Slave map timeout", -15)
134 
135 typedef enum
136 {
137 #define _(n,s,c) SSVM_API_ERROR_##n = c,
139 #undef _
141 
142 #define SSVM_API_ERROR_NO_NAME (-10)
143 
144 int ssvm_master_init (ssvm_private_t * ssvm, u32 master_index);
145 int ssvm_slave_init (ssvm_private_t * ssvm, int timeout_in_seconds);
146 
147 #endif /* __included_ssvm_h__ */
148 
149 /*
150  * fd.io coding-style-patch-verification: ON
151  *
152  * Local Variables:
153  * eval: (c-set-style "gnu")
154  * End:
155  */
u64 ssvm_size
Definition: ssvm.h:74
int ssvm_master_init(ssvm_private_t *ssvm, u32 master_index)
Definition: ssvm.c:18
uword requested_va
Definition: ssvm.h:78
u32 vlib_hw_if_index
Definition: ssvm.h:76
volatile u32 ready
Definition: ssvm.h:65
ssvm_api_error_enum_t
Definition: ssvm.h:135
Fixed length block allocator.
volatile u32 lock
Definition: ssvm.h:47
int ssvm_slave_init(ssvm_private_t *ssvm, int timeout_in_seconds)
Definition: ssvm.c:104
ssvm_shared_header_t * sh
Definition: ssvm.h:73
#define always_inline
Definition: clib.h:84
static void * ssvm_push_heap(ssvm_shared_header_t *sh)
Definition: ssvm.h:114
unsigned long u64
Definition: types.h:89
static void ssvm_pop_heap(void *oldheap)
Definition: ssvm.h:122
#define foreach_ssvm_api_error
Definition: ssvm.h:127
static void ssvm_unlock(ssvm_shared_header_t *h)
Definition: ssvm.h:102
#define SSVM_N_OPAQUE
Definition: ssvm.h:42
u32 per_interface_next_index
Definition: ssvm.h:80
u32 * rx_queue
Definition: ssvm.h:81
static void * clib_mem_set_heap(void *heap)
Definition: mem.h:223
u32 my_pid
Definition: ssvm.h:75
unsigned int u32
Definition: types.h:88
Bitmaps built as vectors of machine words.
u8 * name
Definition: ssvm.h:77
u64 uword
Definition: types.h:112
unsigned char u8
Definition: types.h:56
volatile u32 owner_pid
Definition: ssvm.h:48
#define CLIB_MEMORY_BARRIER()
Definition: clib.h:101
int recursion_count
Definition: ssvm.h:49
int i_am_master
Definition: ssvm.h:79
static void ssvm_lock(ssvm_shared_header_t *h, u32 my_pid, u32 tag)
Definition: ssvm.h:85
CLIB vectors are ubiquitous dynamically resized arrays with by user defined "headers".