xref: /freebsd/sys/netinet6/pim6.h (revision 6be3386466ab79a84b48429ae66244f21526d3df)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (C) 1998 WIDE Project.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the project nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	$KAME: pim6.h,v 1.3 2000/03/25 07:23:58 sumikawa Exp $
32  * $FreeBSD$
33  */
34 /*
35  * Protocol Independent Multicast (PIM) definitions
36  *
37  * Written by Ahmed Helmy, SGI, July 1996
38  *
39  * MULTICAST
40  */
41 
42 /*
43  * PIM packet header
44  */
45 #define PIM_VERSION	2
46 struct pim {
47 #if defined(BYTE_ORDER) && (BYTE_ORDER == LITTLE_ENDIAN)
48 	u_char	pim_type:4, /* the PIM message type, currently they are:
49 			     * Hello, Register, Register-Stop, Join/Prune,
50 			     * Bootstrap, Assert, Graft (PIM-DM only),
51 			     * Graft-Ack (PIM-DM only), C-RP-Adv
52 			     */
53 		pim_ver:4;  /* PIM version number; 2 for PIMv2 */
54 #else
55 	u_char	pim_ver:4,	/* PIM version */
56 		pim_type:4;	/* PIM type    */
57 #endif
58 	u_char  pim_rsv;	/* Reserved */
59 	u_short	pim_cksum;	/* IP style check sum */
60 };
61 
62 #define PIM_MINLEN	8		/* The header min. length is 8    */
63 #define PIM6_REG_MINLEN	(PIM_MINLEN+40)	/* Register message + inner IP6 header */
64 
65 /*
66  * Message types
67  */
68 #define PIM_REGISTER	1	/* PIM Register type is 1 */
69 
70 /* second bit in reg_head is the null bit */
71 #define PIM_NULL_REGISTER 0x40000000
72