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
17 * along with this program; see the file COPYING; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
32 #include "pim_mroute.h"
33 #include "pim_iface.h"
38 #include "pim_register.h"
39 #include "pim_upstream.h"
43 #include "pim_zebra.h"
48 struct thread
*send_test_packet_timer
= NULL
;
51 pim_register_join (struct pim_upstream
*up
)
53 if (pim_is_grp_ssm (up
->sg
.grp
))
55 if (PIM_DEBUG_PIM_EVENTS
)
56 zlog_debug ("%s register setup skipped as group is SSM", up
->sg_str
);
60 pim_channel_add_oif (up
->channel_oil
, pim_regiface
, PIM_OIF_FLAG_PROTO_PIM
);
61 up
->reg_state
= PIM_REG_JOIN
;
65 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
)
77 zlog_debug ("Sending Register stop for %s to %s on %s",
78 pim_str_sg_dump (sg
), inet_ntoa(originator
), ifp
->name
);
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
, PIM_MSG_TYPE_REG_STOP
);
96 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
,
104 buffer
, b1length
+ PIM_MSG_REGISTER_STOP_LEN
,
107 if (PIM_DEBUG_PIM_TRACE
)
109 zlog_debug ("%s: could not send PIM register stop message on interface %s",
110 __PRETTY_FUNCTION__
, ifp
->name
);
116 pim_register_stop_recv (uint8_t *buf
, int buf_size
)
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 (&sg
);
136 if (PIM_DEBUG_PIM_REG
)
137 zlog_debug ("Received Register stop for %s",
140 switch (upstream
->reg_state
)
147 upstream
->reg_state
= PIM_REG_PRUNE
;
148 pim_channel_del_oif (upstream
->channel_oil
, pim_regiface
, PIM_OIF_FLAG_PROTO_PIM
);
149 pim_upstream_start_register_stop_timer (upstream
, 0);
151 case PIM_REG_JOIN_PENDING
:
152 upstream
->reg_state
= PIM_REG_PRUNE
;
153 pim_upstream_start_register_stop_timer (upstream
, 0);
162 pim_register_send (const uint8_t *buf
, int buf_size
, struct in_addr src
, struct pim_rpf
*rpg
, int null_register
, struct pim_upstream
*up
)
164 unsigned char buffer
[10000];
166 struct pim_interface
*pinfo
;
167 struct interface
*ifp
;
169 if (PIM_DEBUG_PIM_REG
)
171 zlog_debug ("Sending %s %sRegister Packet to %s",
172 up
->sg_str
, null_register
? "NULL " : "",
173 inet_ntoa (rpg
->rpf_addr
.u
.prefix4
));
176 ifp
= rpg
->source_nexthop
.interface
;
179 if (PIM_DEBUG_PIM_REG
)
180 zlog_debug ("%s: No interface to transmit register on", __PRETTY_FUNCTION__
);
183 pinfo
= (struct pim_interface
*)ifp
->info
;
185 if (PIM_DEBUG_PIM_REG
)
186 zlog_debug("%s: Interface: %s not configured for pim to trasmit on!\n", __PRETTY_FUNCTION__
, ifp
->name
);
190 if (PIM_DEBUG_PIM_REG
)
192 char rp_str
[INET_ADDRSTRLEN
];
193 strncpy (rp_str
, inet_ntoa (rpg
->rpf_addr
.u
.prefix4
), 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
, PIM_MSG_TYPE_REGISTER
);
208 if (pim_msg_send(pinfo
->pim_sock_fd
,
210 rpg
->rpf_addr
.u
.prefix4
,
212 buf_size
+ PIM_MSG_REGISTER_LEN
,
214 if (PIM_DEBUG_PIM_TRACE
) {
215 zlog_debug("%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
267 pim_register_recv (struct interface
*ifp
,
268 struct in_addr dest_addr
,
269 struct in_addr src_addr
,
270 uint8_t *tlv_buf
, int tlv_buf_size
)
272 int sentRegisterStop
= 0;
278 #define PIM_MSG_REGISTER_BIT_RESERVED_LEN 4
279 ip_hdr
= (struct ip
*)(tlv_buf
+ PIM_MSG_REGISTER_BIT_RESERVED_LEN
);
281 if (!pim_rp_check_is_my_ip_address (ip_hdr
->ip_dst
, dest_addr
)) {
282 if (PIM_DEBUG_PIM_REG
) {
283 char dest
[INET_ADDRSTRLEN
];
285 pim_inet4_dump ("<dst?>", dest_addr
, dest
, sizeof(dest
));
286 zlog_debug ("%s: Received Register message for %s that I do not own", __func__
,
293 * Please note this is not drawn to get the correct bit/data size
295 * The entirety of the REGISTER packet looks like this:
296 * -------------------------------------------------------------
297 * | Ver | Type | Reserved | Checksum |
298 * |-----------------------------------------------------------|
300 * |-----------------------------------------------------------|
303 * | Packet |--------------------------------------------------|
308 * tlv_buf when received from the caller points at the B bit
309 * We need to know the inner source and dest
311 bits
= (uint32_t *)tlv_buf
;
314 * tlv_buf points to the start of the |B|N|... Reserved
315 * Line above. So we need to add 4 bytes to get to the
316 * start of the actual Encapsulated data.
318 memset (&sg
, 0, sizeof (struct prefix_sg
));
319 sg
.src
= ip_hdr
->ip_src
;
320 sg
.grp
= ip_hdr
->ip_dst
;
322 i_am_rp
= I_am_RP (sg
.grp
);
324 if (PIM_DEBUG_PIM_REG
)
326 char src_str
[INET_ADDRSTRLEN
];
328 pim_inet4_dump ("<src?>", src_addr
, src_str
, sizeof (src_str
));
329 zlog_debug ("Received Register message(%s) from %s on %s, rp: %d",
330 pim_str_sg_dump (&sg
), src_str
, ifp
->name
, i_am_rp
);
333 if (i_am_rp
&& (dest_addr
.s_addr
== ((RP (sg
.grp
))->rpf_addr
.u
.prefix4
.s_addr
))) {
334 sentRegisterStop
= 0;
336 if (*bits
& PIM_REGISTER_BORDER_BIT
) {
337 struct in_addr pimbr
= pim_br_get_pmbr (&sg
);
338 if (PIM_DEBUG_PIM_PACKETS
)
339 zlog_debug("%s: Received Register message with Border bit set", __func__
);
341 if (pimbr
.s_addr
== pim_br_unknown
.s_addr
)
342 pim_br_set_pmbr(&sg
, src_addr
);
343 else if (src_addr
.s_addr
!= pimbr
.s_addr
) {
344 pim_register_stop_send (ifp
, &sg
, dest_addr
, src_addr
);
345 if (PIM_DEBUG_PIM_PACKETS
)
346 zlog_debug("%s: Sending register-Stop to %s and dropping mr. packet",
348 /* Drop Packet Silently */
353 struct pim_upstream
*upstream
= pim_upstream_find (&sg
);
355 * If we don't have a place to send ignore the packet
359 upstream
= pim_upstream_add (&sg
, ifp
,
360 PIM_UPSTREAM_FLAG_MASK_SRC_STREAM
,
361 __PRETTY_FUNCTION__
);
364 zlog_warn ("Failure to create upstream state");
368 upstream
->upstream_register
= src_addr
;
371 if ((upstream
->sptbit
== PIM_UPSTREAM_SPTBIT_TRUE
) ||
372 ((SwitchToSptDesired(&sg
)) &&
373 pim_upstream_inherited_olist (upstream
) == 0)) {
374 //pim_scan_individual_oil (upstream->channel_oil);
375 pim_register_stop_send (ifp
, &sg
, dest_addr
, src_addr
);
376 sentRegisterStop
= 1;
378 if (PIM_DEBUG_PIM_REG
)
379 zlog_debug ("(%s) sptbit: %d", upstream
->sg_str
, upstream
->sptbit
);
381 if ((upstream
->sptbit
== PIM_UPSTREAM_SPTBIT_TRUE
) ||
382 (SwitchToSptDesired(&sg
))) {
383 if (sentRegisterStop
) {
384 pim_upstream_keep_alive_timer_start (upstream
, qpim_rp_keep_alive_time
);
386 pim_upstream_keep_alive_timer_start (upstream
, qpim_keep_alive_time
);
390 if (!(upstream
->sptbit
== PIM_UPSTREAM_SPTBIT_TRUE
) &&
391 !(*bits
& PIM_REGISTER_NR_BIT
))
393 //decapsulate and forward the iner packet to
394 //inherited_olist(S,G,rpt)
395 // This is taken care of by the kernel for us
397 pim_upstream_msdp_reg_timer_start(upstream
);
399 if (PIM_DEBUG_PIM_REG
)
402 zlog_debug ("Received Register packet for %s, Rejecting packet because I am not the RP configured for group",
403 pim_str_sg_dump (&sg
));
405 zlog_debug ("Received Register packet for %s, Rejecting packet because the dst ip address is not the actual RP",
406 pim_str_sg_dump (&sg
));
408 pim_register_stop_send (ifp
, &sg
, dest_addr
, src_addr
);