[mirror_frr.git] / ospfd / ospf_opaque.h

/*
 * This is an implementation of rfc2370.
 * Copyright (C) 2001 KDD R&D Laboratories, Inc.
 * http://www.kddlabs.co.jp/
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra 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, or (at your option) any
 * later version.
 *
 * GNU Zebra 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 GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef _ZEBRA_OSPF_OPAQUE_H
#define _ZEBRA_OSPF_OPAQUE_H

#include "vty.h"

#define IS_OPAQUE_LSA(type)                                                    \
	((type) == OSPF_OPAQUE_LINK_LSA || (type) == OSPF_OPAQUE_AREA_LSA      \
	 || (type) == OSPF_OPAQUE_AS_LSA)

/*
 * Opaque LSA's link state ID is redefined as follows.
 *
 *        24       16        8        0
 * +--------+--------+--------+--------+
 * |tttttttt|........|........|........|
 * +--------+--------+--------+--------+
 * |<-Type->|<------- Opaque ID ------>|
 */
#define LSID_OPAQUE_TYPE_MASK	0xff000000	/*  8 bits */
#define LSID_OPAQUE_ID_MASK	0x00ffffff	/* 24 bits */

#define GET_OPAQUE_TYPE(lsid) (((u_int32_t)(lsid)&LSID_OPAQUE_TYPE_MASK) >> 24)

#define GET_OPAQUE_ID(lsid) ((u_int32_t)(lsid)&LSID_OPAQUE_ID_MASK)

#define SET_OPAQUE_LSID(type, id)                                              \
	((((type) << 24) & LSID_OPAQUE_TYPE_MASK) | ((id)&LSID_OPAQUE_ID_MASK))

/*
 * Opaque LSA types will be assigned by IANA.
 * <http://www.iana.org/assignments/ospf-opaque-types>
 */
#define OPAQUE_TYPE_TRAFFIC_ENGINEERING_LSA		1
#define OPAQUE_TYPE_SYCAMORE_OPTICAL_TOPOLOGY_DESC	2
#define OPAQUE_TYPE_GRACE_LSA				3
#define OPAQUE_TYPE_L1VPN_LSA                          5
#define OPAQUE_TYPE_ROUTER_INFORMATION_LSA             4
#define OPAQUE_TYPE_INTER_AS_LSA                       6
#define OPAQUE_TYPE_MAX                                6

/* Followings types are proposed in internet-draft documents. */
#define OPAQUE_TYPE_8021_QOSPF				129
#define OPAQUE_TYPE_SECONDARY_NEIGHBOR_DISCOVERY	224
#define OPAQUE_TYPE_FLOODGATE                           225

/* Ugly hack to make use of an unallocated value for wildcard matching! */
#define OPAQUE_TYPE_WILDCARD				0

#define OPAQUE_TYPE_RANGE_UNASSIGNED(type)                                     \
	(OPAQUE_TYPE_MAX <= (type) && (type) <= 127)

#define OPAQUE_TYPE_RANGE_RESERVED(type) (127 < (type) && (type) <= 255)

#define VALID_OPAQUE_INFO_LEN(lsahdr)                                          \
	((ntohs((lsahdr)->length) >= sizeof(struct lsa_header))                \
	 && ((ntohs((lsahdr)->length) % sizeof(u_int32_t)) == 0))

/* Prototypes. */

extern void ospf_opaque_init(void);
extern void ospf_opaque_term(void);
extern int ospf_opaque_type9_lsa_init(struct ospf_interface *oi);
extern void ospf_opaque_type9_lsa_term(struct ospf_interface *oi);
extern int ospf_opaque_type10_lsa_init(struct ospf_area *area);
extern void ospf_opaque_type10_lsa_term(struct ospf_area *area);
extern int ospf_opaque_type11_lsa_init(struct ospf *ospf);
extern void ospf_opaque_type11_lsa_term(struct ospf *ospf);

extern int ospf_register_opaque_functab(
	u_char lsa_type, u_char opaque_type,
	int (*new_if_hook)(struct interface *ifp),
	int (*del_if_hook)(struct interface *ifp),
	void (*ism_change_hook)(struct ospf_interface *oi, int old_status),
	void (*nsm_change_hook)(struct ospf_neighbor *nbr, int old_status),
	void (*config_write_router)(struct vty *vty),
	void (*config_write_if)(struct vty *vty, struct interface *ifp),
	void (*config_write_debug)(struct vty *vty),
	void (*show_opaque_info)(struct vty *vty, struct ospf_lsa *lsa),
	int (*lsa_originator)(void *arg),
	struct ospf_lsa *(*lsa_refresher)(struct ospf_lsa *lsa),
	int (*new_lsa_hook)(struct ospf_lsa *lsa),
	int (*del_lsa_hook)(struct ospf_lsa *lsa));
