[mirror_frr.git] / isisd / isis_circuit.h

/*
 * IS-IS Rout(e)ing protocol - isis_circuit.h
 *
 * Copyright (C) 2001,2002   Sampo Saaristo
 *                           Tampere University of Technology
 *                           Institute of Communications Engineering
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public Licenseas 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 ISIS_CIRCUIT_H
#define ISIS_CIRCUIT_H

#include "vty.h"
#include "if.h"
#include "qobj.h"

#include "isis_constants.h"
#include "isis_common.h"

#define CIRCUIT_MAX 255

struct password {
	struct password *next;
	int len;
	u_char *pass;
};

struct metric {
	u_char metric_default;
	u_char metric_error;
	u_char metric_expense;
	u_char metric_delay;
};

struct isis_bcast_info {
	u_char snpa[ETH_ALEN];		    /* SNPA of this circuit */
	char run_dr_elect[2];		    /* Should we run dr election ? */
	struct thread *t_run_dr[2];	 /* DR election thread */
	struct thread *t_send_lan_hello[2]; /* send LAN IIHs in this thread */
	struct list *adjdb[2];		    /* adjacency dbs */
	struct list *lan_neighs[2];	 /* list of lx neigh snpa */
	char is_dr[2];			    /* Are we level x DR ? */
	u_char l1_desig_is[ISIS_SYS_ID_LEN + 1]; /* level-1 DR */
	u_char l2_desig_is[ISIS_SYS_ID_LEN + 1]; /* level-2 DR */
	struct thread *t_refresh_pseudo_lsp[2];  /* refresh pseudo-node LSPs */
};

struct isis_p2p_info {
	struct isis_adjacency *neighbor;
	struct thread *t_send_p2p_hello; /* send P2P IIHs in this thread  */
};

struct isis_circuit {
	int state;
	u_char circuit_id;	   /* l1/l2 p2p/bcast CircuitID */
	struct isis_area *area;      /* back pointer to the area */
	struct interface *interface; /* interface info from z */
	int fd;			     /* IS-IS l1/2 socket */
	int sap_length;		     /* SAP length for DLPI */
	struct nlpids nlpids;
	/*
	 * Threads
	 */
	struct thread *t_read;
	struct thread *t_send_csnp[2];
	struct thread *t_send_psnp[2];
	struct list *lsp_queue;	/* LSPs to be txed (both levels) */
	time_t lsp_queue_last_cleared; /* timestamp used to enforce transmit
					* interval;
					* for scalability, use one timestamp per
					* circuit, instead of one per lsp per
					* circuit
					*/
	/* there is no real point in two streams, just for programming kicker */
	int (*rx)(struct isis_circuit *circuit, u_char *ssnpa);
	struct stream *rcv_stream; /* Stream for receiving */
	int (*tx)(struct isis_circuit *circuit, int level);
	struct stream *snd_stream; /* Stream for sending */
	int idx;		   /* idx in S[RM|SN] flags */
				   /* $FRR indent$ */
				   /* clang-format off */
#define CIRCUIT_T_UNKNOWN    0
#define CIRCUIT_T_BROADCAST  1
#define CIRCUIT_T_P2P        2
#define CIRCUIT_T_LOOPBACK   3
	int circ_type;		   /* type of the physical interface */
	int circ_type_config;      /* config type of the physical interface */
	union {
		struct isis_bcast_info bc;
		struct isis_p2p_info p2p;
	} u;
	u_char priority[2]; /* l1/2 IS configured priority */
	int pad_hellos;     /* add padding to Hello PDUs ? */
	char ext_domain;    /* externalDomain   (boolean) */
	int lsp_regenerate_pending[ISIS_LEVELS];
	/*
	 * Configurables
	 */
	struct isis_passwd passwd;     /* Circuit rx/tx password */
	int is_type;		       /* circuit is type == level of circuit
					* differentiated from circuit type (media) */
	u_int32_t hello_interval[2];   /* l1HelloInterval in msecs */
	u_int16_t hello_multiplier[2]; /* l1HelloMultiplier */
	u_int16_t csnp_interval[2];    /* level-1 csnp-interval in seconds */
	u_int16_t psnp_interval[2];    /* level-1 psnp-interval in seconds */
	u_int8_t metric[2];
	u_int32_t te_metric[2];
	struct mpls_te_circuit
		*mtc;   /* Support for MPLS-TE parameters - see isis_te.[c,h] */
	int ip_router;  /* Route IP ? */
	int is_passive; /* Is Passive ? */
	struct list *mt_settings;   /* IS-IS MT Settings */
	struct list *ip_addrs;      /* our IP addresses */
	int ipv6_router;	    /* Route IPv6 ? */
	struct list *ipv6_link;     /* our link local IPv6 addresses */
	struct list *ipv6_non_link; /* our non-link local IPv6 addresses */
	u_int16_t upadjcount[2];
#define ISIS_CIRCUIT_FLAPPED_AFTER_SPF 0x01
	u_char flags;
	/*
	 * Counters as in 10589--11.2.5.9
	 */
	u_int32_t adj_state_changes; /* changesInAdjacencyState */
	u_int32_t init_failures;     /* intialisationFailures */
	u_int32_t ctrl_pdus_rxed;    /* controlPDUsReceived */
	u_int32_t ctrl_pdus_txed;    /* controlPDUsSent */
	u_int32_t
		desig_changes[2]; /* lanLxDesignatedIntermediateSystemChanges */
	u_int32_t rej_adjacencies; /* rejectedAdjacencies */

