[mirror_frr.git] / pimd / pim_register.c

/*
 * PIM for Quagga
 * Copyright (C) 2015 Cumulus Networks, Inc.
 * Donald Sharp
 *
 * 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
 */

#include <zebra.h>

#include "log.h"
#include "if.h"
#include "thread.h"

#include "pimd.h"
#include "pim_str.h"
#include "pim_rp.h"
#include "pim_register.h"
#include "pim_upstream.h"
#include "pim_br.h"

struct thread *send_test_packet_timer = NULL;

/*
 * This seems stupidly expensive.  A list lookup.  Why is this
 * not a hash?
 */
static int
pim_check_is_my_ip_address (struct in_addr dest_addr)
{
  /*
   * See if we can short-cut some?
   * This might not make sense if we ever leave a static RP
   * type of configuration.
   * Note - Premature optimization might bite our patooeys' here.
   */
  if (I_am_RP(dest_addr) && (dest_addr.s_addr == qpim_rp.s_addr))
    return 1;

  if (if_lookup_exact_address (&dest_addr, AF_INET))
    return 1;

  return 0;
}

static void
pim_register_stop_send (struct in_addr src)
{
  return;
}

/*
 * 4.4.2 Receiving Register Messages at the RP
 *
 *   When an RP receives a Register message, the course of action is
 *  decided according to the following pseudocode:
 *
 *  packet_arrives_on_rp_tunnel( pkt ) {
 *      if( outer.dst is not one of my addresses ) {
 *          drop the packet silently.
 *          # Note: this may be a spoofing attempt
 *      }
 *      if( I_am_RP(G) AND outer.dst == RP(G) ) {
 *            sentRegisterStop = FALSE;
 *            if ( register.borderbit == TRUE ) {
 *                 if ( PMBR(S,G) == unknown ) {
 *                      PMBR(S,G) = outer.src
 *                 } else if ( outer.src != PMBR(S,G) ) {
 *                      send Register-Stop(S,G) to outer.src
 *                      drop the packet silently.
 *                 }
 *            }
 *            if ( SPTbit(S,G) OR
 *             ( SwitchToSptDesired(S,G) AND
 *               ( inherited_olist(S,G) == NULL ))) {
 *              send Register-Stop(S,G) to outer.src
 *              sentRegisterStop = TRUE;
 *            }
 *            if ( SPTbit(S,G) OR SwitchToSptDesired(S,G) ) {
 *                 if ( sentRegisterStop == TRUE ) {
 *                      set KeepaliveTimer(S,G) to RP_Keepalive_Period;
 *                 } else {
 *                      set KeepaliveTimer(S,G) to Keepalive_Period;
 *                 }
 *            }
 *            if( !SPTbit(S,G) AND ! pkt.NullRegisterBit ) {
 *                 decapsulate and forward the inner packet to
 *                 inherited_olist(S,G,rpt) # Note (+)
 *            }
 *      } else {
 *          send Register-Stop(S,G) to outer.src
 *          # Note (*)
 *      }
 *  }
 */
