[mirror_frr.git] / ospfd / ospf_lsa.h

/*
 * OSPF Link State Advertisement
 * Copyright (C) 1999, 2000 Toshiaki Takada
 *
 * 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 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 _ZEBRA_OSPF_LSA_H
#define _ZEBRA_OSPF_LSA_H

#include "stream.h"

/* OSPF LSA Default metric values */
#define DEFAULT_DEFAULT_METRIC 20
#define DEFAULT_DEFAULT_ORIGINATE_METRIC 10
#define DEFAULT_DEFAULT_ALWAYS_METRIC 1
#define DEFAULT_METRIC_TYPE EXTERNAL_METRIC_TYPE_2

/* OSPF LSA Range definition. */
#define OSPF_MIN_LSA		1  /* begin range here */
#define OSPF_MAX_LSA           12

/* OSPF LSA Type definition. */
#define OSPF_UNKNOWN_LSA	      0
#define OSPF_ROUTER_LSA               1
#define OSPF_NETWORK_LSA              2
#define OSPF_SUMMARY_LSA              3
#define OSPF_ASBR_SUMMARY_LSA         4
#define OSPF_AS_EXTERNAL_LSA          5
#define OSPF_GROUP_MEMBER_LSA	      6  /* Not supported. */
#define OSPF_AS_NSSA_LSA	              7
#define OSPF_EXTERNAL_ATTRIBUTES_LSA  8  /* Not supported. */
#define OSPF_OPAQUE_LINK_LSA	      9
#define OSPF_OPAQUE_AREA_LSA	     10
#define OSPF_OPAQUE_AS_LSA	     11

#define OSPF_LSA_HEADER_SIZE	     20U
#define OSPF_ROUTER_LSA_LINK_SIZE    12U
#define OSPF_ROUTER_LSA_TOS_SIZE      4U
#define OSPF_MAX_LSA_SIZE	   1500U

/* AS-external-LSA refresh method. */
#define LSA_REFRESH_IF_CHANGED	0
#define LSA_REFRESH_FORCE	1

/* OSPF LSA header. */
struct lsa_header {
	uint16_t ls_age;
	uint8_t options;
	uint8_t type;
	struct in_addr id;
	struct in_addr adv_router;
	uint32_t ls_seqnum;
	uint16_t checksum;
	uint16_t length;
};

struct vertex;

/* OSPF LSA. */
struct ospf_lsa {
	/* LSA origination flag. */
	uint8_t flags;
#define OSPF_LSA_SELF		  0x01
#define OSPF_LSA_SELF_CHECKED	  0x02
#define OSPF_LSA_RECEIVED	  0x04
#define OSPF_LSA_APPROVED	  0x08
#define OSPF_LSA_DISCARD	  0x10
#define OSPF_LSA_LOCAL_XLT	  0x20
#define OSPF_LSA_PREMATURE_AGE	  0x40
#define OSPF_LSA_IN_MAXAGE	  0x80

	/* LSA data. and size */
	struct lsa_header *data;
	size_t size;

	/* Received time stamp. */
	struct timeval tv_recv;

	/* Last time it was originated */
	struct timeval tv_orig;

	/* All of reference count, also lock to remove. */
	int lock;

	/* Flags for the SPF calculation. */
	struct vertex *stat;

	/* References to this LSA in neighbor retransmission lists*/
	int retransmit_counter;

	/* Area the LSA belongs to, may be NULL if AS-external-LSA. */
	struct ospf_area *area;

	/* Parent LSDB. */
	struct ospf_lsdb *lsdb;

	/* Related Route. */
	void *route;

	/* Refreshement List or Queue */
	int refresh_list;

	/* For Type-9 Opaque-LSAs */
	struct ospf_interface *oi;

	/* VRF Id */
	vrf_id_t vrf_id;

	/*For topo chg detection in HELPER role*/
	bool to_be_acknowledged;
};

/* OSPF LSA Link Type. */
#define LSA_LINK_TYPE_POINTOPOINT      1
#define LSA_LINK_TYPE_TRANSIT          2
#define LSA_LINK_TYPE_STUB             3
#define LSA_LINK_TYPE_VIRTUALLINK      4

/* OSPF Router LSA Flag. */
#define ROUTER_LSA_BORDER	       0x01 /* The router is an ABR */
#define ROUTER_LSA_EXTERNAL	       0x02 /* The router is an ASBR */
#define ROUTER_LSA_VIRTUAL	       0x04 /* The router has a VL in this area */
#define ROUTER_LSA_NT		       0x10 /* The routers always translates Type-7 */
#define ROUTER_LSA_SHORTCUT	       0x20 /* Shortcut-ABR specific flag */

