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