extern void ospf_delete_opaque_functab(u_char lsa_type, u_char opaque_type);

extern int ospf_opaque_new_if(struct interface *ifp);
extern int ospf_opaque_del_if(struct interface *ifp);
extern void ospf_opaque_ism_change(struct ospf_interface *oi, int old_status);
extern void ospf_opaque_nsm_change(struct ospf_neighbor *nbr, int old_status);
extern void ospf_opaque_config_write_router(struct vty *vty, struct ospf *);
extern void ospf_opaque_config_write_if(struct vty *vty, struct interface *ifp);
extern void ospf_opaque_config_write_debug(struct vty *vty);
extern void show_opaque_info_detail(struct vty *vty, struct ospf_lsa *lsa);
extern void ospf_opaque_lsa_dump(struct stream *s, u_int16_t length);

extern void ospf_opaque_lsa_originate_schedule(struct ospf_interface *oi,
					       int *init_delay);
extern struct ospf_lsa *ospf_opaque_lsa_install(struct ospf_lsa *,
						int rt_recalc);
extern struct ospf_lsa *ospf_opaque_lsa_refresh(struct ospf_lsa *lsa);

extern void ospf_opaque_lsa_reoriginate_schedule(void *lsa_type_dependent,
						 u_char lsa_type,
						 u_char opaque_type);
extern void ospf_opaque_lsa_refresh_schedule(struct ospf_lsa *lsa);
extern void ospf_opaque_lsa_flush_schedule(struct ospf_lsa *lsa);

extern void ospf_opaque_self_originated_lsa_received(struct ospf_neighbor *nbr,
						     struct ospf_lsa *lsa);
extern struct ospf *oi_to_top(struct ospf_interface *oi);

#endif /* _ZEBRA_OSPF_OPAQUE_H */
Commit	Line	Data
718e3744	1	/*
	2	* This is an implementation of rfc2370.
	3	* Copyright (C) 2001 KDD R&D Laboratories, Inc.
	4	* http://www.kddlabs.co.jp/
	5	*
	6	* This file is part of GNU Zebra.
	7	*
	8	* GNU Zebra is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the
	10	* Free Software Foundation; either version 2, or (at your option) any
	11	* later version.
ac4d0be5	12	*
718e3744	13	* GNU Zebra is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with GNU Zebra; see the file COPYING. If not, write to the Free
	20	* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
	21	* 02111-1307, USA.
	22	*/
	23
	24	#ifndef _ZEBRA_OSPF_OPAQUE_H
	25	#define _ZEBRA_OSPF_OPAQUE_H
	26
4dadc291	27	#include "vty.h"
4dadc291	28
ac4d0be5	29	#define IS_OPAQUE_LSA(type) \
	30	((type) == OSPF_OPAQUE_LINK_LSA \|\| (type) == OSPF_OPAQUE_AREA_LSA \
	31	\|\| (type) == OSPF_OPAQUE_AS_LSA)
718e3744	32
718e3744	33	/*
	34	* Opaque LSA's link state ID is redefined as follows.
	35	*
	36	* 24 16 8 0
	37	* +--------+--------+--------+--------+
	38	* \|tttttttt\|........\|........\|........\|
	39	* +--------+--------+--------+--------+
	40	* \|<-Type->\|<------- Opaque ID ------>\|
	41	*/
	42	#define LSID_OPAQUE_TYPE_MASK 0xff000000 /* 8 bits */
	43	#define LSID_OPAQUE_ID_MASK 0x00ffffff /* 24 bits */
	44
ac4d0be5	45	#define GET_OPAQUE_TYPE(lsid) (((u_int32_t)(lsid)&LSID_OPAQUE_TYPE_MASK) >> 24)
718e3744	46
ac4d0be5	47	#define GET_OPAQUE_ID(lsid) ((u_int32_t)(lsid)&LSID_OPAQUE_ID_MASK)
718e3744	48
ac4d0be5	49	#define SET_OPAQUE_LSID(type, id) \
ac4d0be5	50	((((type) << 24) & LSID_OPAQUE_TYPE_MASK) \| ((id)&LSID_OPAQUE_ID_MASK))
718e3744	51
	52	/*
	53	* Opaque LSA types will be assigned by IANA.
	54	* <http://www.iana.org/assignments/ospf-opaque-types>
	55	*/
	56	#define OPAQUE_TYPE_TRAFFIC_ENGINEERING_LSA 1
	57	#define OPAQUE_TYPE_SYCAMORE_OPTICAL_TOPOLOGY_DESC 2
	58	#define OPAQUE_TYPE_GRACE_LSA 3
16f1b9ee OD	59	#define OPAQUE_TYPE_L1VPN_LSA 5
	60	#define OPAQUE_TYPE_ROUTER_INFORMATION_LSA 4
	61	#define OPAQUE_TYPE_INTER_AS_LSA 6
	62	#define OPAQUE_TYPE_MAX 6
