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 (2 << 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   u8 n_slices;                  /**< number of fifo segment slices */
  71 } fifo_segment_t;
  72
  73 typedef struct
  74 {
  75   fifo_segment_t *segments;     /**< pool of fifo segments */
  76   uword next_baseva;            /**< Where to put the next one */
  77   u32 timeout_in_seconds;       /**< Time to wait during attach */
  78 } fifo_segment_main_t;
  79
  80 typedef struct
  81 {
  82   ssvm_segment_type_t segment_type;     /**< type of segment requested */
  83   u32 segment_size;                     /**< size of the segment */
  84   int memfd_fd;                         /**< fd for memfd segments */
  85   char *segment_name;                   /**< segment name */
  86   u32 *new_segment_indices;             /**< return vec of new seg indices */
  87 } fifo_segment_create_args_t;
  88
  89 #define fifo_segment_flags(_fs) _fs->h->flags
  90
  91 int fifo_segment_init (fifo_segment_t * fs);
  92 int fifo_segment_create (fifo_segment_main_t * sm,
  93                          fifo_segment_create_args_t * a);
  94 int fifo_segment_attach (fifo_segment_main_t * sm,
  95                          fifo_segment_create_args_t * a);
  96 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
  97 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
  98                                           u32 fs_index);
  99 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
 100 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
 101
 102 /**
 103  * Allocate fifo in fifo segment
 104  *
 105  * @param fs            fifo segment for fifo
 106  * @param data_bytes    size of default fifo chunk in bytes
 107  * @param ftype         fifo type @ref fifo_segment_ftype_t
 108  * @return              new fifo or 0 if alloc failed
 109  */
 110 svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
 111                                              u32 slice_index,
 112                                              u32 data_bytes,
 113                                              fifo_segment_ftype_t ftype);
 114
 115 /**
 116  * Free fifo allocated in fifo segment
 117  *
 118  * @param fs            fifo segment for fifo
 119  * @param f             fifo to be freed
 120  */
 121 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
 122
 123 void fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f);
 124 void fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
 125                                u32 slice_index);
 126
 127 /**
 128  * Try to preallocate fifo headers
 129  *
 130  * Tries to preallocate fifo headers and adds them to freelist.
 131  *
 132  * @param fs            fifo segment
 133  * @param batch_size    number of chunks to be allocated
 134  * @return              0 on success, negative number otherwise
 135  */
 136 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
 137                                      u32 batch_size);
 138
 139 /**
 140  * Try to preallocate fifo chunks on segment
 141  *
 142  * Tries to preallocate chunks of requested size on segment and adds them
 143  * to chunk freelist.
 144  *
 145  * @param fs            fifo segment
 146  * @param chunk_size    size of chunks to be allocated in bytes
 147  * @param batch_size    number of chunks to be allocated
 148  * @return              0 on success, negative number otherwise
 149  */
 150 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
 151                                        u32 chunk_size, u32 batch_size);
 152 /**
 153  * Pre-allocates fifo pairs in fifo segment
 154  *
 155  * The number of fifos pre-allocated is the minimum of the requested number
 156  * of pairs and the maximum number that fit within the segment. If the maximum
 157  * is hit, the number of fifo pairs requested is updated by subtracting the
 158  * number of fifos that have been successfully allocated.
 159  *
 160  * @param fs            fifo segment for fifo
 161  * @param rx_fifo_size  data size of rx fifos
 162  * @param tx_fifo_size  data size of tx fifos
 163  * @param n_fifo_pairs  number of pairs requested. Prior to returning, this
 164  *                      is decremented by the the number of pairs allocated.
 165  */
 166 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
 167                                           u32 rx_fifo_size,
 168                                           u32 tx_fifo_size,
 169                                           u32 * n_fifo_pairs);
 170
 171 /**
 172  * Allocate chunks in fifo segment
 173  *
 174  * @param fsh           fifo segment header
 175  * @param slice_index   slice where chunks should be alocated
 176  * @param chunk_size    chunk size needed
 177  * @return              chunk (or chunks) that cover at least chunk_size bytes
 178  *                      on success, 0 on failure.
 179  */
 180 svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
 181                                    u32 slice_index, u32 chunk_size);
 182
 183 /**
 184  * Return chunks to fifo segment
 185  *
 186  * @param fsh           fifo segment header
 187  * @param slice_index   slice where chunks should be returned
 188  * @param c             pointer to first chunk in 0 terminated linked list
 189  */
 190 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
 191                          svm_fifo_chunk_t * c);
 192
 193 /**
 194  * Fifo segment has reached mem limit
 195  *
 196  * @param fsh           fifo segment header
 197  * @return              1 (if reached) or 0 (otherwise)
 198  */
 199 u8 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh);
 200
 201 /**
 202  * Fifo segment reset mem limit flag
 203  *
 204  * @param fs            fifo segment
 205  */
 206 void fsh_reset_mem_limit (fifo_segment_header_t * fsh);
 207
 208 /**
 209  * Fifo segment allocated size
 210  *
 211  * Returns fifo segment's allocated size
 212  *
 213  * @param fs            fifo segment
 214  * @return              allocated size in bytes
 215  */
 216 uword fifo_segment_size (fifo_segment_t * fs);
 217
 218 /**
 219  * Fifo segment estimate of number of free bytes
 220  *
 221  * Returns fifo segment's internal estimate of the number of free bytes.
 222  * To force a synchronization between the segment and the underlying
 223  * memory allocator, call @ref fifo_segment_update_free_bytes
 224  *
 225  * @param fs            fifo segment
 226  * @return              free bytes estimate
 227  */
 228 uword fifo_segment_free_bytes (fifo_segment_t * fs);
 229
 230 /**
 231  * Update fifo segment free bytes estimate
 232  *
 233  * Forces fifo segment free bytes estimate synchronization with underlying
 234  * memory allocator.
 235  *
 236  * @param fs            fifo segment
 237  */
 238 void fifo_segment_update_free_bytes (fifo_segment_t * fs);
 239
 240 /**
 241  * Fifo segment number of cached bytes
 242  *
 243  * Returns fifo segment's number of cached bytes.
 244  *
 245  * @param fs            fifo segment
 246  * @return              cached bytes
 247  */
 248 uword fifo_segment_cached_bytes (fifo_segment_t * fs);
 249
 250 uword fifo_segment_available_bytes (fifo_segment_t * fs);
 251
 252 /**
 253  * Number of bytes on chunk free lists
 254  *
 255  * @param fs            fifo segment
 256  * @return              free bytes on chunk free lists
 257  */
 258 uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
 259 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
 260 svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
 261                                               u32 slice_index);
 262 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
 263 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
 264 /**
 265  * Find number of free chunks of given size
 266  *
 267  * @param fs    fifo segment
 268  * @param size  chunk size of interest or ~0 if all should be counted
 269  * @return      number of chunks of given size
 270  */
 271 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
 272
 273 u8 fifo_segment_get_mem_usage (fifo_segment_t * fs);
 274 fifo_segment_mem_status_t fifo_segment_determine_status
 275   (fifo_segment_header_t * fsh, u8 usage);
 276 fifo_segment_mem_status_t fifo_segment_get_mem_status (fifo_segment_t * fs);
 277
 278 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
 279                              u32 timeout_in_seconds);
 280
 281 format_function_t format_fifo_segment;
 282 format_function_t format_fifo_segment_type;
 283
 284 #endif /* __included_fifo_segment_h__ */
 285
 286 /*
 287  * fd.io coding-style-patch-verification: ON
 288  *
 289  * Local Variables:
 290  * eval: (c-set-style "gnu")
 291  * End:
 292  */