pimd/pimd.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
  16   along with this program; see the file COPYING; if not, write to the
  17   Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  18   MA 02110-1301 USA
  19
  20 */
  21
  22 #ifndef PIMD_H
  23 #define PIMD_H
  24
  25 #include <stdint.h>
  26
  27 #include "pim_memory.h"
  28 #include "pim_assert.h"
  29
  30 #define PIMD_PROGNAME       "pimd"
  31 #define PIMD_DEFAULT_CONFIG "pimd.conf"
  32 #define PIMD_VTY_PORT       2611
  33 #define PIMD_BUG_ADDRESS    "https://github.com/udhos/qpimd"
  34
  35 #define PIM_IP_HEADER_MIN_LEN         (20)
  36 #define PIM_IP_HEADER_MAX_LEN         (60)
  37 #define PIM_IP_PROTO_IGMP             (2)
  38 #define PIM_IP_PROTO_PIM              (103)
  39 #define PIM_IGMP_MIN_LEN              (8)
  40 #define PIM_MSG_HEADER_LEN            (4)
  41 #define PIM_PIM_MIN_LEN               PIM_MSG_HEADER_LEN
  42 #define PIM_PROTO_VERSION             (2)
  43
  44 #define MCAST_ALL_SYSTEMS      "224.0.0.1"
  45 #define MCAST_ALL_ROUTERS      "224.0.0.2"
  46 #define MCAST_ALL_PIM_ROUTERS  "224.0.0.13"
  47 #define MCAST_ALL_IGMP_ROUTERS "224.0.0.22"
  48
  49 #define PIM_FORCE_BOOLEAN(expr) ((expr) != 0)
  50
  51 #define PIM_NET_INADDR_ANY (htonl(INADDR_ANY))
  52 #define PIM_INADDR_IS_ANY(addr) (addr).s_addr == PIM_NET_INADDR_ANY
  53 #define PIM_INADDR_ISNOT_ANY(addr) ((addr).s_addr != PIM_NET_INADDR_ANY) /* struct in_addr addr */
  54
  55 #define PIM_MASK_PIM_EVENTS          (1 << 0)
  56 #define PIM_MASK_PIM_EVENTS_DETAIL   (1 << 1)
  57 #define PIM_MASK_PIM_PACKETS         (1 << 2)
  58 #define PIM_MASK_PIM_PACKETDUMP_SEND (1 << 3)
  59 #define PIM_MASK_PIM_PACKETDUMP_RECV (1 << 4)
  60 #define PIM_MASK_PIM_TRACE           (1 << 5)
  61 #define PIM_MASK_PIM_TRACE_DETAIL    (1 << 6)
  62 #define PIM_MASK_IGMP_EVENTS         (1 << 7)
  63 #define PIM_MASK_IGMP_PACKETS        (1 << 8)
  64 #define PIM_MASK_IGMP_TRACE          (1 << 9)
  65 #define PIM_MASK_IGMP_TRACE_DETAIL   (1 << 10)
  66 #define PIM_MASK_ZEBRA               (1 << 11)
  67 #define PIM_MASK_SSMPINGD            (1 << 12)
  68 #define PIM_MASK_MROUTE              (1 << 13)
  69 #define PIM_MASK_PIM_HELLO           (1 << 14)
  70 #define PIM_MASK_PIM_J_P             (1 << 15)
  71 #define PIM_MASK_STATIC              (1 << 16)
  72 #define PIM_MASK_PIM_REG             (1 << 17)
  73
  74 const char *const PIM_ALL_SYSTEMS;
  75 const char *const PIM_ALL_ROUTERS;
  76 const char *const PIM_ALL_PIM_ROUTERS;
  77 const char *const PIM_ALL_IGMP_ROUTERS;
  78
  79 extern struct thread_master     *master;
  80 uint32_t                  qpim_debugs;
  81 int                       qpim_mroute_socket_fd;
  82 int64_t                   qpim_mroute_socket_creation; /* timestamp of creation */
  83 struct thread            *qpim_mroute_socket_reader;
  84 int                       qpim_mroute_oif_highest_vif_index;
  85 struct list              *qpim_channel_oil_list; /* list of struct channel_oil */
  86 struct in_addr            qpim_all_pim_routers_addr;
  87 int                       qpim_t_periodic; /* Period between Join/Prune Messages */
  88 struct list              *qpim_upstream_list; /* list of struct pim_upstream */
  89 struct zclient           *qpim_zclient_update;
  90 struct zclient           *qpim_zclient_lookup;
  91 struct pim_assert_metric  qpim_infinite_assert_metric;
  92 long                      qpim_rpf_cache_refresh_delay_msec;
  93 struct thread            *qpim_rpf_cache_refresher;
  94 int64_t                   qpim_rpf_cache_refresh_requests;
  95 int64_t                   qpim_rpf_cache_refresh_events;
  96 int64_t                   qpim_rpf_cache_refresh_last;
  97 struct in_addr            qpim_inaddr_any;
  98 struct list              *qpim_ssmpingd_list; /* list of struct ssmpingd_sock */
  99 struct in_addr            qpim_ssmpingd_group_addr;
 100 int64_t                   qpim_scan_oil_events;
 101 int64_t                   qpim_scan_oil_last;
 102 int64_t                   qpim_mroute_add_events;
 103 int64_t                   qpim_mroute_add_last;
 104 int64_t                   qpim_mroute_del_events;
 105 int64_t                   qpim_mroute_del_last;
 106 struct list              *qpim_static_route_list; /* list of routes added statically */
 107
 108 #define PIM_JP_HOLDTIME (qpim_t_periodic * 7 / 2)
 109
 110 #define PIM_MROUTE_IS_ENABLED  (qpim_mroute_socket_fd >= 0)
 111 #define PIM_MROUTE_IS_DISABLED (qpim_mroute_socket_fd < 0)
 112
 113 /*
 114  * Register-Stop Timer (RST(S,G))
 115  * Default values
 116  */
 117 extern int32_t qpim_register_suppress_time;
 118 extern int32_t qpim_register_probe_time;
 119 #define PIM_REGISTER_SUPPRESSION_TIME_DEFAULT      (60)
 120 #define PIM_REGISTER_PROBE_TIME_DEFAULT            (5)
 121
 122 #define PIM_DEBUG_PIM_EVENTS          (qpim_debugs & PIM_MASK_PIM_EVENTS)
 123 #define PIM_DEBUG_PIM_EVENTS_DETAIL   (qpim_debugs & PIM_MASK_PIM_EVENTS_DETAIL)
 124 #define PIM_DEBUG_PIM_PACKETS         (qpim_debugs & PIM_MASK_PIM_PACKETS)
 125 #define PIM_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_SEND)
 126 #define PIM_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_RECV)
 127 #define PIM_DEBUG_PIM_TRACE           (qpim_debugs & PIM_MASK_PIM_TRACE)
 128 #define PIM_DEBUG_PIM_TRACE_DETAIL    (qpim_debugs & PIM_MASK_PIM_TRACE_DETAIL)
 129 #define PIM_DEBUG_IGMP_EVENTS         (qpim_debugs & PIM_MASK_IGMP_EVENTS)
 130 #define PIM_DEBUG_IGMP_PACKETS        (qpim_debugs & PIM_MASK_IGMP_PACKETS)
 131 #define PIM_DEBUG_IGMP_TRACE          (qpim_debugs & PIM_MASK_IGMP_TRACE)
 132 #define PIM_DEBUG_IGMP_TRACE_DETAIL   (qpim_debugs & PIM_MASK_IGMP_TRACE_DETAIL)
 133 #define PIM_DEBUG_ZEBRA               (qpim_debugs & PIM_MASK_ZEBRA)
 134 #define PIM_DEBUG_SSMPINGD            (qpim_debugs & PIM_MASK_SSMPINGD)
 135 #define PIM_DEBUG_MROUTE              (qpim_debugs & PIM_MASK_MROUTE)
 136 #define PIM_DEBUG_PIM_HELLO           (qpim_debugs & PIM_MASK_PIM_HELLO)
 137 #define PIM_DEBUG_PIM_J_P             (qpim_debugs & PIM_MASK_PIM_J_P)
 138 #define PIM_DEBUG_PIM_REG             (qpim_debugs & PIM_MASK_PIM_REG)
 139 #define PIM_DEBUG_STATIC              (qpim_debugs & PIM_MASK_STATIC)
 140
 141 #define PIM_DEBUG_EVENTS       (qpim_debugs & (PIM_MASK_PIM_EVENTS | PIM_MASK_IGMP_EVENTS))
 142 #define PIM_DEBUG_PACKETS      (qpim_debugs & (PIM_MASK_PIM_PACKETS | PIM_MASK_IGMP_PACKETS))
 143 #define PIM_DEBUG_TRACE        (qpim_debugs & (PIM_MASK_PIM_TRACE | PIM_MASK_IGMP_TRACE))
 144
 145 #define PIM_DO_DEBUG_PIM_EVENTS          (qpim_debugs |= PIM_MASK_PIM_EVENTS)
 146 #define PIM_DO_DEBUG_PIM_PACKETS         (qpim_debugs |= PIM_MASK_PIM_PACKETS)
 147 #define PIM_DO_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs |= PIM_MASK_PIM_PACKETDUMP_SEND)
 148 #define PIM_DO_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs |= PIM_MASK_PIM_PACKETDUMP_RECV)
 149 #define PIM_DO_DEBUG_PIM_TRACE           (qpim_debugs |= PIM_MASK_PIM_TRACE)
 150 #define PIM_DO_DEBUG_IGMP_EVENTS         (qpim_debugs |= PIM_MASK_IGMP_EVENTS)
 151 #define PIM_DO_DEBUG_IGMP_PACKETS        (qpim_debugs |= PIM_MASK_IGMP_PACKETS)
 152 #define PIM_DO_DEBUG_IGMP_TRACE          (qpim_debugs |= PIM_MASK_IGMP_TRACE)
 153 #define PIM_DO_DEBUG_IGMP_TRACE_DETAIL   (qpim_debugs |= PIM_MASK_IGMP_TRACE_DETAIL)
 154 #define PIM_DO_DEBUG_ZEBRA               (qpim_debugs |= PIM_MASK_ZEBRA)
 155 #define PIM_DO_DEBUG_SSMPINGD            (qpim_debugs |= PIM_MASK_SSMPINGD)
 156 #define PIM_DO_DEBUG_MROUTE              (qpim_debugs |= PIM_MASK_MROUTE)
 157 #define PIM_DO_DEBUG_PIM_HELLO           (qpim_debugs |= PIM_MASK_PIM_HELLO)
 158 #define PIM_DO_DEBUG_PIM_J_P             (qpim_debugs |= PIM_MASK_PIM_J_P)
 159 #define PIM_DO_DEBUG_PIM_REG             (qpim_debugs |= PIM_MASK_PIM_REG)
 160 #define PIM_DO_DEBUG_STATIC              (qpim_debugs |= PIM_MASK_STATIC)
 161
 162 #define PIM_DONT_DEBUG_PIM_EVENTS          (qpim_debugs &= ~PIM_MASK_PIM_EVENTS)
 163 #define PIM_DONT_DEBUG_PIM_PACKETS         (qpim_debugs &= ~PIM_MASK_PIM_PACKETS)
 164 #define PIM_DONT_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_SEND)
 165 #define PIM_DONT_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_RECV)
 166 #define PIM_DONT_DEBUG_PIM_TRACE           (qpim_debugs &= ~PIM_MASK_PIM_TRACE)
 167 #define PIM_DONT_DEBUG_IGMP_EVENTS         (qpim_debugs &= ~PIM_MASK_IGMP_EVENTS)
 168 #define PIM_DONT_DEBUG_IGMP_PACKETS        (qpim_debugs &= ~PIM_MASK_IGMP_PACKETS)
 169 #define PIM_DONT_DEBUG_IGMP_TRACE          (qpim_debugs &= ~PIM_MASK_IGMP_TRACE)
 170 #define PIM_DONT_DEBUG_IGMP_TRACE_DETAIL   (qpim_debugs &= ~PIM_MASK_IGMP_TRACE_DETAIL)
 171 #define PIM_DONT_DEBUG_ZEBRA               (qpim_debugs &= ~PIM_MASK_ZEBRA)
 172 #define PIM_DONT_DEBUG_SSMPINGD            (qpim_debugs &= ~PIM_MASK_SSMPINGD)
 173 #define PIM_DONT_DEBUG_MROUTE              (qpim_debugs &= ~PIM_MASK_MROUTE)
 174 #define PIM_DONT_DEBUG_PIM_HELLO           (qpim_debugs &= ~PIM_MASK_PIM_HELLO)
 175 #define PIM_DONT_DEBUG_PIM_J_P             (qpim_debugs &= ~PIM_MASK_PIM_J_P)
 176 #define PIM_DONT_DEBUG_PIM_REG             (qpim_debugs &= ~PIM_MASK_PIM_REG)
 177 #define PIM_DONT_DEBUG_STATIC              (qpim_debugs &= ~PIM_MASK_STATIC)
 178
 179 void pim_init(void);
 180 void pim_terminate(void);
 181
 182 extern void pim_route_map_init (void);
 183 extern void pim_route_map_terminate(void);
 184
 185 #endif /* PIMD_H */