	QOBJ_FIELDS
};
DECLARE_QOBJ_TYPE(isis_circuit)

void isis_circuit_init(void);
struct isis_circuit *isis_circuit_new(void);
void isis_circuit_del(struct isis_circuit *circuit);
struct isis_circuit *circuit_lookup_by_ifp(struct interface *ifp,
					   struct list *list);
struct isis_circuit *circuit_scan_by_ifp(struct interface *ifp);
void isis_circuit_configure(struct isis_circuit *circuit,
			    struct isis_area *area);
void isis_circuit_deconfigure(struct isis_circuit *circuit,
			      struct isis_area *area);
void isis_circuit_if_add(struct isis_circuit *circuit, struct interface *ifp);
void isis_circuit_if_del(struct isis_circuit *circuit, struct interface *ifp);
void isis_circuit_if_bind(struct isis_circuit *circuit, struct interface *ifp);
void isis_circuit_if_unbind(struct isis_circuit *circuit,
			    struct interface *ifp);
void isis_circuit_add_addr(struct isis_circuit *circuit,
			   struct connected *conn);
void isis_circuit_del_addr(struct isis_circuit *circuit,
			   struct connected *conn);
void isis_circuit_prepare(struct isis_circuit *circuit);
int isis_circuit_up(struct isis_circuit *circuit);
void isis_circuit_down(struct isis_circuit *);
void circuit_update_nlpids(struct isis_circuit *circuit);
void isis_circuit_print_vty(struct isis_circuit *circuit, struct vty *vty,
			    char detail);
size_t isis_circuit_pdu_size(struct isis_circuit *circuit);
void isis_circuit_stream(struct isis_circuit *circuit, struct stream **stream);

struct isis_circuit *isis_circuit_create(struct isis_area *area,
					 struct interface *ifp);
void isis_circuit_af_set(struct isis_circuit *circuit, bool ip_router,
			 bool ipv6_router);
int isis_circuit_passive_set(struct isis_circuit *circuit, bool passive);
void isis_circuit_is_type_set(struct isis_circuit *circuit, int is_type);
int isis_circuit_circ_type_set(struct isis_circuit *circuit, int circ_type);

int isis_circuit_metric_set(struct isis_circuit *circuit, int level,
			    int metric);

int isis_circuit_passwd_unset(struct isis_circuit *circuit);
int isis_circuit_passwd_cleartext_set(struct isis_circuit *circuit,
				      const char *passwd);
int isis_circuit_passwd_hmac_md5_set(struct isis_circuit *circuit,
				     const char *passwd);

int isis_circuit_mt_enabled_set(struct isis_circuit *circuit, uint16_t mtid,
				bool enabled);

#endif /* _ZEBRA_ISIS_CIRCUIT_H */
Commit	Line	Data
eb5d44eb	1	/*
	2	* IS-IS Rout(e)ing protocol - isis_circuit.h
	3	*
	4	* Copyright (C) 2001,2002 Sampo Saaristo
d62a17ae	5	* Tampere University of Technology
eb5d44eb	6	* Institute of Communications Engineering
eb5d44eb	7	*
d62a17ae	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public Licenseas published by the Free
	10	* Software Foundation; either version 2 of the License, or (at your option)
eb5d44eb	11	* any later version.
eb5d44eb	12	*
d62a17ae	13	* This program is distributed in the hope that it will be useful,but WITHOUT
	14	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	15	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
eb5d44eb	16	* more details.
896014f4 DL	17	*
	18	* You should have received a copy of the GNU General Public License along
	19	* with this program; see the file COPYING; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
eb5d44eb	21	*/
	22
	23	#ifndef ISIS_CIRCUIT_H
	24	#define ISIS_CIRCUIT_H
	25
