[mirror_frr.git] / pimd / pim_msdp.h

/*
 * IP MSDP for Quagga
 * Copyright (C) 2016 Cumulus Networks, Inc.
 *
 * 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_MSDP_H
#define PIM_MSDP_H

enum pim_msdp_peer_state {
	PIM_MSDP_DISABLED,
	PIM_MSDP_INACTIVE,
	PIM_MSDP_LISTEN,
	PIM_MSDP_CONNECTING,
	PIM_MSDP_ESTABLISHED
};

/* SA and KA TLVs are processed; rest ignored */
enum pim_msdp_tlv {
	PIM_MSDP_V4_SOURCE_ACTIVE = 1,
	PIM_MSDP_V4_SOURCE_ACTIVE_REQUEST,
	PIM_MSDP_V4_SOURCE_ACTIVE_RESPONSE,
	PIM_MSDP_KEEPALIVE,
	PIM_MSDP_RESERVED,
	PIM_MSDP_TRACEROUTE_PROGRESS,
	PIM_MSDP_TRACEROUTE_REPLY,
};

/* MSDP error codes */
enum pim_msdp_err {
	PIM_MSDP_ERR_NONE = 0,
	PIM_MSDP_ERR_OOM = -1,
	PIM_MSDP_ERR_PEER_EXISTS = -2,
	PIM_MSDP_ERR_MAX_MESH_GROUPS = -3,
	PIM_MSDP_ERR_NO_PEER = -4,
	PIM_MSDP_ERR_MG_MBR_EXISTS = -5,
	PIM_MSDP_ERR_NO_MG = -6,
	PIM_MSDP_ERR_NO_MG_MBR = -7,
	PIM_MSDP_ERR_SIP_EQ_DIP = -8,
};

#define PIM_MSDP_STATE_STRLEN 16
#define PIM_MSDP_UPTIME_STRLEN 80
#define PIM_MSDP_TIMER_STRLEN 12
#define PIM_MSDP_TCP_PORT 639
#define PIM_MSDP_SOCKET_SNDBUF_SIZE 65536

enum pim_msdp_sa_flags {
	PIM_MSDP_SAF_NONE = 0,
	/* There are two cases where we can pickup an active source locally -
	 * 1. We are RP and got a source-register from the FHR
	 * 2. We are RP and FHR and learnt a new directly connected source on a
	 * DR interface */
	PIM_MSDP_SAF_LOCAL = (1 << 0),
	/* We got this in the MSDP SA TLV from a peer (and this passed peer-RPF
	 * checks) */
	PIM_MSDP_SAF_PEER = (1 << 1),
	PIM_MSDP_SAF_REF = (PIM_MSDP_SAF_LOCAL | PIM_MSDP_SAF_PEER),
	PIM_MSDP_SAF_STALE = (1 << 2), /* local entries can get kicked out on
					* misc pim events such as RP change */
	PIM_MSDP_SAF_UP_DEL_IN_PROG = (1 << 3)
};

struct pim_msdp_sa {
	struct prefix_sg sg;
	char sg_str[PIM_SG_LEN];
	struct in_addr rp;   /* Last RP address associated with this SA */
	struct in_addr peer; /* last peer from who we heard this SA */
	enum pim_msdp_sa_flags flags;

/* rfc-3618 is missing default value for SA-hold-down-Period. pulled
 * this number from industry-standards */
#define PIM_MSDP_SA_HOLD_TIME ((3*60)+30)
	struct thread *sa_state_timer; // 5.6
	int64_t uptime;

	struct pim_upstream *up;
};

enum pim_msdp_peer_flags {
	PIM_MSDP_PEERF_NONE = 0,
	PIM_MSDP_PEERF_LISTENER = (1 << 0),
#define PIM_MSDP_PEER_IS_LISTENER(mp) (mp->flags & PIM_MSDP_PEERF_LISTENER)
	PIM_MSDP_PEERF_SA_JUST_SENT = (1 << 1)
};

