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));
166 static session_table_t *
167 session_table_get_or_alloc_for_connection (transport_connection_t * tc)
170 u32 table_index, fib_proto = transport_connection_fib_proto (tc);
171 if (vec_len (fib_index_to_table_index[fib_proto]) <= tc->fib_index)
173 st = session_table_alloc ();
174 table_index = session_table_index (st);
175 vec_validate (fib_index_to_table_index[fib_proto], tc->fib_index);
176 fib_index_to_table_index[fib_proto][tc->fib_index] = table_index;
181 table_index = fib_index_to_table_index[fib_proto][tc->fib_index];
182 return session_table_get (table_index);
186 static session_table_t *
187 session_table_get_for_connection (transport_connection_t * tc)
189 u32 fib_proto = transport_connection_fib_proto (tc);
190 if (vec_len (fib_index_to_table_index[fib_proto]) <= tc->fib_index)
193 session_table_get (fib_index_to_table_index[fib_proto][tc->fib_index]);
196 static session_table_t *
197 session_table_get_for_fib_index (u32 fib_proto, u32 fib_index)
199 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
201 return session_table_get (fib_index_to_table_index[fib_proto][fib_index]);
205 session_lookup_get_index_for_fib (u32 fib_proto, u32 fib_index)
207 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
208 return SESSION_TABLE_INVALID_INDEX;
209 return fib_index_to_table_index[fib_proto][fib_index];
213 * Add transport connection to a session table
215 * Session lookup 5-tuple (src-ip, dst-ip, src-port, dst-port, session-type)
216 * is added to requested session table.
218 * @param tc transport connection to be added
219 * @param value value to be stored
221 * @return non-zero if failure
224 session_lookup_add_connection (transport_connection_t * tc, u64 value)
230 st = session_table_get_or_alloc_for_connection (tc);
235 make_v4_ss_kv_from_tc (&kv4, tc);
237 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
242 make_v6_ss_kv_from_tc (&kv6, tc);
244 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
250 session_lookup_add_session_endpoint (u32 table_index,
251 session_endpoint_t * sep, u64 value)
257 st = session_table_get (table_index);
262 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
263 sep->transport_proto);
265 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 1);
269 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
270 sep->transport_proto);
272 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 1);
277 session_lookup_del_session_endpoint (u32 table_index,
278 session_endpoint_t * sep)
284 st = session_table_get (table_index);
289 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
290 sep->transport_proto);
291 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 0);
295 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
296 sep->transport_proto);
297 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 0);
302 * Delete transport connection from session table
304 * @param table_index session table index
305 * @param tc transport connection to be removed
307 * @return non-zero if failure
310 session_lookup_del_connection (transport_connection_t * tc)
316 st = session_table_get_for_connection (tc);
321 make_v4_ss_kv_from_tc (&kv4, tc);
322 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
327 make_v6_ss_kv_from_tc (&kv6, tc);
328 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
334 session_lookup_del_session (stream_session_t * s)
336 transport_connection_t *ts;
337 ts = tp_vfts[s->session_type].get_connection (s->connection_index,
339 return session_lookup_del_connection (ts);
342 static stream_session_t *
343 session_lookup_app_listen_session (u32 app_index, u8 fib_proto,
347 app = application_get (app_index);
351 return application_first_listener (app, fib_proto, transport_proto);
355 session_lookup_rules_table4 (session_rules_table_t * srt, u8 proto,
356 ip4_address_t * lcl, u16 lcl_port,
357 ip4_address_t * rmt, u16 rmt_port)
360 action_index = session_rules_table_lookup4 (srt, proto, lcl, rmt, lcl_port,
362 /* Nothing sophisticated for now, action index is app index */
363 return session_lookup_app_listen_session (action_index, FIB_PROTOCOL_IP4,
368 session_lookup_rules_table6 (session_rules_table_t * srt, u8 proto,
369 ip6_address_t * lcl, u16 lcl_port,
370 ip6_address_t * rmt, u16 rmt_port)
373 action_index = session_rules_table_lookup6 (srt, proto, lcl, rmt, lcl_port,
375 return session_lookup_app_listen_session (action_index, FIB_PROTOCOL_IP6,
380 session_lookup_session_endpoint (u32 table_index, session_endpoint_t * sep)
390 st = session_table_get (table_index);
392 return SESSION_INVALID_HANDLE;
395 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
396 sep->transport_proto);
397 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
401 memset (&lcl4, 0, sizeof (lcl4));
403 session_rules_table_lookup4 (&st->session_rules, sep->transport_proto,
404 &lcl4, &sep->ip.ip4, 0, sep->port);
405 if (si != SESSION_RULES_TABLE_INVALID_INDEX)
410 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
411 sep->transport_proto);
412 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
416 memset (&lcl6, 0, sizeof (lcl6));
418 session_rules_table_lookup6 (&st->session_rules, sep->transport_proto,
419 &lcl6, &sep->ip.ip6, 0, sep->port);
420 if (si != SESSION_RULES_TABLE_INVALID_INDEX)
423 return SESSION_INVALID_HANDLE;
427 session_lookup_global_session_endpoint (session_endpoint_t * sep)
438 fib_proto = session_endpoint_fib_proto (sep);
439 table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
440 st = session_table_get (table_index);
445 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
446 sep->transport_proto);
447 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
449 return session_get_from_handle (kv4.value);
450 memset (&lcl4, 0, sizeof (lcl4));
451 return session_lookup_rules_table4 (&st->session_rules,
452 sep->transport_proto, &lcl4, 0,
453 &sep->ip.ip4, sep->port);
457 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
458 sep->transport_proto);
459 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
461 return session_get_from_handle (kv6.value);
462 memset (&lcl6, 0, sizeof (lcl6));
463 return session_lookup_rules_table6 (&st->session_rules,
464 sep->transport_proto, &lcl6, 0,
465 &sep->ip.ip6, sep->port);
470 session_lookup_local_session_endpoint (u32 table_index,
471 session_endpoint_t * sep)
481 st = session_table_get (table_index);
483 return SESSION_INVALID_INDEX;
486 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
487 sep->transport_proto);
488 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
490 return (u32) kv4.value;
493 * Zero out the ip. Logic is that connect to local ips, say
494 * 127.0.0.1:port, can match 0.0.0.0:port
497 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
499 return (u32) kv4.value;
501 memset (&lcl4, 0, sizeof (lcl4));
503 session_rules_table_lookup4 (&st->session_rules, sep->transport_proto,
504 &lcl4, &sep->ip.ip4, 0, sep->port);
505 if (si != SESSION_RULES_TABLE_INVALID_INDEX)
510 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
511 sep->transport_proto);
512 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
514 return (u32) kv6.value;
517 * Zero out the ip. Same logic as above.
519 kv6.key[0] = kv6.key[1] = 0;
520 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
522 return (u32) kv6.value;
524 memset (&lcl6, 0, sizeof (lcl6));
526 session_rules_table_lookup6 (&st->session_rules, sep->transport_proto,
527 &lcl6, &sep->ip.ip6, 0, sep->port);
528 if (si != SESSION_RULES_TABLE_INVALID_INDEX)
531 return SESSION_INVALID_INDEX;
534 static stream_session_t *
535 session_lookup_listener4_i (session_table_t * st, ip4_address_t * lcl,
536 u16 lcl_port, u8 proto)
541 make_v4_listener_kv (&kv4, lcl, lcl_port, proto);
542 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
544 return session_manager_get_listener (proto, (u32) kv4.value);
546 /* Zero out the lcl ip */
548 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
550 return session_manager_get_listener (proto, (u32) kv4.value);
556 session_lookup_listener4 (u32 fib_index, ip4_address_t * lcl, u16 lcl_port,
560 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
563 return session_lookup_listener4_i (st, lcl, lcl_port, proto);
566 static stream_session_t *
567 session_lookup_listener6_i (session_table_t * st, ip6_address_t * lcl,
568 u16 lcl_port, u8 proto)
573 make_v6_listener_kv (&kv6, lcl, lcl_port, proto);
574 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
576 return session_manager_get_listener (proto, (u32) kv6.value);
578 /* Zero out the lcl ip */
579 kv6.key[0] = kv6.key[1] = 0;
580 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
582 return session_manager_get_listener (proto, (u32) kv6.value);
588 session_lookup_listener6 (u32 fib_index, ip6_address_t * lcl, u16 lcl_port,
592 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
595 return session_lookup_listener6_i (st, lcl, lcl_port, proto);
599 session_lookup_listener (u32 table_index, session_endpoint_t * sep)
602 st = session_table_get (table_index);
606 return session_lookup_listener4_i (st, &sep->ip.ip4, sep->port,
607 sep->transport_proto);
609 return session_lookup_listener6_i (st, &sep->ip.ip6, sep->port,
610 sep->transport_proto);
615 session_lookup_add_half_open (transport_connection_t * tc, u64 value)
621 st = session_table_get_or_alloc_for_connection (tc);
626 make_v4_ss_kv_from_tc (&kv4, tc);
628 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
633 make_v6_ss_kv_from_tc (&kv6, tc);
635 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
641 session_lookup_del_half_open (transport_connection_t * tc)
647 st = session_table_get_for_connection (tc);
652 make_v4_ss_kv_from_tc (&kv4, tc);
653 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
658 make_v6_ss_kv_from_tc (&kv6, tc);
659 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
665 session_lookup_half_open_handle (transport_connection_t * tc)
672 st = session_table_get_for_fib_index (transport_connection_fib_proto (tc),
675 return HALF_OPEN_LOOKUP_INVALID_VALUE;
678 make_v4_ss_kv (&kv4, &tc->lcl_ip.ip4, &tc->rmt_ip.ip4, tc->lcl_port,
679 tc->rmt_port, tc->proto);
680 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
686 make_v6_ss_kv (&kv6, &tc->lcl_ip.ip6, &tc->rmt_ip.ip6, tc->lcl_port,
687 tc->rmt_port, tc->proto);
688 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
692 return HALF_OPEN_LOOKUP_INVALID_VALUE;
695 transport_connection_t *
696 session_lookup_half_open_connection (u64 handle, u8 proto, u8 is_ip4)
700 if (handle != HALF_OPEN_LOOKUP_INVALID_VALUE)
702 sst = session_type_from_proto_and_ip (proto, is_ip4);
703 return tp_vfts[sst].get_half_open (handle & 0xFFFFFFFF);
708 transport_connection_t *
709 session_lookup_rules_table_connection4 (session_rules_table_t * srt, u8 proto,
710 ip4_address_t * lcl, u16 lcl_port,
711 ip4_address_t * rmt, u16 rmt_port)
714 s = session_lookup_rules_table4 (srt, proto, lcl, lcl_port, rmt, rmt_port);
716 return tp_vfts[s->session_type].get_listener (s->connection_index);
720 transport_connection_t *
721 session_lookup_rules_table_connection6 (session_rules_table_t * srt, u8 proto,
722 ip6_address_t * lcl, u16 lcl_port,
723 ip6_address_t * rmt, u16 rmt_port)
726 s = session_lookup_rules_table6 (srt, proto, lcl, lcl_port, rmt, rmt_port);
728 return tp_vfts[s->session_type].get_listener (s->connection_index);
733 * Lookup connection with ip4 and transport layer information
735 * This is used on the fast path so it needs to be fast. Thereby,
736 * duplication of code and 'hacks' allowed.
738 * The lookup is incremental and returns whenever something is matched. The
740 * - Try to find an established session
741 * - Try to find a fully-formed or local source wildcarded (listener bound to
742 * all interfaces) listener session
743 * - Try to find a half-open connection
744 * - Try session rules table
747 * @param fib_index index of fib wherein the connection was received
748 * @param lcl local ip4 address
749 * @param rmt remote ip4 address
750 * @param lcl_port local port
751 * @param rmt_port remote port
752 * @param proto transport protocol (e.g., tcp, udp)
753 * @param thread_index thread index for request
755 * @return pointer to transport connection, if one is found, 0 otherwise
757 transport_connection_t *
758 session_lookup_connection_wt4 (u32 fib_index, ip4_address_t * lcl,
759 ip4_address_t * rmt, u16 lcl_port,
760 u16 rmt_port, u8 proto, u32 thread_index)
767 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
768 if (PREDICT_FALSE (!st))
771 /* Lookup session amongst established ones */
772 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
773 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
776 ASSERT ((u32) (kv4.value >> 32) == thread_index);
777 s = session_get (kv4.value & 0xFFFFFFFFULL, thread_index);
778 return tp_vfts[s->session_type].get_connection (s->connection_index,
782 /* If nothing is found, check if any listener is available */
783 s = session_lookup_listener4_i (st, lcl, lcl_port, proto);
785 return tp_vfts[s->session_type].get_listener (s->connection_index);
787 /* Try half-open connections */
788 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
791 u32 sst = session_type_from_proto_and_ip (proto, 1);
792 return tp_vfts[sst].get_half_open (kv4.value & 0xFFFFFFFF);
795 /* Check the session rules table */
796 return session_lookup_rules_table_connection4 (&st->session_rules, proto,
802 * Lookup connection with ip4 and transport layer information
804 * Not optimized. This is used on the fast path so it needs to be fast.
805 * Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical
806 * to that of @ref session_lookup_connection_wt4
808 * @param fib_index index of the fib wherein the connection was received
809 * @param lcl local ip4 address
810 * @param rmt remote ip4 address
811 * @param lcl_port local port
812 * @param rmt_port remote port
813 * @param proto transport protocol (e.g., tcp, udp)
815 * @return pointer to transport connection, if one is found, 0 otherwise
817 transport_connection_t *
818 session_lookup_connection4 (u32 fib_index, ip4_address_t * lcl,
819 ip4_address_t * rmt, u16 lcl_port, u16 rmt_port,
827 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
828 if (PREDICT_FALSE (!st))
831 /* Lookup session amongst established ones */
832 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
833 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
836 s = session_get_from_handle (kv4.value);
837 return tp_vfts[s->session_type].get_connection (s->connection_index,
841 /* If nothing is found, check if any listener is available */
842 s = session_lookup_listener4_i (st, lcl, lcl_port, proto);
844 return tp_vfts[s->session_type].get_listener (s->connection_index);
846 /* Finally, try half-open connections */
847 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
850 u32 sst = session_type_from_proto_and_ip (proto, 1);
851 return tp_vfts[sst].get_half_open (kv4.value & 0xFFFFFFFF);
853 /* Check the session rules table */
854 return session_lookup_rules_table_connection4 (&st->session_rules, proto,
860 * Lookup session with ip4 and transport layer information
862 * Important note: this may look into another thread's pool table and
863 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
864 * if needed as soon as possible.
866 * Lookup logic is similar to that of @ref session_lookup_connection_wt4 but
867 * this returns a session as opposed to a transport connection and it does not
868 * try to lookup half-open sessions.
870 * Typically used by dgram connections
873 session_lookup_safe4 (u32 fib_index, ip4_address_t * lcl, ip4_address_t * rmt,
874 u16 lcl_port, u16 rmt_port, u8 proto)
881 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
882 if (PREDICT_FALSE (!st))
885 /* Lookup session amongst established ones */
886 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
887 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
889 return session_get_from_handle_safe (kv4.value);
891 /* If nothing is found, check if any listener is available */
892 if ((s = session_lookup_listener4_i (st, lcl, lcl_port, proto)))
894 return session_lookup_rules_table4 (&st->session_rules, proto, lcl,
895 lcl_port, rmt, rmt_port);
899 * Lookup connection with ip6 and transport layer information
901 * This is used on the fast path so it needs to be fast. Thereby,
902 * duplication of code and 'hacks' allowed.
904 * The lookup is incremental and returns whenever something is matched. The
906 * - Try to find an established session
907 * - Try to find a fully-formed or local source wildcarded (listener bound to
908 * all interfaces) listener session
909 * - Try to find a half-open connection
910 * - Try session rules table
913 * @param fib_index index of the fib wherein the connection was received
914 * @param lcl local ip6 address
915 * @param rmt remote ip6 address
916 * @param lcl_port local port
917 * @param rmt_port remote port
918 * @param proto transport protocol (e.g., tcp, udp)
919 * @param thread_index thread index for request
921 * @return pointer to transport connection, if one is found, 0 otherwise
923 transport_connection_t *
924 session_lookup_connection_wt6 (u32 fib_index, ip6_address_t * lcl,
925 ip6_address_t * rmt, u16 lcl_port,
926 u16 rmt_port, u8 proto, u32 thread_index)
933 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
934 if (PREDICT_FALSE (!st))
937 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
938 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
941 ASSERT ((u32) (kv6.value >> 32) == thread_index);
942 s = session_get (kv6.value & 0xFFFFFFFFULL, thread_index);
943 return tp_vfts[s->session_type].get_connection (s->connection_index,
947 /* If nothing is found, check if any listener is available */
948 s = session_lookup_listener6_i (st, lcl, lcl_port, proto);
950 return tp_vfts[s->session_type].get_listener (s->connection_index);
952 /* Finally, try half-open connections */
953 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
956 u32 sst = session_type_from_proto_and_ip (proto, 1);
957 return tp_vfts[sst].get_half_open (kv6.value & 0xFFFFFFFF);
960 return session_lookup_rules_table_connection6 (&st->session_rules, proto,
966 * Lookup connection with ip6 and transport layer information
968 * Not optimized. This is used on the fast path so it needs to be fast.
969 * Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical
970 * to that of @ref session_lookup_connection_wt4
972 * @param fib_index index of the fib wherein the connection was received
973 * @param lcl local ip6 address
974 * @param rmt remote ip6 address
975 * @param lcl_port local port
976 * @param rmt_port remote port
977 * @param proto transport protocol (e.g., tcp, udp)
979 * @return pointer to transport connection, if one is found, 0 otherwise
981 transport_connection_t *
982 session_lookup_connection6 (u32 fib_index, ip6_address_t * lcl,
983 ip6_address_t * rmt, u16 lcl_port, u16 rmt_port,
991 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
992 if (PREDICT_FALSE (!st))
995 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
996 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
999 s = session_get_from_handle (kv6.value);
1000 return tp_vfts[s->session_type].get_connection (s->connection_index,
1004 /* If nothing is found, check if any listener is available */
1005 s = session_lookup_listener6 (fib_index, lcl, lcl_port, proto);
1007 return tp_vfts[s->session_type].get_listener (s->connection_index);
1009 /* Finally, try half-open connections */
1010 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
1013 u32 sst = session_type_from_proto_and_ip (proto, 1);
1014 return tp_vfts[sst].get_half_open (kv6.value & 0xFFFFFFFF);
1017 return session_lookup_rules_table_connection6 (&st->session_rules, proto,
1023 * Lookup session with ip6 and transport layer information
1025 * Important note: this may look into another thread's pool table and
1026 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
1027 * if needed as soon as possible.
1029 * Lookup logic is similar to that of @ref session_lookup_connection_wt6 but
1030 * this returns a session as opposed to a transport connection and it does not
1031 * try to lookup half-open sessions.
1033 * Typically used by dgram connections
1036 session_lookup_safe6 (u32 fib_index, ip6_address_t * lcl, ip6_address_t * rmt,
1037 u16 lcl_port, u16 rmt_port, u8 proto)
1039 session_table_t *st;
1041 stream_session_t *s;
1044 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1045 if (PREDICT_FALSE (!st))
1048 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1049 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1051 return session_get_from_handle_safe (kv6.value);
1053 /* If nothing is found, check if any listener is available */
1054 if ((s = session_lookup_listener6_i (st, lcl, lcl_port, proto)))
1056 return session_lookup_rules_table6 (&st->session_rules, proto, lcl,
1057 lcl_port, rmt, rmt_port);
1061 session_lookup_local_listener_make_handle (session_endpoint_t * sep)
1063 return ((u64) SESSION_LOCAL_TABLE_PREFIX << 32
1064 | (u32) sep->port << 16 | (u32) sep->transport_proto << 8
1065 | (u32) sep->is_ip4);
1069 session_lookup_local_is_handle (u64 handle)
1071 if (handle >> 32 == SESSION_LOCAL_TABLE_PREFIX)
1077 session_lookup_local_listener_parse_handle (u64 handle,
1078 session_endpoint_t * sep)
1080 u32 local_table_handle;
1081 if (handle >> 32 != SESSION_LOCAL_TABLE_PREFIX)
1083 local_table_handle = handle & 0xFFFFFFFFULL;
1084 sep->is_ip4 = local_table_handle & 0xff;
1085 local_table_handle >>= 8;
1086 sep->transport_proto = local_table_handle & 0xff;
1087 sep->port = local_table_handle >> 8;
1092 vnet_session_rule_add_del (session_rule_add_del_args_t * args)
1094 app_namespace_t *app_ns = app_namespace_get (args->appns_index);
1095 session_table_t *st;
1098 clib_error_t *error;
1101 return clib_error_return_code (0, VNET_API_ERROR_APP_INVALID_NS, 0,
1103 if (args->scope > 3)
1104 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
1106 if ((args->scope & SESSION_RULE_SCOPE_GLOBAL) || args->scope == 0)
1108 fib_proto = args->table_args.rmt.fp_proto;
1109 fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1110 st = session_table_get_for_fib_index (fib_proto, fib_index);
1111 if ((error = session_rules_table_add_del (&st->session_rules,
1112 &args->table_args)))
1115 if (args->scope & SESSION_RULE_SCOPE_LOCAL)
1117 st = app_namespace_get_local_table (app_ns);
1119 session_rules_table_add_del (&st->session_rules, &args->table_args);
1125 format_ip4_session_lookup_kvp (u8 * s, va_list * args)
1127 clib_bihash_kv_16_8_t *kvp = va_arg (*args, clib_bihash_kv_16_8_t *);
1128 u32 is_local = va_arg (*args, u32);
1129 u8 *app_name, *str = 0;
1130 stream_session_t *session;
1131 v4_connection_key_t *key = (v4_connection_key_t *) kvp->key;
1133 char *proto = key->proto == TRANSPORT_PROTO_TCP ? "T" : "U";
1136 session = session_get_from_handle (kvp->value);
1137 app_name = application_name_from_index (session->app_index);
1138 str = format (0, "[%s] %U:%d->%U:%d", proto, format_ip4_address,
1139 &key->src, clib_net_to_host_u16 (key->src_port),
1140 format_ip4_address, &key->dst,
1141 clib_net_to_host_u16 (key->dst_port));
1142 s = format (s, "%-40v%-30v", str, app_name);
1146 app_name = application_name_from_index (kvp->value);
1147 str = format (0, "[%s] %U:%d", proto, format_ip4_address,
1148 &key->src, clib_net_to_host_u16 (key->src_port));
1149 s = format (s, "%-30v%-30v", str, app_name);
1151 vec_free (app_name);
1155 typedef struct _ip4_session_table_show_ctx_t
1159 } ip4_session_table_show_ctx_t;
1162 ip4_session_table_show (clib_bihash_kv_16_8_t * kvp, void *arg)
1164 ip4_session_table_show_ctx_t *ctx = arg;
1165 vlib_cli_output (ctx->vm, "%U", format_ip4_session_lookup_kvp, kvp,
1171 session_lookup_show_table_entries (vlib_main_t * vm, session_table_t * table,
1172 u8 type, u8 is_local)
1174 ip4_session_table_show_ctx_t ctx = {
1176 .is_local = is_local,
1179 vlib_cli_output (vm, "%-40s%-30s", "Session", "Application");
1181 vlib_cli_output (vm, "%-30s%-30s", "Listener", "Application");
1186 ip4_session_table_walk (&table->v4_session_hash, ip4_session_table_show,
1190 clib_warning ("not supported");
1194 static clib_error_t *
1195 session_rule_command_fn (vlib_main_t * vm, unformat_input_t * input,
1196 vlib_cli_command_t * cmd)
1198 u32 proto = ~0, lcl_port, rmt_port, action = 0, lcl_plen, rmt_plen;
1199 u32 appns_index, scope = 0;
1200 ip46_address_t lcl_ip, rmt_ip;
1201 u8 is_ip4 = 1, conn_set = 0;
1202 u8 fib_proto, is_add = 1, *ns_id = 0;
1203 app_namespace_t *app_ns;
1205 memset (&lcl_ip, 0, sizeof (lcl_ip));
1206 memset (&rmt_ip, 0, sizeof (rmt_ip));
1207 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1209 if (unformat (input, "del"))
1211 else if (unformat (input, "add"))
1213 else if (unformat (input, "appns %_%v%_", &ns_id))
1215 else if (unformat (input, "scope global"))
1216 scope = SESSION_RULE_SCOPE_GLOBAL;
1217 else if (unformat (input, "scope local"))
1218 scope = SESSION_RULE_SCOPE_LOCAL;
1219 else if (unformat (input, "scope all"))
1220 scope = SESSION_RULE_SCOPE_LOCAL | SESSION_RULE_SCOPE_GLOBAL;
1221 else if (unformat (input, "proto %U", unformat_transport_proto, &proto))
1223 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1224 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1225 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1231 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1232 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1233 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1239 else if (unformat (input, "action %d", &action))
1242 return clib_error_return (0, "unknown input `%U'",
1243 format_unformat_error, input);
1246 if (proto == ~0 || !conn_set || action == ~0)
1247 return clib_error_return (0, "proto, connection and action must be set");
1251 app_ns = app_namespace_get_from_id (ns_id);
1253 return clib_error_return (0, "namespace %v does not exist", ns_id);
1257 app_ns = app_namespace_get_default ();
1259 appns_index = app_namespace_index (app_ns);
1261 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1262 session_rule_add_del_args_t args = {
1263 .table_args.lcl.fp_addr = lcl_ip,
1264 .table_args.lcl.fp_len = lcl_plen,
1265 .table_args.lcl.fp_proto = fib_proto,
1266 .table_args.rmt.fp_addr = rmt_ip,
1267 .table_args.rmt.fp_len = rmt_plen,
1268 .table_args.rmt.fp_proto = fib_proto,
1269 .table_args.lcl_port = lcl_port,
1270 .table_args.rmt_port = rmt_port,
1271 .table_args.action_index = action,
1272 .table_args.is_add = is_add,
1273 .appns_index = appns_index,
1276 return vnet_session_rule_add_del (&args);
1280 VLIB_CLI_COMMAND (session_rule_command, static) =
1282 .path = "session rule",
1283 .short_help = "session rule [add|del] appns <ns_id> proto <proto> "
1284 "<lcl-ip/plen> <lcl-port> <rmt-ip/plen> <rmt-port> action <action>",
1285 .function = session_rule_command_fn,
1290 session_lookup_dump_rules_table (u32 fib_index, u8 fib_proto,
1293 vlib_main_t *vm = vlib_get_main ();
1294 session_table_t *st;
1295 st = session_table_get_for_fib_index (fib_index, fib_proto);
1296 session_rules_table_cli_dump (vm, &st->session_rules, fib_proto,
1301 session_lookup_dump_local_rules_table (u32 table_index, u8 fib_proto,
1304 vlib_main_t *vm = vlib_get_main ();
1305 session_table_t *st;
1306 st = session_table_get (table_index);
1307 session_rules_table_cli_dump (vm, &st->session_rules, fib_proto,
1311 static clib_error_t *
1312 show_session_rules_command_fn (vlib_main_t * vm, unformat_input_t * input,
1313 vlib_cli_command_t * cmd)
1315 u32 transport_proto = ~0, lcl_port, rmt_port, lcl_plen, rmt_plen;
1316 u32 fib_index, scope = 0;
1317 ip46_address_t lcl_ip, rmt_ip;
1318 u8 is_ip4 = 1, show_one = 0;
1319 app_namespace_t *app_ns;
1320 session_table_t *st;
1321 u8 *ns_id = 0, fib_proto;
1323 memset (&lcl_ip, 0, sizeof (lcl_ip));
1324 memset (&rmt_ip, 0, sizeof (rmt_ip));
1325 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1327 if (unformat (input, "%U", unformat_transport_proto, &transport_proto))
1329 else if (unformat (input, "appns %_%v%_", &ns_id))
1331 else if (unformat (input, "scope global"))
1333 else if (unformat (input, "scope local"))
1335 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1336 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1337 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1343 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1344 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1345 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1352 return clib_error_return (0, "unknown input `%U'",
1353 format_unformat_error, input);
1356 if (transport_proto == ~0)
1358 vlib_cli_output (vm, "transport proto must be set");
1364 app_ns = app_namespace_get_from_id (ns_id);
1367 vlib_cli_output (vm, "appns %v doesn't exist", ns_id);
1373 app_ns = app_namespace_get_default ();
1376 if (scope == 1 || scope == 0)
1378 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1379 fib_index = is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1380 st = session_table_get_for_fib_index (fib_proto, fib_index);
1384 st = app_namespace_get_local_table (app_ns);
1389 session_rules_table_show_rule (vm, &st->session_rules, transport_proto,
1390 &lcl_ip, lcl_port, &rmt_ip, rmt_port,
1395 session_rules_table_cli_dump (vm, &st->session_rules, FIB_PROTOCOL_IP4,
1397 session_rules_table_cli_dump (vm, &st->session_rules, FIB_PROTOCOL_IP6,
1405 VLIB_CLI_COMMAND (show_session_rules_command, static) =
1407 .path = "show session rules",
1408 .short_help = "show session rules [appns <id> proto <proto> <lcl-ip/plen>"
1409 " <lcl-port> <rmt-ip/plen> <rmt-port>]",
1410 .function = show_session_rules_command_fn,
1415 session_lookup_init (void)
1418 * Allocate default table and map it to fib_index 0
1420 session_table_t *st = session_table_alloc ();
1421 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP4], 0);
1422 fib_index_to_table_index[FIB_PROTOCOL_IP4][0] = session_table_index (st);
1423 session_table_init (st);
1424 st = session_table_alloc ();
1425 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP6], 0);
1426 fib_index_to_table_index[FIB_PROTOCOL_IP6][0] = session_table_index (st);
1427 session_table_init (st);
1431 * fd.io coding-style-patch-verification: ON
1434 * eval: (c-set-style "gnu")