bgp.h

/***********************************************************************
*                                                                      *
*               This software is part of the ast package               *
*          Copyright (c) 2000-2012 AT&T Intellectual Property          *
*                      and is licensed under the                       *
*                 Eclipse Public License, Version 1.0                  *
*                    by AT&T Intellectual Property                     *
*                                                                      *
*                A copy of the License is available at                 *
*          http://www.eclipse.org/org/documents/epl-v10.html           *
*         (with md5 checksum b35adb5213ca9657e911e9befb180842)         *
*                                                                      *
*              Information and Software Systems Research               *
*                            AT&T Research                             *
*                           Florham Park NJ                            *
*                                                                      *
*                 Glenn Fowler <[email protected]>                  *
*                   Phong Vo <[email protected]>                    *
*                                                                      *
***********************************************************************/
#pragma prototyped
/*
 * bgp data interface
 *
 * Glenn Fowler
 * AT&T Research
 */

#ifndef _BGP_H
#define _BGP_H

#include <ast_common.h>
#include <ip6.h>

#define BGP_VERSION		20120515L	/* interface version	*/

#define BGP_SET16		0xffff		/* as16 path set marker	*/
#define BGP_SET32		0xffffffff	/* as32 path set marker	*/

/*
 * attributes (even, 1 bit set)
 */

#define BGP_MESSAGE		(1<<1)
#define BGP_atomic		(1<<2)
#define BGP_best		(1<<3)
#define BGP_damped		(1<<4)
#define BGP_history		(1<<5)
#define BGP_internal		(1<<6)
#define BGP_ipv6		(1<<7)
#define BGP_rib_failure		(1<<8)
#define BGP_slot		(1<<9)
#define BGP_stale		(1<<10)
#define BGP_suppressed		(1<<11)
#define BGP_valid		(1<<12)
#define BGP_PART		(1<<15)

/*
 * indices (odd, 2 bits set)
 */

#define BGP_afi			((1<<1)|1)
#define BGP_agg_addr		((2<<1)|1)
#define BGP_agg_addr32		((3<<1)|1)
#define BGP_agg_addr32v4	((4<<1)|1)
#define BGP_agg_addr32v6	((5<<1)|1)
#define BGP_agg_addrv4		((6<<1)|1)
#define BGP_agg_addrv6		((7<<1)|1)
#define BGP_agg_as		((8<<1)|1)
#define BGP_agg_as16		((9<<1)|1)
#define BGP_agg_as32		((10<<1)|1)
#define BGP_bits		((11<<1)|1)
#define BGP_bitsv4		((12<<1)|1)
#define BGP_bitsv6		((13<<1)|1)
#define BGP_cluster		((14<<1)|1)
#define BGP_community		((15<<1)|1)
#define BGP_dpa_addr		((16<<1)|1)
#define BGP_dpa_addrv4		((17<<1)|1)
#define BGP_dpa_addrv6		((18<<1)|1)
#define BGP_dpa_as		((19<<1)|1)
#define BGP_dpa_as16		((20<<1)|1)
#define BGP_dpa_as32		((21<<1)|1)
#define BGP_dst_addr		((22<<1)|1)
#define BGP_dst_addrv4		((23<<1)|1)
#define BGP_dst_addrv6		((24<<1)|1)
#define BGP_dst_as		((25<<1)|1)
#define BGP_dst_as16		((26<<1)|1)
#define BGP_dst_as32		((27<<1)|1)
#define BGP_extended		((28<<1)|1)
#define BGP_flags		((29<<1)|1)
#define BGP_hop			((30<<1)|1)
#define BGP_hopv4		((31<<1)|1)
#define BGP_hopv6		((32<<1)|1)
#define BGP_id			((33<<1)|1)
#define BGP_key			((34<<1)|1)
#define BGP_label		((35<<1)|1)
#define BGP_labels		((36<<1)|1)
#define BGP_local		((37<<1)|1)
#define BGP_med			((38<<1)|1)
#define BGP_message		((39<<1)|1)
#define BGP_mvpn		((40<<1)|1)
#define BGP_new_state		((41<<1)|1)
#define BGP_old_state		((42<<1)|1)
#define BGP_origin		((43<<1)|1)
#define BGP_originator		((44<<1)|1)
#define BGP_path		((45<<1)|1)
#define BGP_path16		((46<<1)|1)
#define BGP_path32		((47<<1)|1)
#define BGP_prefix		((48<<1)|1)
#define BGP_prefixv4		((49<<1)|1)
#define BGP_prefixv6		((50<<1)|1)
#define BGP_rd_addr		((51<<1)|1)
#define BGP_rd_as		((52<<1)|1)
#define BGP_rd_number		((53<<1)|1)
#define BGP_rd_type		((54<<1)|1)
#define BGP_safi		((55<<1)|1)
#define BGP_src_addr		((56<<1)|1)
#define BGP_src_addrv4		((57<<1)|1)
#define BGP_src_addrv6		((58<<1)|1)
#define BGP_src_as		((59<<1)|1)
#define BGP_src_as16		((60<<1)|1)
#define BGP_src_as32		((61<<1)|1)
#define BGP_stamp		((62<<1)|1)
#define BGP_time		((63<<1)|1)
#define BGP_type		((64<<1)|1)
#define BGP_unknown		((65<<1)|1)
#define BGP_usec		((66<<1)|1)
#define BGP_weight		((67<<1)|1)