struct pim_msdp_peer {
	/* configuration */
	struct in_addr local;
	struct in_addr peer;
	char *mesh_group_name;
	char key_str[INET_ADDRSTRLEN];

	/* state */
	enum pim_msdp_peer_state state;
	enum pim_msdp_peer_flags flags;

	/* TCP socket info */
	union sockunion su_local;
	union sockunion su_peer;
	int fd;

/* protocol timers */
#define PIM_MSDP_PEER_HOLD_TIME 75
	struct thread *hold_timer; // 5.4
				   /* $FRR indent$ */
				   /* clang-format off */
#define PIM_MSDP_PEER_KA_TIME 60
	struct thread *ka_timer;   // 5.5
				   /* $FRR indent$ */
				   /* clang-format off */
#define PIM_MSDP_PEER_CONNECT_RETRY_TIME 30
	struct thread *cr_timer;   // 5.6

	/* packet thread and buffers */
	uint32_t packet_size;
	struct stream *ibuf;
	struct stream_fifo *obuf;
	struct thread *t_read;
	struct thread *t_write;

	/* stats */
	uint32_t conn_attempts;
	uint32_t est_flaps;
	uint32_t sa_cnt; /* number of SAs attributed to this peer */
			 /* $FRR indent$ */
			 /* clang-format off */
#define PIM_MSDP_PEER_LAST_RESET_STR 20
	char last_reset[PIM_MSDP_PEER_LAST_RESET_STR];

	/* packet stats */
	uint32_t ka_tx_cnt;
	uint32_t sa_tx_cnt;
	uint32_t ka_rx_cnt;
	uint32_t sa_rx_cnt;
	uint32_t unk_rx_cnt;

	/* timestamps */
	int64_t uptime;
};

struct pim_msdp_mg_mbr {
	struct in_addr mbr_ip;
	struct pim_msdp_peer *mp;
};

/* PIM MSDP mesh-group */
struct pim_msdp_mg {
	char *mesh_group_name;
	struct in_addr src_ip;
	uint32_t mbr_cnt;
	struct list *mbr_list;
};

enum pim_msdp_flags {
	PIM_MSDPF_NONE = 0,
	PIM_MSDPF_ENABLE = (1 << 0),
	PIM_MSDPF_LISTENER = (1 << 1)
};

struct pim_msdp_listener {
	int fd;
	union sockunion su;
	struct thread *thread;
};

struct pim_msdp {
	enum pim_msdp_flags flags;
	struct thread_master *master;
	struct pim_msdp_listener listener;
	uint32_t rejected_accepts;

	/* MSDP peer info */
	struct hash *peer_hash;
	struct list *peer_list;

/* MSDP active-source info */
#define PIM_MSDP_SA_ADVERTISMENT_TIME 60
	struct thread *sa_adv_timer; // 5.6
	struct hash *sa_hash;
	struct list *sa_list;
	uint32_t local_cnt;

	/* keep a scratch pad for building SA TLVs */
	struct stream *work_obuf;

	struct in_addr originator_id;

	/* currently only one mesh-group is supported - so just stash it here */
	struct pim_msdp_mg *mg;
};

#define PIM_MSDP_PEER_READ_ON(mp)                                              \
	thread_add_read(msdp->master, pim_msdp_read, mp, mp->fd, &mp->t_read)

#define PIM_MSDP_PEER_WRITE_ON(mp)                                             \
	thread_add_write(msdp->master, pim_msdp_write, mp, mp->fd, &mp->t_write)

#define PIM_MSDP_PEER_READ_OFF(mp) THREAD_READ_OFF(mp->t_read)
#define PIM_MSDP_PEER_WRITE_OFF(mp) THREAD_WRITE_OFF(mp->t_write)

