2 *------------------------------------------------------------------
3 * Copyright (c) 2009 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #ifndef __included_svm_common_h__
19 #define __included_svm_common_h__
24 #include <vppinfra/types.h>
26 #define SVM_VERSION ((1<<16) | 1) /* set to declare region ready. */
28 #define SVM_FLAGS_MHEAP (1<<0) /* region contains an mheap */
29 #define SVM_FLAGS_FILE (1<<1) /* region backed by one or more files */
30 #define SVM_FLAGS_NODATA (1<<2) /* region will be further subdivided */
31 #define SVM_FLAGS_NEED_DATA_INIT (1<<3)
33 #define SVM_PVT_MHEAP_SIZE (128<<10) /* region's private mheap (128k) */
35 typedef struct svm_region_
37 volatile uword version;
38 pthread_mutex_t mutex;
39 pthread_cond_t condvar;
40 int mutex_owner_pid; /* in case of trouble */
43 uword virtual_base; /* base of the region object */
46 void *data_base; /* data portion base address */
47 void *data_heap; /* data heap, if any */
48 volatile void *user_ctx; /* user context pointer */
49 /* stuff allocated in the region's heap */
50 uword bitmap_size; /* nbits in virtual alloc bitmap */
51 uword *bitmap; /* the bitmap */
59 * (64K) clib heap for the region itself
61 * data_base -> whatever is in this region
66 typedef struct svm_map_region_args_
68 const char *root_path; /* NULL means use the truly global arena */
75 uword backing_mmap_size;
76 /* uid, gid to own the svm region(s) */
79 } svm_map_region_args_t;
82 * Memory mapped to high addresses for session/vppcom/vcl/etc...
85 #ifdef CLIB_SANITIZE_ADDR
86 #define HIGH_SEGMENT_BASEVA 0x300000000000 /* DO NOT CHANGE THIS: YOU'LL BREAK ASAN */
87 #else /* CLIB_SANITIZE_ADDR */
88 #define HIGH_SEGMENT_BASEVA (128ULL << 30) /* 128GB */
89 #endif /* CLIB_SANITIZE_ADDR */
90 #elif __WORDSIZE == 32
91 #define HIGH_SEGMENT_BASEVA (3584UL << 20) /* 3.5GB */
93 #error "unknown __WORDSIZE"
97 * Memory shared across all router instances. Packet buffers, etc
98 * Base should be "out of the way," and size should be big enough to
99 * cover everything we plan to put here.
101 #define SVM_GLOBAL_REGION_SIZE (64<<20)
102 #define SVM_GLOBAL_REGION_NAME "/global_vm"
103 u64 svm_get_global_region_base_va ();
106 * Memory shared across individual router instances.
108 #define SVM_OVERLAY_REGION_BASEVA \
109 (SVM_GLOBAL_REGION_BASEVA + SVM_GLOBAL_REGION_SIZE)
110 #define SVM_OVERLAY_REGION_SIZE (1<<20)
111 #define SVM_OVERLAY_REGION_BASENAME "/overlay_vm"
120 svm_subregion_t *subregions; /* subregion pool */
128 void *svm_region_find_or_create (svm_map_region_args_t * a);
129 void svm_region_init (void);
130 void svm_region_init_mapped_region (svm_map_region_args_t * a,
132 int svm_region_init_chroot (const char *root_path);
133 void svm_region_init_chroot_uid_gid (const char *root_path, int uid, int gid);
134 void svm_region_init_args (svm_map_region_args_t * a);
135 void svm_region_exit (void);
136 void svm_region_exit_client (void);
137 void svm_region_unmap (void *rp_arg);
138 void svm_region_unmap_client (void *rp_arg);
139 void svm_client_scan (const char *root_path);
140 void svm_client_scan_this_region_nolock (svm_region_t * rp);
141 u8 *shm_name_from_svm_map_region_args (svm_map_region_args_t * a);
142 u8 *format_svm_region (u8 * s, va_list * args);
144 svm_region_t *svm_get_root_rp (void);
146 #endif /* __included_svm_common_h__ */
149 * fd.io coding-style-patch-verification: ON
152 * eval: (c-set-style "gnu")