src/vnet/fib/fib_path_ext.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_PATH_EXT_H__
  17 #define __FIB_PATH_EXT_H__
  18
  19 #include <vnet/mpls/mpls.h>
  20 #include <vnet/fib/fib_types.h>
  21 #include <vnet/dpo/load_balance.h>
  22
  23 /**
  24  * A path extension is a per-entry addition to the forwarding information
  25  * when packets are sent for that entry over that path.
  26  *
  27  * For example:
  28  *    ip route add 1.1.1.1/32 via 10.10.10.10 out-label 100
  29  *
  30  * The out-going MPLS label value 100 is a path-extension. It is a value sepcific
  31  * to the entry 1.1.1.1/32 and valid only when packets are sent via 10.10.10.10.
  32  */
  33 typedef struct fib_path_ext_t_
  34 {
  35     /**
  36      * A description of the path that is being extended.
  37      * This description is used to match this extension with the [changing]
  38      * instance of a fib_path_t that is extended
  39      */
  40     fib_route_path_t fpe_path;
  41 #define fpe_label_stack fpe_path.frp_label_stack
  42
  43     /**
  44      * The index of the path. This is the global index, not the path's
  45      * position in the path-list.
  46      */
  47     fib_node_index_t fpe_path_index;
  48 } fib_path_ext_t;
  49
  50 struct fib_entry_t_;
  51
  52 extern u8 * format_fib_path_ext(u8 * s, va_list * args);
  53
  54 extern void fib_path_ext_init(fib_path_ext_t *path_ext,
  55                               fib_node_index_t path_list_index,
  56                               const fib_route_path_t *rpath);
  57
  58 extern int fib_path_ext_cmp(fib_path_ext_t *path_ext,
  59                             const fib_route_path_t *rpath);
  60
  61 extern void fib_path_ext_resolve(fib_path_ext_t *path_ext,
  62                                  fib_node_index_t path_list_index);
  63
  64 extern load_balance_path_t *fib_path_ext_stack(fib_path_ext_t *path_ext,
  65                                                fib_forward_chain_type_t fct,
  66                                                fib_forward_chain_type_t imp_null_fct,
  67                                                load_balance_path_t *nhs);
  68
  69 #endif
  70