91283e76	26	#include "vty.h"
65f9a9a8	27	#include "if.h"
676a4ea3	28	#include "qobj.h"
65f9a9a8 DL	29
	30	#include "isis_constants.h"
	31	#include "isis_common.h"
91283e76	32
eb5d44eb	33	#define CIRCUIT_MAX 255
eb5d44eb	34
d62a17ae	35	struct password {
	36	struct password *next;
	37	int len;
	38	u_char *pass;
eb5d44eb	39	};
eb5d44eb	40
d62a17ae	41	struct metric {
	42	u_char metric_default;
	43	u_char metric_error;
	44	u_char metric_expense;
	45	u_char metric_delay;
eb5d44eb	46	};
eb5d44eb	47
d62a17ae	48	struct isis_bcast_info {
	49	u_char snpa[ETH_ALEN]; /* SNPA of this circuit */
	50	char run_dr_elect[2]; /* Should we run dr election ? */
	51	struct thread t_run_dr[2]; / DR election thread */
	52	struct thread t_send_lan_hello[2]; / send LAN IIHs in this thread */
	53	struct list adjdb[2]; / adjacency dbs */
	54	struct list lan_neighs[2]; / list of lx neigh snpa */
	55	char is_dr[2]; /* Are we level x DR ? */
	56	u_char l1_desig_is[ISIS_SYS_ID_LEN + 1]; /* level-1 DR */
	57	u_char l2_desig_is[ISIS_SYS_ID_LEN + 1]; /* level-2 DR */
	58	struct thread t_refresh_pseudo_lsp[2]; / refresh pseudo-node LSPs */
eb5d44eb	59	};
eb5d44eb	60
d62a17ae	61	struct isis_p2p_info {
	62	struct isis_adjacency *neighbor;
	63	struct thread t_send_p2p_hello; / send P2P IIHs in this thread */
eb5d44eb	64	};
eb5d44eb	65
d62a17ae	66	struct isis_circuit {
	67	int state;
	68	u_char circuit_id; /* l1/l2 p2p/bcast CircuitID */
	69	struct isis_area area; / back pointer to the area */
	70	struct interface interface; / interface info from z */
	71	int fd; /* IS-IS l1/2 socket */
	72	int sap_length; /* SAP length for DLPI */
	73	struct nlpids nlpids;
	74	/*
	75	* Threads
	76	*/
	77	struct thread *t_read;
	78	struct thread *t_send_csnp[2];
	79	struct thread *t_send_psnp[2];
	80	struct list lsp_queue; / LSPs to be txed (both levels) */
	81	time_t lsp_queue_last_cleared; /* timestamp used to enforce transmit
	82	* interval;
	83	* for scalability, use one timestamp per
	84	* circuit, instead of one per lsp per
	85	* circuit
	86	*/
	87	/* there is no real point in two streams, just for programming kicker */
	88	int (rx)(struct isis_circuit circuit, u_char *ssnpa);
	89	struct stream rcv_stream; / Stream for receiving */
	90	int (tx)(struct isis_circuit circuit, int level);
	91	struct stream snd_stream; / Stream for sending */
	92	int idx; /* idx in S[RM\|SN] flags */
	93	/* $FRR indent$ */
	94	/* clang-format off */
3f045a08 JB	95	#define CIRCUIT_T_UNKNOWN 0
	96	#define CIRCUIT_T_BROADCAST 1
	97	#define CIRCUIT_T_P2P 2
	98	#define CIRCUIT_T_LOOPBACK 3
d62a17ae	99	int circ_type; /* type of the physical interface */
	100	int circ_type_config; /* config type of the physical interface */
	101	union {
	102	struct isis_bcast_info bc;
	103	struct isis_p2p_info p2p;
	104	} u;
	105	u_char priority[2]; /* l1/2 IS configured priority */
	106	int pad_hellos; /* add padding to Hello PDUs ? */
	107	char ext_domain; /* externalDomain (boolean) */
	108	int lsp_regenerate_pending[ISIS_LEVELS];
	109	/*
	110	* Configurables
	111	*/
	112	struct isis_passwd passwd; /* Circuit rx/tx password */
	113	int is_type; /* circuit is type == level of circuit
	114	* differentiated from circuit type (media) */
	115	u_int32_t hello_interval[2]; /* l1HelloInterval in msecs */
	116	u_int16_t hello_multiplier[2]; /* l1HelloMultiplier */
	117	u_int16_t csnp_interval[2]; /* level-1 csnp-interval in seconds */
	118	u_int16_t psnp_interval[2]; /* level-1 psnp-interval in seconds */
	119	u_int8_t metric[2];
	120	u_int32_t te_metric[2];
	121	struct mpls_te_circuit
	122	mtc; / Support for MPLS-TE parameters - see isis_te.[c,h] */
	123	int ip_router; /* Route IP ? */
	124	int is_passive; /* Is Passive ? */
	125	struct list mt_settings; / IS-IS MT Settings */
	126	struct list ip_addrs; / our IP addresses */
	127	int ipv6_router; /* Route IPv6 ? */
	128	struct list ipv6_link; / our link local IPv6 addresses */
	129	struct list ipv6_non_link; / our non-link local IPv6 addresses */
	130	u_int16_t upadjcount[2];
3f045a08	131	#define ISIS_CIRCUIT_FLAPPED_AFTER_SPF 0x01
d62a17ae	132	u_char flags;
	133	/*
	134	* Counters as in 10589--11.2.5.9
	135	*/
	136	u_int32_t adj_state_changes; /* changesInAdjacencyState */
	137	u_int32_t init_failures; /* intialisationFailures */
	138	u_int32_t ctrl_pdus_rxed; /* controlPDUsReceived */
	139	u_int32_t ctrl_pdus_txed; /* controlPDUsSent */
	140	u_int32_t
	141	desig_changes[2]; /* lanLxDesignatedIntermediateSystemChanges */
	142	u_int32_t rej_adjacencies; /* rejectedAdjacencies */
	143
	144	QOBJ_FIELDS
eb5d44eb	145	};
676a4ea3	146	DECLARE_QOBJ_TYPE(isis_circuit)
eb5d44eb	147
d62a17ae	148	void isis_circuit_init(void);
	149	struct isis_circuit *isis_circuit_new(void);
	150	void isis_circuit_del(struct isis_circuit *circuit);
	151	struct isis_circuit circuit_lookup_by_ifp(struct interface ifp,
	152	struct list *list);
	153	struct isis_circuit circuit_scan_by_ifp(struct interface ifp);
	154	void isis_circuit_configure(struct isis_circuit *circuit,
	155	struct isis_area *area);
	156	void isis_circuit_deconfigure(struct isis_circuit *circuit,
	157	struct isis_area *area);
	158	void isis_circuit_if_add(struct isis_circuit circuit, struct interface ifp);
	159	void isis_circuit_if_del(struct isis_circuit circuit, struct interface ifp);
	160	void isis_circuit_if_bind(struct isis_circuit circuit, struct interface ifp);
	161	void isis_circuit_if_unbind(struct isis_circuit *circuit,
	162	struct interface *ifp);
	163	void isis_circuit_add_addr(struct isis_circuit *circuit,
	164	struct connected *conn);
	165	void isis_circuit_del_addr(struct isis_circuit *circuit,
	166	struct connected *conn);
	167	void isis_circuit_prepare(struct isis_circuit *circuit);
	168	int isis_circuit_up(struct isis_circuit *circuit);
	169	void isis_circuit_down(struct isis_circuit *);
	170	void circuit_update_nlpids(struct isis_circuit *circuit);
	171	void isis_circuit_print_vty(struct isis_circuit circuit, struct vty vty,
	172	char detail);
