[mirror_frr.git] / pimd / pimd.h

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * PIM for Quagga
 * Copyright (C) 2008  Everton da Silva Marques
 */

#ifndef PIMD_H
#define PIMD_H

#include <stdint.h>
#include "zebra.h"
#include "libfrr.h"
#include "prefix.h"
#include "vty.h"
#include "plist.h"

#include "pim_addr.h"
#include "pim_str.h"
#include "pim_memory.h"
#include "pim_assert.h"

#define PIMD_VTY_PORT       2611
#define PIM6D_VTY_PORT      2622

#define PIM_IP_PROTO_IGMP             (2)
#define PIM_IP_PROTO_PIM              (103)
#define PIM_IGMP_MIN_LEN              (8)

#define PIM_ENFORCE_LOOPFREE_MFC

/*
 * PIM MSG Header Format
 *  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
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |PIM Ver| Type  |   Reserved    |           Checksum            |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 */
#define PIM_MSG_HEADER_LEN            (4)
#define PIM_PIM_MIN_LEN               PIM_MSG_HEADER_LEN

#define PIM_ENCODED_IPV4_UCAST_SIZE    (6)
#define PIM_ENCODED_IPV4_GROUP_SIZE    (8)
#define PIM_ENCODED_IPV4_SOURCE_SIZE   (8)

/*
 * J/P Message Format, Group Header
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |        Upstream Neighbor Address (Encoded-Unicast format)     |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |  Reserved     | Num groups    |          Holdtime             |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |         Multicast Group Address 1 (Encoded-Group format)      |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |   Number of Joined Sources    |   Number of Pruned Sources    |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 */
#define PIM_JP_GROUP_HEADER_SIZE                                               \
	(PIM_ENCODED_IPV4_UCAST_SIZE + 1 + 1 + 2 + PIM_ENCODED_IPV4_GROUP_SIZE \
	 + 2 + 2)

#define PIM_PROTO_VERSION             (2)

#define MCAST_ALL_SYSTEMS      "224.0.0.1"
#define MCAST_ALL_ROUTERS      "224.0.0.2"
#define MCAST_ALL_PIM_ROUTERS  "224.0.0.13"
#define MCAST_ALL_IGMP_ROUTERS "224.0.0.22"

#define PIM_FORCE_BOOLEAN(expr) ((expr) != 0)

#define PIM_NET_INADDR_ANY (htonl(INADDR_ANY))

#define PIM_MASK_PIM_EVENTS          (1 << 0)
#define PIM_MASK_PIM_EVENTS_DETAIL   (1 << 1)
#define PIM_MASK_PIM_PACKETS         (1 << 2)
#define PIM_MASK_PIM_PACKETDUMP_SEND (1 << 3)
#define PIM_MASK_PIM_PACKETDUMP_RECV (1 << 4)
#define PIM_MASK_PIM_TRACE           (1 << 5)
#define PIM_MASK_PIM_TRACE_DETAIL    (1 << 6)
#define PIM_MASK_GM_EVENTS	     (1 << 7)
#define PIM_MASK_GM_PACKETS	     (1 << 8)
#define PIM_MASK_GM_TRACE            (1 << 9)
#define PIM_MASK_GM_TRACE_DETAIL     (1 << 10)
#define PIM_MASK_ZEBRA               (1 << 11)
#define PIM_MASK_SSMPINGD            (1 << 12)
#define PIM_MASK_MROUTE              (1 << 13)
#define PIM_MASK_MROUTE_DETAIL       (1 << 14)
#define PIM_MASK_PIM_HELLO           (1 << 15)
#define PIM_MASK_PIM_J_P             (1 << 16)
#define PIM_MASK_STATIC              (1 << 17)
#define PIM_MASK_PIM_REG             (1 << 18)
#define PIM_MASK_MSDP_EVENTS         (1 << 19)
#define PIM_MASK_MSDP_PACKETS        (1 << 20)
#define PIM_MASK_MSDP_INTERNAL       (1 << 21)
#define PIM_MASK_PIM_NHT             (1 << 22)
#define PIM_MASK_PIM_NHT_DETAIL      (1 << 23)
#define PIM_MASK_PIM_NHT_RP          (1 << 24)
#define PIM_MASK_MTRACE              (1 << 25)
#define PIM_MASK_VXLAN               (1 << 26)
#define PIM_MASK_BSM_PROC            (1 << 27)
#define PIM_MASK_MLAG                (1 << 28)
/* Remember 32 bits!!! */

/* PIM error codes */
#define PIM_SUCCESS                      0
#define PIM_GROUP_BAD_ADDRESS           -2
#define PIM_GROUP_OVERLAP               -3
#define PIM_GROUP_PFXLIST_OVERLAP       -4
#define PIM_RP_BAD_ADDRESS              -5
#define PIM_RP_NO_PATH                  -6
#define PIM_RP_NOT_FOUND                -7
#define PIM_RP_PFXLIST_IN_USE           -8
#define PIM_IFACE_NOT_FOUND             -9
#define PIM_UPDATE_SOURCE_DUP           -10
#define PIM_GROUP_BAD_ADDR_MASK_COMBO   -11

extern const char *const PIM_ALL_SYSTEMS;
extern const char *const PIM_ALL_ROUTERS;
extern const char *const PIM_ALL_PIM_ROUTERS;
extern const char *const PIM_ALL_IGMP_ROUTERS;

