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_proxy_kv (session_kv4_t * kv, ip4_address_t * lcl, u8 proto)
118 v4_connection_key_t *key = (v4_connection_key_t *) kv->key;
120 key->src.as_u32 = lcl->as_u32;
130 make_v4_ss_kv_from_tc (session_kv4_t * kv, transport_connection_t * t)
132 make_v4_ss_kv (kv, &t->lcl_ip.ip4, &t->rmt_ip.ip4, t->lcl_port, t->rmt_port,
133 session_type_from_proto_and_ip (t->proto, 1));
137 make_v6_ss_kv (session_kv6_t * kv, ip6_address_t * lcl, ip6_address_t * rmt,
138 u16 lcl_port, u16 rmt_port, u8 proto)
140 v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
142 key->src.as_u64[0] = lcl->as_u64[0];
143 key->src.as_u64[1] = lcl->as_u64[1];
144 key->dst.as_u64[0] = rmt->as_u64[0];
145 key->dst.as_u64[1] = rmt->as_u64[1];
146 key->src_port = lcl_port;
147 key->dst_port = rmt_port;
155 make_v6_listener_kv (session_kv6_t * kv, ip6_address_t * lcl, u16 lcl_port,
158 v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
160 key->src.as_u64[0] = lcl->as_u64[0];
161 key->src.as_u64[1] = lcl->as_u64[1];
162 key->dst.as_u64[0] = 0;
163 key->dst.as_u64[1] = 0;
164 key->src_port = lcl_port;
173 make_v6_proxy_kv (session_kv6_t * kv, ip6_address_t * lcl, u8 proto)
175 v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
177 key->src.as_u64[0] = lcl->as_u64[0];
178 key->src.as_u64[1] = lcl->as_u64[1];
179 key->dst.as_u64[0] = 0;
180 key->dst.as_u64[1] = 0;
190 make_v6_ss_kv_from_tc (session_kv6_t * kv, transport_connection_t * t)
192 make_v6_ss_kv (kv, &t->lcl_ip.ip6, &t->rmt_ip.ip6, t->lcl_port, t->rmt_port,
193 session_type_from_proto_and_ip (t->proto, 0));
196 static session_table_t *
197 session_table_get_or_alloc (u8 fib_proto, u8 fib_index)
201 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
203 st = session_table_alloc ();
204 table_index = session_table_index (st);
205 vec_validate (fib_index_to_table_index[fib_proto], fib_index);
206 fib_index_to_table_index[fib_proto][fib_index] = table_index;
207 st->active_fib_proto = fib_proto;
212 table_index = fib_index_to_table_index[fib_proto][fib_index];
213 return session_table_get (table_index);
217 static session_table_t *
218 session_table_get_or_alloc_for_connection (transport_connection_t * tc)
221 fib_proto = transport_connection_fib_proto (tc);
222 return session_table_get_or_alloc (fib_proto, tc->fib_index);
225 static session_table_t *
226 session_table_get_for_connection (transport_connection_t * tc)
228 u32 fib_proto = transport_connection_fib_proto (tc);
229 if (vec_len (fib_index_to_table_index[fib_proto]) <= tc->fib_index)
232 session_table_get (fib_index_to_table_index[fib_proto][tc->fib_index]);
235 static session_table_t *
236 session_table_get_for_fib_index (u32 fib_proto, u32 fib_index)
238 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
240 return session_table_get (fib_index_to_table_index[fib_proto][fib_index]);
244 session_lookup_get_index_for_fib (u32 fib_proto, u32 fib_index)
246 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
247 return SESSION_TABLE_INVALID_INDEX;
248 return fib_index_to_table_index[fib_proto][fib_index];
252 * Add transport connection to a session table
254 * Session lookup 5-tuple (src-ip, dst-ip, src-port, dst-port, session-type)
255 * is added to requested session table.
257 * @param tc transport connection to be added
258 * @param value value to be stored
260 * @return non-zero if failure
263 session_lookup_add_connection (transport_connection_t * tc, u64 value)
269 st = session_table_get_or_alloc_for_connection (tc);
274 make_v4_ss_kv_from_tc (&kv4, tc);
276 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
281 make_v6_ss_kv_from_tc (&kv6, tc);
283 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
289 session_lookup_add_session_endpoint (u32 table_index,
290 session_endpoint_t * sep, u64 value)
296 st = session_table_get (table_index);
301 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
302 sep->transport_proto);
304 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 1);
308 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
309 sep->transport_proto);
311 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 1);
316 session_lookup_del_session_endpoint (u32 table_index,
317 session_endpoint_t * sep)
323 st = session_table_get (table_index);
328 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
329 sep->transport_proto);
330 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 0);
334 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
335 sep->transport_proto);
336 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 0);
341 * Delete transport connection from session table
343 * @param table_index session table index
344 * @param tc transport connection to be removed
346 * @return non-zero if failure
349 session_lookup_del_connection (transport_connection_t * tc)
355 st = session_table_get_for_connection (tc);
360 make_v4_ss_kv_from_tc (&kv4, tc);
361 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
366 make_v6_ss_kv_from_tc (&kv6, tc);
367 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
373 session_lookup_del_session (stream_session_t * s)
375 transport_connection_t *ts;
376 ts = tp_vfts[s->session_type].get_connection (s->connection_index,
378 return session_lookup_del_connection (ts);
382 session_lookup_action_index_is_valid (u32 action_index)
384 if (action_index == SESSION_RULES_TABLE_ACTION_ALLOW
385 || action_index == SESSION_RULES_TABLE_INVALID_INDEX)
391 session_lookup_action_to_app_index (u32 action_index)
393 switch (action_index)
395 case SESSION_RULES_TABLE_ACTION_DROP:
396 return APP_DROP_INDEX;
397 case SESSION_RULES_TABLE_ACTION_ALLOW:
398 case SESSION_RULES_TABLE_INVALID_INDEX:
399 return APP_INVALID_INDEX;
405 static stream_session_t *
406 session_lookup_app_listen_session (u32 app_index, u8 fib_proto,
410 app = application_get_if_valid (app_index);
414 return application_first_listener (app, fib_proto, transport_proto);
417 static stream_session_t *
418 session_lookup_action_to_session (u32 action_index, u8 fib_proto,
422 app_index = session_lookup_action_to_app_index (action_index);
423 /* Nothing sophisticated for now, action index is app index */
424 return session_lookup_app_listen_session (app_index, fib_proto,
429 session_lookup_rules_table_session4 (session_table_t * st, u8 proto,
430 ip4_address_t * lcl, u16 lcl_port,
431 ip4_address_t * rmt, u16 rmt_port)
433 session_rules_table_t *srt = &st->session_rules[proto];
434 u32 action_index, app_index;
435 action_index = session_rules_table_lookup4 (srt, lcl, rmt, lcl_port,
437 app_index = session_lookup_action_to_app_index (action_index);
438 /* Nothing sophisticated for now, action index is app index */
439 return session_lookup_app_listen_session (app_index, FIB_PROTOCOL_IP4,
444 session_lookup_rules_table_session6 (session_table_t * st, u8 proto,
445 ip6_address_t * lcl, u16 lcl_port,
446 ip6_address_t * rmt, u16 rmt_port)
448 session_rules_table_t *srt = &st->session_rules[proto];
449 u32 action_index, app_index;
450 action_index = session_rules_table_lookup6 (srt, lcl, rmt, lcl_port,
452 app_index = session_lookup_action_to_app_index (action_index);
453 return session_lookup_app_listen_session (app_index, FIB_PROTOCOL_IP6,
458 * Lookup listener for session endpoint in table
460 * @param table_index table where the endpoint should be looked up
461 * @param sep session endpoint to be looked up
462 * @param use_rules flag that indicates if the session rules of the table
464 * @return invalid handle if nothing is found, the handle of a valid listener
465 * or an action_index if a rule is hit
468 session_lookup_endpoint_listener (u32 table_index, session_endpoint_t * sep,
471 session_rules_table_t *srt;
477 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
478 st = session_table_get (table_index);
480 return SESSION_INVALID_HANDLE;
486 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port, sst);
487 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
492 memset (&lcl4, 0, sizeof (lcl4));
493 srt = &st->session_rules[sep->transport_proto];
494 ai = session_rules_table_lookup4 (srt, &lcl4, &sep->ip.ip4, 0,
496 if (session_lookup_action_index_is_valid (ai))
497 return session_lookup_action_to_app_index (ai);
505 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port, sst);
506 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
512 memset (&lcl6, 0, sizeof (lcl6));
513 srt = &st->session_rules[sep->transport_proto];
514 ai = session_rules_table_lookup6 (srt, &lcl6, &sep->ip.ip6, 0,
516 if (session_lookup_action_index_is_valid (ai))
517 return session_lookup_action_to_app_index (ai);
520 return SESSION_INVALID_HANDLE;
524 * Look up endpoint in local session table
526 * The result, for now, is an application index and it may in the future
527 * be extended to a more complicated "action object". The only action we
528 * emulate now is "drop" and for that we return a special app index.
530 * Lookup logic is to check in order:
531 * - the rules in the table (connect acls)
532 * - session sub-table for a listener
533 * - session sub-table for a local listener (zeroed addr)
535 * @param table_index table where the lookup should be done
536 * @param sep session endpoint to be looked up
537 * @return index that can be interpreted as an app index or drop action.
540 session_lookup_local_endpoint (u32 table_index, session_endpoint_t * sep)
542 session_rules_table_t *srt;
547 st = session_table_get (table_index);
549 return SESSION_INVALID_INDEX;
550 ASSERT (st->is_local);
558 * Check if endpoint has special rules associated
560 memset (&lcl4, 0, sizeof (lcl4));
561 srt = &st->session_rules[sep->transport_proto];
562 ai = session_rules_table_lookup4 (srt, &lcl4, &sep->ip.ip4, 0,
564 if (session_lookup_action_index_is_valid (ai))
565 return session_lookup_action_to_app_index (ai);
568 * Check if session endpoint is a listener
570 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
571 sep->transport_proto);
572 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
574 return (u32) kv4.value;
577 * Zero out the ip. Logic is that connect to local ips, say
578 * 127.0.0.1:port, can match 0.0.0.0:port
581 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
583 return (u32) kv4.value;
586 * Zero out the port and check if we have proxy
589 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
591 return (u32) kv4.value;
598 memset (&lcl6, 0, sizeof (lcl6));
599 srt = &st->session_rules[sep->transport_proto];
600 ai = session_rules_table_lookup6 (srt, &lcl6, &sep->ip.ip6, 0,
602 if (session_lookup_action_index_is_valid (ai))
603 return session_lookup_action_to_app_index (ai);
605 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
606 sep->transport_proto);
607 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
609 return (u32) kv6.value;
612 * Zero out the ip. Same logic as above.
614 kv6.key[0] = kv6.key[1] = 0;
615 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
617 return (u32) kv6.value;
620 * Zero out the port. Same logic as above.
622 kv6.key[4] = kv6.key[5] = 0;
623 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
625 return (u32) kv6.value;
627 return APP_INVALID_INDEX;
630 static stream_session_t *
631 session_lookup_listener4_i (session_table_t * st, ip4_address_t * lcl,
632 u16 lcl_port, u8 proto)
638 * First, try a fully formed listener
640 make_v4_listener_kv (&kv4, lcl, lcl_port, proto);
641 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
643 return session_manager_get_listener (proto, (u32) kv4.value);
646 * Zero out the lcl ip and check if any 0/0 port binds have been done
649 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
651 return session_manager_get_listener (proto, (u32) kv4.value);
654 * Zero out port and check if we have a proxy set up for our ip
656 make_v4_proxy_kv (&kv4, lcl, proto);
657 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
659 return session_manager_get_listener (proto, (u32) kv4.value);
665 session_lookup_listener4 (u32 fib_index, ip4_address_t * lcl, u16 lcl_port,
669 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
672 return session_lookup_listener4_i (st, lcl, lcl_port, proto);
675 static stream_session_t *
676 session_lookup_listener6_i (session_table_t * st, ip6_address_t * lcl,
677 u16 lcl_port, u8 proto)
682 make_v6_listener_kv (&kv6, lcl, lcl_port, proto);
683 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
685 return session_manager_get_listener (proto, (u32) kv6.value);
687 /* Zero out the lcl ip */
688 kv6.key[0] = kv6.key[1] = 0;
689 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
691 return session_manager_get_listener (proto, (u32) kv6.value);
693 make_v6_proxy_kv (&kv6, lcl, proto);
694 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
696 return session_manager_get_listener (proto, (u32) kv6.value);
701 session_lookup_listener6 (u32 fib_index, ip6_address_t * lcl, u16 lcl_port,
705 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
708 return session_lookup_listener6_i (st, lcl, lcl_port, proto);
712 session_lookup_listener (u32 table_index, session_endpoint_t * sep)
715 st = session_table_get (table_index);
719 return session_lookup_listener4_i (st, &sep->ip.ip4, sep->port,
720 sep->transport_proto);
722 return session_lookup_listener6_i (st, &sep->ip.ip6, sep->port,
723 sep->transport_proto);
728 session_lookup_add_half_open (transport_connection_t * tc, u64 value)
734 st = session_table_get_or_alloc_for_connection (tc);
739 make_v4_ss_kv_from_tc (&kv4, tc);
741 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
746 make_v6_ss_kv_from_tc (&kv6, tc);
748 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
754 session_lookup_del_half_open (transport_connection_t * tc)
760 st = session_table_get_for_connection (tc);
765 make_v4_ss_kv_from_tc (&kv4, tc);
766 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
771 make_v6_ss_kv_from_tc (&kv6, tc);
772 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
778 session_lookup_half_open_handle (transport_connection_t * tc)
785 st = session_table_get_for_fib_index (transport_connection_fib_proto (tc),
788 return HALF_OPEN_LOOKUP_INVALID_VALUE;
791 make_v4_ss_kv (&kv4, &tc->lcl_ip.ip4, &tc->rmt_ip.ip4, tc->lcl_port,
792 tc->rmt_port, tc->proto);
793 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
799 make_v6_ss_kv (&kv6, &tc->lcl_ip.ip6, &tc->rmt_ip.ip6, tc->lcl_port,
800 tc->rmt_port, tc->proto);
801 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
805 return HALF_OPEN_LOOKUP_INVALID_VALUE;
808 transport_connection_t *
809 session_lookup_half_open_connection (u64 handle, u8 proto, u8 is_ip4)
813 if (handle != HALF_OPEN_LOOKUP_INVALID_VALUE)
815 sst = session_type_from_proto_and_ip (proto, is_ip4);
816 return tp_vfts[sst].get_half_open (handle & 0xFFFFFFFF);
822 * Lookup connection with ip4 and transport layer information
824 * This is used on the fast path so it needs to be fast. Thereby,
825 * duplication of code and 'hacks' allowed.
827 * The lookup is incremental and returns whenever something is matched. The
829 * - Try to find an established session
830 * - Try to find a half-open connection
831 * - Try session rules table
832 * - Try to find a fully-formed or local source wildcarded (listener bound to
833 * all interfaces) listener session
836 * @param fib_index index of fib wherein the connection was received
837 * @param lcl local ip4 address
838 * @param rmt remote ip4 address
839 * @param lcl_port local port
840 * @param rmt_port remote port
841 * @param proto transport protocol (e.g., tcp, udp)
842 * @param thread_index thread index for request
843 * @param is_filtered return flag that indicates if connection was filtered.
845 * @return pointer to transport connection, if one is found, 0 otherwise
847 transport_connection_t *
848 session_lookup_connection_wt4 (u32 fib_index, ip4_address_t * lcl,
849 ip4_address_t * rmt, u16 lcl_port,
850 u16 rmt_port, u8 proto, u32 thread_index,
859 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
860 if (PREDICT_FALSE (!st))
864 * Lookup session amongst established ones
866 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
867 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
870 ASSERT ((u32) (kv4.value >> 32) == thread_index);
871 s = session_get (kv4.value & 0xFFFFFFFFULL, thread_index);
872 return tp_vfts[s->session_type].get_connection (s->connection_index,
877 * Try half-open connections
879 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
882 u32 sst = session_type_from_proto_and_ip (proto, 1);
883 return tp_vfts[sst].get_half_open (kv4.value & 0xFFFFFFFF);
887 * Check the session rules table
889 action_index = session_rules_table_lookup4 (&st->session_rules[proto], lcl,
890 rmt, lcl_port, rmt_port);
891 if (session_lookup_action_index_is_valid (action_index))
893 if ((*is_filtered = (action_index == SESSION_RULES_TABLE_ACTION_DROP)))
895 if ((s = session_lookup_action_to_session (action_index,
896 FIB_PROTOCOL_IP4, proto)))
897 return tp_vfts[s->session_type].get_listener (s->connection_index);
902 * If nothing is found, check if any listener is available
904 s = session_lookup_listener4_i (st, lcl, lcl_port, proto);
906 return tp_vfts[s->session_type].get_listener (s->connection_index);
912 * Lookup connection with ip4 and transport layer information
914 * Not optimized. This is used on the fast path so it needs to be fast.
915 * Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical
916 * to that of @ref session_lookup_connection_wt4
918 * @param fib_index index of the fib wherein the connection was received
919 * @param lcl local ip4 address
920 * @param rmt remote ip4 address
921 * @param lcl_port local port
922 * @param rmt_port remote port
923 * @param proto transport protocol (e.g., tcp, udp)
925 * @return pointer to transport connection, if one is found, 0 otherwise
927 transport_connection_t *
928 session_lookup_connection4 (u32 fib_index, ip4_address_t * lcl,
929 ip4_address_t * rmt, u16 lcl_port, u16 rmt_port,
938 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
939 if (PREDICT_FALSE (!st))
943 * Lookup session amongst established ones
945 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
946 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
949 s = session_get_from_handle (kv4.value);
950 return tp_vfts[s->session_type].get_connection (s->connection_index,
955 * Try half-open connections
957 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
960 u32 sst = session_type_from_proto_and_ip (proto, 1);
961 return tp_vfts[sst].get_half_open (kv4.value & 0xFFFFFFFF);
965 * Check the session rules table
967 action_index = session_rules_table_lookup4 (&st->session_rules[proto], lcl,
968 rmt, lcl_port, rmt_port);
969 if (session_lookup_action_index_is_valid (action_index))
971 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
973 if ((s = session_lookup_action_to_session (action_index,
974 FIB_PROTOCOL_IP4, proto)))
975 return tp_vfts[s->session_type].get_listener (s->connection_index);
980 * If nothing is found, check if any listener is available
982 s = session_lookup_listener4_i (st, lcl, lcl_port, proto);
984 return tp_vfts[s->session_type].get_listener (s->connection_index);
990 * Lookup session with ip4 and transport layer information
992 * Important note: this may look into another thread's pool table and
993 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
994 * if needed as soon as possible.
996 * Lookup logic is similar to that of @ref session_lookup_connection_wt4 but
997 * this returns a session as opposed to a transport connection and it does not
998 * try to lookup half-open sessions.
1000 * Typically used by dgram connections
1003 session_lookup_safe4 (u32 fib_index, ip4_address_t * lcl, ip4_address_t * rmt,
1004 u16 lcl_port, u16 rmt_port, u8 proto)
1006 session_table_t *st;
1008 stream_session_t *s;
1012 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
1013 if (PREDICT_FALSE (!st))
1017 * Lookup session amongst established ones
1019 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
1020 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
1022 return session_get_from_handle_safe (kv4.value);
1025 * Check the session rules table
1027 action_index = session_rules_table_lookup4 (&st->session_rules[proto], lcl,
1028 rmt, lcl_port, rmt_port);
1029 if (session_lookup_action_index_is_valid (action_index))
1031 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
1033 return session_lookup_action_to_session (action_index, FIB_PROTOCOL_IP4,
1038 * If nothing is found, check if any listener is available
1040 if ((s = session_lookup_listener4_i (st, lcl, lcl_port, proto)))
1047 * Lookup connection with ip6 and transport layer information
1049 * This is used on the fast path so it needs to be fast. Thereby,
1050 * duplication of code and 'hacks' allowed.
1052 * The lookup is incremental and returns whenever something is matched. The
1054 * - Try to find an established session
1055 * - Try to find a half-open connection
1056 * - Try session rules table
1057 * - Try to find a fully-formed or local source wildcarded (listener bound to
1058 * all interfaces) listener session
1061 * @param fib_index index of the fib wherein the connection was received
1062 * @param lcl local ip6 address
1063 * @param rmt remote ip6 address
1064 * @param lcl_port local port
1065 * @param rmt_port remote port
1066 * @param proto transport protocol (e.g., tcp, udp)
1067 * @param thread_index thread index for request
1069 * @return pointer to transport connection, if one is found, 0 otherwise
1071 transport_connection_t *
1072 session_lookup_connection_wt6 (u32 fib_index, ip6_address_t * lcl,
1073 ip6_address_t * rmt, u16 lcl_port,
1074 u16 rmt_port, u8 proto, u32 thread_index,
1077 session_table_t *st;
1078 stream_session_t *s;
1083 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1084 if (PREDICT_FALSE (!st))
1087 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1088 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1091 ASSERT ((u32) (kv6.value >> 32) == thread_index);
1092 s = session_get (kv6.value & 0xFFFFFFFFULL, thread_index);
1093 return tp_vfts[s->session_type].get_connection (s->connection_index,
1097 /* Try half-open connections */
1098 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
1101 u32 sst = session_type_from_proto_and_ip (proto, 1);
1102 return tp_vfts[sst].get_half_open (kv6.value & 0xFFFFFFFF);
1105 /* Check the session rules table */
1106 action_index = session_rules_table_lookup6 (&st->session_rules[proto], lcl,
1107 rmt, lcl_port, rmt_port);
1108 if (session_lookup_action_index_is_valid (action_index))
1110 if ((*is_filtered = (action_index == SESSION_RULES_TABLE_ACTION_DROP)))
1112 if ((s = session_lookup_action_to_session (action_index,
1113 FIB_PROTOCOL_IP6, proto)))
1114 return tp_vfts[s->session_type].get_listener (s->connection_index);
1118 /* If nothing is found, check if any listener is available */
1119 s = session_lookup_listener6_i (st, lcl, lcl_port, proto);
1121 return tp_vfts[s->session_type].get_listener (s->connection_index);
1127 * Lookup connection with ip6 and transport layer information
1129 * Not optimized. This is used on the fast path so it needs to be fast.
1130 * Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical
1131 * to that of @ref session_lookup_connection_wt4
1133 * @param fib_index index of the fib wherein the connection was received
1134 * @param lcl local ip6 address
1135 * @param rmt remote ip6 address
1136 * @param lcl_port local port
1137 * @param rmt_port remote port
1138 * @param proto transport protocol (e.g., tcp, udp)
1140 * @return pointer to transport connection, if one is found, 0 otherwise
1142 transport_connection_t *
1143 session_lookup_connection6 (u32 fib_index, ip6_address_t * lcl,
1144 ip6_address_t * rmt, u16 lcl_port, u16 rmt_port,
1147 session_table_t *st;
1148 stream_session_t *s;
1153 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1154 if (PREDICT_FALSE (!st))
1157 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1158 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1161 s = session_get_from_handle (kv6.value);
1162 return tp_vfts[s->session_type].get_connection (s->connection_index,
1166 /* Try half-open connections */
1167 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
1170 u32 sst = session_type_from_proto_and_ip (proto, 1);
1171 return tp_vfts[sst].get_half_open (kv6.value & 0xFFFFFFFF);
1174 /* Check the session rules table */
1175 action_index = session_rules_table_lookup6 (&st->session_rules[proto], lcl,
1176 rmt, lcl_port, rmt_port);
1177 if (session_lookup_action_index_is_valid (action_index))
1179 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
1181 if ((s = session_lookup_action_to_session (action_index,
1182 FIB_PROTOCOL_IP6, proto)))
1183 return tp_vfts[s->session_type].get_listener (s->connection_index);
1187 /* If nothing is found, check if any listener is available */
1188 s = session_lookup_listener6 (fib_index, lcl, lcl_port, proto);
1190 return tp_vfts[s->session_type].get_listener (s->connection_index);
1196 * Lookup session with ip6 and transport layer information
1198 * Important note: this may look into another thread's pool table and
1199 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
1200 * if needed as soon as possible.
1202 * Lookup logic is similar to that of @ref session_lookup_connection_wt6 but
1203 * this returns a session as opposed to a transport connection and it does not
1204 * try to lookup half-open sessions.
1206 * Typically used by dgram connections
1209 session_lookup_safe6 (u32 fib_index, ip6_address_t * lcl, ip6_address_t * rmt,
1210 u16 lcl_port, u16 rmt_port, u8 proto)
1212 session_table_t *st;
1214 stream_session_t *s;
1218 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1219 if (PREDICT_FALSE (!st))
1222 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1223 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1225 return session_get_from_handle_safe (kv6.value);
1227 /* Check the session rules table */
1228 action_index = session_rules_table_lookup6 (&st->session_rules[proto], lcl,
1229 rmt, lcl_port, rmt_port);
1230 if (session_lookup_action_index_is_valid (action_index))
1232 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
1234 return session_lookup_action_to_session (action_index, FIB_PROTOCOL_IP6,
1238 /* If nothing is found, check if any listener is available */
1239 if ((s = session_lookup_listener6_i (st, lcl, lcl_port, proto)))
1245 session_lookup_local_listener_make_handle (session_endpoint_t * sep)
1247 return ((u64) SESSION_LOCAL_TABLE_PREFIX << 32
1248 | (u32) sep->port << 16 | (u32) sep->transport_proto << 8
1249 | (u32) sep->is_ip4);
1253 session_lookup_local_is_handle (u64 handle)
1255 if (handle >> 32 == SESSION_LOCAL_TABLE_PREFIX)
1261 session_lookup_local_listener_parse_handle (u64 handle,
1262 session_endpoint_t * sep)
1264 u32 local_table_handle;
1265 if (handle >> 32 != SESSION_LOCAL_TABLE_PREFIX)
1267 local_table_handle = handle & 0xFFFFFFFFULL;
1268 sep->is_ip4 = local_table_handle & 0xff;
1269 local_table_handle >>= 8;
1270 sep->transport_proto = local_table_handle & 0xff;
1271 sep->port = local_table_handle >> 8;
1276 vnet_session_rule_add_del (session_rule_add_del_args_t * args)
1278 app_namespace_t *app_ns = app_namespace_get (args->appns_index);
1279 session_rules_table_t *srt;
1280 session_table_t *st;
1283 clib_error_t *error;
1286 return clib_error_return_code (0, VNET_API_ERROR_APP_INVALID_NS, 0,
1288 if (args->scope > 3)
1289 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
1291 if (args->transport_proto != TRANSPORT_PROTO_TCP
1292 && args->transport_proto != TRANSPORT_PROTO_UDP)
1293 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
1294 "invalid transport proto");
1295 if ((args->scope & SESSION_RULE_SCOPE_GLOBAL) || args->scope == 0)
1297 fib_proto = args->table_args.rmt.fp_proto;
1298 fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1299 st = session_table_get_for_fib_index (fib_proto, fib_index);
1300 srt = &st->session_rules[args->transport_proto];
1301 if ((error = session_rules_table_add_del (srt, &args->table_args)))
1303 clib_error_report (error);
1307 if (args->scope & SESSION_RULE_SCOPE_LOCAL)
1309 memset (&args->table_args.lcl, 0, sizeof (args->table_args.lcl));
1310 args->table_args.lcl.fp_proto = args->table_args.rmt.fp_proto;
1311 args->table_args.lcl_port = 0;
1312 st = app_namespace_get_local_table (app_ns);
1313 srt = &st->session_rules[args->transport_proto];
1314 error = session_rules_table_add_del (srt, &args->table_args);
1320 * Mark (global) tables as pertaining to app ns
1323 session_lookup_set_tables_appns (app_namespace_t * app_ns)
1325 session_table_t *st;
1329 for (fp = 0; fp < ARRAY_LEN (fib_index_to_table_index); fp++)
1331 fib_index = app_namespace_get_fib_index (app_ns, fp);
1332 st = session_table_get_for_fib_index (fp, fib_index);
1334 st->appns_index = app_namespace_index (app_ns);
1339 format_ip4_session_lookup_kvp (u8 * s, va_list * args)
1341 clib_bihash_kv_16_8_t *kvp = va_arg (*args, clib_bihash_kv_16_8_t *);
1342 u32 is_local = va_arg (*args, u32);
1343 u8 *app_name, *str = 0;
1344 stream_session_t *session;
1345 v4_connection_key_t *key = (v4_connection_key_t *) kvp->key;
1347 char *proto = key->proto == TRANSPORT_PROTO_TCP ? "T" : "U";
1350 session = session_get_from_handle (kvp->value);
1351 app_name = application_name_from_index (session->app_index);
1352 str = format (0, "[%s] %U:%d->%U:%d", proto, format_ip4_address,
1353 &key->src, clib_net_to_host_u16 (key->src_port),
1354 format_ip4_address, &key->dst,
1355 clib_net_to_host_u16 (key->dst_port));
1356 s = format (s, "%-40v%-30v", str, app_name);
1360 app_name = application_name_from_index (kvp->value);
1361 str = format (0, "[%s] %U:%d", proto, format_ip4_address,
1362 &key->src, clib_net_to_host_u16 (key->src_port));
1363 s = format (s, "%-30v%-30v", str, app_name);
1365 vec_free (app_name);
1369 typedef struct _ip4_session_table_show_ctx_t
1373 } ip4_session_table_show_ctx_t;
1376 ip4_session_table_show (clib_bihash_kv_16_8_t * kvp, void *arg)
1378 ip4_session_table_show_ctx_t *ctx = arg;
1379 vlib_cli_output (ctx->vm, "%U", format_ip4_session_lookup_kvp, kvp,
1385 session_lookup_show_table_entries (vlib_main_t * vm, session_table_t * table,
1386 u8 type, u8 is_local)
1388 ip4_session_table_show_ctx_t ctx = {
1390 .is_local = is_local,
1393 vlib_cli_output (vm, "%-40s%-30s", "Session", "Application");
1395 vlib_cli_output (vm, "%-30s%-30s", "Listener", "Application");
1400 ip4_session_table_walk (&table->v4_session_hash, ip4_session_table_show,
1404 clib_warning ("not supported");
1408 static clib_error_t *
1409 session_rule_command_fn (vlib_main_t * vm, unformat_input_t * input,
1410 vlib_cli_command_t * cmd)
1412 u32 proto = ~0, lcl_port, rmt_port, action = 0, lcl_plen = 0, rmt_plen = 0;
1413 u32 appns_index, scope = 0;
1414 ip46_address_t lcl_ip, rmt_ip;
1415 u8 is_ip4 = 1, conn_set = 0;
1416 u8 fib_proto, is_add = 1, *ns_id = 0;
1418 app_namespace_t *app_ns;
1419 clib_error_t *error;
1421 memset (&lcl_ip, 0, sizeof (lcl_ip));
1422 memset (&rmt_ip, 0, sizeof (rmt_ip));
1423 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1425 if (unformat (input, "del"))
1427 else if (unformat (input, "add"))
1429 else if (unformat (input, "appns %_%v%_", &ns_id))
1431 else if (unformat (input, "scope global"))
1432 scope = SESSION_RULE_SCOPE_GLOBAL;
1433 else if (unformat (input, "scope local"))
1434 scope = SESSION_RULE_SCOPE_LOCAL;
1435 else if (unformat (input, "scope all"))
1436 scope = SESSION_RULE_SCOPE_LOCAL | SESSION_RULE_SCOPE_GLOBAL;
1437 else if (unformat (input, "proto %U", unformat_transport_proto, &proto))
1439 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1440 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1441 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1447 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1448 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1449 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1455 else if (unformat (input, "action %d", &action))
1457 else if (unformat (input, "tag %_%v%_", &tag))
1460 return clib_error_return (0, "unknown input `%U'",
1461 format_unformat_error, input);
1466 vlib_cli_output (vm, "proto must be set");
1469 if (is_add && !conn_set && action == ~0)
1471 vlib_cli_output (vm, "connection and action must be set for add");
1474 if (!is_add && !tag && !conn_set)
1476 vlib_cli_output (vm, "connection or tag must be set for delete");
1479 if (vec_len (tag) > SESSION_RULE_TAG_MAX_LEN)
1481 vlib_cli_output (vm, "tag too long (max u64)");
1487 app_ns = app_namespace_get_from_id (ns_id);
1490 vlib_cli_output (vm, "namespace %v does not exist", ns_id);
1496 app_ns = app_namespace_get_default ();
1498 appns_index = app_namespace_index (app_ns);
1500 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1501 session_rule_add_del_args_t args = {
1502 .table_args.lcl.fp_addr = lcl_ip,
1503 .table_args.lcl.fp_len = lcl_plen,
1504 .table_args.lcl.fp_proto = fib_proto,
1505 .table_args.rmt.fp_addr = rmt_ip,
1506 .table_args.rmt.fp_len = rmt_plen,
1507 .table_args.rmt.fp_proto = fib_proto,
1508 .table_args.lcl_port = lcl_port,
1509 .table_args.rmt_port = rmt_port,
1510 .table_args.action_index = action,
1511 .table_args.is_add = is_add,
1512 .table_args.tag = tag,
1513 .appns_index = appns_index,
1516 error = vnet_session_rule_add_del (&args);
1522 VLIB_CLI_COMMAND (session_rule_command, static) =
1524 .path = "session rule",
1525 .short_help = "session rule [add|del] appns <ns_id> proto <proto> "
1526 "<lcl-ip/plen> <lcl-port> <rmt-ip/plen> <rmt-port> action <action>",
1527 .function = session_rule_command_fn,
1532 session_lookup_dump_rules_table (u32 fib_index, u8 fib_proto,
1535 vlib_main_t *vm = vlib_get_main ();
1536 session_rules_table_t *srt;
1537 session_table_t *st;
1538 st = session_table_get_for_fib_index (fib_index, fib_proto);
1539 srt = &st->session_rules[transport_proto];
1540 session_rules_table_cli_dump (vm, srt, fib_proto);
1544 session_lookup_dump_local_rules_table (u32 table_index, u8 fib_proto,
1547 vlib_main_t *vm = vlib_get_main ();
1548 session_rules_table_t *srt;
1549 session_table_t *st;
1550 st = session_table_get (table_index);
1551 srt = &st->session_rules[transport_proto];
1552 session_rules_table_cli_dump (vm, srt, fib_proto);
1555 static clib_error_t *
1556 show_session_rules_command_fn (vlib_main_t * vm, unformat_input_t * input,
1557 vlib_cli_command_t * cmd)
1559 u32 transport_proto = ~0, lcl_port, rmt_port, lcl_plen, rmt_plen;
1560 u32 fib_index, scope = 0;
1561 ip46_address_t lcl_ip, rmt_ip;
1562 u8 is_ip4 = 1, show_one = 0;
1563 app_namespace_t *app_ns;
1564 session_rules_table_t *srt;
1565 session_table_t *st;
1566 u8 *ns_id = 0, fib_proto;
1568 memset (&lcl_ip, 0, sizeof (lcl_ip));
1569 memset (&rmt_ip, 0, sizeof (rmt_ip));
1570 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1572 if (unformat (input, "%U", unformat_transport_proto, &transport_proto))
1574 else if (unformat (input, "appns %_%v%_", &ns_id))
1576 else if (unformat (input, "scope global"))
1578 else if (unformat (input, "scope local"))
1580 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1581 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1582 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1588 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1589 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1590 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1597 return clib_error_return (0, "unknown input `%U'",
1598 format_unformat_error, input);
1601 if (transport_proto == ~0)
1603 vlib_cli_output (vm, "transport proto must be set");
1609 app_ns = app_namespace_get_from_id (ns_id);
1612 vlib_cli_output (vm, "appns %v doesn't exist", ns_id);
1618 app_ns = app_namespace_get_default ();
1621 if (scope == 1 || scope == 0)
1623 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1624 fib_index = is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1625 st = session_table_get_for_fib_index (fib_proto, fib_index);
1629 st = app_namespace_get_local_table (app_ns);
1634 srt = &st->session_rules[transport_proto];
1635 session_rules_table_show_rule (vm, srt, &lcl_ip, lcl_port, &rmt_ip,
1640 vlib_cli_output (vm, "%U rules table", format_transport_proto,
1642 srt = &st->session_rules[transport_proto];
1643 session_rules_table_cli_dump (vm, srt, FIB_PROTOCOL_IP4);
1644 session_rules_table_cli_dump (vm, srt, FIB_PROTOCOL_IP6);
1651 VLIB_CLI_COMMAND (show_session_rules_command, static) =
1653 .path = "show session rules",
1654 .short_help = "show session rules [<proto> appns <id> <lcl-ip/plen> "
1655 "<lcl-port> <rmt-ip/plen> <rmt-port> scope <scope>]",
1656 .function = show_session_rules_command_fn,
1661 session_lookup_init (void)
1664 * Allocate default table and map it to fib_index 0
1666 session_table_t *st = session_table_alloc ();
1667 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP4], 0);
1668 fib_index_to_table_index[FIB_PROTOCOL_IP4][0] = session_table_index (st);
1669 st->active_fib_proto = FIB_PROTOCOL_IP4;
1670 session_table_init (st, FIB_PROTOCOL_IP4);
1671 st = session_table_alloc ();
1672 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP6], 0);
1673 fib_index_to_table_index[FIB_PROTOCOL_IP6][0] = session_table_index (st);
1674 st->active_fib_proto = FIB_PROTOCOL_IP6;
1675 session_table_init (st, FIB_PROTOCOL_IP6);
1679 * fd.io coding-style-patch-verification: ON
1682 * eval: (c-set-style "gnu")