extern struct pim_msdp *msdp;
void pim_msdp_init(struct thread_master *master);
void pim_msdp_exit(void);
enum pim_msdp_err pim_msdp_peer_add(struct in_addr peer, struct in_addr local,
				    const char *mesh_group_name,
				    struct pim_msdp_peer **mp_p);
enum pim_msdp_err pim_msdp_peer_del(struct in_addr peer_addr);
char *pim_msdp_state_dump(enum pim_msdp_peer_state state, char *buf,
			  int buf_size);
struct pim_msdp_peer *pim_msdp_peer_find(struct in_addr peer_addr);
void pim_msdp_peer_established(struct pim_msdp_peer *mp);
void pim_msdp_peer_pkt_rxed(struct pim_msdp_peer *mp);
void pim_msdp_peer_stop_tcp_conn(struct pim_msdp_peer *mp, bool chg_state);
void pim_msdp_peer_reset_tcp_conn(struct pim_msdp_peer *mp, const char *rc_str);
int pim_msdp_write(struct thread *thread);
char *pim_msdp_peer_key_dump(struct pim_msdp_peer *mp, char *buf, int buf_size,
			     bool long_format);
int pim_msdp_config_write(struct vty *vty);
void pim_msdp_peer_pkt_txed(struct pim_msdp_peer *mp);
void pim_msdp_sa_ref(struct pim_msdp_peer *mp, struct prefix_sg *sg,
		     struct in_addr rp);
void pim_msdp_sa_local_update(struct pim_upstream *up);
void pim_msdp_sa_local_del(struct prefix_sg *sg);
void pim_msdp_i_am_rp_changed(void);
bool pim_msdp_peer_rpf_check(struct pim_msdp_peer *mp, struct in_addr rp);
void pim_msdp_up_join_state_changed(struct pim_upstream *xg_up);
void pim_msdp_up_del(struct prefix_sg *sg);
enum pim_msdp_err pim_msdp_mg_mbr_add(const char *mesh_group_name,
				      struct in_addr mbr_ip);
enum pim_msdp_err pim_msdp_mg_mbr_del(const char *mesh_group_name,
				      struct in_addr mbr_ip);
enum pim_msdp_err pim_msdp_mg_src_del(const char *mesh_group_name);
enum pim_msdp_err pim_msdp_mg_src_add(const char *mesh_group_name,
				      struct in_addr src_ip);
enum pim_msdp_err pim_msdp_mg_del(const char *mesh_group_name);
#endif
Commit	Line	Data
11128587	1	/*
2a333e0f	2	* IP MSDP for Quagga
11128587	3	* Copyright (C) 2016 Cumulus Networks, Inc.
11128587 DS	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	*
896014f4 DL	15	* You should have received a copy of the GNU General Public License along
	16	* with this program; see the file COPYING; if not, write to the Free Software
	17	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
11128587 DS	18	*/
	19	#ifndef PIM_MSDP_H
	20	#define PIM_MSDP_H
	21
2a333e0f	22	enum pim_msdp_peer_state {
d62a17ae	23	PIM_MSDP_DISABLED,
	24	PIM_MSDP_INACTIVE,
	25	PIM_MSDP_LISTEN,
	26	PIM_MSDP_CONNECTING,
	27	PIM_MSDP_ESTABLISHED
2a333e0f	28	};
11128587	29
2a333e0f	30	/* SA and KA TLVs are processed; rest ignored */
2a333e0f	31	enum pim_msdp_tlv {
d62a17ae	32	PIM_MSDP_V4_SOURCE_ACTIVE = 1,
	33	PIM_MSDP_V4_SOURCE_ACTIVE_REQUEST,
	34	PIM_MSDP_V4_SOURCE_ACTIVE_RESPONSE,
	35	PIM_MSDP_KEEPALIVE,
	36	PIM_MSDP_RESERVED,
	37	PIM_MSDP_TRACEROUTE_PROGRESS,
	38	PIM_MSDP_TRACEROUTE_REPLY,
2a333e0f	39	};
	40
	41	/* MSDP error codes */
	42	enum pim_msdp_err {
d62a17ae	43	PIM_MSDP_ERR_NONE = 0,
	44	PIM_MSDP_ERR_OOM = -1,
	45	PIM_MSDP_ERR_PEER_EXISTS = -2,
	46	PIM_MSDP_ERR_MAX_MESH_GROUPS = -3,
	47	PIM_MSDP_ERR_NO_PEER = -4,
	48	PIM_MSDP_ERR_MG_MBR_EXISTS = -5,
	49	PIM_MSDP_ERR_NO_MG = -6,
	50	PIM_MSDP_ERR_NO_MG_MBR = -7,
	51	PIM_MSDP_ERR_SIP_EQ_DIP = -8,
2a333e0f	52	};
	53
	54	#define PIM_MSDP_STATE_STRLEN 16
