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 typedef struct _segment_manager_properties
  22 {
  23   /** Session fifo sizes.  */
  24   u32 rx_fifo_size;
  25   u32 tx_fifo_size;
  26
  27   /** Configured additional segment size */
  28   u32 add_segment_size;
  29
  30   /** Flag that indicates if additional segments should be created */
  31   u8 add_segment;
  32
  33 } segment_manager_properties_t;
  34
  35 typedef struct _segment_manager
  36 {
  37   /** segments mapped by this manager */
  38   u32 *segment_indices;
  39
  40   /** Owner app index */
  41   u32 app_index;
  42
  43   /** Pointer to manager properties. Could be shared among all of
  44    * an app's segment managers s*/
  45   segment_manager_properties_t *properties;
  46 } segment_manager_t;
  47
  48 /** Pool of segment managers */
  49 extern segment_manager_t *segment_managers;
  50
  51 always_inline segment_manager_t *
  52 segment_manager_new ()
  53 {
  54   segment_manager_t *sm;
  55   pool_get (segment_managers, sm);
  56   memset (sm, 0, sizeof (*sm));
  57   return sm;
  58 }
  59
  60 always_inline segment_manager_t *
  61 segment_manager_get (u32 index)
  62 {
  63   return pool_elt_at_index (segment_managers, index);
  64 }
  65
  66 always_inline segment_manager_t *
  67 segment_manager_get_if_valid (u32 index)
  68 {
  69   if (pool_is_free_index (segment_managers, index))
  70     return 0;
  71   return pool_elt_at_index (segment_managers, index);
  72 }
  73
  74 always_inline u32
  75 segment_manager_index (segment_manager_t * sm)
  76 {
  77   return sm - segment_managers;
  78 }
  79
  80 int
  81 segment_manager_init (segment_manager_t * sm,
  82                       segment_manager_properties_t * properties,
  83                       u32 seg_size);
  84
  85 void segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size);
  86 int
  87 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size);
  88 int session_manager_add_segment (segment_manager_t * sm);
  89 void segment_manager_del (segment_manager_t * sm);
  90 int
  91 segment_manager_alloc_session_fifos (segment_manager_t * sm,
  92                                      svm_fifo_t ** server_rx_fifo,
  93                                      svm_fifo_t ** server_tx_fifo,
  94                                      u32 * fifo_segment_index);
  95 void
  96 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
  97                                svm_fifo_t * tx_fifo);
  98
  99 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
 100 /*
 101  * fd.io coding-style-patch-verification: ON
 102  *
 103  * Local Variables:
 104  * eval: (c-set-style "gnu")
 105  * End:
 106  */