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 /** Configured additional segment size */
34 /** Flag that indicates if additional segments should be created */
37 /** Use private memory segment instead of shared memory */
38 u8 use_private_segment;
39 } segment_manager_properties_t;
41 typedef struct _segment_manager
43 clib_spinlock_t lockp;
45 /** segments mapped by this manager */
48 /** Owner app index */
51 /** Pointer to manager properties. Could be shared among all of
52 * an app's segment managers s*/
53 segment_manager_properties_t *properties;
56 /** Pool of segment managers */
57 extern segment_manager_t *segment_managers;
59 always_inline segment_manager_t *
60 segment_manager_new ()
62 segment_manager_t *sm;
63 pool_get (segment_managers, sm);
64 memset (sm, 0, sizeof (*sm));
68 always_inline segment_manager_t *
69 segment_manager_get (u32 index)
71 return pool_elt_at_index (segment_managers, index);
74 always_inline segment_manager_t *
75 segment_manager_get_if_valid (u32 index)
77 if (pool_is_free_index (segment_managers, index))
79 return pool_elt_at_index (segment_managers, index);
83 segment_manager_index (segment_manager_t * sm)
85 return sm - segment_managers;
89 segment_manager_init (segment_manager_t * sm,
90 segment_manager_properties_t * properties,
93 void segment_manager_get_segment_info (u32 index, u8 ** name, u32 * size);
95 session_manager_add_first_segment (segment_manager_t * sm, u32 segment_size);
96 int session_manager_add_segment (segment_manager_t * sm);
97 void segment_manager_del (segment_manager_t * sm);
99 segment_manager_alloc_session_fifos (segment_manager_t * sm,
100 svm_fifo_t ** server_rx_fifo,
101 svm_fifo_t ** server_tx_fifo,
102 u32 * fifo_segment_index);
104 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
105 svm_fifo_t * tx_fifo);
106 unix_shared_memory_queue_t *segment_manager_alloc_queue (segment_manager_t *
108 void segment_manager_dealloc_queue (segment_manager_t * sm,
109 unix_shared_memory_queue_t * q);
111 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
113 * fd.io coding-style-patch-verification: ON
116 * eval: (c-set-style "gnu")