2a333e0f	55	#define PIM_MSDP_UPTIME_STRLEN 80
977d71cc	56	#define PIM_MSDP_TIMER_STRLEN 12
2a333e0f	57	#define PIM_MSDP_TCP_PORT 639
	58	#define PIM_MSDP_SOCKET_SNDBUF_SIZE 65536
	59
3c72d654	60	enum pim_msdp_sa_flags {
d62a17ae	61	PIM_MSDP_SAF_NONE = 0,
	62	/* There are two cases where we can pickup an active source locally -
	63	* 1. We are RP and got a source-register from the FHR
	64	* 2. We are RP and FHR and learnt a new directly connected source on a
	65	* DR interface */
	66	PIM_MSDP_SAF_LOCAL = (1 << 0),
	67	/* We got this in the MSDP SA TLV from a peer (and this passed peer-RPF
	68	* checks) */
	69	PIM_MSDP_SAF_PEER = (1 << 1),
	70	PIM_MSDP_SAF_REF = (PIM_MSDP_SAF_LOCAL \| PIM_MSDP_SAF_PEER),
	71	PIM_MSDP_SAF_STALE = (1 << 2), /* local entries can get kicked out on
c14777c6	72	* misc pim events such as RP change */
d62a17ae	73	PIM_MSDP_SAF_UP_DEL_IN_PROG = (1 << 3)
3c72d654	74	};
	75
	76	struct pim_msdp_sa {
d62a17ae	77	struct prefix_sg sg;
	78	char sg_str[PIM_SG_LEN];
	79	struct in_addr rp; /* Last RP address associated with this SA */
	80	struct in_addr peer; /* last peer from who we heard this SA */
	81	enum pim_msdp_sa_flags flags;
	82
	83	/* rfc-3618 is missing default value for SA-hold-down-Period. pulled
	84	* this number from industry-standards */
3c72d654	85	#define PIM_MSDP_SA_HOLD_TIME ((3*60)+30)
d62a17ae	86	struct thread *sa_state_timer; // 5.6
d62a17ae	87	int64_t uptime;
7667c556	88
d62a17ae	89	struct pim_upstream *up;
3c72d654	90	};
3c72d654	91
2a333e0f	92	enum pim_msdp_peer_flags {
d62a17ae	93	PIM_MSDP_PEERF_NONE = 0,
d62a17ae	94	PIM_MSDP_PEERF_LISTENER = (1 << 0),
3c72d654	95	#define PIM_MSDP_PEER_IS_LISTENER(mp) (mp->flags & PIM_MSDP_PEERF_LISTENER)
d62a17ae	96	PIM_MSDP_PEERF_SA_JUST_SENT = (1 << 1)
2a333e0f	97	};
	98
	99	struct pim_msdp_peer {
d62a17ae	100	/* configuration */
	101	struct in_addr local;
	102	struct in_addr peer;
	103	char *mesh_group_name;
	104	char key_str[INET_ADDRSTRLEN];
	105
	106	/* state */
	107	enum pim_msdp_peer_state state;
	108	enum pim_msdp_peer_flags flags;
	109
	110	/* TCP socket info */
	111	union sockunion su_local;
	112	union sockunion su_peer;
	113	int fd;
	114
	115	/* protocol timers */
2a333e0f	116	#define PIM_MSDP_PEER_HOLD_TIME 75
d62a17ae	117	struct thread *hold_timer; // 5.4
d62a17ae	118	/* $FRR indent$ */
c14777c6	119	/* clang-format off */
2a333e0f	120	#define PIM_MSDP_PEER_KA_TIME 60
c14777c6	121	struct thread *ka_timer; // 5.5
	122	/* $FRR indent$ */
	123	/* clang-format off */
2a333e0f	124	#define PIM_MSDP_PEER_CONNECT_RETRY_TIME 30
c14777c6	125	struct thread *cr_timer; // 5.6
d62a17ae	126
	127	/* packet thread and buffers */
	128	uint32_t packet_size;
	129	struct stream *ibuf;
	130	struct stream_fifo *obuf;
	131	struct thread *t_read;
	132	struct thread *t_write;
	133
	134	/* stats */
	135	uint32_t conn_attempts;
	136	uint32_t est_flaps;
	137	uint32_t sa_cnt; /* number of SAs attributed to this peer */
	138	/* $FRR indent$ */
	139	/* clang-format off */
977d71cc	140	#define PIM_MSDP_PEER_LAST_RESET_STR 20
d62a17ae	141	char last_reset[PIM_MSDP_PEER_LAST_RESET_STR];
977d71cc	142
d62a17ae	143	/* packet stats */
	144	uint32_t ka_tx_cnt;
	145	uint32_t sa_tx_cnt;
	146	uint32_t ka_rx_cnt;
	147	uint32_t sa_rx_cnt;
	148	uint32_t unk_rx_cnt;
2a333e0f	149
d62a17ae	150	/* timestamps */
d62a17ae	151	int64_t uptime;
2a333e0f	152	};
2a333e0f	153
977d71cc	154	struct pim_msdp_mg_mbr {
d62a17ae	155	struct in_addr mbr_ip;
d62a17ae	156	struct pim_msdp_peer *mp;
977d71cc	157	};
	158
	159	/* PIM MSDP mesh-group */
	160	struct pim_msdp_mg {
d62a17ae	161	char *mesh_group_name;
	162	struct in_addr src_ip;
	163	uint32_t mbr_cnt;
	164	struct list *mbr_list;
977d71cc	165	};
977d71cc	166
2a333e0f	167	enum pim_msdp_flags {
d62a17ae	168	PIM_MSDPF_NONE = 0,
	169	PIM_MSDPF_ENABLE = (1 << 0),
	170	PIM_MSDPF_LISTENER = (1 << 1)
2a333e0f	171	};
	172
	173	struct pim_msdp_listener {
d62a17ae	174	int fd;
	175	union sockunion su;
	176	struct thread *thread;
2a333e0f	177	};
11128587	178
2a333e0f	179	struct pim_msdp {
d62a17ae	180	enum pim_msdp_flags flags;
	181	struct thread_master *master;
	182	struct pim_msdp_listener listener;
	183	uint32_t rejected_accepts;
3c72d654	184
d62a17ae	185	/* MSDP peer info */
	186	struct hash *peer_hash;
	187	struct list *peer_list;
3c72d654	188
d62a17ae	189	/* MSDP active-source info */
3c72d654	190	#define PIM_MSDP_SA_ADVERTISMENT_TIME 60
d62a17ae	191	struct thread *sa_adv_timer; // 5.6
	192	struct hash *sa_hash;
	193	struct list *sa_list;
	194	uint32_t local_cnt;
3c72d654	195
d62a17ae	196	/* keep a scratch pad for building SA TLVs */
d62a17ae	197	struct stream *work_obuf;
3c72d654	198
d62a17ae	199	struct in_addr originator_id;
977d71cc	200
d62a17ae	201	/* currently only one mesh-group is supported - so just stash it here */
d62a17ae	202	struct pim_msdp_mg *mg;
11128587 DS	203	};
11128587 DS	204
d62a17ae	205	#define PIM_MSDP_PEER_READ_ON(mp) \
d62a17ae	206	thread_add_read(msdp->master, pim_msdp_read, mp, mp->fd, &mp->t_read)
ffa2c898	207
d62a17ae	208	#define PIM_MSDP_PEER_WRITE_ON(mp) \
d62a17ae	209	thread_add_write(msdp->master, pim_msdp_write, mp, mp->fd, &mp->t_write)
2a333e0f	210
	211	#define PIM_MSDP_PEER_READ_OFF(mp) THREAD_READ_OFF(mp->t_read)
	212	#define PIM_MSDP_PEER_WRITE_OFF(mp) THREAD_WRITE_OFF(mp->t_write)
	213
	214	extern struct pim_msdp *msdp;
	215	void pim_msdp_init(struct thread_master *master);
	216	void pim_msdp_exit(void);
