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