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 struct _vl_api_address;
  31 struct _vl_api_prefix;
  32 struct _vl_api_mprefix;
  33
  34 extern ip46_type_t ip_address_decode (const struct _vl_api_address *in,
  35                                       ip46_address_t * out);
  36 extern void ip_address_encode (const ip46_address_t * in,
  37                                ip46_type_t type, struct _vl_api_address *out);
  38
  39 extern void ip_prefix_decode (const struct _vl_api_prefix *in,
  40                               fib_prefix_t * out);
  41 extern void ip_prefix_encode (const fib_prefix_t * in,
  42                               struct _vl_api_prefix *out);
  43
  44 extern void ip_mprefix_decode (const struct _vl_api_mprefix *in,
  45                                mfib_prefix_t * out);
  46 extern void ip_mprefix_encode (const mfib_prefix_t * in,
  47                                struct _vl_api_mprefix *out);
  48
  49 extern u8 *format_vl_api_address (u8 * s, va_list * args);
  50 extern u8 *format_vl_api_address_union (u8 * s, va_list * args);
  51 extern u8 *format_vl_api_prefix (u8 * s, va_list * args);
  52 extern u8 *format_vl_api_mprefix (u8 * s, va_list * args);
  53
  54 #endif
  55
  56 /*
  57  * fd.io coding-style-patch-verification: ON
  58  *
  59  * Local Variables:
  60  * eval: (c-set-style "gnu")
  61  * End:
  62  */