#define BGP_LAST		67

#define BGP_INDEX(x)		(((x)>>1)-1)

/*
 * field set bits
 */

#define BGP_SET_agg_addr32v4		(1<<0)
#define BGP_SET_agg_addr32v6		(1<<1)
#define BGP_SET_agg_addrv4		(1<<2)
#define BGP_SET_agg_addrv6		(1<<3)
#define BGP_SET_cluster			(1<<4)
#define BGP_SET_community		(1<<5)
#define BGP_SET_dpa_addrv4		(1<<6)
#define BGP_SET_dpa_addrv6		(1<<7)
#define BGP_SET_dst_addrv4		(1<<8)
#define BGP_SET_dst_addrv6		(1<<9)
#define BGP_SET_extended		(1<<10)
#define BGP_SET_hopv4			(1<<11)
#define BGP_SET_hopv6			(1<<12)
#define BGP_SET_mvpn			(1<<13)
#define BGP_SET_originatorv6		(1<<14)
#define BGP_SET_path16			(1L<<15)
#define BGP_SET_path32			(1L<<16)
#define BGP_SET_prefixv4		(1L<<17)
#define BGP_SET_prefixv6		(1L<<18)
#define BGP_SET_src_addrv4		(1L<<19)
#define BGP_SET_src_addrv6		(1L<<20)
#define BGP_SET_unknown			(1L<<21)

/*
 * BGP_type
 */

#define BGP_TYPE_announce	'A'
#define BGP_TYPE_keepalive	'K'
#define BGP_TYPE_notification	'N'
#define BGP_TYPE_open		'O'
#define BGP_TYPE_state_change	'S'
#define BGP_TYPE_table_dump	'T'
#define BGP_TYPE_withdraw	'W'

/*
 * BGP_origin
 */

#define BGP_ORIGIN_incomplete	'?'
#define BGP_ORIGIN_egp		'e'
#define BGP_ORIGIN_igp		'i'

#define BGPCLUSTER(r)		((Bgpnum_t*)((r)->data+(r)->cluster.offset))
#define BGPCOMMUNITY(r)		((Bgpasn_t*)((r)->data+(r)->community.offset))
#define BGPEXTENDED(r)		((Bgpasn_t*)((r)->data+(r)->extended.offset))
#define BGPLABELS(r)		((Bgpasn_t*)((r)->data+(r)->labels.offset))
#define BGPPATH(r)		((Bgpasn_t*)((r)->data+(r)->path.offset))
#define BGPPATH32(r)		((Bgpnum_t*)((r)->data+(r)->path32.offset))

union Bgpaddr_u; typedef union Bgpaddr_u Bgpaddr_t;
struct Bgproute_s; typedef struct Bgproute_s Bgproute_t;
struct Bgpvec_s; typedef struct Bgpvec_s Bgpvec_t;

typedef uint16_t Bgpasn_t;
typedef uint32_t Bgpnum_t;

struct Bgpvec_s				/* vector data			*/
{
	Bgpasn_t	offset;		/* Bgproute_t.data[] offset	*/
	Bgpasn_t	size;		/* # elements			*/
	Bgpasn_t	maxsize;	/* max allocated size		*/
	Bgpasn_t	elements;	/* sizeof() elements		*/
	Bgpasn_t	flags;		/* data-specific flags		*/
	Bgpasn_t	attr;		/* data-specific attribute	*/
};

