[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_str.h"
#include "pim_memory.h"
#include "pim_assert.h"

#define PIMD_PROGNAME       "pimd"
#define PIMD_DEFAULT_CONFIG "pimd.conf"
#define PIMD_VTY_PORT       2611

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

/*
 * 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_INADDR_IS_ANY(addr) (addr).s_addr == PIM_NET_INADDR_ANY
#define PIM_INADDR_ISNOT_ANY(addr) ((addr).s_addr != PIM_NET_INADDR_ANY) /* struct in_addr addr */

#define max(x,y) ((x) > (y) ? (x) : (y))

#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_IGMP_EVENTS         (1 << 7)
#define PIM_MASK_IGMP_PACKETS        (1 << 8)
#define PIM_MASK_IGMP_TRACE          (1 << 9)
#define PIM_MASK_IGMP_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)

/* PIM error codes */
#define PIM_SUCCESS                0
#define PIM_MALLOC_FAIL           -1
#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

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

extern struct thread_master *master;
extern struct zebra_privs_t pimd_privs;
uint32_t qpim_debugs;
int qpim_mroute_socket_fd;
int64_t qpim_mroute_socket_creation; /* timestamp of creation */
struct in_addr qpim_all_pim_routers_addr;
int qpim_t_periodic; /* Period between Join/Prune Messages */
struct pim_assert_metric qpim_infinite_assert_metric;
long qpim_rpf_cache_refresh_delay_msec;
struct thread *qpim_rpf_cache_refresher;
int64_t qpim_rpf_cache_refresh_requests;
int64_t qpim_rpf_cache_refresh_events;
int64_t qpim_rpf_cache_refresh_last;
struct in_addr qpim_inaddr_any;
struct list *qpim_ssmpingd_list; /* list of struct ssmpingd_sock */
struct in_addr qpim_ssmpingd_group_addr;
int64_t qpim_scan_oil_events;
int64_t qpim_scan_oil_last;
int64_t qpim_mroute_add_events;
int64_t qpim_mroute_add_last;
int64_t qpim_mroute_del_events;
int64_t qpim_mroute_del_last;
int64_t qpim_nexthop_lookups;
struct list *qpim_static_route_list; /* list of routes added statically */
extern unsigned int qpim_keep_alive_time;
extern signed int qpim_rp_keep_alive_time;
extern int qpim_packet_process;
extern uint8_t qpim_ecmp_enable;
extern uint8_t qpim_ecmp_rebalance_enable;

#define PIM_DEFAULT_PACKET_PROCESS 3

#define PIM_JP_HOLDTIME (qpim_t_periodic * 7 / 2)

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

#define PIM_DEBUG_PIM_EVENTS          (qpim_debugs & PIM_MASK_PIM_EVENTS)
#define PIM_DEBUG_PIM_EVENTS_DETAIL   (qpim_debugs & PIM_MASK_PIM_EVENTS_DETAIL)
#define PIM_DEBUG_PIM_PACKETS         (qpim_debugs & PIM_MASK_PIM_PACKETS)
#define PIM_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_SEND)
#define PIM_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_RECV)
#define PIM_DEBUG_PIM_TRACE           (qpim_debugs & PIM_MASK_PIM_TRACE)
#define PIM_DEBUG_PIM_TRACE_DETAIL    (qpim_debugs & PIM_MASK_PIM_TRACE_DETAIL)
#define PIM_DEBUG_IGMP_EVENTS         (qpim_debugs & PIM_MASK_IGMP_EVENTS)
#define PIM_DEBUG_IGMP_PACKETS        (qpim_debugs & PIM_MASK_IGMP_PACKETS)
#define PIM_DEBUG_IGMP_TRACE          (qpim_debugs & PIM_MASK_IGMP_TRACE)
#define PIM_DEBUG_IGMP_TRACE_DETAIL   (qpim_debugs & PIM_MASK_IGMP_TRACE_DETAIL)
#define PIM_DEBUG_ZEBRA               (qpim_debugs & PIM_MASK_ZEBRA)
#define PIM_DEBUG_SSMPINGD            (qpim_debugs & PIM_MASK_SSMPINGD)
#define PIM_DEBUG_MROUTE              (qpim_debugs & PIM_MASK_MROUTE)
#define PIM_DEBUG_MROUTE_DETAIL       (qpim_debugs & PIM_MASK_MROUTE_DETAIL)
#define PIM_DEBUG_PIM_HELLO           (qpim_debugs & PIM_MASK_PIM_HELLO)
#define PIM_DEBUG_PIM_J_P             (qpim_debugs & PIM_MASK_PIM_J_P)
#define PIM_DEBUG_PIM_REG             (qpim_debugs & PIM_MASK_PIM_REG)
#define PIM_DEBUG_STATIC              (qpim_debugs & PIM_MASK_STATIC)
#define PIM_DEBUG_MSDP_EVENTS         (qpim_debugs & PIM_MASK_MSDP_EVENTS)
#define PIM_DEBUG_MSDP_PACKETS        (qpim_debugs & PIM_MASK_MSDP_PACKETS)
#define PIM_DEBUG_MSDP_INTERNAL       (qpim_debugs & PIM_MASK_MSDP_INTERNAL)

#define PIM_DEBUG_EVENTS       (qpim_debugs & (PIM_MASK_PIM_EVENTS | PIM_MASK_IGMP_EVENTS | PIM_MASK_MSDP_EVENTS))
#define PIM_DEBUG_PACKETS      (qpim_debugs & (PIM_MASK_PIM_PACKETS | PIM_MASK_IGMP_PACKETS | PIM_MASK_MSDP_PACKETS))
#define PIM_DEBUG_TRACE        (qpim_debugs & (PIM_MASK_PIM_TRACE | PIM_MASK_IGMP_TRACE))

#define PIM_DO_DEBUG_PIM_EVENTS          (qpim_debugs |= PIM_MASK_PIM_EVENTS)
#define PIM_DO_DEBUG_PIM_PACKETS         (qpim_debugs |= PIM_MASK_PIM_PACKETS)
#define PIM_DO_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs |= PIM_MASK_PIM_PACKETDUMP_SEND)
#define PIM_DO_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs |= PIM_MASK_PIM_PACKETDUMP_RECV)
#define PIM_DO_DEBUG_PIM_TRACE           (qpim_debugs |= PIM_MASK_PIM_TRACE)
#define PIM_DO_DEBUG_IGMP_EVENTS         (qpim_debugs |= PIM_MASK_IGMP_EVENTS)
#define PIM_DO_DEBUG_IGMP_PACKETS        (qpim_debugs |= PIM_MASK_IGMP_PACKETS)
#define PIM_DO_DEBUG_IGMP_TRACE          (qpim_debugs |= PIM_MASK_IGMP_TRACE)
#define PIM_DO_DEBUG_IGMP_TRACE_DETAIL   (qpim_debugs |= PIM_MASK_IGMP_TRACE_DETAIL)
#define PIM_DO_DEBUG_ZEBRA               (qpim_debugs |= PIM_MASK_ZEBRA)
#define PIM_DO_DEBUG_SSMPINGD            (qpim_debugs |= PIM_MASK_SSMPINGD)
#define PIM_DO_DEBUG_MROUTE              (qpim_debugs |= PIM_MASK_MROUTE)
#define PIM_DO_DEBUG_MROUTE_DETAIL       (qpim_debugs |= PIM_MASK_MROUTE_DETAIL)
#define PIM_DO_DEBUG_PIM_HELLO           (qpim_debugs |= PIM_MASK_PIM_HELLO)
#define PIM_DO_DEBUG_PIM_J_P             (qpim_debugs |= PIM_MASK_PIM_J_P)
#define PIM_DO_DEBUG_PIM_REG             (qpim_debugs |= PIM_MASK_PIM_REG)
#define PIM_DO_DEBUG_STATIC              (qpim_debugs |= PIM_MASK_STATIC)
#define PIM_DO_DEBUG_MSDP_EVENTS         (qpim_debugs |= PIM_MASK_MSDP_EVENTS)
#define PIM_DO_DEBUG_MSDP_PACKETS        (qpim_debugs |= PIM_MASK_MSDP_PACKETS)
#define PIM_DO_DEBUG_MSDP_INTERNAL       (qpim_debugs |= PIM_MASK_MSDP_INTERNAL)

#define PIM_DONT_DEBUG_PIM_EVENTS          (qpim_debugs &= ~PIM_MASK_PIM_EVENTS)
#define PIM_DONT_DEBUG_PIM_PACKETS         (qpim_debugs &= ~PIM_MASK_PIM_PACKETS)
#define PIM_DONT_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_SEND)
#define PIM_DONT_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_RECV)
#define PIM_DONT_DEBUG_PIM_TRACE           (qpim_debugs &= ~PIM_MASK_PIM_TRACE)
#define PIM_DONT_DEBUG_IGMP_EVENTS         (qpim_debugs &= ~PIM_MASK_IGMP_EVENTS)
#define PIM_DONT_DEBUG_IGMP_PACKETS        (qpim_debugs &= ~PIM_MASK_IGMP_PACKETS)
#define PIM_DONT_DEBUG_IGMP_TRACE          (qpim_debugs &= ~PIM_MASK_IGMP_TRACE)
#define PIM_DONT_DEBUG_IGMP_TRACE_DETAIL   (qpim_debugs &= ~PIM_MASK_IGMP_TRACE_DETAIL)
#define PIM_DONT_DEBUG_ZEBRA               (qpim_debugs &= ~PIM_MASK_ZEBRA)
#define PIM_DONT_DEBUG_SSMPINGD            (qpim_debugs &= ~PIM_MASK_SSMPINGD)
#define PIM_DONT_DEBUG_MROUTE              (qpim_debugs &= ~PIM_MASK_MROUTE)
#define PIM_DONT_DEBUG_MROUTE_DETAIL       (qpim_debugs &= ~PIM_MASK_MROUTE_DETAIL)
#define PIM_DONT_DEBUG_PIM_HELLO           (qpim_debugs &= ~PIM_MASK_PIM_HELLO)
#define PIM_DONT_DEBUG_PIM_J_P             (qpim_debugs &= ~PIM_MASK_PIM_J_P)
#define PIM_DONT_DEBUG_PIM_REG             (qpim_debugs &= ~PIM_MASK_PIM_REG)
#define PIM_DONT_DEBUG_STATIC              (qpim_debugs &= ~PIM_MASK_STATIC)
#define PIM_DONT_DEBUG_MSDP_EVENTS         (qpim_debugs &= ~PIM_MASK_MSDP_EVENTS)
#define PIM_DONT_DEBUG_MSDP_PACKETS        (qpim_debugs &= ~PIM_MASK_MSDP_PACKETS)
#define PIM_DONT_DEBUG_MSDP_INTERNAL       (qpim_debugs &= ~PIM_MASK_MSDP_INTERNAL)

enum pim_spt_switchover {
	PIM_SPT_IMMEDIATE,
	PIM_SPT_INFINITY,
};

/* Per VRF PIM DB */
struct pim_instance {
	afi_t afi;
	vrf_id_t vrf_id;

	struct {
		enum pim_spt_switchover switchover;
		char *plist;
	} spt;

	struct hash *rpf_hash;
	void *ssm_info; /* per-vrf SSM configuration */
};

extern struct pim_instance *pimg; // Pim Global Instance

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

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

#endif /* PIMD_H */
Commit	Line	Data
12e41d03 DL	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.
ac4d0be5	14
12e41d03 DL	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
12e41d03 DL	19	*/
	20
	21	#ifndef PIMD_H
	22	#define PIMD_H
	23
	24	#include <stdint.h>
1bc98276 CS	25	#include "zebra.h"
1bc98276 CS	26	#include "libfrr.h"
15a5dafe	27	#include "prefix.h"
	28	#include "vty.h"
	29	#include "plist.h"
12e41d03	30
8bfb8b67	31	#include "pim_str.h"
4a1ab8e4	32	#include "pim_memory.h"
12e41d03 DL	33	#include "pim_assert.h"
	34
	35	#define PIMD_PROGNAME "pimd"
	36	#define PIMD_DEFAULT_CONFIG "pimd.conf"
	37	#define PIMD_VTY_PORT 2611
12e41d03	38
12e41d03 DL	39	#define PIM_IP_PROTO_IGMP (2)
	40	#define PIM_IP_PROTO_PIM (103)
	41	#define PIM_IGMP_MIN_LEN (8)
09778298 DS	42
	43	/*
	44	* PIM MSG Header Format
	45	* 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
	46	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	47	* \|PIM Ver\| Type \| Reserved \| Checksum \|
	48	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	49	*/
12e41d03 DL	50	#define PIM_MSG_HEADER_LEN (4)
12e41d03 DL	51	#define PIM_PIM_MIN_LEN PIM_MSG_HEADER_LEN
811ed42a DS	52
	53	#define PIM_ENCODED_IPV4_UCAST_SIZE (6)
	54	#define PIM_ENCODED_IPV4_GROUP_SIZE (8)
	55	#define PIM_ENCODED_IPV4_SOURCE_SIZE (8)
09778298 DS	56
	57	/*
	58	* J/P Message Format, Group Header
	59	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	60	* \| Upstream Neighbor Address (Encoded-Unicast format) \|
	61	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	62	* \| Reserved \| Num groups \| Holdtime \|
	63	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	64	* \| Multicast Group Address 1 (Encoded-Group format) \|
	65	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	66	* \| Number of Joined Sources \| Number of Pruned Sources \|
	67	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	68	*/
ac4d0be5	69	#define PIM_JP_GROUP_HEADER_SIZE \
	70	(PIM_ENCODED_IPV4_UCAST_SIZE + 1 + 1 + 2 + PIM_ENCODED_IPV4_GROUP_SIZE \
	71	+ 2 + 2)
09778298	72
12e41d03 DL	73	#define PIM_PROTO_VERSION (2)
	74
	75	#define MCAST_ALL_SYSTEMS "224.0.0.1"
	76	#define MCAST_ALL_ROUTERS "224.0.0.2"
	77	#define MCAST_ALL_PIM_ROUTERS "224.0.0.13"
	78	#define MCAST_ALL_IGMP_ROUTERS "224.0.0.22"
	79
	80	#define PIM_FORCE_BOOLEAN(expr) ((expr) != 0)
	81
	82	#define PIM_NET_INADDR_ANY (htonl(INADDR_ANY))
df696e3f	83	#define PIM_INADDR_IS_ANY(addr) (addr).s_addr == PIM_NET_INADDR_ANY
12e41d03 DL	84	#define PIM_INADDR_ISNOT_ANY(addr) ((addr).s_addr != PIM_NET_INADDR_ANY) /* struct in_addr addr */
12e41d03 DL	85
15ad0c71	86	#define max(x,y) ((x) > (y) ? (x) : (y))
15ad0c71	87
12e41d03	88	#define PIM_MASK_PIM_EVENTS (1 << 0)
3010e99a DS	89	#define PIM_MASK_PIM_EVENTS_DETAIL (1 << 1)
	90	#define PIM_MASK_PIM_PACKETS (1 << 2)
	91	#define PIM_MASK_PIM_PACKETDUMP_SEND (1 << 3)
	92	#define PIM_MASK_PIM_PACKETDUMP_RECV (1 << 4)
	93	#define PIM_MASK_PIM_TRACE (1 << 5)
	94	#define PIM_MASK_PIM_TRACE_DETAIL (1 << 6)
	95	#define PIM_MASK_IGMP_EVENTS (1 << 7)
	96	#define PIM_MASK_IGMP_PACKETS (1 << 8)
	97	#define PIM_MASK_IGMP_TRACE (1 << 9)
d3a8a0f5 DS	98	#define PIM_MASK_IGMP_TRACE_DETAIL (1 << 10)
	99	#define PIM_MASK_ZEBRA (1 << 11)
	100	#define PIM_MASK_SSMPINGD (1 << 12)
	101	#define PIM_MASK_MROUTE (1 << 13)
6c7197b1 DS	102	#define PIM_MASK_MROUTE_DETAIL (1 << 14)
	103	#define PIM_MASK_PIM_HELLO (1 << 15)
	104	#define PIM_MASK_PIM_J_P (1 << 16)
	105	#define PIM_MASK_STATIC (1 << 17)
	106	#define PIM_MASK_PIM_REG (1 << 18)
2a333e0f	107	#define PIM_MASK_MSDP_EVENTS (1 << 19)
	108	#define PIM_MASK_MSDP_PACKETS (1 << 20)
	109	#define PIM_MASK_MSDP_INTERNAL (1 << 21)
12e41d03	110
dfe43e25 DW	111	/* PIM error codes */
	112	#define PIM_SUCCESS 0
	113	#define PIM_MALLOC_FAIL -1
	114	#define PIM_GROUP_BAD_ADDRESS -2
	115	#define PIM_GROUP_OVERLAP -3
	116	#define PIM_GROUP_PFXLIST_OVERLAP -4
	117	#define PIM_RP_BAD_ADDRESS -5
	118	#define PIM_RP_NO_PATH -6
	119	#define PIM_RP_NOT_FOUND -7
	120	#define PIM_RP_PFXLIST_IN_USE -8
4763cd0e	121	#define PIM_IFACE_NOT_FOUND -9
4763cd0e	122	#define PIM_UPDATE_SOURCE_DUP -10
dfe43e25	123
12e41d03 DL	124	const char *const PIM_ALL_SYSTEMS;
	125	const char *const PIM_ALL_ROUTERS;
	126	const char *const PIM_ALL_PIM_ROUTERS;
	127	const char *const PIM_ALL_IGMP_ROUTERS;
	128
ac4d0be5	129	extern struct thread_master *master;
0b6817c5	130	extern struct zebra_privs_t pimd_privs;
ac4d0be5	131	uint32_t qpim_debugs;
	132	int qpim_mroute_socket_fd;
	133	int64_t qpim_mroute_socket_creation; /* timestamp of creation */
	134	struct in_addr qpim_all_pim_routers_addr;
	135	int qpim_t_periodic; /* Period between Join/Prune Messages */
	136	struct pim_assert_metric qpim_infinite_assert_metric;
	137	long qpim_rpf_cache_refresh_delay_msec;
	138	struct thread *qpim_rpf_cache_refresher;
	139	int64_t qpim_rpf_cache_refresh_requests;
	140	int64_t qpim_rpf_cache_refresh_events;
	141	int64_t qpim_rpf_cache_refresh_last;
	142	struct in_addr qpim_inaddr_any;
	143	struct list qpim_ssmpingd_list; / list of struct ssmpingd_sock */
	144	struct in_addr qpim_ssmpingd_group_addr;
	145	int64_t qpim_scan_oil_events;
	146	int64_t qpim_scan_oil_last;
	147	int64_t qpim_mroute_add_events;
	148	int64_t qpim_mroute_add_last;
	149	int64_t qpim_mroute_del_events;
	150	int64_t qpim_mroute_del_last;
	151	int64_t qpim_nexthop_lookups;
	152	struct list qpim_static_route_list; / list of routes added statically */
	153	extern unsigned int qpim_keep_alive_time;
	154	extern signed int qpim_rp_keep_alive_time;
	155	extern int qpim_packet_process;
	156	extern uint8_t qpim_ecmp_enable;
	157	extern uint8_t qpim_ecmp_rebalance_enable;
633988a7	158
8e4c9ef3	159	#define PIM_DEFAULT_PACKET_PROCESS 3
12e41d03 DL	160
	161	#define PIM_JP_HOLDTIME (qpim_t_periodic * 7 / 2)
	162
4a4c4a07 DS	163	/*
	164	* Register-Stop Timer (RST(S,G))
	165	* Default values
	166	*/
	167	extern int32_t qpim_register_suppress_time;
	168	extern int32_t qpim_register_probe_time;
	169	#define PIM_REGISTER_SUPPRESSION_TIME_DEFAULT (60)
	170	#define PIM_REGISTER_PROBE_TIME_DEFAULT (5)
	171
12e41d03	172	#define PIM_DEBUG_PIM_EVENTS (qpim_debugs & PIM_MASK_PIM_EVENTS)
3010e99a	173	#define PIM_DEBUG_PIM_EVENTS_DETAIL (qpim_debugs & PIM_MASK_PIM_EVENTS_DETAIL)
12e41d03 DL	174	#define PIM_DEBUG_PIM_PACKETS (qpim_debugs & PIM_MASK_PIM_PACKETS)
	175	#define PIM_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_SEND)
	176	#define PIM_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_RECV)
	177	#define PIM_DEBUG_PIM_TRACE (qpim_debugs & PIM_MASK_PIM_TRACE)
3010e99a	178	#define PIM_DEBUG_PIM_TRACE_DETAIL (qpim_debugs & PIM_MASK_PIM_TRACE_DETAIL)
12e41d03 DL	179	#define PIM_DEBUG_IGMP_EVENTS (qpim_debugs & PIM_MASK_IGMP_EVENTS)
	180	#define PIM_DEBUG_IGMP_PACKETS (qpim_debugs & PIM_MASK_IGMP_PACKETS)
	181	#define PIM_DEBUG_IGMP_TRACE (qpim_debugs & PIM_MASK_IGMP_TRACE)
d3a8a0f5	182	#define PIM_DEBUG_IGMP_TRACE_DETAIL (qpim_debugs & PIM_MASK_IGMP_TRACE_DETAIL)
12e41d03 DL	183	#define PIM_DEBUG_ZEBRA (qpim_debugs & PIM_MASK_ZEBRA)
	184	#define PIM_DEBUG_SSMPINGD (qpim_debugs & PIM_MASK_SSMPINGD)
	185	#define PIM_DEBUG_MROUTE (qpim_debugs & PIM_MASK_MROUTE)
6c7197b1	186	#define PIM_DEBUG_MROUTE_DETAIL (qpim_debugs & PIM_MASK_MROUTE_DETAIL)
6250610a JAG	187	#define PIM_DEBUG_PIM_HELLO (qpim_debugs & PIM_MASK_PIM_HELLO)
6250610a JAG	188	#define PIM_DEBUG_PIM_J_P (qpim_debugs & PIM_MASK_PIM_J_P)
9add3b88	189	#define PIM_DEBUG_PIM_REG (qpim_debugs & PIM_MASK_PIM_REG)
6250610a	190	#define PIM_DEBUG_STATIC (qpim_debugs & PIM_MASK_STATIC)
2a333e0f	191	#define PIM_DEBUG_MSDP_EVENTS (qpim_debugs & PIM_MASK_MSDP_EVENTS)
	192	#define PIM_DEBUG_MSDP_PACKETS (qpim_debugs & PIM_MASK_MSDP_PACKETS)
	193	#define PIM_DEBUG_MSDP_INTERNAL (qpim_debugs & PIM_MASK_MSDP_INTERNAL)
12e41d03	194
2a333e0f	195	#define PIM_DEBUG_EVENTS (qpim_debugs & (PIM_MASK_PIM_EVENTS \| PIM_MASK_IGMP_EVENTS \| PIM_MASK_MSDP_EVENTS))
2a333e0f	196	#define PIM_DEBUG_PACKETS (qpim_debugs & (PIM_MASK_PIM_PACKETS \| PIM_MASK_IGMP_PACKETS \| PIM_MASK_MSDP_PACKETS))
12e41d03 DL	197	#define PIM_DEBUG_TRACE (qpim_debugs & (PIM_MASK_PIM_TRACE \| PIM_MASK_IGMP_TRACE))
	198
	199	#define PIM_DO_DEBUG_PIM_EVENTS (qpim_debugs \|= PIM_MASK_PIM_EVENTS)
	200	#define PIM_DO_DEBUG_PIM_PACKETS (qpim_debugs \|= PIM_MASK_PIM_PACKETS)
	201	#define PIM_DO_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs \|= PIM_MASK_PIM_PACKETDUMP_SEND)
	202	#define PIM_DO_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs \|= PIM_MASK_PIM_PACKETDUMP_RECV)
	203	#define PIM_DO_DEBUG_PIM_TRACE (qpim_debugs \|= PIM_MASK_PIM_TRACE)
	204	#define PIM_DO_DEBUG_IGMP_EVENTS (qpim_debugs \|= PIM_MASK_IGMP_EVENTS)
	205	#define PIM_DO_DEBUG_IGMP_PACKETS (qpim_debugs \|= PIM_MASK_IGMP_PACKETS)
	206	#define PIM_DO_DEBUG_IGMP_TRACE (qpim_debugs \|= PIM_MASK_IGMP_TRACE)
d3a8a0f5	207	#define PIM_DO_DEBUG_IGMP_TRACE_DETAIL (qpim_debugs \|= PIM_MASK_IGMP_TRACE_DETAIL)
12e41d03 DL	208	#define PIM_DO_DEBUG_ZEBRA (qpim_debugs \|= PIM_MASK_ZEBRA)
	209	#define PIM_DO_DEBUG_SSMPINGD (qpim_debugs \|= PIM_MASK_SSMPINGD)
	210	#define PIM_DO_DEBUG_MROUTE (qpim_debugs \|= PIM_MASK_MROUTE)
6c7197b1	211	#define PIM_DO_DEBUG_MROUTE_DETAIL (qpim_debugs \|= PIM_MASK_MROUTE_DETAIL)
12e41d03 DL	212	#define PIM_DO_DEBUG_PIM_HELLO (qpim_debugs \|= PIM_MASK_PIM_HELLO)
12e41d03 DL	213	#define PIM_DO_DEBUG_PIM_J_P (qpim_debugs \|= PIM_MASK_PIM_J_P)
9add3b88	214	#define PIM_DO_DEBUG_PIM_REG (qpim_debugs \|= PIM_MASK_PIM_REG)
6250610a	215	#define PIM_DO_DEBUG_STATIC (qpim_debugs \|= PIM_MASK_STATIC)
2a333e0f	216	#define PIM_DO_DEBUG_MSDP_EVENTS (qpim_debugs \|= PIM_MASK_MSDP_EVENTS)
	217	#define PIM_DO_DEBUG_MSDP_PACKETS (qpim_debugs \|= PIM_MASK_MSDP_PACKETS)
	218	#define PIM_DO_DEBUG_MSDP_INTERNAL (qpim_debugs \|= PIM_MASK_MSDP_INTERNAL)
12e41d03 DL	219
	220	#define PIM_DONT_DEBUG_PIM_EVENTS (qpim_debugs &= ~PIM_MASK_PIM_EVENTS)
	221	#define PIM_DONT_DEBUG_PIM_PACKETS (qpim_debugs &= ~PIM_MASK_PIM_PACKETS)
	222	#define PIM_DONT_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_SEND)
	223	#define PIM_DONT_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_RECV)
	224	#define PIM_DONT_DEBUG_PIM_TRACE (qpim_debugs &= ~PIM_MASK_PIM_TRACE)
	225	#define PIM_DONT_DEBUG_IGMP_EVENTS (qpim_debugs &= ~PIM_MASK_IGMP_EVENTS)
	226	#define PIM_DONT_DEBUG_IGMP_PACKETS (qpim_debugs &= ~PIM_MASK_IGMP_PACKETS)
	227	#define PIM_DONT_DEBUG_IGMP_TRACE (qpim_debugs &= ~PIM_MASK_IGMP_TRACE)
d3a8a0f5	228	#define PIM_DONT_DEBUG_IGMP_TRACE_DETAIL (qpim_debugs &= ~PIM_MASK_IGMP_TRACE_DETAIL)
12e41d03 DL	229	#define PIM_DONT_DEBUG_ZEBRA (qpim_debugs &= ~PIM_MASK_ZEBRA)
	230	#define PIM_DONT_DEBUG_SSMPINGD (qpim_debugs &= ~PIM_MASK_SSMPINGD)
	231	#define PIM_DONT_DEBUG_MROUTE (qpim_debugs &= ~PIM_MASK_MROUTE)
6c7197b1	232	#define PIM_DONT_DEBUG_MROUTE_DETAIL (qpim_debugs &= ~PIM_MASK_MROUTE_DETAIL)
12e41d03 DL	233	#define PIM_DONT_DEBUG_PIM_HELLO (qpim_debugs &= ~PIM_MASK_PIM_HELLO)
12e41d03 DL	234	#define PIM_DONT_DEBUG_PIM_J_P (qpim_debugs &= ~PIM_MASK_PIM_J_P)
9add3b88	235	#define PIM_DONT_DEBUG_PIM_REG (qpim_debugs &= ~PIM_MASK_PIM_REG)
6250610a	236	#define PIM_DONT_DEBUG_STATIC (qpim_debugs &= ~PIM_MASK_STATIC)
2a333e0f	237	#define PIM_DONT_DEBUG_MSDP_EVENTS (qpim_debugs &= ~PIM_MASK_MSDP_EVENTS)
	238	#define PIM_DONT_DEBUG_MSDP_PACKETS (qpim_debugs &= ~PIM_MASK_MSDP_PACKETS)
	239	#define PIM_DONT_DEBUG_MSDP_INTERNAL (qpim_debugs &= ~PIM_MASK_MSDP_INTERNAL)
12e41d03	240
a7b2b1e2	241	enum pim_spt_switchover {
ac4d0be5	242	PIM_SPT_IMMEDIATE,
ac4d0be5	243	PIM_SPT_INFINITY,
a7b2b1e2 DS	244	};
a7b2b1e2 DS	245
1bc98276	246	/* Per VRF PIM DB */
ac4d0be5	247	struct pim_instance {
	248	afi_t afi;
	249	vrf_id_t vrf_id;
	250
	251	struct {
	252	enum pim_spt_switchover switchover;
	253	char *plist;
	254	} spt;
	255
	256	struct hash *rpf_hash;
	257	void ssm_info; / per-vrf SSM configuration */
1bc98276 CS	258	};
1bc98276 CS	259
ac4d0be5	260	extern struct pim_instance *pimg; // Pim Global Instance
1bc98276	261
12e41d03 DL	262	void pim_init(void);
	263	void pim_terminate(void);
	264
ac4d0be5	265	extern void pim_route_map_init(void);
28b0c6b3	266	extern void pim_route_map_terminate(void);
ac4d0be5	267	void pim_vrf_init(void);
ac4d0be5	268	void pim_prefix_list_update(struct prefix_list *plist);
0e8ce7e6	269
12e41d03	270	#endif /* PIMD_H */