Line data Source code
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 : /**
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.
47 : */
48 : #ifndef included_ip_lookup_h
49 : #define included_ip_lookup_h
50 :
51 : //#include <vnet/vnet.h>
52 : #include <vlib/vlib.h>
53 : #include <vlib/buffer.h>
54 : #include <vnet/ip/ip4_packet.h>
55 : #include <vnet/ip/ip6_packet.h>
56 : #include <vnet/ip/ip_types.h>
57 : #include <vnet/fib/fib_node.h>
58 : #include <vnet/adj/adj.h>
59 : #include <vnet/dpo/dpo.h>
60 : ///#include <vnet/feature/feature.h>
61 :
62 : /* An all zeros address */
63 : extern const ip46_address_t zero_addr;
64 :
65 : typedef enum ip_interface_address_flags_t_
66 : {
67 : IP_INTERFACE_ADDRESS_FLAG_STALE = (1 << 0),
68 : } __clib_packed ip_interface_address_flags_t;
69 :
70 : typedef struct
71 : {
72 : fib_prefix_t prefix;
73 :
74 : u32 sw_if_index;
75 : } ip_interface_prefix_key_t;
76 :
77 : typedef struct
78 : {
79 : /* key - prefix and sw_if_index */
80 : ip_interface_prefix_key_t key;
81 :
82 : /* number of addresses in this prefix on the interface */
83 : u16 ref_count;
84 :
85 : /* index of the interface address used as a default source address */
86 : u32 src_ia_index;
87 : } ip_interface_prefix_t;
88 :
89 : typedef struct
90 : {
91 : /* Key for mhash; in fact, just a byte offset into mhash key vector. */
92 : u32 address_key;
93 :
94 : /* Interface which has this address. */
95 : u32 sw_if_index;
96 :
97 : /* Address (prefix) length for this interface. */
98 : u16 address_length;
99 :
100 : /* flags relating to this prefix */
101 : ip_interface_address_flags_t flags;
102 :
103 : /* Next and previous pointers for doubly linked list of
104 : addresses per software interface. */
105 : u32 next_this_sw_interface;
106 : u32 prev_this_sw_interface;
107 : } ip_interface_address_t;
108 :
109 : typedef enum
110 : {
111 : IP_LOCAL_NEXT_DROP,
112 : IP_LOCAL_NEXT_PUNT,
113 : IP_LOCAL_NEXT_UDP_LOOKUP,
114 : IP_LOCAL_NEXT_ICMP,
115 : IP_LOCAL_NEXT_REASSEMBLY,
116 : IP_LOCAL_N_NEXT,
117 : } ip_local_next_t;
118 :
119 : struct ip_lookup_main_t;
120 :
121 : typedef struct ip_lookup_main_t
122 : {
123 : /** Pool of addresses that are assigned to interfaces. */
124 : ip_interface_address_t *if_address_pool;
125 :
126 : /** Hash table mapping address to index in interface address pool. */
127 : mhash_t address_to_if_address_index;
128 :
129 : /** Head of doubly linked list of interface addresses for each software interface.
130 : ~0 means this interface has no address. */
131 : u32 *if_address_pool_index_by_sw_if_index;
132 :
133 : /** Pool of prefixes containing addresses assigned to interfaces */
134 : ip_interface_prefix_t *if_prefix_pool;
135 :
136 : /** Hash table mapping prefix to index in interface prefix pool */
137 : mhash_t prefix_to_if_prefix_index;
138 :
139 : /** First table index to use for this interface, ~0 => none */
140 : u32 *classify_table_index_by_sw_if_index;
141 :
142 : /** Feature arc indices */
143 : u8 mcast_feature_arc_index;
144 : u8 ucast_feature_arc_index;
145 : u8 output_feature_arc_index;
146 :
147 : /** Number of bytes in a fib result. Must be at least
148 : sizeof (uword). First word is always adjacency index. */
149 : u32 fib_result_n_bytes, fib_result_n_words;
150 :
151 : /** 1 for ip6; 0 for ip4. */
152 : u32 is_ip6;
153 :
154 : /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
155 : format_function_t *format_address_and_length;
156 :
157 : /** Table mapping ip protocol to ip[46]-local node next index. */
158 : u8 local_next_by_ip_protocol[256];
159 :
160 : /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
161 : u8 builtin_protocol_by_ip_protocol[256];
162 : } ip_lookup_main_t;
163 :
164 : u8 *format_ip_flow_hash_config (u8 * s, va_list * args);
165 : uword unformat_ip_flow_hash_config (unformat_input_t *input, va_list *args);
166 :
167 : always_inline void
168 24487715 : ip_lookup_set_buffer_fib_index (u32 * fib_index_by_sw_if_index,
169 : vlib_buffer_t * b)
170 : {
171 : /* *INDENT-OFF* */
172 24487715 : vnet_buffer (b)->ip.fib_index =
173 24487715 : vec_elt (fib_index_by_sw_if_index, vnet_buffer (b)->sw_if_index[VLIB_RX]);
174 24487715 : vnet_buffer (b)->ip.fib_index =
175 24487715 : ((vnet_buffer (b)->sw_if_index[VLIB_TX] == (u32) ~ 0) ?
176 24487715 : vnet_buffer (b)->ip.fib_index :
177 1167715 : vnet_buffer (b)->sw_if_index[VLIB_TX]);
178 : /* *INDENT-ON* */
179 24487715 : }
180 :
181 : void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
182 : bool fib_prefix_validate (const fib_prefix_t *prefix);
183 :
184 : #endif /* included_ip_lookup_h */
185 : /*
186 : * fd.io coding-style-patch-verification: ON
187 : *
188 : * Local Variables:
189 : * eval: (c-set-style "gnu")
190 : * End:
191 : */
|
