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>
20 #include <svm/queue.h>
21 #include <vlibmemory/api.h>
22 #include <vppinfra/lock.h>
23 #include <vppinfra/valloc.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 /** Segment type: if set to SSVM_N_TYPES, private segments are used */
41 ssvm_segment_type_t segment_type;
43 /** Use one or more private mheaps, instead of the global heap */
44 // u32 private_segment_count;
45 } segment_manager_properties_t;
47 typedef struct _segment_manager
49 /** Pool of segments allocated by this manager */
50 svm_fifo_segment_private_t *segments;
52 /** rwlock that protects the segments pool */
53 clib_rwlock_t segments_rwlock;
55 /** Owner app index */
59 * First segment should not be deleted unless segment manger is deleted.
60 * This also indicates that the segment manager is the first to have been
61 * allocated for the app.
63 u8 first_is_protected;
66 * App event queue allocated in first segment
68 svm_queue_t *event_queue;
71 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY) \
73 clib_rwlock_reader_lock (&(SM)->segments_rwlock); \
74 pool_foreach((VAR), ((SM)->segments), (BODY)); \
75 clib_rwlock_reader_unlock (&(SM)->segments_rwlock); \
78 typedef struct segment_manager_main_
80 /** Pool of segment managers */
81 segment_manager_t *segment_managers;
83 /** Virtual address allocator */
84 clib_valloc_main_t va_allocator;
86 } segment_manager_main_t;
88 extern segment_manager_main_t segment_manager_main;
90 typedef struct segment_manager_main_init_args_
94 } segment_manager_main_init_args_t;
96 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
98 /** Pool of segment managers */
99 extern segment_manager_t *segment_managers;
101 always_inline segment_manager_t *
102 segment_manager_get (u32 index)
104 return pool_elt_at_index (segment_manager_main.segment_managers, index);
107 always_inline segment_manager_t *
108 segment_manager_get_if_valid (u32 index)
110 if (pool_is_free_index (segment_manager_main.segment_managers, index))
112 return pool_elt_at_index (segment_manager_main.segment_managers, index);
116 segment_manager_index (segment_manager_t * sm)
118 return sm - segment_manager_main.segment_managers;
121 always_inline svm_queue_t *
122 segment_manager_event_queue (segment_manager_t * sm)
124 return sm->event_queue;
127 segment_manager_t *segment_manager_new ();
128 int segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
129 u32 evt_q_size, u32 prealloc_fifo_pairs);
131 svm_fifo_segment_private_t *segment_manager_get_segment (segment_manager_t *
134 svm_fifo_segment_private_t
135 * segment_manager_get_segment_w_lock (segment_manager_t * sm,
137 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
138 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
140 int segment_manager_add_first_segment (segment_manager_t * sm,
142 void segment_manager_del_sessions (segment_manager_t * sm);
143 void segment_manager_del (segment_manager_t * sm);
144 void segment_manager_init_del (segment_manager_t * sm);
145 u8 segment_manager_has_fifos (segment_manager_t * sm);
147 segment_manager_alloc_session_fifos (segment_manager_t * sm,
148 svm_fifo_t ** server_rx_fifo,
149 svm_fifo_t ** server_tx_fifo,
150 u32 * fifo_segment_index);
152 segment_manager_dealloc_fifos (u32 svm_segment_index, svm_fifo_t * rx_fifo,
153 svm_fifo_t * tx_fifo);
154 svm_queue_t *segment_manager_alloc_queue (segment_manager_t * sm,
156 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
157 void segment_manager_app_detach (segment_manager_t * sm);
159 void segment_manager_main_init (segment_manager_main_init_args_t * a);
160 segment_manager_properties_t
161 * segment_manager_properties_init (segment_manager_properties_t * sm);
163 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
165 * fd.io coding-style-patch-verification: ON
168 * eval: (c-set-style "gnu")