718e3744	63
	64	/* Followings types are proposed in internet-draft documents. */
	65	#define OPAQUE_TYPE_8021_QOSPF 129
	66	#define OPAQUE_TYPE_SECONDARY_NEIGHBOR_DISCOVERY 224
	67	#define OPAQUE_TYPE_FLOODGATE 225
	68
	69	/* Ugly hack to make use of an unallocated value for wildcard matching! */
	70	#define OPAQUE_TYPE_WILDCARD 0
	71
ac4d0be5	72	#define OPAQUE_TYPE_RANGE_UNASSIGNED(type) \
ac4d0be5	73	(OPAQUE_TYPE_MAX <= (type) && (type) <= 127)
718e3744	74
ac4d0be5	75	#define OPAQUE_TYPE_RANGE_RESERVED(type) (127 < (type) && (type) <= 255)
718e3744	76
ac4d0be5	77	#define VALID_OPAQUE_INFO_LEN(lsahdr) \
	78	((ntohs((lsahdr)->length) >= sizeof(struct lsa_header)) \
	79	&& ((ntohs((lsahdr)->length) % sizeof(u_int32_t)) == 0))
718e3744	80
718e3744	81	/* Prototypes. */
718e3744	82
ac4d0be5	83	extern void ospf_opaque_init(void);
	84	extern void ospf_opaque_term(void);
	85	extern int ospf_opaque_type9_lsa_init(struct ospf_interface *oi);
	86	extern void ospf_opaque_type9_lsa_term(struct ospf_interface *oi);
	87	extern int ospf_opaque_type10_lsa_init(struct ospf_area *area);
	88	extern void ospf_opaque_type10_lsa_term(struct ospf_area *area);
	89	extern int ospf_opaque_type11_lsa_init(struct ospf *ospf);
	90	extern void ospf_opaque_type11_lsa_term(struct ospf *ospf);
	91
	92	extern int ospf_register_opaque_functab(
	93	u_char lsa_type, u_char opaque_type,
	94	int (new_if_hook)(struct interface ifp),
	95	int (del_if_hook)(struct interface ifp),
	96	void (ism_change_hook)(struct ospf_interface oi, int old_status),
	97	void (nsm_change_hook)(struct ospf_neighbor nbr, int old_status),
	98	void (config_write_router)(struct vty vty),
	99	void (config_write_if)(struct vty vty, struct interface *ifp),
	100	void (config_write_debug)(struct vty vty),
	101	void (show_opaque_info)(struct vty vty, struct ospf_lsa *lsa),
	102	int (lsa_originator)(void arg),
	103	struct ospf_lsa (lsa_refresher)(struct ospf_lsa *lsa),
	104	int (new_lsa_hook)(struct ospf_lsa lsa),
	105	int (del_lsa_hook)(struct ospf_lsa lsa));
	106	extern void ospf_delete_opaque_functab(u_char lsa_type, u_char opaque_type);
	107
	108	extern int ospf_opaque_new_if(struct interface *ifp);
	109	extern int ospf_opaque_del_if(struct interface *ifp);
	110	extern void ospf_opaque_ism_change(struct ospf_interface *oi, int old_status);
	111	extern void ospf_opaque_nsm_change(struct ospf_neighbor *nbr, int old_status);
	112	extern void ospf_opaque_config_write_router(struct vty vty, struct ospf );
	113	extern void ospf_opaque_config_write_if(struct vty vty, struct interface ifp);
	114	extern void ospf_opaque_config_write_debug(struct vty *vty);
	115	extern void show_opaque_info_detail(struct vty vty, struct ospf_lsa lsa);
	116	extern void ospf_opaque_lsa_dump(struct stream *s, u_int16_t length);
	117
	118	extern void ospf_opaque_lsa_originate_schedule(struct ospf_interface *oi,
	119	int *init_delay);
	120	extern struct ospf_lsa ospf_opaque_lsa_install(struct ospf_lsa ,
	121	int rt_recalc);
	122	extern struct ospf_lsa ospf_opaque_lsa_refresh(struct ospf_lsa lsa);
	123
	124	extern void ospf_opaque_lsa_reoriginate_schedule(void *lsa_type_dependent,
	125	u_char lsa_type,
	126	u_char opaque_type);
	127	extern void ospf_opaque_lsa_refresh_schedule(struct ospf_lsa *lsa);
	128	extern void ospf_opaque_lsa_flush_schedule(struct ospf_lsa *lsa);
	129
	130	extern void ospf_opaque_self_originated_lsa_received(struct ospf_neighbor *nbr,
	131	struct ospf_lsa *lsa);
	132	extern struct ospf oi_to_top(struct ospf_interface oi);
718e3744	133
718e3744	134	#endif /* _ZEBRA_OSPF_OPAQUE_H */