[mirror_frr.git] / pimd / pim_tlv.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 PIM_TLV_H
#define PIM_TLV_H

#include <zebra.h>

#include "config.h"
#include "if.h"
#include "linklist.h"

#define PIM_MSG_OPTION_TYPE_HOLDTIME         (1)
#define PIM_MSG_OPTION_TYPE_LAN_PRUNE_DELAY  (2)
#define PIM_MSG_OPTION_TYPE_DR_PRIORITY      (19)
#define PIM_MSG_OPTION_TYPE_GENERATION_ID    (20)
#define PIM_MSG_OPTION_TYPE_DM_STATE_REFRESH (21)
#define PIM_MSG_OPTION_TYPE_ADDRESS_LIST     (24)

typedef uint32_t pim_hello_options;
#define PIM_OPTION_MASK_HOLDTIME                     (1 << 0) /* recv holdtime */
#define PIM_OPTION_MASK_LAN_PRUNE_DELAY              (1 << 1) /* recv lan_prune_delay */
#define PIM_OPTION_MASK_DR_PRIORITY                  (1 << 2) /* recv dr_priority */
#define PIM_OPTION_MASK_GENERATION_ID                (1 << 3) /* recv generation_id */
#define PIM_OPTION_MASK_ADDRESS_LIST                 (1 << 4) /* recv secondary address list */
#define PIM_OPTION_MASK_CAN_DISABLE_JOIN_SUPPRESSION (1 << 5) /* T bit value (valid if recv lan_prune_delay) */

#define PIM_RPT_BIT_MASK      (1 << 0)
#define PIM_WILDCARD_BIT_MASK (1 << 1)

#define PIM_OPTION_SET(options, option_mask) ((options) |= (option_mask))
#define PIM_OPTION_UNSET(options, option_mask) ((options) &= ~(option_mask))
#define PIM_OPTION_IS_SET(options, option_mask) ((options) & (option_mask))

#define PIM_TLV_GET_UINT16(buf) ntohs(*(const uint16_t *)(buf))
#define PIM_TLV_GET_UINT32(buf) ntohl(*(const uint32_t *)(buf))
#define PIM_TLV_GET_TYPE(buf) PIM_TLV_GET_UINT16(buf)
#define PIM_TLV_GET_LENGTH(buf) PIM_TLV_GET_UINT16(buf)
#define PIM_TLV_GET_HOLDTIME(buf) PIM_TLV_GET_UINT16(buf)
#define PIM_TLV_GET_PROPAGATION_DELAY(buf) (PIM_TLV_GET_UINT16(buf) & 0x7FFF)
#define PIM_TLV_GET_OVERRIDE_INTERVAL(buf) PIM_TLV_GET_UINT16(buf)
#define PIM_TLV_GET_CAN_DISABLE_JOIN_SUPPRESSION(buf) ((*(const uint8_t *)(buf)) & 0x80)
#define PIM_TLV_GET_DR_PRIORITY(buf) PIM_TLV_GET_UINT32(buf)
#define PIM_TLV_GET_GENERATION_ID(buf) PIM_TLV_GET_UINT32(buf)

#define PIM_TLV_TYPE_SIZE               (2)
#define PIM_TLV_LENGTH_SIZE             (2)
#define PIM_TLV_MIN_SIZE                (PIM_TLV_TYPE_SIZE + PIM_TLV_LENGTH_SIZE)
#define PIM_TLV_OPTION_SIZE(option_len) (PIM_TLV_MIN_SIZE + (option_len))

uint8_t *pim_tlv_append_uint16(uint8_t *buf,
			       const uint8_t *buf_pastend,
			       uint16_t option_type,
			       uint16_t option_value);
uint8_t *pim_tlv_append_2uint16(uint8_t *buf,
				const uint8_t *buf_pastend,
				uint16_t option_type,
				uint16_t option_value1,
				uint16_t option_value2);
uint8_t *pim_tlv_append_uint32(uint8_t *buf,
			       const uint8_t *buf_pastend,
			       uint16_t option_type,
			       uint32_t option_value);
uint8_t *pim_tlv_append_addrlist_ucast(uint8_t *buf,
				       const uint8_t *buf_pastend,
				       struct list *ifconnected,
                                       int family);

