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. */
32 /** Configured additional segment size */
35 /** Flag that indicates if additional segments should be created */
38 /** Segment type: if set to SSVM_N_TYPES, private segments are used */
39 ssvm_segment_type_t segment_type;
41 } segment_manager_properties_t;
43 typedef struct _segment_manager
45 /** Pool of segments allocated by this manager */
46 svm_fifo_segment_private_t *segments;
48 /** rwlock that protects the segments pool */
49 clib_rwlock_t segments_rwlock;
51 /** Owner app index */
55 * First segment should not be deleted unless segment manger is deleted.
56 * This also indicates that the segment manager is the first to have been
57 * allocated for the app.
59 u8 first_is_protected;
62 * App event queue allocated in first segment
64 svm_queue_t *event_queue;
67 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY) \
69 clib_rwlock_reader_lock (&(SM)->segments_rwlock); \
70 pool_foreach((VAR), ((SM)->segments), (BODY)); \
71 clib_rwlock_reader_unlock (&(SM)->segments_rwlock); \
74 typedef struct segment_manager_main_
76 /** Pool of segment managers */
77 segment_manager_t *segment_managers;
79 /** Virtual address allocator */
80 clib_valloc_main_t va_allocator;
82 } segment_manager_main_t;
84 extern segment_manager_main_t segment_manager_main;
86 typedef struct segment_manager_main_init_args_
90 } segment_manager_main_init_args_t;
92 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
94 /** Pool of segment managers */
95 extern segment_manager_t *segment_managers;
97 always_inline segment_manager_t *
98 segment_manager_get (u32 index)
100 return pool_elt_at_index (segment_manager_main.segment_managers, index);
103 always_inline segment_manager_t *
104 segment_manager_get_if_valid (u32 index)
106 if (pool_is_free_index (segment_manager_main.segment_managers, index))
108 return pool_elt_at_index (segment_manager_main.segment_managers, index);
112 segment_manager_index (segment_manager_t * sm)
114 return sm - segment_manager_main.segment_managers;
117 always_inline svm_queue_t *
118 segment_manager_event_queue (segment_manager_t * sm)
120 return sm->event_queue;
123 segment_manager_t *segment_manager_new ();
124 int segment_manager_init (segment_manager_t * sm, u32 first_seg_size,
125 u32 prealloc_fifo_pairs);
127 svm_fifo_segment_private_t *segment_manager_get_segment (segment_manager_t *
130 svm_fifo_segment_private_t
131 * segment_manager_get_segment_w_lock (segment_manager_t * sm,
133 int segment_manager_add_segment (segment_manager_t * sm, u32 segment_size);
134 void segment_manager_del_segment (segment_manager_t * sm,
135 svm_fifo_segment_private_t * fs);
136 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
137 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
139 int segment_manager_add_first_segment (segment_manager_t * sm,
141 void segment_manager_del_sessions (segment_manager_t * sm);
142 void segment_manager_del (segment_manager_t * sm);
143 void segment_manager_init_del (segment_manager_t * sm);
144 u8 segment_manager_has_fifos (segment_manager_t * sm);
145 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
146 svm_fifo_t ** server_rx_fifo,
147 svm_fifo_t ** server_tx_fifo,
148 u32 * fifo_segment_index);
149 int segment_manager_try_alloc_fifos (svm_fifo_segment_private_t * fs,
150 u32 rx_fifo_size, u32 tx_fifo_size,
151 svm_fifo_t ** rx_fifo,
152 svm_fifo_t ** tx_fifo);
153 void segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
154 svm_fifo_t * tx_fifo);
155 svm_queue_t *segment_manager_alloc_queue (svm_fifo_segment_private_t * fs,
157 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
158 void segment_manager_app_detach (segment_manager_t * sm);
160 void segment_manager_main_init (segment_manager_main_init_args_t * a);
161 segment_manager_properties_t
162 * segment_manager_properties_init (segment_manager_properties_t * sm);
164 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
166 * fd.io coding-style-patch-verification: ON
169 * eval: (c-set-style "gnu")