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 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
23 #include <netinet/in.h>
28 #include "pim_igmp_stats.h"
32 The following sizes are likely to support
33 any message sent within local MTU.
35 #define PIM_IGMP_BUFSIZE_READ (20000)
36 #define PIM_IGMP_BUFSIZE_WRITE (20000)
38 #define PIM_IGMP_MEMBERSHIP_QUERY (0x11)
39 #define PIM_IGMP_V1_MEMBERSHIP_REPORT (0x12)
40 #define PIM_IGMP_V2_MEMBERSHIP_REPORT (0x16)
41 #define PIM_IGMP_V2_LEAVE_GROUP (0x17)
42 #define PIM_IGMP_MTRACE_RESPONSE (0x1E)
43 #define PIM_IGMP_MTRACE_QUERY_REQUEST (0x1F)
44 #define PIM_IGMP_V3_MEMBERSHIP_REPORT (0x22)
46 #define IGMP_V3_REPORT_HEADER_SIZE (8)
47 #define IGMP_V3_GROUP_RECORD_MIN_SIZE (8)
48 #define IGMP_V3_MSG_MIN_SIZE \
49 (IGMP_V3_REPORT_HEADER_SIZE + IGMP_V3_GROUP_RECORD_MIN_SIZE)
50 #define IGMP_V12_MSG_SIZE (8)
52 #define IGMP_V3_GROUP_RECORD_TYPE_OFFSET (0)
53 #define IGMP_V3_GROUP_RECORD_AUXDATALEN_OFFSET (1)
54 #define IGMP_V3_GROUP_RECORD_NUMSOURCES_OFFSET (2)
55 #define IGMP_V3_GROUP_RECORD_GROUP_OFFSET (4)
56 #define IGMP_V3_GROUP_RECORD_SOURCE_OFFSET (8)
57 #define IGMP_CHECKSUM_OFFSET (2)
59 /* RFC 3376: 8.1. Robustness Variable - Default: 2 */
60 #define IGMP_DEFAULT_ROBUSTNESS_VARIABLE (2)
62 /* RFC 3376: 8.2. Query Interval - Default: 125 seconds */
63 #define IGMP_GENERAL_QUERY_INTERVAL (125)
65 /* RFC 3376: 8.3. Query Response Interval - Default: 100 deciseconds */
66 #define IGMP_QUERY_MAX_RESPONSE_TIME_DSEC (100)
68 /* RFC 3376: 8.8. Last Member Query Interval - Default: 10 deciseconds */
69 #define IGMP_SPECIFIC_QUERY_MAX_RESPONSE_TIME_DSEC (10)
71 #define IGMP_DEFAULT_VERSION (3)
73 #define IGMP_GET_INT16(ptr, output) \
75 output = *(ptr) << 8; \
76 output |= *((ptr) + 1); \
88 struct interface
*interface
;
92 struct thread
*t_igmp_read
; /* read: IGMP sockets */
94 *t_igmp_query_timer
; /* timer: issue IGMP general queries */
95 struct thread
*t_other_querier_timer
; /* timer: other querier present */
96 pim_addr querier_addr
; /* IP address of the querier */
97 int querier_query_interval
; /* QQI */
98 int querier_robustness_variable
; /* QRV */
99 int startup_query_count
;
103 struct igmp_stats rx_stats
;
106 struct pim_interface
;
108 void pim_igmp_if_init(struct pim_interface
*pim_ifp
, struct interface
*ifp
);
109 void pim_igmp_if_reset(struct pim_interface
*pim_ifp
);
110 void pim_igmp_if_fini(struct pim_interface
*pim_ifp
);
112 struct gm_sock
*pim_igmp_sock_lookup_ifaddr(struct list
*igmp_sock_list
,
113 struct in_addr ifaddr
);
114 struct gm_sock
*pim_igmp_sock_add(struct list
*igmp_sock_list
,
115 struct in_addr ifaddr
, struct interface
*ifp
,
117 void igmp_sock_delete(struct gm_sock
*igmp
);
118 void igmp_sock_free(struct gm_sock
*igmp
);
119 void igmp_sock_delete_all(struct interface
*ifp
);
120 int pim_igmp_packet(struct gm_sock
*igmp
, char *buf
, size_t len
);
121 bool pim_igmp_verify_header(struct ip
*ip_hdr
, size_t len
, size_t *ip_hlen
);
122 void pim_igmp_general_query_on(struct gm_sock
*igmp
);
123 void pim_igmp_general_query_off(struct gm_sock
*igmp
);
124 void pim_igmp_other_querier_timer_on(struct gm_sock
*igmp
);
125 void pim_igmp_other_querier_timer_off(struct gm_sock
*igmp
);
127 int igmp_validate_checksum(char *igmp_msg
, int igmp_msg_len
);
129 #define IGMP_SOURCE_MASK_FORWARDING (1 << 0)
130 #define IGMP_SOURCE_MASK_DELETE (1 << 1)
131 #define IGMP_SOURCE_MASK_SEND (1 << 2)
132 #define IGMP_SOURCE_TEST_FORWARDING(flags) ((flags) & IGMP_SOURCE_MASK_FORWARDING)
133 #define IGMP_SOURCE_TEST_DELETE(flags) ((flags) & IGMP_SOURCE_MASK_DELETE)
134 #define IGMP_SOURCE_TEST_SEND(flags) ((flags) & IGMP_SOURCE_MASK_SEND)
135 #define IGMP_SOURCE_DO_FORWARDING(flags) ((flags) |= IGMP_SOURCE_MASK_FORWARDING)
136 #define IGMP_SOURCE_DO_DELETE(flags) ((flags) |= IGMP_SOURCE_MASK_DELETE)
137 #define IGMP_SOURCE_DO_SEND(flags) ((flags) |= IGMP_SOURCE_MASK_SEND)
138 #define IGMP_SOURCE_DONT_FORWARDING(flags) ((flags) &= ~IGMP_SOURCE_MASK_FORWARDING)
139 #define IGMP_SOURCE_DONT_DELETE(flags) ((flags) &= ~IGMP_SOURCE_MASK_DELETE)
140 #define IGMP_SOURCE_DONT_SEND(flags) ((flags) &= ~IGMP_SOURCE_MASK_SEND)
143 pim_addr source_addr
;
144 struct thread
*t_source_timer
;
145 struct gm_group
*source_group
; /* back pointer */
146 time_t source_creation
;
147 uint32_t source_flags
;
148 struct channel_oil
*source_channel_oil
;
151 RFC 3376: 6.6.3.2. Building and Sending Group and Source Specific
154 int source_query_retransmit_count
;
159 RFC 3376: 6.2.2. Definition of Group Timers
161 The group timer is only used when a group is in EXCLUDE mode and it
162 represents the time for the *filter-mode* of the group to expire and
163 switch to INCLUDE mode.
165 struct thread
*t_group_timer
;
167 /* Shared between group-specific and
168 group-and-source-specific retransmissions */
169 struct thread
*t_group_query_retransmit_timer
;
171 /* Counter exclusive for group-specific retransmissions
172 (not used by group-and-source-specific retransmissions,
173 since sources have their counters) */
174 int group_specific_query_retransmit_count
;
176 /* compatibility mode - igmp v1, v2 or v3 */
179 int group_filtermode_isexcl
; /* 0=INCLUDE, 1=EXCLUDE */
180 struct list
*group_source_list
; /* list of struct gm_source */
181 time_t group_creation
;
182 struct interface
*interface
;
183 int64_t last_igmp_v1_report_dsec
;
184 int64_t last_igmp_v2_report_dsec
;
187 struct gm_group
*find_group_by_addr(struct gm_sock
*igmp
,
188 struct in_addr group_addr
);
189 struct gm_group
*igmp_add_group_by_addr(struct gm_sock
*igmp
,
190 struct in_addr group_addr
);
192 struct gm_source
*igmp_get_source_by_addr(struct gm_group
*group
,
193 struct in_addr src_addr
,
196 void igmp_group_delete_empty_include(struct gm_group
*group
);
198 void igmp_startup_mode_on(struct gm_sock
*igmp
);
200 void igmp_group_timer_on(struct gm_group
*group
, long interval_msec
,
203 void igmp_send_query(int igmp_version
, struct gm_group
*group
, int fd
,
204 const char *ifname
, char *query_buf
, int query_buf_size
,
205 int num_sources
, struct in_addr dst_addr
,
206 struct in_addr group_addr
,
207 int query_max_response_time_dsec
, uint8_t s_flag
,
208 uint8_t querier_robustness_variable
,
209 uint16_t querier_query_interval
);
210 void igmp_group_delete(struct gm_group
*group
);
212 void igmp_send_query_on_intf(struct interface
*ifp
, int igmp_ver
);
213 #endif /* PIM_IGMP_H */