src/vnet/session/segment_manager.h

   1 /*
   2  * Copyright (c) 2017 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 SRC_VNET_SESSION_SEGMENT_MANAGER_H_
  16 #define SRC_VNET_SESSION_SEGMENT_MANAGER_H_
  17
  18 #include <vnet/vnet.h>
  19 #include <svm/svm_fifo_segment.h>
  20 #include <svm/queue.h>
  21 #include <vlibmemory/api.h>
  22 #include <vppinfra/lock.h>
  23 #include <vppinfra/valloc.h>
  24
  25 typedef struct _segment_manager_properties
  26 {
  27   /** Session fifo sizes.  */
  28   u32 rx_fifo_size;
  29   u32 tx_fifo_size;
  30
  31   /** Preallocated pool sizes */
  32 //  u32 preallocated_fifo_pairs;
  33
  34   /** Configured additional segment size */
  35   u32 add_segment_size;
  36
  37   /** Flag that indicates if additional segments should be created */
  38   u8 add_segment;
  39
  40   /** Segment type: if set to SSVM_N_TYPES, private segments are used */
  41   ssvm_segment_type_t segment_type;
  42
  43   /** Use one or more private mheaps, instead of the global heap */
  44 //  u32 private_segment_count;
  45 } segment_manager_properties_t;
  46
  47 typedef struct _segment_manager
  48 {
  49   /** Pool of segments allocated by this manager */
  50   svm_fifo_segment_private_t *segments;
  51
  52   /** rwlock that protects the segments pool */
  53   clib_rwlock_t segments_rwlock;
  54
  55   /** Owner app index */
  56   u32 app_index;
  57
  58   /**
  59    * First segment should not be deleted unless segment manger is deleted.
  60    * This also indicates that the segment manager is the first to have been
  61    * allocated for the app.
  62    */
  63   u8 first_is_protected;
  64
  65   /**
  66    * App event queue allocated in first segment
  67    */
  68   svm_queue_t *event_queue;
  69 } segment_manager_t;
  70
  71 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY)           \
  72 do {                                                                    \
  73     clib_rwlock_reader_lock (&(SM)->segments_rwlock);                   \
  74     pool_foreach((VAR), ((SM)->segments), (BODY));                      \
  75     clib_rwlock_reader_unlock (&(SM)->segments_rwlock);                 \
  76 } while (0)
  77
  78 typedef struct segment_manager_main_
  79 {
  80   /** Pool of segment managers */
  81   segment_manager_t *segment_managers;
  82
  83   /** Virtual address allocator */
  84   clib_valloc_main_t va_allocator;
  85
  86 } segment_manager_main_t;
  87
  88 extern segment_manager_main_t segment_manager_main;
  89
  90 typedef struct segment_manager_main_init_args_
  91 {
  92   u64 baseva;
  93   u64 size;
  94 } segment_manager_main_init_args_t;
  95
  96 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
  97
  98 /** Pool of segment managers */
  99 extern segment_manager_t *segment_managers;
 100
 101 always_inline segment_manager_t *
 102 segment_manager_get (u32 index)
 103 {
 104   return pool_elt_at_index (segment_manager_main.segment_managers, index);
 105 }
 106
 107 always_inline segment_manager_t *
 108 segment_manager_get_if_valid (u32 index)
 109 {
 110   if (pool_is_free_index (segment_manager_main.segment_managers, index))
 111     return 0;
 112   return pool_elt_at_index (segment_manager_main.segment_managers, index);
 113 }
 114
 115 always_inline u32
 116 segment_manager_index (segment_manager_t * sm)
 117 {
 118   return sm - segment_manager_main.segment_managers;
 119 }
 120
 121 always_inline svm_queue_t *
 122 segment_manager_event_queue (segment_manager_t * sm)
 123 {
 124   return sm->event_queue;
 125 }
 126
 127 segment_manager_t *segment_manager_new ();
 128 int segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
 129                           u32 evt_q_size, u32 prealloc_fifo_pairs);
 130
 131 svm_fifo_segment_private_t *segment_manager_get_segment (segment_manager_t *
 132                                                          sm,
 133                                                          u32 segment_index);
 134 svm_fifo_segment_private_t
 135   * segment_manager_get_segment_w_lock (segment_manager_t * sm,
 136                                         u32 segment_index);
 137 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
 138 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
 139
 140 int segment_manager_add_first_segment (segment_manager_t * sm,
 141                                        u32 segment_size);
 142 void segment_manager_del_sessions (segment_manager_t * sm);
 143 void segment_manager_del (segment_manager_t * sm);
 144 void segment_manager_init_del (segment_manager_t * sm);
 145 u8 segment_manager_has_fifos (segment_manager_t * sm);
 146 int
 147 segment_manager_alloc_session_fifos (segment_manager_t * sm,
 148                                      svm_fifo_t ** server_rx_fifo,
 149                                      svm_fifo_t ** server_tx_fifo,
 150                                      u32 * fifo_segment_index);
 151 void
 152 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
 153                                svm_fifo_t * tx_fifo);
 154 svm_queue_t *segment_manager_alloc_queue (segment_manager_t * sm,
 155                                           u32 queue_size);
 156 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
 157 void segment_manager_app_detach (segment_manager_t * sm);
 158
 159 void segment_manager_main_init (segment_manager_main_init_args_t * a);
 160 segment_manager_properties_t
 161   * segment_manager_properties_init (segment_manager_properties_t * sm);
 162
 163 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
 164 /*
 165  * fd.io coding-style-patch-verification: ON
 166  *
 167  * Local Variables:
 168  * eval: (c-set-style "gnu")
 169  * End:
 170  */