socket.c 94.5 KB
Newer Older
Danny Mayer's avatar
Danny Mayer committed
1
/*
Mark Andrews's avatar
Mark Andrews committed
2
 * Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
Mark Andrews's avatar
Mark Andrews committed
3
 * Copyright (C) 2000-2003  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: socket.c,v 1.40 2005/07/12 01:00:20 marka Exp $ */
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

/* This code has been rewritten to take advantage of Windows Sockets
 * I/O Completion Ports and Events. I/O Completion Ports is ONLY
 * available on Windows NT, Windows 2000 and Windows XP series of
 * the Windows Operating Systems. In CANNOT run on Windows 95, Windows 98
 * or the follow-ons to those Systems.
 *
 * This code is by nature multithreaded and takes advantage of various
 * features to pass on information through the completion port for
 * when I/O is completed.  All sends and receives are completed through
 * the completion port. Due to an implementation bug in Windows 2000,
 * Service Pack 2 must installed on the system for this code to run correctly.
 * For details on this problem see Knowledge base article Q263823.
 * The code checks for this. The number of Completion Port Worker threads
 * used is the total number of CPU's + 1. This increases the likelihood that
 * a Worker Thread is available for processing a completed request.
 *
 * All accepts and connects are accomplished through the WSAEventSelect()
 * function and the event_wait loop. Events are added to and deleted from
 * each event_wait thread via a common event_update stack owned by the socket
 * manager. If the event_wait thread runs out of array space in the events
 * array it will look for another event_wait thread to add the event. If it
 * fails to find another one it will create a new thread to handle the
 * outstanding event.
 *
 * A future enhancement is to use AcceptEx to take avantage of Overlapped
 * I/O which allows for enhanced performance of TCP connections.
 * This will also reduce the number of events that are waited on by the
 * event_wait threads to just the connect sockets and reduce the number
 * additional threads required.
 *
 * XXXPDM 5 August, 2002
 */
Danny Mayer's avatar
Danny Mayer committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

#define MAKE_EXTERNAL 1
#include <config.h>

#include <sys/types.h>

#ifndef _WINSOCKAPI_
#define _WINSOCKAPI_   /* Prevent inclusion of winsock.h in windows.h */
#endif

#include <errno.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <io.h>
#include <fcntl.h>
69
#include <process.h>
Danny Mayer's avatar
Danny Mayer committed
70 71 72 73 74 75 76 77 78 79

#include <isc/buffer.h>
#include <isc/bufferlist.h>
#include <isc/condition.h>
#include <isc/list.h>
#include <isc/log.h>
#include <isc/mem.h>
#include <isc/msgs.h>
#include <isc/mutex.h>
#include <isc/net.h>
80
#include <isc/os.h>
Danny Mayer's avatar
Danny Mayer committed
81 82 83 84
#include <isc/platform.h>
#include <isc/print.h>
#include <isc/region.h>
#include <isc/socket.h>
85 86
#include <isc/strerror.h>
#include <isc/syslog.h>
Danny Mayer's avatar
Danny Mayer committed
87 88 89
#include <isc/task.h>
#include <isc/thread.h>
#include <isc/util.h>
90
#include <isc/win32os.h>
Danny Mayer's avatar
Danny Mayer committed
91

92
#include "errno2result.h"
93

94 95 96 97 98 99 100 101 102 103 104
/*
 * Define this macro to control the behavior of connection
 * resets on UDP sockets.  See Microsoft KnowledgeBase Article Q263823
 * for details.
 * NOTE: This requires that Windows 2000 systems install Service Pack 2
 * or later.
 */
#ifndef SIO_UDP_CONNRESET 
#define SIO_UDP_CONNRESET _WSAIOW(IOC_VENDOR,12) 
#endif

Danny Mayer's avatar
Danny Mayer committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
/*
 * Some systems define the socket length argument as an int, some as size_t,
 * some as socklen_t.  This is here so it can be easily changed if needed.
 */
#ifndef ISC_SOCKADDR_LEN_T
#define ISC_SOCKADDR_LEN_T unsigned int
#endif

/*
 * Define what the possible "soft" errors can be.  These are non-fatal returns
 * of various network related functions, like recv() and so on.
 *
 * For some reason, BSDI (and perhaps others) will sometimes return <0
 * from recv() but will have errno==0.  This is broken, but we have to
 * work around it here.
 */
121
#define SOFT_ERROR(e)	((e) == WSAEINTR || \
122
			 (e) == WSA_IO_PENDING || \
123
			 (e) == WSAEWOULDBLOCK || \
124 125 126
			 (e) == EWOULDBLOCK || \
			 (e) == EINTR || \
			 (e) == EAGAIN || \
Danny Mayer's avatar
Danny Mayer committed
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
			 (e) == 0)

#define DLVL(x) ISC_LOGCATEGORY_GENERAL, ISC_LOGMODULE_SOCKET, ISC_LOG_DEBUG(x)

/*
 * DLVL(90)  --  Function entry/exit and other tracing.
 * DLVL(70)  --  Socket "correctness" -- including returning of events, etc.
 * DLVL(60)  --  Socket data send/receive
 * DLVL(50)  --  Event tracing, including receiving/sending completion events.
 * DLVL(20)  --  Socket creation/destruction.
 */
#define TRACE_LEVEL		90
#define CORRECTNESS_LEVEL	70
#define IOEVENT_LEVEL		60
#define EVENT_LEVEL		50
#define CREATION_LEVEL		20