#define IS_ROUTER_LSA_VIRTUAL(x)       ((x)->flags & ROUTER_LSA_VIRTUAL)
#define IS_ROUTER_LSA_EXTERNAL(x)      ((x)->flags & ROUTER_LSA_EXTERNAL)
#define IS_ROUTER_LSA_BORDER(x)	       ((x)->flags & ROUTER_LSA_BORDER)
#define IS_ROUTER_LSA_SHORTCUT(x)      ((x)->flags & ROUTER_LSA_SHORTCUT)
#define IS_ROUTER_LSA_NT(x)            ((x)->flags & ROUTER_LSA_NT)

/* OSPF Router-LSA Link information. */
struct router_lsa_link {
	struct in_addr link_id;
	struct in_addr link_data;
	struct {
		uint8_t type;
		uint8_t tos_count;
		uint16_t metric;
	} m[1];
};

/* OSPF Router-LSAs structure. */
#define OSPF_ROUTER_LSA_MIN_SIZE                   4U /* w/0 link descriptors */
/* There is an edge case, when number of links in a Router-LSA may be 0 without
   breaking the specification. A router, which has no other links to backbone
   area besides one virtual link, will not put any VL descriptor blocks into
   the Router-LSA generated for area 0 until a full adjacency over the VL is
   reached (RFC2328 12.4.1.3). In this case the Router-LSA initially received
   by the other end of the VL will have 0 link descriptor blocks, but soon will
   be replaced with the next revision having 1 descriptor block. */
struct router_lsa {
	struct lsa_header header;
	uint8_t flags;
	uint8_t zero;
	uint16_t links;
	struct router_link {
		struct in_addr link_id;
		struct in_addr link_data;
		uint8_t type;
		uint8_t tos;
		uint16_t metric;
	} link[1];
};

/* OSPF Network-LSAs structure. */
#define OSPF_NETWORK_LSA_MIN_SIZE                  8U /* w/1 router-ID */
struct network_lsa {
	struct lsa_header header;
	struct in_addr mask;
	struct in_addr routers[1];
};

/* OSPF Summary-LSAs structure. */
#define OSPF_SUMMARY_LSA_MIN_SIZE                  8U /* w/1 TOS metric block */
struct summary_lsa {
	struct lsa_header header;
	struct in_addr mask;
	uint8_t tos;
	uint8_t metric[3];
};

/* OSPF AS-external-LSAs structure. */
#define OSPF_AS_EXTERNAL_LSA_MIN_SIZE             16U /* w/1 TOS forwarding block */
struct as_external_lsa {
	struct lsa_header header;
	struct in_addr mask;
	struct as_route {
		uint8_t tos;
		uint8_t metric[3];
		struct in_addr fwd_addr;
		uint32_t route_tag;
	} e[1];
};

#include "ospfd/ospf_opaque.h"

/* Macros. */
#define GET_METRIC(x) get_metric(x)
#define IS_EXTERNAL_METRIC(x)   ((x) & 0x80)

#define GET_AGE(x)     (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
#define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? OSPF_LSA_MAXAGE : get_age(x))
#define IS_LSA_SELF(L)          (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
#define IS_LSA_MAXAGE(L)        (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
#define IS_LSA_MAX_SEQ(L)                                                      \
	((L)->data->ls_seqnum == htonl(OSPF_MAX_SEQUENCE_NUMBER))

#define OSPF_LSA_UPDATE_DELAY		2

#define OSPF_LSA_UPDATE_TIMER_ON(T, F)                                         \
	if (!(T))                                                              \
	(T) = thread_add_timer(master, (F), 0, 2)

#define CHECK_LSA_TYPE_1_TO_5_OR_7(type)                                       \
	((type == OSPF_ROUTER_LSA) || (type == OSPF_NETWORK_LSA)               \
	 || (type == OSPF_SUMMARY_LSA) || (type == OSPF_ASBR_SUMMARY_LSA)      \
	 || (type == OSPF_AS_EXTERNAL_LSA) || (type == OSPF_AS_NSSA_LSA))

/* Prototypes. */
/* XXX: Eek, time functions, similar are in lib/thread.c */
extern struct timeval int2tv(int);
extern struct timeval msec2tv(int);

