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