[mirror_frr.git] / pimd / pim_upstream.h

/*
  PIM for Quagga
  Copyright (C) 2008  Everton da Silva Marques

  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
  
*/

#ifndef PIM_UPSTREAM_H
#define PIM_UPSTREAM_H

#include <zebra.h>
#include <prefix.h>

#include <pimd/pim_rpf.h>

#define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED         (1 << 0)
#define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED (1 << 1)
#define PIM_UPSTREAM_FLAG_MASK_FHR                     (1 << 2)
#define PIM_UPSTREAM_FLAG_MASK_SRC_IGMP                (1 << 3)
#define PIM_UPSTREAM_FLAG_MASK_SRC_PIM                 (1 << 4)
#define PIM_UPSTREAM_FLAG_MASK_SRC_STREAM              (1 << 5)
#define PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM     (1 << 6)

#define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
#define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED_UPDATED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
#define PIM_UPSTREAM_FLAG_TEST_FHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_FHR)
#define PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
#define PIM_UPSTREAM_FLAG_TEST_SRC_PIM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
#define PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
#define PIM_UPSTREAM_FLAG_TEST_CREATED_BY_UPSTREAM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM)

#define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
#define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
#define PIM_UPSTREAM_FLAG_SET_FHR(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_FHR)
#define PIM_UPSTREAM_FLAG_SET_SRC_IGMP(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
#define PIM_UPSTREAM_FLAG_SET_SRC_PIM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
#define PIM_UPSTREAM_FLAG_SET_SRC_STREAM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
#define PIM_UPSTREAM_FLAG_SET_CREATED_BY_UPSTREAM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM)

#define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
#define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
#define PIM_UPSTREAM_FLAG_UNSET_FHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_FHR)
#define PIM_UPSTREAM_FLAG_UNSET_SRC_IGMP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
#define PIM_UPSTREAM_FLAG_UNSET_SRC_PIM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
#define PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
#define PIM_UPSTREAM_FLAG_UNSET_CREATED_BY_UPSTREAM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM)

enum pim_upstream_state {
  PIM_UPSTREAM_NOTJOINED,
  PIM_UPSTREAM_JOINED,
  PIM_UPSTREAM_JOIN_PENDING,
  PIM_UPSTREAM_PRUNE,
};

enum pim_upstream_sptbit {
  PIM_UPSTREAM_SPTBIT_FALSE,
  PIM_UPSTREAM_SPTBIT_TRUE
};

/*
  Upstream (S,G) channel in Joined state
  
  (S,G) in the "Not Joined" state is not represented
  
  See RFC 4601: 4.5.7.  Sending (S,G) Join/Prune Message
*/
struct pim_upstream {
  struct pim_upstream      *parent;
  struct in_addr           upstream_addr;/* Who we are talking to */
  struct in_addr           upstream_register; /*Who we received a register from*/
  struct prefix_sg         sg;           /* (S,G) group key */
  uint32_t                 flags;
  struct channel_oil      *channel_oil;
  struct list             *sources;

  enum pim_upstream_state  join_state;
  enum pim_upstream_sptbit sptbit;

  int                      ref_count;

  struct pim_rpf           rpf;

  struct thread           *t_join_timer;

  /*
   * RST(S,G)
   */
  struct thread           *t_rs_timer;
#define PIM_REGISTER_SUPPRESSION_PERIOD (60)
#define PIM_REGISTER_PROBE_PERIOD        (5)

  /*
   * KAT(S,G)
   */
  struct thread           *t_ka_timer;
#define PIM_KEEPALIVE_PERIOD  (210)
#define PIM_RP_KEEPALIVE_PERIOD ( 3 * qpim_register_suppress_time + qpim_register_probe_time )

  int64_t                  state_transition; /* Record current state uptime */
};

struct list *pim_upstream_list;
struct hash *pim_upstream_hash;

void pim_upstream_free(struct pim_upstream *up);
struct pim_upstream *pim_upstream_find (struct prefix_sg *sg);
struct pim_upstream *pim_upstream_add (struct prefix_sg *sg,
				       struct interface *ifp, int flags,
				       const char *name);
void pim_upstream_del(struct pim_upstream *up, const char *name);

int pim_upstream_evaluate_join_desired(struct pim_upstream *up);
void pim_upstream_update_join_desired(struct pim_upstream *up);

void pim_upstream_join_suppress(struct pim_upstream *up,
				struct in_addr rpf_addr,
				int holdtime);
void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label,
						    struct pim_upstream *up,
						    struct in_addr rpf_addr);
void pim_upstream_join_timer_restart(struct pim_upstream *up);
void pim_upstream_rpf_genid_changed(struct in_addr neigh_addr);
void pim_upstream_rpf_interface_changed(struct pim_upstream *up,
					struct interface *old_rpf_ifp);

