src/vnet/session/segment_manager.h

   1 /*
   2  * Copyright (c) 2017-2019 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 <svm/message_queue.h>
  19 #include <vppinfra/lock.h>
  20 #include <vppinfra/valloc.h>
  21 #include <svm/fifo_segment.h>
  22 #include <vnet/session/session_types.h>
  23
  24 typedef struct _segment_manager_props
  25 {
  26   u32 rx_fifo_size;                     /**< receive fifo size */
  27   u32 tx_fifo_size;                     /**< transmit fifo size */
  28   u32 evt_q_size;                       /**< event queue length */
  29   u32 prealloc_fifos;                   /**< preallocated fifo pairs */
  30   u32 prealloc_fifo_hdrs;               /**< preallocated fifo hdrs */
  31   uword segment_size;                   /**< first segment size */
  32   uword 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   u8 n_slices;                          /**< number of fs slices/threads */
  37   ssvm_segment_type_t segment_type;     /**< seg type: if set to SSVM_N_TYPES,
  38                                              private segments are used */
  39   u32 max_fifo_size;                    /**< max fifo size */
  40   u8 high_watermark;                    /**< memory usage high watermark % */
  41   u8 low_watermark;                     /**< memory usage low watermark % */
  42   u8 pct_first_alloc;                   /**< pct of fifo size to alloc */
  43 } segment_manager_props_t;
  44
  45 typedef enum seg_manager_flag_
  46 {
  47   SEG_MANAGER_F_DETACHED = 1 << 0,
  48   SEG_MANAGER_F_DETACHED_LISTENER = 1 << 1,
  49 } seg_manager_flag_t;
  50
  51 typedef struct _segment_manager
  52 {
  53   /** Pool of segments allocated by this manager */
  54   fifo_segment_t *segments;
  55
  56   /** rwlock that protects the segments pool */
  57   clib_rwlock_t segments_rwlock;
  58
  59   /** Owner app worker index */
  60   u32 app_wrk_index;
  61
  62   /**
  63    * First segment should not be deleted unless segment manger is deleted.
  64    * This also indicates that the segment manager is the first to have been
  65    * allocated for the app.
  66    */
  67   u8 first_is_protected;
  68
  69   /**
  70    * App event queue allocated in first segment
  71    */
  72   svm_msg_q_t *event_queue;
  73
  74   u8 flags;
  75
  76   u32 max_fifo_size;
  77   u8 high_watermark;
  78   u8 low_watermark;
  79 } segment_manager_t;
  80
  81 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
  82
  83 segment_manager_t *segment_manager_alloc (void);
  84 int segment_manager_init (segment_manager_t * sm);
  85 int segment_manager_init_first (segment_manager_t * sm);
  86
  87 /**
  88  * Cleanup segment manager
  89  *
  90  * @param sm    segment manager to be freed
  91  */
  92 void segment_manager_free (segment_manager_t * sm);
  93 void segment_manager_free_safe (segment_manager_t *sm);
  94
  95 /**
  96  * Initiate segment manager cleanup
  97  *
  98  * @param sm    segment manager to be freed
  99  */
 100 void segment_manager_init_free (segment_manager_t * sm);
 101 segment_manager_t *segment_manager_get (u32 index);
 102 segment_manager_t *segment_manager_get_if_valid (u32 index);
 103 u32 segment_manager_index (segment_manager_t * sm);
 104
 105 int segment_manager_add_segment (segment_manager_t *sm, uword segment_size,
 106                                  u8 notify_app);
 107 void segment_manager_del_segment (segment_manager_t * sm,
 108                                   fifo_segment_t * fs);
 109 void segment_manager_lock_and_del_segment (segment_manager_t * sm,
 110                                            u32 fs_index);
 111 fifo_segment_t *segment_manager_get_segment (segment_manager_t * sm,
 112                                              u32 segment_index);
 113 fifo_segment_t *segment_manager_get_segment_w_handle (u64 sh);
 114 fifo_segment_t *segment_manager_get_segment_w_lock (segment_manager_t * sm,
 115                                                     u32 segment_index);
 116 int segment_manager_add_first_segment (segment_manager_t * sm,
 117                                        u32 segment_size);
 118 u64 segment_manager_make_segment_handle (u32 segment_manager_index,
 119                                          u32 segment_index);
 120 u64 segment_manager_segment_handle (segment_manager_t * sm,
 121                                     fifo_segment_t * segment);
 122 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
 123 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
 124
 125 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
 126                                          u32 thread_index,
 127                                          svm_fifo_t ** rx_fifo,
 128                                          svm_fifo_t ** tx_fifo);
 129 int segment_manager_try_alloc_fifos (fifo_segment_t * fs,
 130                                      u32 thread_index,
 131                                      u32 rx_fifo_size, u32 tx_fifo_size,
 132                                      svm_fifo_t ** rx_fifo,
 133                                      svm_fifo_t ** tx_fifo);
 134 void segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo,
 135                                     svm_fifo_t * tx_fifo);
 136 void segment_manager_detach_fifo (segment_manager_t *sm, svm_fifo_t **f);
 137 void segment_manager_attach_fifo (segment_manager_t *sm, svm_fifo_t **f,
 138                                   session_t *s);
 139
 140 void segment_manager_set_watermarks (segment_manager_t * sm,
 141                                      u8 high_watermark, u8 low_watermark);
 142
 143 u8 segment_manager_has_fifos (segment_manager_t * sm);
 144
 145 svm_msg_q_t *segment_manager_alloc_queue (fifo_segment_t * fs,
 146                                           segment_manager_props_t * props);
 147 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
 148 svm_msg_q_t *segment_manager_event_queue (segment_manager_t * sm);
 149 u32 segment_manager_evt_q_expected_size (u32 q_size);
 150
 151 u8 segment_manager_app_detached (segment_manager_t * sm);
 152 void segment_manager_app_detach (segment_manager_t * sm);
 153
 154 /**
 155  * Cleanup segment manager sessions
 156  *
 157  * Initiates disconnects for all sessions 'owned' by a segment manager by
 158  * leveraging the backpointers that fifos keep.
 159  *
 160  * @param sm    segment manager whose sessions are to be disconnected
 161  */
 162 void segment_manager_del_sessions (segment_manager_t * sm);
 163 void segment_manager_del_sessions_filter (segment_manager_t *sm,
 164                                           session_state_t *states);
 165 void segment_manager_format_sessions (segment_manager_t * sm, int verbose);
 166
 167 void segment_manager_main_init (void);
 168
 169 segment_manager_props_t *segment_manager_props_init (segment_manager_props_t *
 170                                                      sm);
 171
 172 static inline void
 173 segment_manager_parse_segment_handle (u64 segment_handle, u32 * sm_index,
 174                                       u32 * segment_index)
 175 {
 176   *sm_index = segment_handle >> 32;
 177   *segment_index = segment_handle & 0xFFFFFFFF;
 178 }
 179
 180 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
 181 /*
 182  * fd.io coding-style-patch-verification: ON
 183  *
 184  * Local Variables:
 185  * eval: (c-set-style "gnu")
 186  * End:
 187  */