]>
Commit | Line | Data |
---|---|---|
b72ede27 FL |
1 | /* |
2 | * VRF related header. | |
3 | * Copyright (C) 2014 6WIND S.A. | |
4 | * | |
5 | * This file is part of GNU Zebra. | |
6 | * | |
7 | * GNU Zebra is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published | |
9 | * by the Free Software Foundation; either version 2, or (at your | |
10 | * option) any later version. | |
11 | * | |
12 | * GNU Zebra is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | * | |
896014f4 DL |
17 | * You should have received a copy of the GNU General Public License along |
18 | * with this program; see the file COPYING; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
b72ede27 FL |
20 | */ |
21 | ||
22 | #ifndef _ZEBRA_VRF_H | |
23 | #define _ZEBRA_VRF_H | |
24 | ||
1a1a7065 | 25 | #include "openbsd-tree.h" |
8736158a | 26 | #include "linklist.h" |
e80e7cce | 27 | #include "qobj.h" |
7ddcfca4 | 28 | #include "vty.h" |
8736158a | 29 | |
216b18ef DS |
30 | /* The default NS ID */ |
31 | #define NS_DEFAULT 0 | |
32 | ||
b72ede27 FL |
33 | /* The default VRF ID */ |
34 | #define VRF_DEFAULT 0 | |
a9ff90c4 | 35 | #define VRF_UNKNOWN UINT32_MAX |
b72ede27 | 36 | |
216b18ef DS |
37 | /* Pending: May need to refine this. */ |
38 | #ifndef IFLA_VRF_MAX | |
d62a17ae | 39 | enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX }; |
216b18ef DS |
40 | |
41 | #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1) | |
42 | #endif | |
43 | ||
44 | #define VRF_NAMSIZ 36 | |
45 | ||
46 | #define VRF_DEFAULT_NAME "Default-IP-Routing-Table" | |
47 | ||
8736158a FL |
48 | /* |
49 | * The command strings | |
50 | */ | |
216b18ef | 51 | #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n" |
8736158a | 52 | #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n" |
ecffa493 | 53 | #define VRF_FULL_CMD_HELP_STR "Specify the VRF\nThe VRF name\nAll VRFs\n" |
8736158a | 54 | |
1da29456 DS |
55 | /* |
56 | * Pass some OS specific data up through | |
57 | * to the daemons | |
58 | */ | |
d62a17ae | 59 | struct vrf_data { |
60 | union { | |
61 | struct { | |
62 | uint32_t table_id; | |
63 | } l; | |
64 | }; | |
1da29456 DS |
65 | }; |
66 | ||
d62a17ae | 67 | struct vrf { |
68 | RB_ENTRY(vrf) id_entry, name_entry; | |
1a1a7065 | 69 | |
d62a17ae | 70 | /* Identifier, same as the vector index */ |
71 | vrf_id_t vrf_id; | |
216b18ef | 72 | |
d62a17ae | 73 | /* Name */ |
74 | char name[VRF_NAMSIZ + 1]; | |
216b18ef | 75 | |
d62a17ae | 76 | /* Zebra internal VRF status */ |
77 | u_char status; | |
84915b0a | 78 | #define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */ |
22bd3e94 | 79 | #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */ |
216b18ef | 80 | |
f4e14fdb RW |
81 | /* Interfaces belonging to this VRF */ |
82 | struct if_name_head ifaces_by_name; | |
ff880b78 | 83 | struct if_index_head ifaces_by_index; |
216b18ef | 84 | |
d62a17ae | 85 | /* User data */ |
86 | void *info; | |
e80e7cce | 87 | |
d62a17ae | 88 | /* The table_id from the kernel */ |
89 | struct vrf_data data; | |
1da29456 | 90 | |
d62a17ae | 91 | QOBJ_FIELDS |
216b18ef | 92 | }; |
d62a17ae | 93 | RB_HEAD(vrf_id_head, vrf); |
94 | RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare) | |
95 | RB_HEAD(vrf_name_head, vrf); | |
96 | RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare) | |
e80e7cce | 97 | DECLARE_QOBJ_TYPE(vrf) |
216b18ef | 98 | |
78dd30b2 PG |
99 | /* Allow VRF with netns as backend */ |
100 | #define VRF_BACKEND_VRF_LITE 0 | |
101 | #define VRF_BACKEND_NETNS 1 | |
216b18ef | 102 | |
1a1a7065 | 103 | extern struct vrf_id_head vrfs_by_id; |
806f8760 | 104 | extern struct vrf_name_head vrfs_by_name; |
216b18ef | 105 | |
d62a17ae | 106 | extern struct vrf *vrf_lookup_by_id(vrf_id_t); |
107 | extern struct vrf *vrf_lookup_by_name(const char *); | |
108 | extern struct vrf *vrf_get(vrf_id_t, const char *); | |
523cafc4 | 109 | extern const char *vrf_id_to_name(vrf_id_t vrf_id); |
d62a17ae | 110 | extern vrf_id_t vrf_name_to_id(const char *); |
111 | ||
112 | #define VRF_GET_ID(V, NAME) \ | |
113 | do { \ | |
114 | struct vrf *vrf; \ | |
115 | if (!(vrf = vrf_lookup_by_name(NAME))) { \ | |
116 | vty_out(vty, "%% VRF %s not found\n", NAME); \ | |
117 | return CMD_WARNING; \ | |
118 | } \ | |
119 | if (vrf->vrf_id == VRF_UNKNOWN) { \ | |
120 | vty_out(vty, "%% VRF %s not active\n", NAME); \ | |
121 | return CMD_WARNING; \ | |
122 | } \ | |
123 | (V) = vrf->vrf_id; \ | |
124 | } while (0) | |
216b18ef | 125 | |
84915b0a | 126 | /* |
127 | * Check whether the VRF is enabled. | |
128 | */ | |
129 | static inline int vrf_is_enabled(struct vrf *vrf) | |
130 | { | |
131 | return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE); | |
132 | } | |
133 | ||
134 | /* check if the vrf is user configured */ | |
135 | static inline int vrf_is_user_cfged(struct vrf *vrf) | |
136 | { | |
137 | return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED); | |
138 | } | |
139 | ||
22bd3e94 | 140 | /* Mark that VRF has user configuration */ |
141 | static inline void vrf_set_user_cfged(struct vrf *vrf) | |
142 | { | |
143 | SET_FLAG(vrf->status, VRF_CONFIGURED); | |
144 | } | |
145 | ||
146 | /* Mark that VRF no longer has any user configuration */ | |
147 | static inline void vrf_reset_user_cfged(struct vrf *vrf) | |
148 | { | |
149 | UNSET_FLAG(vrf->status, VRF_CONFIGURED); | |
150 | } | |
151 | ||
b72ede27 FL |
152 | /* |
153 | * Utilities to obtain the user data | |
154 | */ | |
155 | ||
156 | /* Get the data pointer of the specified VRF. If not found, create one. */ | |
d62a17ae | 157 | extern void *vrf_info_get(vrf_id_t); |
b72ede27 | 158 | /* Look up the data pointer of the specified VRF. */ |
d62a17ae | 159 | extern void *vrf_info_lookup(vrf_id_t); |
b72ede27 | 160 | |
7076bb2f FL |
161 | /* |
162 | * VRF bit-map: maintaining flags, one bit per VRF ID | |
163 | */ | |
164 | ||
d62a17ae | 165 | typedef void *vrf_bitmap_t; |
7076bb2f FL |
166 | #define VRF_BITMAP_NULL NULL |
167 | ||
d62a17ae | 168 | extern vrf_bitmap_t vrf_bitmap_init(void); |
169 | extern void vrf_bitmap_free(vrf_bitmap_t); | |
170 | extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t); | |
171 | extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t); | |
172 | extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t); | |
7076bb2f | 173 | |
b72ede27 FL |
174 | /* |
175 | * VRF initializer/destructor | |
97b1a80c DS |
176 | * |
177 | * create -> Called back when a new VRF is created. This | |
178 | * can be either through these 3 options: | |
179 | * 1) CLI mentions a vrf before OS knows about it | |
180 | * 2) OS calls zebra and we create the vrf from OS | |
181 | * callback | |
182 | * 3) zebra calls individual protocols to notify | |
183 | * about the new vrf | |
184 | * | |
185 | * enable -> Called back when a VRF is actually usable from | |
186 | * an OS perspective ( 2 and 3 above ) | |
187 | * | |
188 | * disable -> Called back when a VRF is being deleted from | |
189 | * the system ( 2 and 3 ) above | |
190 | * | |
191 | * delete -> Called back when a vrf is being deleted from | |
192 | * the system ( 2 and 3 ) above. | |
b72ede27 | 193 | */ |
d62a17ae | 194 | extern void vrf_init(int (*create)(struct vrf *), int (*enable)(struct vrf *), |
195 | int (*disable)(struct vrf *), int (*delete)(struct vrf *)); | |
97b1a80c DS |
196 | /* |
197 | * Call vrf_terminate when the protocol is being shutdown | |
b72ede27 | 198 | */ |
d62a17ae | 199 | extern void vrf_terminate(void); |
b72ede27 | 200 | |
d62a17ae | 201 | extern void vrf_cmd_init(int (*writefunc)(struct vty *vty)); |
7ddcfca4 | 202 | |
e5bf3e1e FL |
203 | /* |
204 | * VRF utilities | |
205 | */ | |
206 | ||
207 | /* Create a socket serving for the given VRF */ | |
d62a17ae | 208 | extern int vrf_socket(int, int, int, vrf_id_t); |
78dd30b2 PG |
209 | extern void vrf_configure_backend(int vrf_backend_netns); |
210 | extern int vrf_get_backend(void); | |
211 | extern int vrf_is_backend_netns(void); | |
e5bf3e1e | 212 | |
19dc275e DS |
213 | /* |
214 | * VRF Debugging | |
215 | */ | |
d62a17ae | 216 | extern void vrf_install_commands(void); |
b72ede27 | 217 | #endif /*_ZEBRA_VRF_H*/ |