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.
16 /** Generate typed init functions for multiple hash table styles... */
17 #include <vppinfra/bihash_16_8.h>
18 #include <vppinfra/bihash_template.h>
20 #include <vppinfra/bihash_template.c>
22 #undef __included_bihash_template_h__
24 #include <vppinfra/bihash_48_8.h>
25 #include <vppinfra/bihash_template.h>
27 #include <vppinfra/bihash_template.c>
28 #include <vnet/session/session_lookup.h>
29 #include <vnet/session/session.h>
30 #include <vnet/session/application.h>
33 * External vector of per transport virtual functions table
35 extern transport_proto_vft_t *tp_vfts;
38 * Network namespace index (i.e., fib index) to session lookup table. We
39 * should have one per network protocol type but for now we only support IP4/6
41 static u32 *fib_index_to_table_index[2];
45 typedef CLIB_PACKED (struct {
54 /* align by making this 4 octets even though its a 1-bit field
55 * NOTE: avoid key overlap with other transports that use 5 tuples for
56 * session identification.
62 }) v4_connection_key_t;
64 typedef CLIB_PACKED (struct {
79 }) v6_connection_key_t;
82 typedef clib_bihash_kv_16_8_t session_kv4_t;
83 typedef clib_bihash_kv_48_8_t session_kv6_t;
86 make_v4_ss_kv (session_kv4_t * kv, ip4_address_t * lcl, ip4_address_t * rmt,
87 u16 lcl_port, u16 rmt_port, u8 proto)
89 v4_connection_key_t *key = (v4_connection_key_t *) kv->key;
91 key->src.as_u32 = lcl->as_u32;
92 key->dst.as_u32 = rmt->as_u32;
93 key->src_port = lcl_port;
94 key->dst_port = rmt_port;
101 make_v4_listener_kv (session_kv4_t * kv, ip4_address_t * lcl, u16 lcl_port,
104 v4_connection_key_t *key = (v4_connection_key_t *) kv->key;
106 key->src.as_u32 = lcl->as_u32;
108 key->src_port = lcl_port;
116 make_v4_ss_kv_from_tc (session_kv4_t * kv, transport_connection_t * t)
118 make_v4_ss_kv (kv, &t->lcl_ip.ip4, &t->rmt_ip.ip4, t->lcl_port, t->rmt_port,
119 session_type_from_proto_and_ip (t->proto, 1));
123 make_v6_ss_kv (session_kv6_t * kv, ip6_address_t * lcl, ip6_address_t * rmt,
124 u16 lcl_port, u16 rmt_port, u8 proto)
126 v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
128 key->src.as_u64[0] = lcl->as_u64[0];
129 key->src.as_u64[1] = lcl->as_u64[1];
130 key->dst.as_u64[0] = rmt->as_u64[0];
131 key->dst.as_u64[1] = rmt->as_u64[1];
132 key->src_port = lcl_port;
133 key->dst_port = rmt_port;
141 make_v6_listener_kv (session_kv6_t * kv, ip6_address_t * lcl, u16 lcl_port,
144 v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
146 key->src.as_u64[0] = lcl->as_u64[0];
147 key->src.as_u64[1] = lcl->as_u64[1];
148 key->dst.as_u64[0] = 0;
149 key->dst.as_u64[1] = 0;
150 key->src_port = lcl_port;
159 make_v6_ss_kv_from_tc (session_kv6_t * kv, transport_connection_t * t)
161 make_v6_ss_kv (kv, &t->lcl_ip.ip6, &t->rmt_ip.ip6, t->lcl_port, t->rmt_port,
162 session_type_from_proto_and_ip (t->proto, 0));
165 static session_table_t *
166 session_table_get_or_alloc (u8 fib_proto, u8 fib_index)
170 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
172 st = session_table_alloc ();
173 table_index = session_table_index (st);
174 vec_validate (fib_index_to_table_index[fib_proto], fib_index);
175 fib_index_to_table_index[fib_proto][fib_index] = table_index;
176 st->active_fib_proto = fib_proto;
181 table_index = fib_index_to_table_index[fib_proto][fib_index];
182 return session_table_get (table_index);
186 static session_table_t *
187 session_table_get_or_alloc_for_connection (transport_connection_t * tc)
190 fib_proto = transport_connection_fib_proto (tc);
191 return session_table_get_or_alloc (fib_proto, tc->fib_index);
194 static session_table_t *
195 session_table_get_for_connection (transport_connection_t * tc)
197 u32 fib_proto = transport_connection_fib_proto (tc);
198 if (vec_len (fib_index_to_table_index[fib_proto]) <= tc->fib_index)
201 session_table_get (fib_index_to_table_index[fib_proto][tc->fib_index]);
204 static session_table_t *
205 session_table_get_for_fib_index (u32 fib_proto, u32 fib_index)
207 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
209 return session_table_get (fib_index_to_table_index[fib_proto][fib_index]);
213 session_lookup_get_index_for_fib (u32 fib_proto, u32 fib_index)
215 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
216 return SESSION_TABLE_INVALID_INDEX;
217 return fib_index_to_table_index[fib_proto][fib_index];
221 * Add transport connection to a session table
223 * Session lookup 5-tuple (src-ip, dst-ip, src-port, dst-port, session-type)
224 * is added to requested session table.
226 * @param tc transport connection to be added
227 * @param value value to be stored
229 * @return non-zero if failure
232 session_lookup_add_connection (transport_connection_t * tc, u64 value)
238 st = session_table_get_or_alloc_for_connection (tc);
243 make_v4_ss_kv_from_tc (&kv4, tc);
245 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
250 make_v6_ss_kv_from_tc (&kv6, tc);
252 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
258 session_lookup_add_session_endpoint (u32 table_index,
259 session_endpoint_t * sep, u64 value)
265 st = session_table_get (table_index);
270 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
271 sep->transport_proto);
273 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 1);
277 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
278 sep->transport_proto);
280 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 1);
285 session_lookup_del_session_endpoint (u32 table_index,
286 session_endpoint_t * sep)
292 st = session_table_get (table_index);
297 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
298 sep->transport_proto);
299 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 0);
303 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
304 sep->transport_proto);
305 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 0);
310 * Delete transport connection from session table
312 * @param table_index session table index
313 * @param tc transport connection to be removed
315 * @return non-zero if failure
318 session_lookup_del_connection (transport_connection_t * tc)
324 st = session_table_get_for_connection (tc);
329 make_v4_ss_kv_from_tc (&kv4, tc);
330 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
335 make_v6_ss_kv_from_tc (&kv6, tc);
336 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
342 session_lookup_del_session (stream_session_t * s)
344 transport_connection_t *ts;
345 ts = tp_vfts[s->session_type].get_connection (s->connection_index,
347 return session_lookup_del_connection (ts);
351 session_lookup_action_to_session (u32 action_index)
353 if (action_index != SESSION_RULES_TABLE_ACTION_DROP)
355 return SESSION_INVALID_INDEX;
358 static stream_session_t *
359 session_lookup_app_listen_session (u32 app_index, u8 fib_proto,
363 app = application_get (app_index);
367 return application_first_listener (app, fib_proto, transport_proto);
371 session_lookup_rules_table4 (session_rules_table_t * srt, u8 proto,
372 ip4_address_t * lcl, u16 lcl_port,
373 ip4_address_t * rmt, u16 rmt_port)
375 u32 action_index, session_index;
376 action_index = session_rules_table_lookup4 (srt, proto, lcl, rmt, lcl_port,
378 session_index = session_lookup_action_to_session (action_index);
379 /* Nothing sophisticated for now, action index is app index */
380 return session_lookup_app_listen_session (session_index, FIB_PROTOCOL_IP4,
385 session_lookup_rules_table6 (session_rules_table_t * srt, u8 proto,
386 ip6_address_t * lcl, u16 lcl_port,
387 ip6_address_t * rmt, u16 rmt_port)
389 u32 action_index, session_index;
390 action_index = session_rules_table_lookup6 (srt, proto, lcl, rmt, lcl_port,
392 session_index = session_lookup_action_to_session (action_index);
393 return session_lookup_app_listen_session (session_index, FIB_PROTOCOL_IP6,
398 session_lookup_session_endpoint (u32 table_index, session_endpoint_t * sep)
408 st = session_table_get (table_index);
410 return SESSION_INVALID_HANDLE;
413 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
414 sep->transport_proto);
415 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
419 memset (&lcl4, 0, sizeof (lcl4));
420 ai = session_rules_table_lookup4 (&st->session_rules,
421 sep->transport_proto, &lcl4,
422 &sep->ip.ip4, 0, sep->port);
423 if (ai != SESSION_RULES_TABLE_INVALID_INDEX)
424 return session_lookup_action_to_session (ai);
428 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
429 sep->transport_proto);
430 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
434 memset (&lcl6, 0, sizeof (lcl6));
435 ai = session_rules_table_lookup6 (&st->session_rules,
436 sep->transport_proto, &lcl6,
437 &sep->ip.ip6, 0, sep->port);
438 if (ai != SESSION_RULES_TABLE_INVALID_INDEX)
439 return session_lookup_action_to_session (ai);
441 return SESSION_INVALID_HANDLE;
445 session_lookup_global_session_endpoint (session_endpoint_t * sep)
456 fib_proto = session_endpoint_fib_proto (sep);
457 table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
458 st = session_table_get (table_index);
463 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
464 sep->transport_proto);
465 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
467 return session_get_from_handle (kv4.value);
468 memset (&lcl4, 0, sizeof (lcl4));
469 return session_lookup_rules_table4 (&st->session_rules,
470 sep->transport_proto, &lcl4, 0,
471 &sep->ip.ip4, sep->port);
475 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
476 sep->transport_proto);
477 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
479 return session_get_from_handle (kv6.value);
480 memset (&lcl6, 0, sizeof (lcl6));
481 return session_lookup_rules_table6 (&st->session_rules,
482 sep->transport_proto, &lcl6, 0,
483 &sep->ip.ip6, sep->port);
488 session_lookup_local_session_endpoint (u32 table_index,
489 session_endpoint_t * sep)
499 st = session_table_get (table_index);
501 return SESSION_INVALID_INDEX;
504 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
505 sep->transport_proto);
506 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
508 return (u32) kv4.value;
511 * Zero out the ip. Logic is that connect to local ips, say
512 * 127.0.0.1:port, can match 0.0.0.0:port
515 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
517 return (u32) kv4.value;
519 memset (&lcl4, 0, sizeof (lcl4));
520 ai = session_rules_table_lookup4 (&st->session_rules,
521 sep->transport_proto, &lcl4,
522 &sep->ip.ip4, 0, sep->port);
523 if (ai != SESSION_RULES_TABLE_INVALID_INDEX)
524 return session_lookup_action_to_session (ai);
528 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
529 sep->transport_proto);
530 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
532 return (u32) kv6.value;
535 * Zero out the ip. Same logic as above.
537 kv6.key[0] = kv6.key[1] = 0;
538 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
540 return (u32) kv6.value;
542 memset (&lcl6, 0, sizeof (lcl6));
543 ai = session_rules_table_lookup6 (&st->session_rules,
544 sep->transport_proto, &lcl6,
545 &sep->ip.ip6, 0, sep->port);
546 if (ai != SESSION_RULES_TABLE_INVALID_INDEX)
547 return session_lookup_action_to_session (ai);
549 return SESSION_INVALID_INDEX;
552 static stream_session_t *
553 session_lookup_listener4_i (session_table_t * st, ip4_address_t * lcl,
554 u16 lcl_port, u8 proto)
559 make_v4_listener_kv (&kv4, lcl, lcl_port, proto);
560 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
562 return session_manager_get_listener (proto, (u32) kv4.value);
564 /* Zero out the lcl ip */
566 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
568 return session_manager_get_listener (proto, (u32) kv4.value);
574 session_lookup_listener4 (u32 fib_index, ip4_address_t * lcl, u16 lcl_port,
578 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
581 return session_lookup_listener4_i (st, lcl, lcl_port, proto);
584 static stream_session_t *
585 session_lookup_listener6_i (session_table_t * st, ip6_address_t * lcl,
586 u16 lcl_port, u8 proto)
591 make_v6_listener_kv (&kv6, lcl, lcl_port, proto);
592 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
594 return session_manager_get_listener (proto, (u32) kv6.value);
596 /* Zero out the lcl ip */
597 kv6.key[0] = kv6.key[1] = 0;
598 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
600 return session_manager_get_listener (proto, (u32) kv6.value);
606 session_lookup_listener6 (u32 fib_index, ip6_address_t * lcl, u16 lcl_port,
610 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
613 return session_lookup_listener6_i (st, lcl, lcl_port, proto);
617 session_lookup_listener (u32 table_index, session_endpoint_t * sep)
620 st = session_table_get (table_index);
624 return session_lookup_listener4_i (st, &sep->ip.ip4, sep->port,
625 sep->transport_proto);
627 return session_lookup_listener6_i (st, &sep->ip.ip6, sep->port,
628 sep->transport_proto);
633 session_lookup_add_half_open (transport_connection_t * tc, u64 value)
639 st = session_table_get_or_alloc_for_connection (tc);
644 make_v4_ss_kv_from_tc (&kv4, tc);
646 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
651 make_v6_ss_kv_from_tc (&kv6, tc);
653 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
659 session_lookup_del_half_open (transport_connection_t * tc)
665 st = session_table_get_for_connection (tc);
670 make_v4_ss_kv_from_tc (&kv4, tc);
671 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
676 make_v6_ss_kv_from_tc (&kv6, tc);
677 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
683 session_lookup_half_open_handle (transport_connection_t * tc)
690 st = session_table_get_for_fib_index (transport_connection_fib_proto (tc),
693 return HALF_OPEN_LOOKUP_INVALID_VALUE;
696 make_v4_ss_kv (&kv4, &tc->lcl_ip.ip4, &tc->rmt_ip.ip4, tc->lcl_port,
697 tc->rmt_port, tc->proto);
698 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
704 make_v6_ss_kv (&kv6, &tc->lcl_ip.ip6, &tc->rmt_ip.ip6, tc->lcl_port,
705 tc->rmt_port, tc->proto);
706 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
710 return HALF_OPEN_LOOKUP_INVALID_VALUE;
713 transport_connection_t *
714 session_lookup_half_open_connection (u64 handle, u8 proto, u8 is_ip4)
718 if (handle != HALF_OPEN_LOOKUP_INVALID_VALUE)
720 sst = session_type_from_proto_and_ip (proto, is_ip4);
721 return tp_vfts[sst].get_half_open (handle & 0xFFFFFFFF);
726 transport_connection_t *
727 session_lookup_rules_table_connection4 (session_rules_table_t * srt, u8 proto,
728 ip4_address_t * lcl, u16 lcl_port,
729 ip4_address_t * rmt, u16 rmt_port)
732 s = session_lookup_rules_table4 (srt, proto, lcl, lcl_port, rmt, rmt_port);
734 return tp_vfts[s->session_type].get_listener (s->connection_index);
738 transport_connection_t *
739 session_lookup_rules_table_connection6 (session_rules_table_t * srt, u8 proto,
740 ip6_address_t * lcl, u16 lcl_port,
741 ip6_address_t * rmt, u16 rmt_port)
744 s = session_lookup_rules_table6 (srt, proto, lcl, lcl_port, rmt, rmt_port);
746 return tp_vfts[s->session_type].get_listener (s->connection_index);
751 * Lookup connection with ip4 and transport layer information
753 * This is used on the fast path so it needs to be fast. Thereby,
754 * duplication of code and 'hacks' allowed.
756 * The lookup is incremental and returns whenever something is matched. The
758 * - Try to find an established session
759 * - Try to find a fully-formed or local source wildcarded (listener bound to
760 * all interfaces) listener session
761 * - Try to find a half-open connection
762 * - Try session rules table
765 * @param fib_index index of fib wherein the connection was received
766 * @param lcl local ip4 address
767 * @param rmt remote ip4 address
768 * @param lcl_port local port
769 * @param rmt_port remote port
770 * @param proto transport protocol (e.g., tcp, udp)
771 * @param thread_index thread index for request
773 * @return pointer to transport connection, if one is found, 0 otherwise
775 transport_connection_t *
776 session_lookup_connection_wt4 (u32 fib_index, ip4_address_t * lcl,
777 ip4_address_t * rmt, u16 lcl_port,
778 u16 rmt_port, u8 proto, u32 thread_index)
785 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
786 if (PREDICT_FALSE (!st))
789 /* Lookup session amongst established ones */
790 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
791 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
794 ASSERT ((u32) (kv4.value >> 32) == thread_index);
795 s = session_get (kv4.value & 0xFFFFFFFFULL, thread_index);
796 return tp_vfts[s->session_type].get_connection (s->connection_index,
800 /* If nothing is found, check if any listener is available */
801 s = session_lookup_listener4_i (st, lcl, lcl_port, proto);
803 return tp_vfts[s->session_type].get_listener (s->connection_index);
805 /* Try half-open connections */
806 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
809 u32 sst = session_type_from_proto_and_ip (proto, 1);
810 return tp_vfts[sst].get_half_open (kv4.value & 0xFFFFFFFF);
813 /* Check the session rules table */
814 return session_lookup_rules_table_connection4 (&st->session_rules, proto,
820 * Lookup connection with ip4 and transport layer information
822 * Not optimized. This is used on the fast path so it needs to be fast.
823 * Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical
824 * to that of @ref session_lookup_connection_wt4
826 * @param fib_index index of the fib wherein the connection was received
827 * @param lcl local ip4 address
828 * @param rmt remote ip4 address
829 * @param lcl_port local port
830 * @param rmt_port remote port
831 * @param proto transport protocol (e.g., tcp, udp)
833 * @return pointer to transport connection, if one is found, 0 otherwise
835 transport_connection_t *
836 session_lookup_connection4 (u32 fib_index, ip4_address_t * lcl,
837 ip4_address_t * rmt, u16 lcl_port, u16 rmt_port,
845 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
846 if (PREDICT_FALSE (!st))
849 /* Lookup session amongst established ones */
850 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
851 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
854 s = session_get_from_handle (kv4.value);
855 return tp_vfts[s->session_type].get_connection (s->connection_index,
859 /* If nothing is found, check if any listener is available */
860 s = session_lookup_listener4_i (st, lcl, lcl_port, proto);
862 return tp_vfts[s->session_type].get_listener (s->connection_index);
864 /* Finally, try half-open connections */
865 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
868 u32 sst = session_type_from_proto_and_ip (proto, 1);
869 return tp_vfts[sst].get_half_open (kv4.value & 0xFFFFFFFF);
871 /* Check the session rules table */
872 return session_lookup_rules_table_connection4 (&st->session_rules, proto,
878 * Lookup session with ip4 and transport layer information
880 * Important note: this may look into another thread's pool table and
881 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
882 * if needed as soon as possible.
884 * Lookup logic is similar to that of @ref session_lookup_connection_wt4 but
885 * this returns a session as opposed to a transport connection and it does not
886 * try to lookup half-open sessions.
888 * Typically used by dgram connections
891 session_lookup_safe4 (u32 fib_index, ip4_address_t * lcl, ip4_address_t * rmt,
892 u16 lcl_port, u16 rmt_port, u8 proto)
899 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
900 if (PREDICT_FALSE (!st))
903 /* Lookup session amongst established ones */
904 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
905 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
907 return session_get_from_handle_safe (kv4.value);
909 /* If nothing is found, check if any listener is available */
910 if ((s = session_lookup_listener4_i (st, lcl, lcl_port, proto)))
912 return session_lookup_rules_table4 (&st->session_rules, proto, lcl,
913 lcl_port, rmt, rmt_port);
917 * Lookup connection with ip6 and transport layer information
919 * This is used on the fast path so it needs to be fast. Thereby,
920 * duplication of code and 'hacks' allowed.
922 * The lookup is incremental and returns whenever something is matched. The
924 * - Try to find an established session
925 * - Try to find a fully-formed or local source wildcarded (listener bound to
926 * all interfaces) listener session
927 * - Try to find a half-open connection
928 * - Try session rules table
931 * @param fib_index index of the fib wherein the connection was received
932 * @param lcl local ip6 address
933 * @param rmt remote ip6 address
934 * @param lcl_port local port
935 * @param rmt_port remote port
936 * @param proto transport protocol (e.g., tcp, udp)
937 * @param thread_index thread index for request
939 * @return pointer to transport connection, if one is found, 0 otherwise
941 transport_connection_t *
942 session_lookup_connection_wt6 (u32 fib_index, ip6_address_t * lcl,
943 ip6_address_t * rmt, u16 lcl_port,
944 u16 rmt_port, u8 proto, u32 thread_index)
951 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
952 if (PREDICT_FALSE (!st))
955 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
956 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
959 ASSERT ((u32) (kv6.value >> 32) == thread_index);
960 s = session_get (kv6.value & 0xFFFFFFFFULL, thread_index);
961 return tp_vfts[s->session_type].get_connection (s->connection_index,
965 /* If nothing is found, check if any listener is available */
966 s = session_lookup_listener6_i (st, lcl, lcl_port, proto);
968 return tp_vfts[s->session_type].get_listener (s->connection_index);
970 /* Finally, try half-open connections */
971 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
974 u32 sst = session_type_from_proto_and_ip (proto, 1);
975 return tp_vfts[sst].get_half_open (kv6.value & 0xFFFFFFFF);
978 return session_lookup_rules_table_connection6 (&st->session_rules, proto,
984 * Lookup connection with ip6 and transport layer information
986 * Not optimized. This is used on the fast path so it needs to be fast.
987 * Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical
988 * to that of @ref session_lookup_connection_wt4
990 * @param fib_index index of the fib wherein the connection was received
991 * @param lcl local ip6 address
992 * @param rmt remote ip6 address
993 * @param lcl_port local port
994 * @param rmt_port remote port
995 * @param proto transport protocol (e.g., tcp, udp)
997 * @return pointer to transport connection, if one is found, 0 otherwise
999 transport_connection_t *
1000 session_lookup_connection6 (u32 fib_index, ip6_address_t * lcl,
1001 ip6_address_t * rmt, u16 lcl_port, u16 rmt_port,
1004 session_table_t *st;
1005 stream_session_t *s;
1009 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1010 if (PREDICT_FALSE (!st))
1013 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1014 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1017 s = session_get_from_handle (kv6.value);
1018 return tp_vfts[s->session_type].get_connection (s->connection_index,
1022 /* If nothing is found, check if any listener is available */
1023 s = session_lookup_listener6 (fib_index, lcl, lcl_port, proto);
1025 return tp_vfts[s->session_type].get_listener (s->connection_index);
1027 /* Finally, try half-open connections */
1028 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
1031 u32 sst = session_type_from_proto_and_ip (proto, 1);
1032 return tp_vfts[sst].get_half_open (kv6.value & 0xFFFFFFFF);
1035 return session_lookup_rules_table_connection6 (&st->session_rules, proto,
1041 * Lookup session with ip6 and transport layer information
1043 * Important note: this may look into another thread's pool table and
1044 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
1045 * if needed as soon as possible.
1047 * Lookup logic is similar to that of @ref session_lookup_connection_wt6 but
1048 * this returns a session as opposed to a transport connection and it does not
1049 * try to lookup half-open sessions.
1051 * Typically used by dgram connections
1054 session_lookup_safe6 (u32 fib_index, ip6_address_t * lcl, ip6_address_t * rmt,
1055 u16 lcl_port, u16 rmt_port, u8 proto)
1057 session_table_t *st;
1059 stream_session_t *s;
1062 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1063 if (PREDICT_FALSE (!st))
1066 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1067 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1069 return session_get_from_handle_safe (kv6.value);
1071 /* If nothing is found, check if any listener is available */
1072 if ((s = session_lookup_listener6_i (st, lcl, lcl_port, proto)))
1074 return session_lookup_rules_table6 (&st->session_rules, proto, lcl,
1075 lcl_port, rmt, rmt_port);
1079 session_lookup_local_listener_make_handle (session_endpoint_t * sep)
1081 return ((u64) SESSION_LOCAL_TABLE_PREFIX << 32
1082 | (u32) sep->port << 16 | (u32) sep->transport_proto << 8
1083 | (u32) sep->is_ip4);
1087 session_lookup_local_is_handle (u64 handle)
1089 if (handle >> 32 == SESSION_LOCAL_TABLE_PREFIX)
1095 session_lookup_local_listener_parse_handle (u64 handle,
1096 session_endpoint_t * sep)
1098 u32 local_table_handle;
1099 if (handle >> 32 != SESSION_LOCAL_TABLE_PREFIX)
1101 local_table_handle = handle & 0xFFFFFFFFULL;
1102 sep->is_ip4 = local_table_handle & 0xff;
1103 local_table_handle >>= 8;
1104 sep->transport_proto = local_table_handle & 0xff;
1105 sep->port = local_table_handle >> 8;
1110 vnet_session_rule_add_del (session_rule_add_del_args_t * args)
1112 app_namespace_t *app_ns = app_namespace_get (args->appns_index);
1113 session_table_t *st;
1116 clib_error_t *error;
1119 return clib_error_return_code (0, VNET_API_ERROR_APP_INVALID_NS, 0,
1121 if (args->scope > 3)
1122 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
1124 if ((args->scope & SESSION_RULE_SCOPE_GLOBAL) || args->scope == 0)
1126 fib_proto = args->table_args.rmt.fp_proto;
1127 fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1128 st = session_table_get_for_fib_index (fib_proto, fib_index);
1129 if ((error = session_rules_table_add_del (&st->session_rules,
1130 &args->table_args)))
1133 if (args->scope & SESSION_RULE_SCOPE_LOCAL)
1135 st = app_namespace_get_local_table (app_ns);
1136 error = session_rules_table_add_del (&st->session_rules,
1143 * Mark (global) tables as pertaining to app ns
1146 session_lookup_set_tables_appns (app_namespace_t * app_ns)
1148 session_table_t *st;
1152 for (fp = 0; fp < ARRAY_LEN (fib_index_to_table_index); fp++)
1154 fib_index = app_namespace_get_fib_index (app_ns, fp);
1155 st = session_table_get_for_fib_index (fp, fib_index);
1157 st->appns_index = app_namespace_index (app_ns);
1162 format_ip4_session_lookup_kvp (u8 * s, va_list * args)
1164 clib_bihash_kv_16_8_t *kvp = va_arg (*args, clib_bihash_kv_16_8_t *);
1165 u32 is_local = va_arg (*args, u32);
1166 u8 *app_name, *str = 0;
1167 stream_session_t *session;
1168 v4_connection_key_t *key = (v4_connection_key_t *) kvp->key;
1170 char *proto = key->proto == TRANSPORT_PROTO_TCP ? "T" : "U";
1173 session = session_get_from_handle (kvp->value);
1174 app_name = application_name_from_index (session->app_index);
1175 str = format (0, "[%s] %U:%d->%U:%d", proto, format_ip4_address,
1176 &key->src, clib_net_to_host_u16 (key->src_port),
1177 format_ip4_address, &key->dst,
1178 clib_net_to_host_u16 (key->dst_port));
1179 s = format (s, "%-40v%-30v", str, app_name);
1183 app_name = application_name_from_index (kvp->value);
1184 str = format (0, "[%s] %U:%d", proto, format_ip4_address,
1185 &key->src, clib_net_to_host_u16 (key->src_port));
1186 s = format (s, "%-30v%-30v", str, app_name);
1188 vec_free (app_name);
1192 typedef struct _ip4_session_table_show_ctx_t
1196 } ip4_session_table_show_ctx_t;
1199 ip4_session_table_show (clib_bihash_kv_16_8_t * kvp, void *arg)
1201 ip4_session_table_show_ctx_t *ctx = arg;
1202 vlib_cli_output (ctx->vm, "%U", format_ip4_session_lookup_kvp, kvp,
1208 session_lookup_show_table_entries (vlib_main_t * vm, session_table_t * table,
1209 u8 type, u8 is_local)
1211 ip4_session_table_show_ctx_t ctx = {
1213 .is_local = is_local,
1216 vlib_cli_output (vm, "%-40s%-30s", "Session", "Application");
1218 vlib_cli_output (vm, "%-30s%-30s", "Listener", "Application");
1223 ip4_session_table_walk (&table->v4_session_hash, ip4_session_table_show,
1227 clib_warning ("not supported");
1231 static clib_error_t *
1232 session_rule_command_fn (vlib_main_t * vm, unformat_input_t * input,
1233 vlib_cli_command_t * cmd)
1235 u32 proto = ~0, lcl_port, rmt_port, action = 0, lcl_plen, rmt_plen;
1236 u32 appns_index, scope = 0;
1237 ip46_address_t lcl_ip, rmt_ip;
1238 u8 is_ip4 = 1, conn_set = 0;
1239 u8 fib_proto, is_add = 1, *ns_id = 0;
1240 app_namespace_t *app_ns;
1242 memset (&lcl_ip, 0, sizeof (lcl_ip));
1243 memset (&rmt_ip, 0, sizeof (rmt_ip));
1244 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1246 if (unformat (input, "del"))
1248 else if (unformat (input, "add"))
1250 else if (unformat (input, "appns %_%v%_", &ns_id))
1252 else if (unformat (input, "scope global"))
1253 scope = SESSION_RULE_SCOPE_GLOBAL;
1254 else if (unformat (input, "scope local"))
1255 scope = SESSION_RULE_SCOPE_LOCAL;
1256 else if (unformat (input, "scope all"))
1257 scope = SESSION_RULE_SCOPE_LOCAL | SESSION_RULE_SCOPE_GLOBAL;
1258 else if (unformat (input, "proto %U", unformat_transport_proto, &proto))
1260 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1261 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1262 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1268 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1269 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1270 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1276 else if (unformat (input, "action %d", &action))
1279 return clib_error_return (0, "unknown input `%U'",
1280 format_unformat_error, input);
1283 if (proto == ~0 || !conn_set || action == ~0)
1284 return clib_error_return (0, "proto, connection and action must be set");
1288 app_ns = app_namespace_get_from_id (ns_id);
1290 return clib_error_return (0, "namespace %v does not exist", ns_id);
1294 app_ns = app_namespace_get_default ();
1296 appns_index = app_namespace_index (app_ns);
1298 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1299 session_rule_add_del_args_t args = {
1300 .table_args.lcl.fp_addr = lcl_ip,
1301 .table_args.lcl.fp_len = lcl_plen,
1302 .table_args.lcl.fp_proto = fib_proto,
1303 .table_args.rmt.fp_addr = rmt_ip,
1304 .table_args.rmt.fp_len = rmt_plen,
1305 .table_args.rmt.fp_proto = fib_proto,
1306 .table_args.lcl_port = lcl_port,
1307 .table_args.rmt_port = rmt_port,
1308 .table_args.action_index = action,
1309 .table_args.is_add = is_add,
1310 .appns_index = appns_index,
1313 return vnet_session_rule_add_del (&args);
1317 VLIB_CLI_COMMAND (session_rule_command, static) =
1319 .path = "session rule",
1320 .short_help = "session rule [add|del] appns <ns_id> proto <proto> "
1321 "<lcl-ip/plen> <lcl-port> <rmt-ip/plen> <rmt-port> action <action>",
1322 .function = session_rule_command_fn,
1327 session_lookup_dump_rules_table (u32 fib_index, u8 fib_proto,
1330 vlib_main_t *vm = vlib_get_main ();
1331 session_table_t *st;
1332 st = session_table_get_for_fib_index (fib_index, fib_proto);
1333 session_rules_table_cli_dump (vm, &st->session_rules, fib_proto,
1338 session_lookup_dump_local_rules_table (u32 table_index, u8 fib_proto,
1341 vlib_main_t *vm = vlib_get_main ();
1342 session_table_t *st;
1343 st = session_table_get (table_index);
1344 session_rules_table_cli_dump (vm, &st->session_rules, fib_proto,
1348 static clib_error_t *
1349 show_session_rules_command_fn (vlib_main_t * vm, unformat_input_t * input,
1350 vlib_cli_command_t * cmd)
1352 u32 transport_proto = ~0, lcl_port, rmt_port, lcl_plen, rmt_plen;
1353 u32 fib_index, scope = 0;
1354 ip46_address_t lcl_ip, rmt_ip;
1355 u8 is_ip4 = 1, show_one = 0;
1356 app_namespace_t *app_ns;
1357 session_table_t *st;
1358 u8 *ns_id = 0, fib_proto;
1360 memset (&lcl_ip, 0, sizeof (lcl_ip));
1361 memset (&rmt_ip, 0, sizeof (rmt_ip));
1362 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1364 if (unformat (input, "%U", unformat_transport_proto, &transport_proto))
1366 else if (unformat (input, "appns %_%v%_", &ns_id))
1368 else if (unformat (input, "scope global"))
1370 else if (unformat (input, "scope local"))
1372 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1373 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1374 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1380 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1381 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1382 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1389 return clib_error_return (0, "unknown input `%U'",
1390 format_unformat_error, input);
1393 if (transport_proto == ~0)
1395 vlib_cli_output (vm, "transport proto must be set");
1401 app_ns = app_namespace_get_from_id (ns_id);
1404 vlib_cli_output (vm, "appns %v doesn't exist", ns_id);
1410 app_ns = app_namespace_get_default ();
1413 if (scope == 1 || scope == 0)
1415 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1416 fib_index = is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1417 st = session_table_get_for_fib_index (fib_proto, fib_index);
1421 st = app_namespace_get_local_table (app_ns);
1426 session_rules_table_show_rule (vm, &st->session_rules, transport_proto,
1427 &lcl_ip, lcl_port, &rmt_ip, rmt_port,
1432 session_rules_table_cli_dump (vm, &st->session_rules, FIB_PROTOCOL_IP4,
1434 session_rules_table_cli_dump (vm, &st->session_rules, FIB_PROTOCOL_IP6,
1442 VLIB_CLI_COMMAND (show_session_rules_command, static) =
1444 .path = "show session rules",
1445 .short_help = "show session rules [appns <id> proto <proto> <lcl-ip/plen>"
1446 " <lcl-port> <rmt-ip/plen> <rmt-port>]",
1447 .function = show_session_rules_command_fn,
1452 session_lookup_init (void)
1455 * Allocate default table and map it to fib_index 0
1457 session_table_t *st = session_table_alloc ();
1458 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP4], 0);
1459 fib_index_to_table_index[FIB_PROTOCOL_IP4][0] = session_table_index (st);
1460 st->active_fib_proto = FIB_PROTOCOL_IP4;
1461 session_table_init (st, FIB_PROTOCOL_IP4);
1462 st = session_table_alloc ();
1463 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP6], 0);
1464 fib_index_to_table_index[FIB_PROTOCOL_IP6][0] = session_table_index (st);
1465 st->active_fib_proto = FIB_PROTOCOL_IP6;
1466 session_table_init (st, FIB_PROTOCOL_IP6);
1470 * fd.io coding-style-patch-verification: ON
1473 * eval: (c-set-style "gnu")