extern struct zebra_privs_t pimd_privs;
extern pim_addr qpim_all_pim_routers_addr;
extern uint8_t qpim_ecmp_enable;
extern uint8_t qpim_ecmp_rebalance_enable;

#define PIM_DEFAULT_PACKET_PROCESS 3

#define PIM_JP_HOLDTIME (router->t_periodic * 7 / 2)

/*
 * Register-Stop Timer (RST(S,G))
 * Default values
 */
#define PIM_REGISTER_SUPPRESSION_TIME_DEFAULT      (60)
#define PIM_REGISTER_PROBE_TIME_DEFAULT            (5)

#define PIM_DEBUG_PIM_EVENTS (router->debugs & PIM_MASK_PIM_EVENTS)
#define PIM_DEBUG_PIM_EVENTS_DETAIL                                            \
	(router->debugs & (PIM_MASK_PIM_EVENTS_DETAIL | PIM_MASK_PIM_EVENTS))
#define PIM_DEBUG_PIM_PACKETS (router->debugs & PIM_MASK_PIM_PACKETS)
#define PIM_DEBUG_PIM_PACKETDUMP_SEND                                          \
	(router->debugs & PIM_MASK_PIM_PACKETDUMP_SEND)
#define PIM_DEBUG_PIM_PACKETDUMP_RECV                                          \
	(router->debugs & PIM_MASK_PIM_PACKETDUMP_RECV)
#define PIM_DEBUG_PIM_TRACE                                                    \
	(router->debugs & (PIM_MASK_PIM_TRACE | PIM_MASK_PIM_TRACE_DETAIL))
#define PIM_DEBUG_PIM_TRACE_DETAIL                                             \
	(router->debugs & PIM_MASK_PIM_TRACE_DETAIL)
#define PIM_DEBUG_GM_EVENTS (router->debugs & PIM_MASK_GM_EVENTS)
#define PIM_DEBUG_GM_PACKETS (router->debugs & PIM_MASK_GM_PACKETS)
#define PIM_DEBUG_GM_TRACE                                                     \
	(router->debugs & (PIM_MASK_GM_TRACE | PIM_MASK_GM_TRACE_DETAIL))
#define PIM_DEBUG_GM_TRACE_DETAIL (router->debugs & PIM_MASK_GM_TRACE_DETAIL)
#define PIM_DEBUG_ZEBRA (router->debugs & PIM_MASK_ZEBRA)
#define PIM_DEBUG_MLAG (router->debugs & PIM_MASK_MLAG)
#define PIM_DEBUG_SSMPINGD (router->debugs & PIM_MASK_SSMPINGD)
#define PIM_DEBUG_MROUTE                                                       \
	(router->debugs & (PIM_MASK_MROUTE | PIM_MASK_MROUTE_DETAIL))
#define PIM_DEBUG_MROUTE_DETAIL (router->debugs & PIM_MASK_MROUTE_DETAIL)
#define PIM_DEBUG_PIM_HELLO (router->debugs & PIM_MASK_PIM_HELLO)
#define PIM_DEBUG_PIM_J_P (router->debugs & PIM_MASK_PIM_J_P)
#define PIM_DEBUG_PIM_REG (router->debugs & PIM_MASK_PIM_REG)
#define PIM_DEBUG_STATIC (router->debugs & PIM_MASK_STATIC)
#define PIM_DEBUG_MSDP_EVENTS (router->debugs & PIM_MASK_MSDP_EVENTS)
#define PIM_DEBUG_MSDP_PACKETS (router->debugs & PIM_MASK_MSDP_PACKETS)
#define PIM_DEBUG_MSDP_INTERNAL (router->debugs & PIM_MASK_MSDP_INTERNAL)
#define PIM_DEBUG_PIM_NHT (router->debugs & PIM_MASK_PIM_NHT)
#define PIM_DEBUG_PIM_NHT_DETAIL (router->debugs & PIM_MASK_PIM_NHT_DETAIL)
#define PIM_DEBUG_PIM_NHT_RP (router->debugs & PIM_MASK_PIM_NHT_RP)
#define PIM_DEBUG_MTRACE (router->debugs & PIM_MASK_MTRACE)
#define PIM_DEBUG_VXLAN (router->debugs & PIM_MASK_VXLAN)
#define PIM_DEBUG_BSM	(router->debugs & PIM_MASK_BSM_PROC)

#define PIM_DEBUG_EVENTS                                                       \
	(router->debugs & (PIM_MASK_PIM_EVENTS | PIM_MASK_GM_EVENTS |          \
			   PIM_MASK_MSDP_EVENTS | PIM_MASK_BSM_PROC))
#define PIM_DEBUG_PACKETS                                                      \
	(router->debugs &                                                      \
	 (PIM_MASK_PIM_PACKETS | PIM_MASK_GM_PACKETS | PIM_MASK_MSDP_PACKETS))
#define PIM_DEBUG_TRACE                                                        \
	(router->debugs & (PIM_MASK_PIM_TRACE | PIM_MASK_GM_TRACE))

