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