src/svm/svm_fifo_segment.h

   1 /*
   2  * Copyright (c) 2016 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_ssvm_fifo_segment_h__
  16 #define __included_ssvm_fifo_segment_h__
  17
  18 #include <svm/ssvm.h>
  19 #include <svm/svm_fifo.h>
  20 #include <vppinfra/lock.h>
  21
  22 typedef enum
  23 {
  24   FIFO_SEGMENT_FREELIST_NONE = -1,
  25   FIFO_SEGMENT_RX_FREELIST = 0,
  26   FIFO_SEGMENT_TX_FREELIST,
  27   FIFO_SEGMENT_N_FREELISTS
  28 } svm_fifo_segment_freelist_t;
  29
  30 #define FIFO_SEGMENT_MIN_FIFO_SIZE 4096
  31 #define FIFO_SEGMENT_MAX_FIFO_SIZE (8<<20)      /* 8mb max fifo size */
  32 #define FIFO_SEGMENT_ALLOC_CHUNK_SIZE 32        /* Allocation quantum */
  33
  34 #define FIFO_SEGMENT_F_IS_PRIVATE       1 << 0  /* Private segment */
  35 #define FIFO_SEGMENT_F_IS_MAIN_HEAP     1 << 1  /* Segment is main heap */
  36 #define FIFO_SEGMENT_F_IS_PREALLOCATED  1 << 2  /* Segment is preallocated */
  37 #define FIFO_SEGMENT_F_WILL_DELETE      1 << 3  /* Segment will be removed */
  38
  39 typedef struct
  40 {
  41   svm_fifo_t *fifos;            /**< Linked list of active RX fifos */
  42   svm_fifo_t **free_fifos;      /**< Freelists, by fifo size  */
  43   u32 n_active_fifos;           /**< Number of active fifos */
  44   u8 flags;                     /**< Segment flags */
  45 } svm_fifo_segment_header_t;
  46
  47 typedef struct
  48 {
  49   ssvm_private_t ssvm;
  50   svm_fifo_segment_header_t *h;
  51 } svm_fifo_segment_private_t;
  52
  53 typedef struct
  54 {
  55   volatile u32 lock;
  56
  57   /** pool of segments */
  58   svm_fifo_segment_private_t *segments;
  59   /* Where to put the next one */
  60   u64 next_baseva;
  61   u32 timeout_in_seconds;
  62 } svm_fifo_segment_main_t;
  63
  64 extern svm_fifo_segment_main_t svm_fifo_segment_main;
  65
  66 typedef struct
  67 {
  68   ssvm_segment_type_t segment_type;
  69   char *segment_name;
  70   u32 segment_size;
  71   u32 *new_segment_indices;
  72   u32 rx_fifo_size;
  73   u32 tx_fifo_size;
  74   u32 preallocated_fifo_pairs;
  75   u32 private_segment_count;
  76   u32 seg_protected_space;
  77   int memfd_fd;
  78 } svm_fifo_segment_create_args_t;
  79
  80 static inline svm_fifo_segment_private_t *
  81 svm_fifo_segment_get_segment (u32 segment_index)
  82 {
  83   svm_fifo_segment_main_t *ssm = &svm_fifo_segment_main;
  84   return pool_elt_at_index (ssm->segments, segment_index);
  85 }
  86
  87 static inline u8
  88 svm_fifo_segment_has_fifos (svm_fifo_segment_private_t * fifo_segment)
  89 {
  90   return fifo_segment->h->fifos != 0;
  91 }
  92
  93 static inline svm_fifo_t *
  94 svm_fifo_segment_get_fifo_list (svm_fifo_segment_private_t * fifo_segment)
  95 {
  96   return fifo_segment->h->fifos;
  97 }
  98
  99 #define foreach_ssvm_fifo_segment_api_error             \
 100 _(OUT_OF_SPACE, "Out of space in segment", -200)
 101
 102 typedef enum
 103 {
 104 #define _(n,s,c) SSVM_FIFO_SEGMENT_API_ERROR_##n = c,
 105   foreach_ssvm_fifo_segment_api_error
 106 #undef _
 107 } ssvm_fifo_segment_api_error_enum_t;
 108
 109 int svm_fifo_segment_create (svm_fifo_segment_create_args_t * a);
 110 int svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t
 111                                              * a);
 112 int svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a);
 113 void svm_fifo_segment_delete (svm_fifo_segment_private_t * s);
 114
 115 svm_fifo_t *svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
 116                                          u32 data_size_in_bytes,
 117                                          svm_fifo_segment_freelist_t index);
 118 void svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s,
 119                                  svm_fifo_t * f,
 120                                  svm_fifo_segment_freelist_t index);
 121 void svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds);
 122 u32 svm_fifo_segment_index (svm_fifo_segment_private_t * s);
 123 u32 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment);
 124 u32 svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t *
 125                                      fifo_segment, u32 fifo_size_in_bytes);
 126 void svm_fifo_segment_info (svm_fifo_segment_private_t * seg, uword * address,
 127                             u64 * size);
 128
 129 svm_fifo_segment_private_t *svm_fifo_segment_segments_pool (void);
 130
 131 format_function_t format_svm_fifo_segment;
 132 format_function_t format_svm_fifo_segment_type;
 133
 134 #endif /* __included_ssvm_fifo_segment_h__ */
 135
 136 /*
 137  * fd.io coding-style-patch-verification: ON
 138  *
 139  * Local Variables:
 140  * eval: (c-set-style "gnu")
 141  * End:
 142  */