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
  28 /**
  29  * Forward declarations so we need not #include the API definitions here
  30  */
  31 typedef u8 vl_api_ip6_address_t[16];
  32 typedef u8 vl_api_ip4_address_t[4];
  33 struct _vl_api_address;
  34 struct _vl_api_prefix;
  35 struct _vl_api_mprefix;
  36
  37 extern ip46_type_t ip_address_decode (const struct _vl_api_address *in,
  38                                       ip46_address_t * out);
  39 extern void ip_address_encode (const ip46_address_t * in,
  40                                ip46_type_t type, struct _vl_api_address *out);
  41 extern void ip6_address_encode (const ip6_address_t * in,
  42                                 vl_api_ip6_address_t out);
  43 extern void ip6_address_decode (const vl_api_ip6_address_t in,
  44                                 ip6_address_t * out);
  45 extern void ip4_address_encode (const ip4_address_t * in,
  46                                 vl_api_ip4_address_t out);
  47 extern void ip4_address_decode (const vl_api_ip4_address_t in,
  48                                 ip4_address_t * out);
  49
  50 extern void ip_prefix_decode (const struct _vl_api_prefix *in,
  51                               fib_prefix_t * out);
  52 extern void ip_prefix_encode (const fib_prefix_t * in,
  53                               struct _vl_api_prefix *out);
  54
  55 extern void ip_mprefix_decode (const struct _vl_api_mprefix *in,
  56                                mfib_prefix_t * out);
  57 extern void ip_mprefix_encode (const mfib_prefix_t * in,
  58                                struct _vl_api_mprefix *out);
  59
  60 #endif
  61
  62 /*
  63  * fd.io coding-style-patch-verification: ON
  64  *
  65  * Local Variables:
  66  * eval: (c-set-style "gnu")
  67  * End:
  68  */