2 *------------------------------------------------------------------
3 * svm.h - shared VM allocation, mmap(...MAP_FIXED...)
6 * Copyright (c) 2009 Cisco and/or its affiliates.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at:
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *------------------------------------------------------------------
21 #ifndef __included_svm_h__
22 #define __included_svm_h__
25 #include <vppinfra/clib.h>
26 #include <vppinfra/mem.h>
28 #define MMAP_PAGESIZE (clib_mem_get_page_size())
30 #define SVM_VERSION ((1<<16) | 1) /* set to declare region ready. */
32 #define SVM_FLAGS_MHEAP (1<<0) /* region contains an mheap */
33 #define SVM_FLAGS_FILE (1<<1) /* region backed by one or more files */
34 #define SVM_FLAGS_NODATA (1<<2) /* region will be further subdivided */
35 #define SVM_FLAGS_NEED_DATA_INIT (1<<3)
37 #define SVM_PVT_MHEAP_SIZE (128<<10) /* region's private mheap (128k) */
39 typedef struct svm_region_
41 volatile uword version;
42 pthread_mutex_t mutex;
43 pthread_cond_t condvar;
44 int mutex_owner_pid; /* in case of trouble */
47 uword virtual_base; /* base of the region object */
50 void *data_base; /* data portion base address */
51 void *data_heap; /* data heap, if any */
52 volatile void *user_ctx; /* user context pointer */
53 /* stuff allocated in the region's heap */
54 uword bitmap_size; /* nbits in virtual alloc bitmap */
55 uword *bitmap; /* the bitmap */
63 * (64K) clib heap for the region itself
65 * data_base -> whatever is in this region
70 typedef struct svm_map_region_args_
72 char *root_path; /* NULL means use the truly global arena */
79 uword backing_mmap_size;
80 /* uid, gid to own the svm region(s) */
83 } svm_map_region_args_t;
87 * Memory shared across all router instances. Packet buffers, etc
88 * Base should be "out of the way," and size should be big enough to
89 * cover everything we plan to put here.
91 #define SVM_GLOBAL_REGION_BASEVA 0x30000000
92 #define SVM_GLOBAL_REGION_SIZE (64<<20)
93 #define SVM_GLOBAL_REGION_NAME "/global_vm"
96 * Memory shared across individual router instances.
98 #define SVM_OVERLAY_REGION_BASEVA \
99 (SVM_GLOBAL_REGION_BASEVA + SVM_GLOBAL_REGION_SIZE)
100 #define SVM_OVERLAY_REGION_SIZE (1<<20)
101 #define SVM_OVERLAY_REGION_BASENAME "/overlay_vm"
110 svm_subregion_t *subregions; /* subregion pool */
116 void *svm_region_find_or_create (svm_map_region_args_t * a);
117 void svm_region_init (void);
118 void svm_region_init_chroot (char *root_path);
119 void svm_region_init_chroot_uid_gid (char *root_path, int uid, int gid);
120 void svm_region_init_args (svm_map_region_args_t * a);
121 void svm_region_exit (void);
122 void svm_region_unmap (void *rp_arg);
123 void svm_client_scan (char *root_path);
124 void svm_client_scan_this_region_nolock (svm_region_t * rp);
125 u8 *shm_name_from_svm_map_region_args (svm_map_region_args_t * a);
128 svm_mem_alloc (svm_region_t * rp, uword size)
131 ASSERT (rp->flags & SVM_FLAGS_MHEAP);
134 pthread_mutex_lock (&rp->mutex);
135 oldheap = clib_mem_set_heap (rp->data_heap);
136 rv = clib_mem_alloc (size);
137 clib_mem_set_heap (oldheap);
138 pthread_mutex_unlock (&rp->mutex);
143 svm_mem_alloc_aligned_at_offset (svm_region_t * rp,
144 uword size, uword align, uword offset)
147 ASSERT (rp->flags & SVM_FLAGS_MHEAP);
150 pthread_mutex_lock (&rp->mutex);
151 oldheap = clib_mem_set_heap (rp->data_heap);
152 rv = clib_mem_alloc_aligned_at_offset (size, align, offset);
153 clib_mem_set_heap (oldheap);
154 pthread_mutex_unlock (&rp->mutex);
159 svm_mem_free (svm_region_t * rp, void *ptr)
162 ASSERT (rp->flags & SVM_FLAGS_MHEAP);
164 pthread_mutex_lock (&rp->mutex);
165 oldheap = clib_mem_set_heap (rp->data_heap);
167 clib_mem_set_heap (oldheap);
168 pthread_mutex_unlock (&rp->mutex);
173 svm_push_pvt_heap (svm_region_t * rp)
176 oldheap = clib_mem_set_heap (rp->region_heap);
177 return ((void *) oldheap);
181 svm_push_data_heap (svm_region_t * rp)
184 oldheap = clib_mem_set_heap (rp->data_heap);
185 return ((void *) oldheap);
189 svm_pop_heap (void *oldheap)
191 clib_mem_set_heap (oldheap);
194 u8 *format_svm_region (u8 * s, va_list * args);
196 svm_region_t *svm_get_root_rp (void);
198 #endif /* __included_svm_h__ */
201 * fd.io coding-style-patch-verification: ON
204 * eval: (c-set-style "gnu")