lib/routemap.h

   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 *, struct prefix *,
  91                                          route_map_object_t, void *);
  92
  93         /* Compile argument and return result as void *. */
  94         void *(*func_compile)(const char *);
  95
  96         /* Free allocated value by func_compile (). */
  97         void (*func_free)(void *);
  98 };
  99
 100 /* Route map apply error. */
 101 enum { RMAP_COMPILE_SUCCESS,
 102
 103        /* Route map rule is missing. */
 104        RMAP_RULE_MISSING,
 105
 106        /* Route map rule can't compile */
 107        RMAP_COMPILE_ERROR };
 108
 109 /* Route map rule list. */
 110 struct route_map_rule_list {
 111         struct route_map_rule *head;
 112         struct route_map_rule *tail;
 113 };
 114
 115 /* Route map index structure. */
 116 struct route_map_index {
 117         struct route_map *map;
 118         char *description;
 119
 120         /* Preference of this route map rule. */
 121         int pref;
 122
 123         /* Route map type permit or deny. */
 124         enum route_map_type type;
 125
 126         /* Do we follow old rules, or hop forward? */
 127         route_map_end_t exitpolicy;
 128
 129         /* If we're using "GOTO", to where do we go? */
 130         int nextpref;
 131
 132         /* If we're using "CALL", to which route-map do ew go? */
 133         char *nextrm;
 134
 135         /* Matching rule list. */
 136         struct route_map_rule_list match_list;
 137         struct route_map_rule_list set_list;
 138
 139         /* Make linked list. */
 140         struct route_map_index *next;
 141         struct route_map_index *prev;
 142
 143         QOBJ_FIELDS
 144 };
 145 DECLARE_QOBJ_TYPE(route_map_index)
 146
 147 /* Route map list structure. */
 148 struct route_map {
 149         /* Name of route map. */
 150         char *name;
 151
 152         /* Route map's rule. */
 153         struct route_map_index *head;
 154         struct route_map_index *tail;
 155
 156         /* Make linked list. */
 157         struct route_map *next;
 158         struct route_map *prev;
 159
 160         /* Maintain update info */
 161         bool to_be_processed; /* True if modification isn't acted on yet */
 162         bool deleted;         /* If 1, then this node will be deleted */
 163
 164         QOBJ_FIELDS
 165 };
 166 DECLARE_QOBJ_TYPE(route_map)
 167
 168 /* Prototypes. */
 169 extern void route_map_init(void);
 170 extern void route_map_finish(void);
 171
 172 /* Add match statement to route map. */
 173 extern int route_map_add_match(struct route_map_index *index,
 174                                const char *match_name, const char *match_arg);
 175
 176 /* Delete specified route match rule. */
 177 extern int route_map_delete_match(struct route_map_index *index,
 178                                   const char *match_name,
 179                                   const char *match_arg);
 180
 181 extern const char *route_map_get_match_arg(struct route_map_index *index,
 182                                            const char *match_name);
 183
 184 /* Add route-map set statement to the route map. */
 185 extern int route_map_add_set(struct route_map_index *index,
 186                              const char *set_name, const char *set_arg);
 187
 188 /* Delete route map set rule. */
 189 extern int route_map_delete_set(struct route_map_index *index,
 190                                 const char *set_name, const char *set_arg);
 191
 192 /* Install rule command to the match list. */
 193 extern void route_map_install_match(struct route_map_rule_cmd *cmd);
 194
 195 /*
 196  * Install rule command to the set list.
 197  *
 198  * When installing a particular item, Allow a difference of handling
 199  * of bad cli inputted(return NULL) -vs- this particular daemon cannot use
 200  * this form of the command(return a pointer and handle it appropriately
 201  * in the apply command).  See 'set metric' command
 202  * as it is handled in ripd/ripngd and ospfd.
 203  */
 204 extern void route_map_install_set(struct route_map_rule_cmd *cmd);
 205
 206 /* Lookup route map by name. */
 207 extern struct route_map *route_map_lookup_by_name(const char *name);
 208
 209 /* Apply route map to the object. */
 210 extern route_map_result_t route_map_apply(struct route_map *map,
 211                                           struct prefix *,
 212                                           route_map_object_t object_type,
 213                                           void *object);
 214
 215 extern void route_map_add_hook(void (*func)(const char *));
 216 extern void route_map_delete_hook(void (*func)(const char *));
 217 extern void route_map_event_hook(void (*func)(route_map_event_t, const char *));
 218 extern int route_map_mark_updated(const char *name);
 219 extern void route_map_walk_update_list(void (*update_fn)(char *name));
 220 extern void route_map_upd8_dependency(route_map_event_t type, const char *arg,
 221                                       const char *rmap_name);
 222 extern void route_map_notify_dependencies(const char *affected_name,
 223                                           route_map_event_t event);
 224
 225 extern int generic_match_add(struct vty *vty, struct route_map_index *index,
 226                              const char *command, const char *arg,
 227                              route_map_event_t type);
 228
 229 extern int generic_match_delete(struct vty *vty, struct route_map_index *index,
 230                                 const char *command, const char *arg,
 231                                 route_map_event_t type);
 232 extern int generic_set_add(struct vty *vty, struct route_map_index *index,
 233                            const char *command, const char *arg);
 234 extern int generic_set_delete(struct vty *vty, struct route_map_index *index,
 235                               const char *command, const char *arg);
 236
 237
 238 /* match interface */
 239 extern void route_map_match_interface_hook(int (*func)(
 240         struct vty *vty, struct route_map_index *index, const char *command,
 241         const char *arg, route_map_event_t type));
 242 /* no match interface */
 243 extern void route_map_no_match_interface_hook(int (*func)(
 244         struct vty *vty, struct route_map_index *index, const char *command,
 245         const char *arg, route_map_event_t type));
 246 /* match ip address */
 247 extern void route_map_match_ip_address_hook(int (*func)(
 248         struct vty *vty, struct route_map_index *index, const char *command,
 249         const char *arg, route_map_event_t type));
 250 /* no match ip address */
 251 extern void route_map_no_match_ip_address_hook(int (*func)(
 252         struct vty *vty, struct route_map_index *index, const char *command,
 253         const char *arg, route_map_event_t type));
 254 /* match ip address prefix list */
 255 extern void route_map_match_ip_address_prefix_list_hook(int (*func)(
 256         struct vty *vty, struct route_map_index *index, const char *command,
 257         const char *arg, route_map_event_t type));
 258 /* no match ip address prefix list */
 259 extern void route_map_no_match_ip_address_prefix_list_hook(int (*func)(
 260         struct vty *vty, struct route_map_index *index, const char *command,
 261         const char *arg, route_map_event_t type));
 262 /* match ip next hop */
 263 extern void route_map_match_ip_next_hop_hook(int (*func)(
 264         struct vty *vty, struct route_map_index *index, const char *command,
 265         const char *arg, route_map_event_t type));
 266 /* no match ip next hop */
 267 extern void route_map_no_match_ip_next_hop_hook(int (*func)(
 268         struct vty *vty, struct route_map_index *index, const char *command,
 269         const char *arg, route_map_event_t type));
 270 /* match ip next hop prefix list */
 271 extern void route_map_match_ip_next_hop_prefix_list_hook(int (*func)(
 272         struct vty *vty, struct route_map_index *index, const char *command,
 273         const char *arg, route_map_event_t type));
 274 /* no match ip next hop prefix list */
 275 extern void route_map_no_match_ip_next_hop_prefix_list_hook(int (*func)(
 276         struct vty *vty, struct route_map_index *index, const char *command,
 277         const char *arg, route_map_event_t type));
 278 /* match ipv6 address */
 279 extern void route_map_match_ipv6_address_hook(int (*func)(
 280         struct vty *vty, struct route_map_index *index, const char *command,
 281         const char *arg, route_map_event_t type));
 282 /* no match ipv6 address */
 283 extern void route_map_no_match_ipv6_address_hook(int (*func)(
 284         struct vty *vty, struct route_map_index *index, const char *command,
 285         const char *arg, route_map_event_t type));
 286 /* match ipv6 address prefix list */
 287 extern void route_map_match_ipv6_address_prefix_list_hook(int (*func)(
 288         struct vty *vty, struct route_map_index *index, const char *command,
 289         const char *arg, route_map_event_t type));
 290 /* no match ipv6 address prefix list */
 291 extern void route_map_no_match_ipv6_address_prefix_list_hook(int (*func)(
 292         struct vty *vty, struct route_map_index *index, const char *command,
 293         const char *arg, route_map_event_t type));
 294 /* match metric */
 295 extern void route_map_match_metric_hook(int (*func)(
 296         struct vty *vty, struct route_map_index *index, const char *command,
 297         const char *arg, route_map_event_t type));
 298 /* no match metric */
 299 extern void route_map_no_match_metric_hook(int (*func)(
 300         struct vty *vty, struct route_map_index *index, const char *command,
 301         const char *arg, route_map_event_t type));
 302 /* match tag */
 303 extern void route_map_match_tag_hook(int (*func)(
 304         struct vty *vty, struct route_map_index *index, const char *command,
 305         const char *arg, route_map_event_t type));
 306 /* no match tag */
 307 extern void route_map_no_match_tag_hook(int (*func)(
 308         struct vty *vty, struct route_map_index *index, const char *command,
 309         const char *arg, route_map_event_t type));
 310 /* set ip nexthop */
 311 extern void route_map_set_ip_nexthop_hook(
 312         int (*func)(struct vty *vty, struct route_map_index *index,
 313                     const char *command, const char *arg));
 314 /* no set ip nexthop */
 315 extern void route_map_no_set_ip_nexthop_hook(
 316         int (*func)(struct vty *vty, struct route_map_index *index,
 317                     const char *command, const char *arg));
 318 /* set ipv6 nexthop local */
 319 extern void route_map_set_ipv6_nexthop_local_hook(
 320         int (*func)(struct vty *vty, struct route_map_index *index,
 321                     const char *command, const char *arg));
 322 /* no set ipv6 nexthop local */
 323 extern void route_map_no_set_ipv6_nexthop_local_hook(
 324         int (*func)(struct vty *vty, struct route_map_index *index,
 325                     const char *command, const char *arg));
 326 /* set metric */
 327 extern void route_map_set_metric_hook(int (*func)(struct vty *vty,
 328                                                   struct route_map_index *index,
 329                                                   const char *command,
 330                                                   const char *arg));
 331 /* no set metric */
 332 extern void route_map_no_set_metric_hook(
 333         int (*func)(struct vty *vty, struct route_map_index *index,
 334                     const char *command, const char *arg));
 335 /* set tag */
 336 extern void route_map_set_tag_hook(int (*func)(struct vty *vty,
 337                                                struct route_map_index *index,
 338                                                const char *command,
 339                                                const char *arg));
 340 /* no set tag */
 341 extern void route_map_no_set_tag_hook(int (*func)(struct vty *vty,
 342                                                   struct route_map_index *index,
 343                                                   const char *command,
 344                                                   const char *arg));
 345
 346 extern void *route_map_rule_tag_compile(const char *arg);
 347 extern void route_map_rule_tag_free(void *rule);
 348
 349 #endif /* _ZEBRA_ROUTEMAP_H */