#define TRACE		DLVL(TRACE_LEVEL)
#define CORRECTNESS	DLVL(CORRECTNESS_LEVEL)
#define IOEVENT		DLVL(IOEVENT_LEVEL)
#define EVENT		DLVL(EVENT_LEVEL)
#define CREATION	DLVL(CREATION_LEVEL)

typedef isc_event_t intev_t;

152 153
#define SOCKET_MAGIC		ISC_MAGIC('I', 'O', 'i', 'o')
#define VALID_SOCKET(t)		ISC_MAGIC_VALID(t, SOCKET_MAGIC)
Danny Mayer's avatar
Danny Mayer committed
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

/*
 * IPv6 control information.  If the socket is an IPv6 socket we want
 * to collect the destination address and interface so the client can
 * set them on outgoing packets.
 */
#ifdef ISC_PLATFORM_HAVEIPV6
#ifndef USE_CMSG
#define USE_CMSG	1
#endif
#endif

/*
 * NetBSD and FreeBSD can timestamp packets.  XXXMLG Should we have
 * a setsockopt() like interface to request timestamps, and if the OS
 * doesn't do it for us, call gettimeofday() on every UDP receive?
 */

/*
 * We really  don't want to try and use these control messages. Win32
 * doesn't have this mechanism
 */
#undef USE_CMSG

/*
 * Message header for recvmsg and sendmsg calls.
 * Used value-result for recvmsg, value only for sendmsg.
 */
182

Danny Mayer's avatar
Danny Mayer committed
183 184 185 186

struct msghdr {
        void	*msg_name;              /* optional address */
        u_int   msg_namelen;            /* size of address */
Danny Mayer's avatar
Danny Mayer committed
187
        WSABUF  *msg_iov;		/* scatter/gather array */
Danny Mayer's avatar
Danny Mayer committed
188 189 190 191 192
        u_int   msg_iovlen;             /* # elements in msg_iov */
        void	*msg_control;           /* ancillary data, see below */
        u_int   msg_controllen;         /* ancillary data buffer len */
        int     msg_flags;              /* flags on received message */
} msghdr;
193
	
194 195 196 197 198
/*%
 * The size to raise the recieve buffer to.
 */
#define RCVBUFSIZE (32*1024)

199 200 201 202 203
/*
 * The number of times a send operation is repeated if the result is EINTR.
 */
#define NRETRIES 10

Danny Mayer's avatar
Danny Mayer committed
204 205 206 207 208 209
struct isc_socket {
	/* Not locked. */
	unsigned int		magic;
	isc_socketmgr_t	       *manager;
	isc_mutex_t		lock;
	isc_sockettype_t	type;
210 211 212 213 214 215
	OVERLAPPED		overlapped;
	/* Pointers to scatter/gather buffers */
	WSABUF			iov[ISC_SOCKET_MAXSCATTERGATHER];
	size_t			totalBytes;
	WSAEVENT		hEvent;		/* Event Handle */
	long			wait_type;	/* Events to wait on */
216 217 218
	WSAEVENT		hAlert;		/* Alert Event Handle */
	DWORD			evthread_id;	/* Event Thread Id for socket */

Danny Mayer's avatar
Danny Mayer committed
219 220 221 222

	/* Locked by socket lock. */
	ISC_LINK(isc_socket_t)	link;
	unsigned int		references;
223
	SOCKET			fd;
Danny Mayer's avatar
Danny Mayer committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
	int			pf;

	ISC_LIST(isc_socketevent_t)		send_list;
	ISC_LIST(isc_socketevent_t)		recv_list;
	ISC_LIST(isc_socket_newconnev_t)	accept_list;
	isc_socket_connev_t		       *connect_ev;

	/*
	 * Internal events.  Posted when a descriptor is readable or
	 * writable.  These are statically allocated and never freed.
	 * They will be set to non-purgable before use.
	 */
	intev_t			readable_ev;
	intev_t			writable_ev;

	isc_sockaddr_t		address;  /* remote address */

241
	unsigned int		pending_close : 1,
Danny Mayer's avatar
Danny Mayer committed
242
				pending_accept : 1,
243 244
				iocp : 1,	/* I/O Completion Port */
				listener : 1,	/* listener socket */
Danny Mayer's avatar
Danny Mayer committed
245 246
				connected : 1,
				connecting : 1, /* connect pending */
247 248 249 250
				bound : 1,	/* bound to local addr */
				pending_free: 1;
	unsigned int		pending_recv;
	unsigned int		pending_send;
Danny Mayer's avatar
Danny Mayer committed
251 252
};

253 254 255 256 257 258 259 260
/*
 * I/O Completion ports Info structures
 */

static HANDLE hHeapHandle = NULL;
static int iocp_total = 0;
typedef struct IoCompletionInfo {
	OVERLAPPED			overlapped;
261
	isc_socketevent_t		*dev;
262
	int				request_type;
263
	struct msghdr			messagehdr;
264 265 266 267
} IoCompletionInfo;

/*
 * Define a maximum number of I/O Completion Port worker threads
268 269
 * to handle the load on the Completion Port. The actual number
 * used is the number of CPU's + 1.
270 271 272 273 274 275 276 277 278 279 280
 */
#define MAX_IOCPTHREADS 20

/*
 * event_change structure to handle adds and deletes from the list of
 * events in the Wait
 */
typedef struct event_change event_change_t;

struct event_change {
	isc_socket_t			*sock;
281 282
	WSAEVENT			hEvent;
	DWORD				evthread_id;
283 284 285 286 287 288 289
	SOCKET				fd;
	unsigned int			action;
	ISC_LINK(event_change_t)	link;
};

