bgpd/bgp_mpath.h

   1 /*
   2  * BGP Multipath
   3  * Copyright (C) 2010 Google Inc.
   4  *
   5  * This file is part of Quagga
   6  *
   7  * Quagga is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * Quagga is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _FRR_BGP_MPATH_H
  23 #define _FRR_BGP_MPATH_H
  24
  25 /* Supplemental information linked to bgp_path_info for keeping track of
  26  * multipath selections, lazily allocated to save memory
  27  */
  28 struct bgp_path_info_mpath {
  29         /* Points to the first multipath (on bestpath) or the next multipath */
  30         struct bgp_path_info_mpath *mp_next;
  31
  32         /* Points to the previous multipath or NULL on bestpath */
  33         struct bgp_path_info_mpath *mp_prev;
  34
  35         /* Points to bgp_path_info associated with this multipath info */
  36         struct bgp_path_info *mp_info;
  37
  38         /* When attached to best path, the number of selected multipaths */
  39         uint16_t mp_count;
  40
  41         /* Flags - relevant as noted. */
  42         uint16_t mp_flags;
  43 #define BGP_MP_LB_PRESENT 0x1 /* Link-bandwidth present for >= 1 path */
  44 #define BGP_MP_LB_ALL 0x2 /* Link-bandwidth present for all multipaths */
  45
  46         /* Aggregated attribute for advertising multipath route */
  47         struct attr *mp_attr;
  48
  49         /* Cumulative bandiwdth of all multipaths - attached to best path. */
  50         uint64_t cum_bw;
  51 };
  52
  53 /* Functions to support maximum-paths configuration */
  54 extern int bgp_maximum_paths_set(struct bgp *bgp, afi_t afi, safi_t safi,
  55                                  int peertype, uint16_t maxpaths,
  56                                  bool clusterlen);
  57 extern int bgp_maximum_paths_unset(struct bgp *bgp, afi_t afi, safi_t safi,
  58                                    int peertype);
  59
  60 /* Functions used by bgp_best_selection to record current
  61  * multipath selections
  62  */
  63 extern int bgp_path_info_nexthop_cmp(struct bgp_path_info *bpi1,
  64                                      struct bgp_path_info *bpi2);
  65 extern void bgp_mp_list_init(struct list *mp_list);
  66 extern void bgp_mp_list_clear(struct list *mp_list);
  67 extern void bgp_mp_list_add(struct list *mp_list, struct bgp_path_info *mpinfo);
  68 extern void bgp_mp_dmed_deselect(struct bgp_path_info *dmed_best);
  69 extern void bgp_path_info_mpath_update(struct bgp *bgp, struct bgp_dest *dest,
  70                                        struct bgp_path_info *new_best,
  71                                        struct bgp_path_info *old_best,
  72                                        struct list *mp_list,
  73                                        struct bgp_maxpaths_cfg *mpath_cfg);
  74 extern void
  75 bgp_path_info_mpath_aggregate_update(struct bgp_path_info *new_best,
  76                                      struct bgp_path_info *old_best);
  77
  78 /* Unlink and free multipath information associated with a bgp_path_info */
  79 extern void bgp_path_info_mpath_dequeue(struct bgp_path_info *path);
  80 extern void bgp_path_info_mpath_free(struct bgp_path_info_mpath **mpath);
  81
  82 /* Walk list of multipaths associated with a best path */
  83 extern struct bgp_path_info *
  84 bgp_path_info_mpath_first(struct bgp_path_info *path);
  85 extern struct bgp_path_info *
  86 bgp_path_info_mpath_next(struct bgp_path_info *path);
  87
  88 /* Accessors for multipath information */
  89 extern uint32_t bgp_path_info_mpath_count(struct bgp_path_info *path);
  90 extern struct attr *bgp_path_info_mpath_attr(struct bgp_path_info *path);
  91 extern bool bgp_path_info_mpath_chkwtd(struct bgp *bgp,
  92                                        struct bgp_path_info *path);
  93 extern uint64_t bgp_path_info_mpath_cumbw(struct bgp_path_info *path);
  94
  95 #endif /* _FRR_BGP_MPATH_H */