int pim_tlv_parse_holdtime(const char *ifname, struct in_addr src_addr,
			   pim_hello_options *hello_options,
			   uint16_t *hello_option_holdtime,
			   uint16_t option_len,
			   const uint8_t *tlv_curr);
int pim_tlv_parse_lan_prune_delay(const char *ifname, struct in_addr src_addr,
				  pim_hello_options *hello_options,
				  uint16_t *hello_option_propagation_delay,
				  uint16_t *hello_option_override_interval,
				  uint16_t option_len,
				  const uint8_t *tlv_curr);
int pim_tlv_parse_dr_priority(const char *ifname, struct in_addr src_addr,
			      pim_hello_options *hello_options,
			      uint32_t *hello_option_dr_priority,
			      uint16_t option_len,
			      const uint8_t *tlv_curr);
int pim_tlv_parse_generation_id(const char *ifname, struct in_addr src_addr,
				pim_hello_options *hello_options,
				uint32_t *hello_option_generation_id,
				uint16_t option_len,
				const uint8_t *tlv_curr);
int pim_tlv_parse_addr_list(const char *ifname, struct in_addr src_addr,
			    pim_hello_options *hello_options,
			    struct list **hello_option_addr_list,
			    uint16_t option_len,
			    const uint8_t *tlv_curr);

int pim_encode_addr_ucast (uint8_t *buf, struct prefix *p);
int pim_encode_addr_group (uint8_t *buf, afi_t afi, int bidir, int scope, struct in_addr group);

int pim_parse_addr_ucast (struct prefix *p,
			  const uint8_t *buf,
			  int buf_size);
int pim_parse_addr_group (struct prefix_sg *sg,
			  const uint8_t *buf,
			  int buf_size);
int pim_parse_addr_source(struct prefix_sg *sg,
			  uint8_t *flags,
			  const uint8_t *buf,
			  int buf_size);

#endif /* PIM_TLV_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.
	14
	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 PIM_TLV_H
	22	#define PIM_TLV_H
	23
	24	#include <zebra.h>
	25
	26	#include "config.h"
	27	#include "if.h"
	28	#include "linklist.h"
	29
