3 Copyright (C) 2008 Everton da Silva Marques
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.
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.
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,
21 #ifndef PIM_UPSTREAM_H
22 #define PIM_UPSTREAM_H
26 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED (1 << 0)
27 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED (2 << 0)
29 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
30 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED_UPDATED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
32 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
33 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
35 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
36 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
42 Preference value assigned to the unicast routing protocol that
43 provided the route to the multicast source or Rendezvous-Point.
46 The unicast routing table metric associated with the route used to
47 reach the multicast source or Rendezvous-Point. The metric is in
48 units applicable to the unicast routing protocol used.
51 struct interface
*interface
; /* RPF_interface(S) */
52 struct in_addr mrib_nexthop_addr
; /* MRIB.next_hop(S) */
53 uint32_t mrib_metric_preference
; /* MRIB.pref(S) */
54 uint32_t mrib_route_metric
; /* MRIB.metric(S) */
58 struct pim_nexthop source_nexthop
;
59 struct in_addr rpf_addr
; /* RPF'(S,G) */
68 enum pim_upstream_state
{
69 PIM_UPSTREAM_NOTJOINED
,
73 enum pim_upstream_sptbit
{
74 PIM_UPSTREAM_SPTBIT_FALSE
,
75 PIM_UPSTREAM_SPTBIT_TRUE
79 Upstream (S,G) channel in Joined state
81 (S,G) in the "Not Joined" state is not represented
83 See RFC 4601: 4.5.7. Sending (S,G) Join/Prune Message
86 struct in_addr upstream_addr
;/* Who we are talking to */
87 struct in_addr source_addr
; /* (S,G) source key */
88 struct in_addr group_addr
; /* (S,G) group key */
90 struct channel_oil
*channel_oil
;
92 enum pim_upstream_state join_state
;
93 enum pim_upstream_sptbit sptbit
;
99 struct thread
*t_join_timer
;
104 struct thread
*t_ka_timer
;
105 #define PIM_KEEPALIVE_PERIOD (210)
106 #define PIM_RP_KEEPALIVE_PERIOD ( 3 * qpim_register_suppress_time + qpim_register_probe_time )
108 int64_t state_transition
; /* Record current state uptime */
111 void pim_upstream_free(struct pim_upstream
*up
);
112 void pim_upstream_delete(struct pim_upstream
*up
);
113 struct pim_upstream
*pim_upstream_find(struct in_addr source_addr
,
114 struct in_addr group_addr
);
115 struct pim_upstream
*pim_upstream_add(struct in_addr source_addr
,
116 struct in_addr group_addr
,
117 struct interface
*ifp
);
118 void pim_upstream_del(struct pim_upstream
*up
);
120 int pim_upstream_evaluate_join_desired(struct pim_upstream
*up
);
121 void pim_upstream_update_join_desired(struct pim_upstream
*up
);
123 void pim_upstream_join_suppress(struct pim_upstream
*up
,
124 struct in_addr rpf_addr
,
126 void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label
,
127 struct pim_upstream
*up
,
128 struct in_addr rpf_addr
);
129 void pim_upstream_join_timer_restart(struct pim_upstream
*up
);
130 void pim_upstream_rpf_genid_changed(struct in_addr neigh_addr
);
131 void pim_upstream_rpf_interface_changed(struct pim_upstream
*up
,
132 struct interface
*old_rpf_ifp
);
134 void pim_upstream_update_could_assert(struct pim_upstream
*up
);
135 void pim_upstream_update_my_assert_metric(struct pim_upstream
*up
);
137 void pim_upstream_keep_alive_timer_start (struct pim_upstream
*up
, uint32_t time
);
139 int pim_upstream_switch_to_spt_desired (struct in_addr source
, struct in_addr group
);
140 #define SwitchToSptDesired(S,G) pim_upstream_switch_to_spt_desired ((S), (G))
142 #endif /* PIM_UPSTREAM_H */