/*
 * Note: We are using an array here since *WaitForMultiple* wants an array
290 291
 * WARNING: This value may not be greater than 64 since the 
 * WSAWaitForMultipleEvents function is limited to 64 events.
292 293 294 295 296 297 298 299 300 301 302 303 304 305
 */

#define MAX_EVENTS 64

/*
 * List of events being waited on and their associated sockets
 */
typedef struct sock_event_list {
	int max_event;
	int total_events;
	isc_socket_t			*aSockList[MAX_EVENTS];
	WSAEVENT			aEventList[MAX_EVENTS];
} sock_event_list;

306 307 308 309 310 311 312 313 314 315 316 317 318
/*
 * Thread Event structure for managing the threads handling events
 */
typedef struct events_thread events_thread_t;

struct events_thread {
	isc_thread_t			thread_handle;	/* Thread's handle */
	DWORD				thread_id;	/* Thread's id */
	sock_event_list			sockev_list;
	isc_socketmgr_t			*manager;
	ISC_LINK(events_thread_t)	link;
};

319 320 321
#define SOCKET_MANAGER_MAGIC	ISC_MAGIC('I', 'O', 'm', 'g')
#define VALID_MANAGER(m)	ISC_MAGIC_VALID(m, SOCKET_MANAGER_MAGIC)

Danny Mayer's avatar
Danny Mayer committed
322 323
struct isc_socketmgr {
	/* Not locked. */
324 325 326
	unsigned int			magic;
	isc_mem_t		       *mctx;
	isc_mutex_t			lock;
Danny Mayer's avatar
Danny Mayer committed
327
	/* Locked by manager lock. */
328 329 330 331 332 333 334 335 336 337 338
	ISC_LIST(event_change_t)	event_updates;
	ISC_LIST(isc_socket_t)		socklist;
	int				event_written;
	WSAEVENT			prime_alert;
	isc_boolean_t			bShutdown;
	ISC_LIST(events_thread_t)	ev_threads;
	isc_condition_t			shutdown_ok;
	HANDLE				hIoCompletionPort;
	int				maxIOCPThreads;
	HANDLE				hIOCPThreads[MAX_IOCPTHREADS];
	DWORD				dwIOCPThreadIds[MAX_IOCPTHREADS];
Danny Mayer's avatar
Danny Mayer committed
339 340 341 342 343 344 345 346 347 348
};

#define CLOSED		0	/* this one must be zero */
#define MANAGED		1
#define CLOSE_PENDING	2

/*
 * send() and recv() iovec counts
 */
#define MAXSCATTERGATHER_SEND	(ISC_SOCKET_MAXSCATTERGATHER)
349
#define MAXSCATTERGATHER_RECV	(ISC_SOCKET_MAXSCATTERGATHER)
Danny Mayer's avatar
Danny Mayer committed
350

351
static isc_threadresult_t WINAPI event_wait(void *uap);
352
static isc_threadresult_t WINAPI SocketIoThread(LPVOID ThreadContext);
Danny Mayer's avatar
Danny Mayer committed
353 354
static void free_socket(isc_socket_t **);

355 356 357 358 359 360 361 362 363
enum {
	SOCKET_RECV,
	SOCKET_SEND,
};

enum {
	EVENT_ADD,
	EVENT_DELETE
};
Danny Mayer's avatar
Danny Mayer committed
364

365 366
#if defined(ISC_SOCKET_DEBUG)
/*
367
 * This is used to dump the contents of the sock structure
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
 * You should make sure that the sock is locked before
 * dumping it. Since the code uses simple printf() statements
 * it should only be used interactively.
 */
void
sock_dump(isc_socket_t *sock) {
	isc_socketevent_t *ldev;
	isc_socket_newconnev_t *ndev;
	isc_sockaddr_t addr;
	char socktext[256];


	isc_socket_getpeername(sock, &addr);
	isc_sockaddr_format(&addr, socktext, sizeof(socktext));
	printf("Remote Socket: %s\n", socktext);
	isc_socket_getsockname(sock, &addr);
	isc_sockaddr_format(&addr, socktext, sizeof(socktext));
	printf("This Socket: %s\n", socktext);

	printf("\n\t\tSock Dump\n");
	printf("\t\tfd: %u\n", sock->fd);
	printf("\t\treferences: %d\n", sock->references);
	printf("\t\tpending_accept: %d\n", sock->pending_accept);
	printf("\t\tpending_close: %d\n", sock->pending_close);
	printf("\t\tconnecting: %d\n", sock->connecting);
	printf("\t\tconnected: %d\n", sock->connected);
	printf("\t\tbound: %d\n", sock->bound);
	printf("\t\tiocp: %d\n", sock->iocp);
	printf("\t\tsocket type: %d\n", sock->type);

	printf("\n\t\tSock Recv List\n");
	ldev = ISC_LIST_HEAD(sock->recv_list);
	while (ldev != NULL) {
		printf("\t\tdev: %p\n", ldev);
		ldev = ISC_LIST_NEXT(ldev, ev_link);
	}
	printf("\n\t\tSock Send List\n");
	ldev = ISC_LIST_HEAD(sock->send_list);
	while (ldev != NULL) {
		printf("\t\tdev: %p\n", ldev);
		ldev = ISC_LIST_NEXT(ldev, ev_link);
	}
	printf("\n\t\tSock Accept List\n");
	ndev = ISC_LIST_HEAD(sock->accept_list);
	while (ndev != NULL) {
		printf("\t\tdev: %p\n", ldev);
		ndev = ISC_LIST_NEXT(ndev, ev_link);
	}
}
#endif

/*  This function will add an entry to the I/O completion port
 *  that will signal the I/O thread to exit (gracefully)
 */
