]>
Commit | Line | Data |
---|---|---|
1 | /* Route map function. | |
2 | * Copyright (C) 1998 Kunihiro Ishiguro | |
3 | * | |
4 | * This file is part of GNU Zebra. | |
5 | * | |
6 | * GNU Zebra is free software; you can redistribute it and/or modify it | |
7 | * under the terms of the GNU General Public License as published by the | |
8 | * Free Software Foundation; either version 2, or (at your option) any | |
9 | * later version. | |
10 | * | |
11 | * GNU Zebra is distributed in the hope that it will be useful, but | |
12 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 | * General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License along | |
17 | * with this program; see the file COPYING; if not, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
21 | #ifndef _ZEBRA_ROUTEMAP_H | |
22 | #define _ZEBRA_ROUTEMAP_H | |
23 | ||
24 | #include "prefix.h" | |
25 | #include "memory.h" | |
26 | #include "qobj.h" | |
27 | #include "vty.h" | |
28 | ||
29 | DECLARE_MTYPE(ROUTE_MAP_NAME) | |
30 | DECLARE_MTYPE(ROUTE_MAP_RULE) | |
31 | DECLARE_MTYPE(ROUTE_MAP_COMPILED) | |
32 | ||
33 | /* Route map's type. */ | |
34 | enum route_map_type { RMAP_PERMIT, RMAP_DENY, RMAP_ANY }; | |
35 | ||
36 | typedef enum { | |
37 | RMAP_MATCH, | |
38 | RMAP_DENYMATCH, | |
39 | RMAP_NOMATCH, | |
40 | RMAP_ERROR, | |
41 | RMAP_OKAY | |
42 | } route_map_result_t; | |
43 | ||
44 | typedef enum { | |
45 | RMAP_RIP, | |
46 | RMAP_RIPNG, | |
47 | RMAP_OSPF, | |
48 | RMAP_OSPF6, | |
49 | RMAP_BGP, | |
50 | RMAP_ZEBRA, | |
51 | RMAP_ISIS, | |
52 | } route_map_object_t; | |
53 | ||
54 | typedef enum { RMAP_EXIT, RMAP_GOTO, RMAP_NEXT } route_map_end_t; | |
55 | ||
56 | typedef enum { | |
57 | RMAP_EVENT_SET_ADDED, | |
58 | RMAP_EVENT_SET_DELETED, | |
59 | RMAP_EVENT_SET_REPLACED, | |
60 | RMAP_EVENT_MATCH_ADDED, | |
61 | RMAP_EVENT_MATCH_DELETED, | |
62 | RMAP_EVENT_MATCH_REPLACED, | |
63 | RMAP_EVENT_INDEX_ADDED, | |
64 | RMAP_EVENT_INDEX_DELETED, | |
65 | RMAP_EVENT_CALL_ADDED, /* call to another routemap added */ | |
66 | RMAP_EVENT_CALL_DELETED, | |
67 | RMAP_EVENT_PLIST_ADDED, | |
68 | RMAP_EVENT_PLIST_DELETED, | |
69 | RMAP_EVENT_CLIST_ADDED, | |
70 | RMAP_EVENT_CLIST_DELETED, | |
71 | RMAP_EVENT_ECLIST_ADDED, | |
72 | RMAP_EVENT_ECLIST_DELETED, | |
73 | RMAP_EVENT_LLIST_ADDED, | |
74 | RMAP_EVENT_LLIST_DELETED, | |
75 | RMAP_EVENT_ASLIST_ADDED, | |
76 | RMAP_EVENT_ASLIST_DELETED, | |
77 | RMAP_EVENT_FILTER_ADDED, | |
78 | RMAP_EVENT_FILTER_DELETED, | |
79 | } route_map_event_t; | |
80 | ||
81 | /* Depth limit in RMAP recursion using RMAP_CALL. */ | |
82 | #define RMAP_RECURSION_LIMIT 10 | |
83 | ||
84 | /* Route map rule structure for matching and setting. */ | |
85 | struct route_map_rule_cmd { | |
86 | /* Route map rule name (e.g. as-path, metric) */ | |
87 | const char *str; | |
88 | ||
89 | /* Function for value set or match. */ | |
90 | route_map_result_t (*func_apply)(void *rule, | |
91 | const struct prefix *prefix, | |
92 | route_map_object_t type, | |
93 | void *object); | |
94 | ||
95 | /* Compile argument and return result as void *. */ | |
96 | void *(*func_compile)(const char *); | |
97 | ||
98 | /* Free allocated value by func_compile (). */ | |
99 | void (*func_free)(void *); | |
100 | }; | |
101 | ||
102 | /* Route map apply error. */ | |
103 | enum { RMAP_COMPILE_SUCCESS, | |
104 | ||
105 | /* Route map rule is missing. */ | |
106 | RMAP_RULE_MISSING, | |
107 | ||
108 | /* Route map rule can't compile */ | |
109 | RMAP_COMPILE_ERROR }; | |
110 | ||
111 | /* Route map rule list. */ | |
112 | struct route_map_rule_list { | |
113 | struct route_map_rule *head; | |
114 | struct route_map_rule *tail; | |
115 | }; | |
116 | ||
117 | /* Route map index structure. */ | |
118 | struct route_map_index { | |
119 | struct route_map *map; | |
120 | char *description; | |
121 | ||
122 | /* Preference of this route map rule. */ | |
123 | int pref; | |
124 | ||
125 | /* Route map type permit or deny. */ | |
126 | enum route_map_type type; | |
127 | ||
128 | /* Do we follow old rules, or hop forward? */ | |
129 | route_map_end_t exitpolicy; | |
130 | ||
131 | /* If we're using "GOTO", to where do we go? */ | |
132 | int nextpref; | |
133 | ||
134 | /* If we're using "CALL", to which route-map do ew go? */ | |
135 | char *nextrm; | |
136 | ||
137 | /* Matching rule list. */ | |
138 | struct route_map_rule_list match_list; | |
139 | struct route_map_rule_list set_list; | |
140 | ||
141 | /* Make linked list. */ | |
142 | struct route_map_index *next; | |
143 | struct route_map_index *prev; | |
144 | ||
145 | /* Keep track how many times we've try to apply */ | |
146 | uint64_t applied; | |
147 | ||
148 | QOBJ_FIELDS | |
149 | }; | |
150 | DECLARE_QOBJ_TYPE(route_map_index) | |
151 | ||
152 | /* Route map list structure. */ | |
153 | struct route_map { | |
154 | /* Name of route map. */ | |
155 | char *name; | |
156 | ||
157 | /* Route map's rule. */ | |
158 | struct route_map_index *head; | |
159 | struct route_map_index *tail; | |
160 | ||
161 | /* Make linked list. */ | |
162 | struct route_map *next; | |
163 | struct route_map *prev; | |
164 | ||
165 | /* Maintain update info */ | |
166 | bool to_be_processed; /* True if modification isn't acted on yet */ | |
167 | bool deleted; /* If 1, then this node will be deleted */ | |
168 | ||
169 | /* How many times have we applied this route-map */ | |
170 | uint64_t applied; | |
171 | ||
172 | QOBJ_FIELDS | |
173 | }; | |
174 | DECLARE_QOBJ_TYPE(route_map) | |
175 | ||
176 | /* Prototypes. */ | |
177 | extern void route_map_init(void); | |
178 | ||
179 | /* | |
180 | * This should only be called on shutdown | |
181 | * Additionally this function sets the hooks to NULL | |
182 | * before any processing is done. | |
183 | */ | |
184 | extern void route_map_finish(void); | |
185 | ||
186 | /* Add match statement to route map. */ | |
187 | extern int route_map_add_match(struct route_map_index *index, | |
188 | const char *match_name, const char *match_arg); | |
189 | ||
190 | /* Delete specified route match rule. */ | |
191 | extern int route_map_delete_match(struct route_map_index *index, | |
192 | const char *match_name, | |
193 | const char *match_arg); | |
194 | ||
195 | extern const char *route_map_get_match_arg(struct route_map_index *index, | |
196 | const char *match_name); | |
197 | ||
198 | /* Add route-map set statement to the route map. */ | |
199 | extern int route_map_add_set(struct route_map_index *index, | |
200 | const char *set_name, const char *set_arg); | |
201 | ||
202 | /* Delete route map set rule. */ | |
203 | extern int route_map_delete_set(struct route_map_index *index, | |
204 | const char *set_name, const char *set_arg); | |
205 | ||
206 | /* Install rule command to the match list. */ | |
207 | extern void route_map_install_match(struct route_map_rule_cmd *cmd); | |
208 | ||
209 | /* | |
210 | * Install rule command to the set list. | |
211 | * | |
212 | * When installing a particular item, Allow a difference of handling | |
213 | * of bad cli inputted(return NULL) -vs- this particular daemon cannot use | |
214 | * this form of the command(return a pointer and handle it appropriately | |
215 | * in the apply command). See 'set metric' command | |
216 | * as it is handled in ripd/ripngd and ospfd. | |
217 | */ | |
218 | extern void route_map_install_set(struct route_map_rule_cmd *cmd); | |
219 | ||
220 | /* Lookup route map by name. */ | |
221 | extern struct route_map *route_map_lookup_by_name(const char *name); | |
222 | ||
223 | /* Simple helper to warn if route-map does not exist. */ | |
224 | struct route_map *route_map_lookup_warn_noexist(struct vty *vty, const char *name); | |
225 | ||
226 | /* Apply route map to the object. */ | |
227 | extern route_map_result_t route_map_apply(struct route_map *map, | |
228 | const struct prefix *prefix, | |
229 | route_map_object_t object_type, | |
230 | void *object); | |
231 | ||
232 | extern void route_map_add_hook(void (*func)(const char *)); | |
233 | extern void route_map_delete_hook(void (*func)(const char *)); | |
234 | extern void route_map_event_hook(void (*func)(route_map_event_t, const char *)); | |
235 | extern int route_map_mark_updated(const char *name); | |
236 | extern void route_map_walk_update_list(void (*update_fn)(char *name)); | |
237 | extern void route_map_upd8_dependency(route_map_event_t type, const char *arg, | |
238 | const char *rmap_name); | |
239 | extern void route_map_notify_dependencies(const char *affected_name, | |
240 | route_map_event_t event); | |
241 | ||
242 | extern int generic_match_add(struct vty *vty, struct route_map_index *index, | |
243 | const char *command, const char *arg, | |
244 | route_map_event_t type); | |
245 | ||
246 | extern int generic_match_delete(struct vty *vty, struct route_map_index *index, | |
247 | const char *command, const char *arg, | |
248 | route_map_event_t type); | |
249 | extern int generic_set_add(struct vty *vty, struct route_map_index *index, | |
250 | const char *command, const char *arg); | |
251 | extern int generic_set_delete(struct vty *vty, struct route_map_index *index, | |
252 | const char *command, const char *arg); | |
253 | ||
254 | ||
255 | /* match interface */ | |
256 | extern void route_map_match_interface_hook(int (*func)( | |
257 | struct vty *vty, struct route_map_index *index, const char *command, | |
258 | const char *arg, route_map_event_t type)); | |
259 | /* no match interface */ | |
260 | extern void route_map_no_match_interface_hook(int (*func)( | |
261 | struct vty *vty, struct route_map_index *index, const char *command, | |
262 | const char *arg, route_map_event_t type)); | |
263 | /* match ip address */ | |
264 | extern void route_map_match_ip_address_hook(int (*func)( | |
265 | struct vty *vty, struct route_map_index *index, const char *command, | |
266 | const char *arg, route_map_event_t type)); | |
267 | /* no match ip address */ | |
268 | extern void route_map_no_match_ip_address_hook(int (*func)( | |
269 | struct vty *vty, struct route_map_index *index, const char *command, | |
270 | const char *arg, route_map_event_t type)); | |
271 | /* match ip address prefix list */ | |
272 | extern void route_map_match_ip_address_prefix_list_hook(int (*func)( | |
273 | struct vty *vty, struct route_map_index *index, const char *command, | |
274 | const char *arg, route_map_event_t type)); | |
275 | /* no match ip address prefix list */ | |
276 | extern void route_map_no_match_ip_address_prefix_list_hook(int (*func)( | |
277 | struct vty *vty, struct route_map_index *index, const char *command, | |
278 | const char *arg, route_map_event_t type)); | |
279 | /* match ip next hop */ | |
280 | extern void route_map_match_ip_next_hop_hook(int (*func)( | |
281 | struct vty *vty, struct route_map_index *index, const char *command, | |
282 | const char *arg, route_map_event_t type)); | |
283 | /* no match ip next hop */ | |
284 | extern void route_map_no_match_ip_next_hop_hook(int (*func)( | |
285 | struct vty *vty, struct route_map_index *index, const char *command, | |
286 | const char *arg, route_map_event_t type)); | |
287 | /* match ip next hop prefix list */ | |
288 | extern void route_map_match_ip_next_hop_prefix_list_hook(int (*func)( | |
289 | struct vty *vty, struct route_map_index *index, const char *command, | |
290 | const char *arg, route_map_event_t type)); | |
291 | /* no match ip next hop prefix list */ | |
292 | extern void route_map_no_match_ip_next_hop_prefix_list_hook(int (*func)( | |
293 | struct vty *vty, struct route_map_index *index, const char *command, | |
294 | const char *arg, route_map_event_t type)); | |
295 | /* match ip next hop type */ | |
296 | extern void route_map_match_ip_next_hop_type_hook(int (*func)( | |
297 | struct vty *vty, struct route_map_index *index, const char *command, | |
298 | const char *arg, route_map_event_t type)); | |
299 | /* no match ip next hop type */ | |
300 | extern void route_map_no_match_ip_next_hop_type_hook(int (*func)( | |
301 | struct vty *vty, struct route_map_index *index, const char *command, | |
302 | const char *arg, route_map_event_t type)); | |
303 | /* match ipv6 address */ | |
304 | extern void route_map_match_ipv6_address_hook(int (*func)( | |
305 | struct vty *vty, struct route_map_index *index, const char *command, | |
306 | const char *arg, route_map_event_t type)); | |
307 | /* no match ipv6 address */ | |
308 | extern void route_map_no_match_ipv6_address_hook(int (*func)( | |
309 | struct vty *vty, struct route_map_index *index, const char *command, | |
310 | const char *arg, route_map_event_t type)); | |
311 | /* match ipv6 address prefix list */ | |
312 | extern void route_map_match_ipv6_address_prefix_list_hook(int (*func)( | |
313 | struct vty *vty, struct route_map_index *index, const char *command, | |
314 | const char *arg, route_map_event_t type)); | |
315 | /* no match ipv6 address prefix list */ | |
316 | extern void route_map_no_match_ipv6_address_prefix_list_hook(int (*func)( | |
317 | struct vty *vty, struct route_map_index *index, const char *command, | |
318 | const char *arg, route_map_event_t type)); | |
319 | /* match ipv6 next-hop type */ | |
320 | extern void route_map_match_ipv6_next_hop_type_hook(int (*func)( | |
321 | struct vty *vty, struct route_map_index *index, const char *command, | |
322 | const char *arg, route_map_event_t type)); | |
323 | /* no match ipv6 next-hop type */ | |
324 | extern void route_map_no_match_ipv6_next_hop_type_hook(int (*func)( | |
325 | struct vty *vty, struct route_map_index *index, const char *command, | |
326 | const char *arg, route_map_event_t type)); | |
327 | /* match metric */ | |
328 | extern void route_map_match_metric_hook(int (*func)( | |
329 | struct vty *vty, struct route_map_index *index, const char *command, | |
330 | const char *arg, route_map_event_t type)); | |
331 | /* no match metric */ | |
332 | extern void route_map_no_match_metric_hook(int (*func)( | |
333 | struct vty *vty, struct route_map_index *index, const char *command, | |
334 | const char *arg, route_map_event_t type)); | |
335 | /* match tag */ | |
336 | extern void route_map_match_tag_hook(int (*func)( | |
337 | struct vty *vty, struct route_map_index *index, const char *command, | |
338 | const char *arg, route_map_event_t type)); | |
339 | /* no match tag */ | |
340 | extern void route_map_no_match_tag_hook(int (*func)( | |
341 | struct vty *vty, struct route_map_index *index, const char *command, | |
342 | const char *arg, route_map_event_t type)); | |
343 | /* set ip nexthop */ | |
344 | extern void route_map_set_ip_nexthop_hook( | |
345 | int (*func)(struct vty *vty, struct route_map_index *index, | |
346 | const char *command, const char *arg)); | |
347 | /* no set ip nexthop */ | |
348 | extern void route_map_no_set_ip_nexthop_hook( | |
349 | int (*func)(struct vty *vty, struct route_map_index *index, | |
350 | const char *command, const char *arg)); | |
351 | /* set ipv6 nexthop local */ | |
352 | extern void route_map_set_ipv6_nexthop_local_hook( | |
353 | int (*func)(struct vty *vty, struct route_map_index *index, | |
354 | const char *command, const char *arg)); | |
355 | /* no set ipv6 nexthop local */ | |
356 | extern void route_map_no_set_ipv6_nexthop_local_hook( | |
357 | int (*func)(struct vty *vty, struct route_map_index *index, | |
358 | const char *command, const char *arg)); | |
359 | /* set metric */ | |
360 | extern void route_map_set_metric_hook(int (*func)(struct vty *vty, | |
361 | struct route_map_index *index, | |
362 | const char *command, | |
363 | const char *arg)); | |
364 | /* no set metric */ | |
365 | extern void route_map_no_set_metric_hook( | |
366 | int (*func)(struct vty *vty, struct route_map_index *index, | |
367 | const char *command, const char *arg)); | |
368 | /* set tag */ | |
369 | extern void route_map_set_tag_hook(int (*func)(struct vty *vty, | |
370 | struct route_map_index *index, | |
371 | const char *command, | |
372 | const char *arg)); | |
373 | /* no set tag */ | |
374 | extern void route_map_no_set_tag_hook(int (*func)(struct vty *vty, | |
375 | struct route_map_index *index, | |
376 | const char *command, | |
377 | const char *arg)); | |
378 | ||
379 | extern void *route_map_rule_tag_compile(const char *arg); | |
380 | extern void route_map_rule_tag_free(void *rule); | |
381 | ||
382 | #endif /* _ZEBRA_ROUTEMAP_H */ |