FD.io VPP  v21.01.1
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 #include <vlibapi/api_types.h>
27 #include <vnet/ip/ip.api_types.h>
28 
29 /**
30  * These enum decode/encodes use 'int' as the type for the enum because
31  * one cannot forward declare an enum
32  */
33 extern int ip_address_family_decode (vl_api_address_family_t af,
34  ip_address_family_t * out);
35 extern vl_api_address_family_t ip_address_family_encode (ip_address_family_t
36  af);
37 extern int ip_proto_decode (vl_api_ip_proto_t ipp, ip_protocol_t * out);
38 extern vl_api_ip_proto_t ip_proto_encode (ip_protocol_t ipp);
39 extern ip_dscp_t ip_dscp_decode (vl_api_ip_dscp_t _dscp);
40 extern vl_api_ip_dscp_t ip_dscp_encode (ip_dscp_t dscp);
41 extern int ip_feature_location_decode (vl_api_ip_feature_location_t in,
42  ip_feature_location_t * out);
43 extern vl_api_ip_feature_location_t
45 
46 /**
47  * Decode/Encode for struct/union types
48  */
49 extern ip46_type_t ip_address_decode (const vl_api_address_t * in,
50  ip46_address_t * out);
51 extern void ip_address_decode2 (const vl_api_address_t * in,
52  ip_address_t * out);
53 extern void ip_address_encode (const ip46_address_t * in,
54  ip46_type_t type, vl_api_address_t * out);
55 extern void ip_address_encode2 (const ip_address_t * in,
56  vl_api_address_t * out);
57 
58 extern void ip6_address_encode (const ip6_address_t * in,
59  vl_api_ip6_address_t out);
60 extern void ip6_address_decode (const vl_api_ip6_address_t in,
61  ip6_address_t * out);
62 extern void ip4_address_encode (const ip4_address_t * in,
63  vl_api_ip4_address_t out);
64 extern void ip4_address_decode (const vl_api_ip4_address_t in,
65  ip4_address_t * out);
66 
67 extern void ip_prefix_decode (const vl_api_prefix_t * in, fib_prefix_t * out);
68 extern void ip_prefix_encode (const fib_prefix_t * in, vl_api_prefix_t * out);
69 extern int ip_prefix_decode2 (const vl_api_prefix_t * in, ip_prefix_t * out);
70 extern void ip_prefix_encode2 (const ip_prefix_t * in, vl_api_prefix_t * out);
71 
72 extern void ip_mprefix_decode (const vl_api_mprefix_t * in,
73  mfib_prefix_t * out);
74 extern void ip_mprefix_encode (const mfib_prefix_t * in,
75  vl_api_mprefix_t * out);
76 
77 #endif
78 
79 /*
80  * fd.io coding-style-patch-verification: ON
81  *
82  * Local Variables:
83  * eval: (c-set-style "gnu")
84  * End:
85  */
vl_api_address_family_t ip_address_family_encode(ip_address_family_t af)
Definition: ip_types_api.c:50
int ip_address_family_decode(vl_api_address_family_t af, ip_address_family_t *out)
Conversion functions to/from (decode/encode) API types to VPP internal types.
Definition: ip_types_api.c:34
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:220
vl_api_ip_dscp_t ip_dscp_encode(ip_dscp_t dscp)
Definition: ip_types_api.c:105
void ip_address_decode2(const vl_api_address_t *in, ip_address_t *out)
Definition: ip_types_api.c:192
Aggregate type for a prefix.
Definition: fib_types.h:202
ip_dscp_t ip_dscp_decode(vl_api_ip_dscp_t _dscp)
Definition: ip_types_api.c:99
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vl_api_ip_dscp_t dscp
Definition: dhcp.api:163
enum ip_protocol ip_protocol_t
vl_api_ip_feature_location_t ip_feature_location_encode(ip_feature_location_t f)
Definition: ip_types_api.c:130
int ip_feature_location_decode(vl_api_ip_feature_location_t in, ip_feature_location_t *out)
Definition: ip_types_api.c:111
vl_api_ip_proto_t ip_proto_encode(ip_protocol_t ipp)
Definition: ip_types_api.c:83
enum ip_feature_location_t_ ip_feature_location_t
void ip4_address_decode(const vl_api_ip4_address_t in, ip4_address_t *out)
Definition: ip_types_api.c:155
int ip_prefix_decode2(const vl_api_prefix_t *in, ip_prefix_t *out)
Definition: ip_types_api.c:276
void ip_prefix_encode(const fib_prefix_t *in, vl_api_prefix_t *out)
Definition: ip_types_api.c:287
Aggregate type for a prefix.
Definition: mfib_types.h:24
void ip_mprefix_encode(const mfib_prefix_t *in, vl_api_mprefix_t *out)
Definition: ip_types_api.c:318
void ip_address_encode2(const ip_address_t *in, vl_api_address_t *out)
Definition: ip_types_api.c:242
void ip4_address_encode(const ip4_address_t *in, vl_api_ip4_address_t out)
Definition: ip_types_api.c:149
void ip6_address_encode(const ip6_address_t *in, vl_api_ip6_address_t out)
Definition: ip_types_api.c:137
enum ip_dscp_t_ ip_dscp_t
int ip_proto_decode(vl_api_ip_proto_t ipp, ip_protocol_t *out)
Definition: ip_types_api.c:65
enum ip_address_family_t_ ip_address_family_t
void ip_prefix_encode2(const ip_prefix_t *in, vl_api_prefix_t *out)
Definition: ip_types_api.c:311
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Decode/Encode for struct/union types.
Definition: ip_types_api.c:186
void ip_mprefix_decode(const vl_api_mprefix_t *in, mfib_prefix_t *out)
Definition: ip_types_api.c:328
void ip6_address_decode(const vl_api_ip6_address_t in, ip6_address_t *out)
Definition: ip_types_api.c:143
void ip_prefix_decode(const vl_api_prefix_t *in, fib_prefix_t *out)
Definition: ip_types_api.c:259
ip46_type_t
Definition: ip46_address.h:22