src/svm/svm_common.h

   1 /*
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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  *------------------------------------------------------------------
  16  */
  17
  18 #ifndef __included_svm_common_h__
  19 #define __included_svm_common_h__
  20
  21 #include <stdarg.h>
  22 #include <pthread.h>
  23 #include <vppinfra/types.h>
  24
  25 #define SVM_VERSION ((1<<16) | 1)       /* set to declare region ready. */
  26
  27 #define SVM_FLAGS_MHEAP (1<<0)  /* region contains an mheap */
  28 #define SVM_FLAGS_FILE  (1<<1)  /* region backed by one or more files */
  29 #define SVM_FLAGS_NODATA (1<<2) /* region will be further subdivided */
  30 #define SVM_FLAGS_NEED_DATA_INIT (1<<3)
  31
  32 #define SVM_PVT_MHEAP_SIZE (128<<10)    /* region's private mheap (128k) */
  33
  34 typedef struct svm_region_
  35 {
  36   volatile uword version;
  37   pthread_mutex_t mutex;
  38   pthread_cond_t condvar;
  39   int mutex_owner_pid;          /* in case of trouble */
  40   int mutex_owner_tag;
  41   uword flags;
  42   uword virtual_base;           /* base of the region object */
  43   uword virtual_size;
  44   void *region_heap;
  45   void *data_base;              /* data portion base address */
  46   void *data_heap;              /* data heap, if any */
  47   volatile void *user_ctx;      /* user context pointer */
  48   /* stuff allocated in the region's heap */
  49   uword bitmap_size;            /* nbits in virtual alloc bitmap */
  50   uword *bitmap;                /* the bitmap */
  51   char *region_name;
  52   char *backing_file;
  53   char **filenames;
  54   uword *client_pids;
  55   /* pad */
  56
  57   /* next page:
  58    * (64K) clib heap for the region itself
  59    *
  60    * data_base -> whatever is in this region
  61    */
  62
  63 } svm_region_t;
  64
  65 typedef struct svm_map_region_args_
  66 {
  67   const char *root_path;        /* NULL means use the truly global arena */
  68   const char *name;
  69   uword baseva;
  70   u64 size;
  71   u64 pvt_heap_size;
  72   uword flags;
  73   char *backing_file;
  74   uword backing_mmap_size;
  75   /* uid, gid to own the svm region(s) */
  76   int uid;
  77   int gid;
  78 } svm_map_region_args_t;
  79
  80 /*
  81  * Memory mapped to high addresses for session/vppcom/vcl/etc...
  82  */
  83 #if __WORDSIZE == 64
  84 #define HIGH_SEGMENT_BASEVA (8ULL   << 30)      /* 8GB */
  85 #elif __WORDSIZE == 32
  86 #define HIGH_SEGMENT_BASEVA (3584UL << 20)      /* 3.5GB */
  87 #else
  88 #error "unknown __WORDSIZE"
  89 #endif
  90
  91 /*
  92  * Memory shared across all router instances. Packet buffers, etc
  93  * Base should be "out of the way," and size should be big enough to
  94  * cover everything we plan to put here.
  95  */
  96 #define SVM_GLOBAL_REGION_SIZE    (64<<20)
  97 #define SVM_GLOBAL_REGION_NAME "/global_vm"
  98 u64 svm_get_global_region_base_va ();
  99
 100 /*
 101  * Memory shared across individual router instances.
 102  */
 103 #define SVM_OVERLAY_REGION_BASEVA \
 104                (SVM_GLOBAL_REGION_BASEVA + SVM_GLOBAL_REGION_SIZE)
 105 #define SVM_OVERLAY_REGION_SIZE   (1<<20)
 106 #define SVM_OVERLAY_REGION_BASENAME "/overlay_vm"
 107
 108 typedef struct
 109 {
 110   u8 *subregion_name;
 111 } svm_subregion_t;
 112
 113 typedef struct
 114 {
 115   svm_subregion_t *subregions;  /* subregion pool */
 116   uword *name_hash;
 117   u8 *root_path;
 118   int uid;
 119   int gid;
 120 } svm_main_region_t;
 121
 122
 123 void *svm_region_find_or_create (svm_map_region_args_t * a);
 124 void svm_region_init (void);
 125 void svm_region_init_mapped_region (svm_map_region_args_t * a,
 126                                     svm_region_t * rp);
 127 int svm_region_init_chroot (const char *root_path);
 128 void svm_region_init_chroot_uid_gid (const char *root_path, int uid, int gid);
 129 void svm_region_init_args (svm_map_region_args_t * a);
 130 void svm_region_exit (void);
 131 void svm_region_exit_client (void);
 132 void svm_region_unmap (void *rp_arg);
 133 void svm_region_unmap_client (void *rp_arg);
 134 void svm_client_scan (const char *root_path);
 135 void svm_client_scan_this_region_nolock (svm_region_t * rp);
 136 u8 *shm_name_from_svm_map_region_args (svm_map_region_args_t * a);
 137 u8 *format_svm_region (u8 * s, va_list * args);
 138
 139 svm_region_t *svm_get_root_rp (void);
 140
 141 #endif /* __included_svm_common_h__ */
 142
 143 /*
 144  * fd.io coding-style-patch-verification: ON
 145  *
 146  * Local Variables:
 147  * eval: (c-set-style "gnu")
 148  * End:
 149  */