3 * Copyright (C) 2015 Cumulus Networks, Inc.
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.
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.
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
31 #include "pim_mroute.h"
32 #include "pim_iface.h"
37 #include "pim_register.h"
38 #include "pim_upstream.h"
42 #include "pim_zebra.h"
47 struct thread
*send_test_packet_timer
= NULL
;
49 void pim_register_join(struct pim_upstream
*up
)
51 struct pim_instance
*pim
= up
->channel_oil
->pim
;
53 if (pim_is_grp_ssm(pim
, up
->sg
.grp
)) {
54 if (PIM_DEBUG_PIM_EVENTS
)
55 zlog_debug("%s register setup skipped as group is SSM",
60 pim_channel_add_oif(up
->channel_oil
, pim
->regiface
,
61 PIM_OIF_FLAG_PROTO_PIM
);
62 up
->reg_state
= PIM_REG_JOIN
;
65 void pim_register_stop_send(struct interface
*ifp
, struct prefix_sg
*sg
,
66 struct in_addr src
, struct in_addr originator
)
68 struct pim_interface
*pinfo
;
69 unsigned char buffer
[10000];
70 unsigned int b1length
= 0;
75 if (PIM_DEBUG_PIM_REG
) {
76 zlog_debug("Sending Register stop for %s to %s on %s",
77 pim_str_sg_dump(sg
), inet_ntoa(originator
),
81 memset(buffer
, 0, 10000);
82 b1
= (uint8_t *)buffer
+ PIM_MSG_REGISTER_STOP_LEN
;
84 length
= pim_encode_addr_group(b1
, AFI_IP
, 0, 0, sg
->grp
);
89 p
.u
.prefix4
= sg
->src
;
91 length
= pim_encode_addr_ucast(b1
, &p
);
94 pim_msg_build_header(buffer
, b1length
+ PIM_MSG_REGISTER_STOP_LEN
,
95 PIM_MSG_TYPE_REG_STOP
);
97 pinfo
= (struct pim_interface
*)ifp
->info
;
99 if (PIM_DEBUG_PIM_TRACE
)
100 zlog_debug("%s: No pinfo!\n", __PRETTY_FUNCTION__
);
103 if (pim_msg_send(pinfo
->pim_sock_fd
, src
, originator
, buffer
,
104 b1length
+ PIM_MSG_REGISTER_STOP_LEN
, ifp
->name
)) {
105 if (PIM_DEBUG_PIM_TRACE
) {
107 "%s: could not send PIM register stop message on interface %s",
108 __PRETTY_FUNCTION__
, ifp
->name
);
111 ++pinfo
->pim_ifstat_reg_stop_send
;
114 int pim_register_stop_recv(struct interface
*ifp
, uint8_t *buf
, int buf_size
)
116 struct pim_interface
*pim_ifp
= ifp
->info
;
117 struct pim_instance
*pim
= pim_ifp
->pim
;
118 struct pim_upstream
*upstream
= NULL
;
119 struct prefix source
;
123 memset(&sg
, 0, sizeof(struct prefix_sg
));
124 l
= pim_parse_addr_group(&sg
, buf
, buf_size
);
127 pim_parse_addr_ucast(&source
, buf
, buf_size
);
128 sg
.src
= source
.u
.prefix4
;
130 upstream
= pim_upstream_find(pim
, &sg
);
135 if (PIM_DEBUG_PIM_REG
)
136 zlog_debug("Received Register stop for %s", upstream
->sg_str
);
138 switch (upstream
->reg_state
) {
144 upstream
->reg_state
= PIM_REG_PRUNE
;
145 pim_channel_del_oif(upstream
->channel_oil
, pim
->regiface
,
146 PIM_OIF_FLAG_PROTO_PIM
);
147 pim_upstream_start_register_stop_timer(upstream
, 0);
149 case PIM_REG_JOIN_PENDING
:
150 upstream
->reg_state
= PIM_REG_PRUNE
;
151 pim_upstream_start_register_stop_timer(upstream
, 0);
159 void pim_register_send(const uint8_t *buf
, int buf_size
, struct in_addr src
,
160 struct pim_rpf
*rpg
, int null_register
,
161 struct pim_upstream
*up
)
163 unsigned char buffer
[10000];
165 struct pim_interface
*pinfo
;
166 struct interface
*ifp
;
168 if (PIM_DEBUG_PIM_REG
) {
169 zlog_debug("Sending %s %sRegister Packet to %s", up
->sg_str
,
170 null_register
? "NULL " : "",
171 inet_ntoa(rpg
->rpf_addr
.u
.prefix4
));
174 ifp
= rpg
->source_nexthop
.interface
;
176 if (PIM_DEBUG_PIM_REG
)
177 zlog_debug("%s: No interface to transmit register on",
178 __PRETTY_FUNCTION__
);
181 pinfo
= (struct pim_interface
*)ifp
->info
;
183 if (PIM_DEBUG_PIM_REG
)
185 "%s: Interface: %s not configured for pim to trasmit on!\n",
186 __PRETTY_FUNCTION__
, ifp
->name
);
190 if (PIM_DEBUG_PIM_REG
) {
191 char rp_str
[INET_ADDRSTRLEN
];
192 strncpy(rp_str
, inet_ntoa(rpg
->rpf_addr
.u
.prefix4
),
193 INET_ADDRSTRLEN
- 1);
194 zlog_debug("%s: Sending %s %sRegister Packet to %s on %s",
195 __PRETTY_FUNCTION__
, up
->sg_str
,
196 null_register
? "NULL " : "", rp_str
, ifp
->name
);
199 memset(buffer
, 0, 10000);
200 b1
= buffer
+ PIM_MSG_HEADER_LEN
;
201 *b1
|= null_register
<< 6;
202 b1
= buffer
+ PIM_MSG_REGISTER_LEN
;
204 memcpy(b1
, (const unsigned char *)buf
, buf_size
);
206 pim_msg_build_header(buffer
, buf_size
+ PIM_MSG_REGISTER_LEN
,
207 PIM_MSG_TYPE_REGISTER
);
209 ++pinfo
->pim_ifstat_reg_send
;
211 if (pim_msg_send(pinfo
->pim_sock_fd
, src
, rpg
->rpf_addr
.u
.prefix4
,
212 buffer
, buf_size
+ PIM_MSG_REGISTER_LEN
, ifp
->name
)) {
213 if (PIM_DEBUG_PIM_TRACE
) {
215 "%s: could not send PIM register message on interface %s",
216 __PRETTY_FUNCTION__
, ifp
->name
);
223 * 4.4.2 Receiving Register Messages at the RP
225 * When an RP receives a Register message, the course of action is
226 * decided according to the following pseudocode:
228 * packet_arrives_on_rp_tunnel( pkt ) {
229 * if( outer.dst is not one of my addresses ) {
230 * drop the packet silently.
231 * # Note: this may be a spoofing attempt
233 * if( I_am_RP(G) AND outer.dst == RP(G) ) {
234 * sentRegisterStop = FALSE;
235 * if ( register.borderbit == TRUE ) {
236 * if ( PMBR(S,G) == unknown ) {
237 * PMBR(S,G) = outer.src
238 * } else if ( outer.src != PMBR(S,G) ) {
239 * send Register-Stop(S,G) to outer.src
240 * drop the packet silently.
243 * if ( SPTbit(S,G) OR
244 * ( SwitchToSptDesired(S,G) AND
245 * ( inherited_olist(S,G) == NULL ))) {
246 * send Register-Stop(S,G) to outer.src
247 * sentRegisterStop = TRUE;
249 * if ( SPTbit(S,G) OR SwitchToSptDesired(S,G) ) {
250 * if ( sentRegisterStop == TRUE ) {
251 * set KeepaliveTimer(S,G) to RP_Keepalive_Period;
253 * set KeepaliveTimer(S,G) to Keepalive_Period;
256 * if( !SPTbit(S,G) AND ! pkt.NullRegisterBit ) {
257 * decapsulate and forward the inner packet to
258 * inherited_olist(S,G,rpt) # Note (+)
261 * send Register-Stop(S,G) to outer.src
266 int pim_register_recv(struct interface
*ifp
, struct in_addr dest_addr
,
267 struct in_addr src_addr
, uint8_t *tlv_buf
,
270 int sentRegisterStop
= 0;
275 struct pim_interface
*pim_ifp
= NULL
;
279 #define PIM_MSG_REGISTER_BIT_RESERVED_LEN 4
280 ip_hdr
= (struct ip
*)(tlv_buf
+ PIM_MSG_REGISTER_BIT_RESERVED_LEN
);
282 if (!pim_rp_check_is_my_ip_address(pim_ifp
->pim
, ip_hdr
->ip_dst
,
284 if (PIM_DEBUG_PIM_REG
) {
285 char dest
[INET_ADDRSTRLEN
];
287 pim_inet4_dump("<dst?>", dest_addr
, dest
, sizeof(dest
));
289 "%s: Received Register message for %s that I do not own",
295 ++pim_ifp
->pim_ifstat_reg_recv
;
298 * Please note this is not drawn to get the correct bit/data size
300 * The entirety of the REGISTER packet looks like this:
301 * -------------------------------------------------------------
302 * | Ver | Type | Reserved | Checksum |
303 * |-----------------------------------------------------------|
305 * |-----------------------------------------------------------|
308 * | Packet |--------------------------------------------------|
313 * tlv_buf when received from the caller points at the B bit
314 * We need to know the inner source and dest
316 bits
= (uint32_t *)tlv_buf
;
319 * tlv_buf points to the start of the |B|N|... Reserved
320 * Line above. So we need to add 4 bytes to get to the
321 * start of the actual Encapsulated data.
323 memset(&sg
, 0, sizeof(struct prefix_sg
));
324 sg
.src
= ip_hdr
->ip_src
;
325 sg
.grp
= ip_hdr
->ip_dst
;
327 i_am_rp
= I_am_RP(pim_ifp
->pim
, sg
.grp
);
329 if (PIM_DEBUG_PIM_REG
) {
330 char src_str
[INET_ADDRSTRLEN
];
332 pim_inet4_dump("<src?>", src_addr
, src_str
, sizeof(src_str
));
334 "Received Register message(%s) from %s on %s, rp: %d",
335 pim_str_sg_dump(&sg
), src_str
, ifp
->name
, i_am_rp
);
340 == ((RP(pim_ifp
->pim
, sg
.grp
))->rpf_addr
.u
.prefix4
.s_addr
))) {
341 sentRegisterStop
= 0;
343 if (*bits
& PIM_REGISTER_BORDER_BIT
) {
344 struct in_addr pimbr
= pim_br_get_pmbr(&sg
);
345 if (PIM_DEBUG_PIM_PACKETS
)
347 "%s: Received Register message with Border bit set",
350 if (pimbr
.s_addr
== pim_br_unknown
.s_addr
)
351 pim_br_set_pmbr(&sg
, src_addr
);
352 else if (src_addr
.s_addr
!= pimbr
.s_addr
) {
353 pim_register_stop_send(ifp
, &sg
, dest_addr
,
355 if (PIM_DEBUG_PIM_PACKETS
)
357 "%s: Sending register-Stop to %s and dropping mr. packet",
359 /* Drop Packet Silently */
364 struct pim_upstream
*upstream
=
365 pim_upstream_find(pim_ifp
->pim
, &sg
);
367 * If we don't have a place to send ignore the packet
370 upstream
= pim_upstream_add(
371 pim_ifp
->pim
, &sg
, ifp
,
372 PIM_UPSTREAM_FLAG_MASK_SRC_STREAM
,
373 __PRETTY_FUNCTION__
, NULL
);
375 zlog_warn("Failure to create upstream state");
379 upstream
->upstream_register
= src_addr
;
382 * If the FHR has set a very very fast register timer
383 * there exists a possibility that the incoming NULL
385 * is happening before we set the spt bit. If so
386 * Do a quick check to update the counters and
387 * then set the spt bit as appropriate
389 if (upstream
->sptbit
!= PIM_UPSTREAM_SPTBIT_TRUE
) {
390 pim_mroute_update_counters(
391 upstream
->channel_oil
);
393 * Have we seen packets?
395 if (upstream
->channel_oil
->cc
.oldpktcnt
396 < upstream
->channel_oil
->cc
.pktcnt
)
397 pim_upstream_set_sptbit(
399 upstream
->rpf
.source_nexthop
404 if ((upstream
->sptbit
== PIM_UPSTREAM_SPTBIT_TRUE
)
405 || ((SwitchToSptDesired(pim_ifp
->pim
, &sg
))
406 && pim_upstream_inherited_olist(pim_ifp
->pim
, upstream
)
408 // pim_scan_individual_oil (upstream->channel_oil);
409 pim_register_stop_send(ifp
, &sg
, dest_addr
, src_addr
);
410 sentRegisterStop
= 1;
412 if (PIM_DEBUG_PIM_REG
)
413 zlog_debug("(%s) sptbit: %d", upstream
->sg_str
,
416 if ((upstream
->sptbit
== PIM_UPSTREAM_SPTBIT_TRUE
)
417 || (SwitchToSptDesired(pim_ifp
->pim
, &sg
))) {
418 if (sentRegisterStop
) {
419 pim_upstream_keep_alive_timer_start(
421 pim_ifp
->pim
->rp_keep_alive_time
);
423 pim_upstream_keep_alive_timer_start(
425 pim_ifp
->pim
->keep_alive_time
);
429 if (!(upstream
->sptbit
== PIM_UPSTREAM_SPTBIT_TRUE
)
430 && !(*bits
& PIM_REGISTER_NR_BIT
)) {
431 // decapsulate and forward the iner packet to
432 // inherited_olist(S,G,rpt)
433 // This is taken care of by the kernel for us
435 pim_upstream_msdp_reg_timer_start(upstream
);
437 if (PIM_DEBUG_PIM_REG
) {
440 "Received Register packet for %s, Rejecting packet because I am not the RP configured for group",
441 pim_str_sg_dump(&sg
));
444 "Received Register packet for %s, Rejecting packet because the dst ip address is not the actual RP",
445 pim_str_sg_dump(&sg
));
447 pim_register_stop_send(ifp
, &sg
, dest_addr
, src_addr
);