9c88b85c285056df1ab0f84c77197fded45c9f9b
[vpp.git] / vnet / vnet / ip / lookup.h
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
40 #ifndef included_ip_lookup_h
41 #define included_ip_lookup_h
42
43 #include <vnet/vnet.h>
44 #include <vlib/buffer.h>
45 #include <vnet/ip/ip4_packet.h>
46 #include <vnet/ip/ip6_packet.h>
47
48 /* Next index stored in adjacency. */
49 typedef enum {
50   /* Packet does not match any route in table. */
51   IP_LOOKUP_NEXT_MISS,
52
53   /* Adjacency says to drop or punt this packet. */
54   IP_LOOKUP_NEXT_DROP,
55   IP_LOOKUP_NEXT_PUNT,
56
57   /* This packet is for one of our own IP addresses. */
58   IP_LOOKUP_NEXT_LOCAL,
59
60   /* This packet matches an "interface route" and packets
61      need to be passed to ARP to find rewrite string for
62      this destination. */
63   IP_LOOKUP_NEXT_ARP,
64
65   /* This packet is to be rewritten and forwarded to the next
66      processing node.  This is typically the output interface but
67      might be another node for further output processing. */
68   IP_LOOKUP_NEXT_REWRITE,
69
70   /* This packet needs to be classified */
71   IP_LOOKUP_NEXT_CLASSIFY,
72
73   /* This packet needs to go to MAP - RFC7596, RFC7597 */
74   IP_LOOKUP_NEXT_MAP,
75
76   /* This packet needs to go to MAP with Translation - RFC7599 */
77   IP_LOOKUP_NEXT_MAP_T,
78
79   /* This packets needs to go to 6RD (RFC5969) */
80   IP_LOOKUP_NEXT_SIXRD,
81
82   /* This packets needs to go to indirect next hop */
83   IP_LOOKUP_NEXT_INDIRECT,
84
85   /* Hop-by-hop header handling */
86   IP_LOOKUP_NEXT_HOP_BY_HOP,
87   IP_LOOKUP_NEXT_ADD_HOP_BY_HOP,
88   IP_LOOKUP_NEXT_POP_HOP_BY_HOP,
89
90   IP_LOOKUP_N_NEXT,
91 } ip_lookup_next_t;
92
93 #define IP4_LOOKUP_NEXT_NODES {                                 \
94     [IP_LOOKUP_NEXT_MISS] = "ip4-miss",                         \
95     [IP_LOOKUP_NEXT_DROP] = "ip4-drop",                         \
96     [IP_LOOKUP_NEXT_PUNT] = "ip4-punt",                         \
97     [IP_LOOKUP_NEXT_LOCAL] = "ip4-local",                       \
98     [IP_LOOKUP_NEXT_ARP] = "ip4-arp",                           \
99     [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite-transit",           \
100     [IP_LOOKUP_NEXT_CLASSIFY] = "ip4-classify",                 \
101     [IP_LOOKUP_NEXT_MAP] = "ip4-map",                           \
102     [IP_LOOKUP_NEXT_MAP_T] = "ip4-map-t",                       \
103     [IP_LOOKUP_NEXT_SIXRD] = "ip4-sixrd",                       \
104     [IP_LOOKUP_NEXT_HOP_BY_HOP] = "ip4-hop-by-hop",             \
105     [IP_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip4-add-hop-by-hop",     \
106     [IP_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip4-pop-hop-by-hop",     \
107     [IP_LOOKUP_NEXT_INDIRECT] = "ip4-indirect",                 \
108 }
109
110 #define IP6_LOOKUP_NEXT_NODES {                                 \
111     [IP_LOOKUP_NEXT_MISS] = "ip6-miss",                         \
112     [IP_LOOKUP_NEXT_DROP] = "ip6-drop",                         \
113     [IP_LOOKUP_NEXT_PUNT] = "ip6-punt",                         \
114     [IP_LOOKUP_NEXT_LOCAL] = "ip6-local",                       \
115     [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor",             \
116     [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite",                   \
117     [IP_LOOKUP_NEXT_CLASSIFY] = "ip6-classify",                 \
118     [IP_LOOKUP_NEXT_MAP] = "ip6-map",                           \
119     [IP_LOOKUP_NEXT_MAP_T] = "ip6-map-t",                       \
120     [IP_LOOKUP_NEXT_SIXRD] = "ip6-sixrd",                       \
121     [IP_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop",             \
122     [IP_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop",     \
123     [IP_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop",     \
124     [IP_LOOKUP_NEXT_INDIRECT] = "ip6-indirect",                 \
125 }
126
127 /* Flow hash configuration */
128 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
129 #define IP_FLOW_HASH_DST_ADDR (1<<1)
130 #define IP_FLOW_HASH_PROTO (1<<2)
131 #define IP_FLOW_HASH_SRC_PORT (1<<3)
132 #define IP_FLOW_HASH_DST_PORT (1<<4)
133 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
134
135 /* Default: 5-tuple without the "reverse" bit */
136 #define IP_FLOW_HASH_DEFAULT (0x1F)
137
138 #define foreach_flow_hash_bit                   \
139 _(src, IP_FLOW_HASH_SRC_ADDR)                   \
140 _(dst, IP_FLOW_HASH_DST_ADDR)                   \
141 _(sport, IP_FLOW_HASH_SRC_PORT)                 \
142 _(dport, IP_FLOW_HASH_DST_PORT)                 \
143 _(proto, IP_FLOW_HASH_PROTO)                    \
144 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)
145
146 /* IP unicast adjacency. */
147 typedef struct {
148   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
149   /* Handle for this adjacency in adjacency heap. */
150   u32 heap_handle;
151
152   STRUCT_MARK(signature_start);
153
154   /* Interface address index for this local/arp adjacency. */
155   u32 if_address_index;
156
157   /* Number of adjecencies in block.  Greater than 1 means multipath;
158      otherwise equal to 1. */
159   u16 n_adj;
160
161   /* Next hop after ip4-lookup. */
162   union {
163     ip_lookup_next_t lookup_next_index : 16;
164     u16 lookup_next_index_as_int;
165   };
166
167   /* Force re-lookup in a different FIB. ~0 => normal behavior */
168   i16 explicit_fib_index;
169   u16 mcast_group_index;  
170
171   /* Highest possible perf subgraph arc interposition, e.g. for ip6 ioam */
172   u16 saved_lookup_next_index;
173
174   union {
175     /* IP_LOOKUP_NEXT_ARP only */
176     struct {
177       ip46_address_t next_hop;
178     } arp;
179     /* IP_LOOKUP_NEXT_CLASSIFY only */
180     struct {
181       u16 table_index;
182     } classify;
183     /* IP_LOOKUP_NEXT_INDIRECT only */
184     struct {
185         ip46_address_t next_hop;
186     } indirect;
187   };
188
189   STRUCT_MARK(signature_end);
190
191   /* Number of FIB entries sharing this adjacency */
192   u32 share_count;
193   /* Use this adjacency instead */
194   u32 next_adj_with_signature;
195
196   CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
197
198   /* Rewrite in second/third cache lines */
199   vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
200 } ip_adjacency_t;
201
202 static inline uword
203 vnet_ip_adjacency_signature (ip_adjacency_t * adj)
204 {
205   uword signature = 0xfeedfaceULL;
206
207   /* Skip heap handle, sum everything up to but not including share_count */
208   signature = hash_memory
209       (STRUCT_MARK_PTR(adj, signature_start),
210        STRUCT_OFFSET_OF(ip_adjacency_t, signature_end)
211        - STRUCT_OFFSET_OF(ip_adjacency_t, signature_start),
212        signature);
213
214   /* and the rewrite */
215   signature = hash_memory (&adj->rewrite_header, VLIB_BUFFER_PRE_DATA_SIZE,
216                              signature);
217   return signature;
218 }
219
220 static inline int
221 vnet_ip_adjacency_share_compare (ip_adjacency_t * a1, ip_adjacency_t *a2)
222 {
223   if (memcmp (STRUCT_MARK_PTR(a1, signature_start),
224               STRUCT_MARK_PTR(a2, signature_start),
225               STRUCT_OFFSET_OF(ip_adjacency_t, signature_end)
226               - STRUCT_OFFSET_OF(ip_adjacency_t, signature_start)))
227     return 0;
228   if (memcmp (&a1->rewrite_header, &a2->rewrite_header,
229               VLIB_BUFFER_PRE_DATA_SIZE))
230     return 0;
231   return 1;
232 }
233
234 /* Index into adjacency table. */
235 typedef u32 ip_adjacency_index_t;
236
237 typedef struct {
238   /* Directly connected next-hop adjacency index. */
239   u32 next_hop_adj_index;
240
241   /* Path weight for this adjacency. */
242   u32 weight;
243 } ip_multipath_next_hop_t;
244
245 typedef struct {
246   /* Adjacency index of first index in block. */
247   u32 adj_index;
248   
249   /* Power of 2 size of adjacency block. */
250   u32 n_adj_in_block;
251
252   /* Number of prefixes that point to this adjacency. */
253   u32 reference_count;
254
255   /* Normalized next hops are used as hash keys: they are sorted by weight
256      and weights are chosen so they add up to 1 << log2_n_adj_in_block (with
257      zero-weighted next hops being deleted).
258      Unnormalized next hops are saved so that control plane has a record of exactly
259      what the RIB told it. */
260   struct {
261     /* Number of hops in the multipath. */
262     u32 count;
263
264     /* Offset into next hop heap for this block. */
265     u32 heap_offset;
266
267     /* Heap handle used to for example free block when we're done with it. */
268     u32 heap_handle;
269   } normalized_next_hops, unnormalized_next_hops;
270 } ip_multipath_adjacency_t;
271
272 /* IP multicast adjacency. */
273 typedef struct {
274   /* Handle for this adjacency in adjacency heap. */
275   u32 heap_handle;
276
277   /* Number of adjecencies in block. */
278   u32 n_adj;
279
280   /* Rewrite string. */
281   vnet_declare_rewrite (64 - 2*sizeof(u32));
282 } ip_multicast_rewrite_t;
283
284 typedef struct {
285   /* ip4-multicast-rewrite next index. */
286   u32 next_index;
287
288   u8 n_rewrite_bytes;
289
290   u8 rewrite_string[64 - 1*sizeof(u32) - 1*sizeof(u8)];
291 } ip_multicast_rewrite_string_t;
292
293 typedef struct {
294   ip_multicast_rewrite_t * rewrite_heap;
295
296   ip_multicast_rewrite_string_t * rewrite_strings;
297
298   /* Negative rewrite string index; >= 0 sw_if_index.
299      Sorted.  Used to hash. */
300   i32 ** adjacency_id_vector;
301
302   uword * adjacency_by_id_vector;
303 } ip_multicast_lookup_main_t;
304
305 typedef struct {
306   /* Key for mhash; in fact, just a byte offset into mhash key vector. */
307   u32 address_key;
308
309   /* Interface which has this address. */
310   u32 sw_if_index;
311
312   /* Adjacency for neighbor probe (ARP) for this interface address. */
313   u32 neighbor_probe_adj_index;
314
315   /* Address (prefix) length for this interface. */
316   u16 address_length;
317
318   /* Will be used for something eventually.  Primary vs. secondary? */
319   u16 flags;
320
321   /* Next and previous pointers for doubly linked list of
322      addresses per software interface. */
323   u32 next_this_sw_interface;
324   u32 prev_this_sw_interface;
325 } ip_interface_address_t;
326
327 typedef enum {
328   IP_LOCAL_NEXT_DROP,
329   IP_LOCAL_NEXT_PUNT,
330   IP_LOCAL_NEXT_UDP_LOOKUP,
331   IP_LOCAL_NEXT_ICMP,
332   IP_LOCAL_N_NEXT,
333 } ip_local_next_t;
334
335 struct ip_lookup_main_t;
336
337 typedef void (* ip_add_del_adjacency_callback_t) (struct ip_lookup_main_t * lm,
338                                                   u32 adj_index,
339                                                   ip_adjacency_t * adj,
340                                                   u32 is_del);
341
342 typedef struct {
343   vnet_config_main_t config_main;
344
345   u32 * config_index_by_sw_if_index;
346 } ip_config_main_t;
347
348 typedef struct ip_lookup_main_t {
349   /* Adjacency heap. */
350   ip_adjacency_t * adjacency_heap;
351
352   /* Adjacency packet/byte counters indexed by adjacency index. */
353   vlib_combined_counter_main_t adjacency_counters;
354
355   /* Heap of (next hop, weight) blocks.  Sorted by next hop. */
356   ip_multipath_next_hop_t * next_hop_heap;
357
358   /* Indexed by heap_handle from ip_adjacency_t. */
359   ip_multipath_adjacency_t * multipath_adjacencies;
360
361   /* Adjacency by signature hash */
362   uword * adj_index_by_signature;
363
364   /* Temporary vectors for looking up next hops in hash. */
365   ip_multipath_next_hop_t * next_hop_hash_lookup_key;
366   ip_multipath_next_hop_t * next_hop_hash_lookup_key_normalized;
367
368   /* Hash table mapping normalized next hops and weights
369      to multipath adjacency index. */
370   uword * multipath_adjacency_by_next_hops;
371
372   u32 * adjacency_remap_table;
373   u32 n_adjacency_remaps;
374
375   /* If average error per adjacency is less than this threshold adjacency block
376      size is accepted. */
377   f64 multipath_next_hop_error_tolerance;
378
379   /* Adjacency index for routing table misses, local punts, and drops. */
380   u32 miss_adj_index, drop_adj_index, local_adj_index;
381
382   /* Miss adjacency is always first in adjacency table. */
383 #define IP_LOOKUP_MISS_ADJ_INDEX 0
384
385   ip_add_del_adjacency_callback_t * add_del_adjacency_callbacks;
386
387   /* Pool of addresses that are assigned to interfaces. */
388   ip_interface_address_t * if_address_pool;
389
390   /* Hash table mapping address to index in interface address pool. */
391   mhash_t address_to_if_address_index;
392
393   /* Head of doubly linked list of interface addresses for each software interface.
394      ~0 means this interface has no address. */
395   u32 * if_address_pool_index_by_sw_if_index;
396
397   /* First table index to use for this interface, ~0 => none */
398   u32 * classify_table_index_by_sw_if_index;
399
400   /* rx/tx interface/feature configuration. */
401   ip_config_main_t rx_config_mains[VNET_N_CAST], tx_config_main;
402
403   /* Number of bytes in a fib result.  Must be at least
404      sizeof (uword).  First word is always adjacency index. */
405   u32 fib_result_n_bytes, fib_result_n_words;
406
407   format_function_t * format_fib_result;
408
409   /* 1 for ip6; 0 for ip4. */
410   u32 is_ip6;
411
412   /* Either format_ip4_address_and_length or format_ip6_address_and_length. */
413   format_function_t * format_address_and_length;
414
415   /* Table mapping ip protocol to ip[46]-local node next index. */
416   u8 local_next_by_ip_protocol[256];
417
418   /* IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
419   u8 builtin_protocol_by_ip_protocol[256];
420 } ip_lookup_main_t;
421
422 always_inline ip_adjacency_t *
423 ip_get_adjacency (ip_lookup_main_t * lm,
424                   u32 adj_index)
425 {
426   ip_adjacency_t * adj;
427
428   adj = vec_elt_at_index (lm->adjacency_heap, adj_index);
429
430   ASSERT (adj->heap_handle != ~0);
431
432   return adj;
433 }
434
435 #define ip_prefetch_adjacency(lm,adj_index,type)                \
436 do {                                                            \
437   ip_adjacency_t * _adj = (lm)->adjacency_heap + (adj_index);   \
438   CLIB_PREFETCH (_adj, sizeof (_adj[0]), type);                 \
439 } while (0)
440
441 static inline void
442 ip_register_add_del_adjacency_callback(ip_lookup_main_t * lm,
443                                        ip_add_del_adjacency_callback_t cb)
444 {
445   vec_add1(lm->add_del_adjacency_callbacks, cb);
446 }
447
448 always_inline void
449 ip_call_add_del_adjacency_callbacks (ip_lookup_main_t * lm, u32 adj_index, u32 is_del)
450 {
451   ip_adjacency_t * adj;
452   uword i;
453   adj = ip_get_adjacency (lm, adj_index);
454   for (i = 0; i < vec_len (lm->add_del_adjacency_callbacks); i++)
455     lm->add_del_adjacency_callbacks[i] (lm, adj_index, adj, is_del);
456 }
457
458 /* Create new block of given number of contiguous adjacencies. */
459 ip_adjacency_t *
460 ip_add_adjacency (ip_lookup_main_t * lm,
461                   ip_adjacency_t * adj,
462                   u32 n_adj,
463                   u32 * adj_index_result);
464
465 void ip_del_adjacency (ip_lookup_main_t * lm, u32 adj_index);
466 void
467 ip_update_adjacency (ip_lookup_main_t * lm,
468                      u32 adj_index,
469                      ip_adjacency_t * copy_adj);
470
471 static inline int
472 ip_adjacency_is_multipath(ip_lookup_main_t * lm, u32 adj_index)
473 {
474   if (!vec_len(lm->multipath_adjacencies))
475     return 0;
476
477   if (vec_len(lm->multipath_adjacencies) < adj_index - 1)
478     return 0;
479
480
481   return (lm->multipath_adjacencies[adj_index].adj_index == adj_index &&
482           lm->multipath_adjacencies[adj_index].n_adj_in_block > 0);
483 }
484
485 void
486 ip_multipath_adjacency_free (ip_lookup_main_t * lm,
487                              ip_multipath_adjacency_t * a);
488
489 u32
490 ip_multipath_adjacency_add_del_next_hop (ip_lookup_main_t * lm,
491                                          u32 is_del,
492                                          u32 old_mp_adj_index,
493                                          u32 next_hop_adj_index,
494                                          u32 next_hop_weight,
495                                          u32 * new_mp_adj_index);
496
497 clib_error_t *
498 ip_interface_address_add_del (ip_lookup_main_t * lm,
499                               u32 sw_if_index,
500                               void * address,
501                               u32 address_length,
502                               u32 is_del,
503                               u32 * result_index);
504
505 always_inline ip_interface_address_t *
506 ip_get_interface_address (ip_lookup_main_t * lm, void * addr_fib)
507 {
508   uword * p = mhash_get (&lm->address_to_if_address_index, addr_fib);
509   return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
510 }
511
512 always_inline void *
513 ip_interface_address_get_address (ip_lookup_main_t * lm, ip_interface_address_t * a)
514 { return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key); }
515
516 always_inline ip_interface_address_t *
517 ip_interface_address_for_packet (ip_lookup_main_t * lm, vlib_buffer_t * b, u32 sw_if_index)
518 {
519   ip_adjacency_t * adj;
520   u32 if_address_index;
521
522   adj = ip_get_adjacency (lm, vnet_buffer (b)->ip.adj_index[VLIB_TX]);
523
524   ASSERT (adj->lookup_next_index == IP_LOOKUP_NEXT_ARP
525           || adj->lookup_next_index == IP_LOOKUP_NEXT_LOCAL);
526   if_address_index = adj->if_address_index;
527   if_address_index = (if_address_index == ~0 ?
528                       vec_elt (lm->if_address_pool_index_by_sw_if_index, sw_if_index)
529                       : if_address_index);
530
531   return pool_elt_at_index (lm->if_address_pool, if_address_index);
532 }
533
534 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body)        \
535 do {                                                                    \
536     vnet_main_t *_vnm = vnet_get_main();                                     \
537     u32 _sw_if_index = sw_if_index;                                     \
538     vnet_sw_interface_t *_swif;                                         \
539     _swif = vnet_get_sw_interface (_vnm, _sw_if_index);                 \
540                                                                         \
541     /*                                                                  \
542      * Loop => honor unnumbered interface addressing.                   \
543      */                                                                 \
544     if (loop && _swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)       \
545       _sw_if_index = _swif->unnumbered_sw_if_index;                     \
546     u32 _ia =                                                           \
547       (vec_len((lm)->if_address_pool_index_by_sw_if_index)              \
548        > (_sw_if_index))                                                \
549         ? vec_elt ((lm)->if_address_pool_index_by_sw_if_index,          \
550                    (_sw_if_index)) : (u32)~0;                           \
551     ip_interface_address_t * _a;                                        \
552     while (_ia != ~0)                                                   \
553     {                                                                   \
554         _a = pool_elt_at_index ((lm)->if_address_pool, _ia);            \
555         _ia = _a->next_this_sw_interface;                               \
556         (a) = _a;                                                       \
557         body;                                                           \
558     }                                                                   \
559 } while (0)
560
561 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
562
563 #endif /* included_ip_lookup_h */