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   u64 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 /*
  82  * Memory shared across all router instances. Packet buffers, etc
  83  * Base should be "out of the way," and size should be big enough to
  84  * cover everything we plan to put here.
  85  */
  86 #define SVM_GLOBAL_REGION_BASEVA  0x30000000
  87 #define SVM_GLOBAL_REGION_SIZE    (64<<20)
  88 #define SVM_GLOBAL_REGION_NAME "/global_vm"
  89
  90 /*
  91  * Memory shared across individual router instances.
  92  */
  93 #define SVM_OVERLAY_REGION_BASEVA \
  94                (SVM_GLOBAL_REGION_BASEVA + SVM_GLOBAL_REGION_SIZE)
  95 #define SVM_OVERLAY_REGION_SIZE   (1<<20)
  96 #define SVM_OVERLAY_REGION_BASENAME "/overlay_vm"
  97
  98 typedef struct
  99 {
 100   u8 *subregion_name;
 101 } svm_subregion_t;
 102
 103 typedef struct
 104 {
 105   svm_subregion_t *subregions;  /* subregion pool */
 106   uword *name_hash;
 107   u8 *root_path;
 108   int uid;
 109   int gid;
 110 } svm_main_region_t;
 111
 112
 113 void *svm_region_find_or_create (svm_map_region_args_t * a);
 114 void svm_region_init (void);
 115 int svm_region_init_chroot (const char *root_path);
 116 void svm_region_init_chroot_uid_gid (const char *root_path, int uid, int gid);
 117 void svm_region_init_args (svm_map_region_args_t * a);
 118 void svm_region_exit (void);
 119 void svm_region_unmap (void *rp_arg);
 120 void svm_client_scan (const char *root_path);
 121 void svm_client_scan_this_region_nolock (svm_region_t * rp);
 122 u8 *shm_name_from_svm_map_region_args (svm_map_region_args_t * a);
 123 u8 *format_svm_region (u8 * s, va_list * args);
 124
 125 svm_region_t *svm_get_root_rp (void);
 126
 127 #endif /* __included_svm_common_h__ */
 128
 129 /*
 130  * fd.io coding-style-patch-verification: ON
 131  *
 132  * Local Variables:
 133  * eval: (c-set-style "gnu")
 134  * End:
 135  */