bgpd: make bgp_info_cmp and multiple-path decision logic more regular

* bgp_route.c: (bgp_info_cmp) This function is supposed to return a
  preference between the given paths, and does so as binary either or.  When
  mpath was added, the binary return value was left as is and instead an out
  parameter 'paths_eq' was added to indicate the mpath-equality case.  It's
  a bit odd, as is the resulting logic in the caller.

  Regularise things again by making the function return a strcmp like
  trinary return value of -1,0,1.  Get rid of the mpath specific arguments,
  but pass in afi/safi as part of the general context - that plus the
  (struct bgp *) is enough to access configuration.

  Update the return values.

  The mpath check was testing the IGP metric for equality, even though
  previous to the mpath changes (and consistent with the behaviour of all
  the other tests bar the end), equality results in continuing through to
  the next comparison. Just go back to the previous way - each test finds a
  preference to return, or continues on to let further tests have a go.

  (bgp_best_selection) Get rid of the (struct bgp_maxpaths_cfg *) arg, we
  can't add state for every optional feature to the argument list - they
  have to look it up as needed. Do pass through the very general afi/safi
  context though (saves several lookups through the route_node).

  Adjust for the new trinary bgp_info_cmp return value and updated args.
  Do the mpath clearing/accumulation in one place, in each loop.

  Call to bgp_info_mpath_update similarly gets updated, as there's no cfg to
  pass.

  (bgp_process_{rsclient,main}) match bgp_best_selection changes.
* bgp_mpath.c: (bgp_mpath_is_configured_sort) Helper for whether mpath is
  enabled by peer sort.
  (bgp_mpath_is_configured) ditto, generally.
  (bgp_info_mpath_update) caller no longer has the cfg to pass in, look it
  up.
* bgp_mpath.h: Export the above and Match .c changes.

Requires commit:
 "bgpd: bgp_scan shouldn't queue up route_nodes with no routes for processing"

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
diff --git a/bgpd/bgp_mpath.c b/bgpd/bgp_mpath.c
index 7999d16..98b75b6 100644
--- a/bgpd/bgp_mpath.c
+++ b/bgpd/bgp_mpath.c
@@ -39,6 +39,33 @@
 #include "bgpd/bgp_ecommunity.h"
 #include "bgpd/bgp_mpath.h"
 
+bool
+bgp_mpath_is_configured_sort (struct bgp *bgp, bgp_peer_sort_t sort,
+                              afi_t afi, safi_t safi)
+{
+  struct bgp_maxpaths_cfg *cfg = &bgp->maxpaths[afi][safi];
+
+  /* XXX: BGP_DEFAULT_MAXPATHS is 1, and this test only seems to make sense
+   * if if it stays 1, so not sure the DEFAULT define is that useful.
+   */
+  switch (sort)
+    {
+      case BGP_PEER_IBGP:
+        return cfg->maxpaths_ibgp != BGP_DEFAULT_MAXPATHS;
+      case BGP_PEER_EBGP:
+        return cfg->maxpaths_ebgp != BGP_DEFAULT_MAXPATHS;
+      default:
+        return false;
+    }
+}
+
+bool
+bgp_mpath_is_configured (struct bgp *bgp, afi_t afi, safi_t safi)
+{
+  return bgp_mpath_is_configured_sort (bgp, BGP_PEER_IBGP, afi, safi)
+         || bgp_mpath_is_configured_sort (bgp, BGP_PEER_EBGP, afi, safi);
+}
+
 /*
  * bgp_maximum_paths_set
  *
@@ -395,7 +422,7 @@
 void
 bgp_info_mpath_update (struct bgp_node *rn, struct bgp_info *new_best,
                        struct bgp_info *old_best, struct list *mp_list,
-                       struct bgp_maxpaths_cfg *mpath_cfg)
+                        afi_t afi, safi_t safi)
 {
   u_int16_t maxpaths, mpath_count, old_mpath_count;
   struct listnode *mp_node, *mp_next_node;
@@ -410,8 +437,11 @@
   old_mpath_count = 0;
   prev_mpath = new_best;
   mp_node = listhead (mp_list);
+  struct bgp_maxpaths_cfg *mpath_cfg;
   debug = BGP_DEBUG (events, EVENTS);
 
+  mpath_cfg  = &new_best->peer->bgp->maxpaths[afi][safi];
+
   if (debug)
     prefix2str (&rn->p, pfx_buf, sizeof (pfx_buf));