extern int get_age(struct ospf_lsa *);
extern uint16_t ospf_lsa_checksum(struct lsa_header *);
extern int ospf_lsa_checksum_valid(struct lsa_header *);
extern int ospf_lsa_refresh_delay(struct ospf_lsa *);

extern const char *dump_lsa_key(struct ospf_lsa *);
extern uint32_t lsa_seqnum_increment(struct ospf_lsa *);
extern void lsa_header_set(struct stream *, uint8_t, uint8_t, struct in_addr,
			   struct in_addr);
extern struct ospf_neighbor *ospf_nbr_lookup_ptop(struct ospf_interface *);
extern int ospf_check_nbr_status(struct ospf *);

/* Prototype for LSA primitive. */
extern struct ospf_lsa *ospf_lsa_new(void);
extern struct ospf_lsa *ospf_lsa_new_and_data(size_t size);
extern struct ospf_lsa *ospf_lsa_dup(struct ospf_lsa *);
extern void ospf_lsa_free(struct ospf_lsa *);
extern struct ospf_lsa *ospf_lsa_lock(struct ospf_lsa *);
extern void ospf_lsa_unlock(struct ospf_lsa **);
extern void ospf_lsa_discard(struct ospf_lsa *);
extern int ospf_lsa_flush_schedule(struct ospf *, struct ospf_lsa *);
extern struct lsa_header *ospf_lsa_data_new(size_t);
extern struct lsa_header *ospf_lsa_data_dup(struct lsa_header *);
extern void ospf_lsa_data_free(struct lsa_header *);

/* Prototype for various LSAs */
extern void ospf_router_lsa_body_set(struct stream **s, struct ospf_area *area);
extern uint8_t router_lsa_flags(struct ospf_area *area);
extern int ospf_router_lsa_update(struct ospf *);
extern int ospf_router_lsa_update_area(struct ospf_area *);

extern void ospf_network_lsa_update(struct ospf_interface *);

extern struct ospf_lsa *
ospf_summary_lsa_originate(struct prefix_ipv4 *, uint32_t, struct ospf_area *);
extern struct ospf_lsa *ospf_summary_asbr_lsa_originate(struct prefix_ipv4 *,
							uint32_t,
							struct ospf_area *);

extern struct ospf_lsa *ospf_lsa_install(struct ospf *, struct ospf_interface *,
					 struct ospf_lsa *);

extern void ospf_nssa_lsa_flush(struct ospf *ospf, struct prefix_ipv4 *p);
extern void ospf_external_lsa_flush(struct ospf *, uint8_t,
				    struct prefix_ipv4 *,
				    ifindex_t /* , struct in_addr nexthop */);

extern struct in_addr ospf_get_ip_from_ifp(struct ospf_interface *);

extern struct ospf_lsa *ospf_external_lsa_originate(struct ospf *,
						    struct external_info *);
extern void ospf_external_lsa_rid_change(struct ospf *ospf);
extern struct ospf_lsa *ospf_lsa_lookup(struct ospf *ospf, struct ospf_area *,
					uint32_t, struct in_addr,
					struct in_addr);
extern struct ospf_lsa *ospf_lsa_lookup_by_id(struct ospf_area *, uint32_t,
					      struct in_addr);
extern struct ospf_lsa *ospf_lsa_lookup_by_header(struct ospf_area *,
						  struct lsa_header *);
extern int ospf_lsa_more_recent(struct ospf_lsa *, struct ospf_lsa *);
extern int ospf_lsa_different(struct ospf_lsa *, struct ospf_lsa *);
extern void ospf_flush_self_originated_lsas_now(struct ospf *);

extern int ospf_lsa_is_self_originated(struct ospf *, struct ospf_lsa *);

extern struct ospf_lsa *ospf_lsa_lookup_by_prefix(struct ospf_lsdb *, uint8_t,
						  struct prefix_ipv4 *,
						  struct in_addr);

extern void ospf_lsa_maxage(struct ospf *, struct ospf_lsa *);
extern uint32_t get_metric(uint8_t *);

extern int ospf_lsa_maxage_walker(struct thread *);
extern struct ospf_lsa *ospf_lsa_refresh(struct ospf *, struct ospf_lsa *);

extern void ospf_external_lsa_refresh_default(struct ospf *);

extern void ospf_external_lsa_refresh_type(struct ospf *, uint8_t,
					   unsigned short, int);
