1/*-
  2 * SPDX-License-Identifier: BSD-3-Clause
  3 *
  4 * Copyright (c) 1996-2000
  5 * University of Southern California/Information Sciences Institute.
  6 * All rights reserved.
  7 *
  8 * Redistribution and use in source and binary forms, with or without
  9 * modification, are permitted provided that the following conditions
 10 * are met:
 11 * 1. Redistributions of source code must retain the above copyright
 12 *    notice, this list of conditions and the following disclaimer.
 13 * 2. Redistributions in binary form must reproduce the above copyright
 14 *    notice, this list of conditions and the following disclaimer in the
 15 *    documentation and/or other materials provided with the distribution.
 16 * 3. Neither the name of the project nor the names of its contributors
 17 *    may be used to endorse or promote products derived from this software
 18 *    without specific prior written permission.
 19 *
 20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 30 * SUCH DAMAGE.
 31 */
 32
 33#ifndef _NETINET_PIM_H_
 34#define _NETINET_PIM_H_
 35
 36/*
 37 * Protocol Independent Multicast (PIM) definitions.
 38 * RFC 2362, June 1998.
 39 *
 40 * Written by Ahmed Helmy, USC/SGI, July 1996.
 41 * Modified by George Edmond Eddy (Rusty), ISI, February 1998.
 42 * Modified by Pavlin Radoslavov, USC/ISI, May 1998, October 2000.
 43 */
 44
 45#include <sys/types.h>
 46
 47#ifndef _PIM_VT
 48#ifndef BYTE_ORDER
 49# error BYTE_ORDER is not defined!
 50#endif
 51#if (BYTE_ORDER != BIG_ENDIAN) && (BYTE_ORDER != LITTLE_ENDIAN)
 52# error BYTE_ORDER must be defined to either BIG_ENDIAN or LITTLE_ENDIAN
 53#endif
 54#endif /* ! _PIM_VT */
 55
 56/*
 57 * PIM packet header
 58 */
 59struct pim {
 60#ifdef _PIM_VT
 61	uint8_t		pim_vt;		/* PIM version and message type	*/
 62#else /* ! _PIM_VT   */
 63#if BYTE_ORDER == BIG_ENDIAN
 64	u_int		pim_vers:4,	/* PIM protocol version		*/
 65			pim_type:4;	/* PIM message type		*/
 66#endif
 67#if BYTE_ORDER == LITTLE_ENDIAN
 68	u_int		pim_type:4,	/* PIM message type		*/
 69			pim_vers:4;	/* PIM protocol version		*/
 70#endif
 71#endif /* ! _PIM_VT  */
 72	uint8_t		pim_reserved;	/* Reserved			*/
 73	uint16_t	pim_cksum;	/* IP-style checksum		*/
 74};
 75/* KAME-related name backward compatibility */
 76#define pim_ver pim_vers
 77#define pim_rsv pim_reserved
 78
 79#ifdef _PIM_VT
 80#define PIM_MAKE_VT(v, t)	(0xff & (((v) << 4) | (0x0f & (t))))
 81#define PIM_VT_V(x)		(((x) >> 4) & 0x0f)
 82#define PIM_VT_T(x)		((x) & 0x0f)
 83#endif /* _PIM_VT */
 84
 85#define PIM_VERSION		2
 86#define PIM_MINLEN		8	/* PIM message min. length	*/
 87#define PIM_REG_MINLEN	(PIM_MINLEN+20)	/* PIM Register hdr + inner IPv4 hdr */
 88#define PIM6_REG_MINLEN	(PIM_MINLEN+40)	/* PIM Register hdr + inner IPv6 hdr */
 89
 90/*
 91 * PIM message types
 92 */
 93#define PIM_HELLO		0x0	/* PIM-SM and PIM-DM		*/
 94#define PIM_REGISTER		0x1	/* PIM-SM only			*/
 95#define PIM_REGISTER_STOP	0x2	/* PIM-SM only			*/
 96#define PIM_JOIN_PRUNE		0x3	/* PIM-SM and PIM-DM		*/
 97#define PIM_BOOTSTRAP		0x4	/* PIM-SM only			*/
 98#define PIM_ASSERT		0x5	/* PIM-SM and PIM-DM		*/
 99#define PIM_GRAFT		0x6	/* PIM-DM only			*/
100#define PIM_GRAFT_ACK		0x7	/* PIM-DM only			*/
101#define PIM_CAND_RP_ADV		0x8	/* PIM-SM only			*/
102#define PIM_ALL_DF_ELECTION	0xa	/* Bidir-PIM-SM only		*/
103
104/*
105 * PIM-Register message flags
106 */
107#define PIM_BORDER_REGISTER 0x80000000U	/* The Border bit (host-order)	*/
108#define PIM_NULL_REGISTER   0x40000000U	/* The Null-Register bit (host-order)*/
109
110/*
111 * All-PIM-Routers IPv4 and IPv6 multicast addresses
112 */
113#define INADDR_ALLPIM_ROUTERS_GROUP	(uint32_t)0xe000000dU  /* 224.0.0.13 */
114#define IN6ADDR_LINKLOCAL_ALLPIM_ROUTERS	"ff02::d"
115#define IN6ADDR_LINKLOCAL_ALLPIM_ROUTERS_INIT				\
116	{{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,		\
117	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0d }}}
118
119#endif /* _NETINET_PIM_H_ */