]>
Commit | Line | Data |
---|---|---|
12e41d03 | 1 | /* |
896014f4 DL |
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 | */ | |
12e41d03 DL |
19 | |
20 | #ifndef PIM_IGMP_H | |
21 | #define PIM_IGMP_H | |
22 | ||
23 | #include <netinet/in.h> | |
24 | ||
25 | #include <zebra.h> | |
26 | #include "vty.h" | |
27 | #include "linklist.h" | |
28 | ||
29 | /* | |
30 | The following sizes are likely to support | |
31 | any message sent within local MTU. | |
32 | */ | |
33 | #define PIM_IGMP_BUFSIZE_READ (20000) | |
34 | #define PIM_IGMP_BUFSIZE_WRITE (20000) | |
35 | ||
36 | #define PIM_IGMP_MEMBERSHIP_QUERY (0x11) | |
37 | #define PIM_IGMP_V1_MEMBERSHIP_REPORT (0x12) | |
38 | #define PIM_IGMP_V2_MEMBERSHIP_REPORT (0x16) | |
39 | #define PIM_IGMP_V2_LEAVE_GROUP (0x17) | |
4d9ad5dc MS |
40 | #define PIM_IGMP_MTRACE_RESPONSE (0x1E) |
41 | #define PIM_IGMP_MTRACE_QUERY_REQUEST (0x1F) | |
12e41d03 DL |
42 | #define PIM_IGMP_V3_MEMBERSHIP_REPORT (0x22) |
43 | ||
44 | #define IGMP_V3_REPORT_HEADER_SIZE (8) | |
45 | #define IGMP_V3_GROUP_RECORD_MIN_SIZE (8) | |
d62a17ae | 46 | #define IGMP_V3_MSG_MIN_SIZE \ |
47 | (IGMP_V3_REPORT_HEADER_SIZE + IGMP_V3_GROUP_RECORD_MIN_SIZE) | |
12e41d03 DL |
48 | #define IGMP_V12_MSG_SIZE (8) |
49 | ||
50 | #define IGMP_V3_GROUP_RECORD_TYPE_OFFSET (0) | |
51 | #define IGMP_V3_GROUP_RECORD_AUXDATALEN_OFFSET (1) | |
52 | #define IGMP_V3_GROUP_RECORD_NUMSOURCES_OFFSET (2) | |
53 | #define IGMP_V3_GROUP_RECORD_GROUP_OFFSET (4) | |
54 | #define IGMP_V3_GROUP_RECORD_SOURCE_OFFSET (8) | |
b05b72e8 | 55 | #define IGMP_CHECKSUM_OFFSET (2) |
12e41d03 DL |
56 | |
57 | /* RFC 3376: 8.1. Robustness Variable - Default: 2 */ | |
58 | #define IGMP_DEFAULT_ROBUSTNESS_VARIABLE (2) | |
59 | ||
60 | /* RFC 3376: 8.2. Query Interval - Default: 125 seconds */ | |
61 | #define IGMP_GENERAL_QUERY_INTERVAL (125) | |
62 | ||
63 | /* RFC 3376: 8.3. Query Response Interval - Default: 100 deciseconds */ | |
64 | #define IGMP_QUERY_MAX_RESPONSE_TIME_DSEC (100) | |
65 | ||
66 | /* RFC 3376: 8.8. Last Member Query Interval - Default: 10 deciseconds */ | |
67 | #define IGMP_SPECIFIC_QUERY_MAX_RESPONSE_TIME_DSEC (10) | |
68 | ||
b05b72e8 DW |
69 | #define IGMP_DEFAULT_VERSION (3) |
70 | ||
12e41d03 | 71 | struct igmp_join { |
d62a17ae | 72 | struct in_addr group_addr; |
73 | struct in_addr source_addr; | |
74 | int sock_fd; | |
75 | time_t sock_creation; | |
12e41d03 DL |
76 | }; |
77 | ||
78 | struct igmp_sock { | |
d62a17ae | 79 | int fd; |
80 | struct interface *interface; | |
81 | struct in_addr ifaddr; | |
82 | time_t sock_creation; | |
83 | ||
84 | struct thread *t_igmp_read; /* read: IGMP sockets */ | |
85 | struct thread | |
86 | *t_igmp_query_timer; /* timer: issue IGMP general queries */ | |
87 | struct thread *t_other_querier_timer; /* timer: other querier present */ | |
88 | ||
89 | int querier_query_interval; /* QQI */ | |
90 | int querier_robustness_variable; /* QRV */ | |
91 | int startup_query_count; | |
92 | ||
f83f3966 MS |
93 | bool mtrace_only; |
94 | ||
d62a17ae | 95 | struct list *igmp_group_list; /* list of struct igmp_group */ |
96 | struct hash *igmp_group_hash; | |
12e41d03 DL |
97 | }; |
98 | ||
99 | struct igmp_sock *pim_igmp_sock_lookup_ifaddr(struct list *igmp_sock_list, | |
100 | struct in_addr ifaddr); | |
d62a17ae | 101 | struct igmp_sock *igmp_sock_lookup_by_fd(struct list *igmp_sock_list, int fd); |
12e41d03 DL |
102 | struct igmp_sock *pim_igmp_sock_add(struct list *igmp_sock_list, |
103 | struct in_addr ifaddr, | |
f83f3966 MS |
104 | struct interface *ifp, |
105 | bool mtrace_only); | |
12e41d03 DL |
106 | void igmp_sock_delete(struct igmp_sock *igmp); |
107 | void igmp_sock_free(struct igmp_sock *igmp); | |
d62a17ae | 108 | void igmp_sock_delete_all(struct interface *ifp); |
12e41d03 DL |
109 | int pim_igmp_packet(struct igmp_sock *igmp, char *buf, size_t len); |
110 | ||
111 | void pim_igmp_general_query_on(struct igmp_sock *igmp); | |
112 | void pim_igmp_general_query_off(struct igmp_sock *igmp); | |
113 | void pim_igmp_other_querier_timer_on(struct igmp_sock *igmp); | |
114 | void pim_igmp_other_querier_timer_off(struct igmp_sock *igmp); | |
115 | ||
116 | #define IGMP_SOURCE_MASK_FORWARDING (1 << 0) | |
117 | #define IGMP_SOURCE_MASK_DELETE (1 << 1) | |
118 | #define IGMP_SOURCE_MASK_SEND (1 << 2) | |
119 | #define IGMP_SOURCE_TEST_FORWARDING(flags) ((flags) & IGMP_SOURCE_MASK_FORWARDING) | |
120 | #define IGMP_SOURCE_TEST_DELETE(flags) ((flags) & IGMP_SOURCE_MASK_DELETE) | |
121 | #define IGMP_SOURCE_TEST_SEND(flags) ((flags) & IGMP_SOURCE_MASK_SEND) | |
122 | #define IGMP_SOURCE_DO_FORWARDING(flags) ((flags) |= IGMP_SOURCE_MASK_FORWARDING) | |
123 | #define IGMP_SOURCE_DO_DELETE(flags) ((flags) |= IGMP_SOURCE_MASK_DELETE) | |
124 | #define IGMP_SOURCE_DO_SEND(flags) ((flags) |= IGMP_SOURCE_MASK_SEND) | |
125 | #define IGMP_SOURCE_DONT_FORWARDING(flags) ((flags) &= ~IGMP_SOURCE_MASK_FORWARDING) | |
126 | #define IGMP_SOURCE_DONT_DELETE(flags) ((flags) &= ~IGMP_SOURCE_MASK_DELETE) | |
127 | #define IGMP_SOURCE_DONT_SEND(flags) ((flags) &= ~IGMP_SOURCE_MASK_SEND) | |
128 | ||
129 | struct igmp_source { | |
d62a17ae | 130 | struct in_addr source_addr; |
131 | struct thread *t_source_timer; | |
132 | struct igmp_group *source_group; /* back pointer */ | |
133 | time_t source_creation; | |
134 | uint32_t source_flags; | |
135 | struct channel_oil *source_channel_oil; | |
136 | ||
137 | /* | |
138 | RFC 3376: 6.6.3.2. Building and Sending Group and Source Specific | |
139 | Queries | |
140 | */ | |
141 | int source_query_retransmit_count; | |
12e41d03 DL |
142 | }; |
143 | ||
144 | struct igmp_group { | |
d62a17ae | 145 | /* |
146 | RFC 3376: 6.2.2. Definition of Group Timers | |
147 | ||
148 | The group timer is only used when a group is in EXCLUDE mode and it | |
149 | represents the time for the *filter-mode* of the group to expire and | |
150 | switch to INCLUDE mode. | |
151 | */ | |
152 | struct thread *t_group_timer; | |
153 | ||
154 | /* Shared between group-specific and | |
155 | group-and-source-specific retransmissions */ | |
156 | struct thread *t_group_query_retransmit_timer; | |
157 | ||
158 | /* Counter exclusive for group-specific retransmissions | |
159 | (not used by group-and-source-specific retransmissions, | |
160 | since sources have their counters) */ | |
161 | int group_specific_query_retransmit_count; | |
162 | ||
163 | /* compatibility mode - igmp v1, v2 or v3 */ | |
164 | int igmp_version; | |
165 | ||
166 | struct in_addr group_addr; | |
167 | int group_filtermode_isexcl; /* 0=INCLUDE, 1=EXCLUDE */ | |
168 | struct list *group_source_list; /* list of struct igmp_source */ | |
169 | time_t group_creation; | |
170 | struct igmp_sock *group_igmp_sock; /* back pointer */ | |
171 | int64_t last_igmp_v1_report_dsec; | |
172 | int64_t last_igmp_v2_report_dsec; | |
12e41d03 DL |
173 | }; |
174 | ||
d62a17ae | 175 | struct igmp_group *find_group_by_addr(struct igmp_sock *igmp, |
176 | struct in_addr group_addr); | |
12e41d03 | 177 | struct igmp_group *igmp_add_group_by_addr(struct igmp_sock *igmp, |
915c13b3 | 178 | struct in_addr group_addr); |
12e41d03 DL |
179 | |
180 | void igmp_group_delete_empty_include(struct igmp_group *group); | |
181 | ||
182 | void igmp_startup_mode_on(struct igmp_sock *igmp); | |
183 | ||
d62a17ae | 184 | void igmp_group_timer_on(struct igmp_group *group, long interval_msec, |
185 | const char *ifname); | |
186 | ||
187 | struct igmp_source *source_new(struct igmp_group *group, | |
188 | struct in_addr src_addr); | |
189 | ||
190 | void igmp_send_query(int igmp_version, struct igmp_group *group, int fd, | |
191 | const char *ifname, char *query_buf, int query_buf_size, | |
192 | int num_sources, struct in_addr dst_addr, | |
193 | struct in_addr group_addr, | |
194 | int query_max_response_time_dsec, uint8_t s_flag, | |
195 | uint8_t querier_robustness_variable, | |
196 | uint16_t querier_query_interval); | |
12e41d03 | 197 | #endif /* PIM_IGMP_H */ |