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/message_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   u32 rx_fifo_size;                     /**< receive fifo size */
  28   u32 tx_fifo_size;                     /**< transmit fifo size */
  29   u32 evt_q_size;                       /**< event queue length */
  30   u32 segment_size;                     /**< first segment size */
  31   u32 prealloc_fifos;                   /**< preallocated fifo pairs */
  32   u32 add_segment_size;                 /**< additional segment size */
  33   u8 add_segment:1;                     /**< can add new segments flag */
  34   u8 use_mq_eventfd:1;                  /**< use eventfds for mqs flag */
  35   u8 reserved:6;                        /**< reserved flags */
  36   ssvm_segment_type_t segment_type;     /**< seg type: if set to SSVM_N_TYPES,
  37                                              private segments are used */
  38 } segment_manager_properties_t;
  39
  40 typedef struct _segment_manager
  41 {
  42   /** Pool of segments allocated by this manager */
  43   svm_fifo_segment_private_t *segments;
  44
  45   /** rwlock that protects the segments pool */
  46   clib_rwlock_t segments_rwlock;
  47
  48   /** Owner app worker index */
  49   u32 app_wrk_index;
  50
  51   /**
  52    * First segment should not be deleted unless segment manger is deleted.
  53    * This also indicates that the segment manager is the first to have been
  54    * allocated for the app.
  55    */
  56   u8 first_is_protected;
  57
  58   /**
  59    * App event queue allocated in first segment
  60    */
  61   svm_msg_q_t *event_queue;
  62 } segment_manager_t;
  63
  64 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY)           \
  65 do {                                                                    \
  66     clib_rwlock_reader_lock (&(SM)->segments_rwlock);                   \
  67     pool_foreach((VAR), ((SM)->segments), (BODY));                      \
  68     clib_rwlock_reader_unlock (&(SM)->segments_rwlock);                 \
  69 } while (0)
  70
  71 typedef struct segment_manager_main_
  72 {
  73   /** Pool of segment managers */
  74   segment_manager_t *segment_managers;
  75
  76   /** Virtual address allocator */
  77   clib_valloc_main_t va_allocator;
  78
  79 } segment_manager_main_t;
  80
  81 extern segment_manager_main_t segment_manager_main;
  82
  83 typedef struct segment_manager_main_init_args_
  84 {
  85   u64 baseva;
  86   u64 size;
  87 } segment_manager_main_init_args_t;
  88
  89 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
  90
  91 /** Pool of segment managers */
  92 extern segment_manager_t *segment_managers;
  93
  94 always_inline segment_manager_t *
  95 segment_manager_get (u32 index)
  96 {
  97   return pool_elt_at_index (segment_manager_main.segment_managers, index);
  98 }
  99
 100 always_inline segment_manager_t *
 101 segment_manager_get_if_valid (u32 index)
 102 {
 103   if (pool_is_free_index (segment_manager_main.segment_managers, index))
 104     return 0;
 105   return pool_elt_at_index (segment_manager_main.segment_managers, index);
 106 }
 107
 108 always_inline u32
 109 segment_manager_index (segment_manager_t * sm)
 110 {
 111   return sm - segment_manager_main.segment_managers;
 112 }
 113
 114 always_inline svm_msg_q_t *
 115 segment_manager_event_queue (segment_manager_t * sm)
 116 {
 117   return sm->event_queue;
 118 }
 119
 120 segment_manager_t *segment_manager_new ();
 121 int segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
 122                           u32 prealloc_fifo_pairs);
 123
 124 svm_fifo_segment_private_t *segment_manager_get_segment (segment_manager_t *
 125                                                          sm,
 126                                                          u32 segment_index);
 127 svm_fifo_segment_private_t
 128   * segment_manager_get_segment_w_lock (segment_manager_t * sm,
 129                                         u32 segment_index);
 130 int segment_manager_add_segment (segment_manager_t * sm, u32 segment_size);
 131 void segment_manager_del_segment (segment_manager_t * sm,
 132                                   svm_fifo_segment_private_t * fs);
 133 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
 134 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
 135
 136 int segment_manager_add_first_segment (segment_manager_t * sm,
 137                                        u32 segment_size);
 138 void segment_manager_del_sessions (segment_manager_t * sm);
 139 void segment_manager_del (segment_manager_t * sm);
 140 void segment_manager_init_del (segment_manager_t * sm);
 141 u8 segment_manager_has_fifos (segment_manager_t * sm);
 142 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
 143                                          svm_fifo_t ** server_rx_fifo,
 144                                          svm_fifo_t ** server_tx_fifo,
 145                                          u32 * fifo_segment_index);
 146 int segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fs,
 147                                      u32 rx_fifo_size, u32 tx_fifo_size,
 148                                      svm_fifo_t ** rx_fifo,
 149                                      svm_fifo_t ** tx_fifo);
 150 void segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
 151                                     svm_fifo_t * tx_fifo);
 152 u32 segment_manager_evt_q_expected_size (u32 q_size);
 153 svm_msg_q_t *segment_manager_alloc_queue (svm_fifo_segment_private_t * fs,
 154                                           segment_manager_properties_t *
 155                                           props);
 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  */