2 * Copyright (c) 2017-2019 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 * Network namespace index (i.e., fib index) to session lookup table. We
34 * should have one per network protocol type but for now we only support IP4/6
36 static u32 *fib_index_to_table_index[2];
40 typedef CLIB_PACKED (struct {
49 /* align by making this 4 octets even though its a 1-bit field
50 * NOTE: avoid key overlap with other transports that use 5 tuples for
51 * session identification.
57 }) v4_connection_key_t;
59 typedef CLIB_PACKED (struct {
74 }) v6_connection_key_t;
77 typedef clib_bihash_kv_16_8_t session_kv4_t;
78 typedef clib_bihash_kv_48_8_t session_kv6_t;
81 make_v4_ss_kv (session_kv4_t * kv, ip4_address_t * lcl, ip4_address_t * rmt,
82 u16 lcl_port, u16 rmt_port, u8 proto)
84 kv->key[0] = (u64) rmt->as_u32 << 32 | (u64) lcl->as_u32;
85 kv->key[1] = (u64) proto << 32 | (u64) rmt_port << 16 | (u64) lcl_port;
90 make_v4_listener_kv (session_kv4_t * kv, ip4_address_t * lcl, u16 lcl_port,
93 kv->key[0] = (u64) lcl->as_u32;
94 kv->key[1] = (u64) proto << 32 | (u64) lcl_port;
99 make_v4_proxy_kv (session_kv4_t * kv, ip4_address_t * lcl, u8 proto)
101 kv->key[0] = (u64) lcl->as_u32;
102 kv->key[1] = (u64) proto << 32;
107 make_v4_ss_kv_from_tc (session_kv4_t * kv, transport_connection_t * tc)
109 make_v4_ss_kv (kv, &tc->lcl_ip.ip4, &tc->rmt_ip.ip4, tc->lcl_port,
110 tc->rmt_port, tc->proto);
114 make_v6_ss_kv (session_kv6_t * kv, ip6_address_t * lcl, ip6_address_t * rmt,
115 u16 lcl_port, u16 rmt_port, u8 proto)
117 kv->key[0] = lcl->as_u64[0];
118 kv->key[1] = lcl->as_u64[1];
119 kv->key[2] = rmt->as_u64[0];
120 kv->key[3] = rmt->as_u64[1];
121 kv->key[4] = (u64) proto << 32 | (u64) rmt_port << 16 | (u64) lcl_port;
127 make_v6_listener_kv (session_kv6_t * kv, ip6_address_t * lcl, u16 lcl_port,
130 kv->key[0] = lcl->as_u64[0];
131 kv->key[1] = lcl->as_u64[1];
134 kv->key[4] = (u64) proto << 32 | (u64) lcl_port;
140 make_v6_proxy_kv (session_kv6_t * kv, ip6_address_t * lcl, u8 proto)
142 kv->key[0] = lcl->as_u64[0];
143 kv->key[1] = lcl->as_u64[1];
146 kv->key[4] = (u64) proto << 32;
152 make_v6_ss_kv_from_tc (session_kv6_t * kv, transport_connection_t * tc)
154 make_v6_ss_kv (kv, &tc->lcl_ip.ip6, &tc->rmt_ip.ip6, tc->lcl_port,
155 tc->rmt_port, tc->proto);
158 static session_table_t *
159 session_table_get_or_alloc (u8 fib_proto, u8 fib_index)
163 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
165 st = session_table_alloc ();
166 table_index = session_table_index (st);
167 vec_validate (fib_index_to_table_index[fib_proto], fib_index);
168 fib_index_to_table_index[fib_proto][fib_index] = table_index;
169 st->active_fib_proto = fib_proto;
170 session_table_init (st, fib_proto);
175 table_index = fib_index_to_table_index[fib_proto][fib_index];
176 return session_table_get (table_index);
180 static session_table_t *
181 session_table_get_or_alloc_for_connection (transport_connection_t * tc)
184 fib_proto = transport_connection_fib_proto (tc);
185 return session_table_get_or_alloc (fib_proto, tc->fib_index);
188 static session_table_t *
189 session_table_get_for_connection (transport_connection_t * tc)
191 u32 fib_proto = transport_connection_fib_proto (tc);
192 if (vec_len (fib_index_to_table_index[fib_proto]) <= tc->fib_index)
195 session_table_get (fib_index_to_table_index[fib_proto][tc->fib_index]);
198 static session_table_t *
199 session_table_get_for_fib_index (u32 fib_proto, u32 fib_index)
201 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
203 return session_table_get (fib_index_to_table_index[fib_proto][fib_index]);
207 session_lookup_get_index_for_fib (u32 fib_proto, u32 fib_index)
209 if (vec_len (fib_index_to_table_index[fib_proto]) <= fib_index)
210 return SESSION_TABLE_INVALID_INDEX;
211 return fib_index_to_table_index[fib_proto][fib_index];
215 * Add transport connection to a session table
217 * Session lookup 5-tuple (src-ip, dst-ip, src-port, dst-port, session-type)
218 * is added to requested session table.
220 * @param tc transport connection to be added
221 * @param value value to be stored
223 * @return non-zero if failure
226 session_lookup_add_connection (transport_connection_t * tc, u64 value)
232 st = session_table_get_or_alloc_for_connection (tc);
237 make_v4_ss_kv_from_tc (&kv4, tc);
239 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
244 make_v6_ss_kv_from_tc (&kv6, tc);
246 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
252 session_lookup_add_session_endpoint (u32 table_index,
253 session_endpoint_t * sep, u64 value)
259 st = session_table_get (table_index);
264 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
265 sep->transport_proto);
267 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 1);
271 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
272 sep->transport_proto);
274 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 1);
279 session_lookup_del_session_endpoint (u32 table_index,
280 session_endpoint_t * sep)
286 st = session_table_get (table_index);
291 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
292 sep->transport_proto);
293 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4, 0);
297 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
298 sep->transport_proto);
299 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6, 0);
304 * Delete transport connection from session table
306 * @param table_index session table index
307 * @param tc transport connection to be removed
309 * @return non-zero if failure
312 session_lookup_del_connection (transport_connection_t * tc)
318 st = session_table_get_for_connection (tc);
323 make_v4_ss_kv_from_tc (&kv4, tc);
324 return clib_bihash_add_del_16_8 (&st->v4_session_hash, &kv4,
329 make_v6_ss_kv_from_tc (&kv6, tc);
330 return clib_bihash_add_del_48_8 (&st->v6_session_hash, &kv6,
336 session_lookup_del_session (session_t * s)
338 transport_connection_t *ts;
339 ts = transport_get_connection (session_get_transport_proto (s),
340 s->connection_index, s->thread_index);
341 return session_lookup_del_connection (ts);
345 session_lookup_action_index_is_valid (u32 action_index)
347 if (action_index == SESSION_RULES_TABLE_ACTION_ALLOW
348 || action_index == SESSION_RULES_TABLE_INVALID_INDEX)
354 session_lookup_action_to_handle (u32 action_index)
356 switch (action_index)
358 case SESSION_RULES_TABLE_ACTION_DROP:
359 return SESSION_DROP_HANDLE;
360 case SESSION_RULES_TABLE_ACTION_ALLOW:
361 case SESSION_RULES_TABLE_INVALID_INDEX:
362 return SESSION_INVALID_HANDLE;
364 /* application index */
370 session_lookup_app_listen_session (u32 app_index, u8 fib_proto,
374 app = application_get_if_valid (app_index);
378 return app_worker_first_listener (application_get_default_worker (app),
379 fib_proto, transport_proto);
383 session_lookup_action_to_session (u32 action_index, u8 fib_proto,
387 app_index = session_lookup_action_to_handle (action_index);
388 /* Nothing sophisticated for now, action index is app index */
389 return session_lookup_app_listen_session (app_index, fib_proto,
395 session_lookup_rules_table_session4 (session_table_t * st, u8 proto,
396 ip4_address_t * lcl, u16 lcl_port,
397 ip4_address_t * rmt, u16 rmt_port)
399 session_rules_table_t *srt = &st->session_rules[proto];
400 u32 action_index, app_index;
401 action_index = session_rules_table_lookup4 (srt, lcl, rmt, lcl_port,
403 app_index = session_lookup_action_to_handle (action_index);
404 /* Nothing sophisticated for now, action index is app index */
405 return session_lookup_app_listen_session (app_index, FIB_PROTOCOL_IP4,
411 session_lookup_rules_table_session6 (session_table_t * st, u8 proto,
412 ip6_address_t * lcl, u16 lcl_port,
413 ip6_address_t * rmt, u16 rmt_port)
415 session_rules_table_t *srt = &st->session_rules[proto];
416 u32 action_index, app_index;
417 action_index = session_rules_table_lookup6 (srt, lcl, rmt, lcl_port,
419 app_index = session_lookup_action_to_handle (action_index);
420 return session_lookup_app_listen_session (app_index, FIB_PROTOCOL_IP6,
425 * Lookup listener for session endpoint in table
427 * @param table_index table where the endpoint should be looked up
428 * @param sep session endpoint to be looked up
429 * @param use_rules flag that indicates if the session rules of the table
431 * @return invalid handle if nothing is found, the handle of a valid listener
432 * or an action derived handle if a rule is hit
435 session_lookup_endpoint_listener (u32 table_index, session_endpoint_t * sep,
438 session_rules_table_t *srt;
443 st = session_table_get (table_index);
445 return SESSION_INVALID_HANDLE;
451 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
452 sep->transport_proto);
453 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
458 clib_memset (&lcl4, 0, sizeof (lcl4));
459 srt = &st->session_rules[sep->transport_proto];
460 ai = session_rules_table_lookup4 (srt, &lcl4, &sep->ip.ip4, 0,
462 if (session_lookup_action_index_is_valid (ai))
463 return session_lookup_action_to_handle (ai);
471 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
472 sep->transport_proto);
473 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
479 clib_memset (&lcl6, 0, sizeof (lcl6));
480 srt = &st->session_rules[sep->transport_proto];
481 ai = session_rules_table_lookup6 (srt, &lcl6, &sep->ip.ip6, 0,
483 if (session_lookup_action_index_is_valid (ai))
484 return session_lookup_action_to_handle (ai);
487 return SESSION_INVALID_HANDLE;
491 * Look up endpoint in local session table
493 * The result, for now, is an application index and it may in the future
494 * be extended to a more complicated "action object". The only action we
495 * emulate now is "drop" and for that we return a special app index.
497 * Lookup logic is to check in order:
498 * - the rules in the table (connect acls)
499 * - session sub-table for a listener
500 * - session sub-table for a local listener (zeroed addr)
502 * @param table_index table where the lookup should be done
503 * @param sep session endpoint to be looked up
504 * @return session handle that can be interpreted as an adjacency
507 session_lookup_local_endpoint (u32 table_index, session_endpoint_t * sep)
509 session_rules_table_t *srt;
514 st = session_table_get (table_index);
516 return SESSION_INVALID_INDEX;
517 ASSERT (st->is_local);
525 * Check if endpoint has special rules associated
527 clib_memset (&lcl4, 0, sizeof (lcl4));
528 srt = &st->session_rules[sep->transport_proto];
529 ai = session_rules_table_lookup4 (srt, &lcl4, &sep->ip.ip4, 0,
531 if (session_lookup_action_index_is_valid (ai))
532 return session_lookup_action_to_handle (ai);
535 * Check if session endpoint is a listener
537 make_v4_listener_kv (&kv4, &sep->ip.ip4, sep->port,
538 sep->transport_proto);
539 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
544 * Zero out the ip. Logic is that connect to local ips, say
545 * 127.0.0.1:port, can match 0.0.0.0:port
547 if (ip4_is_local_host (&sep->ip.ip4))
550 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
560 * Zero out the port and check if we have proxy
563 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
572 clib_memset (&lcl6, 0, sizeof (lcl6));
573 srt = &st->session_rules[sep->transport_proto];
574 ai = session_rules_table_lookup6 (srt, &lcl6, &sep->ip.ip6, 0,
576 if (session_lookup_action_index_is_valid (ai))
577 return session_lookup_action_to_handle (ai);
579 make_v6_listener_kv (&kv6, &sep->ip.ip6, sep->port,
580 sep->transport_proto);
581 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
586 * Zero out the ip. Same logic as above.
589 if (ip6_is_local_host (&sep->ip.ip6))
591 kv6.key[0] = kv6.key[1] = 0;
592 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
598 kv6.key[0] = kv6.key[1] = 0;
602 * Zero out the port. Same logic as above.
604 kv6.key[4] = kv6.key[5] = 0;
605 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
609 return SESSION_INVALID_HANDLE;
612 static inline session_t *
613 session_lookup_listener4_i (session_table_t * st, ip4_address_t * lcl,
614 u16 lcl_port, u8 proto, u8 use_wildcard)
620 * First, try a fully formed listener
622 make_v4_listener_kv (&kv4, lcl, lcl_port, proto);
623 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
625 return listen_session_get ((u32) kv4.value);
628 * Zero out the lcl ip and check if any 0/0 port binds have been done
633 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
635 return listen_session_get ((u32) kv4.value);
643 * Zero out port and check if we have a proxy set up for our ip
645 make_v4_proxy_kv (&kv4, lcl, proto);
646 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
648 return listen_session_get ((u32) kv4.value);
654 session_lookup_listener4 (u32 fib_index, ip4_address_t * lcl, u16 lcl_port,
658 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
661 return session_lookup_listener4_i (st, lcl, lcl_port, proto, 0);
665 session_lookup_listener6_i (session_table_t * st, ip6_address_t * lcl,
666 u16 lcl_port, u8 proto, u8 ip_wildcard)
671 make_v6_listener_kv (&kv6, lcl, lcl_port, proto);
672 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
674 return listen_session_get ((u32) kv6.value);
676 /* Zero out the lcl ip */
679 kv6.key[0] = kv6.key[1] = 0;
680 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
682 return listen_session_get ((u32) kv6.value);
686 kv6.key[0] = kv6.key[1] = 0;
689 make_v6_proxy_kv (&kv6, lcl, proto);
690 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
692 return listen_session_get ((u32) kv6.value);
697 session_lookup_listener6 (u32 fib_index, ip6_address_t * lcl, u16 lcl_port,
701 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
704 return session_lookup_listener6_i (st, lcl, lcl_port, proto, 1);
708 * Lookup listener, exact or proxy (inaddr_any:0) match
711 session_lookup_listener (u32 table_index, session_endpoint_t * sep)
714 st = session_table_get (table_index);
718 return session_lookup_listener4_i (st, &sep->ip.ip4, sep->port,
719 sep->transport_proto, 0);
721 return session_lookup_listener6_i (st, &sep->ip.ip6, sep->port,
722 sep->transport_proto, 0);
727 * Lookup listener wildcard match
730 session_lookup_listener_wildcard (u32 table_index, session_endpoint_t * sep)
733 st = session_table_get (table_index);
737 return session_lookup_listener4_i (st, &sep->ip.ip4, sep->port,
738 sep->transport_proto,
739 1 /* use_wildcard */ );
741 return session_lookup_listener6_i (st, &sep->ip.ip6, sep->port,
742 sep->transport_proto,
743 1 /* use_wildcard */ );
748 session_lookup_add_half_open (transport_connection_t * tc, u64 value)
754 st = session_table_get_or_alloc_for_connection (tc);
759 make_v4_ss_kv_from_tc (&kv4, tc);
761 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
766 make_v6_ss_kv_from_tc (&kv6, tc);
768 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
774 session_lookup_del_half_open (transport_connection_t * tc)
780 st = session_table_get_for_connection (tc);
785 make_v4_ss_kv_from_tc (&kv4, tc);
786 return clib_bihash_add_del_16_8 (&st->v4_half_open_hash, &kv4,
791 make_v6_ss_kv_from_tc (&kv6, tc);
792 return clib_bihash_add_del_48_8 (&st->v6_half_open_hash, &kv6,
798 session_lookup_half_open_handle (transport_connection_t * tc)
805 st = session_table_get_for_fib_index (transport_connection_fib_proto (tc),
808 return HALF_OPEN_LOOKUP_INVALID_VALUE;
811 make_v4_ss_kv (&kv4, &tc->lcl_ip.ip4, &tc->rmt_ip.ip4, tc->lcl_port,
812 tc->rmt_port, tc->proto);
813 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
819 make_v6_ss_kv (&kv6, &tc->lcl_ip.ip6, &tc->rmt_ip.ip6, tc->lcl_port,
820 tc->rmt_port, tc->proto);
821 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
825 return HALF_OPEN_LOOKUP_INVALID_VALUE;
828 transport_connection_t *
829 session_lookup_half_open_connection (u64 handle, u8 proto, u8 is_ip4)
831 if (handle != HALF_OPEN_LOOKUP_INVALID_VALUE)
833 u32 sst = session_type_from_proto_and_ip (proto, is_ip4);
834 return transport_get_half_open (sst, handle & 0xFFFFFFFF);
840 * Lookup connection with ip4 and transport layer information
842 * This is used on the fast path so it needs to be fast. Thereby,
843 * duplication of code and 'hacks' allowed.
845 * The lookup is incremental and returns whenever something is matched. The
847 * - Try to find an established session
848 * - Try to find a half-open connection
849 * - Try session rules table
850 * - Try to find a fully-formed or local source wildcarded (listener bound to
851 * all interfaces) listener session
854 * @param fib_index index of fib wherein the connection was received
855 * @param lcl local ip4 address
856 * @param rmt remote ip4 address
857 * @param lcl_port local port
858 * @param rmt_port remote port
859 * @param proto transport protocol (e.g., tcp, udp)
860 * @param thread_index thread index for request
861 * @param is_filtered return flag that indicates if connection was filtered.
863 * @return pointer to transport connection, if one is found, 0 otherwise
865 transport_connection_t *
866 session_lookup_connection_wt4 (u32 fib_index, ip4_address_t * lcl,
867 ip4_address_t * rmt, u16 lcl_port,
868 u16 rmt_port, u8 proto, u32 thread_index,
877 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
878 if (PREDICT_FALSE (!st))
882 * Lookup session amongst established ones
884 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
885 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
888 if (PREDICT_FALSE ((u32) (kv4.value >> 32) != thread_index))
890 *result = SESSION_LOOKUP_RESULT_WRONG_THREAD;
893 s = session_get (kv4.value & 0xFFFFFFFFULL, thread_index);
894 return transport_get_connection (proto, s->connection_index,
899 * Try half-open connections
901 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
903 return transport_get_half_open (proto, kv4.value & 0xFFFFFFFF);
906 * Check the session rules table
908 action_index = session_rules_table_lookup4 (&st->session_rules[proto], lcl,
909 rmt, lcl_port, rmt_port);
910 if (session_lookup_action_index_is_valid (action_index))
912 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
914 *result = SESSION_LOOKUP_RESULT_FILTERED;
917 if ((s = session_lookup_action_to_session (action_index,
918 FIB_PROTOCOL_IP4, proto)))
919 return transport_get_listener (proto, s->connection_index);
924 * If nothing is found, check if any listener is available
926 s = session_lookup_listener4_i (st, lcl, lcl_port, proto, 1);
928 return transport_get_listener (proto, s->connection_index);
934 * Lookup connection with ip4 and transport layer information
936 * Not optimized. Lookup logic is identical to that of
937 * @ref session_lookup_connection_wt4
939 * @param fib_index index of the fib wherein the connection was received
940 * @param lcl local ip4 address
941 * @param rmt remote ip4 address
942 * @param lcl_port local port
943 * @param rmt_port remote port
944 * @param proto transport protocol (e.g., tcp, udp)
946 * @return pointer to transport connection, if one is found, 0 otherwise
948 transport_connection_t *
949 session_lookup_connection4 (u32 fib_index, ip4_address_t * lcl,
950 ip4_address_t * rmt, u16 lcl_port, u16 rmt_port,
959 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
960 if (PREDICT_FALSE (!st))
964 * Lookup session amongst established ones
966 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
967 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
970 s = session_get_from_handle (kv4.value);
971 return transport_get_connection (proto, s->connection_index,
976 * Try half-open connections
978 rv = clib_bihash_search_inline_16_8 (&st->v4_half_open_hash, &kv4);
980 return transport_get_half_open (proto, kv4.value & 0xFFFFFFFF);
983 * Check the session rules table
985 action_index = session_rules_table_lookup4 (&st->session_rules[proto], lcl,
986 rmt, lcl_port, rmt_port);
987 if (session_lookup_action_index_is_valid (action_index))
989 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
991 if ((s = session_lookup_action_to_session (action_index,
992 FIB_PROTOCOL_IP4, proto)))
993 return transport_get_listener (proto, s->connection_index);
998 * If nothing is found, check if any listener is available
1000 s = session_lookup_listener4_i (st, lcl, lcl_port, proto, 1);
1002 return transport_get_listener (proto, s->connection_index);
1008 * Lookup session with ip4 and transport layer information
1010 * Important note: this may look into another thread's pool table and
1011 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
1012 * if needed as soon as possible.
1014 * Lookup logic is similar to that of @ref session_lookup_connection_wt4 but
1015 * this returns a session as opposed to a transport connection and it does not
1016 * try to lookup half-open sessions.
1018 * Typically used by dgram connections
1021 session_lookup_safe4 (u32 fib_index, ip4_address_t * lcl, ip4_address_t * rmt,
1022 u16 lcl_port, u16 rmt_port, u8 proto)
1024 session_table_t *st;
1030 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP4, fib_index);
1031 if (PREDICT_FALSE (!st))
1035 * Lookup session amongst established ones
1037 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
1038 rv = clib_bihash_search_inline_16_8 (&st->v4_session_hash, &kv4);
1040 return session_get_from_handle_safe (kv4.value);
1043 * Check the session rules table
1045 action_index = session_rules_table_lookup4 (&st->session_rules[proto], lcl,
1046 rmt, lcl_port, rmt_port);
1047 if (session_lookup_action_index_is_valid (action_index))
1049 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
1051 return session_lookup_action_to_session (action_index, FIB_PROTOCOL_IP4,
1056 * If nothing is found, check if any listener is available
1058 if ((s = session_lookup_listener4_i (st, lcl, lcl_port, proto, 1)))
1065 * Lookup connection with ip6 and transport layer information
1067 * This is used on the fast path so it needs to be fast. Thereby,
1068 * duplication of code and 'hacks' allowed.
1070 * The lookup is incremental and returns whenever something is matched. The
1072 * - Try to find an established session
1073 * - Try to find a half-open connection
1074 * - Try session rules table
1075 * - Try to find a fully-formed or local source wildcarded (listener bound to
1076 * all interfaces) listener session
1079 * @param fib_index index of the fib wherein the connection was received
1080 * @param lcl local ip6 address
1081 * @param rmt remote ip6 address
1082 * @param lcl_port local port
1083 * @param rmt_port remote port
1084 * @param proto transport protocol (e.g., tcp, udp)
1085 * @param thread_index thread index for request
1087 * @return pointer to transport connection, if one is found, 0 otherwise
1089 transport_connection_t *
1090 session_lookup_connection_wt6 (u32 fib_index, ip6_address_t * lcl,
1091 ip6_address_t * rmt, u16 lcl_port,
1092 u16 rmt_port, u8 proto, u32 thread_index,
1095 session_table_t *st;
1101 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1102 if (PREDICT_FALSE (!st))
1105 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1106 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1109 ASSERT ((u32) (kv6.value >> 32) == thread_index);
1110 if (PREDICT_FALSE ((u32) (kv6.value >> 32) != thread_index))
1112 *result = SESSION_LOOKUP_RESULT_WRONG_THREAD;
1115 s = session_get (kv6.value & 0xFFFFFFFFULL, thread_index);
1116 return transport_get_connection (proto, s->connection_index,
1120 /* Try half-open connections */
1121 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
1123 return transport_get_half_open (proto, kv6.value & 0xFFFFFFFF);
1125 /* Check the session rules table */
1126 action_index = session_rules_table_lookup6 (&st->session_rules[proto], lcl,
1127 rmt, lcl_port, rmt_port);
1128 if (session_lookup_action_index_is_valid (action_index))
1130 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
1132 *result = SESSION_LOOKUP_RESULT_FILTERED;
1135 if ((s = session_lookup_action_to_session (action_index,
1136 FIB_PROTOCOL_IP6, proto)))
1137 return transport_get_listener (proto, s->connection_index);
1141 /* If nothing is found, check if any listener is available */
1142 s = session_lookup_listener6_i (st, lcl, lcl_port, proto, 1);
1144 return transport_get_listener (proto, s->connection_index);
1150 * Lookup connection with ip6 and transport layer information
1152 * Not optimized. This is used on the fast path so it needs to be fast.
1153 * Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical
1154 * to that of @ref session_lookup_connection_wt4
1156 * @param fib_index index of the fib wherein the connection was received
1157 * @param lcl local ip6 address
1158 * @param rmt remote ip6 address
1159 * @param lcl_port local port
1160 * @param rmt_port remote port
1161 * @param proto transport protocol (e.g., tcp, udp)
1163 * @return pointer to transport connection, if one is found, 0 otherwise
1165 transport_connection_t *
1166 session_lookup_connection6 (u32 fib_index, ip6_address_t * lcl,
1167 ip6_address_t * rmt, u16 lcl_port, u16 rmt_port,
1170 session_table_t *st;
1176 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1177 if (PREDICT_FALSE (!st))
1180 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1181 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1184 s = session_get_from_handle (kv6.value);
1185 return transport_get_connection (proto, s->connection_index,
1189 /* Try half-open connections */
1190 rv = clib_bihash_search_inline_48_8 (&st->v6_half_open_hash, &kv6);
1192 return transport_get_half_open (proto, kv6.value & 0xFFFFFFFF);
1194 /* Check the session rules table */
1195 action_index = session_rules_table_lookup6 (&st->session_rules[proto], lcl,
1196 rmt, lcl_port, rmt_port);
1197 if (session_lookup_action_index_is_valid (action_index))
1199 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
1201 if ((s = session_lookup_action_to_session (action_index,
1202 FIB_PROTOCOL_IP6, proto)))
1203 return transport_get_listener (proto, s->connection_index);
1207 /* If nothing is found, check if any listener is available */
1208 s = session_lookup_listener6_i (st, lcl, lcl_port, proto, 1);
1210 return transport_get_listener (proto, s->connection_index);
1216 * Lookup session with ip6 and transport layer information
1218 * Important note: this may look into another thread's pool table and
1219 * register as 'peeker'. Caller should call @ref session_pool_remove_peeker as
1220 * if needed as soon as possible.
1222 * Lookup logic is similar to that of @ref session_lookup_connection_wt6 but
1223 * this returns a session as opposed to a transport connection and it does not
1224 * try to lookup half-open sessions.
1226 * Typically used by dgram connections
1229 session_lookup_safe6 (u32 fib_index, ip6_address_t * lcl, ip6_address_t * rmt,
1230 u16 lcl_port, u16 rmt_port, u8 proto)
1232 session_table_t *st;
1238 st = session_table_get_for_fib_index (FIB_PROTOCOL_IP6, fib_index);
1239 if (PREDICT_FALSE (!st))
1242 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
1243 rv = clib_bihash_search_inline_48_8 (&st->v6_session_hash, &kv6);
1245 return session_get_from_handle_safe (kv6.value);
1247 /* Check the session rules table */
1248 action_index = session_rules_table_lookup6 (&st->session_rules[proto], lcl,
1249 rmt, lcl_port, rmt_port);
1250 if (session_lookup_action_index_is_valid (action_index))
1252 if (action_index == SESSION_RULES_TABLE_ACTION_DROP)
1254 return session_lookup_action_to_session (action_index, FIB_PROTOCOL_IP6,
1258 /* If nothing is found, check if any listener is available */
1259 if ((s = session_lookup_listener6_i (st, lcl, lcl_port, proto, 1)))
1265 vnet_session_rule_add_del (session_rule_add_del_args_t * args)
1267 app_namespace_t *app_ns = app_namespace_get (args->appns_index);
1268 session_rules_table_t *srt;
1269 session_table_t *st;
1275 return VNET_API_ERROR_APP_INVALID_NS;
1277 if (args->scope > 3)
1278 return VNET_API_ERROR_INVALID_VALUE;
1280 if (args->transport_proto != TRANSPORT_PROTO_TCP
1281 && args->transport_proto != TRANSPORT_PROTO_UDP)
1282 return VNET_API_ERROR_INVALID_VALUE;
1284 if ((args->scope & SESSION_RULE_SCOPE_GLOBAL) || args->scope == 0)
1286 fib_proto = args->table_args.rmt.fp_proto;
1287 fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1288 st = session_table_get_for_fib_index (fib_proto, fib_index);
1289 srt = &st->session_rules[args->transport_proto];
1290 if ((rv = session_rules_table_add_del (srt, &args->table_args)))
1293 if (args->scope & SESSION_RULE_SCOPE_LOCAL)
1295 clib_memset (&args->table_args.lcl, 0, sizeof (args->table_args.lcl));
1296 args->table_args.lcl.fp_proto = args->table_args.rmt.fp_proto;
1297 args->table_args.lcl_port = 0;
1298 st = app_namespace_get_local_table (app_ns);
1299 srt = &st->session_rules[args->transport_proto];
1300 rv = session_rules_table_add_del (srt, &args->table_args);
1306 * Mark (global) tables as pertaining to app ns
1309 session_lookup_set_tables_appns (app_namespace_t * app_ns)
1311 session_table_t *st;
1315 for (fp = 0; fp < ARRAY_LEN (fib_index_to_table_index); fp++)
1317 fib_index = app_namespace_get_fib_index (app_ns, fp);
1318 st = session_table_get_for_fib_index (fp, fib_index);
1320 st->appns_index = app_namespace_index (app_ns);
1325 format_ip4_session_lookup_kvp (u8 * s, va_list * args)
1327 clib_bihash_kv_16_8_t *kvp = va_arg (*args, clib_bihash_kv_16_8_t *);
1328 u32 is_local = va_arg (*args, u32);
1329 v4_connection_key_t *key = (v4_connection_key_t *) kvp->key;
1331 app_worker_t *app_wrk;
1337 session = session_get_from_handle (kvp->value);
1338 app_wrk = app_worker_get (session->app_wrk_index);
1339 app_name = application_name_from_index (app_wrk->app_index);
1340 str = format (0, "[%U] %U:%d->%U:%d", format_transport_proto_short,
1341 key->proto, format_ip4_address, &key->src,
1342 clib_net_to_host_u16 (key->src_port), format_ip4_address,
1343 &key->dst, clib_net_to_host_u16 (key->dst_port));
1344 s = format (s, "%-40v%-30v", str, app_name);
1348 session = session_get_from_handle (kvp->value);
1349 app_wrk = app_worker_get (session->app_wrk_index);
1350 app_name = application_name_from_index (app_wrk->app_index);
1351 str = format (0, "[%U] %U:%d", format_transport_proto_short, key->proto,
1352 format_ip4_address, &key->src,
1353 clib_net_to_host_u16 (key->src_port));
1354 s = format (s, "%-30v%-30v", str, app_name);
1359 typedef struct _ip4_session_table_show_ctx_t
1363 } ip4_session_table_show_ctx_t;
1366 ip4_session_table_show (clib_bihash_kv_16_8_t * kvp, void *arg)
1368 ip4_session_table_show_ctx_t *ctx = arg;
1369 vlib_cli_output (ctx->vm, "%U", format_ip4_session_lookup_kvp, kvp,
1375 session_lookup_show_table_entries (vlib_main_t * vm, session_table_t * table,
1376 u8 type, u8 is_local)
1378 ip4_session_table_show_ctx_t ctx = {
1380 .is_local = is_local,
1383 vlib_cli_output (vm, "%-40s%-30s", "Session", "Application");
1385 vlib_cli_output (vm, "%-30s%-30s", "Listener", "Application");
1390 ip4_session_table_walk (&table->v4_session_hash, ip4_session_table_show,
1394 clib_warning ("not supported");
1398 static clib_error_t *
1399 session_rule_command_fn (vlib_main_t * vm, unformat_input_t * input,
1400 vlib_cli_command_t * cmd)
1402 u32 proto = ~0, lcl_port, rmt_port, action = 0, lcl_plen = 0, rmt_plen = 0;
1403 u32 appns_index, scope = 0;
1404 ip46_address_t lcl_ip, rmt_ip;
1405 u8 is_ip4 = 1, conn_set = 0;
1406 u8 fib_proto, is_add = 1, *ns_id = 0;
1408 app_namespace_t *app_ns;
1411 clib_memset (&lcl_ip, 0, sizeof (lcl_ip));
1412 clib_memset (&rmt_ip, 0, sizeof (rmt_ip));
1413 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1415 if (unformat (input, "del"))
1417 else if (unformat (input, "add"))
1419 else if (unformat (input, "appns %_%v%_", &ns_id))
1421 else if (unformat (input, "scope global"))
1422 scope = SESSION_RULE_SCOPE_GLOBAL;
1423 else if (unformat (input, "scope local"))
1424 scope = SESSION_RULE_SCOPE_LOCAL;
1425 else if (unformat (input, "scope all"))
1426 scope = SESSION_RULE_SCOPE_LOCAL | SESSION_RULE_SCOPE_GLOBAL;
1427 else if (unformat (input, "proto %U", unformat_transport_proto, &proto))
1429 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1430 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1431 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1437 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1438 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1439 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1445 else if (unformat (input, "action %d", &action))
1447 else if (unformat (input, "tag %_%v%_", &tag))
1450 return clib_error_return (0, "unknown input `%U'",
1451 format_unformat_error, input);
1456 vlib_cli_output (vm, "proto must be set");
1459 if (is_add && !conn_set && action == ~0)
1461 vlib_cli_output (vm, "connection and action must be set for add");
1464 if (!is_add && !tag && !conn_set)
1466 vlib_cli_output (vm, "connection or tag must be set for delete");
1469 if (vec_len (tag) > SESSION_RULE_TAG_MAX_LEN)
1471 vlib_cli_output (vm, "tag too long (max u64)");
1477 app_ns = app_namespace_get_from_id (ns_id);
1480 vlib_cli_output (vm, "namespace %v does not exist", ns_id);
1486 app_ns = app_namespace_get_default ();
1488 appns_index = app_namespace_index (app_ns);
1490 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1491 session_rule_add_del_args_t args = {
1492 .transport_proto = proto,
1493 .table_args.lcl.fp_addr = lcl_ip,
1494 .table_args.lcl.fp_len = lcl_plen,
1495 .table_args.lcl.fp_proto = fib_proto,
1496 .table_args.rmt.fp_addr = rmt_ip,
1497 .table_args.rmt.fp_len = rmt_plen,
1498 .table_args.rmt.fp_proto = fib_proto,
1499 .table_args.lcl_port = lcl_port,
1500 .table_args.rmt_port = rmt_port,
1501 .table_args.action_index = action,
1502 .table_args.is_add = is_add,
1503 .table_args.tag = tag,
1504 .appns_index = appns_index,
1507 if ((rv = vnet_session_rule_add_del (&args)))
1508 return clib_error_return (0, "rule add del returned %u", rv);
1515 VLIB_CLI_COMMAND (session_rule_command, static) =
1517 .path = "session rule",
1518 .short_help = "session rule [add|del] appns <ns_id> proto <proto> "
1519 "<lcl-ip/plen> <lcl-port> <rmt-ip/plen> <rmt-port> action <action>",
1520 .function = session_rule_command_fn,
1525 session_lookup_dump_rules_table (u32 fib_index, u8 fib_proto,
1528 vlib_main_t *vm = vlib_get_main ();
1529 session_rules_table_t *srt;
1530 session_table_t *st;
1531 st = session_table_get_for_fib_index (fib_index, fib_proto);
1532 srt = &st->session_rules[transport_proto];
1533 session_rules_table_cli_dump (vm, srt, fib_proto);
1537 session_lookup_dump_local_rules_table (u32 table_index, u8 fib_proto,
1540 vlib_main_t *vm = vlib_get_main ();
1541 session_rules_table_t *srt;
1542 session_table_t *st;
1543 st = session_table_get (table_index);
1544 srt = &st->session_rules[transport_proto];
1545 session_rules_table_cli_dump (vm, srt, fib_proto);
1548 static clib_error_t *
1549 show_session_rules_command_fn (vlib_main_t * vm, unformat_input_t * input,
1550 vlib_cli_command_t * cmd)
1552 u32 transport_proto = ~0, lcl_port, rmt_port, lcl_plen, rmt_plen;
1553 u32 fib_index, scope = 0;
1554 ip46_address_t lcl_ip, rmt_ip;
1555 u8 is_ip4 = 1, show_one = 0;
1556 app_namespace_t *app_ns;
1557 session_rules_table_t *srt;
1558 session_table_t *st;
1559 u8 *ns_id = 0, fib_proto;
1561 clib_memset (&lcl_ip, 0, sizeof (lcl_ip));
1562 clib_memset (&rmt_ip, 0, sizeof (rmt_ip));
1563 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1565 if (unformat (input, "%U", unformat_transport_proto, &transport_proto))
1567 else if (unformat (input, "appns %_%v%_", &ns_id))
1569 else if (unformat (input, "scope global"))
1571 else if (unformat (input, "scope local"))
1573 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip4_address,
1574 &lcl_ip.ip4, &lcl_plen, &lcl_port,
1575 unformat_ip4_address, &rmt_ip.ip4, &rmt_plen,
1581 else if (unformat (input, "%U/%d %d %U/%d %d", unformat_ip6_address,
1582 &lcl_ip.ip6, &lcl_plen, &lcl_port,
1583 unformat_ip6_address, &rmt_ip.ip6, &rmt_plen,
1590 return clib_error_return (0, "unknown input `%U'",
1591 format_unformat_error, input);
1594 if (transport_proto == ~0)
1596 vlib_cli_output (vm, "transport proto must be set");
1602 app_ns = app_namespace_get_from_id (ns_id);
1605 vlib_cli_output (vm, "appns %v doesn't exist", ns_id);
1611 app_ns = app_namespace_get_default ();
1614 if (scope == 1 || scope == 0)
1616 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1617 fib_index = is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1618 st = session_table_get_for_fib_index (fib_proto, fib_index);
1622 st = app_namespace_get_local_table (app_ns);
1627 srt = &st->session_rules[transport_proto];
1628 session_rules_table_show_rule (vm, srt, &lcl_ip, lcl_port, &rmt_ip,
1633 vlib_cli_output (vm, "%U rules table", format_transport_proto,
1635 srt = &st->session_rules[transport_proto];
1636 session_rules_table_cli_dump (vm, srt, FIB_PROTOCOL_IP4);
1637 session_rules_table_cli_dump (vm, srt, FIB_PROTOCOL_IP6);
1644 VLIB_CLI_COMMAND (show_session_rules_command, static) =
1646 .path = "show session rules",
1647 .short_help = "show session rules [<proto> appns <id> <lcl-ip/plen> "
1648 "<lcl-port> <rmt-ip/plen> <rmt-port> scope <scope>]",
1649 .function = show_session_rules_command_fn,
1654 session_lookup_init (void)
1657 * Allocate default table and map it to fib_index 0
1659 session_table_t *st = session_table_alloc ();
1660 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP4], 0);
1661 fib_index_to_table_index[FIB_PROTOCOL_IP4][0] = session_table_index (st);
1662 st->active_fib_proto = FIB_PROTOCOL_IP4;
1663 session_table_init (st, FIB_PROTOCOL_IP4);
1664 st = session_table_alloc ();
1665 vec_validate (fib_index_to_table_index[FIB_PROTOCOL_IP6], 0);
1666 fib_index_to_table_index[FIB_PROTOCOL_IP6][0] = session_table_index (st);
1667 st->active_fib_proto = FIB_PROTOCOL_IP6;
1668 session_table_init (st, FIB_PROTOCOL_IP6);
1672 * fd.io coding-style-patch-verification: ON
1675 * eval: (c-set-style "gnu")