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 typedef struct
  43 {
  44   ssvm_private_t ssvm;          /**< ssvm segment data */
  45   fifo_segment_header_t *h;     /**< fifo segment data */
  46   u8 n_slices;                  /**< number of fifo segment slices */
  47 } fifo_segment_t;
  48
  49 typedef struct
  50 {
  51   fifo_segment_t *segments;     /**< pool of fifo segments */
  52   uword next_baseva;            /**< Where to put the next one */
  53   u32 timeout_in_seconds;       /**< Time to wait during attach */
  54 } fifo_segment_main_t;
  55
  56 typedef struct
  57 {
  58   ssvm_segment_type_t segment_type;     /**< type of segment requested */
  59   u32 segment_size;                     /**< size of the segment */
  60   int memfd_fd;                         /**< fd for memfd segments */
  61   char *segment_name;                   /**< segment name */
  62   u32 *new_segment_indices;             /**< return vec of new seg indices */
  63 } fifo_segment_create_args_t;
  64
  65 #define fifo_segment_flags(_fs) _fs->h->flags
  66
  67 int fifo_segment_init (fifo_segment_t * fs);
  68 int fifo_segment_create (fifo_segment_main_t * sm,
  69                          fifo_segment_create_args_t * a);
  70 int fifo_segment_attach (fifo_segment_main_t * sm,
  71                          fifo_segment_create_args_t * a);
  72 void fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * fs);
  73 fifo_segment_t *fifo_segment_get_segment (fifo_segment_main_t * sm,
  74                                           u32 fs_index);
  75 u32 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * fs);
  76 void fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size);
  77
  78 /**
  79  * Allocate fifo in fifo segment
  80  *
  81  * @param fs            fifo segment for fifo
  82  * @param data_bytes    size of default fifo chunk in bytes
  83  * @param ftype         fifo type @ref fifo_segment_ftype_t
  84  * @return              new fifo or 0 if alloc failed
  85  */
  86 svm_fifo_t *fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs,
  87                                              u32 slice_index,
  88                                              u32 data_bytes,
  89                                              fifo_segment_ftype_t ftype);
  90
  91 /**
  92  * Free fifo allocated in fifo segment
  93  *
  94  * @param fs            fifo segment for fifo
  95  * @param f             fifo to be freed
  96  */
  97 void fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f);
  98
  99 /**
 100  * Try to preallocate fifo headers
 101  *
 102  * Tries to preallocate fifo headers and adds them to freelist.
 103  *
 104  * @param fs            fifo segment
 105  * @param batch_size    number of chunks to be allocated
 106  * @return              0 on success, negative number otherwise
 107  */
 108 int fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
 109                                      u32 batch_size);
 110
 111 /**
 112  * Try to preallocate fifo chunks on segment
 113  *
 114  * Tries to preallocate chunks of requested size on segment and adds them
 115  * to chunk freelist.
 116  *
 117  * @param fs            fifo segment
 118  * @param chunk_size    size of chunks to be allocated in bytes
 119  * @param batch_size    number of chunks to be allocated
 120  * @return              0 on success, negative number otherwise
 121  */
 122 int fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
 123                                        u32 chunk_size, u32 batch_size);
 124 /**
 125  * Pre-allocates fifo pairs in fifo segment
 126  *
 127  * The number of fifos pre-allocated is the minimum of the requested number
 128  * of pairs and the maximum number that fit within the segment. If the maximum
 129  * is hit, the number of fifo pairs requested is updated by subtracting the
 130  * number of fifos that have been successfully allocated.
 131  *
 132  * @param fs            fifo segment for fifo
 133  * @param rx_fifo_size  data size of rx fifos
 134  * @param tx_fifo_size  data size of tx fifos
 135  * @param n_fifo_pairs  number of pairs requested. Prior to returning, this
 136  *                      is decremented by the the number of pairs allocated.
 137  */
 138 void fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
 139                                           u32 rx_fifo_size,
 140                                           u32 tx_fifo_size,
 141                                           u32 * n_fifo_pairs);
 142
 143 svm_fifo_chunk_t *fsh_alloc_chunk (fifo_segment_header_t * fsh,
 144                                    u32 slice_index, u32 chunk_size);
 145
 146 void fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
 147                          svm_fifo_chunk_t * cur);
 148
 149 /**
 150  * Fifo segment estimate of number of free bytes
 151  *
 152  * Returns fifo segment's internal estimate of the number of free bytes.
 153  * To force a synchronization between the segment and the underlying
 154  * memory allocator, call @ref fifo_segment_update_free_bytes
 155  *
 156  * @param fs            fifo segment
 157  * @return              free bytes estimate
 158  */
 159 uword fifo_segment_free_bytes (fifo_segment_t * fs);
 160
 161 /**
 162  * Update fifo segment free bytes estimate
 163  *
 164  * Forces fifo segment free bytes estimate synchronization with underlying
 165  * memory allocator.
 166  *
 167  * @param fs            fifo segment
 168  */
 169 void fifo_segment_update_free_bytes (fifo_segment_t * fs);
 170
 171 /**
 172  * Number of bytes on chunk free lists
 173  *
 174  * @param fs            fifo segment
 175  * @return              free bytes on chunk free lists
 176  */
 177 uword fifo_segment_fl_chunk_bytes (fifo_segment_t * fs);
 178 u8 fifo_segment_has_fifos (fifo_segment_t * fs);
 179 svm_fifo_t *fifo_segment_get_slice_fifo_list (fifo_segment_t * fs,
 180                                               u32 slice_index);
 181 u32 fifo_segment_num_fifos (fifo_segment_t * fs);
 182 u32 fifo_segment_num_free_fifos (fifo_segment_t * fs);
 183 /**
 184  * Find number of free chunks of given size
 185  *
 186  * @param fs    fifo segment
 187  * @param size  chunk size of interest or ~0 if all should be counted
 188  * @return      number of chunks of given size
 189  */
 190 u32 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size);
 191
 192 void fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
 193                              u32 timeout_in_seconds);
 194
 195 format_function_t format_fifo_segment;
 196 format_function_t format_fifo_segment_type;
 197
 198 #endif /* __included_fifo_segment_h__ */
 199
 200 /*
 201  * fd.io coding-style-patch-verification: ON
 202  *
 203  * Local Variables:
 204  * eval: (c-set-style "gnu")
 205  * End:
 206  */