]> git.proxmox.com Git - mirror_frr.git/blame - pimd/pim_msdp.h
Merge pull request #8691 from louis-oui/split-soft-reconfig
[mirror_frr.git] / pimd / pim_msdp.h
CommitLineData
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
e2809e61
RZ
22#include "lib/openbsd-queue.h"
23
2a333e0f 24enum pim_msdp_peer_state {
d62a17ae 25 PIM_MSDP_DISABLED,
26 PIM_MSDP_INACTIVE,
27 PIM_MSDP_LISTEN,
28 PIM_MSDP_CONNECTING,
29 PIM_MSDP_ESTABLISHED
2a333e0f 30};
11128587 31
2a333e0f 32/* SA and KA TLVs are processed; rest ignored */
33enum pim_msdp_tlv {
d62a17ae 34 PIM_MSDP_V4_SOURCE_ACTIVE = 1,
35 PIM_MSDP_V4_SOURCE_ACTIVE_REQUEST,
36 PIM_MSDP_V4_SOURCE_ACTIVE_RESPONSE,
37 PIM_MSDP_KEEPALIVE,
38 PIM_MSDP_RESERVED,
39 PIM_MSDP_TRACEROUTE_PROGRESS,
40 PIM_MSDP_TRACEROUTE_REPLY,
2a333e0f 41};
42
43/* MSDP error codes */
44enum pim_msdp_err {
d62a17ae 45 PIM_MSDP_ERR_NONE = 0,
46 PIM_MSDP_ERR_OOM = -1,
47 PIM_MSDP_ERR_PEER_EXISTS = -2,
48 PIM_MSDP_ERR_MAX_MESH_GROUPS = -3,
49 PIM_MSDP_ERR_NO_PEER = -4,
50 PIM_MSDP_ERR_MG_MBR_EXISTS = -5,
51 PIM_MSDP_ERR_NO_MG = -6,
52 PIM_MSDP_ERR_NO_MG_MBR = -7,
53 PIM_MSDP_ERR_SIP_EQ_DIP = -8,
2a333e0f 54};
55
56#define PIM_MSDP_STATE_STRLEN 16
2a333e0f 57#define PIM_MSDP_UPTIME_STRLEN 80
977d71cc 58#define PIM_MSDP_TIMER_STRLEN 12
2a333e0f 59#define PIM_MSDP_TCP_PORT 639
60#define PIM_MSDP_SOCKET_SNDBUF_SIZE 65536
61
3c72d654 62enum pim_msdp_sa_flags {
d62a17ae 63 PIM_MSDP_SAF_NONE = 0,
64 /* There are two cases where we can pickup an active source locally -
65 * 1. We are RP and got a source-register from the FHR
66 * 2. We are RP and FHR and learnt a new directly connected source on a
67 * DR interface */
68 PIM_MSDP_SAF_LOCAL = (1 << 0),
69 /* We got this in the MSDP SA TLV from a peer (and this passed peer-RPF
70 * checks) */
71 PIM_MSDP_SAF_PEER = (1 << 1),
72 PIM_MSDP_SAF_REF = (PIM_MSDP_SAF_LOCAL | PIM_MSDP_SAF_PEER),
73 PIM_MSDP_SAF_STALE = (1 << 2), /* local entries can get kicked out on
2ad78035 74 * misc pim events such as RP change */
d62a17ae 75 PIM_MSDP_SAF_UP_DEL_IN_PROG = (1 << 3)
3c72d654 76};
77
78struct pim_msdp_sa {
472ad383
DS
79 struct pim_instance *pim;
80
d62a17ae 81 struct prefix_sg sg;
82 char sg_str[PIM_SG_LEN];
83 struct in_addr rp; /* Last RP address associated with this SA */
84 struct in_addr peer; /* last peer from who we heard this SA */
85 enum pim_msdp_sa_flags flags;
86
87/* rfc-3618 is missing default value for SA-hold-down-Period. pulled
88 * this number from industry-standards */
3c72d654 89#define PIM_MSDP_SA_HOLD_TIME ((3*60)+30)
d62a17ae 90 struct thread *sa_state_timer; // 5.6
91 int64_t uptime;
7667c556 92
d62a17ae 93 struct pim_upstream *up;
3c72d654 94};
95
2a333e0f 96enum pim_msdp_peer_flags {
d62a17ae 97 PIM_MSDP_PEERF_NONE = 0,
98 PIM_MSDP_PEERF_LISTENER = (1 << 0),
3c72d654 99#define PIM_MSDP_PEER_IS_LISTENER(mp) (mp->flags & PIM_MSDP_PEERF_LISTENER)
d62a17ae 100 PIM_MSDP_PEERF_SA_JUST_SENT = (1 << 1)
2a333e0f 101};
102
103struct pim_msdp_peer {
472ad383
DS
104 struct pim_instance *pim;
105
d62a17ae 106 /* configuration */
107 struct in_addr local;
108 struct in_addr peer;
109 char *mesh_group_name;
110 char key_str[INET_ADDRSTRLEN];
111
112 /* state */
113 enum pim_msdp_peer_state state;
114 enum pim_msdp_peer_flags flags;
115
116 /* TCP socket info */
117 union sockunion su_local;
118 union sockunion su_peer;
119 int fd;
120
121/* protocol timers */
2a333e0f 122#define PIM_MSDP_PEER_HOLD_TIME 75
d62a17ae 123 struct thread *hold_timer; // 5.4
2a333e0f 124#define PIM_MSDP_PEER_KA_TIME 60
9d303b37 125 struct thread *ka_timer; // 5.5
2a333e0f 126#define PIM_MSDP_PEER_CONNECT_RETRY_TIME 30
9d303b37 127 struct thread *cr_timer; // 5.6
d62a17ae 128
129 /* packet thread and buffers */
130 uint32_t packet_size;
131 struct stream *ibuf;
132 struct stream_fifo *obuf;
133 struct thread *t_read;
134 struct thread *t_write;
135
136 /* stats */
137 uint32_t conn_attempts;
138 uint32_t est_flaps;
139 uint32_t sa_cnt; /* number of SAs attributed to this peer */
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 */
151 int64_t uptime;
2a333e0f 152};
153
977d71cc 154struct pim_msdp_mg_mbr {
d62a17ae 155 struct in_addr mbr_ip;
156 struct pim_msdp_peer *mp;
977d71cc 157};
158
159/* PIM MSDP mesh-group */
160struct 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;
e2809e61
RZ
165
166 /** Belongs to PIM instance list. */
167 SLIST_ENTRY(pim_msdp_mg) mg_entry;
977d71cc 168};
169
e2809e61
RZ
170SLIST_HEAD(pim_mesh_group_list, pim_msdp_mg);
171
2a333e0f 172enum pim_msdp_flags {
d62a17ae 173 PIM_MSDPF_NONE = 0,
174 PIM_MSDPF_ENABLE = (1 << 0),
175 PIM_MSDPF_LISTENER = (1 << 1)
2a333e0f 176};
177
178struct pim_msdp_listener {
d62a17ae 179 int fd;
180 union sockunion su;
181 struct thread *thread;
2a333e0f 182};
11128587 183
2a333e0f 184struct pim_msdp {
d62a17ae 185 enum pim_msdp_flags flags;
186 struct thread_master *master;
187 struct pim_msdp_listener listener;
188 uint32_t rejected_accepts;
3c72d654 189
d62a17ae 190 /* MSDP peer info */
191 struct hash *peer_hash;
192 struct list *peer_list;
3c72d654 193
d62a17ae 194/* MSDP active-source info */
3c72d654 195#define PIM_MSDP_SA_ADVERTISMENT_TIME 60
d62a17ae 196 struct thread *sa_adv_timer; // 5.6
197 struct hash *sa_hash;
198 struct list *sa_list;
199 uint32_t local_cnt;
3c72d654 200
d62a17ae 201 /* keep a scratch pad for building SA TLVs */
202 struct stream *work_obuf;
3c72d654 203
d62a17ae 204 struct in_addr originator_id;
977d71cc 205
e2809e61
RZ
206 /** List of mesh groups. */
207 struct pim_mesh_group_list mglist;
11128587
DS
208};
209
d62a17ae 210#define PIM_MSDP_PEER_READ_ON(mp) \
472ad383 211 thread_add_read(mp->pim->msdp.master, pim_msdp_read, mp, mp->fd, \
2ad78035 212 &mp->t_read)
ffa2c898 213
d62a17ae 214#define PIM_MSDP_PEER_WRITE_ON(mp) \
472ad383 215 thread_add_write(mp->pim->msdp.master, pim_msdp_write, mp, mp->fd, \
2ad78035 216 &mp->t_write)
2a333e0f 217
50478845
MS
218#define PIM_MSDP_PEER_READ_OFF(mp) thread_cancel(&mp->t_read)
219#define PIM_MSDP_PEER_WRITE_OFF(mp) thread_cancel(&mp->t_write)
2a333e0f 220
2ad78035
DS
221// struct pim_msdp *msdp;
222struct pim_instance;
64c86530 223void pim_msdp_init(struct pim_instance *pim, struct thread_master *master);
2ad78035 224void pim_msdp_exit(struct pim_instance *pim);
472ad383
DS
225enum pim_msdp_err pim_msdp_peer_add(struct pim_instance *pim,
226 struct in_addr peer, struct in_addr local,
d62a17ae 227 const char *mesh_group_name,
228 struct pim_msdp_peer **mp_p);
472ad383
DS
229enum pim_msdp_err pim_msdp_peer_del(struct pim_instance *pim,
230 struct in_addr peer_addr);
d62a17ae 231char *pim_msdp_state_dump(enum pim_msdp_peer_state state, char *buf,
232 int buf_size);
472ad383
DS
233struct pim_msdp_peer *pim_msdp_peer_find(struct pim_instance *pim,
234 struct in_addr peer_addr);
2a333e0f 235void pim_msdp_peer_established(struct pim_msdp_peer *mp);
236void pim_msdp_peer_pkt_rxed(struct pim_msdp_peer *mp);
237void pim_msdp_peer_stop_tcp_conn(struct pim_msdp_peer *mp, bool chg_state);
238void pim_msdp_peer_reset_tcp_conn(struct pim_msdp_peer *mp, const char *rc_str);
239int pim_msdp_write(struct thread *thread);
d62a17ae 240char *pim_msdp_peer_key_dump(struct pim_msdp_peer *mp, char *buf, int buf_size,
241 bool long_format);
84f25989
DS
242int pim_msdp_config_write(struct pim_instance *pim, struct vty *vty,
243 const char *spaces);
8c70c9e2
RZ
244bool pim_msdp_peer_config_write(struct vty *vty, struct pim_instance *pim,
245 const char *spaces);
3c72d654 246void pim_msdp_peer_pkt_txed(struct pim_msdp_peer *mp);
472ad383
DS
247void pim_msdp_sa_ref(struct pim_instance *pim, struct pim_msdp_peer *mp,
248 struct prefix_sg *sg, struct in_addr rp);
1bf16443 249void pim_msdp_sa_local_update(struct pim_upstream *up);
472ad383
DS
250void pim_msdp_sa_local_del(struct pim_instance *pim, struct prefix_sg *sg);
251void pim_msdp_i_am_rp_changed(struct pim_instance *pim);
3c72d654 252bool pim_msdp_peer_rpf_check(struct pim_msdp_peer *mp, struct in_addr rp);
1eca8576
DS
253void pim_msdp_up_join_state_changed(struct pim_instance *pim,
254 struct pim_upstream *xg_up);
472ad383 255void pim_msdp_up_del(struct pim_instance *pim, struct prefix_sg *sg);
472ad383
DS
256enum pim_msdp_err pim_msdp_mg_del(struct pim_instance *pim,
257 const char *mesh_group_name);
e2809e61
RZ
258
259/**
260 * Allocates a new mesh group data structure under PIM instance.
261 */
262struct pim_msdp_mg *pim_msdp_mg_new(struct pim_instance *pim,
263 const char *mesh_group_name);
264/**
265 * Deallocates mesh group data structure under PIM instance.
266 */
267void pim_msdp_mg_free(struct pim_instance *pim, struct pim_msdp_mg **mgp);
268
269/**
270 * Change the source address of a mesh group peers. It will do the following:
271 * - Close all peers TCP connections
272 * - Recreate peers data structure
273 * - Start TCP connections with new local address.
274 */
fb35f654
RZ
275void pim_msdp_mg_src_add(struct pim_instance *pim, struct pim_msdp_mg *mg,
276 struct in_addr *ai);
e2809e61
RZ
277
278/**
279 * Add new peer to mesh group and starts the connection if source address is
280 * configured.
281 */
fb35f654
RZ
282struct pim_msdp_mg_mbr *pim_msdp_mg_mbr_add(struct pim_instance *pim,
283 struct pim_msdp_mg *mg,
284 struct in_addr *ia);
e2809e61
RZ
285
286/**
287 * Stops the connection and removes the peer data structures.
288 */
fb35f654 289void pim_msdp_mg_mbr_del(struct pim_msdp_mg *mg, struct pim_msdp_mg_mbr *mbr);
e2809e61 290
11128587 291#endif