union Bgpaddr_u				/* ipv4/ipv6 address		*/
{
	Bgpnum_t	v4;		/* ipv4 addr			*/
	unsigned char	v6[16];		/* ipv6 addr			*/
};

/* BGP_TYPE_state_change */

#define old_state	agg_as
#define new_state	dpa_as

/* BGP_TYPE_open */

#define open_version	med
#define open_as		agg_as
#define open_hold	dpa_as
#define open_id		originator.v4
#define open_size	local

/* BGP_TYPE_notification */

#define note_code	agg_as
#define note_subcode	dpa_as
#define note_size	local

struct Bgproute_s
{
	/* 128/32 bit members						*/

	Bgpaddr_t	addr;		/* prefix address		*/
	Bgpaddr_t	agg_addr32;	/* aggregator as32 addr		*/
	Bgpaddr_t	agg_addr;	/* aggregator addr		*/
	Bgpaddr_t	dpa_addr;	/* dpa addr			*/
	Bgpaddr_t	dst_addr;	/* destination addr		*/
	Bgpaddr_t	hop;		/* next hop addr		*/
	Bgpaddr_t	originator;	/* originator addr		*/
	Bgpaddr_t	rd_addr;	/* nlri rd addr			*/
	Bgpaddr_t	src_addr;	/* source addr			*/

	/* 32 bit members */

	Bgpnum_t	size;		/* actual record size		*/
	Bgpnum_t	local;		/* local preference		*/
	Bgpnum_t	med;		/* med				*/
	Bgpnum_t	weight;		/* router proprietary weight	*/
	Bgpnum_t	time;		/* packet event time stamp	*/
	Bgpnum_t	usec;		/* packet event time stamp usec	*/
	Bgpnum_t	stamp;		/* data time stamp		*/
	Bgpnum_t	message;	/* message group index		*/
	Bgpnum_t	agg_as32;	/* aggregator as32		*/
	Bgpnum_t	dpa_as32;	/* dpa as32			*/
	Bgpnum_t	dst_as32;	/* destination as32		*/
	Bgpnum_t	src_as32;	/* source as32			*/
	Bgpnum_t	set;		/* BGP_SET_* bitmask		*/
	Bgpnum_t	label;		/* nlri label			*/
	Bgpnum_t	rd_as;		/* nlri rd as number 		*/
	Bgpnum_t	rd_number;	/* nlri rd assigned number 	*/
	Bgpnum_t	flags;		/* aux flags			*/
	Bgpnum_t	id;		/* aux id			*/

	/* 16 bit members */

	Bgpvec_t	path;		/* as path			*/
	Bgpvec_t	cluster;	/* clusters			*/
	Bgpvec_t	community;	/* communities			*/
	Bgpvec_t	extended;	/* extended communities		*/
	Bgpvec_t	labels;		/* NLRI labels			*/
	Bgpvec_t	path32;		/* as32 path			*/
	Bgpvec_t	unknown;	/* unknown attributes		*/
	Bgpvec_t	ped;		/* pe discriminator addr.label	*/

	Bgpasn_t	attr;		/* BGP_[a-z]* route attributes	*/
	Bgpasn_t	agg_as;		/* aggregator as		*/
	Bgpasn_t	dpa_as;		/* dpa as			*/
	Bgpasn_t	dst_as;		/* destination as		*/
	Bgpasn_t	src_as;		/* source as			*/

	/* 8 bit members */

	unsigned char	bits;		/* prefix bits			*/
	unsigned char	type;		/* BGP_TYPE_*			*/
	unsigned char	origin;		/* BGP_ORIGIN_*			*/
	unsigned char	blocks;		/* # blocks for this record	*/
	unsigned char	afi;		/* announce afi			*/
	unsigned char	safi;		/* announce subsequent afi	*/
	unsigned char	p1;		/* parameter 1			*/
	unsigned char	rd_type;	/* nlri rd type			*/

	/* unaligned fixed buffer members */

	unsigned char	prefixv6[17];	/* prefix			*/

	char		pad[5];		/* pad to 8 byte boundary	*/

	char		data[1704];	/* vector data (round to 2K)	*/
};

#endif