12e41d03 DL	30	#define PIM_MSG_OPTION_TYPE_HOLDTIME (1)
	31	#define PIM_MSG_OPTION_TYPE_LAN_PRUNE_DELAY (2)
	32	#define PIM_MSG_OPTION_TYPE_DR_PRIORITY (19)
	33	#define PIM_MSG_OPTION_TYPE_GENERATION_ID (20)
	34	#define PIM_MSG_OPTION_TYPE_DM_STATE_REFRESH (21)
	35	#define PIM_MSG_OPTION_TYPE_ADDRESS_LIST (24)
	36
	37	typedef uint32_t pim_hello_options;
	38	#define PIM_OPTION_MASK_HOLDTIME (1 << 0) /* recv holdtime */
	39	#define PIM_OPTION_MASK_LAN_PRUNE_DELAY (1 << 1) /* recv lan_prune_delay */
	40	#define PIM_OPTION_MASK_DR_PRIORITY (1 << 2) /* recv dr_priority */
	41	#define PIM_OPTION_MASK_GENERATION_ID (1 << 3) /* recv generation_id */
	42	#define PIM_OPTION_MASK_ADDRESS_LIST (1 << 4) /* recv secondary address list */
	43	#define PIM_OPTION_MASK_CAN_DISABLE_JOIN_SUPPRESSION (1 << 5) /* T bit value (valid if recv lan_prune_delay) */
	44
	45	#define PIM_RPT_BIT_MASK (1 << 0)
	46	#define PIM_WILDCARD_BIT_MASK (1 << 1)
	47
	48	#define PIM_OPTION_SET(options, option_mask) ((options) \|= (option_mask))
	49	#define PIM_OPTION_UNSET(options, option_mask) ((options) &= ~(option_mask))
	50	#define PIM_OPTION_IS_SET(options, option_mask) ((options) & (option_mask))
	51
	52	#define PIM_TLV_GET_UINT16(buf) ntohs((const uint16_t )(buf))
	53	#define PIM_TLV_GET_UINT32(buf) ntohl((const uint32_t )(buf))
	54	#define PIM_TLV_GET_TYPE(buf) PIM_TLV_GET_UINT16(buf)
	55	#define PIM_TLV_GET_LENGTH(buf) PIM_TLV_GET_UINT16(buf)
	56	#define PIM_TLV_GET_HOLDTIME(buf) PIM_TLV_GET_UINT16(buf)
	57	#define PIM_TLV_GET_PROPAGATION_DELAY(buf) (PIM_TLV_GET_UINT16(buf) & 0x7FFF)
	58	#define PIM_TLV_GET_OVERRIDE_INTERVAL(buf) PIM_TLV_GET_UINT16(buf)
	59	#define PIM_TLV_GET_CAN_DISABLE_JOIN_SUPPRESSION(buf) (((const uint8_t )(buf)) & 0x80)
	60	#define PIM_TLV_GET_DR_PRIORITY(buf) PIM_TLV_GET_UINT32(buf)
	61	#define PIM_TLV_GET_GENERATION_ID(buf) PIM_TLV_GET_UINT32(buf)
	62
	63	#define PIM_TLV_TYPE_SIZE (2)
	64	#define PIM_TLV_LENGTH_SIZE (2)
	65	#define PIM_TLV_MIN_SIZE (PIM_TLV_TYPE_SIZE + PIM_TLV_LENGTH_SIZE)
	66	#define PIM_TLV_OPTION_SIZE(option_len) (PIM_TLV_MIN_SIZE + (option_len))
	67
	68	uint8_t pim_tlv_append_uint16(uint8_t buf,
	69	const uint8_t *buf_pastend,
	70	uint16_t option_type,
	71	uint16_t option_value);
	72	uint8_t pim_tlv_append_2uint16(uint8_t buf,
	73	const uint8_t *buf_pastend,
	74	uint16_t option_type,
	75	uint16_t option_value1,
	76	uint16_t option_value2);
	77	uint8_t pim_tlv_append_uint32(uint8_t buf,
	78	const uint8_t *buf_pastend,
	79	uint16_t option_type,
	80	uint32_t option_value);
	81	uint8_t pim_tlv_append_addrlist_ucast(uint8_t buf,
	82	const uint8_t *buf_pastend,
0f4b1d2d DS	83	struct list *ifconnected,
0f4b1d2d DS	84	int family);
12e41d03 DL	85
	86	int pim_tlv_parse_holdtime(const char *ifname, struct in_addr src_addr,
	87	pim_hello_options *hello_options,
	88	uint16_t *hello_option_holdtime,
	89	uint16_t option_len,
	90	const uint8_t *tlv_curr);
	91	int pim_tlv_parse_lan_prune_delay(const char *ifname, struct in_addr src_addr,
	92	pim_hello_options *hello_options,
	93	uint16_t *hello_option_propagation_delay,
	94	uint16_t *hello_option_override_interval,
	95	uint16_t option_len,
	96	const uint8_t *tlv_curr);
	97	int pim_tlv_parse_dr_priority(const char *ifname, struct in_addr src_addr,
	98	pim_hello_options *hello_options,
	99	uint32_t *hello_option_dr_priority,
	100	uint16_t option_len,
	101	const uint8_t *tlv_curr);
	102	int pim_tlv_parse_generation_id(const char *ifname, struct in_addr src_addr,
	103	pim_hello_options *hello_options,
	104	uint32_t *hello_option_generation_id,
	105	uint16_t option_len,
	106	const uint8_t *tlv_curr);
	107	int pim_tlv_parse_addr_list(const char *ifname, struct in_addr src_addr,
	108	pim_hello_options *hello_options,
	109	struct list **hello_option_addr_list,
	110	uint16_t option_len,
	111	const uint8_t *tlv_curr);
	112
8f483f92 DS	113	int pim_encode_addr_ucast (uint8_t buf, struct prefix p);
	114	int pim_encode_addr_group (uint8_t *buf, afi_t afi, int bidir, int scope, struct in_addr group);
	115
4416b1f6 DS	116	int pim_parse_addr_ucast (struct prefix *p,
	117	const uint8_t *buf,
	118	int buf_size);
bce0e645	119	int pim_parse_addr_group (struct prefix_sg *sg,
4416b1f6 DS	120	const uint8_t *buf,
4416b1f6 DS	121	int buf_size);
a7762e07	122	int pim_parse_addr_source(struct prefix_sg *sg,
12e41d03 DL	123	uint8_t *flags,
	124	const uint8_t *buf,
	125	int buf_size);
	126
	127	#endif /* PIM_TLV_H */