extern struct ospf_lsa *ospf_external_lsa_refresh(struct ospf *,
						  struct ospf_lsa *,
						  struct external_info *, int,
						  bool aggr);
extern struct in_addr ospf_lsa_unique_id(struct ospf *, struct ospf_lsdb *,
					 uint8_t, struct prefix_ipv4 *);
extern void ospf_schedule_lsa_flood_area(struct ospf_area *, struct ospf_lsa *);
extern void ospf_schedule_lsa_flush_area(struct ospf_area *, struct ospf_lsa *);

extern void ospf_refresher_register_lsa(struct ospf *, struct ospf_lsa *);
extern void ospf_refresher_unregister_lsa(struct ospf *, struct ospf_lsa *);
extern int ospf_lsa_refresh_walker(struct thread *);

extern void ospf_lsa_maxage_delete(struct ospf *, struct ospf_lsa *);

extern void ospf_discard_from_db(struct ospf *, struct ospf_lsdb *,
				 struct ospf_lsa *);

extern int metric_type(struct ospf *, uint8_t, unsigned short);
extern int metric_value(struct ospf *, uint8_t, unsigned short);

extern char link_info_set(struct stream **s, struct in_addr id,
			  struct in_addr data, uint8_t type, uint8_t tos,
			  uint16_t cost);

extern struct in_addr ospf_get_nssa_ip(struct ospf_area *);
extern int ospf_translated_nssa_compare(struct ospf_lsa *, struct ospf_lsa *);
extern struct ospf_lsa *ospf_translated_nssa_refresh(struct ospf *ospf,
						     struct ospf_lsa *type7,
						     struct ospf_lsa *type5);
extern struct ospf_lsa *ospf_translated_nssa_originate(struct ospf *ospf,
						       struct ospf_lsa *type7,
						       struct ospf_lsa *type5);
extern void ospf_check_and_gen_init_seq_lsa(struct ospf_interface *oi,
					    struct ospf_lsa *lsa);
extern void ospf_flush_lsa_from_area(struct ospf *ospf, struct in_addr area_id,
				     int type);
#endif /* _ZEBRA_OSPF_LSA_H */
Commit	Line	Data
718e3744	1	/*
	2	* OSPF Link State Advertisement
	3	* Copyright (C) 1999, 2000 Toshiaki Takada
	4	*
	5	* This file is part of GNU Zebra.
	6	*
	7	* GNU Zebra is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License as published by the
	9	* Free Software Foundation; either version 2, or (at your option) any
	10	* later version.
	11	*
	12	* GNU Zebra is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
896014f4 DL	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; see the file COPYING; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
718e3744	20	*/
	21
	22	#ifndef _ZEBRA_OSPF_LSA_H
	23	#define _ZEBRA_OSPF_LSA_H
	24
4dadc291	25	#include "stream.h"
4dadc291	26
236e900c QY	27	/* OSPF LSA Default metric values */
	28	#define DEFAULT_DEFAULT_METRIC 20
	29	#define DEFAULT_DEFAULT_ORIGINATE_METRIC 10
	30	#define DEFAULT_DEFAULT_ALWAYS_METRIC 1
	31	#define DEFAULT_METRIC_TYPE EXTERNAL_METRIC_TYPE_2
	32
718e3744	33	/* OSPF LSA Range definition. */
718e3744	34	#define OSPF_MIN_LSA 1 /* begin range here */
718e3744	35	#define OSPF_MAX_LSA 12
718e3744	36
	37	/* OSPF LSA Type definition. */
	38	#define OSPF_UNKNOWN_LSA 0
	39	#define OSPF_ROUTER_LSA 1
	40	#define OSPF_NETWORK_LSA 2
	41	#define OSPF_SUMMARY_LSA 3
	42	#define OSPF_ASBR_SUMMARY_LSA 4
	43	#define OSPF_AS_EXTERNAL_LSA 5
	44	#define OSPF_GROUP_MEMBER_LSA 6 /* Not supported. */
	45	#define OSPF_AS_NSSA_LSA 7
	46	#define OSPF_EXTERNAL_ATTRIBUTES_LSA 8 /* Not supported. */
	47	#define OSPF_OPAQUE_LINK_LSA 9
	48	#define OSPF_OPAQUE_AREA_LSA 10
	49	#define OSPF_OPAQUE_AS_LSA 11
	50
