2 * Copyright (c) 2015 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __MPLS_TUNNEL_H__
17 #define __MPLS_TUNNEL_H__
19 #include <vnet/mpls/mpls.h>
20 #include <vnet/fib/fib_path_ext.h>
22 typedef enum mpls_tunnel_attribute_t_
24 MPLS_TUNNEL_ATTRIBUTE_FIRST = 0,
26 * @brief The tunnel has an underlying multicast LSP
28 MPLS_TUNNEL_ATTRIBUTE_MCAST = MPLS_TUNNEL_ATTRIBUTE_FIRST,
29 MPLS_TUNNEL_ATTRIBUTE_LAST = MPLS_TUNNEL_ATTRIBUTE_MCAST,
30 } mpls_tunnel_attribute_t;
32 #define MPLS_TUNNEL_ATTRIBUTES { \
33 [MPLS_TUNNEL_ATTRIBUTE_MCAST] = "multicast", \
35 #define FOR_EACH_MPLS_TUNNEL_ATTRIBUTE(_item) \
36 for (_item = MPLS_TUNNEL_ATTRIBUTE_FIRST; \
37 _item <= MPLS_TUNNEL_ATTRIBUTE_LAST; \
40 typedef enum mpls_tunnel_flag_t_ {
41 MPLS_TUNNEL_FLAG_NONE = 0,
42 MPLS_TUNNEL_FLAG_MCAST = (1 << MPLS_TUNNEL_ATTRIBUTE_MCAST),
43 } __attribute__ ((packed)) mpls_tunnel_flags_t;
47 * @brief A uni-directional MPLS tunnel
49 typedef struct mpls_tunnel_t_
52 * @brief The tunnel hooks into the FIB control plane graph.
59 mpls_tunnel_flags_t mt_flags;
62 * @brief If the tunnel is an L2 tunnel, this is the link type ETHERNET
65 adj_index_t mt_l2_adj;
68 * @brief on a L2 tunnel this is the VLIB arc from the L2-tx to the l2-midchain
73 * @brief The path-list over which the tunnel's destination is reachable
75 fib_node_index_t mt_path_list;
78 * @brief sibling index on the path-list so notifications are received.
83 * A vector of path extensions o hold the label stack for each path
85 fib_path_ext_t *mt_path_exts;
88 * @brief Flag to indicate the tunnel is only for L2 traffic, that is
89 * this tunnel belongs in a bridge domain.
94 * @brief The HW interface index of the tunnel interfaces
99 * @brief The SW interface index of the tunnel interfaces
106 * @brief Create a new MPLS tunnel
107 * @return the SW Interface index of the newly created tuneel
109 extern u32 vnet_mpls_tunnel_create (u8 l2_only,
113 * @brief Add a path to an MPLS tunnel
115 extern void vnet_mpls_tunnel_path_add (u32 sw_if_index,
116 fib_route_path_t *rpath);
119 * @brief remove a path from a tunnel.
120 * @return the number of remaining paths. 0 implies the tunnel can be deleted
122 extern int vnet_mpls_tunnel_path_remove (u32 sw_if_index,
123 fib_route_path_t *rpath);
126 * @brief Delete an MPLS tunnel
128 extern void vnet_mpls_tunnel_del (u32 sw_if_index);
130 extern const mpls_tunnel_t *mpls_tunnel_get(u32 index);
133 * @brief Callback function invoked while walking MPLS tunnels
135 typedef void (*mpls_tunnel_walk_cb_t)(u32 index, void *ctx);
138 * @brief Walk all the MPLS tunnels
140 extern void mpls_tunnel_walk(mpls_tunnel_walk_cb_t cb,