[mirror_frr.git] / pimd / pimd.h

/*
 * PIM for Quagga
 * Copyright (C) 2008  Everton da Silva Marques
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

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