src/vnet/session/segment_manager.h

   1 /*
   2  * Copyright (c) 2017 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 SRC_VNET_SESSION_SEGMENT_MANAGER_H_
  16 #define SRC_VNET_SESSION_SEGMENT_MANAGER_H_
  17
  18 #include <vnet/vnet.h>
  19 #include <svm/svm_fifo_segment.h>
  20
  21 #include <vlibmemory/unix_shared_memory_queue.h>
  22 #include <vlibmemory/api.h>
  23 #include <vppinfra/lock.h>
  24
  25 typedef struct _segment_manager_properties
  26 {
  27   /** Session fifo sizes.  */
  28   u32 rx_fifo_size;
  29   u32 tx_fifo_size;
  30
  31   /** Preallocated pool sizes */
  32   u32 preallocated_fifo_pairs;
  33
  34   /** Configured additional segment size */
  35   u32 add_segment_size;
  36
  37   /** Flag that indicates if additional segments should be created */
  38   u8 add_segment;
  39
  40   /** Use private memory segment instead of shared memory */
  41   u8 use_private_segment;
  42
  43   /** Use one or more private mheaps, instead of the global heap */
  44   u32 private_segment_count;
  45   u32 private_segment_size;
  46 } segment_manager_properties_t;
  47
  48 typedef struct _segment_manager
  49 {
  50   clib_spinlock_t lockp;
  51
  52   /** segments mapped by this manager */
  53   u32 *segment_indices;
  54
  55   /** Owner app index */
  56   u32 app_index;
  57
  58   /** Pointer to manager properties. Could be shared among all of
  59    * an app's segment managers s*/
  60   segment_manager_properties_t *properties;
  61 } segment_manager_t;
  62
  63 /** Pool of segment managers */
  64 extern segment_manager_t *segment_managers;
  65
  66 always_inline segment_manager_t *
  67 segment_manager_new ()
  68 {
  69   segment_manager_t *sm;
  70   pool_get (segment_managers, sm);
  71   memset (sm, 0, sizeof (*sm));
  72   return sm;
  73 }
  74
  75 always_inline segment_manager_t *
  76 segment_manager_get (u32 index)
  77 {
  78   return pool_elt_at_index (segment_managers, index);
  79 }
  80
  81 always_inline segment_manager_t *
  82 segment_manager_get_if_valid (u32 index)
  83 {
  84   if (pool_is_free_index (segment_managers, index))
  85     return 0;
  86   return pool_elt_at_index (segment_managers, index);
  87 }
  88
  89 always_inline u32
  90 segment_manager_index (segment_manager_t * sm)
  91 {
  92   return sm - segment_managers;
  93 }
  94
  95 int
  96 segment_manager_init (segment_manager_t * sm,
  97                       segment_manager_properties_t * properties,
  98                       u32 seg_size);
  99
 100 void segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size);
 101 int
 102 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size);
 103 void segment_manager_first_segment_maybe_del (segment_manager_t * sm);
 104 int session_manager_add_segment (segment_manager_t * sm);
 105 void segment_manager_del (segment_manager_t * sm);
 106 int
 107 segment_manager_alloc_session_fifos (segment_manager_t * sm,
 108                                      svm_fifo_t ** server_rx_fifo,
 109                                      svm_fifo_t ** server_tx_fifo,
 110                                      u32 * fifo_segment_index);
 111 void
 112 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
 113                                svm_fifo_t * tx_fifo);
 114 unix_shared_memory_queue_t *segment_manager_alloc_queue (segment_manager_t *
 115                                                          sm, u32 queue_size);
 116 void segment_manager_dealloc_queue (segment_manager_t * sm,
 117                                     unix_shared_memory_queue_t * q);
 118
 119 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
 120 /*
 121  * fd.io coding-style-patch-verification: ON
 122  *
 123  * Local Variables:
 124  * eval: (c-set-style "gnu")
 125  * End:
 126  */