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
  17  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  18  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19  * 02111-1307, USA.
  20  */
  21
  22 #ifndef _ZEBRA_ROUTEMAP_H
  23 #define _ZEBRA_ROUTEMAP_H
  24
  25 /* Route map's type. */
  26 enum route_map_type
  27 {
  28   RMAP_PERMIT,
  29   RMAP_DENY,
  30   RMAP_ANY
  31 };
  32
  33 typedef enum
  34 {
  35   RMAP_MATCH,
  36   RMAP_DENYMATCH,
  37   RMAP_NOMATCH,
  38   RMAP_ERROR,
  39   RMAP_OKAY
  40 } route_map_result_t;
  41
  42 typedef enum
  43 {
  44   RMAP_RIP,
  45   RMAP_RIPNG,
  46   RMAP_OSPF,
  47   RMAP_OSPF6,
  48   RMAP_BGP
  49 } route_map_object_t;
  50
  51 typedef enum
  52 {
  53   RMAP_EXIT,
  54   RMAP_GOTO,
  55   RMAP_NEXT
  56 } route_map_end_t;
  57
  58 typedef enum
  59 {
  60   RMAP_EVENT_SET_ADDED,
  61   RMAP_EVENT_SET_DELETED,
  62   RMAP_EVENT_SET_REPLACED,
  63   RMAP_EVENT_MATCH_ADDED,
  64   RMAP_EVENT_MATCH_DELETED,
  65   RMAP_EVENT_MATCH_REPLACED,
  66   RMAP_EVENT_INDEX_ADDED,
  67   RMAP_EVENT_INDEX_DELETED
  68 } route_map_event_t;
  69
  70 /* Depth limit in RMAP recursion using RMAP_CALL. */
  71 #define RMAP_RECURSION_LIMIT      10
  72
  73 /* Route map rule structure for matching and setting. */
  74 struct route_map_rule_cmd
  75 {
  76   /* Route map rule name (e.g. as-path, metric) */
  77   const char *str;
  78
  79   /* Function for value set or match. */
  80   route_map_result_t (*func_apply)(void *, struct prefix *,
  81                                    route_map_object_t, void *);
  82
  83   /* Compile argument and return result as void *. */
  84   void *(*func_compile)(const char *);
  85
  86   /* Free allocated value by func_compile (). */
  87   void (*func_free)(void *);
  88 };
  89
  90 /* Route map apply error. */
  91 enum
  92 {
  93   /* Route map rule is missing. */
  94   RMAP_RULE_MISSING = 1,
  95
  96   /* Route map rule can't compile */
  97   RMAP_COMPILE_ERROR
  98 };
  99
 100 /* Route map rule list. */
 101 struct route_map_rule_list
 102 {
 103   struct route_map_rule *head;
 104   struct route_map_rule *tail;
 105 };
 106
 107 /* Route map index structure. */
 108 struct route_map_index
 109 {
 110   struct route_map *map;
 111
 112   /* Preference of this route map rule. */
 113   int pref;
 114
 115   /* Route map type permit or deny. */
 116   enum route_map_type type;
 117
 118   /* Do we follow old rules, or hop forward? */
 119   route_map_end_t exitpolicy;
 120
 121   /* If we're using "GOTO", to where do we go? */
 122   int nextpref;
 123
 124   /* If we're using "CALL", to which route-map do ew go? */
 125   char *nextrm;
 126
 127   /* Matching rule list. */
 128   struct route_map_rule_list match_list;
 129   struct route_map_rule_list set_list;
 130
 131   /* Make linked list. */
 132   struct route_map_index *next;
 133   struct route_map_index *prev;
 134 };
 135
 136 /* Route map list structure. */
 137 struct route_map
 138 {
 139   /* Name of route map. */
 140   char *name;
 141
 142   /* Route map's rule. */
 143   struct route_map_index *head;
 144   struct route_map_index *tail;
 145
 146   /* Make linked list. */
 147   struct route_map *next;
 148   struct route_map *prev;
 149 };
 150
 151 /* Prototypes. */
 152 void route_map_init ();
 153 void route_map_init_vty ();
 154
 155 /* Add match statement to route map. */
 156 int
 157 route_map_add_match (struct route_map_index *index,
 158                      const char *match_name,
 159                      const char *match_arg);
 160
 161 /* Delete specified route match rule. */
 162 int
 163 route_map_delete_match (struct route_map_index *index,
 164                         const char *match_name,
 165                         const char *match_arg);
 166
 167 /* Add route-map set statement to the route map. */
 168 int
 169 route_map_add_set (struct route_map_index *index,
 170                    const char *set_name,
 171                    const char *set_arg);
 172
 173 /* Delete route map set rule. */
 174 int
 175 route_map_delete_set (struct route_map_index *index, const char *set_name,
 176                       const char *set_arg);
 177
 178 /* Install rule command to the match list. */
 179 void
 180 route_map_install_match (struct route_map_rule_cmd *cmd);
 181
 182 /* Install rule command to the set list. */
 183 void
 184 route_map_install_set (struct route_map_rule_cmd *cmd);
 185
 186 /* Lookup route map by name. */
 187 struct route_map *
 188 route_map_lookup_by_name (const char *name);
 189
 190 /* Apply route map to the object. */
 191 route_map_result_t
 192 route_map_apply (struct route_map *map, struct prefix *,
 193                  route_map_object_t object_type, void *object);
 194
 195 void route_map_add_hook (void (*func) (const char *));
 196 void route_map_delete_hook (void (*func) (const char *));
 197 void route_map_event_hook (void (*func) (route_map_event_t, const char *));
 198
 199
 200 #endif /* _ZEBRA_ROUTEMAP_H */