src/vnet/fib/fib_api.h

   1 /*
   2  * Copyright (c) 2016 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 __FIB_API_H__
  17 #define __FIB_API_H__
  18
  19 #include <vnet/fib/fib_types.h>
  20 #include <vnet/fib/fib_entry.h>
  21 #include <vnet/ip/ip.api_types.h>
  22
  23 /**
  24  * Forward declare the API type, no need to include the generated api headers
  25  */
  26 struct _vl_api_fib_path;
  27 struct _vl_api_fib_prefix;
  28
  29 /**
  30  * Encode and decode functions from the API types to internal types
  31  */
  32 extern vl_api_fib_path_nh_proto_t fib_api_path_dpo_proto_to_nh (dpo_proto_t dproto);
  33 extern int fib_api_path_nh_proto_to_dpo (vl_api_fib_path_nh_proto_t pp, dpo_proto_t *dproto);
  34 extern void fib_api_path_encode(const fib_route_path_t * api_rpath,
  35                                 vl_api_fib_path_t *out);
  36 extern int fib_api_path_decode(vl_api_fib_path_t *in,
  37                                fib_route_path_t *out);
  38
  39 extern int fib_api_table_id_decode(fib_protocol_t fproto,
  40                                    u32 table_id,
  41                                    u32 *fib_index);
  42
  43 /**
  44  * Adding routes from the API
  45  */
  46 extern int fib_api_route_add_del (u8 is_add,
  47                                   u8 is_multipath,
  48                                   u32 fib_index,
  49                                   const fib_prefix_t * prefix,
  50                                   fib_source_t src,
  51                                   fib_entry_flag_t entry_flags,
  52                                   fib_route_path_t *rpaths);
  53
  54 extern u8* format_vl_api_fib_path(u8 * s, va_list * args);
  55
  56
  57 extern int fib_proto_from_api_address_family (vl_api_address_family_t af, fib_protocol_t *out);
  58 extern vl_api_address_family_t fib_proto_to_api_address_family (fib_protocol_t fproto);
  59
  60 #endif /* __FIB_API_H__ */