summaryrefslogtreecommitdiffstats
path: root/lib/routemap.h
blob: f1937ac4034fdb33601ee7172441e98390f545d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/* Route map function.
 * Copyright (C) 1998 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_ROUTEMAP_H
#define _ZEBRA_ROUTEMAP_H

#include "prefix.h"
#include "memory.h"
#include "qobj.h"
#include "vty.h"

DECLARE_MTYPE(ROUTE_MAP_NAME)
DECLARE_MTYPE(ROUTE_MAP_RULE)
DECLARE_MTYPE(ROUTE_MAP_COMPILED)

/* Route map's type. */
enum route_map_type
{
  RMAP_PERMIT,
  RMAP_DENY,
  RMAP_ANY
};

typedef enum 
{
  RMAP_MATCH,
  RMAP_DENYMATCH,
  RMAP_NOMATCH,
  RMAP_ERROR,
  RMAP_OKAY
} route_map_result_t;

typedef enum
{
  RMAP_RIP,
  RMAP_RIPNG,
  RMAP_OSPF,
  RMAP_OSPF6,
  RMAP_BGP,
  RMAP_ZEBRA,
  RMAP_ISIS,
} route_map_object_t;

typedef enum
{
  RMAP_EXIT,
  RMAP_GOTO,
  RMAP_NEXT
} route_map_end_t;

typedef enum
{
  RMAP_EVENT_SET_ADDED,
  RMAP_EVENT_SET_DELETED,
  RMAP_EVENT_SET_REPLACED,
  RMAP_EVENT_MATCH_ADDED,
  RMAP_EVENT_MATCH_DELETED,
  RMAP_EVENT_MATCH_REPLACED,
  RMAP_EVENT_INDEX_ADDED,
  RMAP_EVENT_INDEX_DELETED,
  RMAP_EVENT_CALL_ADDED,	/* call to another routemap added */
  RMAP_EVENT_CALL_DELETED,
  RMAP_EVENT_PLIST_ADDED,
  RMAP_EVENT_PLIST_DELETED,
  RMAP_EVENT_CLIST_ADDED,
  RMAP_EVENT_CLIST_DELETED,
  RMAP_EVENT_ECLIST_ADDED,
  RMAP_EVENT_ECLIST_DELETED,
  RMAP_EVENT_LLIST_ADDED,
  RMAP_EVENT_LLIST_DELETED,
  RMAP_EVENT_ASLIST_ADDED,
  RMAP_EVENT_ASLIST_DELETED,
  RMAP_EVENT_FILTER_ADDED,
  RMAP_EVENT_FILTER_DELETED,
} route_map_event_t;

/* Depth limit in RMAP recursion using RMAP_CALL. */
#define RMAP_RECURSION_LIMIT      10

/* Route map rule structure for matching and setting. */
struct route_map_rule_cmd
{
  /* Route map rule name (e.g. as-path, metric) */
  const char *str;

  /* Function for value set or match. */
  route_map_result_t (*func_apply)(void *, struct prefix *, 
				   route_map_object_t, void *);

  /* Compile argument and return result as void *. */
  void *(*func_compile)(const char *);

  /* Free allocated value by func_compile (). */
  void (*func_free)(void *);
};

/* Route map apply error. */
enum
{
  /* Route map rule is missing. */
  RMAP_RULE_MISSING = 1,

  /* Route map rule can't compile */
  RMAP_COMPILE_ERROR
};

/* Route map rule list. */
struct route_map_rule_list
{
  struct route_map_rule *head;
  struct route_map_rule *tail;
};

/* Route map index structure. */
struct route_map_index
{
  struct route_map *map;
  char *description;

  /* Preference of this route map rule. */
  int pref;

  /* Route map type permit or deny. */
  enum route_map_type type;			

  /* Do we follow old rules, or hop forward? */
  route_map_end_t exitpolicy;

  /* If we're using "GOTO", to where do we go? */
  int nextpref;

  /* If we're using "CALL", to which route-map do ew go? */
  char *nextrm;

  /* Matching rule list. */
  struct route_map_rule_list match_list;
  struct route_map_rule_list set_list;

  /* Make linked list. */
  struct route_map_index *next;
  struct route_map_index *prev;

  QOBJ_FIELDS
};
DECLARE_QOBJ_TYPE(route_map_index)

/* Route map list structure. */
struct route_map
{
  /* Name of route map. */
  char *name;

  /* Route map's rule. */
  struct route_map_index *head;
  struct route_map_index *tail;

