]>
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 DL |
27 | |
28 | #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED (1 << 0) | |
29 | #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED (2 << 0) | |
30 | ||
31 | #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED) | |
32 | #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED_UPDATED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED) | |
33 | ||
34 | #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED) | |
35 | #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED) | |
36 | ||
37 | #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED) | |
38 | #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED) | |
39 | ||
40 | /* | |
41 | RFC 4601: | |
42 | ||
43 | Metric Preference | |
44 | Preference value assigned to the unicast routing protocol that | |
45 | provided the route to the multicast source or Rendezvous-Point. | |
46 | ||
47 | Metric | |
48 | The unicast routing table metric associated with the route used to | |
49 | reach the multicast source or Rendezvous-Point. The metric is in | |
50 | units applicable to the unicast routing protocol used. | |
51 | */ | |
52 | struct pim_nexthop { | |
53 | struct interface *interface; /* RPF_interface(S) */ | |
54 | struct in_addr mrib_nexthop_addr; /* MRIB.next_hop(S) */ | |
55 | uint32_t mrib_metric_preference; /* MRIB.pref(S) */ | |
56 | uint32_t mrib_route_metric; /* MRIB.metric(S) */ | |
57 | }; | |
58 | ||
59 | struct pim_rpf { | |
60 | struct pim_nexthop source_nexthop; | |
61 | struct in_addr rpf_addr; /* RPF'(S,G) */ | |
62 | }; | |
63 | ||
64 | enum pim_rpf_result { | |
65 | PIM_RPF_OK = 0, | |
66 | PIM_RPF_CHANGED, | |
67 | PIM_RPF_FAILURE | |
68 | }; | |
69 | ||
70 | enum pim_upstream_state { | |
71 | PIM_UPSTREAM_NOTJOINED, | |
d7259eac DS |
72 | PIM_UPSTREAM_JOINED, |
73 | PIM_UPSTREAM_JOIN_PENDING, | |
74 | PIM_UPSTREAM_PRUNE, | |
12e41d03 DL |
75 | }; |
76 | ||
d99764f6 DS |
77 | enum pim_upstream_sptbit { |
78 | PIM_UPSTREAM_SPTBIT_FALSE, | |
79 | PIM_UPSTREAM_SPTBIT_TRUE | |
80 | }; | |
81 | ||
12e41d03 DL |
82 | /* |
83 | Upstream (S,G) channel in Joined state | |
84 | ||
85 | (S,G) in the "Not Joined" state is not represented | |
86 | ||
87 | See RFC 4601: 4.5.7. Sending (S,G) Join/Prune Message | |
88 | */ | |
89 | struct pim_upstream { | |
4d99418b | 90 | struct pim_upstream *parent; |
56638739 | 91 | int fhr; |
8f5f5e91 | 92 | struct in_addr upstream_addr;/* Who we are talking to */ |
4ed0af70 | 93 | struct prefix_sg sg; /* (S,G) group key */ |
12e41d03 DL |
94 | uint32_t flags; |
95 | struct channel_oil *channel_oil; | |
96 | ||
97 | enum pim_upstream_state join_state; | |
d99764f6 DS |
98 | enum pim_upstream_sptbit sptbit; |
99 | ||
12e41d03 DL |
100 | int ref_count; |
101 | ||
102 | struct pim_rpf rpf; | |
103 | ||
104 | struct thread *t_join_timer; | |
4a4c4a07 | 105 | |
2ddab288 DS |
106 | /* |
107 | * RST(S,G) | |
108 | */ | |
109 | struct thread *t_rs_timer; | |
110 | #define PIM_REGISTER_SUPPRESSION_PERIOD (60) | |
111 | #define PIM_REGISTER_PROBE_PERIOD (5) | |
112 | ||
4a4c4a07 DS |
113 | /* |
114 | * KAT(S,G) | |
115 | */ | |
116 | struct thread *t_ka_timer; | |
117 | #define PIM_KEEPALIVE_PERIOD (210) | |
118 | #define PIM_RP_KEEPALIVE_PERIOD ( 3 * qpim_register_suppress_time + qpim_register_probe_time ) | |
119 | ||
12e41d03 DL |
120 | int64_t state_transition; /* Record current state uptime */ |
121 | }; | |
122 | ||
123 | void pim_upstream_free(struct pim_upstream *up); | |
124 | void pim_upstream_delete(struct pim_upstream *up); | |
4ed0af70 DS |
125 | struct pim_upstream *pim_upstream_find (struct prefix_sg *sg); |
126 | struct pim_upstream *pim_upstream_find_non_any (struct prefix_sg *sg); | |
127 | struct pim_upstream *pim_upstream_add (struct prefix_sg *sg, | |
651d0f71 | 128 | struct interface *ifp); |
12e41d03 DL |
129 | void pim_upstream_del(struct pim_upstream *up); |
130 | ||
131 | int pim_upstream_evaluate_join_desired(struct pim_upstream *up); | |
132 | void pim_upstream_update_join_desired(struct pim_upstream *up); | |
133 | ||
134 | void pim_upstream_join_suppress(struct pim_upstream *up, | |
135 | struct in_addr rpf_addr, | |
136 | int holdtime); | |
137 | void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label, | |
138 | struct pim_upstream *up, | |
139 | struct in_addr rpf_addr); | |
140 | void pim_upstream_join_timer_restart(struct pim_upstream *up); | |
141 | void pim_upstream_rpf_genid_changed(struct in_addr neigh_addr); | |
142 | void pim_upstream_rpf_interface_changed(struct pim_upstream *up, | |
143 | struct interface *old_rpf_ifp); | |
144 | ||
145 | void pim_upstream_update_could_assert(struct pim_upstream *up); | |
146 | void pim_upstream_update_my_assert_metric(struct pim_upstream *up); | |
147 | ||
f14248dd | 148 | void pim_upstream_keep_alive_timer_start (struct pim_upstream *up, uint32_t time); |
cb40b272 | 149 | |
4ed0af70 | 150 | int pim_upstream_switch_to_spt_desired (struct prefix_sg *sg); |
ad410c6c | 151 | #define SwitchToSptDesired(sg) pim_upstream_switch_to_spt_desired (sg) |
cb40b272 | 152 | |
627ed2a3 DS |
153 | void pim_upstream_start_register_stop_timer (struct pim_upstream *up, int null_register); |
154 | ||
56638739 DS |
155 | void pim_upstream_send_join (struct pim_upstream *up); |
156 | ||
7fcdfb34 DS |
157 | void pim_upstream_switch (struct pim_upstream *up, enum pim_upstream_state new_state); |
158 | ||
d7259eac | 159 | const char *pim_upstream_state2str (struct pim_upstream *up); |
4fdc8f36 DS |
160 | |
161 | int pim_upstream_inherited_olist (struct pim_upstream *up); | |
12e41d03 | 162 | #endif /* PIM_UPSTREAM_H */ |