#define PIM_DO_DEBUG_PIM_EVENTS (router->debugs |= PIM_MASK_PIM_EVENTS)
#define PIM_DO_DEBUG_PIM_PACKETS (router->debugs |= PIM_MASK_PIM_PACKETS)
#define PIM_DO_DEBUG_PIM_PACKETDUMP_SEND                                       \
	(router->debugs |= PIM_MASK_PIM_PACKETDUMP_SEND)
#define PIM_DO_DEBUG_PIM_PACKETDUMP_RECV                                       \
	(router->debugs |= PIM_MASK_PIM_PACKETDUMP_RECV)
#define PIM_DO_DEBUG_PIM_TRACE (router->debugs |= PIM_MASK_PIM_TRACE)
#define PIM_DO_DEBUG_PIM_TRACE_DETAIL                                          \
	(router->debugs |= PIM_MASK_PIM_TRACE_DETAIL)
#define PIM_DO_DEBUG_GM_EVENTS (router->debugs |= PIM_MASK_GM_EVENTS)
#define PIM_DO_DEBUG_GM_PACKETS (router->debugs |= PIM_MASK_GM_PACKETS)
#define PIM_DO_DEBUG_GM_TRACE (router->debugs |= PIM_MASK_GM_TRACE)
#define PIM_DO_DEBUG_GM_TRACE_DETAIL                                           \
	(router->debugs |= PIM_MASK_GM_TRACE_DETAIL)
#define PIM_DO_DEBUG_ZEBRA (router->debugs |= PIM_MASK_ZEBRA)
#define PIM_DO_DEBUG_MLAG (router->debugs |= PIM_MASK_MLAG)
#define PIM_DO_DEBUG_SSMPINGD (router->debugs |= PIM_MASK_SSMPINGD)
#define PIM_DO_DEBUG_MROUTE (router->debugs |= PIM_MASK_MROUTE)
#define PIM_DO_DEBUG_MROUTE_DETAIL (router->debugs |= PIM_MASK_MROUTE_DETAIL)
#define PIM_DO_DEBUG_BSM (router->debugs |= PIM_MASK_BSM_PROC)
#define PIM_DO_DEBUG_PIM_HELLO (router->debugs |= PIM_MASK_PIM_HELLO)
#define PIM_DO_DEBUG_PIM_J_P (router->debugs |= PIM_MASK_PIM_J_P)
#define PIM_DO_DEBUG_PIM_REG (router->debugs |= PIM_MASK_PIM_REG)
#define PIM_DO_DEBUG_STATIC (router->debugs |= PIM_MASK_STATIC)
#define PIM_DO_DEBUG_MSDP_EVENTS (router->debugs |= PIM_MASK_MSDP_EVENTS)
#define PIM_DO_DEBUG_MSDP_PACKETS (router->debugs |= PIM_MASK_MSDP_PACKETS)
#define PIM_DO_DEBUG_MSDP_INTERNAL (router->debugs |= PIM_MASK_MSDP_INTERNAL)
#define PIM_DO_DEBUG_PIM_NHT (router->debugs |= PIM_MASK_PIM_NHT)
#define PIM_DO_DEBUG_PIM_NHT_DETAIL (router->debugs |= PIM_MASK_PIM_NHT_DETAIL)
#define PIM_DO_DEBUG_PIM_NHT_RP (router->debugs |= PIM_MASK_PIM_NHT_RP)
#define PIM_DO_DEBUG_MTRACE (router->debugs |= PIM_MASK_MTRACE)
#define PIM_DO_DEBUG_VXLAN (router->debugs |= PIM_MASK_VXLAN)

#define PIM_DONT_DEBUG_PIM_EVENTS (router->debugs &= ~PIM_MASK_PIM_EVENTS)
#define PIM_DONT_DEBUG_PIM_PACKETS (router->debugs &= ~PIM_MASK_PIM_PACKETS)
#define PIM_DONT_DEBUG_PIM_PACKETDUMP_SEND                                     \
	(router->debugs &= ~PIM_MASK_PIM_PACKETDUMP_SEND)
#define PIM_DONT_DEBUG_PIM_PACKETDUMP_RECV                                     \
	(router->debugs &= ~PIM_MASK_PIM_PACKETDUMP_RECV)
#define PIM_DONT_DEBUG_PIM_TRACE (router->debugs &= ~PIM_MASK_PIM_TRACE)
#define PIM_DONT_DEBUG_PIM_TRACE_DETAIL                                        \
	(router->debugs &= ~PIM_MASK_PIM_TRACE_DETAIL)
#define PIM_DONT_DEBUG_GM_EVENTS (router->debugs &= ~PIM_MASK_GM_EVENTS)
#define PIM_DONT_DEBUG_GM_PACKETS (router->debugs &= ~PIM_MASK_GM_PACKETS)
#define PIM_DONT_DEBUG_GM_TRACE (router->debugs &= ~PIM_MASK_GM_TRACE)
#define PIM_DONT_DEBUG_GM_TRACE_DETAIL                                         \
	(router->debugs &= ~PIM_MASK_GM_TRACE_DETAIL)
