]> git.proxmox.com Git - mirror_frr.git/blame - lib/routemap.h
zebra, lib: fix the ZEBRA_INTERFACE_VRF_UPDATE zapi message
[mirror_frr.git] / lib / routemap.h
CommitLineData
718e3744 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 *
896014f4
DL
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
718e3744 19 */
20
21#ifndef _ZEBRA_ROUTEMAP_H
22#define _ZEBRA_ROUTEMAP_H
23
24873f0c 24#include "prefix.h"
4a1ab8e4 25#include "memory.h"
e80e7cce 26#include "qobj.h"
0a538fc9
QY
27#include "vty.h"
28
4a1ab8e4
DL
29DECLARE_MTYPE(ROUTE_MAP_NAME)
30DECLARE_MTYPE(ROUTE_MAP_RULE)
31DECLARE_MTYPE(ROUTE_MAP_COMPILED)
24873f0c 32
718e3744 33/* Route map's type. */
d62a17ae 34enum route_map_type { RMAP_PERMIT, RMAP_DENY, RMAP_ANY };
35
36typedef enum {
37 RMAP_MATCH,
38 RMAP_DENYMATCH,
39 RMAP_NOMATCH,
40 RMAP_ERROR,
41 RMAP_OKAY
718e3744 42} route_map_result_t;
43
d62a17ae 44typedef enum {
45 RMAP_RIP,
46 RMAP_RIPNG,
47 RMAP_OSPF,
48 RMAP_OSPF6,
49 RMAP_BGP,
50 RMAP_ZEBRA,
51 RMAP_ISIS,
718e3744 52} route_map_object_t;
53
d62a17ae 54typedef enum { RMAP_EXIT, RMAP_GOTO, RMAP_NEXT } route_map_end_t;
55
56typedef 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,
718e3744 79} route_map_event_t;
80
fee0f4c6 81/* Depth limit in RMAP recursion using RMAP_CALL. */
82#define RMAP_RECURSION_LIMIT 10
83
718e3744 84/* Route map rule structure for matching and setting. */
d62a17ae 85struct route_map_rule_cmd {
86 /* Route map rule name (e.g. as-path, metric) */
87 const char *str;
718e3744 88
d62a17ae 89 /* Function for value set or match. */
123214ef
MS
90 route_map_result_t (*func_apply)(void *rule,
91 const struct prefix *prefix,
92 route_map_object_t type,
93 void *object);
718e3744 94
d62a17ae 95 /* Compile argument and return result as void *. */
96 void *(*func_compile)(const char *);
718e3744 97
d62a17ae 98 /* Free allocated value by func_compile (). */
99 void (*func_free)(void *);
718e3744 100};
101
102/* Route map apply error. */
996c9314 103enum { RMAP_COMPILE_SUCCESS,
9ca25fed 104
996c9314
LB
105 /* Route map rule is missing. */
106 RMAP_RULE_MISSING,
718e3744 107
996c9314
LB
108 /* Route map rule can't compile */
109 RMAP_COMPILE_ERROR };
718e3744 110
111/* Route map rule list. */
d62a17ae 112struct route_map_rule_list {
113 struct route_map_rule *head;
114 struct route_map_rule *tail;
718e3744 115};
116
117/* Route map index structure. */
d62a17ae 118struct route_map_index {
119 struct route_map *map;
120 char *description;
718e3744 121
d62a17ae 122 /* Preference of this route map rule. */
123 int pref;
718e3744 124
d62a17ae 125 /* Route map type permit or deny. */
126 enum route_map_type type;
718e3744 127
d62a17ae 128 /* Do we follow old rules, or hop forward? */
129 route_map_end_t exitpolicy;
718e3744 130
d62a17ae 131 /* If we're using "GOTO", to where do we go? */
132 int nextpref;
718e3744 133
d62a17ae 134 /* If we're using "CALL", to which route-map do ew go? */
135 char *nextrm;
fee0f4c6 136
d62a17ae 137 /* Matching rule list. */
138 struct route_map_rule_list match_list;
139 struct route_map_rule_list set_list;
718e3744 140
d62a17ae 141 /* Make linked list. */
142 struct route_map_index *next;
143 struct route_map_index *prev;
e80e7cce 144
279b0607
DS
145 /* Keep track how many times we've try to apply */
146 uint64_t applied;
147
d62a17ae 148 QOBJ_FIELDS
718e3744 149};
e80e7cce 150DECLARE_QOBJ_TYPE(route_map_index)
718e3744 151
152/* Route map list structure. */
d62a17ae 153struct route_map {
154 /* Name of route map. */
155 char *name;
718e3744 156
d62a17ae 157 /* Route map's rule. */
158 struct route_map_index *head;
159 struct route_map_index *tail;
718e3744 160
d62a17ae 161 /* Make linked list. */
162 struct route_map *next;
163 struct route_map *prev;
518f0eb1 164
d62a17ae 165 /* Maintain update info */
e4694d0d
DS
166 bool to_be_processed; /* True if modification isn't acted on yet */
167 bool deleted; /* If 1, then this node will be deleted */
e80e7cce 168
279b0607
DS
169 /* How many times have we applied this route-map */
170 uint64_t applied;
171
d62a17ae 172 QOBJ_FIELDS
718e3744 173};
e80e7cce 174DECLARE_QOBJ_TYPE(route_map)
718e3744 175
176/* Prototypes. */
d62a17ae 177extern void route_map_init(void);
8619629a
DS
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 */
d62a17ae 184extern void route_map_finish(void);
718e3744 185
186/* Add match statement to route map. */
d62a17ae 187extern int route_map_add_match(struct route_map_index *index,
188 const char *match_name, const char *match_arg);
718e3744 189
190/* Delete specified route match rule. */
d62a17ae 191extern int route_map_delete_match(struct route_map_index *index,
192 const char *match_name,
193 const char *match_arg);
718e3744 194
d62a17ae 195extern const char *route_map_get_match_arg(struct route_map_index *index,
196 const char *match_name);
518f0eb1 197
718e3744 198/* Add route-map set statement to the route map. */
d62a17ae 199extern int route_map_add_set(struct route_map_index *index,
200 const char *set_name, const char *set_arg);
718e3744 201
202/* Delete route map set rule. */
d62a17ae 203extern int route_map_delete_set(struct route_map_index *index,
204 const char *set_name, const char *set_arg);
718e3744 205
206/* Install rule command to the match list. */
d62a17ae 207extern void route_map_install_match(struct route_map_rule_cmd *cmd);
718e3744 208
6a74c5f9
DS
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 */
d62a17ae 218extern void route_map_install_set(struct route_map_rule_cmd *cmd);
718e3744 219
220/* Lookup route map by name. */
d62a17ae 221extern struct route_map *route_map_lookup_by_name(const char *name);
718e3744 222
1de27621
DA
223/* Simple helper to warn if route-map does not exist. */
224struct route_map *route_map_lookup_warn_noexist(struct vty *vty, const char *name);
225
718e3744 226/* Apply route map to the object. */
d62a17ae 227extern route_map_result_t route_map_apply(struct route_map *map,
123214ef 228 const struct prefix *prefix,
d62a17ae 229 route_map_object_t object_type,
230 void *object);
231
232extern void route_map_add_hook(void (*func)(const char *));
233extern void route_map_delete_hook(void (*func)(const char *));
234extern void route_map_event_hook(void (*func)(route_map_event_t, const char *));
7096e938 235extern int route_map_mark_updated(const char *name);
46a69f10 236extern void route_map_walk_update_list(void (*update_fn)(char *name));
d62a17ae 237extern void route_map_upd8_dependency(route_map_event_t type, const char *arg,
238 const char *rmap_name);
239extern void route_map_notify_dependencies(const char *affected_name,
240 route_map_event_t event);
241
242extern 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
246extern 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);
249extern int generic_set_add(struct vty *vty, struct route_map_index *index,
250 const char *command, const char *arg);
251extern int generic_set_delete(struct vty *vty, struct route_map_index *index,
252 const char *command, const char *arg);
82f97584
DW
253
254
255/* match interface */
d62a17ae 256extern 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));
82f97584 259/* no match interface */
d62a17ae 260extern 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));
82f97584 263/* match ip address */
d62a17ae 264extern 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));
82f97584 267/* no match ip address */
d62a17ae 268extern 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));
82f97584 271/* match ip address prefix list */
d62a17ae 272extern 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));
82f97584 275/* no match ip address prefix list */
d62a17ae 276extern 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));
82f97584 279/* match ip next hop */
d62a17ae 280extern 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));
82f97584 283/* no match ip next hop */
d62a17ae 284extern 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));
82f97584 287/* match ip next hop prefix list */
d62a17ae 288extern 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));
82f97584 291/* no match ip next hop prefix list */
d62a17ae 292extern 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));
61ad901e
DA
295/* match ip next hop type */
296extern 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 */
300extern 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));
82f97584 303/* match ipv6 address */
d62a17ae 304extern 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));
82f97584 307/* no match ipv6 address */
d62a17ae 308extern 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));
82f97584 311/* match ipv6 address prefix list */
d62a17ae 312extern 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));
82f97584 315/* no match ipv6 address prefix list */
d62a17ae 316extern 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));
61ad901e
DA
319/* match ipv6 next-hop type */
320extern 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 */
324extern 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));
82f97584 327/* match metric */
d62a17ae 328extern 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));
82f97584 331/* no match metric */
d62a17ae 332extern 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));
82f97584 335/* match tag */
d62a17ae 336extern 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));
82f97584 339/* no match tag */
d62a17ae 340extern 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));
82f97584 343/* set ip nexthop */
d62a17ae 344extern 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));
82f97584 347/* no set ip nexthop */
d62a17ae 348extern 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));
82f97584 351/* set ipv6 nexthop local */
d62a17ae 352extern 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));
82f97584 355/* no set ipv6 nexthop local */
d62a17ae 356extern 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));
82f97584 359/* set metric */
d62a17ae 360extern 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));
82f97584 364/* no set metric */
d62a17ae 365extern 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));
82f97584 368/* set tag */
d62a17ae 369extern 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));
82f97584 373/* no set tag */
d62a17ae 374extern 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));
e52702f2 378
d62a17ae 379extern void *route_map_rule_tag_compile(const char *arg);
380extern void route_map_rule_tag_free(void *rule);
dc9ffce8 381
718e3744 382#endif /* _ZEBRA_ROUTEMAP_H */