Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2015 Cisco and/or its affiliates. |
| 3 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | * you may not use this file except in compliance with the License. |
| 5 | * You may obtain a copy of the License at: |
| 6 | * |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * |
| 9 | * Unless required by applicable law or agreed to in writing, software |
| 10 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | * See the License for the specific language governing permissions and |
| 13 | * limitations under the License. |
| 14 | */ |
| 15 | /* |
| 16 | * ip/ip_lookup.h: ip (4 or 6) lookup structures, adjacencies, ... |
| 17 | * |
| 18 | * Copyright (c) 2008 Eliot Dresselhaus |
| 19 | * |
| 20 | * Permission is hereby granted, free of charge, to any person obtaining |
| 21 | * a copy of this software and associated documentation files (the |
| 22 | * "Software"), to deal in the Software without restriction, including |
| 23 | * without limitation the rights to use, copy, modify, merge, publish, |
| 24 | * distribute, sublicense, and/or sell copies of the Software, and to |
| 25 | * permit persons to whom the Software is furnished to do so, subject to |
| 26 | * the following conditions: |
| 27 | * |
| 28 | * The above copyright notice and this permission notice shall be |
| 29 | * included in all copies or substantial portions of the Software. |
| 30 | * |
| 31 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
| 32 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 33 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| 34 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
| 35 | * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
| 36 | * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
| 37 | * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 38 | */ |
| 39 | |
Chris Luke | 16bcf7d | 2016-09-01 14:31:46 -0400 | [diff] [blame] | 40 | /** |
| 41 | * @file |
| 42 | * Definitions for all things IP (v4|v6) unicast and multicast lookup related. |
| 43 | * |
| 44 | * - Adjacency definitions and registration. |
| 45 | * - Callbacks on route add. |
| 46 | * - Callbacks on interface address change. |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 47 | */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 48 | #ifndef included_ip_lookup_h |
| 49 | #define included_ip_lookup_h |
| 50 | |
| 51 | #include <vnet/vnet.h> |
| 52 | #include <vlib/buffer.h> |
Damjan Marion | 102ec52 | 2016-03-29 13:18:17 +0200 | [diff] [blame] | 53 | #include <vnet/ip/ip4_packet.h> |
Pierre Pfister | 1dabaaf | 2016-04-25 14:15:15 +0100 | [diff] [blame] | 54 | #include <vnet/ip/ip6_packet.h> |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 55 | #include <vnet/fib/fib_node.h> |
Neale Ranns | fa5d198 | 2017-02-20 14:19:51 -0800 | [diff] [blame] | 56 | #include <vnet/adj/adj.h> |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 57 | #include <vnet/dpo/dpo.h> |
Damjan Marion | 2231150 | 2016-10-28 20:30:15 +0200 | [diff] [blame] | 58 | #include <vnet/feature/feature.h> |
Damjan Marion | b270789 | 2016-04-13 11:21:07 +0200 | [diff] [blame] | 59 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 60 | /** Flow hash configuration */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 61 | #define IP_FLOW_HASH_SRC_ADDR (1<<0) |
| 62 | #define IP_FLOW_HASH_DST_ADDR (1<<1) |
| 63 | #define IP_FLOW_HASH_PROTO (1<<2) |
| 64 | #define IP_FLOW_HASH_SRC_PORT (1<<3) |
| 65 | #define IP_FLOW_HASH_DST_PORT (1<<4) |
| 66 | #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5) |
| 67 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 68 | /** Default: 5-tuple without the "reverse" bit */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 69 | #define IP_FLOW_HASH_DEFAULT (0x1F) |
| 70 | |
| 71 | #define foreach_flow_hash_bit \ |
| 72 | _(src, IP_FLOW_HASH_SRC_ADDR) \ |
| 73 | _(dst, IP_FLOW_HASH_DST_ADDR) \ |
| 74 | _(sport, IP_FLOW_HASH_SRC_PORT) \ |
| 75 | _(dport, IP_FLOW_HASH_DST_PORT) \ |
| 76 | _(proto, IP_FLOW_HASH_PROTO) \ |
| 77 | _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST) |
| 78 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 79 | /** |
| 80 | * A flow hash configuration is a mask of the flow hash options |
| 81 | */ |
| 82 | typedef u32 flow_hash_config_t; |
| 83 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 84 | /* An all zeros address */ |
| 85 | extern const ip46_address_t zero_addr; |
Dave Barach | dbf19ca | 2016-03-15 10:21:54 +0100 | [diff] [blame] | 86 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 87 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 88 | typedef struct |
| 89 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 90 | /* Key for mhash; in fact, just a byte offset into mhash key vector. */ |
| 91 | u32 address_key; |
| 92 | |
| 93 | /* Interface which has this address. */ |
| 94 | u32 sw_if_index; |
| 95 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 96 | /* Address (prefix) length for this interface. */ |
| 97 | u16 address_length; |
| 98 | |
| 99 | /* Will be used for something eventually. Primary vs. secondary? */ |
| 100 | u16 flags; |
| 101 | |
| 102 | /* Next and previous pointers for doubly linked list of |
| 103 | addresses per software interface. */ |
| 104 | u32 next_this_sw_interface; |
| 105 | u32 prev_this_sw_interface; |
| 106 | } ip_interface_address_t; |
| 107 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 108 | typedef enum |
| 109 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 110 | IP_LOCAL_NEXT_DROP, |
| 111 | IP_LOCAL_NEXT_PUNT, |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 112 | IP_LOCAL_NEXT_UDP_LOOKUP, |
| 113 | IP_LOCAL_NEXT_ICMP, |
| 114 | IP_LOCAL_N_NEXT, |
| 115 | } ip_local_next_t; |
| 116 | |
| 117 | struct ip_lookup_main_t; |
| 118 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 119 | typedef struct ip_lookup_main_t |
| 120 | { |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 121 | /** Pool of addresses that are assigned to interfaces. */ |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 122 | ip_interface_address_t *if_address_pool; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 123 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 124 | /** Hash table mapping address to index in interface address pool. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 125 | mhash_t address_to_if_address_index; |
| 126 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 127 | /** Head of doubly linked list of interface addresses for each software interface. |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 128 | ~0 means this interface has no address. */ |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 129 | u32 *if_address_pool_index_by_sw_if_index; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 130 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 131 | /** First table index to use for this interface, ~0 => none */ |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 132 | u32 *classify_table_index_by_sw_if_index; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 133 | |
Damjan Marion | 8b3191e | 2016-11-09 19:54:20 +0100 | [diff] [blame] | 134 | /** Feature arc indices */ |
| 135 | u8 mcast_feature_arc_index; |
| 136 | u8 ucast_feature_arc_index; |
| 137 | u8 output_feature_arc_index; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 138 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 139 | /** Number of bytes in a fib result. Must be at least |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 140 | sizeof (uword). First word is always adjacency index. */ |
| 141 | u32 fib_result_n_bytes, fib_result_n_words; |
| 142 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 143 | /** 1 for ip6; 0 for ip4. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 144 | u32 is_ip6; |
| 145 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 146 | /** Either format_ip4_address_and_length or format_ip6_address_and_length. */ |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 147 | format_function_t *format_address_and_length; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 148 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 149 | /** Table mapping ip protocol to ip[46]-local node next index. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 150 | u8 local_next_by_ip_protocol[256]; |
| 151 | |
Keith Burns (alagalah) | 79b5f63 | 2016-08-02 05:40:20 -0700 | [diff] [blame] | 152 | /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 153 | u8 builtin_protocol_by_ip_protocol[256]; |
| 154 | } ip_lookup_main_t; |
| 155 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 156 | clib_error_t *ip_interface_address_add_del (ip_lookup_main_t * lm, |
| 157 | u32 sw_if_index, |
| 158 | void *address, |
| 159 | u32 address_length, |
| 160 | u32 is_del, u32 * result_index); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 161 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 162 | u8 *format_ip_flow_hash_config (u8 * s, va_list * args); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 163 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 164 | always_inline ip_interface_address_t * |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 165 | ip_get_interface_address (ip_lookup_main_t * lm, void *addr_fib) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 166 | { |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 167 | uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 168 | return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0; |
| 169 | } |
| 170 | |
| 171 | always_inline void * |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 172 | ip_interface_address_get_address (ip_lookup_main_t * lm, |
| 173 | ip_interface_address_t * a) |
| 174 | { |
| 175 | return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key); |
| 176 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 177 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 178 | /* *INDENT-OFF* */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 179 | #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body) \ |
| 180 | do { \ |
Neale Ranns | d5b6aa1 | 2017-05-16 08:46:45 -0700 | [diff] [blame] | 181 | vnet_main_t *_vnm = vnet_get_main(); \ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 182 | u32 _sw_if_index = sw_if_index; \ |
| 183 | vnet_sw_interface_t *_swif; \ |
| 184 | _swif = vnet_get_sw_interface (_vnm, _sw_if_index); \ |
| 185 | \ |
| 186 | /* \ |
| 187 | * Loop => honor unnumbered interface addressing. \ |
| 188 | */ \ |
Neale Ranns | d5b6aa1 | 2017-05-16 08:46:45 -0700 | [diff] [blame] | 189 | if (_swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED) \ |
| 190 | { \ |
| 191 | if (loop) \ |
| 192 | _sw_if_index = _swif->unnumbered_sw_if_index; \ |
| 193 | else \ |
| 194 | /* the interface is unnumbered, by the caller does not want \ |
| 195 | * unnumbered interfaces considered/honoured */ \ |
| 196 | break; \ |
| 197 | } \ |
| 198 | u32 _ia = ((vec_len((lm)->if_address_pool_index_by_sw_if_index) \ |
| 199 | > (_sw_if_index)) ? \ |
| 200 | vec_elt ((lm)->if_address_pool_index_by_sw_if_index, \ |
| 201 | (_sw_if_index)) : \ |
| 202 | (u32)~0); \ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 203 | ip_interface_address_t * _a; \ |
| 204 | while (_ia != ~0) \ |
| 205 | { \ |
| 206 | _a = pool_elt_at_index ((lm)->if_address_pool, _ia); \ |
| 207 | _ia = _a->next_this_sw_interface; \ |
| 208 | (a) = _a; \ |
| 209 | body; \ |
| 210 | } \ |
| 211 | } while (0) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 212 | /* *INDENT-ON* */ |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 213 | |
Florin Coras | 3a0325f | 2018-06-01 12:22:23 -0700 | [diff] [blame] | 214 | always_inline void |
| 215 | ip_lookup_set_buffer_fib_index (u32 * fib_index_by_sw_if_index, |
| 216 | vlib_buffer_t * b) |
| 217 | { |
Neale Ranns | 9b2f51a | 2018-09-11 05:55:50 -0700 | [diff] [blame^] | 218 | /* *INDENT-OFF* */ |
Florin Coras | 3a0325f | 2018-06-01 12:22:23 -0700 | [diff] [blame] | 219 | vnet_buffer (b)->ip.fib_index = |
| 220 | vec_elt (fib_index_by_sw_if_index, vnet_buffer (b)->sw_if_index[VLIB_RX]); |
| 221 | vnet_buffer (b)->ip.fib_index = |
Neale Ranns | 9b2f51a | 2018-09-11 05:55:50 -0700 | [diff] [blame^] | 222 | ((vnet_buffer (b)->sw_if_index[VLIB_TX] == (u32) ~ 0) ? |
| 223 | vnet_buffer (b)->ip.fib_index : |
| 224 | vnet_buffer (b)->sw_if_index[VLIB_TX]); |
| 225 | /* *INDENT-ON* */ |
Florin Coras | 3a0325f | 2018-06-01 12:22:23 -0700 | [diff] [blame] | 226 | } |
| 227 | |
Florin Coras | 595992c | 2017-11-06 17:17:08 -0800 | [diff] [blame] | 228 | typedef struct _vnet_ip_container_proxy_args |
| 229 | { |
| 230 | fib_prefix_t prefix; |
| 231 | u32 sw_if_index; |
| 232 | u8 is_add; |
| 233 | } vnet_ip_container_proxy_args_t; |
| 234 | |
| 235 | clib_error_t *vnet_ip_container_proxy_add_del (vnet_ip_container_proxy_args_t |
| 236 | * args); |
| 237 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 238 | void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index); |
| 239 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 240 | #endif /* included_ip_lookup_h */ |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 241 | /* |
| 242 | * fd.io coding-style-patch-verification: ON |
| 243 | * |
| 244 | * Local Variables: |
| 245 | * eval: (c-set-style "gnu") |
| 246 | * End: |
| 247 | */ |