int
pim_register_recv (struct interface *ifp,
		   struct in_addr dest_addr,
		   struct in_addr src_addr,
		   uint8_t *tlv_buf, int tlv_buf_size)
{
  int sentRegisterStop = 0;
  struct ip *ip_hdr;
  size_t hlen;
  struct in_addr group = { .s_addr = 0 };
  struct in_addr source = { .s_addr = 0 };
  uint8_t *msg;
  uint32_t *bits;

  if (!pim_check_is_my_ip_address (dest_addr)) {
    if (PIM_DEBUG_PIM_PACKETS) {
      char dest[100];

      pim_inet4_dump ("<dst?>", dest_addr, dest, sizeof(dest));
      zlog_debug ("%s: Received Register message for %s that I do not own", __func__,
		  dest);
    }
    return 0;
  }

#define inherited_olist(S,G) NULL
  /*
   * Please note this is not drawn to get the correct bit/data size
   *
   * The entirety of the REGISTER packet looks like this:
   * -------------------------------------------------------------
   * | Ver  | Type | Reserved     |       Checksum               |
   * |-----------------------------------------------------------|
   * |B|N|     Reserved 2                                        |
   * |-----------------------------------------------------------|
   * | Encap  |                IP HDR                            |
   * | Mcast  |                                                  |
   * | Packet |--------------------------------------------------|
   * |        |               Mcast Data                         |
   * |        |                                                  |
   * ...
   *
   * tlv_buf when received from the caller points at the B bit
   * We need to know the inner source and dest
   */
  bits = (uint32_t *)tlv_buf;
  ip_hdr = (struct ip *)(tlv_buf + PIM_MSG_REGISTER_LEN);
  hlen = (ip_hdr->ip_hl << 2) | PIM_MSG_REGISTER_LEN;
  msg = (uint8_t *)tlv_buf + hlen;
  source = ip_hdr->ip_src;
  group = ip_hdr->ip_dst;

  if (I_am_RP (group) && (dest_addr.s_addr == (RP (group).s_addr))) {
    sentRegisterStop = 0;

    if (*bits && PIM_REGISTER_BORDER_BIT) {
      struct in_addr pimbr = pim_br_get_pmbr (source, group);
      if (PIM_DEBUG_PIM_PACKETS)
	zlog_debug("%s: Received Register message with Border bit set", __func__);

      if (pimbr.s_addr == pim_br_unknown.s_addr)
	pim_br_set_pmbr(source, group, src_addr);
      else if (src_addr.s_addr != pimbr.s_addr) {
	pim_register_stop_send(src_addr);
	if (PIM_DEBUG_PIM_PACKETS)
	  zlog_debug("%s: Sending register-Stop to %s and dropping mr. packet",
	    __func__, "Sender");
	/* Drop Packet Silently */
	return 1;
      }
    }

    struct pim_upstream *upstream = pim_upstream_find (source, group);
    /*
     * If we don't have a place to send ignore the packet
     */
    if (!upstream)
      return 1;

    if ((upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE) ||
	((SwitchToSptDesired(source, group)) &&
	 (inherited_olist(source, group) == NULL))) {
      pim_register_stop_send(src_addr);
      sentRegisterStop = 1;
    }

    if ((upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE) ||
	(SwitchToSptDesired(source, group))) {
      if (sentRegisterStop) {
	pim_upstream_keep_alive_timer_start (upstream, PIM_RP_KEEPALIVE_PERIOD);
      } else {
	pim_upstream_keep_alive_timer_start (upstream, PIM_KEEPALIVE_PERIOD);
      }
    }

    if (!(upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE) &&
	!(*bits && PIM_REGISTER_NR_BIT)) {
      //decapsulate and forward the iner packet to
      //inherited_olist(S,G,rpt)
    }
  } else {
    pim_register_stop_send(src_addr);
  }

  return 1;
}


static int
pim_register_send_test_packet (struct thread *t)
{
  uint8_t *packet;

  packet = THREAD_ARG(t);

  *packet = 4;

  return 1;
}

/*
 * pim_register_send_test_packet
 *
 * Send a test packet to the RP from source, in group and pps packets per second
 */
void
pim_register_send_test_packet_start (struct in_addr source,
				     struct in_addr group,
				     uint32_t pps)
{
  uint8_t *packet = NULL;

  THREAD_TIMER_MSEC_ON(master, send_test_packet_timer,
		       pim_register_send_test_packet, packet, 1000/pps);

  return;
}
Commit	Line	Data
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	*
	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,
	19	* MA 02110-1301 USA
	20	*/
	21
	22	#include <zebra.h>
	23
	24	#include "log.h"
	25	#include "if.h"
	26	#include "thread.h"
	27
	28	#include "pimd.h"
	29	#include "pim_str.h"
	30	#include "pim_rp.h"
	31	#include "pim_register.h"