#define PIM_DONT_DEBUG_ZEBRA (router->debugs &= ~PIM_MASK_ZEBRA)
#define PIM_DONT_DEBUG_MLAG (router->debugs &= ~PIM_MASK_MLAG)
#define PIM_DONT_DEBUG_SSMPINGD (router->debugs &= ~PIM_MASK_SSMPINGD)
#define PIM_DONT_DEBUG_MROUTE (router->debugs &= ~PIM_MASK_MROUTE)
#define PIM_DONT_DEBUG_MROUTE_DETAIL (router->debugs &= ~PIM_MASK_MROUTE_DETAIL)
#define PIM_DONT_DEBUG_PIM_HELLO (router->debugs &= ~PIM_MASK_PIM_HELLO)
#define PIM_DONT_DEBUG_PIM_J_P (router->debugs &= ~PIM_MASK_PIM_J_P)
#define PIM_DONT_DEBUG_PIM_REG (router->debugs &= ~PIM_MASK_PIM_REG)
#define PIM_DONT_DEBUG_STATIC (router->debugs &= ~PIM_MASK_STATIC)
#define PIM_DONT_DEBUG_MSDP_EVENTS (router->debugs &= ~PIM_MASK_MSDP_EVENTS)
#define PIM_DONT_DEBUG_MSDP_PACKETS (router->debugs &= ~PIM_MASK_MSDP_PACKETS)
#define PIM_DONT_DEBUG_MSDP_INTERNAL (router->debugs &= ~PIM_MASK_MSDP_INTERNAL)
#define PIM_DONT_DEBUG_PIM_NHT (router->debugs &= ~PIM_MASK_PIM_NHT)
#define PIM_DONT_DEBUG_PIM_NHT_DETAIL                                          \
	(router->debugs &= ~PIM_MASK_PIM_NHT_DETAIL)
#define PIM_DONT_DEBUG_PIM_NHT_RP (router->debugs &= ~PIM_MASK_PIM_NHT_RP)
#define PIM_DONT_DEBUG_MTRACE (router->debugs &= ~PIM_MASK_MTRACE)
#define PIM_DONT_DEBUG_VXLAN (router->debugs &= ~PIM_MASK_VXLAN)
#define PIM_DONT_DEBUG_BSM (router->debugs &= ~PIM_MASK_BSM_PROC)

/* RFC 3376: 8.1. Robustness Variable - Default: 2 for IGMP */
/* RFC 2710: 7.1. Robustness Variable - Default: 2 for MLD */
#define GM_DEFAULT_ROBUSTNESS_VARIABLE 2

/* RFC 3376: 8.2. Query Interval - Default: 125 seconds for IGMP */
/* RFC 2710: 7.2. Query Interval - Default: 125 seconds for MLD */
#define GM_GENERAL_QUERY_INTERVAL 125

/* RFC 3376: 8.3. Query Response Interval - Default: 100 deciseconds for IGMP */
/* RFC 2710: 7.3. Query Response Interval - Default: 100 deciseconds for MLD */
#define GM_QUERY_MAX_RESPONSE_TIME_DSEC 100

/* RFC 3376: 8.8. Last Member Query Interval - Default: 10 deciseconds for IGMP
 */
/* RFC 2710: 7.8. Last Listener Query Interval - Default: 10 deciseconds for MLD
 */
#define GM_SPECIFIC_QUERY_MAX_RESPONSE_TIME_DSEC 10

void pim_router_init(void);
void pim_router_terminate(void);

void pim_init(void);
void pim_terminate(void);

extern void pim_route_map_init(void);
extern void pim_route_map_terminate(void);
void pim_prefix_list_update(struct prefix_list *plist);

#endif /* PIMD_H */
Commit	Line	Data
acddc0ed	1	// SPDX-License-Identifier: GPL-2.0-or-later
12e41d03	2	/*
896014f4 DL	3	* PIM for Quagga
896014f4 DL	4	* Copyright (C) 2008 Everton da Silva Marques
896014f4	5	*/
12e41d03 DL	6
	7	#ifndef PIMD_H
	8	#define PIMD_H
	9
	10	#include <stdint.h>
1bc98276 CS	11	#include "zebra.h"
1bc98276 CS	12	#include "libfrr.h"
15a5dafe	13	#include "prefix.h"
	14	#include "vty.h"
	15	#include "plist.h"
12e41d03	16
26625d51	17	#include "pim_addr.h"
8bfb8b67	18	#include "pim_str.h"
4a1ab8e4	19	#include "pim_memory.h"
12e41d03 DL	20	#include "pim_assert.h"
12e41d03 DL	21
12e41d03	22	#define PIMD_VTY_PORT 2611
8a86ada1	23	#define PIM6D_VTY_PORT 2622
12e41d03	24
12e41d03 DL	25	#define PIM_IP_PROTO_IGMP (2)
	26	#define PIM_IP_PROTO_PIM (103)
	27	#define PIM_IGMP_MIN_LEN (8)
09778298	28
35a3c3c1 DL	29	#define PIM_ENFORCE_LOOPFREE_MFC
35a3c3c1 DL	30
09778298 DS	31	/*
	32	* PIM MSG Header Format
	33	* 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
	34	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	35	* \|PIM Ver\| Type \| Reserved \| Checksum \|
	36	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	37	*/
12e41d03 DL	38	#define PIM_MSG_HEADER_LEN (4)
12e41d03 DL	39	#define PIM_PIM_MIN_LEN PIM_MSG_HEADER_LEN
811ed42a DS	40
	41	#define PIM_ENCODED_IPV4_UCAST_SIZE (6)
	42	#define PIM_ENCODED_IPV4_GROUP_SIZE (8)
	43	#define PIM_ENCODED_IPV4_SOURCE_SIZE (8)