  /* Make linked list. */
  struct route_map *next;
  struct route_map *prev;

  /* Maintain update info */
  int to_be_processed;	 /* True if modification isn't acted on yet */
  int deleted;		 /* If 1, then this node will be deleted */

  QOBJ_FIELDS
};
DECLARE_QOBJ_TYPE(route_map)

/* Prototypes. */
extern void route_map_init (void);
extern void route_map_finish (void);

/* Add match statement to route map. */
extern int route_map_add_match (struct route_map_index *index,
		                const char *match_name,
		                const char *match_arg);

/* Delete specified route match rule. */
extern int route_map_delete_match (struct route_map_index *index,
			           const char *match_name,
			           const char *match_arg);

extern const char *route_map_get_match_arg (struct route_map_index *index,
					    const char *match_name);

/* Add route-map set statement to the route map. */
extern int route_map_add_set (struct route_map_index *index, 
		              const char *set_name,
		              const char *set_arg);

/* Delete route map set rule. */
extern int route_map_delete_set (struct route_map_index *index,
                                 const char *set_name,
                                 const char *set_arg);

/* Install rule command to the match list. */
extern void route_map_install_match (struct route_map_rule_cmd *cmd);

/* Install rule command to the set list. */
extern void route_map_install_set (struct route_map_rule_cmd *cmd);

/* Lookup route map by name. */
extern struct route_map * route_map_lookup_by_name (const char *name);

/* Apply route map to the object. */
extern route_map_result_t route_map_apply (struct route_map *map,
                                           struct prefix *,
                                           route_map_object_t object_type,
                                           void *object);

extern void route_map_add_hook (void (*func) (const char *));
extern void route_map_delete_hook (void (*func) (const char *));
extern void route_map_event_hook (void (*func) (route_map_event_t,
						const char *));
extern int route_map_mark_updated (const char *name, int deleted);
extern int route_map_clear_updated (struct route_map *rmap);
extern void route_map_walk_update_list (int (*update_fn) (char *name));
extern void route_map_upd8_dependency (route_map_event_t type, const char *arg,
				       const char *rmap_name);
extern void route_map_notify_dependencies (const char *affected_name,
					   route_map_event_t event);

extern int generic_match_add (struct vty *vty,
                              struct route_map_index *index,
                              const char *command,
                              const char *arg,
                              route_map_event_t type);

extern int generic_match_delete (struct vty *vty,
                                 struct route_map_index *index,
                                 const char *command,
                                 const char *arg,
                                 route_map_event_t type);
extern int generic_set_add (struct vty *vty, struct route_map_index *index,
                            const char *command, const char *arg);
extern int generic_set_delete (struct vty *vty, struct route_map_index *index,
                               const char *command, const char *arg);


/* match interface */
extern void route_map_match_interface_hook (int (*func) (struct vty *vty,
                                                         struct route_map_index *index,
                                                         const char *command,
                                                         const char *arg,
                                                         route_map_event_t type));
/* no match interface */
extern void route_map_no_match_interface_hook (int (*func) (struct vty *vty,
                                                            struct route_map_index *index,
                                                            const char *command,
                                                            const char *arg,
                                                            route_map_event_t type));
/* match ip address */
extern void route_map_match_ip_address_hook (int (*func) (struct vty *vty,
                                                          struct route_map_index *index,
                                                          const char *command,
                                                          const char *arg,
                                                          route_map_event_t type));
/* no match ip address */
extern void route_map_no_match_ip_address_hook (int (*func) (struct vty *vty,
                                                             struct route_map_index *index,
                                                             const char *command,
                                                             const char *arg,
                                                             route_map_event_t type));
/* match ip address prefix list */
extern void route_map_match_ip_address_prefix_list_hook (int (*func) (struct vty *vty,
                                                                      struct route_map_index *index,
                                                                      const char *command,
                                                                      const char *arg,
                                                                      route_map_event_t type));
/* no match ip address prefix list */
extern void route_map_no_match_ip_address_prefix_list_hook (int (*func) (struct vty *vty,
                                                                         struct route_map_index *index,
                                                                         const char *command,
                                                                         const char *arg,
                                                                         route_map_event_t type));
/* match ip next hop */
extern void route_map_match_ip_next_hop_hook (int (*func) (struct vty *vty,
                                                           struct route_map_index *index,
                                                           const char *command,
                                                           const char *arg,
                                                           route_map_event_t type));
