3 * Copyright (C) 2014 6WIND S.A.
5 * This file is part of GNU Zebra.
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.
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.
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
25 #include "openbsd-tree.h"
30 /* The default NS ID */
33 /* The default VRF ID */
35 #define VRF_UNKNOWN UINT16_MAX
36 #define VRF_ALL UINT16_MAX - 1
38 /* Pending: May need to refine this. */
40 enum { IFLA_VRF_UNSPEC
, IFLA_VRF_TABLE
, __IFLA_VRF_MAX
};
42 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
47 #define VRF_DEFAULT_NAME "Default-IP-Routing-Table"
52 #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n"
53 #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n"
56 * Pass some OS specific data up through
68 RB_ENTRY(vrf
) id_entry
, name_entry
;
70 /* Identifier, same as the vector index */
74 char name
[VRF_NAMSIZ
+ 1];
76 /* Zebra internal VRF status */
78 #define VRF_ACTIVE (1 << 0)
80 /* Master list of interfaces belonging to this VRF */
86 /* The table_id from the kernel */
91 RB_HEAD(vrf_id_head
, vrf
);
92 RB_PROTOTYPE(vrf_id_head
, vrf
, id_entry
, vrf_id_compare
)
93 RB_HEAD(vrf_name_head
, vrf
);
94 RB_PROTOTYPE(vrf_name_head
, vrf
, name_entry
, vrf_name_compare
)
95 DECLARE_QOBJ_TYPE(vrf
)
98 extern struct vrf_id_head vrfs_by_id
;
99 extern struct vrf_name_head vrfs_by_name
;
101 extern struct vrf
*vrf_lookup_by_id(vrf_id_t
);
102 extern struct vrf
*vrf_lookup_by_name(const char *);
103 extern struct vrf
*vrf_get(vrf_id_t
, const char *);
104 extern vrf_id_t
vrf_name_to_id(const char *);
106 #define VRF_GET_ID(V, NAME) \
109 if (!(vrf = vrf_lookup_by_name(NAME))) { \
110 vty_out(vty, "%% VRF %s not found\n", NAME); \
111 return CMD_WARNING; \
113 if (vrf->vrf_id == VRF_UNKNOWN) { \
114 vty_out(vty, "%% VRF %s not active\n", NAME); \
115 return CMD_WARNING; \
121 * Utilities to obtain the user data
124 /* Get the data pointer of the specified VRF. If not found, create one. */
125 extern void *vrf_info_get(vrf_id_t
);
126 /* Look up the data pointer of the specified VRF. */
127 extern void *vrf_info_lookup(vrf_id_t
);
130 * Utilities to obtain the interface list
133 /* Look up the interface list of the specified VRF. */
134 extern struct list
*vrf_iflist(vrf_id_t
);
135 /* Get the interface list of the specified VRF. Create one if not find. */
136 extern struct list
*vrf_iflist_get(vrf_id_t
);
139 * VRF bit-map: maintaining flags, one bit per VRF ID
142 typedef void *vrf_bitmap_t
;
143 #define VRF_BITMAP_NULL NULL
145 extern vrf_bitmap_t
vrf_bitmap_init(void);
146 extern void vrf_bitmap_free(vrf_bitmap_t
);
147 extern void vrf_bitmap_set(vrf_bitmap_t
, vrf_id_t
);
148 extern void vrf_bitmap_unset(vrf_bitmap_t
, vrf_id_t
);
149 extern int vrf_bitmap_check(vrf_bitmap_t
, vrf_id_t
);
152 * VRF initializer/destructor
154 * create -> Called back when a new VRF is created. This
155 * can be either through these 3 options:
156 * 1) CLI mentions a vrf before OS knows about it
157 * 2) OS calls zebra and we create the vrf from OS
159 * 3) zebra calls individual protocols to notify
162 * enable -> Called back when a VRF is actually usable from
163 * an OS perspective ( 2 and 3 above )
165 * disable -> Called back when a VRF is being deleted from
166 * the system ( 2 and 3 ) above
168 * delete -> Called back when a vrf is being deleted from
169 * the system ( 2 and 3 ) above.
171 extern void vrf_init(int (*create
)(struct vrf
*), int (*enable
)(struct vrf
*),
172 int (*disable
)(struct vrf
*), int (*delete)(struct vrf
*));
174 * Call vrf_terminate when the protocol is being shutdown
176 extern void vrf_terminate(void);
178 extern void vrf_cmd_init(int (*writefunc
)(struct vty
*vty
));
184 /* Create a socket serving for the given VRF */
185 extern int vrf_socket(int, int, int, vrf_id_t
);
190 extern void vrf_install_commands(void);
191 #endif /*_ZEBRA_VRF_H*/