]> git.proxmox.com Git - mirror_frr.git/blame - pimd/pim_register.c
Merge pull request #5793 from ton31337/fix/formatting_show_bgp_summary_failed
[mirror_frr.git] / pimd / pim_register.c
CommitLineData
01d68c9b
DS
1/*
2 * PIM for Quagga
3 * Copyright (C) 2015 Cumulus Networks, Inc.
4 * Donald Sharp
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
896014f4
DL
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
01d68c9b
DS
19 */
20
21#include <zebra.h>
22
23#include "log.h"
24#include "if.h"
25#include "thread.h"
13c2408c 26#include "prefix.h"
dfe43e25
DW
27#include "vty.h"
28#include "plist.h"
01d68c9b
DS
29
30#include "pimd.h"
998af219
DS
31#include "pim_mroute.h"
32#include "pim_iface.h"
33#include "pim_msg.h"
34#include "pim_pim.h"
01d68c9b
DS
35#include "pim_str.h"
36#include "pim_rp.h"
37#include "pim_register.h"
80c0d168 38#include "pim_upstream.h"
01d68c9b 39#include "pim_br.h"
2ca35b3d
DS
40#include "pim_rpf.h"
41#include "pim_oil.h"
42#include "pim_zebra.h"
43#include "pim_join.h"
13c2408c 44#include "pim_util.h"
15a5dafe 45#include "pim_ssm.h"
b9f3a51c 46#include "pim_vxlan.h"
01d68c9b
DS
47
48struct thread *send_test_packet_timer = NULL;
49
d62a17ae 50void pim_register_join(struct pim_upstream *up)
15a5dafe 51{
ac7eaeb4
DS
52 struct pim_instance *pim = up->channel_oil->pim;
53
6f439a70 54 if (pim_is_grp_ssm(pim, up->sg.grp)) {
d62a17ae 55 if (PIM_DEBUG_PIM_EVENTS)
56 zlog_debug("%s register setup skipped as group is SSM",
57 up->sg_str);
58 return;
59 }
60
ac7eaeb4 61 pim_channel_add_oif(up->channel_oil, pim->regiface,
1b249e70 62 PIM_OIF_FLAG_PROTO_PIM, __func__);
d62a17ae 63 up->reg_state = PIM_REG_JOIN;
2951a7a4 64 pim_vxlan_update_sg_reg_state(pim, up, true /*reg_join*/);
15a5dafe 65}
66
d62a17ae 67void pim_register_stop_send(struct interface *ifp, struct prefix_sg *sg,
68 struct in_addr src, struct in_addr originator)
01d68c9b 69{
d62a17ae 70 struct pim_interface *pinfo;
71 unsigned char buffer[10000];
72 unsigned int b1length = 0;
73 unsigned int length;
74 uint8_t *b1;
75 struct prefix p;
76
77 if (PIM_DEBUG_PIM_REG) {
78 zlog_debug("Sending Register stop for %s to %s on %s",
79 pim_str_sg_dump(sg), inet_ntoa(originator),
80 ifp->name);
81 }
82
83 memset(buffer, 0, 10000);
84 b1 = (uint8_t *)buffer + PIM_MSG_REGISTER_STOP_LEN;
85
86 length = pim_encode_addr_group(b1, AFI_IP, 0, 0, sg->grp);
87 b1length += length;
88 b1 += length;
89
90 p.family = AF_INET;
91 p.u.prefix4 = sg->src;
92 p.prefixlen = 32;
93 length = pim_encode_addr_ucast(b1, &p);
94 b1length += length;
95
96 pim_msg_build_header(buffer, b1length + PIM_MSG_REGISTER_STOP_LEN,
d57a8bbf 97 PIM_MSG_TYPE_REG_STOP, false);
d62a17ae 98
99 pinfo = (struct pim_interface *)ifp->info;
100 if (!pinfo) {
101 if (PIM_DEBUG_PIM_TRACE)
9165c5f5 102 zlog_debug("%s: No pinfo!", __PRETTY_FUNCTION__);
d62a17ae 103 return;
13c2408c 104 }
d62a17ae 105 if (pim_msg_send(pinfo->pim_sock_fd, src, originator, buffer,
106 b1length + PIM_MSG_REGISTER_STOP_LEN, ifp->name)) {
107 if (PIM_DEBUG_PIM_TRACE) {
108 zlog_debug(
109 "%s: could not send PIM register stop message on interface %s",
110 __PRETTY_FUNCTION__, ifp->name);
111 }
112 }
113 ++pinfo->pim_ifstat_reg_stop_send;
01d68c9b
DS
114}
115
b206566b 116int pim_register_stop_recv(struct interface *ifp, uint8_t *buf, int buf_size)
4dffc880 117{
b206566b
DS
118 struct pim_interface *pim_ifp = ifp->info;
119 struct pim_instance *pim = pim_ifp->pim;
d62a17ae 120 struct pim_upstream *upstream = NULL;
121 struct prefix source;
122 struct prefix_sg sg;
123 int l;
124
125 memset(&sg, 0, sizeof(struct prefix_sg));
126 l = pim_parse_addr_group(&sg, buf, buf_size);
127 buf += l;
128 buf_size -= l;
129 pim_parse_addr_ucast(&source, buf, buf_size);
130 sg.src = source.u.prefix4;
131
b206566b 132 upstream = pim_upstream_find(pim, &sg);
d62a17ae 133 if (!upstream) {
134 return 0;
135 }
136
137 if (PIM_DEBUG_PIM_REG)
138 zlog_debug("Received Register stop for %s", upstream->sg_str);
139
140 switch (upstream->reg_state) {
141 case PIM_REG_NOINFO:
142 case PIM_REG_PRUNE:
143 return 0;
144 break;
145 case PIM_REG_JOIN:
146 upstream->reg_state = PIM_REG_PRUNE;
b206566b 147 pim_channel_del_oif(upstream->channel_oil, pim->regiface,
1b249e70 148 PIM_OIF_FLAG_PROTO_PIM, __func__);
d62a17ae 149 pim_upstream_start_register_stop_timer(upstream, 0);
b9f3a51c 150 pim_vxlan_update_sg_reg_state(pim, upstream,
2951a7a4 151 false/*reg_join*/);
d62a17ae 152 break;
153 case PIM_REG_JOIN_PENDING:
154 upstream->reg_state = PIM_REG_PRUNE;
155 pim_upstream_start_register_stop_timer(upstream, 0);
156 return 0;
157 break;
158 }
159
160 return 0;
4dffc880
DS
161}
162
d62a17ae 163void pim_register_send(const uint8_t *buf, int buf_size, struct in_addr src,
164 struct pim_rpf *rpg, int null_register,
165 struct pim_upstream *up)
998af219 166{
d62a17ae 167 unsigned char buffer[10000];
168 unsigned char *b1;
169 struct pim_interface *pinfo;
170 struct interface *ifp;
171
172 if (PIM_DEBUG_PIM_REG) {
173 zlog_debug("Sending %s %sRegister Packet to %s", up->sg_str,
174 null_register ? "NULL " : "",
175 inet_ntoa(rpg->rpf_addr.u.prefix4));
176 }
177
178 ifp = rpg->source_nexthop.interface;
179 if (!ifp) {
180 if (PIM_DEBUG_PIM_REG)
181 zlog_debug("%s: No interface to transmit register on",
182 __PRETTY_FUNCTION__);
183 return;
184 }
185 pinfo = (struct pim_interface *)ifp->info;
186 if (!pinfo) {
187 if (PIM_DEBUG_PIM_REG)
188 zlog_debug(
189 "%s: Interface: %s not configured for pim to trasmit on!\n",
190 __PRETTY_FUNCTION__, ifp->name);
191 return;
192 }
193
194 if (PIM_DEBUG_PIM_REG) {
195 char rp_str[INET_ADDRSTRLEN];
81c077d0
QY
196 strlcpy(rp_str, inet_ntoa(rpg->rpf_addr.u.prefix4),
197 sizeof(rp_str));
d62a17ae 198 zlog_debug("%s: Sending %s %sRegister Packet to %s on %s",
199 __PRETTY_FUNCTION__, up->sg_str,
200 null_register ? "NULL " : "", rp_str, ifp->name);
201 }
202
203 memset(buffer, 0, 10000);
204 b1 = buffer + PIM_MSG_HEADER_LEN;
205 *b1 |= null_register << 6;
206 b1 = buffer + PIM_MSG_REGISTER_LEN;
207
208 memcpy(b1, (const unsigned char *)buf, buf_size);
209
210 pim_msg_build_header(buffer, buf_size + PIM_MSG_REGISTER_LEN,
d57a8bbf 211 PIM_MSG_TYPE_REGISTER, false);
d62a17ae 212
213 ++pinfo->pim_ifstat_reg_send;
214
215 if (pim_msg_send(pinfo->pim_sock_fd, src, rpg->rpf_addr.u.prefix4,
216 buffer, buf_size + PIM_MSG_REGISTER_LEN, ifp->name)) {
217 if (PIM_DEBUG_PIM_TRACE) {
218 zlog_debug(
219 "%s: could not send PIM register message on interface %s",
220 __PRETTY_FUNCTION__, ifp->name);
221 }
222 return;
223 }
998af219
DS
224}
225
aea1f845
AK
226void pim_null_register_send(struct pim_upstream *up)
227{
228 struct ip ip_hdr;
229 struct pim_interface *pim_ifp;
230 struct pim_rpf *rpg;
231 struct in_addr src;
232
233 pim_ifp = up->rpf.source_nexthop.interface->info;
234 if (!pim_ifp) {
23fc858a 235 if (PIM_DEBUG_PIM_TRACE)
aea1f845
AK
236 zlog_debug(
237 "%s: Cannot send null-register for %s no valid iif",
238 __PRETTY_FUNCTION__, up->sg_str);
239 return;
240 }
241
242 rpg = RP(pim_ifp->pim, up->sg.grp);
243 if (!rpg) {
23fc858a 244 if (PIM_DEBUG_PIM_TRACE)
aea1f845
AK
245 zlog_debug(
246 "%s: Cannot send null-register for %s no RPF to the RP",
247 __PRETTY_FUNCTION__, up->sg_str);
248 return;
249 }
250
251 memset(&ip_hdr, 0, sizeof(struct ip));
252 ip_hdr.ip_p = PIM_IP_PROTO_PIM;
253 ip_hdr.ip_hl = 5;
254 ip_hdr.ip_v = 4;
255 ip_hdr.ip_src = up->sg.src;
256 ip_hdr.ip_dst = up->sg.grp;
257 ip_hdr.ip_len = htons(20);
258
259 /* checksum is broken */
260 src = pim_ifp->primary_address;
d9e75668
AK
261 if (PIM_UPSTREAM_FLAG_TEST_SRC_VXLAN_ORIG(up->flags)) {
262 if (!pim_vxlan_get_register_src(pim_ifp->pim, up, &src)) {
23fc858a 263 if (PIM_DEBUG_PIM_TRACE)
d9e75668
AK
264 zlog_debug(
265 "%s: Cannot send null-register for %s vxlan-aa PIP unavailable",
266 __PRETTY_FUNCTION__, up->sg_str);
267 return;
268 }
269 }
aea1f845
AK
270 pim_register_send((uint8_t *)&ip_hdr, sizeof(struct ip),
271 src, rpg, 1, up);
272}
273
01d68c9b
DS
274/*
275 * 4.4.2 Receiving Register Messages at the RP
276 *
277 * When an RP receives a Register message, the course of action is
278 * decided according to the following pseudocode:
279 *
280 * packet_arrives_on_rp_tunnel( pkt ) {
281 * if( outer.dst is not one of my addresses ) {
282 * drop the packet silently.
283 * # Note: this may be a spoofing attempt
284 * }
285 * if( I_am_RP(G) AND outer.dst == RP(G) ) {
2951a7a4
QY
286 * sentRegisterStop = false;
287 * if ( register.borderbit == true ) {
01d68c9b
DS
288 * if ( PMBR(S,G) == unknown ) {
289 * PMBR(S,G) = outer.src
290 * } else if ( outer.src != PMBR(S,G) ) {
291 * send Register-Stop(S,G) to outer.src
292 * drop the packet silently.
293 * }
294 * }
295 * if ( SPTbit(S,G) OR
296 * ( SwitchToSptDesired(S,G) AND
297 * ( inherited_olist(S,G) == NULL ))) {
298 * send Register-Stop(S,G) to outer.src
2951a7a4 299 * sentRegisterStop = true;
01d68c9b
DS
300 * }
301 * if ( SPTbit(S,G) OR SwitchToSptDesired(S,G) ) {
2951a7a4 302 * if ( sentRegisterStop == true ) {
01d68c9b
DS
303 * set KeepaliveTimer(S,G) to RP_Keepalive_Period;
304 * } else {
305 * set KeepaliveTimer(S,G) to Keepalive_Period;
306 * }
307 * }
308 * if( !SPTbit(S,G) AND ! pkt.NullRegisterBit ) {
309 * decapsulate and forward the inner packet to
310 * inherited_olist(S,G,rpt) # Note (+)
311 * }
312 * } else {
313 * send Register-Stop(S,G) to outer.src
314 * # Note (*)
315 * }
316 * }
317 */
d62a17ae 318int pim_register_recv(struct interface *ifp, struct in_addr dest_addr,
319 struct in_addr src_addr, uint8_t *tlv_buf,
320 int tlv_buf_size)
01d68c9b 321{
d62a17ae 322 int sentRegisterStop = 0;
323 struct ip *ip_hdr;
324 struct prefix_sg sg;
325 uint32_t *bits;
326 int i_am_rp = 0;
327 struct pim_interface *pim_ifp = NULL;
01d68c9b 328
fec883d9
DS
329 pim_ifp = ifp->info;
330
75a26779 331#define PIM_MSG_REGISTER_BIT_RESERVED_LEN 4
d62a17ae 332 ip_hdr = (struct ip *)(tlv_buf + PIM_MSG_REGISTER_BIT_RESERVED_LEN);
333
f43593d9 334 if (!pim_rp_check_is_my_ip_address(pim_ifp->pim, dest_addr)) {
d62a17ae 335 if (PIM_DEBUG_PIM_REG) {
336 char dest[INET_ADDRSTRLEN];
337
338 pim_inet4_dump("<dst?>", dest_addr, dest, sizeof(dest));
339 zlog_debug(
f43593d9 340 "%s: Received Register message for destination address: %s that I do not own",
d62a17ae 341 __func__, dest);
342 }
343 return 0;
344 }
345
d62a17ae 346 ++pim_ifp->pim_ifstat_reg_recv;
347
348 /*
349 * Please note this is not drawn to get the correct bit/data size
350 *
351 * The entirety of the REGISTER packet looks like this:
352 * -------------------------------------------------------------
353 * | Ver | Type | Reserved | Checksum |
354 * |-----------------------------------------------------------|
355 * |B|N| Reserved 2 |
356 * |-----------------------------------------------------------|
357 * | Encap | IP HDR |
358 * | Mcast | |
359 * | Packet |--------------------------------------------------|
360 * | | Mcast Data |
361 * | | |
362 * ...
363 *
364 * tlv_buf when received from the caller points at the B bit
365 * We need to know the inner source and dest
366 */
367 bits = (uint32_t *)tlv_buf;
368
369 /*
370 * tlv_buf points to the start of the |B|N|... Reserved
371 * Line above. So we need to add 4 bytes to get to the
372 * start of the actual Encapsulated data.
373 */
374 memset(&sg, 0, sizeof(struct prefix_sg));
375 sg.src = ip_hdr->ip_src;
376 sg.grp = ip_hdr->ip_dst;
377
d9c9a9ee 378 i_am_rp = I_am_RP(pim_ifp->pim, sg.grp);
d62a17ae 379
380 if (PIM_DEBUG_PIM_REG) {
381 char src_str[INET_ADDRSTRLEN];
382
383 pim_inet4_dump("<src?>", src_addr, src_str, sizeof(src_str));
41714081
DS
384 zlog_debug("Received Register message%s from %s on %s, rp: %d",
385 pim_str_sg_dump(&sg), src_str, ifp->name, i_am_rp);
d62a17ae 386 }
387
fec883d9
DS
388 if (i_am_rp
389 && (dest_addr.s_addr
390 == ((RP(pim_ifp->pim, sg.grp))->rpf_addr.u.prefix4.s_addr))) {
d62a17ae 391 sentRegisterStop = 0;
392
393 if (*bits & PIM_REGISTER_BORDER_BIT) {
394 struct in_addr pimbr = pim_br_get_pmbr(&sg);
395 if (PIM_DEBUG_PIM_PACKETS)
396 zlog_debug(
397 "%s: Received Register message with Border bit set",
398 __func__);
399
400 if (pimbr.s_addr == pim_br_unknown.s_addr)
401 pim_br_set_pmbr(&sg, src_addr);
402 else if (src_addr.s_addr != pimbr.s_addr) {
403 pim_register_stop_send(ifp, &sg, dest_addr,
404 src_addr);
405 if (PIM_DEBUG_PIM_PACKETS)
406 zlog_debug(
407 "%s: Sending register-Stop to %s and dropping mr. packet",
408 __func__, "Sender");
409 /* Drop Packet Silently */
410 return 0;
411 }
412 }
413
9b29ea95
DS
414 struct pim_upstream *upstream =
415 pim_upstream_find(pim_ifp->pim, &sg);
d62a17ae 416 /*
417 * If we don't have a place to send ignore the packet
418 */
419 if (!upstream) {
420 upstream = pim_upstream_add(
2002dcdb
DS
421 pim_ifp->pim, &sg, ifp,
422 PIM_UPSTREAM_FLAG_MASK_SRC_STREAM,
0885a9f1 423 __PRETTY_FUNCTION__, NULL);
d62a17ae 424 if (!upstream) {
425 zlog_warn("Failure to create upstream state");
426 return 1;
427 }
428
429 upstream->upstream_register = src_addr;
cc61055f
DS
430 } else {
431 /*
432 * If the FHR has set a very very fast register timer
433 * there exists a possibility that the incoming NULL
434 * register
435 * is happening before we set the spt bit. If so
436 * Do a quick check to update the counters and
437 * then set the spt bit as appropriate
438 */
439 if (upstream->sptbit != PIM_UPSTREAM_SPTBIT_TRUE) {
440 pim_mroute_update_counters(
441 upstream->channel_oil);
442 /*
443 * Have we seen packets?
444 */
445 if (upstream->channel_oil->cc.oldpktcnt
446 < upstream->channel_oil->cc.pktcnt)
447 pim_upstream_set_sptbit(
448 upstream,
449 upstream->rpf.source_nexthop
450 .interface);
451 }
d62a17ae 452 }
453
454 if ((upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE)
2ef4ed70 455 || ((SwitchToSptDesiredOnRp(pim_ifp->pim, &sg))
9b29ea95
DS
456 && pim_upstream_inherited_olist(pim_ifp->pim, upstream)
457 == 0)) {
d62a17ae 458 pim_register_stop_send(ifp, &sg, dest_addr, src_addr);
459 sentRegisterStop = 1;
460 } else {
461 if (PIM_DEBUG_PIM_REG)
462 zlog_debug("(%s) sptbit: %d", upstream->sg_str,
463 upstream->sptbit);
464 }
465 if ((upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE)
2ef4ed70 466 || (SwitchToSptDesiredOnRp(pim_ifp->pim, &sg))) {
d62a17ae 467 if (sentRegisterStop) {
468 pim_upstream_keep_alive_timer_start(
996c9314
LB
469 upstream,
470 pim_ifp->pim->rp_keep_alive_time);
d62a17ae 471 } else {
472 pim_upstream_keep_alive_timer_start(
996c9314
LB
473 upstream,
474 pim_ifp->pim->keep_alive_time);
d62a17ae 475 }
476 }
477
478 if (!(upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE)
479 && !(*bits & PIM_REGISTER_NR_BIT)) {
480 // decapsulate and forward the iner packet to
481 // inherited_olist(S,G,rpt)
482 // This is taken care of by the kernel for us
483 }
484 pim_upstream_msdp_reg_timer_start(upstream);
485 } else {
486 if (PIM_DEBUG_PIM_REG) {
487 if (!i_am_rp)
488 zlog_debug(
489 "Received Register packet for %s, Rejecting packet because I am not the RP configured for group",
490 pim_str_sg_dump(&sg));
491 else
492 zlog_debug(
493 "Received Register packet for %s, Rejecting packet because the dst ip address is not the actual RP",
494 pim_str_sg_dump(&sg));
495 }
496 pim_register_stop_send(ifp, &sg, dest_addr, src_addr);
497 }
498
8dc60b69 499 return 0;
01d68c9b 500}