80c0d168	32	#include "pim_upstream.h"
01d68c9b DS	33	#include "pim_br.h"
	34
	35	struct thread *send_test_packet_timer = NULL;
	36
	37	/*
	38	* This seems stupidly expensive. A list lookup. Why is this
	39	* not a hash?
	40	*/
	41	static int
	42	pim_check_is_my_ip_address (struct in_addr dest_addr)
	43	{
	44	/*
	45	* See if we can short-cut some?
	46	* This might not make sense if we ever leave a static RP
	47	* type of configuration.
	48	* Note - Premature optimization might bite our patooeys' here.
	49	*/
	50	if (I_am_RP(dest_addr) && (dest_addr.s_addr == qpim_rp.s_addr))
	51	return 1;
	52
	53	if (if_lookup_exact_address (&dest_addr, AF_INET))
	54	return 1;
	55
	56	return 0;
	57	}
	58
	59	static void
	60	pim_register_stop_send (struct in_addr src)
	61	{
	62	return;
	63	}
	64
	65	/*
	66	* 4.4.2 Receiving Register Messages at the RP
	67	*
	68	* When an RP receives a Register message, the course of action is
	69	* decided according to the following pseudocode:
	70	*
	71	* packet_arrives_on_rp_tunnel( pkt ) {
	72	* if( outer.dst is not one of my addresses ) {
	73	* drop the packet silently.
	74	* # Note: this may be a spoofing attempt
	75	* }
	76	* if( I_am_RP(G) AND outer.dst == RP(G) ) {
	77	* sentRegisterStop = FALSE;
	78	* if ( register.borderbit == TRUE ) {
	79	* if ( PMBR(S,G) == unknown ) {
	80	* PMBR(S,G) = outer.src
	81	* } else if ( outer.src != PMBR(S,G) ) {
	82	* send Register-Stop(S,G) to outer.src
	83	* drop the packet silently.
	84	* }
	85	* }
	86	* if ( SPTbit(S,G) OR
	87	* ( SwitchToSptDesired(S,G) AND
	88	* ( inherited_olist(S,G) == NULL ))) {
	89	* send Register-Stop(S,G) to outer.src
	90	* sentRegisterStop = TRUE;
	91	* }
	92	* if ( SPTbit(S,G) OR SwitchToSptDesired(S,G) ) {
	93	* if ( sentRegisterStop == TRUE ) {
	94	* set KeepaliveTimer(S,G) to RP_Keepalive_Period;
	95	* } else {
	96	* set KeepaliveTimer(S,G) to Keepalive_Period;
97	* }
98	* }
99	* if( !SPTbit(S,G) AND ! pkt.NullRegisterBit ) {
100	* decapsulate and forward the inner packet to
101	* inherited_olist(S,G,rpt) # Note (+)
102	* }
103	* } else {
104	* send Register-Stop(S,G) to outer.src
105	* # Note (*)
106	* }
107	* }
108	*/
109	int
110	pim_register_recv (struct interface *ifp,
111	struct in_addr dest_addr,
112	struct in_addr src_addr,
113	uint8_t *tlv_buf, int tlv_buf_size)
114	{
77e390e5 DS	115	int sentRegisterStop = 0;
	116	struct ip *ip_hdr;
	117	size_t hlen;
01d68c9b DS	118	struct in_addr group = { .s_addr = 0 };
01d68c9b DS	119	struct in_addr source = { .s_addr = 0 };
77e390e5 DS	120	uint8_t *msg;
77e390e5 DS	121	uint32_t *bits;
01d68c9b DS	122
	123	if (!pim_check_is_my_ip_address (dest_addr)) {
	124	if (PIM_DEBUG_PIM_PACKETS) {
	125	char dest[100];
	126
	127	pim_inet4_dump ("<dst?>", dest_addr, dest, sizeof(dest));
	128	zlog_debug ("%s: Received Register message for %s that I do not own", __func__,
	129	dest);
	130	}
	131	return 0;
	132	}
	133
80c0d168	134	#define inherited_olist(S,G) NULL
77e390e5 DS	135	/*
	136	* Please note this is not drawn to get the correct bit/data size
	137	*
	138	* The entirety of the REGISTER packet looks like this:
	139	* -------------------------------------------------------------
	140	* \| Ver \| Type \| Reserved \| Checksum \|
	141	* \|-----------------------------------------------------------\|
	142	* \|B\|N\| Reserved 2 \|
	143	* \|-----------------------------------------------------------\|
	144	* \| Encap \| IP HDR \|
	145	* \| Mcast \| \|
	146	* \| Packet \|--------------------------------------------------\|
	147	* \| \| Mcast Data \|
	148	* \| \| \|
	149	* ...
	150	*
	151	* tlv_buf when received from the caller points at the B bit
	152	* We need to know the inner source and dest
	153	*/
	154	bits = (uint32_t *)tlv_buf;
	155	ip_hdr = (struct ip *)(tlv_buf + PIM_MSG_REGISTER_LEN);
	156	hlen = (ip_hdr->ip_hl << 2) \| PIM_MSG_REGISTER_LEN;
	157	msg = (uint8_t *)tlv_buf + hlen;
	158	source = ip_hdr->ip_src;
	159	group = ip_hdr->ip_dst;
	160
01d68c9b	161	if (I_am_RP (group) && (dest_addr.s_addr == (RP (group).s_addr))) {
77e390e5	162	sentRegisterStop = 0;
01d68c9b DS	163
	164	if (*bits && PIM_REGISTER_BORDER_BIT) {
	165	struct in_addr pimbr = pim_br_get_pmbr (source, group);
	166	if (PIM_DEBUG_PIM_PACKETS)
	167	zlog_debug("%s: Received Register message with Border bit set", __func__);
	168
	169	if (pimbr.s_addr == pim_br_unknown.s_addr)
80c0d168 DS	170	pim_br_set_pmbr(source, group, src_addr);
	171	else if (src_addr.s_addr != pimbr.s_addr) {
	172	pim_register_stop_send(src_addr);
01d68c9b DS	173	if (PIM_DEBUG_PIM_PACKETS)
	174	zlog_debug("%s: Sending register-Stop to %s and dropping mr. packet",
	175	__func__, "Sender");
77e390e5 DS	176	/* Drop Packet Silently */
77e390e5 DS	177	return 1;
01d68c9b DS	178	}
01d68c9b DS	179	}
77e390e5 DS	180
	181	struct pim_upstream *upstream = pim_upstream_find (source, group);
	182	/*
	183	* If we don't have a place to send ignore the packet
	184	*/
	185	if (!upstream)
	186	return 1;
	187
	188	if ((upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE) \|\|
	189	((SwitchToSptDesired(source, group)) &&
80c0d168 DS	190	(inherited_olist(source, group) == NULL))) {
80c0d168 DS	191	pim_register_stop_send(src_addr);
77e390e5 DS	192	sentRegisterStop = 1;
	193	}
	194
	195	if ((upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE) \|\|
	196	(SwitchToSptDesired(source, group))) {
80c0d168 DS	197	if (sentRegisterStop) {
80c0d168 DS	198	pim_upstream_keep_alive_timer_start (upstream, PIM_RP_KEEPALIVE_PERIOD);
77e390e5	199	} else {
80c0d168	200	pim_upstream_keep_alive_timer_start (upstream, PIM_KEEPALIVE_PERIOD);
77e390e5 DS	201	}
	202	}
	203
	204	if (!(upstream->sptbit == PIM_UPSTREAM_SPTBIT_TRUE) &&
	205	!(*bits && PIM_REGISTER_NR_BIT)) {
	206	//decapsulate and forward the iner packet to
	207	//inherited_olist(S,G,rpt)
01d68c9b	208	}
77e390e5	209	} else {
80c0d168	210	pim_register_stop_send(src_addr);
77e390e5	211	}
01d68c9b DS	212
	213	return 1;
	214	}
	215
	216
	217	static int
	218	pim_register_send_test_packet (struct thread *t)
	219	{
	220	uint8_t *packet;
	221
	222	packet = THREAD_ARG(t);
	223
	224	*packet = 4;
	225
	226	return 1;
	227	}
	228
	229	/*
	230	* pim_register_send_test_packet
	231	*
	232	* Send a test packet to the RP from source, in group and pps packets per second
	233	*/
	234	void
	235	pim_register_send_test_packet_start (struct in_addr source,
	236	struct in_addr group,
	237	uint32_t pps)
	238	{
	239	uint8_t *packet = NULL;
	240
	241	THREAD_TIMER_MSEC_ON(master, send_test_packet_timer,
	242	pim_register_send_test_packet, packet, 1000/pps);
	243
	244	return;
	245	}