blob: 454fef879672c1226456789c5dc2c0c1ef0695c8 [file] [log] [blame]
Florin Coras6cf30ad2017-04-04 23:08:23 -07001/*
Florin Coras288eaab2019-02-03 15:26:14 -08002 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
Florin Coras6cf30ad2017-04-04 23:08:23 -07003 * 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
Florin Coras3c2fed52018-07-04 04:15:05 -070018#include <svm/message_queue.h>
Florin Corasa5464812017-04-19 13:00:05 -070019#include <vppinfra/lock.h>
Florin Corasa332c462018-01-31 06:52:17 -080020#include <vppinfra/valloc.h>
Florin Coras88001c62019-04-24 14:44:46 -070021#include <svm/fifo_segment.h>
Ryujiro Shibuyad8f48e22020-01-22 12:11:42 +000022#include <vnet/session/session_types.h>
Florin Corasa5464812017-04-19 13:00:05 -070023
Florin Coras88001c62019-04-24 14:44:46 -070024typedef struct _segment_manager_props
Florin Coras6cf30ad2017-04-04 23:08:23 -070025{
Florin Coras15531972018-08-12 23:50:53 -070026 u32 rx_fifo_size; /**< receive fifo size */
27 u32 tx_fifo_size; /**< transmit fifo size */
28 u32 evt_q_size; /**< event queue length */
Florin Coras15531972018-08-12 23:50:53 -070029 u32 prealloc_fifos; /**< preallocated fifo pairs */
Florin Coras9845c202020-04-28 01:54:22 +000030 u32 prealloc_fifo_hdrs; /**< preallocated fifo hdrs */
Florin Corasef4f3e72019-12-11 14:27:53 -080031 uword segment_size; /**< first segment size */
32 uword add_segment_size; /**< additional segment size */
Florin Coras15531972018-08-12 23:50:53 -070033 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 */
Florin Coras62ddc032019-12-08 18:30:42 -080036 u8 n_slices; /**< number of fs slices/threads */
Florin Coras15531972018-08-12 23:50:53 -070037 ssvm_segment_type_t segment_type; /**< seg type: if set to SSVM_N_TYPES,
38 private segments are used */
Ryujiro Shibuyad8f48e22020-01-22 12:11:42 +000039 u32 max_fifo_size; /**< max fifo size */
Ryujiro Shibuya234fe892019-12-25 07:40:54 +000040 u8 high_watermark; /**< memory usage high watermark % */
41 u8 low_watermark; /**< memory usage low watermark % */
Florin Coras2de9c0f2020-02-02 19:30:39 +000042 u8 pct_first_alloc; /**< pct of fifo size to alloc */
Florin Coras88001c62019-04-24 14:44:46 -070043} segment_manager_props_t;
Florin Coras6cf30ad2017-04-04 23:08:23 -070044
Florin Corasc8e812f2020-05-14 05:32:18 +000045typedef enum seg_manager_flag_
46{
47 SEG_MANAGER_F_DETACHED = 1 << 0,
48 SEG_MANAGER_F_DETACHED_LISTENER = 1 << 1,
49} seg_manager_flag_t;
50
Florin Coras6cf30ad2017-04-04 23:08:23 -070051typedef struct _segment_manager
52{
Florin Corasa332c462018-01-31 06:52:17 -080053 /** Pool of segments allocated by this manager */
Florin Coras88001c62019-04-24 14:44:46 -070054 fifo_segment_t *segments;
Florin Corasa5464812017-04-19 13:00:05 -070055
Florin Corasa332c462018-01-31 06:52:17 -080056 /** rwlock that protects the segments pool */
57 clib_rwlock_t segments_rwlock;
Florin Coras6cf30ad2017-04-04 23:08:23 -070058
Florin Coras15531972018-08-12 23:50:53 -070059 /** Owner app worker index */
60 u32 app_wrk_index;
Florin Coras6cf30ad2017-04-04 23:08:23 -070061
Florin Corasc87c91d2017-08-16 19:55:49 -070062 /**
Florin Corasc87c91d2017-08-16 19:55:49 -070063 * 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;
Florin Corasa332c462018-01-31 06:52:17 -080068
69 /**
70 * App event queue allocated in first segment
71 */
Florin Coras3c2fed52018-07-04 04:15:05 -070072 svm_msg_q_t *event_queue;
Ryujiro Shibuya234fe892019-12-25 07:40:54 +000073
Florin Corasc8e812f2020-05-14 05:32:18 +000074 u8 flags;
75
Ryujiro Shibuyad8f48e22020-01-22 12:11:42 +000076 u32 max_fifo_size;
Ryujiro Shibuya234fe892019-12-25 07:40:54 +000077 u8 high_watermark;
78 u8 low_watermark;
Florin Coras6cf30ad2017-04-04 23:08:23 -070079} segment_manager_t;
80
Florin Corasc87c91d2017-08-16 19:55:49 -070081#define SEGMENT_MANAGER_INVALID_APP_INDEX ((u32) ~0)
82
Florin Coras88001c62019-04-24 14:44:46 -070083segment_manager_t *segment_manager_alloc (void);
Ryujiro Shibuya234fe892019-12-25 07:40:54 +000084int segment_manager_init (segment_manager_t * sm);
Florin Corasa107f402020-09-29 19:18:46 -070085int segment_manager_init_first (segment_manager_t * sm);
Florin Coras6cf30ad2017-04-04 23:08:23 -070086
Florin Coras88001c62019-04-24 14:44:46 -070087/**
88 * Cleanup segment manager
89 *
90 * @param sm segment manager to be freed
91 */
92void segment_manager_free (segment_manager_t * sm);
93
94/**
95 * Initiate segment manager cleanup
96 *
97 * @param sm segment manager to be freed
98 */
99void segment_manager_init_free (segment_manager_t * sm);
100segment_manager_t *segment_manager_get (u32 index);
101segment_manager_t *segment_manager_get_if_valid (u32 index);
102u32 segment_manager_index (segment_manager_t * sm);
103
Florin Corasef4f3e72019-12-11 14:27:53 -0800104int segment_manager_add_segment (segment_manager_t * sm, uword segment_size);
Florin Corasf8f516a2018-02-08 15:10:09 -0800105void segment_manager_del_segment (segment_manager_t * sm,
Florin Coras88001c62019-04-24 14:44:46 -0700106 fifo_segment_t * fs);
Florin Coras2d0e3de2020-10-23 16:31:40 -0700107void segment_manager_lock_and_del_segment (segment_manager_t * sm,
108 u32 fs_index);
Florin Coras88001c62019-04-24 14:44:46 -0700109fifo_segment_t *segment_manager_get_segment (segment_manager_t * sm,
110 u32 segment_index);
111fifo_segment_t *segment_manager_get_segment_w_handle (u64 sh);
Florin Corasb095a3c2019-04-25 12:58:46 -0700112fifo_segment_t *segment_manager_get_segment_w_lock (segment_manager_t * sm,
Florin Coras88001c62019-04-24 14:44:46 -0700113 u32 segment_index);
114int segment_manager_add_first_segment (segment_manager_t * sm,
115 u32 segment_size);
116u64 segment_manager_make_segment_handle (u32 segment_manager_index,
117 u32 segment_index);
118u64 segment_manager_segment_handle (segment_manager_t * sm,
119 fifo_segment_t * segment);
Florin Corasa332c462018-01-31 06:52:17 -0800120void segment_manager_segment_reader_unlock (segment_manager_t * sm);
121void segment_manager_segment_writer_unlock (segment_manager_t * sm);
122
Florin Corasf8f516a2018-02-08 15:10:09 -0800123int segment_manager_alloc_session_fifos (segment_manager_t * sm,
Florin Coras62ddc032019-12-08 18:30:42 -0800124 u32 thread_index,
Florin Coras88001c62019-04-24 14:44:46 -0700125 svm_fifo_t ** rx_fifo,
126 svm_fifo_t ** tx_fifo);
127int segment_manager_try_alloc_fifos (fifo_segment_t * fs,
Florin Coras62ddc032019-12-08 18:30:42 -0800128 u32 thread_index,
Florin Corasf8f516a2018-02-08 15:10:09 -0800129 u32 rx_fifo_size, u32 tx_fifo_size,
130 svm_fifo_t ** rx_fifo,
131 svm_fifo_t ** tx_fifo);
Florin Coras19223e02019-03-03 14:56:05 -0800132void segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo,
Florin Corasf8f516a2018-02-08 15:10:09 -0800133 svm_fifo_t * tx_fifo);
Florin Coras6d7552c2020-04-09 01:49:45 +0000134void segment_manager_detach_fifo (segment_manager_t * sm, svm_fifo_t * f);
135void segment_manager_attach_fifo (segment_manager_t * sm, svm_fifo_t * f,
136 session_t * s);
Florin Corasb095a3c2019-04-25 12:58:46 -0700137
Ryujiro Shibuya234fe892019-12-25 07:40:54 +0000138void segment_manager_set_watermarks (segment_manager_t * sm,
139 u8 high_watermark, u8 low_watermark);
140
Florin Coras88001c62019-04-24 14:44:46 -0700141u8 segment_manager_has_fifos (segment_manager_t * sm);
142
143svm_msg_q_t *segment_manager_alloc_queue (fifo_segment_t * fs,
144 segment_manager_props_t * props);
Florin Corase86a8ed2018-01-05 03:20:25 -0800145void segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q);
Florin Coras88001c62019-04-24 14:44:46 -0700146svm_msg_q_t *segment_manager_event_queue (segment_manager_t * sm);
147u32 segment_manager_evt_q_expected_size (u32 q_size);
148
Florin Corasbf395972020-04-30 15:05:24 +0000149u8 segment_manager_app_detached (segment_manager_t * sm);
Florin Coras4e4531e2017-11-06 23:27:56 -0800150void segment_manager_app_detach (segment_manager_t * sm);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700151
Florin Coras88001c62019-04-24 14:44:46 -0700152/**
153 * Cleanup segment manager sessions
154 *
155 * Initiates disconnects for all sessions 'owned' by a segment manager by
156 * leveraging the backpointers that fifos keep.
157 *
158 * @param sm segment manager whose sessions are to be disconnected
159 */
160void segment_manager_del_sessions (segment_manager_t * sm);
161void segment_manager_format_sessions (segment_manager_t * sm, int verbose);
162
Florin Coras9a45bd82020-12-28 16:28:07 -0800163void segment_manager_main_init (void);
Florin Coras88001c62019-04-24 14:44:46 -0700164
165segment_manager_props_t *segment_manager_props_init (segment_manager_props_t *
166 sm);
Florin Corasad0c77f2017-11-09 18:00:15 -0800167
Florin Coras9845c202020-04-28 01:54:22 +0000168static inline void
169segment_manager_parse_segment_handle (u64 segment_handle, u32 * sm_index,
170 u32 * segment_index)
171{
172 *sm_index = segment_handle >> 32;
173 *segment_index = segment_handle & 0xFFFFFFFF;
174}
175
Florin Coras6cf30ad2017-04-04 23:08:23 -0700176#endif /* SRC_VNET_SESSION_SEGMENT_MANAGER_H_ */
177/*
178 * fd.io coding-style-patch-verification: ON
179 *
180 * Local Variables:
181 * eval: (c-set-style "gnu")
182 * End:
183 */