pimd/pim_assert.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_ASSERT_H
  21 #define PIM_ASSERT_H
  22
  23 #include <zebra.h>
  24
  25 #include "if.h"
  26
  27 struct pim_ifchannel;
  28 struct pim_neighbor;
  29
  30 enum pim_ifassert_state {
  31         PIM_IFASSERT_NOINFO,
  32         PIM_IFASSERT_I_AM_WINNER,
  33         PIM_IFASSERT_I_AM_LOSER
  34 };
  35
  36 struct pim_assert_metric {
  37         uint32_t rpt_bit_flag;
  38         uint32_t metric_preference;
  39         uint32_t route_metric;
  40         pim_addr ip_address; /* neighbor router that sourced the Assert
  41                                       message */
  42 };
  43
  44 /*
  45   RFC 4601: 4.11.  Timer Values
  46
  47   Note that for historical reasons, the Assert message lacks a
  48   Holdtime field.  Thus, changing the Assert Time from the default
  49   value is not recommended.
  50  */
  51 #define PIM_ASSERT_OVERRIDE_INTERVAL (3)   /* seconds */
  52 #define PIM_ASSERT_TIME              (180) /* seconds */
  53
  54 #define PIM_ASSERT_METRIC_PREFERENCE_MAX (0xFFFFFFFF)
  55 #define PIM_ASSERT_ROUTE_METRIC_MAX      (0xFFFFFFFF)
  56
  57 void pim_ifassert_winner_set(struct pim_ifchannel *ch,
  58                              enum pim_ifassert_state new_state, pim_addr winner,
  59                              struct pim_assert_metric winner_metric);
  60
  61 int pim_assert_recv(struct interface *ifp, struct pim_neighbor *neigh,
  62                     pim_addr src_addr, uint8_t *buf, int buf_size);
  63
  64 int pim_assert_metric_better(const struct pim_assert_metric *m1,
  65                              const struct pim_assert_metric *m2);
  66 int pim_assert_metric_match(const struct pim_assert_metric *m1,
  67                             const struct pim_assert_metric *m2);
  68
  69 int pim_assert_build_msg(uint8_t *pim_msg, int buf_size, struct interface *ifp,
  70                          pim_addr group_addr, pim_addr source_addr,
  71                          uint32_t metric_preference, uint32_t route_metric,
  72                          uint32_t rpt_bit_flag);
  73
  74 int pim_assert_send(struct pim_ifchannel *ch);
  75
  76 int assert_action_a1(struct pim_ifchannel *ch);
  77 void assert_action_a4(struct pim_ifchannel *ch);
  78 void assert_action_a5(struct pim_ifchannel *ch);
  79
  80 #endif /* PIM_ASSERT_H */