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