mirror of
				https://git.proxmox.com/git/mirror_frr
				synced 2025-11-04 01:43:38 +00:00 
			
		
		
		
	structures with bit fields in pim_msg.h should consider endianness Signed-off-by: Binu <binu_abraham@looptelecom.com>
		
			
				
	
	
		
			157 lines
		
	
	
		
			4.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			157 lines
		
	
	
		
			4.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * 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 PIM_MSG_H
 | 
						|
#define PIM_MSG_H
 | 
						|
 | 
						|
#include <netinet/in.h>
 | 
						|
 | 
						|
#include "pim_jp_agg.h"
 | 
						|
 | 
						|
#define PIM_HDR_LEN  sizeof(struct pim_msg_header)
 | 
						|
/*
 | 
						|
  Number       Description
 | 
						|
  ----------   ------------------
 | 
						|
  0            Reserved
 | 
						|
  1            IP (IP version 4)
 | 
						|
  2            IP6 (IP version 6)
 | 
						|
 | 
						|
  From:
 | 
						|
  http://www.iana.org/assignments/address-family-numbers
 | 
						|
*/
 | 
						|
enum pim_msg_address_family {
 | 
						|
	PIM_MSG_ADDRESS_FAMILY_RESERVED,
 | 
						|
	PIM_MSG_ADDRESS_FAMILY_IPV4,
 | 
						|
	PIM_MSG_ADDRESS_FAMILY_IPV6,
 | 
						|
};
 | 
						|
 | 
						|
/*
 | 
						|
 * pim_msg_hdr
 | 
						|
 * =========================
 | 
						|
 *  PIM Header definition as per RFC 5059. N bit introduced to indicate
 | 
						|
 *  do-not-forward option in PIM Boot strap Message.
 | 
						|
 *    0                   1                   2                   3
 | 
						|
 *   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  |N|  Reserved   |           Checksum            |
 | 
						|
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | 
						|
 */
 | 
						|
struct pim_msg_header {
 | 
						|
#if (BYTE_ORDER == LITTLE_ENDIAN)
 | 
						|
	uint8_t type : 4;
 | 
						|
	uint8_t ver : 4;
 | 
						|
	uint8_t reserved : 7;
 | 
						|
	uint8_t Nbit : 1; /* No Fwd Bit */
 | 
						|
#elif (BYTE_ORDER == BIG_ENDIAN)
 | 
						|
	uint8_t ver : 4;
 | 
						|
	uint8_t type : 4;
 | 
						|
	uint8_t Nbit : 1; /* No Fwd Bit */
 | 
						|
	uint8_t reserved : 7;
 | 
						|
#else
 | 
						|
#error"Please set byte order"
 | 
						|
#endif
 | 
						|
	uint16_t checksum;
 | 
						|
} __attribute__((packed));
 | 
						|
 | 
						|
struct pim_encoded_ipv4_unicast {
 | 
						|
	uint8_t family;
 | 
						|
	uint8_t reserved;
 | 
						|
	struct in_addr addr;
 | 
						|
} __attribute__((packed));
 | 
						|
 | 
						|
/*
 | 
						|
 *  Encoded Group format. RFC 4601 Sec 4.9.1
 | 
						|
 *   0                   1                   2                   3
 | 
						|
 *   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
 | 
						|
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | 
						|
 *  |  Addr Family  | Encoding Type |B| Reserved  |Z|  Mask Len     |
 | 
						|
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | 
						|
 *  |                Group multicast Address
 | 
						|
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+...
 | 
						|
 */
 | 
						|
struct pim_encoded_group_ipv4 {
 | 
						|
	uint8_t family;
 | 
						|
	uint8_t ne;
 | 
						|
#if (BYTE_ORDER == LITTLE_ENDIAN)
 | 
						|
	uint8_t sz : 1;	/* scope zone bit */
 | 
						|
	uint8_t reserved : 6;	/* Reserved */
 | 
						|
	uint8_t bidir : 1;	/* Bidir bit */
 | 
						|
#elif (BYTE_ORDER == BIG_ENDIAN)
 | 
						|
	uint8_t bidir : 1;	/* Bidir bit */
 | 
						|
	uint8_t reserved : 6;	/* Reserved */
 | 
						|
	uint8_t sz : 1;		/* scope zone bit */
 | 
						|
#else
 | 
						|
#error"Please set byte order"
 | 
						|
#endif
 | 
						|
	uint8_t mask;
 | 
						|
	struct in_addr addr;
 | 
						|
} __attribute__((packed));
 | 
						|
 | 
						|
 | 
						|
/*
 | 
						|
 *  Encoded Source format. RFC 4601 Sec 4.9.1
 | 
						|
 *   0                   1                   2                   3
 | 
						|
 *   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
 | 
						|
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | 
						|
 *  | Addr Family   | Encoding Type | Rsrvd   |S|W|R|  Mask Len     |
 | 
						|
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | 
						|
 *  |                        Source Address
 | 
						|
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-...
 | 
						|
 */
 | 
						|
struct pim_encoded_source_ipv4 {
 | 
						|
	uint8_t family;
 | 
						|
	uint8_t ne;
 | 
						|
	uint8_t bits;
 | 
						|
	uint8_t mask;
 | 
						|
	struct in_addr addr;
 | 
						|
} __attribute__((packed));
 | 
						|
 | 
						|
struct pim_jp_groups {
 | 
						|
	struct pim_encoded_group_ipv4 g;
 | 
						|
	uint16_t joins;
 | 
						|
	uint16_t prunes;
 | 
						|
	struct pim_encoded_source_ipv4 s[1];
 | 
						|
} __attribute__((packed));
 | 
						|
 | 
						|
struct pim_jp {
 | 
						|
	struct pim_msg_header header;
 | 
						|
	struct pim_encoded_ipv4_unicast addr;
 | 
						|
	uint8_t reserved;
 | 
						|
	uint8_t num_groups;
 | 
						|
	uint16_t holdtime;
 | 
						|
	struct pim_jp_groups groups[1];
 | 
						|
} __attribute__((packed));
 | 
						|
 | 
						|
void pim_msg_build_header(uint8_t *pim_msg, size_t pim_msg_size,
 | 
						|
			  uint8_t pim_msg_type, bool no_fwd);
 | 
						|
uint8_t *pim_msg_addr_encode_ipv4_ucast(uint8_t *buf, struct in_addr addr);
 | 
						|
uint8_t *pim_msg_addr_encode_ipv4_group(uint8_t *buf, struct in_addr addr);
 | 
						|
 | 
						|
#define PIM_ENCODE_SPARSE_BIT      0x04
 | 
						|
#define PIM_ENCODE_WC_BIT          0x02
 | 
						|
#define PIM_ENCODE_RPT_BIT         0x01
 | 
						|
uint8_t *pim_msg_addr_encode_ipv4_source(uint8_t *buf, struct in_addr addr,
 | 
						|
					 uint8_t bits);
 | 
						|
 | 
						|
 | 
						|
size_t pim_msg_get_jp_group_size(struct list *sources);
 | 
						|
size_t pim_msg_build_jp_groups(struct pim_jp_groups *grp,
 | 
						|
			       struct pim_jp_agg_group *sgs, size_t size);
 | 
						|
#endif /* PIM_MSG_H */
 |