src/vnet/ip/ip_types_api.h

   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  */
  30 typedef u8 vl_api_ip6_address_t[16];
  31 typedef u8 vl_api_ip4_address_t[4];
  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 becuase
  38  * one cannot forward declare an enum
  39  */
  40 extern int ip_address_family_decode (int _af, ip_address_family_t * out);
  41 extern int ip_address_family_encode (ip_address_family_t af);
  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,
  55                                 vl_api_ip6_address_t out);
  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,
  59                                 vl_api_ip4_address_t out);
  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  */