]> git.proxmox.com Git - mirror_frr.git/blame - lib/routemap.h
libs, daemons: use const in route-map apply
[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
d62a17ae 145 QOBJ_FIELDS
718e3744 146};
e80e7cce 147DECLARE_QOBJ_TYPE(route_map_index)
718e3744 148
149/* Route map list structure. */
d62a17ae 150struct route_map {
151 /* Name of route map. */
152 char *name;
718e3744 153
d62a17ae 154 /* Route map's rule. */
155 struct route_map_index *head;
156 struct route_map_index *tail;
718e3744 157
d62a17ae 158 /* Make linked list. */
159 struct route_map *next;
160 struct route_map *prev;
518f0eb1 161
d62a17ae 162 /* Maintain update info */
e4694d0d
DS
163 bool to_be_processed; /* True if modification isn't acted on yet */
164 bool deleted; /* If 1, then this node will be deleted */
e80e7cce 165
d62a17ae 166 QOBJ_FIELDS
718e3744 167};
e80e7cce 168DECLARE_QOBJ_TYPE(route_map)
718e3744 169
170/* Prototypes. */
d62a17ae 171extern void route_map_init(void);
172extern void route_map_finish(void);
718e3744 173
174/* Add match statement to route map. */
d62a17ae 175extern int route_map_add_match(struct route_map_index *index,
176 const char *match_name, const char *match_arg);
718e3744 177
178/* Delete specified route match rule. */
d62a17ae 179extern int route_map_delete_match(struct route_map_index *index,
180 const char *match_name,
181 const char *match_arg);
718e3744 182
d62a17ae 183extern const char *route_map_get_match_arg(struct route_map_index *index,
184 const char *match_name);
518f0eb1 185
718e3744 186/* Add route-map set statement to the route map. */
d62a17ae 187extern int route_map_add_set(struct route_map_index *index,
188 const char *set_name, const char *set_arg);
718e3744 189
190/* Delete route map set rule. */
d62a17ae 191extern int route_map_delete_set(struct route_map_index *index,
192 const char *set_name, const char *set_arg);
718e3744 193
194/* Install rule command to the match list. */
d62a17ae 195extern void route_map_install_match(struct route_map_rule_cmd *cmd);
718e3744 196
6a74c5f9
DS
197/*
198 * Install rule command to the set list.
199 *
200 * When installing a particular item, Allow a difference of handling
201 * of bad cli inputted(return NULL) -vs- this particular daemon cannot use
202 * this form of the command(return a pointer and handle it appropriately
203 * in the apply command). See 'set metric' command
204 * as it is handled in ripd/ripngd and ospfd.
205 */
d62a17ae 206extern void route_map_install_set(struct route_map_rule_cmd *cmd);
718e3744 207
208/* Lookup route map by name. */
d62a17ae 209extern struct route_map *route_map_lookup_by_name(const char *name);
718e3744 210
211/* Apply route map to the object. */
d62a17ae 212extern route_map_result_t route_map_apply(struct route_map *map,
123214ef 213 const struct prefix *prefix,
d62a17ae 214 route_map_object_t object_type,
215 void *object);
216
217extern void route_map_add_hook(void (*func)(const char *));
218extern void route_map_delete_hook(void (*func)(const char *));
219extern void route_map_event_hook(void (*func)(route_map_event_t, const char *));
7096e938 220extern int route_map_mark_updated(const char *name);
46a69f10 221extern void route_map_walk_update_list(void (*update_fn)(char *name));
d62a17ae 222extern void route_map_upd8_dependency(route_map_event_t type, const char *arg,
223 const char *rmap_name);
224extern void route_map_notify_dependencies(const char *affected_name,
225 route_map_event_t event);
226
227extern int generic_match_add(struct vty *vty, struct route_map_index *index,
228 const char *command, const char *arg,
229 route_map_event_t type);
230
231extern int generic_match_delete(struct vty *vty, struct route_map_index *index,
232 const char *command, const char *arg,
233 route_map_event_t type);
234extern int generic_set_add(struct vty *vty, struct route_map_index *index,
235 const char *command, const char *arg);
236extern int generic_set_delete(struct vty *vty, struct route_map_index *index,
237 const char *command, const char *arg);
82f97584
DW
238
239
240/* match interface */
d62a17ae 241extern void route_map_match_interface_hook(int (*func)(
242 struct vty *vty, struct route_map_index *index, const char *command,
243 const char *arg, route_map_event_t type));
82f97584 244/* no match interface */
d62a17ae 245extern void route_map_no_match_interface_hook(int (*func)(
246 struct vty *vty, struct route_map_index *index, const char *command,
247 const char *arg, route_map_event_t type));
82f97584 248/* match ip address */
d62a17ae 249extern void route_map_match_ip_address_hook(int (*func)(
250 struct vty *vty, struct route_map_index *index, const char *command,
251 const char *arg, route_map_event_t type));
82f97584 252/* no match ip address */
d62a17ae 253extern void route_map_no_match_ip_address_hook(int (*func)(
254 struct vty *vty, struct route_map_index *index, const char *command,
255 const char *arg, route_map_event_t type));
82f97584 256/* match ip address prefix list */
d62a17ae 257extern void route_map_match_ip_address_prefix_list_hook(int (*func)(
258 struct vty *vty, struct route_map_index *index, const char *command,
259 const char *arg, route_map_event_t type));
82f97584 260/* no match ip address prefix list */
d62a17ae 261extern void route_map_no_match_ip_address_prefix_list_hook(int (*func)(
262 struct vty *vty, struct route_map_index *index, const char *command,
263 const char *arg, route_map_event_t type));
82f97584 264/* match ip next hop */
d62a17ae 265extern void route_map_match_ip_next_hop_hook(int (*func)(
266 struct vty *vty, struct route_map_index *index, const char *command,
267 const char *arg, route_map_event_t type));
82f97584 268/* no match ip next hop */
d62a17ae 269extern void route_map_no_match_ip_next_hop_hook(int (*func)(
270 struct vty *vty, struct route_map_index *index, const char *command,
271 const char *arg, route_map_event_t type));
82f97584 272/* match ip next hop prefix list */
d62a17ae 273extern void route_map_match_ip_next_hop_prefix_list_hook(int (*func)(
274 struct vty *vty, struct route_map_index *index, const char *command,
275 const char *arg, route_map_event_t type));
82f97584 276/* no match ip next hop prefix list */
d62a17ae 277extern void route_map_no_match_ip_next_hop_prefix_list_hook(int (*func)(
278 struct vty *vty, struct route_map_index *index, const char *command,
279 const char *arg, route_map_event_t type));
82f97584 280/* match ipv6 address */
d62a17ae 281extern void route_map_match_ipv6_address_hook(int (*func)(
282 struct vty *vty, struct route_map_index *index, const char *command,
283 const char *arg, route_map_event_t type));
82f97584 284/* no match ipv6 address */
d62a17ae 285extern void route_map_no_match_ipv6_address_hook(int (*func)(
286 struct vty *vty, struct route_map_index *index, const char *command,
287 const char *arg, route_map_event_t type));
82f97584 288/* match ipv6 address prefix list */
d62a17ae 289extern void route_map_match_ipv6_address_prefix_list_hook(int (*func)(
290 struct vty *vty, struct route_map_index *index, const char *command,
291 const char *arg, route_map_event_t type));
82f97584 292/* no match ipv6 address prefix list */
d62a17ae 293extern void route_map_no_match_ipv6_address_prefix_list_hook(int (*func)(
294 struct vty *vty, struct route_map_index *index, const char *command,
295 const char *arg, route_map_event_t type));
82f97584 296/* match metric */
d62a17ae 297extern void route_map_match_metric_hook(int (*func)(
298 struct vty *vty, struct route_map_index *index, const char *command,
299 const char *arg, route_map_event_t type));
82f97584 300/* no match metric */
d62a17ae 301extern void route_map_no_match_metric_hook(int (*func)(
302 struct vty *vty, struct route_map_index *index, const char *command,
303 const char *arg, route_map_event_t type));
82f97584 304/* match tag */
d62a17ae 305extern void route_map_match_tag_hook(int (*func)(
306 struct vty *vty, struct route_map_index *index, const char *command,
307 const char *arg, route_map_event_t type));
82f97584 308/* no match tag */
d62a17ae 309extern void route_map_no_match_tag_hook(int (*func)(
310 struct vty *vty, struct route_map_index *index, const char *command,
311 const char *arg, route_map_event_t type));
82f97584 312/* set ip nexthop */
d62a17ae 313extern void route_map_set_ip_nexthop_hook(
314 int (*func)(struct vty *vty, struct route_map_index *index,
315 const char *command, const char *arg));
82f97584 316/* no set ip nexthop */
d62a17ae 317extern void route_map_no_set_ip_nexthop_hook(
318 int (*func)(struct vty *vty, struct route_map_index *index,
319 const char *command, const char *arg));
82f97584 320/* set ipv6 nexthop local */
d62a17ae 321extern void route_map_set_ipv6_nexthop_local_hook(
322 int (*func)(struct vty *vty, struct route_map_index *index,
323 const char *command, const char *arg));
82f97584 324/* no set ipv6 nexthop local */
d62a17ae 325extern void route_map_no_set_ipv6_nexthop_local_hook(
326 int (*func)(struct vty *vty, struct route_map_index *index,
327 const char *command, const char *arg));
82f97584 328/* set metric */
d62a17ae 329extern void route_map_set_metric_hook(int (*func)(struct vty *vty,
330 struct route_map_index *index,
331 const char *command,
332 const char *arg));
82f97584 333/* no set metric */
d62a17ae 334extern void route_map_no_set_metric_hook(
335 int (*func)(struct vty *vty, struct route_map_index *index,
336 const char *command, const char *arg));
82f97584 337/* set tag */
d62a17ae 338extern void route_map_set_tag_hook(int (*func)(struct vty *vty,
339 struct route_map_index *index,
340 const char *command,
341 const char *arg));
82f97584 342/* no set tag */
d62a17ae 343extern void route_map_no_set_tag_hook(int (*func)(struct vty *vty,
344 struct route_map_index *index,
345 const char *command,
346 const char *arg));
e52702f2 347
d62a17ae 348extern void *route_map_rule_tag_compile(const char *arg);
349extern void route_map_rule_tag_free(void *rule);
dc9ffce8 350
718e3744 351#endif /* _ZEBRA_ROUTEMAP_H */