09778298 DS	44
	45	/*
	46	* J/P Message Format, Group Header
	47	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	48	* \| Upstream Neighbor Address (Encoded-Unicast format) \|
	49	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	50	* \| Reserved \| Num groups \| Holdtime \|
	51	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	52	* \| Multicast Group Address 1 (Encoded-Group format) \|
	53	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	54	* \| Number of Joined Sources \| Number of Pruned Sources \|
	55	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	56	*/
d62a17ae	57	#define PIM_JP_GROUP_HEADER_SIZE \
	58	(PIM_ENCODED_IPV4_UCAST_SIZE + 1 + 1 + 2 + PIM_ENCODED_IPV4_GROUP_SIZE \
	59	+ 2 + 2)
09778298	60
12e41d03 DL	61	#define PIM_PROTO_VERSION (2)
	62
	63	#define MCAST_ALL_SYSTEMS "224.0.0.1"
	64	#define MCAST_ALL_ROUTERS "224.0.0.2"
	65	#define MCAST_ALL_PIM_ROUTERS "224.0.0.13"
	66	#define MCAST_ALL_IGMP_ROUTERS "224.0.0.22"
	67
	68	#define PIM_FORCE_BOOLEAN(expr) ((expr) != 0)
	69
	70	#define PIM_NET_INADDR_ANY (htonl(INADDR_ANY))
12e41d03 DL	71
12e41d03 DL	72	#define PIM_MASK_PIM_EVENTS (1 << 0)
3010e99a DS	73	#define PIM_MASK_PIM_EVENTS_DETAIL (1 << 1)
	74	#define PIM_MASK_PIM_PACKETS (1 << 2)
	75	#define PIM_MASK_PIM_PACKETDUMP_SEND (1 << 3)
	76	#define PIM_MASK_PIM_PACKETDUMP_RECV (1 << 4)
	77	#define PIM_MASK_PIM_TRACE (1 << 5)
	78	#define PIM_MASK_PIM_TRACE_DETAIL (1 << 6)
b4099022 SG	79	#define PIM_MASK_GM_EVENTS (1 << 7)
	80	#define PIM_MASK_GM_PACKETS (1 << 8)
	81	#define PIM_MASK_GM_TRACE (1 << 9)
	82	#define PIM_MASK_GM_TRACE_DETAIL (1 << 10)
d3a8a0f5 DS	83	#define PIM_MASK_ZEBRA (1 << 11)
	84	#define PIM_MASK_SSMPINGD (1 << 12)
	85	#define PIM_MASK_MROUTE (1 << 13)
6c7197b1 DS	86	#define PIM_MASK_MROUTE_DETAIL (1 << 14)
	87	#define PIM_MASK_PIM_HELLO (1 << 15)
	88	#define PIM_MASK_PIM_J_P (1 << 16)
	89	#define PIM_MASK_STATIC (1 << 17)
	90	#define PIM_MASK_PIM_REG (1 << 18)
2a333e0f	91	#define PIM_MASK_MSDP_EVENTS (1 << 19)
	92	#define PIM_MASK_MSDP_PACKETS (1 << 20)
	93	#define PIM_MASK_MSDP_INTERNAL (1 << 21)
40f1f31b DS	94	#define PIM_MASK_PIM_NHT (1 << 22)
40f1f31b DS	95	#define PIM_MASK_PIM_NHT_DETAIL (1 << 23)
3d225d48	96	#define PIM_MASK_PIM_NHT_RP (1 << 24)
4d9ad5dc	97	#define PIM_MASK_MTRACE (1 << 25)
b583b035	98	#define PIM_MASK_VXLAN (1 << 26)
361b5843	99	#define PIM_MASK_BSM_PROC (1 << 27)
36b5b98f	100	#define PIM_MASK_MLAG (1 << 28)
3d225d48	101	/* Remember 32 bits!!! */
12e41d03	102
dfe43e25	103	/* PIM error codes */
6b44b401 SP	104	#define PIM_SUCCESS 0
	105	#define PIM_GROUP_BAD_ADDRESS -2
	106	#define PIM_GROUP_OVERLAP -3
	107	#define PIM_GROUP_PFXLIST_OVERLAP -4
	108	#define PIM_RP_BAD_ADDRESS -5
	109	#define PIM_RP_NO_PATH -6
	110	#define PIM_RP_NOT_FOUND -7
	111	#define PIM_RP_PFXLIST_IN_USE -8
	112	#define PIM_IFACE_NOT_FOUND -9
	113	#define PIM_UPDATE_SOURCE_DUP -10
	114	#define PIM_GROUP_BAD_ADDR_MASK_COMBO -11
dfe43e25	115
403242d2 TK	116	extern const char *const PIM_ALL_SYSTEMS;
	117	extern const char *const PIM_ALL_ROUTERS;
	118	extern const char *const PIM_ALL_PIM_ROUTERS;
	119	extern const char *const PIM_ALL_IGMP_ROUTERS;