779adb01	51	#define OSPF_LSA_HEADER_SIZE 20U
779adb01	52	#define OSPF_ROUTER_LSA_LINK_SIZE 12U
05b7709d	53	#define OSPF_ROUTER_LSA_TOS_SIZE 4U
779adb01	54	#define OSPF_MAX_LSA_SIZE 1500U
718e3744	55
	56	/* AS-external-LSA refresh method. */
	57	#define LSA_REFRESH_IF_CHANGED 0
	58	#define LSA_REFRESH_FORCE 1
	59
	60	/* OSPF LSA header. */
d62a17ae	61	struct lsa_header {
d7c0a89a QY	62	uint16_t ls_age;
	63	uint8_t options;
	64	uint8_t type;
d62a17ae	65	struct in_addr id;
d62a17ae	66	struct in_addr adv_router;
d7c0a89a QY	67	uint32_t ls_seqnum;
	68	uint16_t checksum;
	69	uint16_t length;
718e3744	70	};
718e3744	71
c971918a DL	72	struct vertex;
c971918a DL	73
718e3744	74	/* OSPF LSA. */
d62a17ae	75	struct ospf_lsa {
d62a17ae	76	/* LSA origination flag. */
d7c0a89a	77	uint8_t flags;
718e3744	78	#define OSPF_LSA_SELF 0x01
	79	#define OSPF_LSA_SELF_CHECKED 0x02
	80	#define OSPF_LSA_RECEIVED 0x04
	81	#define OSPF_LSA_APPROVED 0x08
	82	#define OSPF_LSA_DISCARD 0x10
718e3744	83	#define OSPF_LSA_LOCAL_XLT 0x20
7ddf1d6e	84	#define OSPF_LSA_PREMATURE_AGE 0x40
3106a032	85	#define OSPF_LSA_IN_MAXAGE 0x80
718e3744	86
8db278b5	87	/* LSA data. and size */
d62a17ae	88	struct lsa_header *data;
8db278b5	89	size_t size;
718e3744	90
d62a17ae	91	/* Received time stamp. */
d62a17ae	92	struct timeval tv_recv;
718e3744	93
d62a17ae	94	/* Last time it was originated */
d62a17ae	95	struct timeval tv_orig;
718e3744	96
d62a17ae	97	/* All of reference count, also lock to remove. */
d62a17ae	98	int lock;
718e3744	99
d62a17ae	100	/* Flags for the SPF calculation. */
c971918a	101	struct vertex *stat;
718e3744	102
d62a17ae	103	/* References to this LSA in neighbor retransmission lists*/
d62a17ae	104	int retransmit_counter;
718e3744	105
d62a17ae	106	/* Area the LSA belongs to, may be NULL if AS-external-LSA. */
d62a17ae	107	struct ospf_area *area;
718e3744	108
d62a17ae	109	/* Parent LSDB. */
d62a17ae	110	struct ospf_lsdb *lsdb;
718e3744	111
d62a17ae	112	/* Related Route. */
	113	void *route;
	114
	115	/* Refreshement List or Queue */
	116	int refresh_list;
	117
	118	/* For Type-9 Opaque-LSAs */
	119	struct ospf_interface *oi;
b5a8894d CS	120
	121	/* VRF Id */
	122	vrf_id_t vrf_id;
ad686992	123
	124	/For topo chg detection in HELPER role/
	125	bool to_be_acknowledged;
718e3744	126	};
	127
	128	/* OSPF LSA Link Type. */
	129	#define LSA_LINK_TYPE_POINTOPOINT 1
	130	#define LSA_LINK_TYPE_TRANSIT 2
	131	#define LSA_LINK_TYPE_STUB 3
	132	#define LSA_LINK_TYPE_VIRTUALLINK 4
	133
	134	/* OSPF Router LSA Flag. */
	135	#define ROUTER_LSA_BORDER 0x01 /* The router is an ABR */
	136	#define ROUTER_LSA_EXTERNAL 0x02 /* The router is an ASBR */
	137	#define ROUTER_LSA_VIRTUAL 0x04 /* The router has a VL in this area */
0c9491b3	138	#define ROUTER_LSA_NT 0x10 /* The routers always translates Type-7 */
718e3744	139	#define ROUTER_LSA_SHORTCUT 0x20 /* Shortcut-ABR specific flag */
	140
	141	#define IS_ROUTER_LSA_VIRTUAL(x) ((x)->flags & ROUTER_LSA_VIRTUAL)
	142	#define IS_ROUTER_LSA_EXTERNAL(x) ((x)->flags & ROUTER_LSA_EXTERNAL)
	143	#define IS_ROUTER_LSA_BORDER(x) ((x)->flags & ROUTER_LSA_BORDER)
	144	#define IS_ROUTER_LSA_SHORTCUT(x) ((x)->flags & ROUTER_LSA_SHORTCUT)