b20ccb3a CF	173	size_t isis_circuit_pdu_size(struct isis_circuit *circuit);
b20ccb3a CF	174	void isis_circuit_stream(struct isis_circuit circuit, struct stream *stream);
3f045a08	175
d62a17ae	176	struct isis_circuit isis_circuit_create(struct isis_area area,
	177	struct interface *ifp);
	178	void isis_circuit_af_set(struct isis_circuit *circuit, bool ip_router,
	179	bool ipv6_router);
	180	int isis_circuit_passive_set(struct isis_circuit *circuit, bool passive);
	181	void isis_circuit_is_type_set(struct isis_circuit *circuit, int is_type);
	182	int isis_circuit_circ_type_set(struct isis_circuit *circuit, int circ_type);
	183
	184	int isis_circuit_metric_set(struct isis_circuit *circuit, int level,
	185	int metric);
	186
	187	int isis_circuit_passwd_unset(struct isis_circuit *circuit);
	188	int isis_circuit_passwd_cleartext_set(struct isis_circuit *circuit,
	189	const char *passwd);
	190	int isis_circuit_passwd_hmac_md5_set(struct isis_circuit *circuit,
	191	const char *passwd);
	192
	193	int isis_circuit_mt_enabled_set(struct isis_circuit *circuit, uint16_t mtid,
	194	bool enabled);
064f4896	195
eb5d44eb	196	#endif /* _ZEBRA_ISIS_CIRCUIT_H */