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   uword segment_size;                   /**< first segment size */
  31   uword add_segment_size;               /**< additional segment size */
  32   u8 add_segment:1;                     /**< can add new segments flag */
  33   u8 use_mq_eventfd:1;                  /**< use eventfds for mqs flag */
  34   u8 reserved:6;                        /**< reserved flags */
  35   u8 n_slices;                          /**< number of fs slices/threads */
  36   ssvm_segment_type_t segment_type;     /**< seg type: if set to SSVM_N_TYPES,
  37                                              private segments are used */
  38   u32 max_fifo_size;                    /**< max fifo size */
  39   u8 high_watermark;                    /**< memory usage high watermark % */
  40   u8 low_watermark;                     /**< memory usage low watermark % */
  41 } segment_manager_props_t;
  42
  43 typedef struct _segment_manager
  44 {
  45   /** Pool of segments allocated by this manager */
  46   fifo_segment_t *segments;
  47
  48   /** rwlock that protects the segments pool */
  49   clib_rwlock_t segments_rwlock;
  50
  51   /** Owner app worker index */
  52   u32 app_wrk_index;
  53
  54   /**
  55    * First segment should not be deleted unless segment manger is deleted.
  56    * This also indicates that the segment manager is the first to have been
  57    * allocated for the app.
  58    */
  59   u8 first_is_protected;
  60
  61   /**
  62    * App event queue allocated in first segment
  63    */
  64   svm_msg_q_t *event_queue;
  65
  66   u32 max_fifo_size;
  67   u8 high_watermark;
  68   u8 low_watermark;
  69 } segment_manager_t;
  70
  71 typedef struct segment_manager_main_init_args_
  72 {
  73   u64 baseva;
  74   u64 size;
  75 } segment_manager_main_init_args_t;
  76
  77 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
  78
  79 segment_manager_t *segment_manager_alloc (void);
  80 int segment_manager_init (segment_manager_t * sm);
  81
  82 /**
  83  * Cleanup segment manager
  84  *
  85  * @param sm    segment manager to be freed
  86  */
  87 void segment_manager_free (segment_manager_t * sm);
  88
  89 /**
  90  * Initiate segment manager cleanup
  91  *
  92  * @param sm    segment manager to be freed
  93  */
  94 void segment_manager_init_free (segment_manager_t * sm);
  95 segment_manager_t *segment_manager_get (u32 index);
  96 segment_manager_t *segment_manager_get_if_valid (u32 index);
  97 u32 segment_manager_index (segment_manager_t * sm);
  98
  99 int segment_manager_add_segment (segment_manager_t * sm, uword segment_size);
 100 void segment_manager_del_segment (segment_manager_t * sm,
 101                                   fifo_segment_t * fs);
 102 fifo_segment_t *segment_manager_get_segment (segment_manager_t * sm,
 103                                              u32 segment_index);
 104 fifo_segment_t *segment_manager_get_segment_w_handle (u64 sh);
 105 fifo_segment_t *segment_manager_get_segment_w_lock (segment_manager_t * sm,
 106                                                     u32 segment_index);
 107 int segment_manager_add_first_segment (segment_manager_t * sm,
 108                                        u32 segment_size);
 109 u64 segment_manager_make_segment_handle (u32 segment_manager_index,
 110                                          u32 segment_index);
 111 u64 segment_manager_segment_handle (segment_manager_t * sm,
 112                                     fifo_segment_t * segment);
 113 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
 114 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
 115
 116 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
 117                                          u32 thread_index,
 118                                          svm_fifo_t ** rx_fifo,
 119                                          svm_fifo_t ** tx_fifo);
 120 int segment_manager_try_alloc_fifos (fifo_segment_t * fs,
 121                                      u32 thread_index,
 122                                      u32 rx_fifo_size, u32 tx_fifo_size,
 123                                      svm_fifo_t ** rx_fifo,
 124                                      svm_fifo_t ** tx_fifo);
 125 void segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo,
 126                                     svm_fifo_t * tx_fifo);
 127
 128 void segment_manager_set_watermarks (segment_manager_t * sm,
 129                                      u8 high_watermark, u8 low_watermark);
 130
 131 u8 segment_manager_has_fifos (segment_manager_t * sm);
 132
 133 svm_msg_q_t *segment_manager_alloc_queue (fifo_segment_t * fs,
 134                                           segment_manager_props_t * props);
 135 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
 136 svm_msg_q_t *segment_manager_event_queue (segment_manager_t * sm);
 137 u32 segment_manager_evt_q_expected_size (u32 q_size);
 138
 139 void segment_manager_app_detach (segment_manager_t * sm);
 140
 141 /**
 142  * Cleanup segment manager sessions
 143  *
 144  * Initiates disconnects for all sessions 'owned' by a segment manager by
 145  * leveraging the backpointers that fifos keep.
 146  *
 147  * @param sm    segment manager whose sessions are to be disconnected
 148  */
 149 void segment_manager_del_sessions (segment_manager_t * sm);
 150 void segment_manager_format_sessions (segment_manager_t * sm, int verbose);
 151
 152 void segment_manager_main_init (segment_manager_main_init_args_t * a);
 153
 154 segment_manager_props_t *segment_manager_props_init (segment_manager_props_t *
 155                                                      sm);
 156
 157 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
 158 /*
 159  * fd.io coding-style-patch-verification: ON
 160  *
 161  * Local Variables:
 162  * eval: (c-set-style "gnu")
 163  * End:
 164  */