bgpd/bgp_route.h

   1 /* BGP routing information base
   2    Copyright (C) 1996, 97, 98, 2000 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 #ifndef _QUAGGA_BGP_ROUTE_H
  22 #define _QUAGGA_BGP_ROUTE_H
  23
  24 #include "queue.h"
  25 #include "bgp_table.h"
  26
  27 struct bgp_nexthop_cache;
  28
  29 /* Ancillary information to struct bgp_info,
  30  * used for uncommonly used data (aggregation, MPLS, etc.)
  31  * and lazily allocated to save memory.
  32  */
  33 struct bgp_info_extra
  34 {
  35   /* Pointer to dampening structure.  */
  36   struct bgp_damp_info *damp_info;
  37
  38   /* This route is suppressed with aggregation.  */
  39   int suppress;
  40
  41   /* Nexthop reachability check.  */
  42   u_int32_t igpmetric;
  43
  44   /* MPLS label.  */
  45   u_char tag[3];
  46 };
  47
  48 struct bgp_info
  49 {
  50   /* For linked list. */
  51   struct bgp_info *next;
  52   struct bgp_info *prev;
  53
  54   /* For nexthop linked list */
  55   LIST_ENTRY(bgp_info) nh_thread;
  56
  57   /* Back pointer to the prefix node */
  58   struct bgp_node *net;
  59
  60   /* Back pointer to the nexthop structure */
  61   struct bgp_nexthop_cache *nexthop;
  62
  63   /* Peer structure.  */
  64   struct peer *peer;
  65
  66   /* Attribute structure.  */
  67   struct attr *attr;
  68
  69   /* Extra information */
  70   struct bgp_info_extra *extra;
  71
  72
  73   /* Multipath information */
  74   struct bgp_info_mpath *mpath;
  75
  76   /* Uptime.  */
  77   time_t uptime;
  78
  79   /* reference count */
  80   int lock;
  81
  82   /* BGP information status.  */
  83   u_int16_t flags;
  84 #define BGP_INFO_IGP_CHANGED    (1 << 0)
  85 #define BGP_INFO_DAMPED         (1 << 1)
  86 #define BGP_INFO_HISTORY        (1 << 2)
  87 #define BGP_INFO_SELECTED       (1 << 3)
  88 #define BGP_INFO_VALID          (1 << 4)
  89 #define BGP_INFO_ATTR_CHANGED   (1 << 5)
  90 #define BGP_INFO_DMED_CHECK     (1 << 6)
  91 #define BGP_INFO_DMED_SELECTED  (1 << 7)
  92 #define BGP_INFO_STALE          (1 << 8)
  93 #define BGP_INFO_REMOVED        (1 << 9)
  94 #define BGP_INFO_COUNTED        (1 << 10)
  95 #define BGP_INFO_MULTIPATH      (1 << 11)
  96 #define BGP_INFO_MULTIPATH_CHG  (1 << 12)
  97
  98   /* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
  99   u_char type;
 100
 101   /* When above type is BGP.  This sub type specify BGP sub type
 102      information.  */
 103   u_char sub_type;
 104 #define BGP_ROUTE_NORMAL       0
 105 #define BGP_ROUTE_STATIC       1
 106 #define BGP_ROUTE_AGGREGATE    2
 107 #define BGP_ROUTE_REDISTRIBUTE 3
 108 };
 109
 110 /* BGP static route configuration. */
 111 struct bgp_static
 112 {
 113   /* Backdoor configuration.  */
 114   int backdoor;
 115
 116   /* Import check status.  */
 117   u_char valid;
 118
 119   /* IGP metric. */
 120   u_int32_t igpmetric;
 121
 122   /* IGP nexthop. */
 123   struct in_addr igpnexthop;
 124
 125   /* Atomic set reference count (ie cause of pathlimit) */
 126   u_int32_t atomic;
 127
 128   /* BGP redistribute route-map.  */
 129   struct
 130   {
 131     char *name;
 132     struct route_map *map;
 133   } rmap;
 134
 135   /* Route Distinguisher */
 136   struct prefix_rd     prd;
 137
 138   /* MPLS label.  */
 139   u_char tag[3];
 140 };
 141
 142 #define BGP_INFO_COUNTABLE(BI) \
 143   (! CHECK_FLAG ((BI)->flags, BGP_INFO_HISTORY) \
 144    && ! CHECK_FLAG ((BI)->flags, BGP_INFO_REMOVED))
 145
 146 /* Flags which indicate a route is unuseable in some form */
 147 #define BGP_INFO_UNUSEABLE \
 148   (BGP_INFO_HISTORY|BGP_INFO_DAMPED|BGP_INFO_REMOVED)
 149 /* Macro to check BGP information is alive or not.  Sadly,
 150  * not equivalent to just checking previous, because of the
 151  * sense of the additional VALID flag.
 152  */
 153 #define BGP_INFO_HOLDDOWN(BI) \
 154   (! CHECK_FLAG ((BI)->flags, BGP_INFO_VALID) \
 155    || CHECK_FLAG ((BI)->flags, BGP_INFO_UNUSEABLE))
 156
 157 #define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
 158 #define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
 159 #define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
 160 #define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)
 161
 162 #define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
 163 #define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
 164 #define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
 165 #define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)
 166
 167 #define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
 168 #define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
 169 #define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
 170 #define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)
 171
 172 #define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
 173 #define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
 174 #define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
 175 #define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)
 176
 177 #define ROUTE_MAP_IMPORT_NAME(F)    ((F)->map[RMAP_IMPORT].name)
 178 #define ROUTE_MAP_IMPORT(F)    ((F)->map[RMAP_IMPORT].map)
 179 #define ROUTE_MAP_EXPORT_NAME(F)    ((F)->map[RMAP_EXPORT].name)
 180 #define ROUTE_MAP_EXPORT(F)    ((F)->map[RMAP_EXPORT].map)
 181
 182 #define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
 183 #define UNSUPPRESS_MAP(F)       ((F)->usmap.map)
 184
 185 enum bgp_clear_route_type
 186 {
 187   BGP_CLEAR_ROUTE_NORMAL,
 188   BGP_CLEAR_ROUTE_MY_RSCLIENT
 189 };
 190
 191 enum bgp_path_type
 192 {
 193   BGP_PATH_ALL,
 194   BGP_PATH_BESTPATH,
 195   BGP_PATH_MULTIPATH
 196 };
 197
 198 /* Prototypes. */
 199 extern void bgp_route_init (void);
 200 extern void bgp_route_finish (void);
 201 extern void bgp_cleanup_routes (void);
 202 extern void bgp_announce_route (struct peer *, afi_t, safi_t);
 203 extern void bgp_announce_route_all (struct peer *);
 204 extern void bgp_default_originate (struct peer *, afi_t, safi_t, int);
 205 extern void bgp_soft_reconfig_in (struct peer *, afi_t, safi_t);
 206 extern void bgp_soft_reconfig_rsclient (struct peer *, afi_t, safi_t);
 207 extern void bgp_check_local_routes_rsclient (struct peer *rsclient, afi_t afi, safi_t safi);
 208 extern void bgp_clear_route (struct peer *, afi_t, safi_t,
 209                              enum bgp_clear_route_type);
 210 extern void bgp_clear_route_all (struct peer *);
 211 extern void bgp_clear_adj_in (struct peer *, afi_t, safi_t);
 212 extern void bgp_clear_stale_route (struct peer *, afi_t, safi_t);
 213
 214 extern struct bgp_info *bgp_info_lock (struct bgp_info *);
 215 extern struct bgp_info *bgp_info_unlock (struct bgp_info *);
 216 extern void bgp_info_add (struct bgp_node *rn, struct bgp_info *ri);
 217 extern void bgp_info_delete (struct bgp_node *rn, struct bgp_info *ri);
 218 extern struct bgp_info_extra *bgp_info_extra_get (struct bgp_info *);
 219 extern void bgp_info_set_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
 220 extern void bgp_info_unset_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
 221
 222 extern int bgp_nlri_parse_ip (struct peer *, struct attr *, struct bgp_nlri *);
 223
 224 extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);
 225
 226 extern void bgp_redistribute_add (struct prefix *, const struct in_addr *,
 227                                   const struct in6_addr *,
 228                                   u_int32_t, u_char, route_tag_t);
 229 extern void bgp_redistribute_delete (struct prefix *, u_char);
 230 extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int);
 231
 232 extern void bgp_static_delete (struct bgp *);
 233 extern void bgp_static_update (struct bgp *, struct prefix *, struct bgp_static *,
 234                         afi_t, safi_t);
 235 extern void bgp_static_withdraw (struct bgp *, struct prefix *, afi_t, safi_t);
 236
 237 extern int bgp_static_set_safi (safi_t safi, struct vty *vty, const char *,
 238                           const char *, const char *, const char *);
 239
 240 extern int bgp_static_unset_safi (safi_t safi, struct vty *, const char *,
 241                             const char *, const char *);
 242
 243 /* this is primarily for MPLS-VPN */
 244 extern int bgp_update (struct peer *, struct prefix *, struct attr *,
 245                        afi_t, safi_t, int, int, struct prefix_rd *,
 246                        u_char *, int);
 247 extern int bgp_withdraw (struct peer *, struct prefix *, struct attr *,
 248                          afi_t, safi_t, int, int, struct prefix_rd *, u_char *);
 249
 250 /* for bgp_nexthop and bgp_damp */
 251 extern void bgp_process (struct bgp *, struct bgp_node *, afi_t, safi_t);
 252 extern int bgp_config_write_network (struct vty *, struct bgp *, afi_t, safi_t, int *);
 253 extern int bgp_config_write_distance (struct vty *, struct bgp *, afi_t, safi_t, int *);
 254
 255 extern void bgp_aggregate_increment (struct bgp *, struct prefix *, struct bgp_info *,
 256                               afi_t, safi_t);
 257 extern void bgp_aggregate_decrement (struct bgp *, struct prefix *, struct bgp_info *,
 258                               afi_t, safi_t);
 259
 260 extern u_char bgp_distance_apply (struct prefix *, struct bgp_info *, struct bgp *);
 261 extern u_char ipv6_bgp_distance_apply (struct prefix *, struct bgp_info *, struct bgp *);
 262
 263 extern afi_t bgp_node_afi (struct vty *);
 264 extern safi_t bgp_node_safi (struct vty *);
 265
 266 extern void route_vty_out (struct vty *, struct prefix *, struct bgp_info *, int, safi_t);
 267 extern void route_vty_out_tag (struct vty *, struct prefix *, struct bgp_info *, int, safi_t);
 268 extern void route_vty_out_tmp (struct vty *, struct prefix *, struct attr *, safi_t);
 269
 270 extern void bgp_peer_clear_node_queue_drain_immediate (struct peer *peer);
 271 extern void bgp_process_queues_drain_immediate (void);
 272
 273 #endif /* _QUAGGA_BGP_ROUTE_H */