FD.io VPP  v21.01.1
Vector Packet Processing
ip_types.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 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 #ifndef __IP_TYPES_H__
17 #define __IP_TYPES_H__
18 
19 #include <vnet/fib/fib_types.h>
20 
22 {
25 } __clib_packed ip_address_family_t;
26 
27 #define N_AF (AF_IP6+1)
28 
30  va_list * args);
31 extern u8 *format_ip_address_family (u8 * s, va_list * args);
32 
33 #define FOR_EACH_IP_ADDRESS_FAMILY(_af) \
34  for (_af = AF_IP4; _af <= AF_IP6; _af++)
35 
39  fp);
40 
42 {
45 } __clib_packed ip_sub_address_family_t;
46 
47 #define N_SAFI (SAFI_MULTICAST+1)
48 
50  va_list * args);
51 extern u8 *format_ip_sub_address_family (u8 * s, va_list * args);
52 
53 #define FOR_EACH_IP_ADDRESS_SUB_FAMILY(_safi) \
54  for (_safi = SAFI_UNICAST; _safi <= SAFI_MULTICAST; _safi++)
55 
56 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
57 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
58 
59 /**
60  * Locations in the IP switch path where features can be applied
61  */
62 #define foreach_ip_feature_location \
63  _(INPUT, "input") \
64  _(OUTPUT, "output") \
65  _(LOCAL, "local") \
66  _(PUNT, "punt") \
67  _(DROP, "drop") \
68 
70 {
71 #define _(a,b) IP_FEATURE_##a,
73 #undef _
74 } __clib_packed ip_feature_location_t;
75 
76 #define N_IP_FEATURE_LOCATIONS (IP_FEATURE_DROP+1)
77 
78 /* *INDENT-OFF* */
79 typedef struct ip_address
80 {
81  ip46_address_t ip;
83 } __clib_packed ip_address_t;
84 /* *INDENT-ON* */
85 
86 #define IP_ADDRESS_V4_ALL_0S {.ip.ip4.as_u32 = 0, .version = AF_IP4}
87 #define IP_ADDRESS_V6_ALL_0S {.ip.ip6.as_u64 = {0, 0}, .version = AF_IP6}
88 #define ip_address_initializer IP_ADDRESS_V6_ALL_0S
89 
90 #define ip_addr_46(_a) (_a)->ip
91 #define ip_addr_v4(_a) (_a)->ip.ip4
92 #define ip_addr_v6(_a) (_a)->ip.ip6
93 #define ip_addr_version(_a) (_a)->version
94 
95 extern u8 *ip_addr_bytes (ip_address_t * ip);
96 
97 extern bool ip_address_is_zero (const ip_address_t * ip);
98 extern int ip_address_cmp (const ip_address_t * ip1,
99  const ip_address_t * ip2);
100 extern void ip_address_copy (ip_address_t * dst, const ip_address_t * src);
101 extern void ip_address_copy_addr (void *dst, const ip_address_t * src);
102 extern void ip_address_set (ip_address_t * dst, const void *src, u8 version);
103 extern u16 ip_address_size (const ip_address_t * a);
105 extern u8 *format_ip_address (u8 * s, va_list * args);
106 extern uword unformat_ip_address (unformat_input_t * input, va_list * args);
108  ip46_address_t * a);
109 extern void ip_address_from_46 (const ip46_address_t * a,
110  fib_protocol_t fproto, ip_address_t * addr);
111 extern void ip_address_increment (ip_address_t * ip);
112 extern void ip_address_reset (ip_address_t * ip);
113 
114 /* *INDENT-OFF* */
115 typedef struct ip_prefix
116 {
119 } __clib_packed ip_prefix_t;
120 /* *INDENT-ON* */
121 
122 #define ip_prefix_addr(_a) (_a)->addr
123 #define ip_prefix_version(_a) ip_addr_version(&ip_prefix_addr(_a))
124 #define ip_prefix_len(_a) (_a)->len
125 #define ip_prefix_v4(_a) ip_addr_v4(&ip_prefix_addr(_a))
126 #define ip_prefix_v6(_a) ip_addr_v6(&ip_prefix_addr(_a))
127 
128 extern int ip_prefix_cmp (ip_prefix_t * p1, ip_prefix_t * p2);
129 extern void ip_prefix_normalize (ip_prefix_t * a);
130 
131 extern void ip_address_to_fib_prefix (const ip_address_t * addr,
132  fib_prefix_t * prefix);
133 extern void ip_prefix_to_fib_prefix (const ip_prefix_t * ipp,
134  fib_prefix_t * fibp);
135 extern u8 *format_ip_prefix (u8 * s, va_list * args);
136 extern uword unformat_ip_prefix (unformat_input_t * input, va_list * args);
137 
138 extern bool ip_prefix_validate (const ip_prefix_t * ip);
139 extern void ip4_address_normalize (ip4_address_t * ip4, u8 preflen);
140 extern void ip6_address_normalize (ip6_address_t * ip6, u8 preflen);
141 extern void ip4_preflen_to_mask (u8 pref_len, ip4_address_t * ip);
144  ip4_address_t * res);
145 extern void ip6_prefix_max_address_host_order (ip6_address_t * ip, u8 plen,
146  ip6_address_t * res);
147 extern void ip6_preflen_to_mask (u8 pref_len, ip6_address_t * mask);
148 extern u32 ip6_mask_to_preflen (ip6_address_t * mask);
149 
150 #endif /* __IP_TYPES_H__ */
151 
152 /*
153  * fd.io coding-style-patch-verification: ON
154  *
155  * Local Variables:
156  * eval: (c-set-style "gnu")
157  * End:
158  */
void ip_address_to_fib_prefix(const ip_address_t *addr, fib_prefix_t *prefix)
convert from a IP address to a FIB prefix
Definition: ip_types.c:271
u8 * format_ip_address(u8 *s, va_list *args)
Definition: ip_types.c:21
u16 ip_version_to_size(ip_address_family_t af)
Definition: ip_types.c:178
struct ip_address ip_address_t
int ip_address_cmp(const ip_address_t *ip1, const ip_address_t *ip2)
Definition: ip_types.c:117
u16 ip_address_size(const ip_address_t *a)
Definition: ip_types.c:87
a
Definition: bitmap.h:544
void ip4_address_normalize(ip4_address_t *ip4, u8 preflen)
Definition: ip_types.c:462
fib_protocol_t ip_address_family_to_fib_proto(ip_address_family_t af)
Definition: ip_types.c:224
fib_protocol_t ip_address_to_46(const ip_address_t *addr, ip46_address_t *a)
Definition: ip_types.c:253
ip46_address_t ip
Definition: ip_types.h:81
u32 ip4_mask_to_preflen(ip4_address_t *mask)
Definition: ip_types.c:501
vl_api_address_t src
Definition: gre.api:54
vl_api_prefix_t prefix
Definition: ip.api:144
void ip_address_from_46(const ip46_address_t *a, fib_protocol_t fproto, ip_address_t *addr)
Definition: ip_types.c:260
u16 mask
Definition: flow_types.api:52
void ip4_prefix_max_address_host_order(ip4_address_t *ip, u8 plen, ip4_address_t *res)
Definition: ip_types.c:509
vhost_vring_addr_t addr
Definition: vhost_user.h:111
bool ip_address_is_zero(const ip_address_t *ip)
Definition: ip_types.c:102
int ip_prefix_cmp(ip_prefix_t *p1, ip_prefix_t *p2)
Definition: ip_types.c:384
unsigned char u8
Definition: types.h:56
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
ip_sub_address_family_t_
Definition: ip_types.h:41
u8 * format_ip_address_family(u8 *s, va_list *args)
Definition: ip.c:192
vl_api_ip6_address_t ip6
Definition: one.api:424
void ip6_prefix_max_address_host_order(ip6_address_t *ip, u8 plen, ip6_address_t *res)
Definition: ip_types.c:540
Aggregate type for a prefix.
Definition: fib_types.h:202
u8 * format_ip_sub_address_family(u8 *s, va_list *args)
Definition: ip.c:228
struct ip_prefix ip_prefix_t
void ip6_address_normalize(ip6_address_t *ip6, u8 preflen)
Definition: ip_types.c:472
void ip_address_copy_addr(void *dst, const ip_address_t *src)
Definition: ip_types.c:164
unsigned int u32
Definition: types.h:88
void ip6_preflen_to_mask(u8 pref_len, ip6_address_t *mask)
Definition: ip_types.c:518
ip_feature_location_t_
Definition: ip_types.h:69
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
bool ip_prefix_validate(const ip_prefix_t *ip)
Definition: ip_types.c:448
vl_api_ip4_address_t ip4
Definition: one.api:376
vl_api_address_t dst
Definition: gre.api:55
void ip4_preflen_to_mask(u8 pref_len, ip4_address_t *ip)
Definition: ip_types.c:492
uword unformat_ip_address_family(unformat_input_t *input, va_list *args)
Definition: ip.c:208
enum ip_feature_location_t_ ip_feature_location_t
uword unformat_ip_prefix(unformat_input_t *input, va_list *args)
Definition: ip_types.c:64
u8 * ip_addr_bytes(ip_address_t *ip)
Definition: ip_types.c:149
enum ip_sub_address_family_t_ ip_sub_address_family_t
void ip_prefix_to_fib_prefix(const ip_prefix_t *ipp, fib_prefix_t *fibp)
convert from a LISP to a FIB prefix
Definition: ip_types.c:411
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
ip_address_family_t version
Definition: ip_types.h:82
void ip_address_reset(ip_address_t *ip)
Definition: ip_types.c:299
uword unformat_ip_address(unformat_input_t *input, va_list *args)
Definition: ip_types.c:41
ip_address_t addr
Definition: ip_types.h:117
enum ip_address_family_t_ ip_address_family_t
void ip_address_set(ip_address_t *dst, const void *src, u8 version)
Definition: ip_types.c:208
void ip_address_increment(ip_address_t *ip)
Definition: ip_types.c:292
#define foreach_ip_feature_location
Locations in the IP switch path where features can be applied.
Definition: ip_types.h:62
void ip_prefix_normalize(ip_prefix_t *a)
Definition: ip_types.c:358
u64 uword
Definition: types.h:112
ip_address_family_t ip_address_family_from_fib_proto(fib_protocol_t fp)
Definition: ip_types.c:238
ip_address_family_t_
Definition: ip_types.h:21
void ip_address_copy(ip_address_t *dst, const ip_address_t *src)
Definition: ip_types.c:133
uword unformat_ip_sub_address_family(unformat_input_t *input, va_list *args)
Definition: ip.c:244
u32 ip6_mask_to_preflen(ip6_address_t *mask)
Definition: ip_types.c:563
u8 * format_ip_prefix(u8 *s, va_list *args)
Definition: ip_types.c:56
vnet_link_t ip_address_family_to_link_type(ip_address_family_t af)
Definition: ip_types.c:193