pimd/pim_rpf.h

   1 /*
   2  * PIM for Quagga
   3  * Copyright (C) 2008  Everton da Silva Marques
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; see the file COPYING; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef PIM_RPF_H
  21 #define PIM_RPF_H
  22
  23 #include <zebra.h>
  24
  25 #include "pim_upstream.h"
  26 #include "pim_neighbor.h"
  27
  28 /*
  29   RFC 4601:
  30
  31   Metric Preference
  32     Preference value assigned to the unicast routing protocol that
  33     provided the route to the multicast source or Rendezvous-Point.
  34
  35   Metric
  36     The unicast routing table metric associated with the route used to
  37     reach the multicast source or Rendezvous-Point.  The metric is in
  38     units applicable to the unicast routing protocol used.
  39 */
  40 struct pim_nexthop {
  41         struct in_addr last_lookup;
  42         long long last_lookup_time;
  43         struct interface *interface;     /* RPF_interface(S) */
  44         struct prefix mrib_nexthop_addr; /* MRIB.next_hop(S) */
  45         uint32_t mrib_metric_preference; /* MRIB.pref(S) */
  46         uint32_t mrib_route_metric;      /* MRIB.metric(S) */
  47         struct pim_neighbor *nbr;
  48 };
  49
  50 struct pim_rpf {
  51         struct pim_nexthop source_nexthop;
  52         struct prefix rpf_addr; /* RPF'(S,G) */
  53 };
  54
  55 enum pim_rpf_result { PIM_RPF_OK = 0, PIM_RPF_CHANGED, PIM_RPF_FAILURE };
  56
  57 struct pim_upstream;
  58
  59 unsigned int pim_rpf_hash_key(void *arg);
  60 bool pim_rpf_equal(const void *arg1, const void *arg2);
  61
  62 int pim_nexthop_lookup(struct pim_instance *pim, struct pim_nexthop *nexthop,
  63                        struct in_addr addr, int neighbor_needed);
  64 enum pim_rpf_result pim_rpf_update(struct pim_instance *pim,
  65                                    struct pim_upstream *up, struct pim_rpf *old,
  66                                    uint8_t is_new);
  67
  68 int pim_rpf_addr_is_inaddr_none(struct pim_rpf *rpf);
  69 int pim_rpf_addr_is_inaddr_any(struct pim_rpf *rpf);
  70
  71 int pim_rpf_is_same(struct pim_rpf *rpf1, struct pim_rpf *rpf2);
  72 void pim_rpf_set_refresh_time(struct pim_instance *pim);
  73 #endif /* PIM_RPF_H */