12e41d03	120
0b6817c5	121	extern struct zebra_privs_t pimd_privs;
29fd9fca	122	extern pim_addr qpim_all_pim_routers_addr;
d62a17ae	123	extern uint8_t qpim_ecmp_enable;
d62a17ae	124	extern uint8_t qpim_ecmp_rebalance_enable;
cba44481	125
8e4c9ef3	126	#define PIM_DEFAULT_PACKET_PROCESS 3
12e41d03	127
5b45753e	128	#define PIM_JP_HOLDTIME (router->t_periodic * 7 / 2)
12e41d03	129
4a4c4a07 DS	130	/*
	131	* Register-Stop Timer (RST(S,G))
	132	* Default values
	133	*/
4a4c4a07 DS	134	#define PIM_REGISTER_SUPPRESSION_TIME_DEFAULT (60)
	135	#define PIM_REGISTER_PROBE_TIME_DEFAULT (5)
	136
046b1aa7 DS	137	#define PIM_DEBUG_PIM_EVENTS (router->debugs & PIM_MASK_PIM_EVENTS)
046b1aa7 DS	138	#define PIM_DEBUG_PIM_EVENTS_DETAIL \
0ab16492	139	(router->debugs & (PIM_MASK_PIM_EVENTS_DETAIL \| PIM_MASK_PIM_EVENTS))
046b1aa7 DS	140	#define PIM_DEBUG_PIM_PACKETS (router->debugs & PIM_MASK_PIM_PACKETS)
	141	#define PIM_DEBUG_PIM_PACKETDUMP_SEND \
	142	(router->debugs & PIM_MASK_PIM_PACKETDUMP_SEND)
	143	#define PIM_DEBUG_PIM_PACKETDUMP_RECV \
	144	(router->debugs & PIM_MASK_PIM_PACKETDUMP_RECV)
92fed03c DL	145	#define PIM_DEBUG_PIM_TRACE \
92fed03c DL	146	(router->debugs & (PIM_MASK_PIM_TRACE \| PIM_MASK_PIM_TRACE_DETAIL))
0ab16492	147	#define PIM_DEBUG_PIM_TRACE_DETAIL \
5e530de4	148	(router->debugs & PIM_MASK_PIM_TRACE_DETAIL)
d891fa78 SG	149	#define PIM_DEBUG_GM_EVENTS (router->debugs & PIM_MASK_GM_EVENTS)
d891fa78 SG	150	#define PIM_DEBUG_GM_PACKETS (router->debugs & PIM_MASK_GM_PACKETS)
a96d64b0	151	#define PIM_DEBUG_GM_TRACE \
d891fa78	152	(router->debugs & (PIM_MASK_GM_TRACE \| PIM_MASK_GM_TRACE_DETAIL))
a96d64b0	153	#define PIM_DEBUG_GM_TRACE_DETAIL (router->debugs & PIM_MASK_GM_TRACE_DETAIL)
046b1aa7	154	#define PIM_DEBUG_ZEBRA (router->debugs & PIM_MASK_ZEBRA)
36b5b98f	155	#define PIM_DEBUG_MLAG (router->debugs & PIM_MASK_MLAG)
046b1aa7	156	#define PIM_DEBUG_SSMPINGD (router->debugs & PIM_MASK_SSMPINGD)
92fed03c DL	157	#define PIM_DEBUG_MROUTE \
	158	(router->debugs & (PIM_MASK_MROUTE \| PIM_MASK_MROUTE_DETAIL))
	159	#define PIM_DEBUG_MROUTE_DETAIL (router->debugs & PIM_MASK_MROUTE_DETAIL)
046b1aa7 DS	160	#define PIM_DEBUG_PIM_HELLO (router->debugs & PIM_MASK_PIM_HELLO)
	161	#define PIM_DEBUG_PIM_J_P (router->debugs & PIM_MASK_PIM_J_P)
	162	#define PIM_DEBUG_PIM_REG (router->debugs & PIM_MASK_PIM_REG)
	163	#define PIM_DEBUG_STATIC (router->debugs & PIM_MASK_STATIC)
	164	#define PIM_DEBUG_MSDP_EVENTS (router->debugs & PIM_MASK_MSDP_EVENTS)
	165	#define PIM_DEBUG_MSDP_PACKETS (router->debugs & PIM_MASK_MSDP_PACKETS)
	166	#define PIM_DEBUG_MSDP_INTERNAL (router->debugs & PIM_MASK_MSDP_INTERNAL)
	167	#define PIM_DEBUG_PIM_NHT (router->debugs & PIM_MASK_PIM_NHT)
