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 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 PIMD_H
  21 #define PIMD_H
  22
  23 #include <stdint.h>
  24 #include "zebra.h"
  25 #include "libfrr.h"
  26 #include "prefix.h"
  27 #include "vty.h"
  28 #include "plist.h"
  29
  30 #include "pim_instance.h"
  31 #include "pim_str.h"
  32 #include "pim_memory.h"
  33 #include "pim_assert.h"
  34
  35 #define PIMD_PROGNAME       "pimd"
  36 #define PIMD_DEFAULT_CONFIG "pimd.conf"
  37 #define PIMD_VTY_PORT       2611
  38
  39 #define PIM_IP_PROTO_IGMP             (2)
  40 #define PIM_IP_PROTO_PIM              (103)
  41 #define PIM_IGMP_MIN_LEN              (8)
  42
  43 #define PIM_ENFORCE_LOOPFREE_MFC
  44
  45 /*
  46  * PIM MSG Header Format
  47  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  48  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  49  * |PIM Ver| Type  |   Reserved    |           Checksum            |
  50  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  51  */
  52 #define PIM_MSG_HEADER_LEN            (4)
  53 #define PIM_PIM_MIN_LEN               PIM_MSG_HEADER_LEN
  54
  55 #define PIM_ENCODED_IPV4_UCAST_SIZE    (6)
  56 #define PIM_ENCODED_IPV4_GROUP_SIZE    (8)
  57 #define PIM_ENCODED_IPV4_SOURCE_SIZE   (8)
  58
  59 /*
  60  * J/P Message Format, Group Header
  61  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  62  * |        Upstream Neighbor Address (Encoded-Unicast format)     |
  63  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  64  * |  Reserved     | Num groups    |          Holdtime             |
  65  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  66  * |         Multicast Group Address 1 (Encoded-Group format)      |
  67  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  68  * |   Number of Joined Sources    |   Number of Pruned Sources    |
  69  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  70  */
  71 #define PIM_JP_GROUP_HEADER_SIZE                                               \
  72         (PIM_ENCODED_IPV4_UCAST_SIZE + 1 + 1 + 2 + PIM_ENCODED_IPV4_GROUP_SIZE \
  73          + 2 + 2)
  74
  75 #define PIM_PROTO_VERSION             (2)
  76
  77 #define MCAST_ALL_SYSTEMS      "224.0.0.1"
  78 #define MCAST_ALL_ROUTERS      "224.0.0.2"
  79 #define MCAST_ALL_PIM_ROUTERS  "224.0.0.13"
  80 #define MCAST_ALL_IGMP_ROUTERS "224.0.0.22"
  81
  82 #define PIM_FORCE_BOOLEAN(expr) ((expr) != 0)
  83
  84 #define PIM_NET_INADDR_ANY (htonl(INADDR_ANY))
  85 #define PIM_INADDR_IS_ANY(addr) (addr).s_addr == PIM_NET_INADDR_ANY
  86 #define PIM_INADDR_ISNOT_ANY(addr) ((addr).s_addr != PIM_NET_INADDR_ANY) /* struct in_addr addr */
  87
  88 #define max(x,y) ((x) > (y) ? (x) : (y))
  89
  90 #define PIM_MASK_PIM_EVENTS          (1 << 0)
  91 #define PIM_MASK_PIM_EVENTS_DETAIL   (1 << 1)
  92 #define PIM_MASK_PIM_PACKETS         (1 << 2)
  93 #define PIM_MASK_PIM_PACKETDUMP_SEND (1 << 3)
  94 #define PIM_MASK_PIM_PACKETDUMP_RECV (1 << 4)
  95 #define PIM_MASK_PIM_TRACE           (1 << 5)
  96 #define PIM_MASK_PIM_TRACE_DETAIL    (1 << 6)
  97 #define PIM_MASK_IGMP_EVENTS         (1 << 7)
  98 #define PIM_MASK_IGMP_PACKETS        (1 << 8)
  99 #define PIM_MASK_IGMP_TRACE          (1 << 9)
 100 #define PIM_MASK_IGMP_TRACE_DETAIL   (1 << 10)
 101 #define PIM_MASK_ZEBRA               (1 << 11)
 102 #define PIM_MASK_SSMPINGD            (1 << 12)
 103 #define PIM_MASK_MROUTE              (1 << 13)
 104 #define PIM_MASK_MROUTE_DETAIL       (1 << 14)
 105 #define PIM_MASK_PIM_HELLO           (1 << 15)
 106 #define PIM_MASK_PIM_J_P             (1 << 16)
 107 #define PIM_MASK_STATIC              (1 << 17)
 108 #define PIM_MASK_PIM_REG             (1 << 18)
 109 #define PIM_MASK_MSDP_EVENTS         (1 << 19)
 110 #define PIM_MASK_MSDP_PACKETS        (1 << 20)
 111 #define PIM_MASK_MSDP_INTERNAL       (1 << 21)
 112 #define PIM_MASK_PIM_NHT             (1 << 22)
 113 #define PIM_MASK_PIM_NHT_DETAIL      (1 << 23)
 114 #define PIM_MASK_PIM_NHT_RP          (1 << 24)
 115 #define PIM_MASK_MTRACE              (1 << 25)
 116 #define PIM_MASK_VXLAN               (1 << 26)
 117 #define PIM_MASK_BSM_PROC            (1 << 27)
 118 #define PIM_MASK_MLAG                (1 << 28)
 119 /* Remember 32 bits!!! */
 120
 121 /* PIM error codes */
 122 #define PIM_SUCCESS                      0
 123 #define PIM_GROUP_BAD_ADDRESS           -2
 124 #define PIM_GROUP_OVERLAP               -3
 125 #define PIM_GROUP_PFXLIST_OVERLAP       -4
 126 #define PIM_RP_BAD_ADDRESS              -5
 127 #define PIM_RP_NO_PATH                  -6
 128 #define PIM_RP_NOT_FOUND                -7
 129 #define PIM_RP_PFXLIST_IN_USE           -8
 130 #define PIM_IFACE_NOT_FOUND             -9
 131 #define PIM_UPDATE_SOURCE_DUP           -10
 132 #define PIM_GROUP_BAD_ADDR_MASK_COMBO   -11
 133
 134 const char *const PIM_ALL_SYSTEMS;
 135 const char *const PIM_ALL_ROUTERS;
 136 const char *const PIM_ALL_PIM_ROUTERS;
 137 const char *const PIM_ALL_IGMP_ROUTERS;
 138
 139 extern struct pim_router *router;
 140 extern struct zebra_privs_t pimd_privs;
 141 struct in_addr qpim_all_pim_routers_addr;
 142 extern uint8_t qpim_ecmp_enable;
 143 extern uint8_t qpim_ecmp_rebalance_enable;
 144
 145 #define PIM_DEFAULT_PACKET_PROCESS 3
 146
 147 #define PIM_JP_HOLDTIME (router->t_periodic * 7 / 2)
 148
 149 /*
 150  * Register-Stop Timer (RST(S,G))
 151  * Default values
 152  */
 153 #define PIM_REGISTER_SUPPRESSION_TIME_DEFAULT      (60)
 154 #define PIM_REGISTER_PROBE_TIME_DEFAULT            (5)
 155
 156 #define PIM_DEBUG_PIM_EVENTS (router->debugs & PIM_MASK_PIM_EVENTS)
 157 #define PIM_DEBUG_PIM_EVENTS_DETAIL                                            \
 158         (router->debugs & (PIM_MASK_PIM_EVENTS_DETAIL | PIM_MASK_PIM_EVENTS))
 159 #define PIM_DEBUG_PIM_PACKETS (router->debugs & PIM_MASK_PIM_PACKETS)
 160 #define PIM_DEBUG_PIM_PACKETDUMP_SEND                                          \
 161         (router->debugs & PIM_MASK_PIM_PACKETDUMP_SEND)
 162 #define PIM_DEBUG_PIM_PACKETDUMP_RECV                                          \
 163         (router->debugs & PIM_MASK_PIM_PACKETDUMP_RECV)
 164 #define PIM_DEBUG_PIM_TRACE (router->debugs & PIM_MASK_PIM_TRACE)
 165 #define PIM_DEBUG_PIM_TRACE_DETAIL                                             \
 166         (router->debugs & (PIM_MASK_PIM_TRACE_DETAIL | PIM_MASK_PIM_TRACE))
 167 #define PIM_DEBUG_PIM_TRACE_DETAIL_ONLY                                        \
 168         (router->debugs & PIM_MASK_PIM_TRACE_DETAIL)
 169 #define PIM_DEBUG_IGMP_EVENTS (router->debugs & PIM_MASK_IGMP_EVENTS)
 170 #define PIM_DEBUG_IGMP_PACKETS (router->debugs & PIM_MASK_IGMP_PACKETS)
 171 #define PIM_DEBUG_IGMP_TRACE (router->debugs & PIM_MASK_IGMP_TRACE)
 172 #define PIM_DEBUG_IGMP_TRACE_DETAIL                                            \
 173         (router->debugs & (PIM_MASK_IGMP_TRACE_DETAIL | PIM_MASK_IGMP_TRACE))
 174 #define PIM_DEBUG_ZEBRA (router->debugs & PIM_MASK_ZEBRA)
 175 #define PIM_DEBUG_MLAG (router->debugs & PIM_MASK_MLAG)
 176 #define PIM_DEBUG_SSMPINGD (router->debugs & PIM_MASK_SSMPINGD)
 177 #define PIM_DEBUG_MROUTE (router->debugs & PIM_MASK_MROUTE)
 178 #define PIM_DEBUG_MROUTE_DETAIL                                                \
 179         (router->debugs & (PIM_MASK_MROUTE_DETAIL | PIM_MASK_MROUTE))
 180 #define PIM_DEBUG_MROUTE_DETAIL_ONLY (router->debugs & PIM_MASK_MROUTE_DETAIL)
 181 #define PIM_DEBUG_PIM_HELLO (router->debugs & PIM_MASK_PIM_HELLO)
 182 #define PIM_DEBUG_PIM_J_P (router->debugs & PIM_MASK_PIM_J_P)
 183 #define PIM_DEBUG_PIM_REG (router->debugs & PIM_MASK_PIM_REG)
 184 #define PIM_DEBUG_STATIC (router->debugs & PIM_MASK_STATIC)
 185 #define PIM_DEBUG_MSDP_EVENTS (router->debugs & PIM_MASK_MSDP_EVENTS)
 186 #define PIM_DEBUG_MSDP_PACKETS (router->debugs & PIM_MASK_MSDP_PACKETS)
 187 #define PIM_DEBUG_MSDP_INTERNAL (router->debugs & PIM_MASK_MSDP_INTERNAL)
 188 #define PIM_DEBUG_PIM_NHT (router->debugs & PIM_MASK_PIM_NHT)
 189 #define PIM_DEBUG_PIM_NHT_DETAIL                                               \
 190         (router->debugs & (PIM_MASK_PIM_NHT_DETAIL | PIM_MASK_PIM_NHT))
 191 #define PIM_DEBUG_PIM_NHT_RP (router->debugs & PIM_MASK_PIM_NHT_RP)
 192 #define PIM_DEBUG_MTRACE (router->debugs & PIM_MASK_MTRACE)
 193 #define PIM_DEBUG_VXLAN (router->debugs & PIM_MASK_VXLAN)
 194 #define PIM_DEBUG_BSM   (router->debugs & PIM_MASK_BSM_PROC)
 195
 196 #define PIM_DEBUG_EVENTS                                                       \
 197         (router->debugs                                                        \
 198          & (PIM_MASK_PIM_EVENTS | PIM_MASK_IGMP_EVENTS                         \
 199             | PIM_MASK_MSDP_EVENTS | PIM_MASK_BSM_PROC))
 200 #define PIM_DEBUG_PACKETS                                                      \
 201         (router->debugs                                                        \
 202          & (PIM_MASK_PIM_PACKETS | PIM_MASK_IGMP_PACKETS                       \
 203             | PIM_MASK_MSDP_PACKETS))
 204 #define PIM_DEBUG_TRACE                                                        \
 205         (router->debugs & (PIM_MASK_PIM_TRACE | PIM_MASK_IGMP_TRACE))
 206
 207 #define PIM_DO_DEBUG_PIM_EVENTS (router->debugs |= PIM_MASK_PIM_EVENTS)
 208 #define PIM_DO_DEBUG_PIM_PACKETS (router->debugs |= PIM_MASK_PIM_PACKETS)
 209 #define PIM_DO_DEBUG_PIM_PACKETDUMP_SEND                                       \
 210         (router->debugs |= PIM_MASK_PIM_PACKETDUMP_SEND)
 211 #define PIM_DO_DEBUG_PIM_PACKETDUMP_RECV                                       \
 212         (router->debugs |= PIM_MASK_PIM_PACKETDUMP_RECV)
 213 #define PIM_DO_DEBUG_PIM_TRACE (router->debugs |= PIM_MASK_PIM_TRACE)
 214 #define PIM_DO_DEBUG_PIM_TRACE_DETAIL                                          \
 215         (router->debugs |= PIM_MASK_PIM_TRACE_DETAIL)
 216 #define PIM_DO_DEBUG_IGMP_EVENTS (router->debugs |= PIM_MASK_IGMP_EVENTS)
 217 #define PIM_DO_DEBUG_IGMP_PACKETS (router->debugs |= PIM_MASK_IGMP_PACKETS)
 218 #define PIM_DO_DEBUG_IGMP_TRACE (router->debugs |= PIM_MASK_IGMP_TRACE)
 219 #define PIM_DO_DEBUG_IGMP_TRACE_DETAIL                                         \
 220         (router->debugs |= PIM_MASK_IGMP_TRACE_DETAIL)
 221 #define PIM_DO_DEBUG_ZEBRA (router->debugs |= PIM_MASK_ZEBRA)
 222 #define PIM_DO_DEBUG_MLAG (router->debugs |= PIM_MASK_MLAG)
 223 #define PIM_DO_DEBUG_SSMPINGD (router->debugs |= PIM_MASK_SSMPINGD)
 224 #define PIM_DO_DEBUG_MROUTE (router->debugs |= PIM_MASK_MROUTE)
 225 #define PIM_DO_DEBUG_MROUTE_DETAIL (router->debugs |= PIM_MASK_MROUTE_DETAIL)
 226 #define PIM_DO_DEBUG_BSM (router->debugs |= PIM_MASK_BSM_PROC)
 227 #define PIM_DO_DEBUG_PIM_HELLO (router->debugs |= PIM_MASK_PIM_HELLO)
 228 #define PIM_DO_DEBUG_PIM_J_P (router->debugs |= PIM_MASK_PIM_J_P)
 229 #define PIM_DO_DEBUG_PIM_REG (router->debugs |= PIM_MASK_PIM_REG)
 230 #define PIM_DO_DEBUG_STATIC (router->debugs |= PIM_MASK_STATIC)
 231 #define PIM_DO_DEBUG_MSDP_EVENTS (router->debugs |= PIM_MASK_MSDP_EVENTS)
 232 #define PIM_DO_DEBUG_MSDP_PACKETS (router->debugs |= PIM_MASK_MSDP_PACKETS)
 233 #define PIM_DO_DEBUG_MSDP_INTERNAL (router->debugs |= PIM_MASK_MSDP_INTERNAL)
 234 #define PIM_DO_DEBUG_PIM_NHT (router->debugs |= PIM_MASK_PIM_NHT)
 235 #define PIM_DO_DEBUG_PIM_NHT_RP (router->debugs |= PIM_MASK_PIM_NHT_RP)
 236 #define PIM_DO_DEBUG_MTRACE (router->debugs |= PIM_MASK_MTRACE)
 237 #define PIM_DO_DEBUG_VXLAN (router->debugs |= PIM_MASK_VXLAN)
 238
 239 #define PIM_DONT_DEBUG_PIM_EVENTS (router->debugs &= ~PIM_MASK_PIM_EVENTS)
 240 #define PIM_DONT_DEBUG_PIM_PACKETS (router->debugs &= ~PIM_MASK_PIM_PACKETS)
 241 #define PIM_DONT_DEBUG_PIM_PACKETDUMP_SEND                                     \
 242         (router->debugs &= ~PIM_MASK_PIM_PACKETDUMP_SEND)
 243 #define PIM_DONT_DEBUG_PIM_PACKETDUMP_RECV                                     \
 244         (router->debugs &= ~PIM_MASK_PIM_PACKETDUMP_RECV)
 245 #define PIM_DONT_DEBUG_PIM_TRACE (router->debugs &= ~PIM_MASK_PIM_TRACE)
 246 #define PIM_DONT_DEBUG_PIM_TRACE_DETAIL                                        \
 247         (router->debugs &= ~PIM_MASK_PIM_TRACE_DETAIL)
 248 #define PIM_DONT_DEBUG_IGMP_EVENTS (router->debugs &= ~PIM_MASK_IGMP_EVENTS)
 249 #define PIM_DONT_DEBUG_IGMP_PACKETS (router->debugs &= ~PIM_MASK_IGMP_PACKETS)
 250 #define PIM_DONT_DEBUG_IGMP_TRACE (router->debugs &= ~PIM_MASK_IGMP_TRACE)
 251 #define PIM_DONT_DEBUG_IGMP_TRACE_DETAIL                                       \
 252         (router->debugs &= ~PIM_MASK_IGMP_TRACE_DETAIL)
 253 #define PIM_DONT_DEBUG_ZEBRA (router->debugs &= ~PIM_MASK_ZEBRA)
 254 #define PIM_DONT_DEBUG_MLAG (router->debugs &= ~PIM_MASK_MLAG)
 255 #define PIM_DONT_DEBUG_SSMPINGD (router->debugs &= ~PIM_MASK_SSMPINGD)
 256 #define PIM_DONT_DEBUG_MROUTE (router->debugs &= ~PIM_MASK_MROUTE)
 257 #define PIM_DONT_DEBUG_MROUTE_DETAIL (router->debugs &= ~PIM_MASK_MROUTE_DETAIL)
 258 #define PIM_DONT_DEBUG_PIM_HELLO (router->debugs &= ~PIM_MASK_PIM_HELLO)
 259 #define PIM_DONT_DEBUG_PIM_J_P (router->debugs &= ~PIM_MASK_PIM_J_P)
 260 #define PIM_DONT_DEBUG_PIM_REG (router->debugs &= ~PIM_MASK_PIM_REG)
 261 #define PIM_DONT_DEBUG_STATIC (router->debugs &= ~PIM_MASK_STATIC)
 262 #define PIM_DONT_DEBUG_MSDP_EVENTS (router->debugs &= ~PIM_MASK_MSDP_EVENTS)
 263 #define PIM_DONT_DEBUG_MSDP_PACKETS (router->debugs &= ~PIM_MASK_MSDP_PACKETS)
 264 #define PIM_DONT_DEBUG_MSDP_INTERNAL (router->debugs &= ~PIM_MASK_MSDP_INTERNAL)
 265 #define PIM_DONT_DEBUG_PIM_NHT (router->debugs &= ~PIM_MASK_PIM_NHT)
 266 #define PIM_DONT_DEBUG_PIM_NHT_RP (router->debugs &= ~PIM_MASK_PIM_NHT_RP)
 267 #define PIM_DONT_DEBUG_MTRACE (router->debugs &= ~PIM_MASK_MTRACE)
 268 #define PIM_DONT_DEBUG_VXLAN (router->debugs &= ~PIM_MASK_VXLAN)
 269 #define PIM_DONT_DEBUG_BSM (router->debugs &= ~PIM_MASK_BSM_PROC)
 270
 271 void pim_router_init(void);
 272 void pim_router_terminate(void);
 273
 274 void pim_init(void);
 275 void pim_terminate(void);
 276
 277 extern void pim_route_map_init(void);
 278 extern void pim_route_map_terminate(void);
 279 void pim_prefix_list_update(struct prefix_list *plist);
 280
 281 #endif /* PIMD_H */