src/svm/fifo_segment.h

   1 /*
   2  * Copyright (c) 2016-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 __included_fifo_segment_h__
  16 #define __included_fifo_segment_h__
  17
  18 #include <svm/ssvm.h>
  19 #include <svm/fifo_types.h>
  20 #include <svm/svm_fifo.h>
  21
  22 typedef enum
  23 {
  24   FIFO_SEGMENT_FTYPE_NONE = -1,
  25   FIFO_SEGMENT_RX_FIFO = 0,
  26   FIFO_SEGMENT_TX_FIFO,
  27   FIFO_SEGMENT_N_FTYPES
  28 } fifo_segment_ftype_t;
  29
  30 #define FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE 12      /**< 4kB min fifo size */
  31 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096         /**< 4kB min fifo size */
  32 #define FIFO_SEGMENT_MAX_FIFO_SIZE (2ULL << 30) /**< 2GB max fifo size */
  33 #define FIFO_SEGMENT_ALLOC_BATCH_SIZE 32        /* Allocation quantum */
  34
  35 typedef enum fifo_segment_flags_
  36 {
  37   FIFO_SEGMENT_F_IS_PREALLOCATED = 1 << 0,
  38   FIFO_SEGMENT_F_WILL_DELETE = 1 << 1,
  39   FIFO_SEGMENT_F_MEM_LIMIT = 1 << 2,
  40 } fifo_segment_flags_t;
  41
  42 #define foreach_segment_mem_status      \
  43 _(NO_PRESSURE, "No pressure")           \
  44 _(LOW_PRESSURE, "Low pressure")         \
  45 _(HIGH_PRESSURE, "High pressure")       \
  46 _(NO_MEMORY, "No memory")
  47
  48 typedef enum
  49 {
  50 #define _(sym,str)  MEMORY_PRESSURE_##sym,
  51   foreach_segment_mem_status
  52 #undef _
  53     MEMORY_N_PRESSURE,
  54 } fifo_segment_mem_status_t;
  55
  56 #if 0
  57 typedef enum fifo_segment_mem_status_
  58 {
  59   MEMORY_PRESSURE_NO_PRESSURE,
  60   MEMORY_PRESSURE_LOW_PRESSURE,
  61   MEMORY_PRESSURE_HIGH_PRESSURE,
  62   MEMORY_PRESSURE_NO_MEMORY,
  63 } fifo_segment_mem_status_t;
  64 #endif
  65
  66 typedef struct
  67 {
  68   ssvm_private_t ssvm;          /**< ssvm segment data */
  69   fifo_segment_header_t *h;     /**< fifo segment data */
  70   uword max_byte_index;
  71   u8 n_slices;                  /**< number of fifo segment slices */
  72   fifo_slice_private_t *slices; /**< private slice information */
  73 } fifo_segment_t;
  74
  75 typedef struct
  76 {
  77   fifo_segment_t *segments;     /**< pool of fifo segments */
  78   uword next_baseva;            /**< Where to put the next one */
  79   u32 timeout_in_seconds;       /**< Time to wait during attach */
  80 } fifo_segment_main_t;
  81
  82 typedef struct
  83 {
  84   ssvm_segment_type_t segment_type;     /**< type of segment requested */
  85   u32 segment_size;                     /**< size of the segment */
  86   int memfd_fd;                         /**< fd for memfd segments */
  87   char *segment_name;                   /**< segment name */
  88   u32 *new_segment_indices;             /**< return vec of new seg indices */
  89 } fifo_segment_create_args_t;
  90
  91 #define fifo_segment_flags(_fs) _fs->h->flags
  92
  93 int fifo_segment_init (fifo_segment_t * fs);
  94 int fifo_segment_create (fifo_segment_main_t * sm,
  95                          fifo_segment_create_args_t * a);
  96 int fifo_segment_attach (fifo_segment_main_t * sm,
  97                          fifo_segment_create_args_t * a);
  98 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
  99 void fifo_segment_cleanup (fifo_segment_t *fs);
 100 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
 101                                           u32 fs_index);
 102 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
 103 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
 104
 105 /**
 106  * Allocate fifo in fifo segment
 107  *
 108  * @param fs            fifo segment for fifo
 109  * @param data_bytes    size of default fifo chunk in bytes
 110  * @param ftype         fifo type @ref fifo_segment_ftype_t
 111  * @return              new fifo or 0 if alloc failed
 112  */
 113 svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
 114                                              u32 slice_index,
 115                                              u32 data_bytes,
 116                                              fifo_segment_ftype_t ftype);
 117 svm_fifo_t *fifo_segment_alloc_fifo_w_shared (fifo_segment_t *fs,
 118                                               svm_fifo_shared_t *sf);
 119
 120 /**
 121  * Free fifo allocated in fifo segment
 122  *
 123  * @param fs            fifo segment for fifo
 124  * @param f             fifo to be freed
 125  */
 126 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
 127
 128 void fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f);
 129 void fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
 130                                u32 slice_index);
 131
 132 /**
 133  * Try to preallocate fifo headers
 134  *
 135  * Tries to preallocate fifo headers and adds them to freelist.
 136  *
 137  * @param fs            fifo segment
 138  * @param batch_size    number of chunks to be allocated
 139  * @return              0 on success, negative number otherwise
 140  */
 141 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
 142                                      u32 batch_size);
 143
 144 /**
 145  * Try to preallocate fifo chunks on segment
 146  *
 147  * Tries to preallocate chunks of requested size on segment and adds them
 148  * to chunk freelist.
 149  *
 150  * @param fs            fifo segment
 151  * @param chunk_size    size of chunks to be allocated in bytes
 152  * @param batch_size    number of chunks to be allocated
 153  * @return              0 on success, negative number otherwise
 154  */
 155 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
 156                                        u32 chunk_size, u32 batch_size);
 157 /**
 158  * Pre-allocates fifo pairs in fifo segment
 159  *
 160  * The number of fifos pre-allocated is the minimum of the requested number
 161  * of pairs and the maximum number that fit within the segment. If the maximum
 162  * is hit, the number of fifo pairs requested is updated by subtracting the
 163  * number of fifos that have been successfully allocated.
 164  *
 165  * @param fs            fifo segment for fifo
 166  * @param rx_fifo_size  data size of rx fifos
 167  * @param tx_fifo_size  data size of tx fifos
 168  * @param n_fifo_pairs  number of pairs requested. Prior to returning, this
 169  *                      is decremented by the the number of pairs allocated.
 170  */
 171 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
 172                                           u32 rx_fifo_size,
 173                                           u32 tx_fifo_size,
 174                                           u32 * n_fifo_pairs);
 175
 176 /**
 177  * Allocate chunks in fifo segment
 178  *
 179  * @param fsh           fifo segment header
 180  * @param slice_index   slice where chunks should be alocated
 181  * @param chunk_size    chunk size needed
 182  * @return              chunk (or chunks) that cover at least chunk_size bytes
 183  *                      on success, 0 on failure.
 184  */
 185 svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
 186                                    u32 slice_index, u32 chunk_size);
 187
 188 /**
 189  * Return chunks to fifo segment
 190  *
 191  * @param fsh           fifo segment header
 192  * @param slice_index   slice where chunks should be returned
 193  * @param c             pointer to first chunk in 0 terminated linked list
 194  */
 195 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
 196                          svm_fifo_chunk_t * c);
 197
 198 /**
 199  * Fifo segment has reached mem limit
 200  *
 201  * @param fsh           fifo segment header
 202  * @return              1 (if reached) or 0 (otherwise)
 203  */
 204 u8 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh);
 205
 206 /**
 207  * Fifo segment reset mem limit flag
 208  *
 209  * @param fs            fifo segment
 210  */
 211 void fsh_reset_mem_limit (fifo_segment_header_t * fsh);
 212
 213 /**
 214  * Fifo segment reset mem limit flag
 215  *
 216  * @param fs            fifo segment
 217  * @param size          size requested
 218  * @return              pointer to memory allocated or 0
 219  */
 220 void *fifo_segment_alloc (fifo_segment_t *fs, uword size);
 221 /**
 222  * Fifo segment allocated size
 223  *
 224  * Returns fifo segment's allocated size
 225  *
 226  * @param fs            fifo segment
 227  * @return              allocated size in bytes
 228  */
 229 uword fifo_segment_size (fifo_segment_t * fs);
 230
 231 /**
 232  * Fifo segment estimate of number of free bytes
 233  *
 234  * Returns fifo segment's internal estimate of the number of free bytes.
 235  * To force a synchronization between the segment and the underlying
 236  * memory allocator, call @ref fifo_segment_update_free_bytes
 237  *
 238  * @param fs            fifo segment
 239  * @return              free bytes estimate
 240  */
 241 uword fifo_segment_free_bytes (fifo_segment_t * fs);
 242
 243 /**
 244  * Fifo segment number of cached bytes
 245  *
 246  * Returns fifo segment's number of cached bytes.
 247  *
 248  * @param fs            fifo segment
 249  * @return              cached bytes
 250  */
 251 uword fifo_segment_cached_bytes (fifo_segment_t * fs);
 252
 253 uword fifo_segment_available_bytes (fifo_segment_t * fs);
 254
 255 /**
 256  * Number of bytes on chunk free lists
 257  *
 258  * @param fs            fifo segment
 259  * @return              free bytes on chunk free lists
 260  */
 261 uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
 262 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
 263 svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
 264                                               u32 slice_index);
 265 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
 266 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
 267 /**
 268  * Find number of free chunks of given size
 269  *
 270  * @param fs    fifo segment
 271  * @param size  chunk size of interest or ~0 if all should be counted
 272  * @return      number of chunks of given size
 273  */
 274 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
 275
 276 u8 fifo_segment_get_mem_usage (fifo_segment_t * fs);
 277 fifo_segment_mem_status_t fifo_segment_determine_status
 278   (fifo_segment_header_t * fsh, u8 usage);
 279 fifo_segment_mem_status_t fifo_segment_get_mem_status (fifo_segment_t * fs);
 280
 281 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
 282                              u32 timeout_in_seconds);
 283
 284 format_function_t format_fifo_segment;
 285 format_function_t format_fifo_segment_type;
 286
 287 #endif /* __included_fifo_segment_h__ */
 288
 289 /*
 290  * fd.io coding-style-patch-verification: ON
 291  *
 292  * Local Variables:
 293  * eval: (c-set-style "gnu")
 294  * End:
 295  */