FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
fib_path_ext.h
Go to the documentation of this file.
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 
22 /**
23  * A path extension is a per-entry addition to the forwarding information
24  * when packets are sent for that entry over that path.
25  *
26  * For example:
27  * ip route add 1.1.1.1/32 via 10.10.10.10 out-label 100
28  *
29  * The out-going MPLS label value 100 is a path-extension. It is a value sepcific
30  * to the entry 1.1.1.1/32 and valid only when packets are sent via 10.10.10.10.
31  */
32 typedef struct fib_path_ext_t_
33 {
34  /**
35  * A description of the path that is being extended.
36  * This description is used to match this extension with the [changing]
37  * instance of a fib_path_t that is extended
38  */
40 #define fpe_label_stack fpe_path.frp_label_stack
41 
42  /**
43  * The index of the path. This is the global index, not the path's
44  * position in the path-list.
45  */
48 
49 struct fib_entry_t_;
50 
51 extern u8 * format_fib_path_ext(u8 * s, va_list * args);
52 
53 extern void fib_path_ext_init(fib_path_ext_t *path_ext,
54  fib_node_index_t path_list_index,
55  const fib_route_path_t *rpath);
56 
57 extern int fib_path_ext_cmp(fib_path_ext_t *path_ext,
58  const fib_route_path_t *rpath);
59 
60 extern void fib_path_ext_resolve(fib_path_ext_t *path_ext,
61  fib_node_index_t path_list_index);
62 
64  const struct fib_entry_t_ *entry,
66  load_balance_path_t *nhs);
67 
68 #endif
69 
An entry in a FIB table.
Definition: fib_entry.h:361
A representation of a path as described by a route producer.
Definition: fib_types.h:285
load_balance_path_t * fib_path_ext_stack(fib_path_ext_t *path_ext, const struct fib_entry_t_ *entry, fib_forward_chain_type_t fct, load_balance_path_t *nhs)
u8 * format_fib_path_ext(u8 *s, va_list *args)
Definition: fib_path_ext.c:28
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:28
void fib_path_ext_resolve(fib_path_ext_t *path_ext, fib_node_index_t path_list_index)
Definition: fib_path_ext.c:71
void fib_path_ext_init(fib_path_ext_t *path_ext, fib_node_index_t path_list_index, const fib_route_path_t *rpath)
Definition: fib_path_ext.c:84
enum fib_forward_chain_type_t_ fib_forward_chain_type_t
FIB output chain type.
unsigned char u8
Definition: types.h:56
fib_node_index_t fpe_path_index
The index of the path.
Definition: fib_path_ext.h:46
One path from an [EU]CMP set that the client wants to add to a load-balance object.
Definition: load_balance.h:61
int fib_path_ext_cmp(fib_path_ext_t *path_ext, const fib_route_path_t *rpath)
Definition: fib_path_ext.c:47
struct fib_path_ext_t_ fib_path_ext_t
A path extension is a per-entry addition to the forwarding information when packets are sent for that...
A path extension is a per-entry addition to the forwarding information when packets are sent for that...
Definition: fib_path_ext.h:32
fib_route_path_t fpe_path
A description of the path that is being extended.
Definition: fib_path_ext.h:39