0c9491b3	145	#define IS_ROUTER_LSA_NT(x) ((x)->flags & ROUTER_LSA_NT)
718e3744	146
718e3744	147	/* OSPF Router-LSA Link information. */
d62a17ae	148	struct router_lsa_link {
	149	struct in_addr link_id;
	150	struct in_addr link_data;
	151	struct {
d7c0a89a QY	152	uint8_t type;
	153	uint8_t tos_count;
	154	uint16_t metric;
d62a17ae	155	} m[1];
718e3744	156	};
	157
	158	/* OSPF Router-LSAs structure. */
a25a44db DO	159	#define OSPF_ROUTER_LSA_MIN_SIZE 4U /* w/0 link descriptors */
	160	/* There is an edge case, when number of links in a Router-LSA may be 0 without
	161	breaking the specification. A router, which has no other links to backbone
	162	area besides one virtual link, will not put any VL descriptor blocks into
	163	the Router-LSA generated for area 0 until a full adjacency over the VL is
	164	reached (RFC2328 12.4.1.3). In this case the Router-LSA initially received
	165	by the other end of the VL will have 0 link descriptor blocks, but soon will
	166	be replaced with the next revision having 1 descriptor block. */
d62a17ae	167	struct router_lsa {
d62a17ae	168	struct lsa_header header;
d7c0a89a QY	169	uint8_t flags;
	170	uint8_t zero;
	171	uint16_t links;
8db278b5	172	struct router_link {
d62a17ae	173	struct in_addr link_id;
d62a17ae	174	struct in_addr link_data;
d7c0a89a QY	175	uint8_t type;
	176	uint8_t tos;
	177	uint16_t metric;
d62a17ae	178	} link[1];
718e3744	179	};
	180
	181	/* OSPF Network-LSAs structure. */
4e31de79	182	#define OSPF_NETWORK_LSA_MIN_SIZE 8U /* w/1 router-ID */
d62a17ae	183	struct network_lsa {
	184	struct lsa_header header;
	185	struct in_addr mask;
	186	struct in_addr routers[1];
718e3744	187	};
	188
	189	/* OSPF Summary-LSAs structure. */
4e31de79	190	#define OSPF_SUMMARY_LSA_MIN_SIZE 8U /* w/1 TOS metric block */
d62a17ae	191	struct summary_lsa {
	192	struct lsa_header header;
	193	struct in_addr mask;
d7c0a89a QY	194	uint8_t tos;
d7c0a89a QY	195	uint8_t metric[3];
718e3744	196	};
	197
	198	/* OSPF AS-external-LSAs structure. */
4e31de79	199	#define OSPF_AS_EXTERNAL_LSA_MIN_SIZE 16U /* w/1 TOS forwarding block */
d62a17ae	200	struct as_external_lsa {
	201	struct lsa_header header;
	202	struct in_addr mask;
8db278b5	203	struct as_route {
d7c0a89a QY	204	uint8_t tos;
d7c0a89a QY	205	uint8_t metric[3];
d62a17ae	206	struct in_addr fwd_addr;
d7c0a89a	207	uint32_t route_tag;
d62a17ae	208	} e[1];
718e3744	209	};
718e3744	210
718e3744	211	#include "ospfd/ospf_opaque.h"
718e3744	212
	213	/* Macros. */
	214	#define GET_METRIC(x) get_metric(x)
	215	#define IS_EXTERNAL_METRIC(x) ((x) & 0x80)
	216
	217	#define GET_AGE(x) (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
d62a17ae	218	#define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? OSPF_LSA_MAXAGE : get_age(x))
718e3744	219	#define IS_LSA_SELF(L) (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
718e3744	220	#define IS_LSA_MAXAGE(L) (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
44d1115a MR	221	#define IS_LSA_MAX_SEQ(L) \
44d1115a MR	222	((L)->data->ls_seqnum == htonl(OSPF_MAX_SEQUENCE_NUMBER))
718e3744	223
718e3744	224	#define OSPF_LSA_UPDATE_DELAY 2
718e3744	225
d62a17ae	226	#define OSPF_LSA_UPDATE_TIMER_ON(T, F) \
	227	if (!(T)) \
	228	(T) = thread_add_timer(master, (F), 0, 2)
