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 #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 (int _af, ip_address_family_t * out);
  34 extern int ip_address_family_encode (ip_address_family_t af);
  35 extern int ip_proto_decode (int _af, ip_protocol_t * out);
  36 extern int ip_proto_encode (ip_protocol_t af);
  37 extern ip_dscp_t ip_dscp_decode (u8 _dscp);
  38 extern u8 ip_dscp_encode (ip_dscp_t dscp);
  39
  40 /**
  41  * Decode/Encode for struct/union types
  42  */
  43 extern ip46_type_t ip_address_decode (const vl_api_address_t * in,
  44                                       ip46_address_t * out);
  45 extern void ip_address_encode (const ip46_address_t * in,
  46                                ip46_type_t type, vl_api_address_t * out);
  47 extern void ip_address_decode2 (const vl_api_address_t * in,
  48                                 ip_address_t * out);
  49 extern void ip_address_encode2 (const ip_address_t * in,
  50                                 vl_api_address_t * out);
  51 extern void ip6_address_encode (const ip6_address_t * in,
  52                                 vl_api_ip6_address_t out);
  53 extern void ip6_address_decode (const vl_api_ip6_address_t in,
  54                                 ip6_address_t * out);
  55 extern void ip4_address_encode (const ip4_address_t * in,
  56                                 vl_api_ip4_address_t out);
  57 extern void ip4_address_decode (const vl_api_ip4_address_t in,
  58                                 ip4_address_t * out);
  59
  60 extern void ip_prefix_decode (const vl_api_prefix_t * in, fib_prefix_t * out);
  61 extern void ip_prefix_encode (const fib_prefix_t * in, vl_api_prefix_t * out);
  62
  63 extern void ip_mprefix_decode (const vl_api_mprefix_t * in,
  64                                mfib_prefix_t * out);
  65 extern void ip_mprefix_encode (const mfib_prefix_t * in,
  66                                vl_api_mprefix_t * out);
  67
  68 #endif
  69
  70 /*
  71  * fd.io coding-style-patch-verification: ON
  72  *
  73  * Local Variables:
  74  * eval: (c-set-style "gnu")
  75  * End:
  76  */