static void
signal_iocompletionport_exit(isc_socketmgr_t *manager) {
	int i;
	int errval;
	char strbuf[ISC_STRERRORSIZE];

428
	REQUIRE(VALID_MANAGER(manager));
429
	for (i = 0; i < manager->maxIOCPThreads; i++) {
430 431
		if (!PostQueuedCompletionStatus(manager->hIoCompletionPort,
						0, 0, 0)) {
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
			errval = GetLastError();
			isc__strerror(errval, strbuf, sizeof(strbuf));
			FATAL_ERROR(__FILE__, __LINE__,
				isc_msgcat_get(isc_msgcat, ISC_MSGSET_SOCKET,
				ISC_MSG_FAILED,
				"Can't request service thread to exit: %s"),
				strbuf);
		}
	}
}

/*
 * Create the worker threads for the I/O Completion Port
 */
void
iocompletionport_createthreads(int total_threads, isc_socketmgr_t *manager) {
	int errval;
	char strbuf[ISC_STRERRORSIZE];
450
	int i;
451

452 453
	INSIST(total_threads > 0);
	REQUIRE(VALID_MANAGER(manager));
454 455 456 457
	/*
	 * We need at least one
	 */
	for (i = 0; i < total_threads; i++) {
458
		manager->hIOCPThreads[i] = CreateThread(NULL, 0, SocketIoThread,
459 460 461 462 463 464 465 466 467 468 469 470 471 472
						manager, 0,
						&manager->dwIOCPThreadIds[i]);
		if(manager->hIOCPThreads[i] == NULL) {
			errval = GetLastError();
			isc__strerror(errval, strbuf, sizeof(strbuf));
			FATAL_ERROR(__FILE__, __LINE__,
				isc_msgcat_get(isc_msgcat, ISC_MSGSET_SOCKET,
				ISC_MSG_FAILED,
				"Can't create IOCP thread: %s"),
				strbuf);
		}
	}
}

473
/*
474
 *  Create/initialise the I/O completion port
475
 */
476 477 478 479
void
iocompletionport_init(isc_socketmgr_t *manager) {
	int errval;
	char strbuf[ISC_STRERRORSIZE];
480 481

	REQUIRE(VALID_MANAGER(manager));
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
	/*
	 * Create a private heap to handle the socket overlapped structure
	 * The miniumum number of structures is 10, there is no maximum
	 */
	hHeapHandle = HeapCreate(0, 10*sizeof(IoCompletionInfo), 0);
	manager->maxIOCPThreads = min(isc_os_ncpus() + 1,
					MAX_IOCPTHREADS);

	/* Now Create the Completion Port */
	manager->hIoCompletionPort = CreateIoCompletionPort(
				     INVALID_HANDLE_VALUE, NULL,
				     0, manager->maxIOCPThreads);
	if (manager->hIoCompletionPort == NULL) {
		errval = GetLastError();
		isc__strerror(errval, strbuf, sizeof(strbuf));
		FATAL_ERROR(__FILE__, __LINE__,
				isc_msgcat_get(isc_msgcat, ISC_MSGSET_SOCKET,
				ISC_MSG_FAILED,
				"CreateIoCompletionPort() failed "
				"during initialization: %s"),
				strbuf);
		exit(1);
	}
	
	/*
	 * Worker threads for servicing the I/O
 	 */
	iocompletionport_createthreads(manager->maxIOCPThreads, manager);
}
	
512

513 514
void
iocompletionport_exit(isc_socketmgr_t *manager) {
515 516

	REQUIRE(VALID_MANAGER(manager));
517 518 519 520 521 522
	if (manager->hIoCompletionPort != NULL) {
		/*  Get each of the service threads to exit
		*/
		signal_iocompletionport_exit(manager);
	}
}
523

524
/*
525 526
 * Add sockets in here and pass the sock data in as part of the
 * information needed.
527
 */
528
void
529 530
iocompletionport_update(isc_socket_t *sock) {
	HANDLE hiocp;
531 532

	REQUIRE(sock != NULL);
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
	if(sock->iocp == 0) {
		sock->iocp = 1;
		hiocp = CreateIoCompletionPort((HANDLE) sock->fd,
			sock->manager->hIoCompletionPort, (DWORD) sock,
			sock->manager->maxIOCPThreads);
		InterlockedIncrement(&iocp_total);

	}
}

void
socket_event_minit(sock_event_list *evlist) {
	BOOL bReset;
	int i;

548
	REQUIRE(evlist != NULL);
549 550 551 552 553 554 555 556
	/* Initialize the Event List */
	evlist->max_event = 0;
	evlist->total_events = 0;
	for (i = 0; i < MAX_EVENTS; i++) {
		evlist->aSockList[i] = NULL;
		evlist->aEventList[i] = (WSAEVENT) 0;
	}

557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
	evlist->aEventList[0] = WSACreateEvent();
	(evlist->max_event)++;
	bReset = WSAResetEvent(evlist->aEventList[0]);
}
/*
 * Event Thread Initialization
 */
