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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef SRC_VNET_SESSION_SEGMENT_MANAGER_H_
16 #define SRC_VNET_SESSION_SEGMENT_MANAGER_H_
18 #include <vnet/vnet.h>
19 #include <svm/svm_fifo_segment.h>
21 #include <vlibmemory/unix_shared_memory_queue.h>
22 #include <vlibmemory/api.h>
23 #include <vppinfra/lock.h>
25 typedef struct _segment_manager_properties
27 /** Session fifo sizes. */
31 /** Preallocated pool sizes */
32 u32 preallocated_fifo_pairs;
34 /** Configured additional segment size */
37 /** Flag that indicates if additional segments should be created */
40 /** Use private memory segment instead of shared memory */
41 u8 use_private_segment;
42 } segment_manager_properties_t;
44 typedef struct _segment_manager
46 clib_spinlock_t lockp;
48 /** segments mapped by this manager */
51 /** Owner app index */
54 /** Pointer to manager properties. Could be shared among all of
55 * an app's segment managers s*/
56 segment_manager_properties_t *properties;
59 /** Pool of segment managers */
60 extern segment_manager_t *segment_managers;
62 always_inline segment_manager_t *
63 segment_manager_new ()
65 segment_manager_t *sm;
66 pool_get (segment_managers, sm);
67 memset (sm, 0, sizeof (*sm));
71 always_inline segment_manager_t *
72 segment_manager_get (u32 index)
74 return pool_elt_at_index (segment_managers, index);
77 always_inline segment_manager_t *
78 segment_manager_get_if_valid (u32 index)
80 if (pool_is_free_index (segment_managers, index))
82 return pool_elt_at_index (segment_managers, index);
86 segment_manager_index (segment_manager_t * sm)
88 return sm - segment_managers;
92 segment_manager_init (segment_manager_t * sm,
93 segment_manager_properties_t * properties,
96 void segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size);
98 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size);
99 void segment_manager_first_segment_maybe_del (segment_manager_t * sm);
100 int session_manager_add_segment (segment_manager_t * sm);
101 void segment_manager_del (segment_manager_t * sm);
103 segment_manager_alloc_session_fifos (segment_manager_t * sm,
104 svm_fifo_t ** server_rx_fifo,
105 svm_fifo_t ** server_tx_fifo,
106 u32 * fifo_segment_index);
108 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
109 svm_fifo_t * tx_fifo);
110 unix_shared_memory_queue_t *segment_manager_alloc_queue (segment_manager_t *
112 void segment_manager_dealloc_queue (segment_manager_t * sm,
113 unix_shared_memory_queue_t * q);
115 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
117 * fd.io coding-style-patch-verification: ON
120 * eval: (c-set-style "gnu")