718e3744	229
df074ec3	230	#define CHECK_LSA_TYPE_1_TO_5_OR_7(type) \
	231	((type == OSPF_ROUTER_LSA) \|\| (type == OSPF_NETWORK_LSA) \
	232	\|\| (type == OSPF_SUMMARY_LSA) \|\| (type == OSPF_ASBR_SUMMARY_LSA) \
	233	\|\| (type == OSPF_AS_EXTERNAL_LSA) \|\| (type == OSPF_AS_NSSA_LSA))
	234
718e3744	235	/* Prototypes. */
4dadc291	236	/* XXX: Eek, time functions, similar are in lib/thread.c */
d62a17ae	237	extern struct timeval int2tv(int);
d62a17ae	238	extern struct timeval msec2tv(int);
4dadc291	239
d62a17ae	240	extern int get_age(struct ospf_lsa *);
d7c0a89a	241	extern uint16_t ospf_lsa_checksum(struct lsa_header *);
d62a17ae	242	extern int ospf_lsa_checksum_valid(struct lsa_header *);
d62a17ae	243	extern int ospf_lsa_refresh_delay(struct ospf_lsa *);
4dadc291	244
d62a17ae	245	extern const char dump_lsa_key(struct ospf_lsa );
d7c0a89a QY	246	extern uint32_t lsa_seqnum_increment(struct ospf_lsa *);
d7c0a89a QY	247	extern void lsa_header_set(struct stream *, uint8_t, uint8_t, struct in_addr,
d62a17ae	248	struct in_addr);
	249	extern struct ospf_neighbor ospf_nbr_lookup_ptop(struct ospf_interface );
	250	extern int ospf_check_nbr_status(struct ospf *);
718e3744	251
718e3744	252	/* Prototype for LSA primitive. */
d62a17ae	253	extern struct ospf_lsa *ospf_lsa_new(void);
5b3d4186	254	extern struct ospf_lsa *ospf_lsa_new_and_data(size_t size);
d62a17ae	255	extern struct ospf_lsa ospf_lsa_dup(struct ospf_lsa );
	256	extern void ospf_lsa_free(struct ospf_lsa *);
	257	extern struct ospf_lsa ospf_lsa_lock(struct ospf_lsa );
	258	extern void ospf_lsa_unlock(struct ospf_lsa **);
	259	extern void ospf_lsa_discard(struct ospf_lsa *);
	260	extern int ospf_lsa_flush_schedule(struct ospf , struct ospf_lsa );
	261	extern struct lsa_header *ospf_lsa_data_new(size_t);
	262	extern struct lsa_header ospf_lsa_data_dup(struct lsa_header );
	263	extern void ospf_lsa_data_free(struct lsa_header *);
718e3744	264
718e3744	265	/* Prototype for various LSAs */
7fd0729f G	266	extern void ospf_router_lsa_body_set(struct stream *s, struct ospf_area area);
7fd0729f G	267	extern uint8_t router_lsa_flags(struct ospf_area *area);
d62a17ae	268	extern int ospf_router_lsa_update(struct ospf *);
	269	extern int ospf_router_lsa_update_area(struct ospf_area *);
	270
	271	extern void ospf_network_lsa_update(struct ospf_interface *);
	272
	273	extern struct ospf_lsa *
d7c0a89a	274	ospf_summary_lsa_originate(struct prefix_ipv4 , uint32_t, struct ospf_area );
d62a17ae	275	extern struct ospf_lsa ospf_summary_asbr_lsa_originate(struct prefix_ipv4 ,
d7c0a89a	276	uint32_t,
d62a17ae	277	struct ospf_area *);
	278
	279	extern struct ospf_lsa ospf_lsa_install(struct ospf , struct ospf_interface *,
	280	struct ospf_lsa *);
	281
	282	extern void ospf_nssa_lsa_flush(struct ospf ospf, struct prefix_ipv4 p);
d7c0a89a QY	283	extern void ospf_external_lsa_flush(struct ospf *, uint8_t,
d7c0a89a QY	284	struct prefix_ipv4 *,
d62a17ae	285	ifindex_t /* , struct in_addr nexthop */);
	286
	287	extern struct in_addr ospf_get_ip_from_ifp(struct ospf_interface *);
	288
	289	extern struct ospf_lsa ospf_external_lsa_originate(struct ospf ,
	290	struct external_info *);