isc_result_t
event_thread_create(events_thread_t **evthreadp, isc_socketmgr_t *manager) {
	events_thread_t *evthread;

	REQUIRE(VALID_MANAGER(manager));
	REQUIRE(evthreadp != NULL && *evthreadp == NULL);

	evthread = isc_mem_get(manager->mctx, sizeof(*evthread));
	socket_event_minit(&evthread->sockev_list);
	ISC_LINK_INIT(evthread, link);
	evthread->manager = manager;

	ISC_LIST_APPEND(manager->ev_threads, evthread, link);

578
	/*
579
	 * Start up the event wait thread.
580
	 */
581 582 583
	if (isc_thread_create(event_wait, evthread, &evthread->thread_handle) !=
	    ISC_R_SUCCESS) {
		isc_mem_put(manager->mctx, evthread, sizeof(*evthread));
584
		UNEXPECTED_ERROR(__FILE__, __LINE__,
585
				 "isc_thread_create() %s",
586 587
				 isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
						ISC_MSG_FAILED, "failed"));
588
		return (ISC_R_UNEXPECTED);
589
	}
590 591
	*evthreadp = evthread;
	return (ISC_R_SUCCESS);
592 593
}
/*
594 595 596
 * Locate a thread with space for additional events or create one if
 * necessary. The manager is locked at this point so the information
 * cannot be changed by another thread while we are searching.
597
 */
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
void
locate_available_thread(isc_socketmgr_t *manager) {
	events_thread_t *evthread;
	DWORD threadid = GetCurrentThreadId();

	evthread = ISC_LIST_HEAD(manager->ev_threads);
	while (evthread != NULL) {
		/*
		 * We need to find a thread with space to add an event
		 * If we find it, alert it to process the event change
		 * list
		 */
		if(threadid != evthread->thread_id &&
			evthread->sockev_list.max_event < MAX_EVENTS) {
			WSASetEvent(evthread->sockev_list.aEventList[0]);
			return;
		}
		evthread = ISC_LIST_NEXT(evthread, link);
	}
	/*
	 * We need to create a new thread as other threads are full.
	 * If we succeed in creating the thread, alert it to
	 * process the event change list since it will have space.
	 * If we are unable to create one, the event will stay on the
	 * list and the next event_wait thread will try again to add
	 * the event. It will call here again if it has no space.
	 */
	if (event_thread_create(&evthread, manager) == ISC_R_SUCCESS) {
		WSASetEvent(evthread->sockev_list.aEventList[0]);
	}

}

isc_boolean_t
socket_eventlist_add(event_change_t *evchange, sock_event_list *evlist,
		     isc_socketmgr_t *manager) {
634
	int max_event;
635 636
	isc_socket_t *sock;
	REQUIRE(evchange != NULL);
637

638
	sock = evchange->sock;
639 640 641 642 643 644
	REQUIRE(sock != NULL);
	REQUIRE(sock->hEvent != NULL);
	REQUIRE(evlist != NULL);

	max_event = evlist->max_event;
	if(max_event >= MAX_EVENTS) {
645 646
		locate_available_thread(manager);
		return (ISC_FALSE);
647 648 649 650 651 652
	}

	evlist->aSockList[max_event] = sock;
	evlist->aEventList[max_event] = sock->hEvent;
	evlist->max_event++;
	evlist->total_events++;
653 654 655
	sock->hAlert = evlist->aEventList[0];
	sock->evthread_id = GetCurrentThreadId();
	return (ISC_TRUE);
656
}
657

658
/*
659 660
 * Note that the eventLock is locked before calling this function.
 * All Events and associated sockets are closed here.
661
 */
662 663
isc_boolean_t
socket_eventlist_delete(event_change_t *evchange, sock_event_list *evlist) {
664 665
	int i;
	WSAEVENT hEvent;
666
	int iEvent = -1;
667

668 669
	REQUIRE(evchange != NULL);
	/*  Make sure this is the right thread from which to delete the event */
670
	if (evchange->evthread_id != GetCurrentThreadId())
671
		return (ISC_FALSE);
672

673 674 675
	REQUIRE(evlist != NULL);
	REQUIRE(evchange->hEvent != NULL);
	hEvent = evchange->hEvent;
676

677 678 679 680 681 682 683
	/* Find the Event */
	for (i = 1; i < evlist->max_event; i++) {
		if (evlist->aEventList[i] == hEvent) {
			iEvent = i;
			break;
		}
	}
684

685 686 687
	/* Actual event start at 1 */
	if (iEvent < 1)
		return (ISC_FALSE);
688

689
	for(i = iEvent; i < (evlist->max_event - 1); i++) {
690 691 692
		evlist->aEventList[i] = evlist->aEventList[i + 1];
		evlist->aSockList[i] = evlist->aSockList[i + 1];
	}
693

694 695 696 697 698 699 700
	evlist->aEventList[evlist->max_event - 1] = 0;
	evlist->aSockList[evlist->max_event - 1] = NULL;

	/* Cleanup */
	WSACloseEvent(hEvent);
	if (evchange->fd >= 0)
		closesocket(evchange->fd);
701 702
	evlist->max_event--;
	evlist->total_events--;
703

704
	return (ISC_TRUE);
705
}
706

707 708
/*
 * Get the event changes off of the list and apply the
709 710 711 712 713 714 715 716 717 718 719
 * requested changes. The manager lock is taken out at
 * the start of this function to prevent other event_wait
 * threads processing the same information at the same
 * time. The queue may not be empty on exit since other
 * threads may be involved in processing the queue.
 *
 * The deletes are done first in order that there be space
 * available for the events being added in the same thread
 * in case the event list is almost full. This reduces the
 * probability of having to create another thread which would
 * increase overhead costs.
720 721 722 723
 */