/* no match ip next hop */
extern void route_map_no_match_ip_next_hop_hook (int (*func) (struct vty *vty,
                                                              struct route_map_index *index,
                                                              const char *command,
                                                              const char *arg,
                                                              route_map_event_t type));
/* match ip next hop prefix list */
extern void route_map_match_ip_next_hop_prefix_list_hook (int (*func) (struct vty *vty,
                                                                       struct route_map_index *index,
                                                                       const char *command,
                                                                       const char *arg,
                                                                       route_map_event_t type));
/* no match ip next hop prefix list */
extern void route_map_no_match_ip_next_hop_prefix_list_hook (int (*func) (struct vty *vty,
                                                                          struct route_map_index *index,
                                                                          const char *command,
                                                                          const char *arg,
                                                                          route_map_event_t type));
/* match ipv6 address */
extern void route_map_match_ipv6_address_hook (int (*func) (struct vty *vty,
                                                            struct route_map_index *index,
                                                            const char *command,
                                                            const char *arg,
                                                            route_map_event_t type));
/* no match ipv6 address */
extern void route_map_no_match_ipv6_address_hook (int (*func) (struct vty *vty,
                                                               struct route_map_index *index,
                                                               const char *command,
                                                               const char *arg,
                                                               route_map_event_t type));
/* match ipv6 address prefix list */
extern void route_map_match_ipv6_address_prefix_list_hook (int (*func) (struct vty *vty,
                                                                        struct route_map_index *index,
                                                                        const char *command,
                                                                        const char *arg,
                                                                        route_map_event_t type));
/* no match ipv6 address prefix list */
extern void route_map_no_match_ipv6_address_prefix_list_hook (int (*func) (struct vty *vty,
                                                                           struct route_map_index *index,
                                                                           const char *command,
                                                                           const char *arg,
                                                                           route_map_event_t type));
/* match metric */
extern void route_map_match_metric_hook (int (*func) (struct vty *vty,
                                                      struct route_map_index *index,
                                                      const char *command,
                                                      const char *arg,
                                                      route_map_event_t type));
/* no match metric */
extern void route_map_no_match_metric_hook (int (*func) (struct vty *vty,
                                                         struct route_map_index *index,
                                                         const char *command,
                                                         const char *arg,
                                                         route_map_event_t type));
/* match tag */
extern void route_map_match_tag_hook (int (*func) (struct vty *vty,
                                                   struct route_map_index *index,
                                                   const char *command,
                                                   const char *arg,
                                                   route_map_event_t type));
/* no match tag */
extern void route_map_no_match_tag_hook (int (*func) (struct vty *vty,
                                                      struct route_map_index *index,
                                                      const char *command,
                                                      const char *arg,
                                                      route_map_event_t type));
/* set ip nexthop */
extern void route_map_set_ip_nexthop_hook (int (*func) (struct vty *vty,
                                                        struct route_map_index *index,
                                                        const char *command,
                                                        const char *arg));
/* no set ip nexthop */
extern void route_map_no_set_ip_nexthop_hook (int (*func) (struct vty *vty,
                                                           struct route_map_index *index,
                                                           const char *command,
                                                           const char *arg));
/* set ipv6 nexthop local */
extern void route_map_set_ipv6_nexthop_local_hook (int (*func) (struct vty *vty,
                                                                struct route_map_index *index,
                                                                const char *command,
                                                                const char *arg));
/* no set ipv6 nexthop local */
extern void route_map_no_set_ipv6_nexthop_local_hook (int (*func) (struct vty *vty,
                                                                   struct route_map_index *index,
                                                                   const char *command,
                                                                   const char *arg));
/* set metric */
extern void route_map_set_metric_hook (int (*func) (struct vty *vty,
                                                    struct route_map_index *index,
                                                    const char *command,
                                                    const char *arg));
/* no set metric */
extern void route_map_no_set_metric_hook (int (*func) (struct vty *vty,
                                                       struct route_map_index *index,
                                                       const char *command,
                                                       const char *arg));
/* set tag */
extern void route_map_set_tag_hook (int (*func) (struct vty *vty,
                                                 struct route_map_index *index,
                                                 const char *command,
                                                 const char *arg));
/* no set tag */
extern void route_map_no_set_tag_hook (int (*func) (struct vty *vty,
                                                    struct route_map_index *index,
                                                    const char *command,
                                                    const char *arg));

extern void *route_map_rule_tag_compile (const char *arg);
extern void route_map_rule_tag_free (void *rule);

#endif /* _ZEBRA_ROUTEMAP_H */