2 * Copyright (c) 2017-2019 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 <svm/message_queue.h>
19 #include <vppinfra/lock.h>
20 #include <vppinfra/valloc.h>
21 #include <svm/fifo_segment.h>
23 typedef struct _segment_manager_props
25 u32 rx_fifo_size; /**< receive fifo size */
26 u32 tx_fifo_size; /**< transmit fifo size */
27 u32 evt_q_size; /**< event queue length */
28 u32 prealloc_fifos; /**< preallocated fifo pairs */
29 uword segment_size; /**< first segment size */
30 uword add_segment_size; /**< additional segment size */
31 u8 add_segment:1; /**< can add new segments flag */
32 u8 use_mq_eventfd:1; /**< use eventfds for mqs flag */
33 u8 reserved:6; /**< reserved flags */
34 u8 n_slices; /**< number of fs slices/threads */
35 ssvm_segment_type_t segment_type; /**< seg type: if set to SSVM_N_TYPES,
36 private segments are used */
37 } segment_manager_props_t;
39 typedef struct _segment_manager
41 /** Pool of segments allocated by this manager */
42 fifo_segment_t *segments;
44 /** rwlock that protects the segments pool */
45 clib_rwlock_t segments_rwlock;
47 /** Owner app worker index */
51 * First segment should not be deleted unless segment manger is deleted.
52 * This also indicates that the segment manager is the first to have been
53 * allocated for the app.
55 u8 first_is_protected;
58 * App event queue allocated in first segment
60 svm_msg_q_t *event_queue;
63 typedef struct segment_manager_main_init_args_
67 } segment_manager_main_init_args_t;
69 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
71 segment_manager_t *segment_manager_alloc (void);
72 int segment_manager_init (segment_manager_t * sm, uword first_seg_size,
73 u32 prealloc_fifo_pairs);
76 * Cleanup segment manager
78 * @param sm segment manager to be freed
80 void segment_manager_free (segment_manager_t * sm);
83 * Initiate segment manager cleanup
85 * @param sm segment manager to be freed
87 void segment_manager_init_free (segment_manager_t * sm);
88 segment_manager_t *segment_manager_get (u32 index);
89 segment_manager_t *segment_manager_get_if_valid (u32 index);
90 u32 segment_manager_index (segment_manager_t * sm);
92 int segment_manager_add_segment (segment_manager_t * sm, uword segment_size);
93 void segment_manager_del_segment (segment_manager_t * sm,
95 fifo_segment_t *segment_manager_get_segment (segment_manager_t * sm,
97 fifo_segment_t *segment_manager_get_segment_w_handle (u64 sh);
98 fifo_segment_t *segment_manager_get_segment_w_lock (segment_manager_t * sm,
100 int segment_manager_add_first_segment (segment_manager_t * sm,
102 u64 segment_manager_make_segment_handle (u32 segment_manager_index,
104 u64 segment_manager_segment_handle (segment_manager_t * sm,
105 fifo_segment_t * segment);
106 void segment_manager_segment_reader_unlock (segment_manager_t * sm);
107 void segment_manager_segment_writer_unlock (segment_manager_t * sm);
109 int segment_manager_alloc_session_fifos (segment_manager_t * sm,
111 svm_fifo_t ** rx_fifo,
112 svm_fifo_t ** tx_fifo);
113 int segment_manager_try_alloc_fifos (fifo_segment_t * fs,
115 u32 rx_fifo_size, u32 tx_fifo_size,
116 svm_fifo_t ** rx_fifo,
117 svm_fifo_t ** tx_fifo);
118 void segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo,
119 svm_fifo_t * tx_fifo);
121 u8 segment_manager_has_fifos (segment_manager_t * sm);
123 svm_msg_q_t *segment_manager_alloc_queue (fifo_segment_t * fs,
124 segment_manager_props_t * props);
125 void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
126 svm_msg_q_t *segment_manager_event_queue (segment_manager_t * sm);
127 u32 segment_manager_evt_q_expected_size (u32 q_size);
129 void segment_manager_app_detach (segment_manager_t * sm);
132 * Cleanup segment manager sessions
134 * Initiates disconnects for all sessions 'owned' by a segment manager by
135 * leveraging the backpointers that fifos keep.
137 * @param sm segment manager whose sessions are to be disconnected
139 void segment_manager_del_sessions (segment_manager_t * sm);
140 void segment_manager_format_sessions (segment_manager_t * sm, int verbose);
142 void segment_manager_main_init (segment_manager_main_init_args_t * a);
144 segment_manager_props_t *segment_manager_props_init (segment_manager_props_t *
147 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
149 * fd.io coding-style-patch-verification: ON
152 * eval: (c-set-style "gnu")