blob: 290d4d2ed9b9ceccfdd936315c60b8e1360bb147 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +09002#ifndef __LINUX_PIM_H
3#define __LINUX_PIM_H
4
Nikolay Aleksandrov556d2992016-10-31 13:21:02 +01005#include <linux/skbuff.h>
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +09006#include <asm/byteorder.h>
7
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +09008/* Message types - V1 */
Harvey Harrisonf3a7c662009-02-14 22:58:35 -08009#define PIM_V1_VERSION cpu_to_be32(0x10000000)
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +090010#define PIM_V1_REGISTER 1
11
12/* Message types - V2 */
13#define PIM_VERSION 2
Nikolay Aleksandrov56245ca2016-10-31 13:21:04 +010014
15/* RFC7761, sec 4.9:
16 * Type
17 * Types for specific PIM messages. PIM Types are:
18 *
19 * Message Type Destination
20 * ---------------------------------------------------------------------
21 * 0 = Hello Multicast to ALL-PIM-ROUTERS
22 * 1 = Register Unicast to RP
23 * 2 = Register-Stop Unicast to source of Register
24 * packet
25 * 3 = Join/Prune Multicast to ALL-PIM-ROUTERS
26 * 4 = Bootstrap Multicast to ALL-PIM-ROUTERS
27 * 5 = Assert Multicast to ALL-PIM-ROUTERS
28 * 6 = Graft (used in PIM-DM only) Unicast to RPF'(S)
29 * 7 = Graft-Ack (used in PIM-DM only) Unicast to source of Graft
30 * packet
31 * 8 = Candidate-RP-Advertisement Unicast to Domain's BSR
32 */
33enum {
34 PIM_TYPE_HELLO,
35 PIM_TYPE_REGISTER,
36 PIM_TYPE_REGISTER_STOP,
37 PIM_TYPE_JOIN_PRUNE,
38 PIM_TYPE_BOOTSTRAP,
39 PIM_TYPE_ASSERT,
40 PIM_TYPE_GRAFT,
41 PIM_TYPE_GRAFT_ACK,
42 PIM_TYPE_CANDIDATE_RP_ADV
43};
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +090044
Harvey Harrisonf3a7c662009-02-14 22:58:35 -080045#define PIM_NULL_REGISTER cpu_to_be32(0x40000000)
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +090046
Nikolay Aleksandrov556d2992016-10-31 13:21:02 +010047/* RFC7761, sec 4.9:
48 * The PIM header common to all PIM messages is:
49 * 0 1 2 3
50 * 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
51 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
52 * |PIM Ver| Type | Reserved | Checksum |
53 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
54 */
55struct pimhdr {
56 __u8 type;
57 __u8 reserved;
58 __be16 csum;
59};
Nikolay Aleksandrov1973a4e2015-11-26 15:23:48 +010060
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +090061/* PIMv2 register message header layout (ietf-draft-idmr-pimvsm-v2-00.ps */
Nikolay Aleksandrov556d2992016-10-31 13:21:02 +010062struct pimreghdr {
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +090063 __u8 type;
64 __u8 reserved;
65 __be16 csum;
66 __be32 flags;
67};
68
Nikolay Aleksandrov556d2992016-10-31 13:21:02 +010069int pim_rcv_v1(struct sk_buff *skb);
70
71static inline bool ipmr_pimsm_enabled(void)
72{
73 return IS_BUILTIN(CONFIG_IP_PIMSM_V1) || IS_BUILTIN(CONFIG_IP_PIMSM_V2);
74}
75
76static inline struct pimhdr *pim_hdr(const struct sk_buff *skb)
77{
78 return (struct pimhdr *)skb_transport_header(skb);
79}
80
81static inline u8 pim_hdr_version(const struct pimhdr *pimhdr)
82{
83 return pimhdr->type >> 4;
84}
85
86static inline u8 pim_hdr_type(const struct pimhdr *pimhdr)
87{
88 return pimhdr->type & 0xf;
89}
Nikolay Aleksandrov20bb6ce2016-10-31 13:21:03 +010090
91/* check if the address is 224.0.0.13, RFC7761 sec 4.3.1 */
92static inline bool pim_ipv4_all_pim_routers(__be32 addr)
93{
94 return addr == htonl(0xE000000D);
95}
YOSHIFUJI Hideaki2e804622008-04-03 09:22:09 +090096#endif