FD.io VPP  v18.10-32-g1161dda
Vector Packet Processing
ip_types_api.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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_types_api.h>
17 
18 #define vl_typedefs /* define message structures */
19 #include <vnet/vnet_all_api_h.h>
20 #undef vl_typedefs
21 
22 #define vl_endianfun /* define message structures */
23 #include <vnet/vnet_all_api_h.h>
24 #undef vl_endianfun
25 
26 /* instantiate all the print functions we know about */
27 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
28 #define vl_printfun
29 #include <vnet/vnet_all_api_h.h>
30 #undef vl_printfun
31 
32 static ip46_type_t
33 ip_address_union_decode (const vl_api_address_union_t * in,
34  vl_api_address_family_t af, ip46_address_t * out)
35 {
36  ip46_type_t type;
37 
38  switch (clib_net_to_host_u32 (af))
39  {
40  case ADDRESS_IP4:
41  memset (out, 0, sizeof (*out));
42  clib_memcpy (&out->ip4, &in->ip4, sizeof (out->ip4));
43  type = IP46_TYPE_IP4;
44  break;
45  case ADDRESS_IP6:
46  clib_memcpy (&out->ip6, &in->ip6, sizeof (out->ip6));
47  type = IP46_TYPE_IP6;
48  break;
49  default:
50  ASSERT (!"Unkown address family in API address type");
51  type = IP46_TYPE_ANY;
52  break;
53  }
54 
55  return type;
56 }
57 
59 ip_address_decode (const vl_api_address_t * in, ip46_address_t * out)
60 {
61  return (ip_address_union_decode (&in->un, in->af, out));
62 }
63 
64 static void
65 ip_address_union_encode (const ip46_address_t * in,
66  vl_api_address_family_t af,
67  vl_api_address_union_t * out)
68 {
69  if (ADDRESS_IP6 == clib_net_to_host_u32 (af))
70  memcpy (out->ip6.address, &in->ip6, sizeof (out->ip6));
71  else
72  memcpy (out->ip4.address, &in->ip4, sizeof (out->ip4));
73 }
74 
75 void
76 ip_address_encode (const ip46_address_t * in,
77  ip46_type_t type, vl_api_address_t * out)
78 {
79  switch (type)
80  {
81  case IP46_TYPE_IP4:
82  out->af = clib_net_to_host_u32 (ADDRESS_IP4);
83  break;
84  case IP46_TYPE_IP6:
85  out->af = clib_net_to_host_u32 (ADDRESS_IP6);
86  break;
87  case IP46_TYPE_ANY:
88  if (ip46_address_is_ip4 (in))
89  out->af = clib_net_to_host_u32 (ADDRESS_IP4);
90  else
91  out->af = clib_net_to_host_u32 (ADDRESS_IP6);
92  break;
93  }
94  ip_address_union_encode (in, out->af, &out->un);
95 }
96 
97 void
98 ip_prefix_decode (const vl_api_prefix_t * in, fib_prefix_t * out)
99 {
100  switch (clib_net_to_host_u32 (in->address.af))
101  {
102  case ADDRESS_IP4:
103  out->fp_proto = FIB_PROTOCOL_IP4;
104  break;
105  case ADDRESS_IP6:
106  out->fp_proto = FIB_PROTOCOL_IP6;
107  break;
108  }
109  out->fp_len = in->address_length;
110  ip_address_decode (&in->address, &out->fp_addr);
111 }
112 
113 void
114 ip_prefix_encode (const fib_prefix_t * in, vl_api_prefix_t * out)
115 {
116  out->address_length = in->fp_len;
118  fib_proto_to_ip46 (in->fp_proto), &out->address);
119 }
120 
121 void
122 ip_mprefix_encode (const mfib_prefix_t * in, vl_api_mprefix_t * out)
123 {
124  out->af = (FIB_PROTOCOL_IP6 == in->fp_proto ? ADDRESS_IP6 : ADDRESS_IP4);
125  out->af = clib_host_to_net_u32 (out->af);
126  out->grp_address_length = clib_host_to_net_u16 (in->fp_len);
127 
128  ip_address_union_encode (&in->fp_grp_addr, out->af, &out->grp_address);
129  ip_address_union_encode (&in->fp_src_addr, out->af, &out->src_address);
130 }
131 
132 void
133 ip_mprefix_decode (const vl_api_mprefix_t * in, mfib_prefix_t * out)
134 {
135  out->fp_proto = (ADDRESS_IP6 == clib_net_to_host_u32 (in->af) ?
137  out->fp_len = clib_net_to_host_u16 (in->grp_address_length);
138 
139  ip_address_union_decode (&in->grp_address, in->af, &out->fp_grp_addr);
140  ip_address_union_decode (&in->src_address, in->af, &out->fp_src_addr);
141 }
142 
143 u8 *
144 format_vl_api_address (u8 * s, va_list * args)
145 {
146  const vl_api_address_t *addr = va_arg (*args, vl_api_address_t *);
147 
148  if (ADDRESS_IP6 == clib_net_to_host_u32 (addr->af))
149  s = format (s, "ip6:%U", format_ip6_address, addr->un.ip6.address);
150  else
151  s = format (s, "ip4:%U", format_ip4_address, addr->un.ip4.address);
152 
153  return s;
154 }
155 
156 u8 *
157 format_vl_api_address_union (u8 * s, va_list * args)
158 {
159  const vl_api_address_union_t *addr =
160  va_arg (*args, vl_api_address_union_t *);
161  vl_api_address_family_t af = va_arg (*args, vl_api_address_family_t);
162 
163  if (ADDRESS_IP6 == af)
164  s = format (s, "ip6:%U", format_ip6_address, addr->ip6.address);
165  else
166  s = format (s, "ip4:%U", format_ip4_address, addr->ip4.address);
167 
168  return s;
169 }
170 
171 u8 *
172 format_vl_api_prefix (u8 * s, va_list * args)
173 {
174  const vl_api_prefix_t *pfx = va_arg (*args, vl_api_prefix_t *);
175 
176  s = format (s, "%U/%d", format_vl_api_address,
177  &pfx->address, pfx->address_length);
178 
179  return s;
180 }
181 
182 /*
183  * fd.io coding-style-patch-verification: ON
184  *
185  * Local Variables:
186  * eval: (c-set-style "gnu")
187  * End:
188  */
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:212
ip46_address_t fp_src_addr
Definition: mfib_types.h:47
static ip46_type_t ip_address_union_decode(const vl_api_address_union_t *in, vl_api_address_family_t af, ip46_address_t *out)
Definition: ip_types_api.c:33
void ip_prefix_decode(const vl_api_prefix_t *in, fib_prefix_t *out)
Definition: ip_types_api.c:98
ip46_type_t fib_proto_to_ip46(fib_protocol_t fproto)
Convert from fib_protocol to ip46_type.
Definition: fib_types.c:287
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
vhost_vring_addr_t addr
Definition: vhost_user.h:121
unsigned char u8
Definition: types.h:56
format_function_t format_ip4_address
Definition: format.h:75
memset(h->entries, 0, sizeof(h->entries[0])*entries)
Aggregrate type for a prefix.
Definition: fib_types.h:203
u8 * format_vl_api_address(u8 *s, va_list *args)
Definition: ip_types_api.c:144
u16 fp_len
The mask length.
Definition: fib_types.h:207
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Definition: ip_types_api.c:59
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:226
#define ip46_address_is_ip4(ip46)
Definition: ip6_packet.h:88
format_function_t format_ip6_address
Definition: format.h:93
void ip_mprefix_encode(const mfib_prefix_t *in, vl_api_mprefix_t *out)
Definition: ip_types_api.c:122
#define clib_memcpy(a, b, c)
Definition: string.h:75
Aggregrate type for a prefix.
Definition: mfib_types.h:24
#define ASSERT(truth)
ip46_type_t
Definition: ip6_packet.h:70
static void ip_address_union_encode(const ip46_address_t *in, vl_api_address_family_t af, vl_api_address_union_t *out)
Definition: ip_types_api.c:65
u8 * format_vl_api_address_union(u8 *s, va_list *args)
Definition: ip_types_api.c:157
void ip_prefix_encode(const fib_prefix_t *in, vl_api_prefix_t *out)
Definition: ip_types_api.c:114
fib_protocol_t fp_proto
protocol type
Definition: mfib_types.h:33
u8 * format_vl_api_prefix(u8 *s, va_list *args)
Definition: ip_types_api.c:172
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:76
u16 fp_len
The mask length.
Definition: mfib_types.h:28
void ip_mprefix_decode(const vl_api_mprefix_t *in, mfib_prefix_t *out)
Definition: ip_types_api.c:133
ip46_address_t fp_grp_addr
The address type is not deriveable from the fp_addr member.
Definition: mfib_types.h:46