FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
segment_manager.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #ifndef SRC_VNET_SESSION_SEGMENT_MANAGER_H_
16 #define SRC_VNET_SESSION_SEGMENT_MANAGER_H_
17 
18 #include <svm/message_queue.h>
19 #include <vppinfra/lock.h>
20 #include <vppinfra/valloc.h>
21 #include <svm/fifo_segment.h>
23 
24 typedef struct _segment_manager_props
25 {
26  u32 rx_fifo_size; /**< receive fifo size */
27  u32 tx_fifo_size; /**< transmit fifo size */
28  u32 evt_q_size; /**< event queue length */
29  u32 prealloc_fifos; /**< preallocated fifo pairs */
30  u32 prealloc_fifo_hdrs; /**< preallocated fifo hdrs */
31  uword segment_size; /**< first segment size */
32  uword add_segment_size; /**< additional segment size */
33  u8 add_segment:1; /**< can add new segments flag */
34  u8 use_mq_eventfd:1; /**< use eventfds for mqs flag */
35  u8 reserved:6; /**< reserved flags */
36  u8 n_slices; /**< number of fs slices/threads */
37  ssvm_segment_type_t segment_type; /**< seg type: if set to SSVM_N_TYPES,
38  private segments are used */
39  u32 max_fifo_size; /**< max fifo size */
40  u8 high_watermark; /**< memory usage high watermark % */
41  u8 low_watermark; /**< memory usage low watermark % */
42  u8 pct_first_alloc; /**< pct of fifo size to alloc */
44 
45 typedef enum seg_manager_flag_
46 {
50 
51 typedef struct _segment_manager
52 {
53  /** Pool of segments allocated by this manager */
54  fifo_segment_t *segments;
55 
56  /** rwlock that protects the segments pool */
57  clib_rwlock_t segments_rwlock;
58 
59  /** Owner app worker index */
60  u32 app_wrk_index;
61 
62  /**
63  * First segment should not be deleted unless segment manger is deleted.
64  * This also indicates that the segment manager is the first to have been
65  * allocated for the app.
66  */
67  u8 first_is_protected;
68 
69  /**
70  * App event queue allocated in first segment
71  */
72  svm_msg_q_t *event_queue;
73 
74  u8 flags;
75 
76  u32 max_fifo_size;
77  u8 high_watermark;
78  u8 low_watermark;
80 
82 {
86 
87 #define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
88 
91 
92 /**
93  * Cleanup segment manager
94  *
95  * @param sm segment manager to be freed
96  */
98 
99 /**
100  * Initiate segment manager cleanup
101  *
102  * @param sm segment manager to be freed
103  */
108 
109 int segment_manager_add_segment (segment_manager_t * sm, uword segment_size);
111  fifo_segment_t * fs);
113  u32 segment_index);
116  u32 segment_index);
118  u32 segment_size);
120  u32 segment_index);
122  fifo_segment_t * segment);
125 
127  u32 thread_index,
128  svm_fifo_t ** rx_fifo,
129  svm_fifo_t ** tx_fifo);
131  u32 thread_index,
132  u32 rx_fifo_size, u32 tx_fifo_size,
133  svm_fifo_t ** rx_fifo,
134  svm_fifo_t ** tx_fifo);
136  svm_fifo_t * tx_fifo);
139  session_t * s);
140 
142  u8 high_watermark, u8 low_watermark);
143 
145 
147  segment_manager_props_t * props);
151 
154 
155 /**
156  * Cleanup segment manager sessions
157  *
158  * Initiates disconnects for all sessions 'owned' by a segment manager by
159  * leveraging the backpointers that fifos keep.
160  *
161  * @param sm segment manager whose sessions are to be disconnected
162  */
164 void segment_manager_format_sessions (segment_manager_t * sm, int verbose);
165 
167 
169  sm);
170 
171 static inline void
172 segment_manager_parse_segment_handle (u64 segment_handle, u32 * sm_index,
173  u32 * segment_index)
174 {
175  *sm_index = segment_handle >> 32;
176  *segment_index = segment_handle & 0xFFFFFFFF;
177 }
178 
179 #endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
180 /*
181  * fd.io coding-style-patch-verification: ON
182  *
183  * Local Variables:
184  * eval: (c-set-style "gnu")
185  * End:
186  */
void segment_manager_free(segment_manager_t *sm)
Cleanup segment manager.
u32 segment_manager_index(segment_manager_t *sm)
int segment_manager_init(segment_manager_t *sm)
Initializes segment manager based on options provided.
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:103
a
Definition: bitmap.h:538
unsigned long u64
Definition: types.h:89
struct segment_manager_main_init_args_ segment_manager_main_init_args_t
static void segment_manager_parse_segment_handle(u64 segment_handle, u32 *sm_index, u32 *segment_index)
fifo_segment_t * segment_manager_get_segment_w_handle(u64 sh)
unsigned char u8
Definition: types.h:56
u8 segment_manager_has_fifos(segment_manager_t *sm)
segment_manager_t * segment_manager_get(u32 index)
enum seg_manager_flag_ seg_manager_flag_t
void segment_manager_segment_reader_unlock(segment_manager_t *sm)
enum ssvm_segment_type_ ssvm_segment_type_t
segment_manager_props_t * segment_manager_props_init(segment_manager_props_t *sm)
seg_manager_flag_
void segment_manager_app_detach(segment_manager_t *sm)
static CLIB_NOSANITIZE_ADDR void add_segment(mstate m, char *tbase, size_t tsize, flag_t mmapped)
Definition: dlmalloc.c:2585
int segment_manager_add_first_segment(segment_manager_t *sm, u32 segment_size)
Simple first-fit virtual space allocator.
segment_manager_t * segment_manager_alloc(void)
unsigned int u32
Definition: types.h:88
segment_manager_t * segment_manager_get_if_valid(u32 index)
u32 segment_manager_evt_q_expected_size(u32 q_size)
svm_msg_q_t * segment_manager_event_queue(segment_manager_t *sm)
int segment_manager_alloc_session_fifos(segment_manager_t *sm, u32 thread_index, svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo)
u64 segment_manager_make_segment_handle(u32 segment_manager_index, u32 segment_index)
svm_msg_q_t * segment_manager_alloc_queue(fifo_segment_t *fs, segment_manager_props_t *props)
Allocates shm queue in the first segment.
void segment_manager_dealloc_fifos(svm_fifo_t *rx_fifo, svm_fifo_t *tx_fifo)
void segment_manager_set_watermarks(segment_manager_t *sm, u8 high_watermark, u8 low_watermark)
struct _segment_manager_props segment_manager_props_t
int segment_manager_add_segment(segment_manager_t *sm, uword segment_size)
Adds segment to segment manager&#39;s pool.
void segment_manager_del_segment(segment_manager_t *sm, fifo_segment_t *fs)
Remove segment without lock.
fifo_segment_t * segment_manager_get_segment(segment_manager_t *sm, u32 segment_index)
Reads a segment from the segment manager&#39;s pool without lock.
u8 segment_manager_app_detached(segment_manager_t *sm)
Unidirectional shared-memory multi-ring message queue.
void segment_manager_detach_fifo(segment_manager_t *sm, svm_fifo_t *f)
void segment_manager_segment_writer_unlock(segment_manager_t *sm)
u64 segment_manager_segment_handle(segment_manager_t *sm, fifo_segment_t *segment)
void segment_manager_attach_fifo(segment_manager_t *sm, svm_fifo_t *f, session_t *s)
u64 uword
Definition: types.h:112
u32 index
Definition: flow_types.api:221
struct _segment_manager segment_manager_t
struct _svm_queue svm_queue_t
void segment_manager_dealloc_queue(segment_manager_t *sm, svm_queue_t *q)
Frees shm queue allocated in the first segment.
void segment_manager_init_free(segment_manager_t *sm)
Initiate segment manager cleanup.
void segment_manager_format_sessions(segment_manager_t *sm, int verbose)
fifo_segment_t * segment_manager_get_segment_w_lock(segment_manager_t *sm, u32 segment_index)
Reads a segment from the segment manager&#39;s pool and acquires reader lock.
void segment_manager_main_init(segment_manager_main_init_args_t *a)
struct _svm_fifo svm_fifo_t
int segment_manager_try_alloc_fifos(fifo_segment_t *fs, u32 thread_index, u32 rx_fifo_size, u32 tx_fifo_size, svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo)
void segment_manager_del_sessions(segment_manager_t *sm)
Cleanup segment manager sessions.