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