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