FD.io VPP  v17.07.01-10-g3be13f0
Vector Packet Processing
session.h
Go to the documentation of this file.
1 /*
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:
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 __included_session_h__
16 #define __included_session_h__
17 
18 #include <vnet/session/transport.h>
22 
23 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
24 #define INVALID_INDEX ((u32)~0)
25 
26 /* TODO decide how much since we have pre-data as well */
27 #define MAX_HDRS_LEN 100 /* Max number of bytes for headers */
28 
29 typedef enum
30 {
38 
39 #define foreach_session_input_error \
40 _(NO_SESSION, "No session drops") \
41 _(NO_LISTENER, "No listener for dst port drops") \
42 _(ENQUEUED, "Packets pushed into rx fifo") \
43 _(NOT_READY, "Session not ready packets") \
44 _(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
45 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
46 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
47 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
48 _(NO_SPACE, "Couldn't allocate a fifo pair")
49 
50 typedef enum
51 {
52 #define _(sym,str) SESSION_ERROR_##sym,
54 #undef _
57 
58 /* Event queue input node static next indices */
59 typedef enum
60 {
68 
69 #define foreach_session_type \
70  _(IP4_TCP, ip4_tcp) \
71  _(IP4_UDP, ip4_udp) \
72  _(IP6_TCP, ip6_tcp) \
73  _(IP6_UDP, ip6_udp)
74 
75 typedef enum
76 {
77 #define _(A, a) SESSION_TYPE_##A,
79 #undef _
82 
83 /*
84  * Application session state
85  */
86 typedef enum
87 {
94 
95 typedef struct
96 {
97  void *fp;
98  void *arg;
99 } rpc_args_t;
100 
101 /* *INDENT-OFF* */
102 typedef CLIB_PACKED (struct {
103  union
104  {
105  svm_fifo_t * fifo;
106  u64 session_handle;
107  rpc_args_t rpc_args;
108  };
109  u8 event_type;
110  u16 event_id;
111 }) session_fifo_event_t;
112 /* *INDENT-ON* */
113 
114 typedef struct _stream_session_t
115 {
116  /** fifo pointers. Once allocated, these do not move */
117  svm_fifo_t *server_rx_fifo;
118  svm_fifo_t *server_tx_fifo;
119 
120  /** Type */
121  u8 session_type;
122 
123  /** State */
124  u8 session_state;
125 
126  u8 thread_index;
127 
128  /** To avoid n**2 "one event per frame" check */
129  u8 enqueue_epoch;
130 
131  /** Pad to a multiple of 8 octets */
132  u8 align_pad[4];
133 
134  /** svm segment index where fifos were allocated */
135  u32 svm_segment_index;
136 
137  /** Session index in per_thread pool */
138  u32 session_index;
139 
140  /** Transport specific */
141  u32 connection_index;
142 
143  /** Application specific */
144  u32 pid;
145 
146  /** stream server pool index */
147  u32 app_index;
148 
149  /** Parent listener session if the result of an accept */
150  u32 listener_index;
151 
152  /** Opaque, pad to a 64-octet boundary */
153  u64 opaque[2];
155 
156 /* Forward definition */
157 typedef struct _session_manager_main session_manager_main_t;
158 
159 typedef int
162  session_fifo_event_t * e0, stream_session_t * s0,
163  u32 thread_index, int *n_tx_pkts);
164 
167 
168 struct _session_manager_main
169 {
170  /** Lookup tables for established sessions and listeners */
171  clib_bihash_16_8_t v4_session_hash;
172  clib_bihash_48_8_t v6_session_hash;
173 
174  /** Lookup tables for half-open sessions */
175  clib_bihash_16_8_t v4_half_open_hash;
176  clib_bihash_48_8_t v6_half_open_hash;
177 
178  /** Per worker thread session pools */
179  stream_session_t **sessions;
180 
181  /** Pool of listen sessions. Same type as stream sessions to ease lookups */
182  stream_session_t *listen_sessions[SESSION_N_TYPES];
183 
184  /** Sparse vector to map dst port to stream server */
185  u16 *stream_server_by_dst_port[SESSION_N_TYPES];
186 
187  /** per-worker enqueue epoch counters */
188  u8 *current_enqueue_epoch;
189 
190  /** Per-worker thread vector of sessions to enqueue */
191  u32 **session_indices_to_enqueue_by_thread;
192 
193  /** per-worker tx buffer free lists */
194  u32 **tx_buffers;
195 
196  /** Per worker-thread vector of partially read events */
197  session_fifo_event_t **free_event_vector;
198 
199  /** per-worker active event vectors */
200  session_fifo_event_t **pending_event_vector;
201 
202  /** vpp fifo event queue */
203  unix_shared_memory_queue_t **vpp_event_queues;
204 
205  /** vpp fifo event queue configured length */
206  u32 configured_event_queue_length;
207 
208  /** Unique segment name counter */
209  u32 unique_segment_name_counter;
210 
211  /** Per transport rx function that can either dequeue or peek */
212  session_fifo_rx_fn *session_tx_fns[SESSION_N_TYPES];
213 
214  u8 is_enabled;
215 
216  /* Convenience */
219 
220 #if SESSION_DBG
221  /**
222  * last event poll time by thread
223  * Debug only. Will cause false cache-line sharing as-is
224  */
225  f64 *last_event_poll_by_thread;
226 #endif
227 
228 };
229 
232 
233 /*
234  * Session manager function
235  */
238 {
239  return &session_manager_main;
240 }
241 
242 /*
243  * Stream session functions
244  */
245 
247  u16 lcl_port, u8 proto);
249  ip4_address_t * rmt, u16 lcl_port,
250  u16 rmt_port, u8 proto,
251  u32 thread_index);
253  u16 lcl_port, u8 proto);
255  ip6_address_t * rmt, u16 lcl_port,
256  u16 rmt_port, u8, u32 thread_index);
259  ip4_address_t * rmt, u16 lcl_port,
260  u16 rmt_port, u8 proto,
261  u32 thread_index);
264  ip6_address_t * rmt, u16 lcl_port,
265  u16 rmt_port, u8 proto,
266  u32 thread_index);
267 stream_session_t *stream_session_lookup_listener (ip46_address_t * lcl,
268  u16 lcl_port, u8 proto);
271 
273 stream_session_get_tsi (u64 ti_and_si, u32 thread_index)
274 {
275  ASSERT ((u32) (ti_and_si >> 32) == thread_index);
276  return pool_elt_at_index (session_manager_main.sessions[thread_index],
277  ti_and_si & 0xFFFFFFFFULL);
278 }
279 
281 stream_session_get (u32 si, u32 thread_index)
282 {
283  return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
284 }
285 
288 {
289  if (thread_index >= vec_len (session_manager_main.sessions))
290  return 0;
291 
292  if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
293  return 0;
294 
295  return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
296 }
297 
300 {
301  return ((u64) s->thread_index << 32) | (u64) s->session_index;
302 }
303 
306 {
307  return handle & 0xFFFFFFFF;
308 }
309 
312 {
313  return handle >> 32;
314 }
315 
316 always_inline void
317 stream_session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
318 {
319  *index = stream_session_index_from_handle (handle);
320  *thread_index = stream_session_thread_from_handle (handle);
321 }
322 
325 {
328  (handle)],
330 }
331 
334 {
335  return pool_elt_at_index (session_manager_main.listen_sessions[sst], si);
336 }
337 
340 {
341  if (s->session_state == SESSION_STATE_LISTENING)
342  return s - session_manager_main.listen_sessions[s->session_type];
343 
344  return s - session_manager_main.sessions[s->thread_index];
345 }
346 
349 {
350  stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
351  return svm_fifo_max_enqueue (s->server_rx_fifo);
352 }
353 
356 {
357  stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
358  return s->server_rx_fifo->nitems;
359 }
360 
362 
363 int
365  u32 offset, u8 queue_event, u8 is_in_order);
366 int
368  u32 offset, u32 max_bytes);
370 
372  u8 is_fail);
374  u32 rx_pointer, u32 tx_pointer);
375 
380 int
381 stream_session_accept (transport_connection_t * tc, u32 listener_index,
382  u8 sst, u8 notify);
383 int
384 stream_session_open (u32 app_index, session_type_t st,
385  transport_endpoint_t * tep,
386  transport_connection_t ** tc);
391 void session_send_session_evt_to_thread (u64 session_handle,
392  fifo_event_type_t evt_type,
393  u32 thread_index);
394 u8 *format_stream_session (u8 * s, va_list * args);
395 int
396 send_session_connected_callback (u32 app_index, u32 api_context,
397  stream_session_t * s, u8 is_fail);
398 
399 
400 void session_register_transport (u8 type, const transport_proto_vft_t * vft);
402 
404 
407 {
408  return session_manager_main.vpp_event_queues[thread_index];
409 }
410 
411 int session_manager_flush_enqueue_events (u32 thread_index);
412 
415 {
416  ASSERT (s->session_state == SESSION_STATE_LISTENING);
417  return ((u64) s->session_type << 32) | s->session_index;
418 }
419 
422 {
424  stream_session_t *s;
425  u32 type, index;
426  type = handle >> 32;
427  index = handle & 0xFFFFFFFF;
428 
429  if (pool_is_free_index (smm->listen_sessions[type], index))
430  return 0;
431 
432  s = pool_elt_at_index (smm->listen_sessions[type], index);
433  ASSERT (s->session_state == SESSION_STATE_LISTENING);
434  return s;
435 }
436 
438 listen_session_new (session_type_t type)
439 {
440  stream_session_t *s;
441  pool_get_aligned (session_manager_main.listen_sessions[type], s,
443  memset (s, 0, sizeof (*s));
444 
445  s->session_type = type;
446  s->session_state = SESSION_STATE_LISTENING;
447  s->session_index = s - session_manager_main.listen_sessions[type];
448 
449  return s;
450 }
451 
453 listen_session_get (session_type_t type, u32 index)
454 {
455  return pool_elt_at_index (session_manager_main.listen_sessions[type],
456  index);
457 }
458 
459 always_inline void
461 {
462  pool_put (session_manager_main.listen_sessions[s->session_type], s);
463 }
464 
467 {
468  return session_manager_main.is_enabled == 1;
469 }
470 
471 #endif /* __included_session_h__ */
472 
473 /*
474  * fd.io coding-style-patch-verification: ON
475  *
476  * Local Variables:
477  * eval: (c-set-style "gnu")
478  * End:
479  */
int send_session_connected_callback(u32 app_index, u32 api_context, stream_session_t *s, u8 is_fail)
Definition: session_api.c:155
session_queue_next_t
Definition: session.h:59
static stream_session_t * listen_session_get_from_handle(u64 handle)
Definition: session.h:421
static u32 stream_session_index_from_handle(u64 handle)
Definition: session.h:305
void session_register_transport(u8 type, const transport_proto_vft_t *vft)
Definition: session.c:1041
transport_proto_vft_t * session_get_transport_vft(u8 type)
Definition: session.c:1055
void * arg
Definition: session.h:98
struct _transport_connection transport_connection_t
struct _vlib_node_registration vlib_node_registration_t
static stream_session_t * listen_session_new(session_type_t type)
Definition: session.h:438
static u32 svm_fifo_max_enqueue(svm_fifo_t *f)
Definition: svm_fifo.h:77
void * fp
Definition: session.h:97
#define foreach_session_type
Definition: session.h:69
static u8 session_manager_is_enabled()
Definition: session.h:466
stream_session_t * stream_session_lookup_listener(ip46_address_t *lcl, u16 lcl_port, u8 proto)
Definition: session.c:262
static u32 stream_session_max_rx_enqueue(transport_connection_t *tc)
Definition: session.h:348
vlib_node_registration_t session_queue_node
(constructor) VLIB_REGISTER_NODE (session_queue_node)
Definition: node.c:25
session_fifo_rx_fn session_tx_fifo_peek_and_snd
struct _stream_session_t stream_session_t
struct _svm_fifo svm_fifo_t
fifo_event_type_t
Definition: session.h:29
stream_session_t * stream_session_lookup_listener6(ip6_address_t *lcl, u16 lcl_port, u8 proto)
Definition: session.c:219
#define always_inline
Definition: clib.h:84
int stream_session_connect_notify(transport_connection_t *tc, u8 sst, u8 is_fail)
Definition: session.c:704
unsigned long u64
Definition: types.h:89
void stream_session_accept_notify(transport_connection_t *tc)
Definition: session.c:753
typedef CLIB_PACKED(struct{union{svm_fifo_t *fifo;u64 session_handle;rpc_args_t rpc_args;};u8 event_type;u16 event_id;}) session_fifo_event_t
u32 stream_session_dequeue_drop(transport_connection_t *tc, u32 max_bytes)
Definition: session.c:583
stream_session_t * stream_session_lookup4(ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index)
Looks up a session based on the 5-tuple passed as argument.
Definition: session.c:200
struct _transport_proto_vft transport_proto_vft_t
void stream_session_table_add_for_tc(transport_connection_t *tc, u64 value)
Definition: session.c:40
static void listen_session_del(stream_session_t *s)
Definition: session.h:460
static session_manager_main_t * vnet_get_session_manager_main()
Definition: session.h:237
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:397
session_type_t
Definition: session.h:75
void stream_session_init_fifos_pointers(transport_connection_t *tc, u32 rx_pointer, u32 tx_pointer)
Init fifo tail and head pointers.
Definition: session.c:694
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:241
int stream_session_table_del_for_tc(transport_connection_t *tc)
Definition: session.c:108
vnet_main_t vnet_main
Definition: misc.c:43
struct _session_manager_main session_manager_main_t
Definition: session.h:157
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P (general version).
Definition: pool.h:169
static unix_shared_memory_queue_t * session_manager_get_vpp_event_queue(u32 thread_index)
Definition: session.h:406
session_fifo_rx_fn session_tx_fifo_dequeue_and_snd
static u32 stream_session_get_index(stream_session_t *s)
Definition: session.h:339
u8 * format_stream_session(u8 *s, va_list *args)
Format stream session as per the following format.
Definition: session_cli.c:36
stream_session_t * stream_session_lookup_listener4(ip4_address_t *lcl, u16 lcl_port, u8 proto)
Definition: session.c:173
void stream_session_disconnect(stream_session_t *s)
Disconnect session and propagate to transport.
Definition: session.c:1012
transport_connection_t * stream_session_lookup_transport4(ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index)
Definition: session.c:314
int stream_session_stop_listen(stream_session_t *s)
Ask transport to stop listening on local transport endpoint.
Definition: session.c:950
int stream_session_enqueue_data(transport_connection_t *tc, vlib_buffer_t *b, u32 offset, u8 queue_event, u8 is_in_order)
Definition: session.c:494
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:238
session_manager_main_t session_manager_main
Definition: session.c:33
static stream_session_t * stream_session_get_if_valid(u64 si, u32 thread_index)
Definition: session.h:287
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: session.c:1179
int vlib_main(vlib_main_t *volatile vm, unformat_input_t *input)
Definition: main.c:1692
void stream_session_delete_notify(transport_connection_t *tc)
Notification from transport that connection is being deleted.
Definition: session.c:807
static void stream_session_parse_handle(u64 handle, u32 *index, u32 *thread_index)
Definition: session.h:317
void stream_session_cleanup(stream_session_t *s)
Cleanup transport and session state.
Definition: session.c:1025
static stream_session_t * stream_session_get_tsi(u64 ti_and_si, u32 thread_index)
Definition: session.h:273
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
void stream_session_reset_notify(transport_connection_t *tc)
Notify application that connection has been reset.
Definition: session.c:824
static u32 stream_session_thread_from_handle(u64 handle)
Definition: session.h:311
transport_connection_t * stream_session_lookup_transport6(ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index)
Definition: session.c:348
void session_send_session_evt_to_thread(u64 session_handle, fifo_event_type_t evt_type, u32 thread_index)
Definition: session.c:973
int stream_session_open(u32 app_index, session_type_t st, transport_endpoint_t *tep, transport_connection_t **tc)
Ask transport to open connection to remote transport endpoint.
Definition: session.c:880
static stream_session_t * stream_session_listener_get(u8 sst, u64 si)
Definition: session.h:333
u32 stream_session_tx_fifo_max_dequeue(transport_connection_t *tc)
Definition: session.c:566
int stream_session_listen(stream_session_t *s, transport_endpoint_t *tep)
Ask transport to listen on local transport endpoint.
Definition: session.c:919
stream_session_t * stream_session_lookup6(ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8, u32 thread_index)
Definition: session.c:244
int stream_session_accept(transport_connection_t *tc, u32 listener_index, u8 sst, u8 notify)
Accept a stream session.
Definition: session.c:838
static u64 stream_session_handle(stream_session_t *s)
Definition: session.h:299
unsigned short u16
Definition: types.h:57
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
static stream_session_t * listen_session_get(session_type_t type, u32 index)
Definition: session.h:453
unsigned char u8
Definition: types.h:56
struct _transport_endpoint transport_endpoint_t
session_error_t
Definition: session.h:50
#define foreach_session_input_error
Definition: session.h:39
static u32 stream_session_rx_fifo_size(transport_connection_t *tc)
Definition: session.h:355
int stream_session_peek_bytes(transport_connection_t *tc, u8 *buffer, u32 offset, u32 max_bytes)
Definition: session.c:575
int( session_fifo_rx_fn)(vlib_main_t *vm, vlib_node_runtime_t *node, session_manager_main_t *smm, session_fifo_event_t *e0, stream_session_t *s0, u32 thread_index, int *n_tx_pkts)
Definition: session.h:160
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67
static u64 listen_session_get_handle(stream_session_t *s)
Definition: session.h:414
void stream_session_disconnect_notify(transport_connection_t *tc)
Notification from transport that connection is being closed.
Definition: session.c:771
static stream_session_t * stream_session_get_from_handle(u64 handle)
Definition: session.h:324
int session_manager_flush_enqueue_events(u32 thread_index)
Flushes queue of sessions that are to be notified of new data enqueued events.
Definition: session.c:656
stream_session_state_t
Definition: session.h:86
struct _unix_shared_memory_queue unix_shared_memory_queue_t
static stream_session_t * stream_session_get(u32 si, u32 thread_index)
Definition: session.h:281