proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-11-04 08:28:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
01485adb9d
mirror_frr/lib/routemap.h
Donald Sharp 1782514fb9 *: Remove route_map_object_t from the system 
The route_map_object_t was being used to track what protocol we were
being called against.  But each protocol was only ever calling itself.
So we had a variable that was only ever being passed in from route_map_apply
that had to be carried against and everyone was testing if that variable
was for their own stack.

Clean up this route_map_object_t from the entire system.  We should
speed some stuff up.  Yes I know not a bunch but this will add up.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-11-13 19:35:20 -05:00

719 lines
24 KiB
C
Raw Blame History

/* 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"
#include "lib/plist.h"
#include "lib/plist_int.h"
#ifdef __cplusplus
extern "C" {
#endif
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_DENYMATCH,
RMAP_PERMITMATCH
} route_map_result_t;
/*
* Route-map match or set result "Eg: match evpn vni xx"
* route-map match cmd always returns match/nomatch/noop
* match--> found a match
* nomatch--> didnt find a match
* noop--> not applicable
* route-map set retuns okay/error
* okay --> set was successful
* error --> set was not successful
*/
enum route_map_cmd_result_t {
/*
* route-map match cmd results
*/
RMAP_MATCH,
RMAP_NOMATCH,
RMAP_NOOP,
/*
* route-map set cmd results
*/
RMAP_OKAY,
RMAP_ERROR
};
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. */
enum route_map_cmd_result_t (*func_apply)(void *rule,
const struct prefix *prefix,
void *object);
/* Compile argument and return result as void *. */
void *(*func_compile)(const char *);
/* Free allocated value by func_compile (). */
void (*func_free)(void *);
/** To get the rule key after Compilation **/
void *(*func_get_rmap_rule_key)(void *val);
};
/* Route map apply error. */
enum rmap_compile_rets {
RMAP_COMPILE_SUCCESS,
/* Route map rule is missing. */
RMAP_RULE_MISSING,
/* Route map rule can't compile */
RMAP_COMPILE_ERROR,
};
/* Route map rule. This rule has both `match' rule and `set' rule. */
struct route_map_rule {
/* Rule type. */
const struct route_map_rule_cmd *cmd;
/* For pretty printing. */
char *rule_str;
/* Pre-compiled match rule. */
void *value;
/* Linked list. */
struct route_map_rule *next;
struct route_map_rule *prev;
};
/* Route map rule list. */
struct route_map_rule_list {
struct route_map_rule *head;
struct route_map_rule *tail;
};
/* Forward struct declaration: the complete can be found later this file. */
struct routemap_hook_context;
/* 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;
/* Keep track how many times we've try to apply */
uint64_t applied;
uint64_t applied_clear;
/* List of match/sets contexts. */
TAILQ_HEAD(, routemap_hook_context) rhclist;
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 */
bool to_be_processed; /* True if modification isn't acted on yet */
bool deleted; /* If 1, then this node will be deleted */
bool optimization_disabled;
/* How many times have we applied this route-map */
uint64_t applied;
uint64_t applied_clear;
/* Counter to track active usage of this route-map */
uint16_t use_count;
/* Tables to maintain IPv4 and IPv6 prefixes from
* the prefix-list match clause.
*/
struct route_table *ipv4_prefix_table;
struct route_table *ipv6_prefix_table;
QOBJ_FIELDS
};
DECLARE_QOBJ_TYPE(route_map)
/* Prototypes. */
extern void route_map_init(void);
/*
* This should only be called on shutdown
* Additionally this function sets the hooks to NULL
* before any processing is done.
*/
extern void route_map_finish(void);
/* Add match statement to route map. */
extern enum rmap_compile_rets route_map_add_match(struct route_map_index *index,
const char *match_name,
const char *match_arg,
route_map_event_t type);
/* Delete specified route match rule. */
extern enum rmap_compile_rets
route_map_delete_match(struct route_map_index *index,
const char *match_name, const char *match_arg,
route_map_event_t type);
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 enum rmap_compile_rets route_map_add_set(struct route_map_index *index,
const char *set_name,
const char *set_arg);
/* Delete route map set rule. */
extern enum rmap_compile_rets
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(const struct route_map_rule_cmd *cmd);
/*
* Install rule command to the set list.
*
* When installing a particular item, Allow a difference of handling
* of bad cli inputted(return NULL) -vs- this particular daemon cannot use
* this form of the command(return a pointer and handle it appropriately
* in the apply command). See 'set metric' command
* as it is handled in ripd/ripngd and ospfd.
*/
extern void route_map_install_set(const struct route_map_rule_cmd *cmd);
/* Lookup route map by name. */
extern struct route_map *route_map_lookup_by_name(const char *name);
/* Simple helper to warn if route-map does not exist. */
struct route_map *route_map_lookup_warn_noexist(struct vty *vty, const char *name);
/* Apply route map to the object. */
extern route_map_result_t route_map_apply(struct route_map *map,
const struct prefix *prefix,
void *object);
extern void route_map_add_hook(void (*func)(const char *));
extern void route_map_delete_hook(void (*func)(const char *));
/*
* This is the callback for when something has changed about a
* route-map. The interested parties can register to receive
* this data.
*
* name - Is the name of the changed route-map
*/
extern void route_map_event_hook(void (*func)(const char *name));
extern int route_map_mark_updated(const char *name);
extern void route_map_walk_update_list(void (*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 void
route_map_notify_pentry_dependencies(const char *affected_name,
struct prefix_list_entry *pentry,
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 ip next hop type */
extern void route_map_match_ip_next_hop_type_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 type */
extern void route_map_no_match_ip_next_hop_type_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 ipv6 next-hop type */
extern void route_map_match_ipv6_next_hop_type_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 next-hop type */
extern void route_map_no_match_ipv6_next_hop_type_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 sr-te color */
extern void route_map_set_srte_color_hook(
int (*func)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg));
/* no set sr-te color */
extern void route_map_no_set_srte_color_hook(
int (*func)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg));
/* 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);
/* Increment the route-map used counter */
extern void route_map_counter_increment(struct route_map *map);
/* Decrement the route-map used counter */
extern void route_map_counter_decrement(struct route_map *map);
/* Route map hooks data structure. */
struct route_map_match_set_hooks {
/* match interface */
int (*match_interface)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* no match interface */
int (*no_match_interface)(struct vty *vty,
struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* match ip address */
int (*match_ip_address)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* no match ip address */
int (*no_match_ip_address)(struct vty *vty,
struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* match ip address prefix list */
int (*match_ip_address_prefix_list)(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 */
int (*no_match_ip_address_prefix_list)(struct vty *vty,
struct route_map_index *index,
const char *command,
const char *arg,
route_map_event_t type);
/* match ip next hop */
int (*match_ip_next_hop)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* no match ip next hop */
int (*no_match_ip_next_hop)(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 */
int (*match_ip_next_hop_prefix_list)(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 */
int (*no_match_ip_next_hop_prefix_list)(struct vty *vty,
struct route_map_index *index,
const char *command,
const char *arg,
route_map_event_t type);
/* match ip next-hop type */
int (*match_ip_next_hop_type)(struct vty *vty,
struct route_map_index *index,
const char *command,
const char *arg,
route_map_event_t type);
/* no match ip next-hop type */
int (*no_match_ip_next_hop_type)(struct vty *vty,
struct route_map_index *index,
const char *command,
const char *arg,
route_map_event_t type);
/* match ipv6 address */
int (*match_ipv6_address)(struct vty *vty,
struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* no match ipv6 address */
int (*no_match_ipv6_address)(struct vty *vty,
struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* match ipv6 address prefix list */
int (*match_ipv6_address_prefix_list)(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 */
int (*no_match_ipv6_address_prefix_list)(struct vty *vty,
struct route_map_index *index,
const char *command,
const char *arg,
route_map_event_t type);
/* match ipv6 next-hop type */
int (*match_ipv6_next_hop_type)(struct vty *vty,
struct route_map_index *index,
const char *command,
const char *arg,
route_map_event_t type);
/* no match ipv6 next-hop type */
int (*no_match_ipv6_next_hop_type)(struct vty *vty,
struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* match metric */
int (*match_metric)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* no match metric */
int (*no_match_metric)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* match tag */
int (*match_tag)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* no match tag */
int (*no_match_tag)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg,
route_map_event_t type);
/* set sr-te color */
int (*set_srte_color)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
/* no set sr-te color */
int (*no_set_srte_color)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
/* set ip nexthop */
int (*set_ip_nexthop)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
/* no set ip nexthop */
int (*no_set_ip_nexthop)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
/* set ipv6 nexthop local */
int (*set_ipv6_nexthop_local)(struct vty *vty,
struct route_map_index *index,
const char *command, const char *arg);
/* no set ipv6 nexthop local */
int (*no_set_ipv6_nexthop_local)(struct vty *vty,
struct route_map_index *index,
const char *command, const char *arg);
/* set metric */
int (*set_metric)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
/* no set metric */
int (*no_set_metric)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
/* set tag */
int (*set_tag)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
/* no set tag */
int (*no_set_tag)(struct vty *vty, struct route_map_index *index,
const char *command, const char *arg);
};
extern struct route_map_match_set_hooks rmap_match_set_hook;
/* Making route map list. */
struct route_map_list {
struct route_map *head;
struct route_map *tail;
void (*add_hook)(const char *);
void (*delete_hook)(const char *);
void (*event_hook)(const char *);
};
extern struct route_map_list route_map_master;
extern struct route_map *route_map_get(const char *name);
extern void route_map_delete(struct route_map *map);
extern struct route_map_index *route_map_index_get(struct route_map *map,
enum route_map_type type,
int pref);
extern void route_map_index_delete(struct route_map_index *index, int notify);
/* routemap_northbound.c */
typedef int (*routemap_match_hook_fun)(struct vty *vty,
struct route_map_index *rmi,
const char *command, const char *arg,
route_map_event_t event);
typedef int (*routemap_set_hook_fun)(struct vty *vty,
struct route_map_index *rmi,
const char *command, const char *arg);
struct routemap_hook_context {
struct route_map_index *rhc_rmi;
const char *rhc_rule;
route_map_event_t rhc_event;
routemap_set_hook_fun rhc_shook;
routemap_match_hook_fun rhc_mhook;
TAILQ_ENTRY(routemap_hook_context) rhc_entry;
};
int lib_route_map_entry_match_destroy(struct nb_cb_destroy_args *args);
int lib_route_map_entry_set_destroy(struct nb_cb_destroy_args *args);
struct routemap_hook_context *
routemap_hook_context_insert(struct route_map_index *rmi);
void routemap_hook_context_free(struct routemap_hook_context *rhc);
extern const struct frr_yang_module_info frr_route_map_info;
/* routemap_cli.c */
extern void route_map_instance_show(struct vty *vty, struct lyd_node *dnode,
bool show_defaults);
extern void route_map_instance_show_end(struct vty *vty,
struct lyd_node *dnode);
extern void route_map_condition_show(struct vty *vty, struct lyd_node *dnode,
bool show_defaults);
extern void route_map_action_show(struct vty *vty, struct lyd_node *dnode,
bool show_defaults);
extern void route_map_exit_policy_show(struct vty *vty, struct lyd_node *dnode,
bool show_defaults);
extern void route_map_call_show(struct vty *vty, struct lyd_node *dnode,
bool show_defaults);
extern void route_map_description_show(struct vty *vty,
struct lyd_node *dnode,
bool show_defaults);
extern void route_map_cli_init(void);
#ifdef __cplusplus
}
#endif
#endif /* _ZEBRA_ROUTEMAP_H */
Reference in New Issue View Git Blame Copy Permalink