6d733f0d	168	#define PIM_DEBUG_PIM_NHT_DETAIL (router->debugs & PIM_MASK_PIM_NHT_DETAIL)
046b1aa7 DS	169	#define PIM_DEBUG_PIM_NHT_RP (router->debugs & PIM_MASK_PIM_NHT_RP)
046b1aa7 DS	170	#define PIM_DEBUG_MTRACE (router->debugs & PIM_MASK_MTRACE)
b583b035	171	#define PIM_DEBUG_VXLAN (router->debugs & PIM_MASK_VXLAN)
361b5843	172	#define PIM_DEBUG_BSM (router->debugs & PIM_MASK_BSM_PROC)
046b1aa7 DS	173
046b1aa7 DS	174	#define PIM_DEBUG_EVENTS \
d891fa78 SG	175	(router->debugs & (PIM_MASK_PIM_EVENTS \| PIM_MASK_GM_EVENTS \| \
d891fa78 SG	176	PIM_MASK_MSDP_EVENTS \| PIM_MASK_BSM_PROC))
046b1aa7	177	#define PIM_DEBUG_PACKETS \
d891fa78 SG	178	(router->debugs & \
d891fa78 SG	179	(PIM_MASK_PIM_PACKETS \| PIM_MASK_GM_PACKETS \| PIM_MASK_MSDP_PACKETS))
046b1aa7	180	#define PIM_DEBUG_TRACE \
d891fa78	181	(router->debugs & (PIM_MASK_PIM_TRACE \| PIM_MASK_GM_TRACE))
046b1aa7 DS	182
	183	#define PIM_DO_DEBUG_PIM_EVENTS (router->debugs \|= PIM_MASK_PIM_EVENTS)
	184	#define PIM_DO_DEBUG_PIM_PACKETS (router->debugs \|= PIM_MASK_PIM_PACKETS)
	185	#define PIM_DO_DEBUG_PIM_PACKETDUMP_SEND \
	186	(router->debugs \|= PIM_MASK_PIM_PACKETDUMP_SEND)
	187	#define PIM_DO_DEBUG_PIM_PACKETDUMP_RECV \
	188	(router->debugs \|= PIM_MASK_PIM_PACKETDUMP_RECV)
	189	#define PIM_DO_DEBUG_PIM_TRACE (router->debugs \|= PIM_MASK_PIM_TRACE)
	190	#define PIM_DO_DEBUG_PIM_TRACE_DETAIL \
	191	(router->debugs \|= PIM_MASK_PIM_TRACE_DETAIL)
d891fa78 SG	192	#define PIM_DO_DEBUG_GM_EVENTS (router->debugs \|= PIM_MASK_GM_EVENTS)
	193	#define PIM_DO_DEBUG_GM_PACKETS (router->debugs \|= PIM_MASK_GM_PACKETS)
	194	#define PIM_DO_DEBUG_GM_TRACE (router->debugs \|= PIM_MASK_GM_TRACE)
	195	#define PIM_DO_DEBUG_GM_TRACE_DETAIL \
	196	(router->debugs \|= PIM_MASK_GM_TRACE_DETAIL)
046b1aa7	197	#define PIM_DO_DEBUG_ZEBRA (router->debugs \|= PIM_MASK_ZEBRA)
36b5b98f	198	#define PIM_DO_DEBUG_MLAG (router->debugs \|= PIM_MASK_MLAG)
046b1aa7 DS	199	#define PIM_DO_DEBUG_SSMPINGD (router->debugs \|= PIM_MASK_SSMPINGD)
	200	#define PIM_DO_DEBUG_MROUTE (router->debugs \|= PIM_MASK_MROUTE)
	201	#define PIM_DO_DEBUG_MROUTE_DETAIL (router->debugs \|= PIM_MASK_MROUTE_DETAIL)
361b5843	202	#define PIM_DO_DEBUG_BSM (router->debugs \|= PIM_MASK_BSM_PROC)
046b1aa7 DS	203	#define PIM_DO_DEBUG_PIM_HELLO (router->debugs \|= PIM_MASK_PIM_HELLO)
	204	#define PIM_DO_DEBUG_PIM_J_P (router->debugs \|= PIM_MASK_PIM_J_P)
	205	#define PIM_DO_DEBUG_PIM_REG (router->debugs \|= PIM_MASK_PIM_REG)
	206	#define PIM_DO_DEBUG_STATIC (router->debugs \|= PIM_MASK_STATIC)
	207	#define PIM_DO_DEBUG_MSDP_EVENTS (router->debugs \|= PIM_MASK_MSDP_EVENTS)
	208	#define PIM_DO_DEBUG_MSDP_PACKETS (router->debugs \|= PIM_MASK_MSDP_PACKETS)
	209	#define PIM_DO_DEBUG_MSDP_INTERNAL (router->debugs \|= PIM_MASK_MSDP_INTERNAL)
	210	#define PIM_DO_DEBUG_PIM_NHT (router->debugs \|= PIM_MASK_PIM_NHT)
6d733f0d	211	#define PIM_DO_DEBUG_PIM_NHT_DETAIL (router->debugs \|= PIM_MASK_PIM_NHT_DETAIL)
046b1aa7 DS	212	#define PIM_DO_DEBUG_PIM_NHT_RP (router->debugs \|= PIM_MASK_PIM_NHT_RP)
046b1aa7 DS	213	#define PIM_DO_DEBUG_MTRACE (router->debugs \|= PIM_MASK_MTRACE)
b583b035	214	#define PIM_DO_DEBUG_VXLAN (router->debugs \|= PIM_MASK_VXLAN)
046b1aa7 DS	215
	216	#define PIM_DONT_DEBUG_PIM_EVENTS (router->debugs &= ~PIM_MASK_PIM_EVENTS)
	217	#define PIM_DONT_DEBUG_PIM_PACKETS (router->debugs &= ~PIM_MASK_PIM_PACKETS)
	218	#define PIM_DONT_DEBUG_PIM_PACKETDUMP_SEND \
	219	(router->debugs &= ~PIM_MASK_PIM_PACKETDUMP_SEND)
	220	#define PIM_DONT_DEBUG_PIM_PACKETDUMP_RECV \
	221	(router->debugs &= ~PIM_MASK_PIM_PACKETDUMP_RECV)
	222	#define PIM_DONT_DEBUG_PIM_TRACE (router->debugs &= ~PIM_MASK_PIM_TRACE)
	223	#define PIM_DONT_DEBUG_PIM_TRACE_DETAIL \
	224	(router->debugs &= ~PIM_MASK_PIM_TRACE_DETAIL)