d62a17ae	217	enum pim_msdp_err pim_msdp_peer_add(struct in_addr peer, struct in_addr local,
	218	const char *mesh_group_name,
	219	struct pim_msdp_peer **mp_p);
2a333e0f	220	enum pim_msdp_err pim_msdp_peer_del(struct in_addr peer_addr);
d62a17ae	221	char pim_msdp_state_dump(enum pim_msdp_peer_state state, char buf,
d62a17ae	222	int buf_size);
2a333e0f	223	struct pim_msdp_peer *pim_msdp_peer_find(struct in_addr peer_addr);
	224	void pim_msdp_peer_established(struct pim_msdp_peer *mp);
	225	void pim_msdp_peer_pkt_rxed(struct pim_msdp_peer *mp);
	226	void pim_msdp_peer_stop_tcp_conn(struct pim_msdp_peer *mp, bool chg_state);
	227	void pim_msdp_peer_reset_tcp_conn(struct pim_msdp_peer mp, const char rc_str);
	228	int pim_msdp_write(struct thread *thread);
d62a17ae	229	char pim_msdp_peer_key_dump(struct pim_msdp_peer mp, char *buf, int buf_size,
d62a17ae	230	bool long_format);
3c72d654	231	int pim_msdp_config_write(struct vty *vty);
3c72d654	232	void pim_msdp_peer_pkt_txed(struct pim_msdp_peer *mp);
d62a17ae	233	void pim_msdp_sa_ref(struct pim_msdp_peer mp, struct prefix_sg sg,
d62a17ae	234	struct in_addr rp);
1bf16443	235	void pim_msdp_sa_local_update(struct pim_upstream *up);
3c72d654	236	void pim_msdp_sa_local_del(struct prefix_sg *sg);
	237	void pim_msdp_i_am_rp_changed(void);
	238	bool pim_msdp_peer_rpf_check(struct pim_msdp_peer *mp, struct in_addr rp);
7667c556	239	void pim_msdp_up_join_state_changed(struct pim_upstream *xg_up);
36e466fe	240	void pim_msdp_up_del(struct prefix_sg *sg);
d62a17ae	241	enum pim_msdp_err pim_msdp_mg_mbr_add(const char *mesh_group_name,
	242	struct in_addr mbr_ip);
	243	enum pim_msdp_err pim_msdp_mg_mbr_del(const char *mesh_group_name,
	244	struct in_addr mbr_ip);
977d71cc	245	enum pim_msdp_err pim_msdp_mg_src_del(const char *mesh_group_name);
d62a17ae	246	enum pim_msdp_err pim_msdp_mg_src_add(const char *mesh_group_name,
d62a17ae	247	struct in_addr src_ip);
977d71cc	248	enum pim_msdp_err pim_msdp_mg_del(const char *mesh_group_name);
11128587	249	#endif