fa3c7c7e	291	extern void ospf_external_lsa_rid_change(struct ospf *ospf);
b5a8894d	292	extern struct ospf_lsa ospf_lsa_lookup(struct ospf ospf, struct ospf_area *,
d7c0a89a	293	uint32_t, struct in_addr,
b5a8894d	294	struct in_addr);
d7c0a89a	295	extern struct ospf_lsa ospf_lsa_lookup_by_id(struct ospf_area , uint32_t,
d62a17ae	296	struct in_addr);
	297	extern struct ospf_lsa ospf_lsa_lookup_by_header(struct ospf_area ,
	298	struct lsa_header *);
	299	extern int ospf_lsa_more_recent(struct ospf_lsa , struct ospf_lsa );
	300	extern int ospf_lsa_different(struct ospf_lsa , struct ospf_lsa );
	301	extern void ospf_flush_self_originated_lsas_now(struct ospf *);
	302
	303	extern int ospf_lsa_is_self_originated(struct ospf , struct ospf_lsa );
	304
d7c0a89a	305	extern struct ospf_lsa ospf_lsa_lookup_by_prefix(struct ospf_lsdb , uint8_t,
d62a17ae	306	struct prefix_ipv4 *,
	307	struct in_addr);
	308
	309	extern void ospf_lsa_maxage(struct ospf , struct ospf_lsa );
d7c0a89a	310	extern uint32_t get_metric(uint8_t *);
d62a17ae	311
	312	extern int ospf_lsa_maxage_walker(struct thread *);
	313	extern struct ospf_lsa ospf_lsa_refresh(struct ospf , struct ospf_lsa *);
	314
	315	extern void ospf_external_lsa_refresh_default(struct ospf *);
	316
d7c0a89a QY	317	extern void ospf_external_lsa_refresh_type(struct ospf *, uint8_t,
d7c0a89a QY	318	unsigned short, int);
d62a17ae	319	extern struct ospf_lsa ospf_external_lsa_refresh(struct ospf ,
d62a17ae	320	struct ospf_lsa *,
63f0e941	321	struct external_info *, int,
63f0e941	322	bool aggr);
d62a17ae	323	extern struct in_addr ospf_lsa_unique_id(struct ospf , struct ospf_lsdb ,
d7c0a89a	324	uint8_t, struct prefix_ipv4 *);
d62a17ae	325	extern void ospf_schedule_lsa_flood_area(struct ospf_area , struct ospf_lsa );
	326	extern void ospf_schedule_lsa_flush_area(struct ospf_area , struct ospf_lsa );
	327
	328	extern void ospf_refresher_register_lsa(struct ospf , struct ospf_lsa );
	329	extern void ospf_refresher_unregister_lsa(struct ospf , struct ospf_lsa );
	330	extern int ospf_lsa_refresh_walker(struct thread *);
	331
	332	extern void ospf_lsa_maxage_delete(struct ospf , struct ospf_lsa );
	333
	334	extern void ospf_discard_from_db(struct ospf , struct ospf_lsdb ,
	335	struct ospf_lsa *);
d62a17ae	336
d7c0a89a QY	337	extern int metric_type(struct ospf *, uint8_t, unsigned short);
d7c0a89a QY	338	extern int metric_value(struct ospf *, uint8_t, unsigned short);
d62a17ae	339
7fd0729f G	340	extern char link_info_set(struct stream **s, struct in_addr id,
	341	struct in_addr data, uint8_t type, uint8_t tos,
	342	uint16_t cost);
	343
d62a17ae	344	extern struct in_addr ospf_get_nssa_ip(struct ospf_area *);
d62a17ae	345	extern int ospf_translated_nssa_compare(struct ospf_lsa , struct ospf_lsa );
c317eddb	346	extern struct ospf_lsa ospf_translated_nssa_refresh(struct ospf ospf,
	347	struct ospf_lsa *type7,
	348	struct ospf_lsa *type5);
	349	extern struct ospf_lsa ospf_translated_nssa_originate(struct ospf ospf,
	350	struct ospf_lsa *type7,
	351	struct ospf_lsa *type5);
3cb62bb3 MR	352	extern void ospf_check_and_gen_init_seq_lsa(struct ospf_interface *oi,
3cb62bb3 MR	353	struct ospf_lsa *lsa);
44445dee S	354	extern void ospf_flush_lsa_from_area(struct ospf *ospf, struct in_addr area_id,
44445dee S	355	int type);
718e3744	356	#endif /* _ZEBRA_OSPF_LSA_H */