d891fa78 SG	225	#define PIM_DONT_DEBUG_GM_EVENTS (router->debugs &= ~PIM_MASK_GM_EVENTS)
	226	#define PIM_DONT_DEBUG_GM_PACKETS (router->debugs &= ~PIM_MASK_GM_PACKETS)
	227	#define PIM_DONT_DEBUG_GM_TRACE (router->debugs &= ~PIM_MASK_GM_TRACE)
	228	#define PIM_DONT_DEBUG_GM_TRACE_DETAIL \
	229	(router->debugs &= ~PIM_MASK_GM_TRACE_DETAIL)
046b1aa7	230	#define PIM_DONT_DEBUG_ZEBRA (router->debugs &= ~PIM_MASK_ZEBRA)
36b5b98f	231	#define PIM_DONT_DEBUG_MLAG (router->debugs &= ~PIM_MASK_MLAG)
046b1aa7 DS	232	#define PIM_DONT_DEBUG_SSMPINGD (router->debugs &= ~PIM_MASK_SSMPINGD)
	233	#define PIM_DONT_DEBUG_MROUTE (router->debugs &= ~PIM_MASK_MROUTE)
	234	#define PIM_DONT_DEBUG_MROUTE_DETAIL (router->debugs &= ~PIM_MASK_MROUTE_DETAIL)
	235	#define PIM_DONT_DEBUG_PIM_HELLO (router->debugs &= ~PIM_MASK_PIM_HELLO)
	236	#define PIM_DONT_DEBUG_PIM_J_P (router->debugs &= ~PIM_MASK_PIM_J_P)
	237	#define PIM_DONT_DEBUG_PIM_REG (router->debugs &= ~PIM_MASK_PIM_REG)
	238	#define PIM_DONT_DEBUG_STATIC (router->debugs &= ~PIM_MASK_STATIC)
	239	#define PIM_DONT_DEBUG_MSDP_EVENTS (router->debugs &= ~PIM_MASK_MSDP_EVENTS)
	240	#define PIM_DONT_DEBUG_MSDP_PACKETS (router->debugs &= ~PIM_MASK_MSDP_PACKETS)
	241	#define PIM_DONT_DEBUG_MSDP_INTERNAL (router->debugs &= ~PIM_MASK_MSDP_INTERNAL)
	242	#define PIM_DONT_DEBUG_PIM_NHT (router->debugs &= ~PIM_MASK_PIM_NHT)
6d733f0d SG	243	#define PIM_DONT_DEBUG_PIM_NHT_DETAIL \
6d733f0d SG	244	(router->debugs &= ~PIM_MASK_PIM_NHT_DETAIL)
046b1aa7 DS	245	#define PIM_DONT_DEBUG_PIM_NHT_RP (router->debugs &= ~PIM_MASK_PIM_NHT_RP)
046b1aa7 DS	246	#define PIM_DONT_DEBUG_MTRACE (router->debugs &= ~PIM_MASK_MTRACE)
b583b035	247	#define PIM_DONT_DEBUG_VXLAN (router->debugs &= ~PIM_MASK_VXLAN)
361b5843	248	#define PIM_DONT_DEBUG_BSM (router->debugs &= ~PIM_MASK_BSM_PROC)
12e41d03	249
de5dc092 A	250	/* RFC 3376: 8.1. Robustness Variable - Default: 2 for IGMP */
	251	/* RFC 2710: 7.1. Robustness Variable - Default: 2 for MLD */
	252	#define GM_DEFAULT_ROBUSTNESS_VARIABLE 2
	253
	254	/* RFC 3376: 8.2. Query Interval - Default: 125 seconds for IGMP */
	255	/* RFC 2710: 7.2. Query Interval - Default: 125 seconds for MLD */
	256	#define GM_GENERAL_QUERY_INTERVAL 125
	257
	258	/* RFC 3376: 8.3. Query Response Interval - Default: 100 deciseconds for IGMP */
	259	/* RFC 2710: 7.3. Query Response Interval - Default: 100 deciseconds for MLD */
	260	#define GM_QUERY_MAX_RESPONSE_TIME_DSEC 100
	261
	262	/* RFC 3376: 8.8. Last Member Query Interval - Default: 10 deciseconds for IGMP
	263	*/
	264	/* RFC 2710: 7.8. Last Listener Query Interval - Default: 10 deciseconds for MLD
	265	*/
	266	#define GM_SPECIFIC_QUERY_MAX_RESPONSE_TIME_DSEC 10
	267
36417fcc DS	268	void pim_router_init(void);
	269	void pim_router_terminate(void);
	270
12e41d03 DL	271	void pim_init(void);
	272	void pim_terminate(void);
	273
d62a17ae	274	extern void pim_route_map_init(void);
28b0c6b3	275	extern void pim_route_map_terminate(void);
d62a17ae	276	void pim_prefix_list_update(struct prefix_list *plist);
0e8ce7e6	277
12e41d03	278	#endif /* PIMD_H */