Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / ce1aae4e88d8ed2c73e8213115cf9f3a4e37370f / . / src / vnet / fib / fib_path.h
blob: 91f49d0923439a83c53a67835980070718fc989e [file] [log] [blame]
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100[diff] [blame]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/**
17 * Given a route of the form;
18 * q.r.s.t/Y
19 * via <interface> <next-hop>
20 *
21 * The prefix is: q.r.s.t./Y
22 * the path is: 'via <interface> <next-hop>
23 *
24 * The path is the description of where to send the traffic, and the
25 * the prefix is a description of which traffic to send.
26 * It is the aim of the FIB to resolve the path, i.e. to find the corresponding
27 * adjacency to match the path's description.
28 */
29
30#ifndef __FIB_PATH_H__
31#define __FIB_PATH_H__
32
33#include <vnet/ip/ip.h>
34#include <vnet/dpo/load_balance.h>
35
36#include <vnet/fib/fib_types.h>
37#include <vnet/adj/adj_types.h>
38
39/**
40 * Enurmeration of path configuration attributes
41 */
42typedef enum fib_path_cfg_attribute_t_ {
43 /**
44 * Marker. Add new types after this one.
45 */
46 FIB_PATH_CFG_ATTRIBUTE_FIRST = 0,
47 /**
48 * The path is forced to a drop, whatever the next-hop info says.
49 * something somewhere knows better...
50 */
51 FIB_PATH_CFG_ATTRIBUTE_DROP = FIB_PATH_CFG_ATTRIBUTE_FIRST,
52 /**
53 * The path uses an adj that is exclusive. I.e. it is known only by
54 * the source of the route.
55 */
56 FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE,
57 /**
58 * Recursion constraint via host
59 */
60 FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST,
61 /**
62 * Recursion constraint via attached
63 */
64 FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED,
65 /**
66 * The path is a for-us path
67 */
68 FIB_PATH_CFG_ATTRIBUTE_LOCAL,
69 /**
70 * Marker. Add new types before this one, then update it.
71 */
72 FIB_PATH_CFG_ATTRIBUTE_LAST = FIB_PATH_CFG_ATTRIBUTE_LOCAL,
73} __attribute__ ((packed)) fib_path_cfg_attribute_t;
74
75/**
76 * The maximum number of path attributes
77 */
78#define FIB_PATH_CFG_ATTRIBUTE_MAX (FIB_PATH_CFG_ATTRIBUTE_LAST + 1)
79
80#define FIB_PATH_CFG_ATTRIBUTES { \
81 [FIB_PATH_CFG_ATTRIBUTE_DROP] = "drop", \
82 [FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
83 [FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST] = "resolve-host", \
84 [FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED] = "resolve-attached", \
85 [FIB_PATH_CFG_ATTRIBUTE_LOCAL] = "local", \
86}
87
88#define FOR_EACH_FIB_PATH_CFG_ATTRIBUTE(_item) \
89 for (_item = FIB_PATH_CFG_ATTRIBUTE_FIRST; \
90 _item <= FIB_PATH_CFG_ATTRIBUTE_LAST; \
91 _item++)
92
93/**
94 * Path config flags from the attributes
95 */
96typedef enum fib_path_cfg_flags_t_ {
97 FIB_PATH_CFG_FLAG_NONE = 0,
98 FIB_PATH_CFG_FLAG_DROP = (1 << FIB_PATH_CFG_ATTRIBUTE_DROP),
99 FIB_PATH_CFG_FLAG_EXCLUSIVE = (1 << FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE),
100 FIB_PATH_CFG_FLAG_RESOLVE_HOST = (1 << FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST),
101 FIB_PATH_CFG_FLAG_RESOLVE_ATTACHED = (1 << FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED),
102 FIB_PATH_CFG_FLAG_LOCAL = (1 << FIB_PATH_CFG_ATTRIBUTE_LOCAL),
103} __attribute__ ((packed)) fib_path_cfg_flags_t;
104
105
106extern u8 *fib_path_format(fib_node_index_t pi, u8 *s);
107extern u8 *fib_path_adj_format(fib_node_index_t pi,
108 u32 indent,
109 u8 *s);
110
111extern u8 * format_fib_path(u8 * s, va_list * args);
112
113extern fib_node_index_t fib_path_create(fib_node_index_t pl_index,
114 fib_protocol_t nh_proto,
115 fib_path_cfg_flags_t flags,
116 const fib_route_path_t *path);
117extern fib_node_index_t fib_path_create_special(fib_node_index_t pl_index,
118 fib_protocol_t nh_proto,
119 fib_path_cfg_flags_t flags,
120 const dpo_id_t *dpo);
121
122extern int fib_path_cmp(fib_node_index_t path_index1,
123 fib_node_index_t path_index2);
124extern int fib_path_cmp_for_sort(void * a1, void * a2);
125extern int fib_path_cmp_w_route_path(fib_node_index_t path_index,
126 const fib_route_path_t *rpath);
127extern fib_node_index_t fib_path_copy(fib_node_index_t path_index,
128 fib_node_index_t path_list_index);
129extern int fib_path_resolve(fib_node_index_t path_index);
130extern int fib_path_is_resolved(fib_node_index_t path_index);
131extern int fib_path_is_recursive(fib_node_index_t path_index);
132extern int fib_path_is_exclusive(fib_node_index_t path_index);
133extern int fib_path_is_deag(fib_node_index_t path_index);
134extern int fib_path_is_looped(fib_node_index_t path_index);
Neale Rannsad422ed2016-11-02 14:20:04 +0000[diff] [blame]135extern fib_protocol_t fib_path_get_proto(fib_node_index_t path_index);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100[diff] [blame]136extern void fib_path_destroy(fib_node_index_t path_index);
137extern uword fib_path_hash(fib_node_index_t path_index);
138extern load_balance_path_t * fib_path_append_nh_for_multipath_hash(
139 fib_node_index_t path_index,
140 fib_forward_chain_type_t fct,
141 load_balance_path_t *hash_key);
142extern void fib_path_contribute_forwarding(fib_node_index_t path_index,
143 fib_forward_chain_type_t type,
144 dpo_id_t *dpo);
Neale Ranns3ee44042016-10-03 13:05:48 +0100[diff] [blame]145extern void fib_path_contribute_urpf(fib_node_index_t path_index,
146 index_t urpf);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100[diff] [blame]147extern adj_index_t fib_path_get_adj(fib_node_index_t path_index);
148extern int fib_path_recursive_loop_detect(fib_node_index_t path_index,
149 fib_node_index_t **entry_indicies);
150extern u32 fib_path_get_resolving_interface(fib_node_index_t fib_entry_index);
151extern int fib_path_get_weight(fib_node_index_t path_index);
152
153extern void fib_path_module_init(void);
Steven01b07122016-11-02 10:40:09 -0700[diff] [blame]154extern int fib_path_encode(fib_node_index_t path_list_index,
155 fib_node_index_t path_index,
156 void *ctx);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100[diff] [blame]157
158#endif