]> git.proxmox.com Git - mirror_frr.git/blob - pimd/pim_ifchannel.h
lib: enforce vrf_name_to_id by returning default_vrf when name is null
[mirror_frr.git] / pimd / pim_ifchannel.h
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 along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20 #ifndef PIM_IFCHANNEL_H
21 #define PIM_IFCHANNEL_H
22
23 #include <zebra.h>
24
25 #include "if.h"
26 #include "prefix.h"
27
28 struct pim_ifchannel;
29 #include "pim_upstream.h"
30
31 enum pim_ifmembership { PIM_IFMEMBERSHIP_NOINFO, PIM_IFMEMBERSHIP_INCLUDE };
32
33 enum pim_ifjoin_state {
34 PIM_IFJOIN_NOINFO,
35 PIM_IFJOIN_JOIN,
36 PIM_IFJOIN_PRUNE,
37 PIM_IFJOIN_PRUNE_PENDING,
38 PIM_IFJOIN_PRUNE_TMP,
39 PIM_IFJOIN_PRUNE_PENDING_TMP,
40 };
41
42 enum pim_ifassert_state {
43 PIM_IFASSERT_NOINFO,
44 PIM_IFASSERT_I_AM_WINNER,
45 PIM_IFASSERT_I_AM_LOSER
46 };
47
48 struct pim_assert_metric {
49 uint32_t rpt_bit_flag;
50 uint32_t metric_preference;
51 uint32_t route_metric;
52 struct in_addr ip_address; /* neighbor router that sourced the Assert
53 message */
54 };
55
56 /*
57 Flag to detect change in CouldAssert(S,G,I)
58 */
59 #define PIM_IF_FLAG_MASK_COULD_ASSERT (1 << 0)
60 #define PIM_IF_FLAG_TEST_COULD_ASSERT(flags) ((flags) & PIM_IF_FLAG_MASK_COULD_ASSERT)
61 #define PIM_IF_FLAG_SET_COULD_ASSERT(flags) ((flags) |= PIM_IF_FLAG_MASK_COULD_ASSERT)
62 #define PIM_IF_FLAG_UNSET_COULD_ASSERT(flags) ((flags) &= ~PIM_IF_FLAG_MASK_COULD_ASSERT)
63 /*
64 Flag to detect change in AssertTrackingDesired(S,G,I)
65 */
66 #define PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED (1 << 1)
67 #define PIM_IF_FLAG_TEST_ASSERT_TRACKING_DESIRED(flags) ((flags) & PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED)
68 #define PIM_IF_FLAG_SET_ASSERT_TRACKING_DESIRED(flags) ((flags) |= PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED)
69 #define PIM_IF_FLAG_UNSET_ASSERT_TRACKING_DESIRED(flags) ((flags) &= ~PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED)
70
71 /*
72 * Flat to tell us if the ifchannel is (S,G,rpt)
73 */
74 #define PIM_IF_FLAG_MASK_S_G_RPT (1 << 2)
75 #define PIM_IF_FLAG_TEST_S_G_RPT(flags) ((flags) & PIM_IF_FLAG_MASK_S_G_RPT)
76 #define PIM_IF_FLAG_SET_S_G_RPT(flags) ((flags) |= PIM_IF_FLAG_MASK_S_G_RPT)
77 #define PIM_IF_FLAG_UNSET_S_G_RPT(flags) ((flags) &= ~PIM_IF_FLAG_MASK_S_G_RPT)
78
79 /*
80 Per-interface (S,G) state
81 */
82 struct pim_ifchannel {
83 RB_ENTRY(rb_ifchannel) pim_ifp_rb;
84
85 struct pim_ifchannel *parent;
86 struct list *sources;
87 struct prefix_sg sg;
88 char sg_str[PIM_SG_LEN];
89 struct interface *interface; /* backpointer to interface */
90 uint32_t flags;
91
92 /* IGMPv3 determined interface has local members for (S,G) ? */
93 enum pim_ifmembership local_ifmembership;
94
95 /* Per-interface (S,G) Join/Prune State (Section 4.1.4 of RFC4601) */
96 enum pim_ifjoin_state ifjoin_state;
97 struct thread *t_ifjoin_expiry_timer;
98 struct thread *t_ifjoin_prune_pending_timer;
99 int64_t ifjoin_creation; /* Record uptime of ifjoin state */
100
101 /* Per-interface (S,G) Assert State (Section 4.6.1 of RFC4601) */
102 enum pim_ifassert_state ifassert_state;
103 struct thread *t_ifassert_timer;
104 struct in_addr ifassert_winner;
105 struct pim_assert_metric ifassert_winner_metric;
106 int64_t ifassert_creation; /* Record uptime of ifassert state */
107 struct pim_assert_metric ifassert_my_metric;
108
109 /* Upstream (S,G) state */
110 struct pim_upstream *upstream;
111 };
112
113 RB_HEAD(pim_ifchannel_rb, pim_ifchannel);
114 RB_PROTOTYPE(pim_ifchannel_rb, pim_ifchannel, pim_ifp_rb,
115 pim_ifchannel_compare);
116
117 void pim_ifchannel_delete(struct pim_ifchannel *ch);
118 void pim_ifchannel_delete_all(struct interface *ifp);
119 void pim_ifchannel_membership_clear(struct interface *ifp);
120 void pim_ifchannel_delete_on_noinfo(struct interface *ifp);
121 struct pim_ifchannel *pim_ifchannel_find(struct interface *ifp,
122 struct prefix_sg *sg);
123 struct pim_ifchannel *pim_ifchannel_add(struct interface *ifp,
124 struct prefix_sg *sg, uint8_t ch_flags,
125 int up_flags);
126 void pim_ifchannel_join_add(struct interface *ifp, struct in_addr neigh_addr,
127 struct in_addr upstream, struct prefix_sg *sg,
128 uint8_t source_flags, uint16_t holdtime);
129 void pim_ifchannel_prune(struct interface *ifp, struct in_addr upstream,
130 struct prefix_sg *sg, uint8_t source_flags,
131 uint16_t holdtime);
132 int pim_ifchannel_local_membership_add(struct interface *ifp,
133 struct prefix_sg *sg);
134 void pim_ifchannel_local_membership_del(struct interface *ifp,
135 struct prefix_sg *sg);
136
137 void pim_ifchannel_ifjoin_switch(const char *caller, struct pim_ifchannel *ch,
138 enum pim_ifjoin_state new_state);
139 const char *pim_ifchannel_ifjoin_name(enum pim_ifjoin_state ifjoin_state,
140 int flags);
141 const char *pim_ifchannel_ifassert_name(enum pim_ifassert_state ifassert_state);
142
143 int pim_ifchannel_isin_oiflist(struct pim_ifchannel *ch);
144
145 void reset_ifassert_state(struct pim_ifchannel *ch);
146
147 void pim_ifchannel_update_could_assert(struct pim_ifchannel *ch);
148 void pim_ifchannel_update_my_assert_metric(struct pim_ifchannel *ch);
149 void pim_ifchannel_update_assert_tracking_desired(struct pim_ifchannel *ch);
150
151 void pim_ifchannel_scan_forward_start(struct interface *new_ifp);
152 void pim_ifchannel_set_star_g_join_state(struct pim_ifchannel *ch, int eom,
153 uint8_t join);
154
155 int pim_ifchannel_compare(const struct pim_ifchannel *ch1,
156 const struct pim_ifchannel *ch2);
157
158 unsigned int pim_ifchannel_hash_key(void *arg);
159 #endif /* PIM_IFCHANNEL_H */