isc_result_t
process_eventlist(sock_event_list *evlist, isc_socketmgr_t *manager) {
	event_change_t *evchange;
724 725 726 727 728 729
	event_change_t *next;
	isc_boolean_t del;

	REQUIRE(evlist != NULL);

	LOCK(&manager->lock);
730

731 732 733
	/*
	 * First the deletes.
	 */
734
	evchange = ISC_LIST_HEAD(manager->event_updates);
735
	while (evchange != NULL) {
736 737
		next = ISC_LIST_NEXT(evchange, link);
		del = ISC_FALSE;
738
		if (evchange->action == EVENT_DELETE) {
739 740
			del = socket_eventlist_delete(evchange, evlist);

741 742 743 744
			/*
			 * Delete only if this thread's socket list was
			 * updated.
			 */
745 746 747 748 749 750
			if (del) {
				ISC_LIST_DEQUEUE(manager->event_updates,
						 evchange, link);
				HeapFree(hHeapHandle, 0, evchange);
				manager->event_written--;
			}
751
		}
752
		evchange = next;
753
	}
754 755 756 757

	/*
	 * Now the adds.
	 */
758 759 760 761
	evchange = ISC_LIST_HEAD(manager->event_updates);
	while (evchange != NULL) {
		next = ISC_LIST_NEXT(evchange, link);
		del = ISC_FALSE;
762
		if (evchange->action == EVENT_ADD) {
763 764
			del = socket_eventlist_add(evchange, evlist, manager);

765 766 767 768
			/*
			 * Delete only if this thread's socket list was
			 * updated.
			 */
769 770 771 772 773 774 775 776 777 778
			if (del) {
				ISC_LIST_DEQUEUE(manager->event_updates,
						 evchange, link);
				HeapFree(hHeapHandle, 0, evchange);
				manager->event_written--;
			}
		}
		evchange = next;
	}
	UNLOCK(&manager->lock);
779 780
	return (ISC_R_SUCCESS);
}
781

782 783 784 785 786
/*
 * Add the event list changes to the queue and notify the
 * event loop
 */
static void
787
notify_eventlist(isc_socket_t *sock, isc_socketmgr_t *manager,
788 789
		 unsigned int action)
{
790 791

	event_change_t *evchange;
792 793 794

	REQUIRE(VALID_MANAGER(manager));
	REQUIRE(sock != NULL);
795 796 797 798 799
	
	evchange = HeapAlloc(hHeapHandle, HEAP_ZERO_MEMORY,
			     sizeof(event_change_t));
	evchange->sock = sock;
	evchange->action = action;
800
	evchange->hEvent = sock->hEvent;
801
	evchange->fd = sock->fd;
802
	evchange->evthread_id = sock->evthread_id;
803

804 805
	LOCK(&manager->lock);
	ISC_LIST_APPEND(manager->event_updates, evchange, link);
806
	sock->manager->event_written++;
807 808 809 810 811 812 813
	UNLOCK(&manager->lock);

	/* Alert the Wait List */
	if (sock->hAlert != NULL)
		WSASetEvent(sock->hAlert);
	else
		WSASetEvent(manager->prime_alert);
814
}
815

816 817 818 819 820 821 822
/*
 * Note that the socket is already locked before calling this function
 */
isc_result_t
socket_event_add(isc_socket_t *sock, long type) {
	int stat;
	WSAEVENT hEvent;
823 824
	char strbuf[ISC_STRERRORSIZE];
	const char *msg;
825 826

	REQUIRE(sock != NULL);
827

828 829 830
	hEvent = WSACreateEvent();
	if (hEvent == WSA_INVALID_EVENT) {
		stat = WSAGetLastError();
831 832 833 834 835
		isc__strerror(stat, strbuf, sizeof(strbuf));
		msg = isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,	
				     ISC_MSG_FAILED, "failed"),
		UNEXPECTED_ERROR(__FILE__, __LINE__, "WSACreateEvent: %s: %s",
				 msg, strbuf);
836 837 838 839
		return (ISC_R_UNEXPECTED);
	}
	if (WSAEventSelect(sock->fd, hEvent, type) != 0) {
		stat = WSAGetLastError();
840 841 842 843 844
		isc__strerror(stat, strbuf, sizeof(strbuf));
		msg = isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,	
				     ISC_MSG_FAILED, "failed");
		UNEXPECTED_ERROR(__FILE__, __LINE__, "WSAEventSelect: %s: %s",
				 msg, strbuf);
845 846 847
		return (ISC_R_UNEXPECTED);
	}
	sock->hEvent = hEvent;
848

849
	sock->wait_type = type;
850
	notify_eventlist(sock, sock->manager, EVENT_ADD);
851 852
	return (ISC_R_SUCCESS);
}
853

Danny Mayer's avatar
Danny Mayer committed
854
/*
855
 * Note that the socket is not locked before calling this function
Danny Mayer's avatar
Danny Mayer committed
856
 */
857 858 859 860 861
void
socket_event_delete(isc_socket_t *sock) {

	REQUIRE(sock != NULL);
	REQUIRE(sock->hEvent != NULL);
Danny Mayer's avatar
Danny Mayer committed
862

863 864 865
	if (sock->hEvent != NULL) {
		sock->wait_type = 0;
		sock->pending_close = 1;
866
		notify_eventlist(sock, sock->manager, EVENT_DELETE);
867
		sock->hEvent = NULL;
868 869
		sock->hAlert = NULL;
		sock->evthread_id = 0;
870 871
	}
}
872

873 874 875 876 877 878 879 880 881
/*
 * Routine to cleanup and then close the socket.
 * Only close the socket here if it is NOT associated
 * with an event, otherwise the WSAWaitForMultipleEvents
 * may fail due to the fact that the the Wait should not
 * be running while closing an event or a socket.
 */
