FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
ip_types_api.h
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 #ifndef __IP_TYPES_API_H__
17 #define __IP_TYPES_API_H__
18 
19 /**
20  * Conversion functions to/from (decode/encode) API types to VPP internal types
21  */
22 
23 #include <vnet/ip/ip.h>
24 #include <vnet/fib/fib_types.h>
25 #include <vnet/mfib/mfib_types.h>
26 
27 /**
28  * Forward declarations so we need not #include the API definitions here
29  */
32 struct _vl_api_address;
33 struct _vl_api_prefix;
34 struct _vl_api_mprefix;
35 
36 /**
37  * These enum decode/encodes use 'int' as the type for the enum because
38  * one cannot forward declare an enum
39  */
40 extern int ip_address_family_decode (int _af, ip_address_family_t * out);
42 extern int ip_proto_decode (int _af, ip_protocol_t * out);
43 extern int ip_proto_encode (ip_protocol_t af);
44 extern ip_dscp_t ip_dscp_decode (u8 _dscp);
45 extern u8 ip_dscp_encode (ip_dscp_t dscp);
46 
47 /**
48  * Decode/Encode for struct/union types
49  */
50 extern ip46_type_t ip_address_decode (const struct _vl_api_address *in,
51  ip46_address_t * out);
52 extern void ip_address_encode (const ip46_address_t * in,
53  ip46_type_t type, struct _vl_api_address *out);
54 extern void ip6_address_encode (const ip6_address_t * in,
56 extern void ip6_address_decode (const vl_api_ip6_address_t in,
57  ip6_address_t * out);
58 extern void ip4_address_encode (const ip4_address_t * in,
60 extern void ip4_address_decode (const vl_api_ip4_address_t in,
61  ip4_address_t * out);
62 
63 extern void ip_prefix_decode (const struct _vl_api_prefix *in,
64  fib_prefix_t * out);
65 extern void ip_prefix_encode (const fib_prefix_t * in,
66  struct _vl_api_prefix *out);
67 
68 extern void ip_mprefix_decode (const struct _vl_api_mprefix *in,
69  mfib_prefix_t * out);
70 extern void ip_mprefix_encode (const mfib_prefix_t * in,
71  struct _vl_api_mprefix *out);
72 
73 #endif
74 
75 /*
76  * fd.io coding-style-patch-verification: ON
77  *
78  * Local Variables:
79  * eval: (c-set-style "gnu")
80  * End:
81  */
void ip_prefix_encode(const fib_prefix_t *in, struct _vl_api_prefix *out)
u8 vl_api_ip6_address_t[16]
Conversion functions to/from (decode/encode) API types to VPP internal types.
Definition: ip_types_api.h:30
enum ip_address_family_t_ ip_address_family_t
unsigned char u8
Definition: types.h:56
void ip_prefix_decode(const struct _vl_api_prefix *in, fib_prefix_t *out)
Aggregate type for a prefix.
Definition: fib_types.h:203
void ip_mprefix_decode(const struct _vl_api_mprefix *in, mfib_prefix_t *out)
vl_api_fib_path_type_t type
Definition: fib_types.api:123
ip_dscp_t ip_dscp_decode(u8 _dscp)
Definition: ip_types_api.c:99
int ip_address_family_encode(ip_address_family_t af)
Definition: ip_types_api.c:51
enum ip_protocol ip_protocol_t
int ip_proto_encode(ip_protocol_t af)
Definition: ip_types_api.c:83
ip46_type_t ip_address_decode(const struct _vl_api_address *in, ip46_address_t *out)
Decode/Encode for struct/union types.
u8 vl_api_ip4_address_t[4]
Definition: ip_types_api.h:31
void ip4_address_decode(const vl_api_ip4_address_t in, ip4_address_t *out)
Definition: ip_types_api.c:129
Aggregate type for a prefix.
Definition: mfib_types.h:24
void ip4_address_encode(const ip4_address_t *in, vl_api_ip4_address_t out)
Definition: ip_types_api.c:123
void ip6_address_encode(const ip6_address_t *in, vl_api_ip6_address_t out)
Definition: ip_types_api.c:111
enum ip_dscp_t_ ip_dscp_t
ip46_type_t
Definition: ip6_packet.h:70
int ip_proto_decode(int _af, ip_protocol_t *out)
Definition: ip_types_api.c:66
void ip_mprefix_encode(const mfib_prefix_t *in, struct _vl_api_mprefix *out)
int ip_address_family_decode(int _af, ip_address_family_t *out)
These enum decode/encodes use &#39;int&#39; as the type for the enum because one cannot forward declare an en...
Definition: ip_types_api.c:34
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, struct _vl_api_address *out)
u8 ip_dscp_encode(ip_dscp_t dscp)
Definition: ip_types_api.c:105
void ip6_address_decode(const vl_api_ip6_address_t in, ip6_address_t *out)
Definition: ip_types_api.c:117