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. */
46 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
51 #define VRF_DEFAULT_NAME "Default-IP-Routing-Table"
56 #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n"
57 #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n"
61 RB_ENTRY(vrf
) id_entry
, name_entry
;
63 /* Identifier, same as the vector index */
67 char name
[VRF_NAMSIZ
+ 1];
69 /* Zebra internal VRF status */
71 #define VRF_ACTIVE (1 << 0)
73 /* Master list of interfaces belonging to this VRF */
81 RB_HEAD (vrf_id_head
, vrf
);
82 RB_PROTOTYPE (vrf_id_head
, vrf
, id_entry
, vrf_id_compare
)
83 RB_HEAD (vrf_name_head
, vrf
);
84 RB_PROTOTYPE (vrf_name_head
, vrf
, name_entry
, vrf_name_compare
)
85 DECLARE_QOBJ_TYPE(vrf
)
88 extern struct vrf_id_head vrfs_by_id
;
89 extern struct vrf_name_head vrfs_by_name
;
91 extern struct vrf
*vrf_lookup_by_id (vrf_id_t
);
92 extern struct vrf
*vrf_lookup_by_name (const char *);
93 extern struct vrf
*vrf_get (vrf_id_t
, const char *);
94 extern vrf_id_t
vrf_name_to_id (const char *);
96 #define VRF_GET_ID(V,NAME) \
99 if (!(vrf = vrf_lookup_by_name(NAME))) \
101 vty_out (vty, "%% VRF %s not found%s", NAME, VTY_NEWLINE);\
102 return CMD_WARNING; \
104 if (vrf->vrf_id == VRF_UNKNOWN) \
106 vty_out (vty, "%% VRF %s not active%s", NAME, VTY_NEWLINE);\
107 return CMD_WARNING; \
113 * Utilities to obtain the user data
116 /* Get the data pointer of the specified VRF. If not found, create one. */
117 extern void *vrf_info_get (vrf_id_t
);
118 /* Look up the data pointer of the specified VRF. */
119 extern void *vrf_info_lookup (vrf_id_t
);
122 * Utilities to obtain the interface list
125 /* Look up the interface list of the specified VRF. */
126 extern struct list
*vrf_iflist (vrf_id_t
);
127 /* Get the interface list of the specified VRF. Create one if not find. */
128 extern struct list
*vrf_iflist_get (vrf_id_t
);
131 * VRF bit-map: maintaining flags, one bit per VRF ID
134 typedef void * vrf_bitmap_t
;
135 #define VRF_BITMAP_NULL NULL
137 extern vrf_bitmap_t
vrf_bitmap_init (void);
138 extern void vrf_bitmap_free (vrf_bitmap_t
);
139 extern void vrf_bitmap_set (vrf_bitmap_t
, vrf_id_t
);
140 extern void vrf_bitmap_unset (vrf_bitmap_t
, vrf_id_t
);
141 extern int vrf_bitmap_check (vrf_bitmap_t
, vrf_id_t
);
144 * VRF initializer/destructor
146 * create -> Called back when a new VRF is created. This
147 * can be either through these 3 options:
148 * 1) CLI mentions a vrf before OS knows about it
149 * 2) OS calls zebra and we create the vrf from OS
151 * 3) zebra calls individual protocols to notify
154 * enable -> Called back when a VRF is actually usable from
155 * an OS perspective ( 2 and 3 above )
157 * disable -> Called back when a VRF is being deleted from
158 * the system ( 2 and 3 ) above
160 * delete -> Called back when a vrf is being deleted from
161 * the system ( 2 and 3 ) above.
163 extern void vrf_init (int (*create
)(struct vrf
*),
164 int (*enable
)(struct vrf
*),
165 int (*disable
)(struct vrf
*),
166 int (*delete)(struct vrf
*));
168 * Call vrf_terminate when the protocol is being shutdown
170 extern void vrf_terminate (void);
172 extern void vrf_cmd_init (int (*writefunc
)(struct vty
*vty
));
178 /* Create a socket serving for the given VRF */
179 extern int vrf_socket (int, int, int, vrf_id_t
);
184 extern void vrf_install_commands (void);
185 #endif /*_ZEBRA_VRF_H*/