interfaceiter.c 9.56 KB
Newer Older
Danny Mayer's avatar
Danny Mayer committed
1
/*
Mark Andrews's avatar
Mark Andrews committed
2
 * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
Andreas Gustafsson's avatar
Andreas Gustafsson committed
3
 * Copyright (C) 1999-2001  Internet Software Consortium.
Danny Mayer's avatar
Danny Mayer committed
4
5
6
7
8
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
Mark Andrews's avatar
Mark Andrews committed
9
10
11
12
13
14
15
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
Danny Mayer's avatar
Danny Mayer committed
16
17
 */

18
/* $Id: interfaceiter.c,v 1.9 2007/06/18 03:36:50 marka Exp $ */
Danny Mayer's avatar
Danny Mayer committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

/*
 * Note that this code will need to be revisited to support IPv6 Interfaces.
 * For now we just iterate through IPv4 interfaces.
 */

#include <config.h>
#include <winsock2.h>
#include <ws2tcpip.h>
#include <sys/types.h>

#include <stdio.h>
#include <stdlib.h>
#include <errno.h>

#include <isc/interfaceiter.h>
#include <isc/mem.h>
#include <isc/result.h>
#include <isc/string.h>
38
#include <isc/strerror.h>
Danny Mayer's avatar
Danny Mayer committed
39
40
41
#include <isc/types.h>
#include <isc/util.h>

42
43
void InitSockets(void);

Danny Mayer's avatar
Danny Mayer committed
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/* Common utility functions */

/*
 * Extract the network address part from a "struct sockaddr".
 *
 * The address family is given explicity
 * instead of using src->sa_family, because the latter does not work
 * for copying a network mask obtained by SIOCGIFNETMASK (it does
 * not have a valid address family).
 */


#define IFITER_MAGIC		0x49464954U	/* IFIT. */
#define VALID_IFITER(t)		((t) != NULL && (t)->magic == IFITER_MAGIC)

struct isc_interfaceiter {
	unsigned int		magic;		/* Magic number. */
Danny Mayer's avatar
Danny Mayer committed
61
62
	isc_mem_t		*mctx;
	int			socket;
Danny Mayer's avatar
Danny Mayer committed
63
	INTERFACE_INFO		IFData;		/* Current Interface Info */
Danny Mayer's avatar
Danny Mayer committed
64
	int			numIF;		/* Current Interface count */
Andreas Gustafsson's avatar
Andreas Gustafsson committed
65
66
	int			totalIF;	/* Total Number
						   of Interfaces */
Danny Mayer's avatar
Danny Mayer committed
67
68
69
70
71
72
73
74
75
76
77
78
79
	INTERFACE_INFO		*buf;		/* Buffer for WSAIoctl data. */
	unsigned int		bufsize;	/* Bytes allocated. */
	INTERFACE_INFO		*pos;		/* Current offset in IF List */
	isc_interface_t		current;	/* Current interface data. */
	isc_result_t		result;		/* Last result code. */
};


/*
 * Size of buffer for SIO_GET_INTERFACE_LIST, in number of interfaces.
 * We assume no sane system will have more than than 1K of IP addresses on
 * all of its adapters.
 */
Danny Mayer's avatar
Danny Mayer committed
80
81
82
#define IFCONF_SIZE_INITIAL	  16
#define IFCONF_SIZE_INCREMENT	  64
#define IFCONF_SIZE_MAX		1040
Danny Mayer's avatar
Danny Mayer committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

static void
get_addr(unsigned int family, isc_netaddr_t *dst, struct sockaddr *src) {
	dst->family = family;
	switch (family) {
	case AF_INET:
		memcpy(&dst->type.in,
		       &((struct sockaddr_in *) src)->sin_addr,
		       sizeof(struct in_addr));
		break;
	case	AF_INET6:
		memcpy(&dst->type.in6,
		       &((struct sockaddr_in6 *) src)->sin6_addr,
		       sizeof(struct in6_addr));
		break;
	default:
		INSIST(0);
		break;
	}
}