void
socket_close(isc_socket_t *sock) {
882 883

	REQUIRE(sock != NULL);
884 885 886 887 888 889 890 891 892 893 894 895
	sock->pending_close = 1;
	if (sock->hEvent != NULL)
		socket_event_delete(sock);
	else {
		closesocket(sock->fd);
	}
	if (sock->iocp) {
		sock->iocp = 0;
		InterlockedDecrement(&iocp_total);
	}

}
896

Danny Mayer's avatar
Danny Mayer committed
897 898 899
/*
 * Initialize socket services
 */
Andreas Gustafsson's avatar
Andreas Gustafsson committed
900
BOOL InitSockets() {
Danny Mayer's avatar
Danny Mayer committed
901 902 903 904 905 906 907 908
	WORD wVersionRequested;
	WSADATA wsaData;
	int err;

	/* Need Winsock 2.0 or better */
	wVersionRequested = MAKEWORD(2, 0);
 
	err = WSAStartup(wVersionRequested, &wsaData);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
909
	if ( err != 0 ) {
Danny Mayer's avatar
Danny Mayer committed
910
		/* Tell the user that we could not find a usable Winsock DLL */
911
		return(FALSE);
Danny Mayer's avatar
Danny Mayer committed
912
	}
913
	return(TRUE);
Danny Mayer's avatar
Danny Mayer committed
914 915
}

Andreas Gustafsson's avatar
Andreas Gustafsson committed
916
int
917
internal_sendmsg(isc_socket_t *sock, IoCompletionInfo *lpo,
918 919
		 struct msghdr *messagehdr, int flags, int *Error)
{
920
	int Result;
Danny Mayer's avatar
Danny Mayer committed
921 922
	DWORD BytesSent;
	DWORD Flags = flags;
923 924 925 926
	int total_sent;

	*Error = 0;
	Result = WSASendTo((SOCKET) sock->fd, 
927 928
			messagehdr->msg_iov, 
			messagehdr->msg_iovlen, 
929 930
			&BytesSent,
			Flags,
931 932
			messagehdr->msg_name,
			messagehdr->msg_namelen,
933 934 935 936
			(LPOVERLAPPED) lpo,
			NULL);

	total_sent = (int) BytesSent;
Danny Mayer's avatar
Danny Mayer committed
937
    
938 939 940 941 942 943
	/* Check for errors.*/
	if (Result == SOCKET_ERROR) {

		*Error = WSAGetLastError();
        
	        switch (*Error) {
944 945 946 947 948 949
		case WSA_IO_INCOMPLETE :
		case WSA_WAIT_IO_COMPLETION :
		case WSA_IO_PENDING :
			sock->pending_send++;
		case NO_ERROR :
			break;
950

951 952 953 954 955 956 957
		default :
			return (-1);
			break;
		}
	} else
		sock->pending_send++;
	if (lpo != NULL)
958 959 960
		return (0);
	else
		return (total_sent);
Danny Mayer's avatar
Danny Mayer committed
961 962 963
}

int
964
internal_recvmsg(isc_socket_t *sock, IoCompletionInfo *lpo,
965 966
		 struct msghdr *messagehdr, int flags, int *Error)
{
967 968 969
	DWORD Flags = 0;
	DWORD NumBytes = 0;
	int total_bytes = 0;
Danny Mayer's avatar
Danny Mayer committed
970
	int Result;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
971

972 973
	*Error = 0;
	Result = WSARecvFrom((SOCKET) sock->fd,
974 975 976 977 978 979 980 981
			     messagehdr->msg_iov,
			     messagehdr->msg_iovlen,
			     &NumBytes,
			     &Flags,
			     messagehdr->msg_name,
			     (int *)&(messagehdr->msg_namelen),
			     (LPOVERLAPPED) lpo,
			     NULL);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
982

983
	total_bytes = (int) NumBytes;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
984 985 986

	/* Check for errors. */
	if (Result == SOCKET_ERROR) {
987 988

		*Error = WSAGetLastError();
Danny Mayer's avatar
Danny Mayer committed
989
        
990
	        switch (*Error) {
991 992 993 994 995 996
		case WSA_IO_INCOMPLETE:
		case WSA_WAIT_IO_COMPLETION:
		case WSA_IO_PENDING:
			sock->pending_recv++;
		case NO_ERROR:
			break;
Danny Mayer's avatar
Danny Mayer committed
997

998 999 1000 1001 1002 1003
		default :
			return (-1);
			break;
		}
	} else
		sock->pending_recv++;
1004 1005

	/* Return the flags received in header */
1006
	messagehdr->msg_flags = Flags;
1007
	if (lpo != NULL)
1008 1009 1010 1011
		return (-1);
	else
		return (total_bytes);
} 
Danny Mayer's avatar
Danny Mayer committed
1012 1013

static void
1014 1015 1016
manager_log(isc_socketmgr_t *sockmgr, isc_logcategory_t *category,
	    isc_logmodule_t *module, int level, const char *fmt, ...)
{
Danny Mayer's avatar
Danny Mayer committed
1017 1018 1019
	char msgbuf[2048];
	va_list ap;

1020
	if (!isc_log_wouldlog(isc_lctx, level))
Danny Mayer's avatar
Danny Mayer committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
		return;

	va_start(ap, fmt);
	vsnprintf(msgbuf, sizeof(msgbuf), fmt, ap);
	va_end(ap);

	isc_log_write(isc_lctx, category, module, level,
		      "sockmgr %p: %s", sockmgr, msgbuf);
}

1031 1032 1033 1034 1035
static void
socket_log(isc_socket_t *sock, isc_sockaddr_t *address,
	   isc_logcategory_t *category, isc_logmodule_t *module, int level,
	   isc_msgcat_t *msgcat, int msgset, int message,
	   const char *fmt, ...) ISC_FORMAT_PRINTF(9, 10);
