]>
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 | |
58255d34 | 35 | #define VRF_UNKNOWN UINT16_MAX |
ece35fdc | 36 | #define VRF_ALL UINT16_MAX - 1 |
b72ede27 | 37 | |
216b18ef DS |
38 | /* Pending: May need to refine this. */ |
39 | #ifndef IFLA_VRF_MAX | |
d62a17ae | 40 | enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX }; |
216b18ef DS |
41 | |
42 | #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1) | |
43 | #endif | |
44 | ||
45 | #define VRF_NAMSIZ 36 | |
46 | ||
47 | #define VRF_DEFAULT_NAME "Default-IP-Routing-Table" | |
48 | ||
8736158a FL |
49 | /* |
50 | * The command strings | |
51 | */ | |
216b18ef | 52 | #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n" |
8736158a | 53 | #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n" |
ecffa493 | 54 | #define VRF_FULL_CMD_HELP_STR "Specify the VRF\nThe VRF name\nAll VRFs\n" |
8736158a | 55 | |
1da29456 DS |
56 | /* |
57 | * Pass some OS specific data up through | |
58 | * to the daemons | |
59 | */ | |
d62a17ae | 60 | struct vrf_data { |
61 | union { | |
62 | struct { | |
63 | uint32_t table_id; | |
64 | } l; | |
65 | }; | |
1da29456 DS |
66 | }; |
67 | ||
d62a17ae | 68 | struct vrf { |
69 | RB_ENTRY(vrf) id_entry, name_entry; | |
1a1a7065 | 70 | |
d62a17ae | 71 | /* Identifier, same as the vector index */ |
72 | vrf_id_t vrf_id; | |
216b18ef | 73 | |
d62a17ae | 74 | /* Name */ |
75 | char name[VRF_NAMSIZ + 1]; | |
216b18ef | 76 | |
d62a17ae | 77 | /* Zebra internal VRF status */ |
78 | u_char status; | |
79694123 | 79 | #define VRF_ACTIVE (1 << 0) |
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 DS |
98 | |
99 | ||
1a1a7065 | 100 | extern struct vrf_id_head vrfs_by_id; |
806f8760 | 101 | extern struct vrf_name_head vrfs_by_name; |
216b18ef | 102 | |
d62a17ae | 103 | extern struct vrf *vrf_lookup_by_id(vrf_id_t); |
104 | extern struct vrf *vrf_lookup_by_name(const char *); | |
105 | extern struct vrf *vrf_get(vrf_id_t, const char *); | |
523cafc4 | 106 | extern const char *vrf_id_to_name(vrf_id_t vrf_id); |
d62a17ae | 107 | extern vrf_id_t vrf_name_to_id(const char *); |
108 | ||
109 | #define VRF_GET_ID(V, NAME) \ | |
110 | do { \ | |
111 | struct vrf *vrf; \ | |
112 | if (!(vrf = vrf_lookup_by_name(NAME))) { \ | |
113 | vty_out(vty, "%% VRF %s not found\n", NAME); \ | |
114 | return CMD_WARNING; \ | |
115 | } \ | |
116 | if (vrf->vrf_id == VRF_UNKNOWN) { \ | |
117 | vty_out(vty, "%% VRF %s not active\n", NAME); \ | |
118 | return CMD_WARNING; \ | |
119 | } \ | |
120 | (V) = vrf->vrf_id; \ | |
121 | } while (0) | |
216b18ef | 122 | |
b72ede27 FL |
123 | /* |
124 | * Utilities to obtain the user data | |
125 | */ | |
126 | ||
127 | /* Get the data pointer of the specified VRF. If not found, create one. */ | |
d62a17ae | 128 | extern void *vrf_info_get(vrf_id_t); |
b72ede27 | 129 | /* Look up the data pointer of the specified VRF. */ |
d62a17ae | 130 | extern void *vrf_info_lookup(vrf_id_t); |
b72ede27 | 131 | |
7076bb2f FL |
132 | /* |
133 | * VRF bit-map: maintaining flags, one bit per VRF ID | |
134 | */ | |
135 | ||
d62a17ae | 136 | typedef void *vrf_bitmap_t; |
7076bb2f FL |
137 | #define VRF_BITMAP_NULL NULL |
138 | ||
d62a17ae | 139 | extern vrf_bitmap_t vrf_bitmap_init(void); |
140 | extern void vrf_bitmap_free(vrf_bitmap_t); | |
141 | extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t); | |
142 | extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t); | |
143 | extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t); | |
7076bb2f | 144 | |
b72ede27 FL |
145 | /* |
146 | * VRF initializer/destructor | |
97b1a80c DS |
147 | * |
148 | * create -> Called back when a new VRF is created. This | |
149 | * can be either through these 3 options: | |
150 | * 1) CLI mentions a vrf before OS knows about it | |
151 | * 2) OS calls zebra and we create the vrf from OS | |
152 | * callback | |
153 | * 3) zebra calls individual protocols to notify | |
154 | * about the new vrf | |
155 | * | |
156 | * enable -> Called back when a VRF is actually usable from | |
157 | * an OS perspective ( 2 and 3 above ) | |
158 | * | |
159 | * disable -> Called back when a VRF is being deleted from | |
160 | * the system ( 2 and 3 ) above | |
161 | * | |
162 | * delete -> Called back when a vrf is being deleted from | |
163 | * the system ( 2 and 3 ) above. | |
b72ede27 | 164 | */ |
d62a17ae | 165 | extern void vrf_init(int (*create)(struct vrf *), int (*enable)(struct vrf *), |
166 | int (*disable)(struct vrf *), int (*delete)(struct vrf *)); | |
97b1a80c DS |
167 | /* |
168 | * Call vrf_terminate when the protocol is being shutdown | |
b72ede27 | 169 | */ |
d62a17ae | 170 | extern void vrf_terminate(void); |
b72ede27 | 171 | |
d62a17ae | 172 | extern void vrf_cmd_init(int (*writefunc)(struct vty *vty)); |
7ddcfca4 | 173 | |
e5bf3e1e FL |
174 | /* |
175 | * VRF utilities | |
176 | */ | |
177 | ||
178 | /* Create a socket serving for the given VRF */ | |
d62a17ae | 179 | extern int vrf_socket(int, int, int, vrf_id_t); |
e5bf3e1e | 180 | |
19dc275e DS |
181 | /* |
182 | * VRF Debugging | |
183 | */ | |
d62a17ae | 184 | extern void vrf_install_commands(void); |
b72ede27 | 185 | #endif /*_ZEBRA_VRF_H*/ |