isc_result_t
isc_interfaceiter_create(isc_mem_t *mctx, isc_interfaceiter_t **iterp) {
106
	char strbuf[ISC_STRERRORSIZE]; 
Danny Mayer's avatar
Danny Mayer committed
107
108
109
110
111
112
113
114
115
116
117
118
119
	isc_interfaceiter_t *iter;
	isc_result_t result;
	int error;
	unsigned long bytesReturned = 0;

	REQUIRE(mctx != NULL);
	REQUIRE(iterp != NULL);
	REQUIRE(*iterp == NULL);

	iter = isc_mem_get(mctx, sizeof(*iter));
	if (iter == NULL)
		return (ISC_R_NOMEMORY);

120
121
	InitSockets();

Danny Mayer's avatar
Danny Mayer committed
122
123
124
125
	iter->mctx = mctx;
	iter->buf = NULL;

	/*
Andreas Gustafsson's avatar
Andreas Gustafsson committed
126
127
	 * Create an unbound datagram socket to do the
	 * SIO_GET_INTERFACE_LIST WSAIoctl on.
Danny Mayer's avatar
Danny Mayer committed
128
129
	 */
	if ((iter->socket = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
130
131
		error = WSAGetLastError();
		isc__strerror(error, strbuf, sizeof(strbuf));
Danny Mayer's avatar
Danny Mayer committed
132
		UNEXPECTED_ERROR(__FILE__, __LINE__,
133
				"making interface scan socket: %s",
134
				strbuf);
Danny Mayer's avatar
Danny Mayer committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
		result = ISC_R_UNEXPECTED;
		goto socket_failure;
	}

	/*
	 * Get the interface configuration, allocating more memory if
	 * necessary.
	 */
	iter->bufsize = IFCONF_SIZE_INITIAL*sizeof(INTERFACE_INFO);

	for (;;) {
		iter->buf = isc_mem_get(mctx, iter->bufsize);
		if (iter->buf == NULL) {
			result = ISC_R_NOMEMORY;
			goto alloc_failure;
		}

Andreas Gustafsson's avatar
Andreas Gustafsson committed
152
153
		if (WSAIoctl(iter->socket, SIO_GET_INTERFACE_LIST,
			     0, 0, iter->buf, iter->bufsize,
154
			     &bytesReturned, 0, 0) == SOCKET_ERROR)
Andreas Gustafsson's avatar
Andreas Gustafsson committed
155
		{
Danny Mayer's avatar
Danny Mayer committed
156
157
158
			error = WSAGetLastError();
			if (error != WSAEFAULT && error != WSAENOBUFS) {
				errno = error;
159
				isc__strerror(error, strbuf, sizeof(strbuf));
Danny Mayer's avatar
Danny Mayer committed
160
				UNEXPECTED_ERROR(__FILE__, __LINE__,
161
						"get interface configuration: %s",
162
						strbuf);
Danny Mayer's avatar
Danny Mayer committed
163
164
165
166
167
168
169
170
171
				result = ISC_R_UNEXPECTED;
				goto ioctl_failure;
			}
			/*
			 * EINVAL.  Retry with a bigger buffer.
			 */
		} else {
			/*
			 * The WSAIoctl succeeded.
Andreas Gustafsson's avatar
Andreas Gustafsson committed
172
173
174
			 * If the number of the returned bytes is the same
			 * as the buffer size, we will grow it just in
			 * case and retry.
Danny Mayer's avatar
Danny Mayer committed
175
			 */
Andreas Gustafsson's avatar
Andreas Gustafsson committed
176
177
			if (bytesReturned > 0 &&
			    (bytesReturned < iter->bufsize))
Danny Mayer's avatar
Danny Mayer committed
178
179
180
181
182
183
184
185
186
187
188
				break;
		}
		if (iter->bufsize >= IFCONF_SIZE_MAX*sizeof(INTERFACE_INFO)) {
			UNEXPECTED_ERROR(__FILE__, __LINE__,
					 "get interface configuration: "
					 "maximum buffer size exceeded");
			result = ISC_R_UNEXPECTED;
			goto ioctl_failure;
		}
		isc_mem_put(mctx, iter->buf, iter->bufsize);

Andreas Gustafsson's avatar
Andreas Gustafsson committed
189
190
		iter->bufsize += IFCONF_SIZE_INCREMENT *
			sizeof(INTERFACE_INFO);
Danny Mayer's avatar
Danny Mayer committed
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
	}

	/*
	 * A newly created iterator has an undefined position
	 * until isc_interfaceiter_first() is called.
	 */
	iter->pos = NULL;
	iter->result = ISC_R_FAILURE;
	iter->numIF = 0;
	iter->totalIF = bytesReturned/sizeof(INTERFACE_INFO);


	iter->magic = IFITER_MAGIC;
	*iterp = iter;
	/* We don't need the socket any more, so close it */
	closesocket(iter->socket);
	return (ISC_R_SUCCESS);

 ioctl_failure:
	isc_mem_put(mctx, iter->buf, iter->bufsize);

 alloc_failure:
	(void) closesocket(iter->socket);

 socket_failure:
Andreas Gustafsson's avatar
Andreas Gustafsson committed
216
	isc_mem_put(mctx, iter, sizeof(*iter));
Danny Mayer's avatar
Danny Mayer committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
	return (result);
}

/*
 * Get information about the current interface to iter->current.
 * If successful, return ISC_R_SUCCESS.
 * If the interface has an unsupported address family, or if
 * some operation on it fails, return ISC_R_IGNORE to make
 * the higher-level iterator code ignore it.
 */

static isc_result_t
internal_current(isc_interfaceiter_t *iter, int family) {
	BOOL ifNamed = FALSE;
	unsigned long flags;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
232

Danny Mayer's avatar
Danny Mayer committed
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
	REQUIRE(VALID_IFITER(iter));
	REQUIRE(iter->numIF >= 0);

	memset(&iter->current, 0, sizeof(iter->current));
	iter->current.af = family;

	get_addr(family, &iter->current.address,
		 (struct sockaddr *)&(iter->IFData.iiAddress));

	/*
	 * Get interface flags.
	 */

	iter->current.flags = 0;
	flags = iter->IFData.iiFlags;

	if ((flags & IFF_UP) != 0)
		iter->current.flags |= INTERFACE_F_UP;

Andreas Gustafsson's avatar
Andreas Gustafsson committed
252
	if ((flags & IFF_POINTTOPOINT) != 0) {
Danny Mayer's avatar
Danny Mayer committed
253
254
255
256
257
		iter->current.flags |= INTERFACE_F_POINTTOPOINT;
		sprintf(iter->current.name, "PPP Interface %d", iter->numIF);
		ifNamed = TRUE;
	}

Andreas Gustafsson's avatar
Andreas Gustafsson committed
258
	if ((flags & IFF_LOOPBACK) != 0) {
Danny Mayer's avatar
Danny Mayer committed
259
		iter->current.flags |= INTERFACE_F_LOOPBACK;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
260
261
		sprintf(iter->current.name, "Loopback Interface %d",
			iter->numIF);
Danny Mayer's avatar
Danny Mayer committed
262
263
264
265
266
267
268
269
		ifNamed = TRUE;
	}

	/*
	 * If the interface is point-to-point, get the destination address.
	 */
	if ((iter->current.flags & INTERFACE_F_POINTTOPOINT) != 0) {
		get_addr(family, &iter->current.dstaddress,
Danny Mayer's avatar
Danny Mayer committed
270
		(struct sockaddr *)&(iter->IFData.iiBroadcastAddress));
Danny Mayer's avatar
Danny Mayer committed
271
272
	}

Danny Mayer's avatar
Danny Mayer committed
273
	if (ifNamed == FALSE)
Andreas Gustafsson's avatar
Andreas Gustafsson committed
274
275
276
		sprintf(iter->current.name,
			"TCP/IP Interface %d", iter->numIF);

Danny Mayer's avatar
Danny Mayer committed
277
278
279
280
281
282
283
284
	/*
	 * Get the network mask.
	 */
	switch (family) {
	case AF_INET:
		get_addr(family, &iter->current.netmask,
			 (struct sockaddr *)&(iter->IFData.iiNetmask));
		break;
Danny Mayer's avatar
Danny Mayer committed
285
	case AF_INET6:
Danny Mayer's avatar
Danny Mayer committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
		break;
	}

	return (ISC_R_SUCCESS);
}

/*
 * Step the iterator to the next interface.  Unlike
 * isc_interfaceiter_next(), this may leave the iterator
 * positioned on an interface that will ultimately
 * be ignored.  Return ISC_R_NOMORE if there are no more
 * interfaces, otherwise ISC_R_SUCCESS.
 */
static isc_result_t
internal_next(isc_interfaceiter_t *iter) {
	if (iter->numIF >= iter->totalIF)
		return (ISC_R_NOMORE);

	/*
	 * The first one needs to be set up to point to the last
	 * Element of the array.  Go to the end and back up
	 * Microsoft's implementation is peculiar for returning
	 * the list in reverse order
	 */
	 
Danny Mayer's avatar
Danny Mayer committed
311
	if (iter->numIF == 0)
Danny Mayer's avatar
Danny Mayer committed
312
		iter->pos = (INTERFACE_INFO *)(iter->buf + (iter->totalIF));
Andreas Gustafsson's avatar
Andreas Gustafsson committed
313

Danny Mayer's avatar
Danny Mayer committed
314
	iter->pos--;
Danny Mayer's avatar
Danny Mayer committed
315
	if (&(iter->pos) < &(iter->buf))
Danny Mayer's avatar
Danny Mayer committed
316
317
318
319
320
321
322
323
324
325
326
		return (ISC_R_NOMORE);

	memset(&(iter->IFData), 0, sizeof(INTERFACE_INFO));
	memcpy(&(iter->IFData), iter->pos, sizeof(INTERFACE_INFO));
	iter->numIF++;

	return (ISC_R_SUCCESS);
}

isc_result_t
isc_interfaceiter_current(isc_interfaceiter_t *iter,
Danny Mayer's avatar
Danny Mayer committed
327
			  isc_interface_t *ifdata) {
Danny Mayer's avatar
Danny Mayer committed
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
	REQUIRE(iter->result == ISC_R_SUCCESS);
	memcpy(ifdata, &iter->current, sizeof(*ifdata));
	return (ISC_R_SUCCESS);
}

isc_result_t
isc_interfaceiter_first(isc_interfaceiter_t *iter) {
	isc_result_t result;

	REQUIRE(VALID_IFITER(iter));

	iter->numIF = 0;
	for (;;) {
		result = internal_next(iter);
		if (result != ISC_R_SUCCESS)
			break;
		result = internal_current(iter, AF_INET);
		if (result != ISC_R_IGNORE)
			break;
	}
	iter->result = result;
	return (result);
}

isc_result_t
isc_interfaceiter_next(isc_interfaceiter_t *iter) {
	isc_result_t result;

	REQUIRE(VALID_IFITER(iter));
	REQUIRE(iter->result == ISC_R_SUCCESS);

	for (;;) {
		result = internal_next(iter);
		if (result != ISC_R_SUCCESS)
			break;
		result = internal_current(iter,AF_INET);
		if (result != ISC_R_IGNORE)
			break;
	}
	iter->result = result;
	return (result);
}

void
Andreas Gustafsson's avatar
Andreas Gustafsson committed
372
isc_interfaceiter_destroy(isc_interfaceiter_t **iterp) {
Danny Mayer's avatar
Danny Mayer committed
373
374
375
376
377
378
379
380
	isc_interfaceiter_t *iter;
	REQUIRE(iterp != NULL);
	iter = *iterp;
	REQUIRE(VALID_IFITER(iter));

	isc_mem_put(iter->mctx, iter->buf, iter->bufsize);

	iter->magic = 0;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
381
	isc_mem_put(iter->mctx, iter, sizeof(*iter));
Danny Mayer's avatar
Danny Mayer committed
382
383
	*iterp = NULL;
}
Danny Mayer's avatar
Danny Mayer committed
384