void pim_upstream_update_could_assert(struct pim_upstream *up);
void pim_upstream_update_my_assert_metric(struct pim_upstream *up);

void pim_upstream_keep_alive_timer_start (struct pim_upstream *up, uint32_t time);

int pim_upstream_switch_to_spt_desired (struct prefix_sg *sg);
#define SwitchToSptDesired(sg) pim_upstream_switch_to_spt_desired (sg)

void pim_upstream_start_register_stop_timer (struct pim_upstream *up, int null_register);

void pim_upstream_send_join (struct pim_upstream *up);

void pim_upstream_switch (struct pim_upstream *up, enum pim_upstream_state new_state);

const char *pim_upstream_state2str (enum pim_upstream_state join_state);

int pim_upstream_inherited_olist (struct pim_upstream *up);

void pim_upstream_find_new_rpf (void);

void pim_upstream_init (void);
void pim_upstream_terminate (void);
#endif /* PIM_UPSTREAM_H */
Commit	Line	Data
12e41d03 DL	1	/*
	2	PIM for Quagga
	3	Copyright (C) 2008 Everton da Silva Marques
	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
	15	You should have received a copy of the GNU General Public License
	16	along with this program; see the file COPYING; if not, write to the
	17	Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
	18	MA 02110-1301 USA
	19
12e41d03 DL	20	*/
	21
	22	#ifndef PIM_UPSTREAM_H
	23	#define PIM_UPSTREAM_H
	24
	25	#include <zebra.h>
05e451f8	26	#include <prefix.h>
12e41d03	27
f9717886	28	#include <pimd/pim_rpf.h>
bfea315d	29
12e41d03	30	#define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED (1 << 0)
ca973133 DS	31	#define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED (1 << 1)
	32	#define PIM_UPSTREAM_FLAG_MASK_FHR (1 << 2)
	33	#define PIM_UPSTREAM_FLAG_MASK_SRC_IGMP (1 << 3)
	34	#define PIM_UPSTREAM_FLAG_MASK_SRC_PIM (1 << 4)
	35	#define PIM_UPSTREAM_FLAG_MASK_SRC_STREAM (1 << 5)
5ce79466	36	#define PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM (1 << 6)
12e41d03 DL	37
	38	#define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
	39	#define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED_UPDATED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
69ff3706	40	#define PIM_UPSTREAM_FLAG_TEST_FHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_FHR)
1d3a62cd DS	41	#define PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
	42	#define PIM_UPSTREAM_FLAG_TEST_SRC_PIM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
	43	#define PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
5ce79466	44	#define PIM_UPSTREAM_FLAG_TEST_CREATED_BY_UPSTREAM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM)
12e41d03 DL	45
	46	#define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(flags) ((flags) \|= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
	47	#define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) \|= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
69ff3706	48	#define PIM_UPSTREAM_FLAG_SET_FHR(flags) ((flags) \|= PIM_UPSTREAM_FLAG_MASK_FHR)
1d3a62cd DS	49	#define PIM_UPSTREAM_FLAG_SET_SRC_IGMP(flags) ((flags) \|= PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
	50	#define PIM_UPSTREAM_FLAG_SET_SRC_PIM(flags) ((flags) \|= PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
	51	#define PIM_UPSTREAM_FLAG_SET_SRC_STREAM(flags) ((flags) \|= PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
5ce79466	52	#define PIM_UPSTREAM_FLAG_SET_CREATED_BY_UPSTREAM(flags) ((flags) \|= PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM)
12e41d03 DL	53
	54	#define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
	55	#define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
69ff3706	56	#define PIM_UPSTREAM_FLAG_UNSET_FHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_FHR)
1d3a62cd DS	57	#define PIM_UPSTREAM_FLAG_UNSET_SRC_IGMP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
	58	#define PIM_UPSTREAM_FLAG_UNSET_SRC_PIM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
	59	#define PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
5ce79466	60	#define PIM_UPSTREAM_FLAG_UNSET_CREATED_BY_UPSTREAM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_CREATED_BY_UPSTREAM)
12e41d03	61
12e41d03 DL	62	enum pim_upstream_state {
12e41d03 DL	63	PIM_UPSTREAM_NOTJOINED,
d7259eac DS	64	PIM_UPSTREAM_JOINED,
	65	PIM_UPSTREAM_JOIN_PENDING,
	66	PIM_UPSTREAM_PRUNE,
12e41d03 DL	67	};
12e41d03 DL	68
d99764f6 DS	69	enum pim_upstream_sptbit {
	70	PIM_UPSTREAM_SPTBIT_FALSE,
	71	PIM_UPSTREAM_SPTBIT_TRUE
	72	};
	73
