bgpd/bgp_damp.h

   1 /* BGP flap dampening
   2  * Copyright (C) 2001 IP Infusion Inc.
   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 _QUAGGA_BGP_DAMP_H
  22 #define _QUAGGA_BGP_DAMP_H
  23
  24 #include "bgpd/bgp_table.h"
  25
  26 /* Structure maintained on a per-route basis. */
  27 struct bgp_damp_info {
  28         /* Figure-of-merit.  */
  29         unsigned int penalty;
  30
  31         /* Number of flapping.  */
  32         unsigned int flap;
  33
  34         /* First flap time  */
  35         time_t start_time;
  36
  37         /* Last time penalty was updated.  */
  38         time_t t_updated;
  39
  40         /* Time of route start to be suppressed.  */
  41         time_t suppress_time;
  42
  43         /* Back reference to associated dampening configuration. */
  44         struct bgp_damp_config *config;
  45
  46         /* Back reference to bgp_path_info. */
  47         struct bgp_path_info *path;
  48
  49         /* Back reference to bgp_node. */
  50         struct bgp_dest *dest;
  51
  52         /* Current index in the reuse_list. */
  53         int index;
  54 #define BGP_DAMP_NO_REUSE_LIST_INDEX                                           \
  55         (-1) /* index for elements on no_reuse_list */
  56
  57         /* Last time message type. */
  58         uint8_t lastrecord;
  59 #define BGP_RECORD_UPDATE       1U
  60 #define BGP_RECORD_WITHDRAW     2U
  61
  62         afi_t afi;
  63         safi_t safi;
  64
  65         SLIST_ENTRY(bgp_damp_info) entry;
  66 };
  67
  68 SLIST_HEAD(reuselist, bgp_damp_info);
  69
  70 /* Specified parameter set configuration. */
  71 struct bgp_damp_config {
  72         /* Value over which routes suppressed.  */
  73         unsigned int suppress_value;
  74
  75         /* Value below which suppressed routes reused.  */
  76         unsigned int reuse_limit;
  77
  78         /* Max time a route can be suppressed.  */
  79         time_t max_suppress_time;
  80
  81         /* Time during which accumulated penalty reduces by half.  */
  82         time_t half_life;
  83
  84         /* Non-configurable parameters but fixed at implementation time.
  85          * To change this values, init_bgp_damp() should be modified.
  86          */
  87         time_t tmax; /* Max time previous instability retained */
  88         unsigned int reuse_list_size;  /* Number of reuse lists */
  89         unsigned int reuse_index_size; /* Size of reuse index array */
  90
  91         /* Non-configurable parameters.  Most of these are calculated from
  92          * the configurable parameters above.
  93          */
  94         unsigned int ceiling;             /* Max value a penalty can attain */
  95         unsigned int decay_rate_per_tick; /* Calculated from half-life */
  96         unsigned int decay_array_size; /* Calculated using config parameters */
  97         double scale_factor;
  98         unsigned int reuse_scale_factor;
  99
 100         /* Decay array per-set based. */
 101         double *decay_array;
 102
 103         /* Reuse index array per-set based. */
 104         int *reuse_index;
 105
 106         /* Reuse list array per-set based. */
 107         struct reuselist *reuse_list;
 108         unsigned int reuse_offset;
 109
 110         /* All dampening information which is not on reuse list.  */
 111         struct reuselist no_reuse_list;
 112
 113         /* Reuse timer thread per-set base. */
 114         struct thread *t_reuse;
 115
 116         afi_t afi;
 117         safi_t safi;
 118 };
 119
 120 #define BGP_DAMP_NONE           0
 121 #define BGP_DAMP_USED           1
 122 #define BGP_DAMP_SUPPRESSED     2
 123
 124 /* Time granularity for reuse lists */
 125 #define DELTA_REUSE               10
 126
 127 /* Time granularity for decay arrays */
 128 #define DELTA_T                    5
 129
 130 #define DEFAULT_PENALTY         1000
 131
 132 #define DEFAULT_HALF_LIFE         15
 133 #define DEFAULT_REUSE            750
 134 #define DEFAULT_SUPPRESS        2000
 135
 136 #define REUSE_LIST_SIZE          256
 137 #define REUSE_ARRAY_SIZE        1024
 138
 139 extern struct bgp_damp_config *get_active_bdc_from_pi(struct bgp_path_info *pi,
 140                                                       afi_t afi, safi_t safi);
 141 extern int bgp_damp_enable(struct bgp *, afi_t, safi_t, time_t, unsigned int,
 142                            unsigned int, time_t);
 143 extern int bgp_damp_disable(struct bgp *, afi_t, safi_t);
 144 extern int bgp_damp_withdraw(struct bgp_path_info *path, struct bgp_dest *dest,
 145                              afi_t afi, safi_t safi, int attr_change);
 146 extern int bgp_damp_update(struct bgp_path_info *path, struct bgp_dest *dest,
 147                            afi_t afi, safi_t saff);
 148 extern void bgp_damp_info_free(struct bgp_damp_info *bdi, int withdraw);
 149 extern void bgp_damp_info_clean(struct bgp *bgp, struct bgp_damp_config *bdc,
 150                                 afi_t afi, safi_t safi);
 151 extern void bgp_damp_config_clean(struct bgp_damp_config *bdc);
 152 extern int bgp_damp_decay(time_t, int, struct bgp_damp_config *damp);
 153 extern void bgp_config_write_damp(struct vty *vty, struct bgp *bgp, afi_t afi,
 154                                   safi_t safi);
 155 extern void bgp_damp_info_vty(struct vty *vty, struct bgp *bgp,
 156                               struct bgp_path_info *path, afi_t afi,
 157                               safi_t safi, json_object *json_path);
 158 extern const char *bgp_damp_reuse_time_vty(struct vty *vty,
 159                                            struct bgp_path_info *path,
 160                                            char *timebuf, size_t len, afi_t afi,
 161                                            safi_t safi, bool use_json,
 162                                            json_object *json);
 163 extern int bgp_show_dampening_parameters(struct vty *vty, afi_t, safi_t,
 164                                          uint16_t);
 165 extern void bgp_peer_damp_enable(struct peer *peer, afi_t afi, safi_t safi,
 166                                  time_t half, unsigned int reuse,
 167                                  unsigned int suppress, time_t max);
 168 extern void bgp_peer_damp_disable(struct peer *peer, afi_t afi, safi_t safi);
 169 extern void bgp_config_write_peer_damp(struct vty *vty, struct peer *peer,
 170                                        afi_t afi, safi_t safi);
 171 extern void bgp_show_peer_dampening_parameters(struct vty *vty,
 172                                                struct peer *peer, afi_t afi,
 173                                                safi_t safi, bool use_json);
 174
 175 #endif /* _QUAGGA_BGP_DAMP_H */