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