12e41d03 DL	74	/*
	75	Upstream (S,G) channel in Joined state
	76
	77	(S,G) in the "Not Joined" state is not represented
	78
	79	See RFC 4601: 4.5.7. Sending (S,G) Join/Prune Message
	80	*/
	81	struct pim_upstream {
4d99418b	82	struct pim_upstream *parent;
8f5f5e91	83	struct in_addr upstream_addr;/* Who we are talking to */
8e38a2cf	84	struct in_addr upstream_register; /Who we received a register from/
4ed0af70	85	struct prefix_sg sg; /* (S,G) group key */
12e41d03 DL	86	uint32_t flags;
12e41d03 DL	87	struct channel_oil *channel_oil;
03417ccd	88	struct list *sources;
12e41d03 DL	89
12e41d03 DL	90	enum pim_upstream_state join_state;
d99764f6 DS	91	enum pim_upstream_sptbit sptbit;
d99764f6 DS	92
12e41d03 DL	93	int ref_count;
	94
	95	struct pim_rpf rpf;
	96
	97	struct thread *t_join_timer;
4a4c4a07	98
2ddab288 DS	99	/*
	100	* RST(S,G)
	101	*/
	102	struct thread *t_rs_timer;
	103	#define PIM_REGISTER_SUPPRESSION_PERIOD (60)
	104	#define PIM_REGISTER_PROBE_PERIOD (5)
	105
4a4c4a07 DS	106	/*
	107	* KAT(S,G)
	108	*/
	109	struct thread *t_ka_timer;
	110	#define PIM_KEEPALIVE_PERIOD (210)
	111	#define PIM_RP_KEEPALIVE_PERIOD ( 3 * qpim_register_suppress_time + qpim_register_probe_time )
	112
12e41d03 DL	113	int64_t state_transition; /* Record current state uptime */
	114	};
	115
0f588989 DS	116	struct list *pim_upstream_list;
	117	struct hash *pim_upstream_hash;
	118
12e41d03	119	void pim_upstream_free(struct pim_upstream *up);
4ed0af70	120	struct pim_upstream pim_upstream_find (struct prefix_sg sg);
4ed0af70	121	struct pim_upstream pim_upstream_add (struct prefix_sg sg,
e5905a3b DS	122	struct interface *ifp, int flags,
	123	const char *name);
	124	void pim_upstream_del(struct pim_upstream up, const char name);
12e41d03 DL	125
	126	int pim_upstream_evaluate_join_desired(struct pim_upstream *up);
	127	void pim_upstream_update_join_desired(struct pim_upstream *up);
	128
	129	void pim_upstream_join_suppress(struct pim_upstream *up,
	130	struct in_addr rpf_addr,
	131	int holdtime);
	132	void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label,
	133	struct pim_upstream *up,
	134	struct in_addr rpf_addr);
	135	void pim_upstream_join_timer_restart(struct pim_upstream *up);
	136	void pim_upstream_rpf_genid_changed(struct in_addr neigh_addr);
	137	void pim_upstream_rpf_interface_changed(struct pim_upstream *up,
	138	struct interface *old_rpf_ifp);
	139
	140	void pim_upstream_update_could_assert(struct pim_upstream *up);
	141	void pim_upstream_update_my_assert_metric(struct pim_upstream *up);
	142
f14248dd	143	void pim_upstream_keep_alive_timer_start (struct pim_upstream *up, uint32_t time);
cb40b272	144
4ed0af70	145	int pim_upstream_switch_to_spt_desired (struct prefix_sg *sg);
ad410c6c	146	#define SwitchToSptDesired(sg) pim_upstream_switch_to_spt_desired (sg)
cb40b272	147
627ed2a3 DS	148	void pim_upstream_start_register_stop_timer (struct pim_upstream *up, int null_register);
627ed2a3 DS	149
56638739 DS	150	void pim_upstream_send_join (struct pim_upstream *up);
56638739 DS	151
7fcdfb34 DS	152	void pim_upstream_switch (struct pim_upstream *up, enum pim_upstream_state new_state);
7fcdfb34 DS	153
c9802954	154	const char *pim_upstream_state2str (enum pim_upstream_state join_state);
4fdc8f36 DS	155
4fdc8f36 DS	156	int pim_upstream_inherited_olist (struct pim_upstream *up);
d3dd1804 DS	157
	158	void pim_upstream_find_new_rpf (void);
	159
0f588989 DS	160	void pim_upstream_init (void);
0f588989 DS	161	void pim_upstream_terminate (void);
12e41d03	162	#endif /* PIM_UPSTREAM_H */