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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __IP_TYPES_API_H__
17 #define __IP_TYPES_API_H__
20 * Conversion functions to/from (decode/encode) API types to VPP internal types
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>
30 * These enum decode/encodes use 'int' as the type for the enum because
31 * one cannot forward declare an enum
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
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);
43 * Decode/Encode for struct/union types
45 extern ip46_type_t ip_address_decode (const vl_api_address_t * in,
46 ip46_address_t * out);
47 extern void ip_address_decode2 (const vl_api_address_t * in,
49 extern void ip_address_encode (const ip46_address_t * in,
50 ip46_type_t type, vl_api_address_t * out);
51 extern void ip_address_encode2 (const ip_address_t * in,
52 vl_api_address_t * out);
54 extern void ip6_address_encode (const ip6_address_t * in,
55 vl_api_ip6_address_t out);
56 extern void ip6_address_decode (const vl_api_ip6_address_t in,
58 extern void ip4_address_encode (const ip4_address_t * in,
59 vl_api_ip4_address_t out);
60 extern void ip4_address_decode (const vl_api_ip4_address_t in,
63 extern void ip_prefix_decode (const vl_api_prefix_t * in, fib_prefix_t * out);
64 extern void ip_prefix_encode (const fib_prefix_t * in, vl_api_prefix_t * out);
65 extern int ip_prefix_decode2 (const vl_api_prefix_t * in, ip_prefix_t * out);
66 extern void ip_prefix_encode2 (const ip_prefix_t * in, vl_api_prefix_t * out);
68 extern void ip_mprefix_decode (const vl_api_mprefix_t * in,
70 extern void ip_mprefix_encode (const mfib_prefix_t * in,
71 vl_api_mprefix_t * out);
76 * fd.io coding-style-patch-verification: ON
79 * eval: (c-set-style "gnu")