FD.io VPP  v18.07-rc0-415-g6c78436
Vector Packet Processing
ip.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 #include <vnet/ip/ip.h>
17 #include <vnet/fib/fib_table.h>
18 
19 u8
20 ip_is_zero (ip46_address_t * ip46_address, u8 is_ip4)
21 {
22  if (is_ip4)
23  return (ip46_address->ip4.as_u32 == 0);
24  else
25  return (ip46_address->as_u64[0] == 0 && ip46_address->as_u64[1] == 0);
26 }
27 
28 u8
29 ip_is_local_host (ip46_address_t * ip46_address, u8 is_ip4)
30 {
31  if (is_ip4)
32  return (ip46_address->ip4.as_u8[0] == 127);
33  else
34  return (ip46_address->as_u64[0] == 0 &&
35  clib_net_to_host_u64 (ip46_address->as_u64[1]) == 1);
36 }
37 
38 u8
40 {
41  return (ip4_address->as_u8[0] == 127);
42 }
43 
44 u8
46 {
47  return (ip6_address->as_u64[0] == 0 &&
48  clib_net_to_host_u64 (ip6_address->as_u64[1]) == 1);
49 }
50 
51 /**
52  * Checks that an ip is local to the requested fib
53  */
54 u8
55 ip_is_local (u32 fib_index, ip46_address_t * ip46_address, u8 is_ip4)
56 {
57  fib_node_index_t fei;
59  fib_prefix_t prefix;
60 
61  /* Check if requester is local */
62  if (is_ip4)
63  {
64  prefix.fp_len = 32;
65  prefix.fp_proto = FIB_PROTOCOL_IP4;
66  }
67  else
68  {
69  prefix.fp_len = 128;
70  prefix.fp_proto = FIB_PROTOCOL_IP6;
71  }
72 
73  clib_memcpy (&prefix.fp_addr, ip46_address, sizeof (ip46_address_t));
74  fei = fib_table_lookup (fib_index, &prefix);
75  flags = fib_entry_get_flags (fei);
76 
77  return (flags & FIB_ENTRY_FLAG_LOCAL);
78 }
79 
80 void
81 ip_copy (ip46_address_t * dst, ip46_address_t * src, u8 is_ip4)
82 {
83  if (is_ip4)
84  dst->ip4.as_u32 = src->ip4.as_u32;
85  else
86  clib_memcpy (&dst->ip6, &src->ip6, sizeof (ip6_address_t));
87 }
88 
89 void
90 ip_set (ip46_address_t * dst, void *src, u8 is_ip4)
91 {
92  if (is_ip4)
93  dst->ip4.as_u32 = ((ip4_address_t *) src)->as_u32;
94  else
95  clib_memcpy (&dst->ip6, (ip6_address_t *) src, sizeof (ip6_address_t));
96 }
97 
98 u8
99 ip_interface_has_address (u32 sw_if_index, ip46_address_t * ip, u8 is_ip4)
100 {
101  ip_interface_address_t *ia = 0;
102 
103  if (is_ip4)
104  {
106  ip4_address_t *ip4;
107  /* *INDENT-OFF* */
108  foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
109  ({
110  ip4 = ip_interface_address_get_address (lm4, ia);
111  if (ip4_address_compare (ip4, &ip->ip4) == 0)
112  return 1;
113  }));
114  /* *INDENT-ON* */
115  }
116  else
117  {
119  ip6_address_t *ip6;
120  /* *INDENT-OFF* */
121  foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
122  ({
123  ip6 = ip_interface_address_get_address (lm6, ia);
124  if (ip6_address_compare (ip6, &ip->ip6) == 0)
125  return 1;
126  }));
127  /* *INDENT-ON* */
128  }
129  return 0;
130 }
131 
132 void *
133 ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4)
134 {
137  ip_interface_address_t *ia = 0;
138 
139  if (is_ip4)
140  {
141  /* *INDENT-OFF* */
142  foreach_ip_interface_address (lm4, ia, sw_if_index, 1 /* unnumbered */ ,
143  ({
144  return ip_interface_address_get_address (lm4, ia);
145  }));
146  /* *INDENT-ON* */
147  }
148  else
149  {
150  /* *INDENT-OFF* */
151  foreach_ip_interface_address (lm6, ia, sw_if_index, 1 /* unnumbered */ ,
152  ({
153  ip6_address_t *rv;
154  rv = ip_interface_address_get_address (lm6, ia);
155  /* Trying to use a link-local ip6 src address is a fool's errand */
157  return rv;
158  }));
159  /* *INDENT-ON* */
160  }
161 
162  return 0;
163 }
164 
165 void
167 {
168  ASSERT (preflen <= 32);
169  if (preflen == 0)
170  ip4->data_u32 = 0;
171  else
172  ip4->data_u32 &= clib_net_to_host_u32 (0xffffffff << (32 - preflen));
173 }
174 
175 void
177 {
178  ASSERT (preflen <= 128);
179  if (preflen == 0)
180  {
181  ip6->as_u64[0] = 0;
182  ip6->as_u64[1] = 0;
183  }
184  else if (preflen <= 64)
185  {
186  ip6->as_u64[0] &=
187  clib_host_to_net_u64 (0xffffffffffffffffL << (64 - preflen));
188  ip6->as_u64[1] = 0;
189  }
190  else
191  ip6->as_u64[1] &=
192  clib_host_to_net_u64 (0xffffffffffffffffL << (128 - preflen));
193 }
194 
195 void
197 {
198  if (pref_len == 0)
199  ip->as_u32 = 0;
200  else
201  ip->as_u32 = clib_host_to_net_u32 (~((1 << (32 - pref_len)) - 1));
202 }
203 
204 u32
206 {
207  if (mask->as_u32 == 0)
208  return 0;
209  return (32 - log2_first_set (clib_net_to_host_u32 (mask->as_u32)));
210 }
211 
212 void
214  ip4_address_t * res)
215 {
216  u32 not_mask;
217  not_mask = (1 << (32 - plen)) - 1;
218  res->as_u32 = clib_net_to_host_u32 (ip->as_u32) + not_mask;
219 }
220 
221 void
223 {
224  if (pref_len == 0)
225  {
226  mask->as_u64[0] = 0;
227  mask->as_u64[1] = 0;
228  }
229  else if (pref_len <= 64)
230  {
231  mask->as_u64[0] =
232  clib_host_to_net_u64 (0xffffffffffffffffL << (64 - pref_len));
233  mask->as_u64[1] = 0;
234  }
235  else
236  {
237  mask->as_u64[1] =
238  clib_host_to_net_u64 (0xffffffffffffffffL << (128 - pref_len));
239  }
240 }
241 
242 void
244  ip6_address_t * res)
245 {
246  u64 not_mask;
247  if (plen == 0)
248  {
249  res->as_u64[0] = 0xffffffffffffffffL;
250  res->as_u64[1] = 0xffffffffffffffffL;
251  }
252  else if (plen <= 64)
253  {
254  not_mask = ((u64) 1 << (64 - plen)) - 1;
255  res->as_u64[0] = clib_net_to_host_u64 (ip->as_u64[0]) + not_mask;
256  res->as_u64[1] = 0xffffffffffffffffL;
257  }
258  else
259  {
260  not_mask = ((u64) 1 << (128 - plen)) - 1;
261  res->as_u64[1] = clib_net_to_host_u64 (ip->as_u64[1]) + not_mask;
262  }
263 }
264 
265 u32
267 {
268  u8 first1, first0;
269  if (mask->as_u64[0] == 0 && mask->as_u64[1] == 0)
270  return 0;
271  first1 = log2_first_set (clib_net_to_host_u64 (mask->as_u64[1]));
272  first0 = log2_first_set (clib_net_to_host_u64 (mask->as_u64[0]));
273 
274  if (first1 != 0)
275  return 128 - first1;
276  else
277  return 64 - first0;
278 }
279 
280 /*
281  * fd.io coding-style-patch-verification: ON
282  *
283  * Local Variables:
284  * eval: (c-set-style "gnu")
285  * End:
286  */
#define foreach_ip_interface_address(lm, a, sw_if_index, loop, body)
Definition: lookup.h:179
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:197
void ip6_preflen_to_mask(u8 pref_len, ip6_address_t *mask)
Definition: ip.c:222
void ip4_preflen_to_mask(u8 pref_len, ip4_address_t *ip)
Definition: ip.c:196
void ip_copy(ip46_address_t *dst, ip46_address_t *src, u8 is_ip4)
Definition: ip.c:81
static uword log2_first_set(uword x)
Definition: clib.h:253
u8 ip_is_local(u32 fib_index, ip46_address_t *ip46_address, u8 is_ip4)
Checks that an ip is local to the requested fib.
Definition: ip.c:55
u64 as_u64[2]
Definition: ip6_packet.h:51
unsigned long u64
Definition: types.h:89
void ip_set(ip46_address_t *dst, void *src, u8 is_ip4)
Definition: ip.c:90
u8 ip_interface_has_address(u32 sw_if_index, ip46_address_t *ip, u8 is_ip4)
Definition: ip.c:99
ip_lookup_main_t lookup_main
Definition: ip4.h:97
void * ip_interface_get_first_ip(u32 sw_if_index, u8 is_ip4)
Definition: ip.c:133
unsigned char u8
Definition: types.h:56
void ip6_prefix_max_address_host_order(ip6_address_t *ip, u8 plen, ip6_address_t *res)
Definition: ip.c:243
void ip4_address_normalize(ip4_address_t *ip4, u8 preflen)
Definition: ip.c:166
Aggregrate type for a prefix.
Definition: fib_types.h:188
unsigned int u32
Definition: types.h:88
u16 fp_len
The mask length.
Definition: fib_types.h:192
fib_node_index_t fib_table_lookup(u32 fib_index, const fib_prefix_t *prefix)
Perfom a longest prefix match in the non-forwarding table.
Definition: fib_table.c:66
Definition: fib_entry.h:275
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:211
typedef ip6_address
Definition: ip_types.api:20
void ip6_address_normalize(ip6_address_t *ip6, u8 preflen)
Definition: ip.c:176
int ip6_address_compare(ip6_address_t *a1, ip6_address_t *a2)
Definition: ip46_cli.c:60
u32 ip6_mask_to_preflen(ip6_address_t *mask)
Definition: ip.c:266
int ip4_address_compare(ip4_address_t *a1, ip4_address_t *a2)
Definition: ip46_cli.c:53
#define clib_memcpy(a, b, c)
Definition: string.h:75
u8 ip4_is_local_host(ip4_address_t *ip4_address)
Definition: ip.c:39
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
u32 ip4_mask_to_preflen(ip4_address_t *mask)
Definition: ip.c:205
u8 ip6_is_local_host(ip6_address_t *ip6_address)
Definition: ip.c:45
enum fib_entry_flag_t_ fib_entry_flag_t
#define ASSERT(truth)
ip6_main_t ip6_main
Definition: ip6_forward.c:2574
ip_lookup_main_t lookup_main
Definition: ip6.h:161
static uword ip6_address_is_link_local_unicast(const ip6_address_t *a)
Definition: ip6_packet.h:302
u8 ip_is_zero(ip46_address_t *ip46_address, u8 is_ip4)
Definition: ip.c:20
void ip4_prefix_max_address_host_order(ip4_address_t *ip, u8 plen, ip4_address_t *res)
Definition: ip.c:213
u8 ip_is_local_host(ip46_address_t *ip46_address, u8 is_ip4)
Definition: ip.c:29
typedef ip4_address
Definition: ip_types.api:16
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:832
static void * ip_interface_address_get_address(ip_lookup_main_t *lm, ip_interface_address_t *a)
Definition: lookup.h:172
u32 flags
Definition: vhost-user.h:77
fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index)
Definition: fib_entry.c:276