1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* Hey Emacs use -*- mode: C -*- */
/*
*------------------------------------------------------------------
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*------------------------------------------------------------------
*/
option version = "1.0.0";
import "vnet/ip/ip_types.api";
/**
* @brief Filter mode
*/
enum filter_mode {
EXCLUDE = 0,
INCLUDE = 1,
};
/**
* @brief
* Used by a 'host' to enable the reception/listening of packets for a specific
* multicast group
*
* For each socket on which IPMulticastListen has been invoked, the
* system records the desired multicast reception state for that socket.
* That state conceptually consists of a set of records of the form:
*
* (interface, multicast-address, filter-mode, source-list)
*
* The socket state evolves in response to each invocation of
* IPMulticastListen on the socket, as follows:
*
* o If the requested filter mode is INCLUDE *and* the requested source
* list is empty, then the entry corresponding to the requested
* interface and multicast address is deleted if present. If no such
* entry is present, the request is ignored.
*
* o If the requested filter mode is EXCLUDE *or* the requested source
* list is non-empty, then the entry corresponding to the requested
* interface and multicast address, if present, is changed to contain
* the requested filter mode and source list. If no such entry is
* present, a new entry is created, using the parameters specified in
* the request.
*
* @param client_index - opaque cookie to identify the sender
* @param context - sender context, to match reply w/ request
* @param sw_if_index - interface sw index
* @param filter - filter mode
* @param saddr - source address
* @param gaddr - group address
*/
typeonly define igmp_group
{
vl_api_filter_mode_t filter;
u8 n_srcs;
u32 sw_if_index;
vl_api_ip4_address_t gaddr;
vl_api_ip4_address_t saddrs[n_srcs];
};
autoreply define igmp_listen
{
u32 client_index;
u32 context;
vl_api_igmp_group_t group;
};
/**
* @brief
* Used by a 'router' and 'host' to enable the reception of IGMP packets.
* For hosts this must be called once before igmp_listen.
*
* @param client_index - opaque cookie to identify the sender
* @param context - sender context, to match reply w/ request
* @param enable - if set, enable igmp messages on configuration
* @param mode - Host (1) or router (0) mode
* @param sw_if_index - interface sw index
*/
autoreply define igmp_enable_disable
{
u32 client_index;
u32 context;
u8 enable;
u8 mode;
u32 sw_if_index;
};
/**
* @brief dump (S,G)s from interface
* @param client_index - opaque cookie to identify the sender
* @param context - sender context, to match reply w/ request
* @param sw_if_index - interface sw index (~0 for all)
*/
define igmp_dump
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
/**
* @brief igmp details
* @param context - sender context, to match reply w/ request
* @param sw_if_index - interface sw index
* @param saddr - source address
* @param gaddr - group address
*/
define igmp_details
{
u32 context;
u32 sw_if_index;
vl_api_ip4_address_t saddr;
vl_api_ip4_address_t gaddr;
};
/** \brief remove all (S,G)s from an interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface sw index
*/
autoreply define igmp_clear_interface
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
/**
* @brief register for igmp events
* @param client_index - opaque cookie to identify the sender
* @param context - sender context, to match reply w/ request
* @param pid - sender's pid
* @param enable - 1 enable, 0 disable igmp events
*/
autoreply define want_igmp_events
{
u32 client_index;
u32 context;
u32 enable;
u32 pid;
};
service {
rpc want_igmp_events returns want_igmp_events_reply
events igmp_event;
};
/**
* @brief igmp event details
* @param client_index - opaque cookie to identify the sender
* @param context - sender context, to match reply w/ request
* @param sw_if_index - interface sw index
* @param saddr - source address
* @param gaddr - group address
*@param filter - filter mode
*/
define igmp_event
{
u32 context;
u32 sw_if_index;
vl_api_filter_mode_t filter;
vl_api_ip4_address_t saddr;
vl_api_ip4_address_t gaddr;
};
/**
* @brief enum to specify either ASM or SSM semantics
*/
enum group_prefix_type
{
ASM = 0,
SSM = 1,
};
/**
* @brief Definition of a Group prefix and its type
*/
typedef group_prefix
{
vl_api_group_prefix_type_t type;
vl_api_prefix_t prefix;
};
/**
* @brief Configure a prefix for SSM or ASM semantics
* @param address - Prefix address
* @param address_length - Prefix length
*/
autoreply define igmp_group_prefix_set
{
u32 client_index;
u32 context;
vl_api_group_prefix_t gp;
};
define igmp_group_prefix_dump
{
u32 client_index;
u32 context;
};
define igmp_group_prefix_details
{
u32 context;
vl_api_group_prefix_t gp;
};
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