1036

Danny Mayer's avatar
Danny Mayer committed
1037 1038 1039 1040
static void
socket_log(isc_socket_t *sock, isc_sockaddr_t *address,
	   isc_logcategory_t *category, isc_logmodule_t *module, int level,
	   isc_msgcat_t *msgcat, int msgset, int message,
1041 1042
	   const char *fmt, ...)
{
Danny Mayer's avatar
Danny Mayer committed
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	char msgbuf[2048];
	char peerbuf[256];
	va_list ap;

	if (! isc_log_wouldlog(isc_lctx, level))
		return;

	va_start(ap, fmt);
	vsnprintf(msgbuf, sizeof(msgbuf), fmt, ap);
	va_end(ap);

	if (address == NULL) {
		isc_log_iwrite(isc_lctx, category, module, level,
			       msgcat, msgset, message,
			       "socket %p: %s", sock, msgbuf);
1058
	} else {
Mark Andrews's avatar
Mark Andrews committed
1059
		isc_sockaddr_format(address, peerbuf, sizeof(peerbuf));
1060 1061 1062
		isc_log_iwrite(isc_lctx, category, module, level,
			       msgcat, msgset, message,
			       "socket %p %s: %s", sock, peerbuf, msgbuf);
Danny Mayer's avatar
Danny Mayer committed
1063 1064
	}
}
1065

Danny Mayer's avatar
Danny Mayer committed
1066
/*
1067
 * Make an fd SOCKET non-blocking.
Danny Mayer's avatar
Danny Mayer committed
1068 1069
 */
static isc_result_t
1070
make_nonblock(SOCKET fd) {
Danny Mayer's avatar
Danny Mayer committed
1071 1072
	int ret;
	unsigned long flags = 1;
1073
	char strbuf[ISC_STRERRORSIZE];
Danny Mayer's avatar
Danny Mayer committed
1074 1075

	/* Set the socket to non-blocking */
1076
	ret = ioctlsocket(fd, FIONBIO, &flags);
Danny Mayer's avatar
Danny Mayer committed
1077 1078

	if (ret == -1) {
1079
		isc__strerror(errno, strbuf, sizeof(strbuf));
Danny Mayer's avatar
Danny Mayer committed
1080 1081
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "ioctlsocket(%d, FIOBIO, %d): %s",
1082
				 fd, flags, strbuf);
Danny Mayer's avatar
Danny Mayer committed
1083 1084 1085 1086 1087 1088

		return (ISC_R_UNEXPECTED);
	}

	return (ISC_R_SUCCESS);
}
1089

Danny Mayer's avatar
Danny Mayer committed
1090
/*
1091 1092 1093 1094 1095 1096 1097 1098
 * Windows 2000 systems incorrectly cause UDP sockets using WASRecvFrom
 * to not work correctly, returning a WSACONNRESET error when a WSASendTo
 * fails with an "ICMP port unreachable" response and preventing the
 * socket from using the WSARecvFrom in subsequent operations.
 * The function below fixes this, but requires that Windows 2000
 * Service Pack 2 or later be installed on the system.  NT 4.0
 * systems are not affected by this and work correctly.
 * See Microsoft Knowledge Base Article Q263823 for details of this.
Danny Mayer's avatar
Danny Mayer committed
1099
 */
1100 1101 1102 1103 1104 1105 1106 1107 1108
isc_result_t
connection_reset_fix(SOCKET fd) {
	DWORD dwBytesReturned = 0;
	BOOL  bNewBehavior = FALSE;
	DWORD status;

	if(isc_win32os_majorversion() < 5)
		return (ISC_R_SUCCESS); /*  NT 4.0 has no problem */

1109
	/* disable bad behavior using IOCTL: SIO_UDP_CONNRESET */
1110 1111 1112 1113 1114
	status = WSAIoctl(fd, SIO_UDP_CONNRESET, &bNewBehavior,
			  sizeof(bNewBehavior), NULL, 0,
			  &dwBytesReturned, NULL, NULL);
	if (status != SOCKET_ERROR)
		return (ISC_R_SUCCESS);
1115 1116 1117 1118 1119
	else {
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "WSAIoctl(SIO_UDP_CONNRESET, oldBehaviour) %s",
				 isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
						ISC_MSG_FAILED, "failed"));
1120
		return (ISC_R_UNEXPECTED);
1121
	}
Danny Mayer's avatar
Danny Mayer committed
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
}

/*
 * Construct an iov array and attach it to the msghdr passed in.  This is
 * the SEND constructor, which will use the used region of the buffer
 * (if using a buffer list) or will use the internal region (if a single
 * buffer I/O is requested).
 *
 * Nothing can be NULL, and the done event must list at least one buffer
 * on the buffer linked list for this function to be meaningful.
 *
 * If write_countp != NULL, *write_countp will hold the number of bytes
 * this transaction can send.
 */
static void
build_msghdr_send(isc_socket_t *sock, isc_socketevent_t *dev,
		  struct msghdr *msg, char *cmsg,
1139 1140
		  WSABUF *iov, size_t *write_countp)
{
Danny Mayer's avatar
Danny Mayer committed
1141 1142 1143 1144 1145 1146
	unsigned int iovcount;
	isc_buffer_t *buffer;
	isc_region_t used;
	size_t write_count;
	size_t skip_count;

Mark Andrews's avatar
Mark Andrews committed
1147
	memset(msg, 0, sizeof(*msg));
Danny Mayer's avatar
Danny Mayer committed
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163