5 * Copyright (c) 1995 Open Market, Inc.
8 * This file contains proprietary and confidential information and
9 * remains the unpublished property of Open Market, Inc. Use,
10 * disclosure, or reproduction is prohibited except as permitted by
11 * express written license agreement with Open Market, Inc.
14 * snapper@openmarket.com
16 * (Special thanks to Karen and Bill. They made my job much easier and
17 * significantly more enjoyable.)
20 static const char rcsid[] = "$Id: os_win32.c,v 1.26 2001/12/21 02:58:33 robs Exp $";
23 #define WIN32_LEAN_AND_MEAN
29 #include <sys/timeb.h>
31 #define DLLAPI __declspec(dllexport)
36 #define WIN32_OPEN_MAX 128 /* XXX: Small hack */
39 * millisecs to wait for a client connection before checking the
40 * shutdown flag (then go back to waiting for a connection, etc).
42 #define ACCEPT_TIMEOUT 1000
44 #define MUTEX_VARNAME "_FCGI_MUTEX_"
45 #define SHUTDOWN_EVENT_NAME "_FCGI_SHUTDOWN_EVENT_"
46 #define LOCALHOST "localhost"
48 static HANDLE hIoCompPort = INVALID_HANDLE_VALUE;
49 static HANDLE hStdinCompPort = INVALID_HANDLE_VALUE;
50 static HANDLE hStdinThread = INVALID_HANDLE_VALUE;
52 static HANDLE stdioHandles[3] = {INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE,
53 INVALID_HANDLE_VALUE};
55 // This is a nail for listening to more than one port..
56 static HANDLE acceptMutex = INVALID_HANDLE_VALUE;
58 static BOOLEAN shutdownPending = FALSE;
59 static BOOLEAN shutdownNow = FALSE;
62 * An enumeration of the file types
63 * supported by the FD_TABLE structure.
65 * XXX: Not all currently supported. This allows for future
85 * Structure used to map file handle and socket handle
86 * values into values that can be used to create unix-like
87 * select bitmaps, read/write for both sockets/files.
94 unsigned long instance;
96 int offset; /* only valid for async file writes */
97 LPDWORD offsetHighPtr; /* pointers to offset high and low words */
98 LPDWORD offsetLowPtr; /* only valid for async file writes (logs) */
99 HANDLE hMapMutex; /* mutex handle for multi-proc offset update */
100 LPVOID ovList; /* List of associated OVERLAPPED_REQUESTs */
104 * XXX Note there is no dyanmic sizing of this table, so if the
105 * number of open file descriptors exceeds WIN32_OPEN_MAX the
108 static struct FD_TABLE fdTable[WIN32_OPEN_MAX];
110 static CRITICAL_SECTION fdTableCritical;
112 struct OVERLAPPED_REQUEST {
113 OVERLAPPED overlapped;
114 unsigned long instance; /* file instance (won't match after a close) */
115 OS_AsyncProc procPtr; /* callback routine */
116 ClientData clientData; /* callback argument */
117 ClientData clientData1; /* additional clientData */
119 typedef struct OVERLAPPED_REQUEST *POVERLAPPED_REQUEST;
121 static const char *bindPathPrefix = "\\\\.\\pipe\\FastCGI\\";
123 static FILE_TYPE listenType = FD_UNUSED;
125 // XXX This should be a DESCRIPTOR
126 static HANDLE hListen = INVALID_HANDLE_VALUE;
128 static OVERLAPPED listenOverlapped;
129 static BOOLEAN libInitialized = FALSE;
132 *--------------------------------------------------------------
134 * Win32NewDescriptor --
136 * Set up for I/O descriptor masquerading.
139 * Returns "fake id" which masquerades as a UNIX-style "small
140 * non-negative integer" file/socket descriptor.
141 * Win32_* routine below will "do the right thing" based on the
142 * descriptor's actual type. -1 indicates failure.
145 * Entry in fdTable is reserved to represent the socket/file.
147 *--------------------------------------------------------------
149 static int Win32NewDescriptor(FILE_TYPE type, int fd, int desiredFd)
153 EnterCriticalSection(&fdTableCritical);
156 * If desiredFd is set, try to get this entry (this is used for
157 * mapping stdio handles). Otherwise try to get the fd entry.
158 * If this is not available, find a the first empty slot. .
160 if (desiredFd >= 0 && desiredFd < WIN32_OPEN_MAX)
162 if (fdTable[desiredFd].type == FD_UNUSED)
169 if (fd < WIN32_OPEN_MAX && fdTable[fd].type == FD_UNUSED)
177 for (i = 1; i < WIN32_OPEN_MAX; ++i)
179 if (fdTable[i].type == FD_UNUSED)
190 fdTable[index].fid.value = fd;
191 fdTable[index].type = type;
192 fdTable[index].path = NULL;
193 fdTable[index].Errno = NO_ERROR;
194 fdTable[index].status = 0;
195 fdTable[index].offset = -1;
196 fdTable[index].offsetHighPtr = fdTable[index].offsetLowPtr = NULL;
197 fdTable[index].hMapMutex = NULL;
198 fdTable[index].ovList = NULL;
201 LeaveCriticalSection(&fdTableCritical);
206 *--------------------------------------------------------------
210 * This thread performs I/O on stadard input. It is needed
211 * because you can't guarantee that all applications will
212 * create standard input with sufficient access to perform
213 * asynchronous I/O. Since we don't want to block the app
214 * reading from stdin we make it look like it's using I/O
215 * completion ports to perform async I/O.
218 * Data is read from stdin and posted to the io completion
224 *--------------------------------------------------------------
226 static void StdinThread(LPDWORD startup){
230 unsigned long bytesRead;
231 POVERLAPPED_REQUEST pOv;
233 // Touch the arg to prevent warning
238 * Block until a request to read from stdin comes in or a
239 * request to terminate the thread arrives (fd = -1).
241 if (!GetQueuedCompletionStatus(hStdinCompPort, &bytesRead, &fd,
242 (LPOVERLAPPED *)&pOv, (DWORD)-1) && !pOv) {
247 ASSERT((fd == STDIN_FILENO) || (fd == -1));
252 ASSERT(pOv->clientData1 != NULL);
254 if(ReadFile(stdioHandles[STDIN_FILENO], pOv->clientData1, bytesRead,
256 PostQueuedCompletionStatus(hIoCompPort, bytesRead,
257 STDIN_FILENO, (LPOVERLAPPED)pOv);
267 void OS_ShutdownPending(void)
269 shutdownPending = TRUE;
272 /* XXX Need a shutdown now event */
273 static DWORD WINAPI ShutdownRequestThread(LPVOID arg)
275 HANDLE shutdownEvent = (HANDLE) arg;
277 if (WaitForSingleObject(shutdownEvent, INFINITE) == WAIT_FAILED)
279 // Assuming it will happen again, all we can do is exit the thread
284 // "Simple reads and writes to properly-aligned 32-bit variables are atomic"
285 shutdownPending = TRUE;
287 // Before an accept() is entered the shutdownPending flag is checked.
288 // If set, OS_Accept() will return -1. If not, it waits
289 // on a connection request for one second, checks the flag, & repeats.
290 // Only one process/thread is allowed to do this at time by
291 // wrapping the accept() with mutex.
297 *--------------------------------------------------------------
301 * Set up the OS library for use.
304 * Returns 0 if success, -1 if not.
307 * Sockets initialized, pseudo file descriptors setup, etc.
309 *--------------------------------------------------------------
311 int OS_LibInit(int stdioFds[3])
318 char *cLenPtr = NULL;
324 InitializeCriticalSection(&fdTableCritical);
327 * Initialize windows sockets library.
329 wVersion = MAKEWORD(2,0);
330 err = WSAStartup( wVersion, &wsaData );
332 fprintf(stderr, "Error starting Windows Sockets. Error: %d",
338 * Create the I/O completion port to be used for our I/O queue.
340 if (hIoCompPort == INVALID_HANDLE_VALUE) {
341 hIoCompPort = CreateIoCompletionPort (INVALID_HANDLE_VALUE, NULL,
343 if(hIoCompPort == INVALID_HANDLE_VALUE) {
344 printf("<H2>OS_LibInit Failed CreateIoCompletionPort! ERROR: %d</H2>\r\n\r\n",
351 * If a shutdown event is in the env, save it (I don't see any to
352 * remove it from the environment out from under the application).
353 * Spawn a thread to wait on the shutdown request.
355 val = getenv(SHUTDOWN_EVENT_NAME);
358 HANDLE shutdownEvent = (HANDLE) atoi(val);
360 if (! CreateThread(NULL, 0, ShutdownRequestThread,
361 shutdownEvent, 0, NULL))
367 if (acceptMutex == INVALID_HANDLE_VALUE)
369 /* If an accept mutex is in the env, use it */
370 val = getenv(MUTEX_VARNAME);
373 acceptMutex = (HANDLE) atoi(val);
378 * Determine if this library is being used to listen for FastCGI
379 * connections. This is communicated by STDIN containing a
380 * valid handle to a listener object. In this case, both the
381 * "stdout" and "stderr" handles will be INVALID (ie. closed) by
382 * the starting process.
384 * The trick is determining if this is a pipe or a socket...
386 * XXX: Add the async accept test to determine socket or handle to a
389 if((GetStdHandle(STD_OUTPUT_HANDLE) == INVALID_HANDLE_VALUE) &&
390 (GetStdHandle(STD_ERROR_HANDLE) == INVALID_HANDLE_VALUE) &&
391 (GetStdHandle(STD_INPUT_HANDLE) != INVALID_HANDLE_VALUE) )
393 DWORD pipeMode = PIPE_READMODE_BYTE | PIPE_WAIT;
394 HANDLE oldStdIn = GetStdHandle(STD_INPUT_HANDLE);
396 // Move the handle to a "low" number
397 if (! DuplicateHandle(GetCurrentProcess(), oldStdIn,
398 GetCurrentProcess(), &hListen,
399 0, TRUE, DUPLICATE_SAME_ACCESS))
404 if (! SetStdHandle(STD_INPUT_HANDLE, hListen))
409 CloseHandle(oldStdIn);
412 * Set the pipe handle state so that it operates in wait mode.
414 * NOTE: The listenFd is not mapped to a pseudo file descriptor
415 * as all work done on it is contained to the OS library.
417 * XXX: Initial assumption is that SetNamedPipeHandleState will
418 * fail if this is an IP socket...
420 if (SetNamedPipeHandleState(hListen, &pipeMode, NULL, NULL))
422 listenType = FD_PIPE_SYNC;
423 listenOverlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
427 listenType = FD_SOCKET_SYNC;
432 * If there are no stdioFds passed in, we're done.
434 if(stdioFds == NULL) {
440 * Setup standard input asynchronous I/O. There is actually a separate
441 * thread spawned for this purpose. The reason for this is that some
442 * web servers use anonymous pipes for the connection between itself
443 * and a CGI application. Anonymous pipes can't perform asynchronous
444 * I/O or use I/O completion ports. Therefore in order to present a
445 * consistent I/O dispatch model to an application we emulate I/O
446 * completion port behavior by having the standard input thread posting
447 * messages to the hIoCompPort which look like a complete overlapped
448 * I/O structure. This keeps the event dispatching simple from the
449 * application perspective.
451 stdioHandles[STDIN_FILENO] = GetStdHandle(STD_INPUT_HANDLE);
453 if(!SetHandleInformation(stdioHandles[STDIN_FILENO],
454 HANDLE_FLAG_INHERIT, 0)) {
456 * XXX: Causes error when run from command line. Check KB
457 err = GetLastError();
463 if ((fakeFd = Win32NewDescriptor(FD_PIPE_SYNC,
464 (int)stdioHandles[STDIN_FILENO],
465 STDIN_FILENO)) == -1) {
469 * Set stdin equal to our pseudo FD and create the I/O completion
470 * port to be used for async I/O.
472 stdioFds[STDIN_FILENO] = fakeFd;
476 * Create the I/O completion port to be used for communicating with
477 * the thread doing I/O on standard in. This port will carry read
478 * and possibly thread termination requests to the StdinThread.
480 if (hStdinCompPort == INVALID_HANDLE_VALUE) {
481 hStdinCompPort = CreateIoCompletionPort (INVALID_HANDLE_VALUE, NULL,
483 if(hStdinCompPort == INVALID_HANDLE_VALUE) {
484 printf("<H2>OS_LibInit Failed CreateIoCompletionPort: STDIN! ERROR: %d</H2>\r\n\r\n",
491 * Create the thread that will read stdin if the CONTENT_LENGTH
494 if((cLenPtr = getenv("CONTENT_LENGTH")) != NULL &&
496 hStdinThread = CreateThread(NULL, 8192,
497 (LPTHREAD_START_ROUTINE)&StdinThread,
499 if (hStdinThread == NULL) {
500 printf("<H2>OS_LibInit Failed to create STDIN thread! ERROR: %d</H2>\r\n\r\n",
507 * STDOUT will be used synchronously.
509 * XXX: May want to convert this so that it could be used for OVERLAPPED
510 * I/O later. If so, model it after the Stdin I/O as stdout is
511 * also incapable of async I/O on some servers.
513 stdioHandles[STDOUT_FILENO] = GetStdHandle(STD_OUTPUT_HANDLE);
514 if(!SetHandleInformation(stdioHandles[STDOUT_FILENO],
515 HANDLE_FLAG_INHERIT, FALSE)) {
520 if ((fakeFd = Win32NewDescriptor(FD_PIPE_SYNC,
521 (int)stdioHandles[STDOUT_FILENO],
522 STDOUT_FILENO)) == -1) {
526 * Set stdout equal to our pseudo FD
528 stdioFds[STDOUT_FILENO] = fakeFd;
531 stdioHandles[STDERR_FILENO] = GetStdHandle(STD_ERROR_HANDLE);
532 if(!SetHandleInformation(stdioHandles[STDERR_FILENO],
533 HANDLE_FLAG_INHERIT, FALSE)) {
537 if ((fakeFd = Win32NewDescriptor(FD_PIPE_SYNC,
538 (int)stdioHandles[STDERR_FILENO],
539 STDERR_FILENO)) == -1) {
543 * Set stderr equal to our pseudo FD
545 stdioFds[STDERR_FILENO] = fakeFd;
552 *--------------------------------------------------------------
556 * Shutdown the OS library.
562 * Memory freed, handles closed.
564 *--------------------------------------------------------------
566 void OS_LibShutdown()
569 if (hIoCompPort != INVALID_HANDLE_VALUE)
571 CloseHandle(hIoCompPort);
572 hIoCompPort = INVALID_HANDLE_VALUE;
575 if (hStdinCompPort != INVALID_HANDLE_VALUE)
577 CloseHandle(hStdinCompPort);
578 hStdinCompPort = INVALID_HANDLE_VALUE;
581 if (acceptMutex != INVALID_HANDLE_VALUE)
583 ReleaseMutex(acceptMutex);
586 DisconnectNamedPipe(hListen);
595 *--------------------------------------------------------------
597 * Win32FreeDescriptor --
599 * Free I/O descriptor entry in fdTable.
602 * Frees I/O descriptor entry in fdTable.
607 *--------------------------------------------------------------
609 static void Win32FreeDescriptor(int fd)
611 /* Catch it if fd is a bogus value */
612 ASSERT((fd >= 0) && (fd < WIN32_OPEN_MAX));
614 EnterCriticalSection(&fdTableCritical);
616 if (fdTable[fd].type != FD_UNUSED)
618 switch (fdTable[fd].type)
623 /* Free file path string */
624 ASSERT(fdTable[fd].path != NULL);
625 free(fdTable[fd].path);
626 fdTable[fd].path = NULL;
633 ASSERT(fdTable[fd].path == NULL);
635 fdTable[fd].type = FD_UNUSED;
636 fdTable[fd].path = NULL;
637 fdTable[fd].Errno = NO_ERROR;
638 fdTable[fd].offsetHighPtr = fdTable[fd].offsetLowPtr = NULL;
640 if (fdTable[fd].hMapMutex != NULL)
642 CloseHandle(fdTable[fd].hMapMutex);
643 fdTable[fd].hMapMutex = NULL;
647 LeaveCriticalSection(&fdTableCritical);
652 static short getPort(const char * bindPath)
655 char * p = strchr(bindPath, ':');
664 port = (short) atoi(buf);
671 * OS_CreateLocalIpcFd --
673 * This procedure is responsible for creating the listener pipe
674 * on Windows NT for local process communication. It will create a
675 * named pipe and return a file descriptor to it to the caller.
678 * Listener pipe created. This call returns either a valid
679 * pseudo file descriptor or -1 on error.
682 * Listener pipe and IPC address are stored in the FCGI info
684 * 'errno' will set on errors (-1 is returned).
686 *----------------------------------------------------------------------
688 int OS_CreateLocalIpcFd(const char *bindPath, int backlog)
691 short port = getPort(bindPath);
693 if (acceptMutex == INVALID_HANDLE_VALUE)
695 acceptMutex = CreateMutex(NULL, FALSE, NULL);
696 if (acceptMutex == NULL) return -2;
697 if (! SetHandleInformation(acceptMutex, HANDLE_FLAG_INHERIT, TRUE)) return -3;
700 // There's nothing to be gained (at the moment) by a shutdown Event
702 if (port && *bindPath != ':' && strncmp(bindPath, LOCALHOST, strlen(LOCALHOST)))
704 fprintf(stderr, "To start a service on a TCP port can not "
705 "specify a host name.\n"
706 "You should either use \"localhost:<port>\" or "
707 " just use \":<port>.\"\n");
711 listenType = (port) ? FD_SOCKET_SYNC : FD_PIPE_ASYNC;
716 struct sockaddr_in sockAddr;
717 int sockLen = sizeof(sockAddr);
719 memset(&sockAddr, 0, sizeof(sockAddr));
720 sockAddr.sin_family = AF_INET;
721 sockAddr.sin_addr.s_addr = htonl(INADDR_ANY);
722 sockAddr.sin_port = htons(port);
724 listenSock = socket(AF_INET, SOCK_STREAM, 0);
725 if (listenSock == INVALID_SOCKET)
730 if (bind(listenSock, (struct sockaddr *) &sockAddr, sockLen) )
735 if (listen(listenSock, backlog))
740 pseudoFd = Win32NewDescriptor(listenType, listenSock, -1);
744 closesocket(listenSock);
748 hListen = (HANDLE) listenSock;
752 HANDLE hListenPipe = INVALID_HANDLE_VALUE;
753 char *pipePath = malloc(strlen(bindPathPrefix) + strlen(bindPath) + 1);
760 strcpy(pipePath, bindPathPrefix);
761 strcat(pipePath, bindPath);
763 hListenPipe = CreateNamedPipe(pipePath,
764 PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
765 PIPE_TYPE_BYTE | PIPE_WAIT | PIPE_READMODE_BYTE,
766 PIPE_UNLIMITED_INSTANCES,
767 4096, 4096, 0, NULL);
771 if (hListenPipe == INVALID_HANDLE_VALUE)
776 if (! SetHandleInformation(hListenPipe, HANDLE_FLAG_INHERIT, TRUE))
781 pseudoFd = Win32NewDescriptor(listenType, (int) hListenPipe, -1);
785 CloseHandle(hListenPipe);
789 hListen = (HANDLE) hListenPipe;
796 *----------------------------------------------------------------------
800 * Create the pipe pathname connect to the remote application if
804 * -1 if fail or a valid handle if connection succeeds.
807 * Remote connection established.
809 *----------------------------------------------------------------------
811 int OS_FcgiConnect(char *bindPath)
813 short port = getPort(bindPath);
820 struct sockaddr_in sockAddr;
821 int sockLen = sizeof(sockAddr);
824 if (*bindPath != ':')
826 char * p = strchr(bindPath, ':');
827 int len = p - bindPath + 1;
830 strncpy(host, bindPath, len);
834 hp = gethostbyname(host ? host : LOCALHOST);
843 fprintf(stderr, "Unknown host: %s\n", bindPath);
847 memset(&sockAddr, 0, sizeof(sockAddr));
848 sockAddr.sin_family = AF_INET;
849 memcpy(&sockAddr.sin_addr, hp->h_addr, hp->h_length);
850 sockAddr.sin_port = htons(port);
852 sock = socket(AF_INET, SOCK_STREAM, 0);
853 if (sock == INVALID_SOCKET)
858 if (! connect(sock, (struct sockaddr *) &sockAddr, sockLen))
864 pseudoFd = Win32NewDescriptor(FD_SOCKET_SYNC, sock, -1);
873 char *pipePath = malloc(strlen(bindPathPrefix) + strlen(bindPath) + 1);
881 strcpy(pipePath, bindPathPrefix);
882 strcat(pipePath, bindPath);
884 hPipe = CreateFile(pipePath,
885 GENERIC_WRITE | GENERIC_READ,
886 FILE_SHARE_READ | FILE_SHARE_WRITE,
889 FILE_FLAG_OVERLAPPED,
894 if( hPipe == INVALID_HANDLE_VALUE)
899 pseudoFd = Win32NewDescriptor(FD_PIPE_ASYNC, (int) hPipe, -1);
908 * Set stdin equal to our pseudo FD and create the I/O completion
909 * port to be used for async I/O.
911 if (! CreateIoCompletionPort(hPipe, hIoCompPort, pseudoFd, 1))
913 Win32FreeDescriptor(pseudoFd);
923 *--------------------------------------------------------------
927 * Pass through to the appropriate NT read function.
930 * Returns number of byes read. Mimics unix read:.
931 * n bytes read, 0 or -1 failure: errno contains actual error
936 *--------------------------------------------------------------
938 int OS_Read(int fd, char * buf, size_t len)
943 ASSERT((fd >= 0) && (fd < WIN32_OPEN_MAX));
945 if (shutdownNow) return -1;
947 switch (fdTable[fd].type)
954 if (ReadFile(fdTable[fd].fid.fileHandle, buf, len, &bytesRead, NULL))
960 fdTable[fd].Errno = GetLastError();
966 case FD_SOCKET_ASYNC:
968 ret = recv(fdTable[fd].fid.sock, buf, len, 0);
969 if (ret == SOCKET_ERROR)
971 fdTable[fd].Errno = WSAGetLastError();
986 *--------------------------------------------------------------
990 * Perform a synchronous OS write.
993 * Returns number of bytes written. Mimics unix write:
994 * n bytes written, 0 or -1 failure (??? couldn't find man page).
999 *--------------------------------------------------------------
1001 int OS_Write(int fd, char * buf, size_t len)
1006 ASSERT(fd >= 0 && fd < WIN32_OPEN_MAX);
1008 if (shutdownNow) return -1;
1010 switch (fdTable[fd].type)
1017 if (WriteFile(fdTable[fd].fid.fileHandle, buf, len, &bytesWritten, NULL))
1023 fdTable[fd].Errno = GetLastError();
1028 case FD_SOCKET_SYNC:
1029 case FD_SOCKET_ASYNC:
1031 ret = send(fdTable[fd].fid.sock, buf, len, 0);
1032 if (ret == SOCKET_ERROR)
1034 fdTable[fd].Errno = WSAGetLastError();
1049 *----------------------------------------------------------------------
1053 * Spawns a new server listener process, and stores the information
1054 * relating to the child in the supplied record. A wait handler is
1055 * registered on the child's completion. This involves creating
1056 * a process on NT and preparing a command line with the required
1057 * state (currently a -childproc flag and the server socket to use
1058 * for accepting connections).
1061 * 0 if success, -1 if error.
1064 * Child process spawned.
1066 *----------------------------------------------------------------------
1068 int OS_SpawnChild(char *execPath, int listenFd)
1070 STARTUPINFO StartupInfo;
1071 PROCESS_INFORMATION pInfo;
1074 memset((void *)&StartupInfo, 0, sizeof(STARTUPINFO));
1075 StartupInfo.cb = sizeof (STARTUPINFO);
1076 StartupInfo.lpReserved = NULL;
1077 StartupInfo.lpReserved2 = NULL;
1078 StartupInfo.cbReserved2 = 0;
1079 StartupInfo.lpDesktop = NULL;
1082 * FastCGI on NT will set the listener pipe HANDLE in the stdin of
1083 * the new process. The fact that there is a stdin and NULL handles
1084 * for stdout and stderr tells the FastCGI process that this is a
1085 * FastCGI process and not a CGI process.
1087 StartupInfo.dwFlags = STARTF_USESTDHANDLES;
1089 * XXX: Do I have to dup the handle before spawning the process or is
1090 * it sufficient to use the handle as it's reference counted
1093 StartupInfo.hStdInput = fdTable[listenFd].fid.fileHandle;
1094 StartupInfo.hStdOutput = INVALID_HANDLE_VALUE;
1095 StartupInfo.hStdError = INVALID_HANDLE_VALUE;
1098 * Make the listener socket inheritable.
1100 success = SetHandleInformation(StartupInfo.hStdInput, HANDLE_FLAG_INHERIT,
1107 * XXX: Might want to apply some specific security attributes to the
1110 success = CreateProcess(execPath, /* LPCSTR address of module name */
1111 NULL, /* LPCSTR address of command line */
1112 NULL, /* Process security attributes */
1113 NULL, /* Thread security attributes */
1114 TRUE, /* Inheritable Handes inherited. */
1115 0, /* DWORD creation flags */
1116 NULL, /* Use parent environment block */
1117 NULL, /* Address of current directory name */
1118 &StartupInfo, /* Address of STARTUPINFO */
1119 &pInfo); /* Address of PROCESS_INFORMATION */
1128 *--------------------------------------------------------------
1130 * OS_AsyncReadStdin --
1132 * This initiates an asynchronous read on the standard
1133 * input handle. This handle is not guaranteed to be
1134 * capable of performing asynchronous I/O so we send a
1135 * message to the StdinThread to do the synchronous read.
1138 * -1 if error, 0 otherwise.
1141 * Asynchronous message is queued to the StdinThread and an
1142 * overlapped structure is allocated/initialized.
1144 *--------------------------------------------------------------
1146 int OS_AsyncReadStdin(void *buf, int len, OS_AsyncProc procPtr,
1147 ClientData clientData)
1149 POVERLAPPED_REQUEST pOv;
1151 ASSERT(fdTable[STDIN_FILENO].type != FD_UNUSED);
1153 pOv = (POVERLAPPED_REQUEST)malloc(sizeof(struct OVERLAPPED_REQUEST));
1155 memset((void *)pOv, 0, sizeof(struct OVERLAPPED_REQUEST));
1156 pOv->clientData1 = (ClientData)buf;
1157 pOv->instance = fdTable[STDIN_FILENO].instance;
1158 pOv->procPtr = procPtr;
1159 pOv->clientData = clientData;
1161 PostQueuedCompletionStatus(hStdinCompPort, len, STDIN_FILENO,
1167 *--------------------------------------------------------------
1171 * This initiates an asynchronous read on the file
1172 * handle which may be a socket or named pipe.
1174 * We also must save the ProcPtr and ClientData, so later
1175 * when the io completes, we know who to call.
1177 * We don't look at any results here (the ReadFile may
1178 * return data if it is cached) but do all completion
1179 * processing in OS_Select when we get the io completion
1180 * port done notifications. Then we call the callback.
1183 * -1 if error, 0 otherwise.
1186 * Asynchronous I/O operation is queued for completion.
1188 *--------------------------------------------------------------
1190 int OS_AsyncRead(int fd, int offset, void *buf, int len,
1191 OS_AsyncProc procPtr, ClientData clientData)
1194 POVERLAPPED_REQUEST pOv;
1197 * Catch any bogus fd values
1199 ASSERT((fd >= 0) && (fd < WIN32_OPEN_MAX));
1201 * Confirm that this is an async fd
1203 ASSERT(fdTable[fd].type != FD_UNUSED);
1204 ASSERT(fdTable[fd].type != FD_FILE_SYNC);
1205 ASSERT(fdTable[fd].type != FD_PIPE_SYNC);
1206 ASSERT(fdTable[fd].type != FD_SOCKET_SYNC);
1208 pOv = (POVERLAPPED_REQUEST)malloc(sizeof(struct OVERLAPPED_REQUEST));
1210 memset((void *)pOv, 0, sizeof(struct OVERLAPPED_REQUEST));
1212 * Only file offsets should be non-zero, but make sure.
1214 if (fdTable[fd].type == FD_FILE_ASYNC)
1215 if (fdTable[fd].offset >= 0)
1216 pOv->overlapped.Offset = fdTable[fd].offset;
1218 pOv->overlapped.Offset = offset;
1219 pOv->instance = fdTable[fd].instance;
1220 pOv->procPtr = procPtr;
1221 pOv->clientData = clientData;
1224 * ReadFile returns: TRUE success, FALSE failure
1226 if (!ReadFile(fdTable[fd].fid.fileHandle, buf, len, &bytesRead,
1227 (LPOVERLAPPED)pOv)) {
1228 fdTable[fd].Errno = GetLastError();
1229 if(fdTable[fd].Errno == ERROR_NO_DATA ||
1230 fdTable[fd].Errno == ERROR_PIPE_NOT_CONNECTED) {
1231 PostQueuedCompletionStatus(hIoCompPort, 0, fd, (LPOVERLAPPED)pOv);
1234 if(fdTable[fd].Errno != ERROR_IO_PENDING) {
1235 PostQueuedCompletionStatus(hIoCompPort, 0, fd, (LPOVERLAPPED)pOv);
1238 fdTable[fd].Errno = 0;
1244 *--------------------------------------------------------------
1248 * This initiates an asynchronous write on the "fake" file
1249 * descriptor (which may be a file, socket, or named pipe).
1250 * We also must save the ProcPtr and ClientData, so later
1251 * when the io completes, we know who to call.
1253 * We don't look at any results here (the WriteFile generally
1254 * completes immediately) but do all completion processing
1255 * in OS_DoIo when we get the io completion port done
1256 * notifications. Then we call the callback.
1259 * -1 if error, 0 otherwise.
1262 * Asynchronous I/O operation is queued for completion.
1264 *--------------------------------------------------------------
1266 int OS_AsyncWrite(int fd, int offset, void *buf, int len,
1267 OS_AsyncProc procPtr, ClientData clientData)
1270 POVERLAPPED_REQUEST pOv;
1273 * Catch any bogus fd values
1275 ASSERT((fd >= 0) && (fd < WIN32_OPEN_MAX));
1277 * Confirm that this is an async fd
1279 ASSERT(fdTable[fd].type != FD_UNUSED);
1280 ASSERT(fdTable[fd].type != FD_FILE_SYNC);
1281 ASSERT(fdTable[fd].type != FD_PIPE_SYNC);
1282 ASSERT(fdTable[fd].type != FD_SOCKET_SYNC);
1284 pOv = (POVERLAPPED_REQUEST)malloc(sizeof(struct OVERLAPPED_REQUEST));
1286 memset((void *)pOv, 0, sizeof(struct OVERLAPPED_REQUEST));
1288 * Only file offsets should be non-zero, but make sure.
1290 if (fdTable[fd].type == FD_FILE_ASYNC)
1292 * Only file opened via OS_AsyncWrite with
1293 * O_APPEND will have an offset != -1.
1295 if (fdTable[fd].offset >= 0)
1297 * If the descriptor has a memory mapped file
1298 * handle, take the offsets from there.
1300 if (fdTable[fd].hMapMutex != NULL) {
1302 * Wait infinitely; this *should* not cause problems.
1304 WaitForSingleObject(fdTable[fd].hMapMutex, INFINITE);
1307 * Retrieve the shared offset values.
1309 pOv->overlapped.OffsetHigh = *(fdTable[fd].offsetHighPtr);
1310 pOv->overlapped.Offset = *(fdTable[fd].offsetLowPtr);
1313 * Update the shared offset values for the next write
1315 *(fdTable[fd].offsetHighPtr) += 0; /* XXX How do I handle overflow */
1316 *(fdTable[fd].offsetLowPtr) += len;
1318 ReleaseMutex(fdTable[fd].hMapMutex);
1320 pOv->overlapped.Offset = fdTable[fd].offset;
1322 pOv->overlapped.Offset = offset;
1323 pOv->instance = fdTable[fd].instance;
1324 pOv->procPtr = procPtr;
1325 pOv->clientData = clientData;
1328 * WriteFile returns: TRUE success, FALSE failure
1330 if (!WriteFile(fdTable[fd].fid.fileHandle, buf, len, &bytesWritten,
1331 (LPOVERLAPPED)pOv)) {
1332 fdTable[fd].Errno = GetLastError();
1333 if(fdTable[fd].Errno != ERROR_IO_PENDING) {
1334 PostQueuedCompletionStatus(hIoCompPort, 0, fd, (LPOVERLAPPED)pOv);
1337 fdTable[fd].Errno = 0;
1339 if (fdTable[fd].offset >= 0)
1340 fdTable[fd].offset += len;
1345 *--------------------------------------------------------------
1349 * Closes the descriptor with routine appropriate for
1350 * descriptor's type.
1353 * Socket or file is closed. Return values mimic Unix close:
1354 * 0 success, -1 failure
1357 * Entry in fdTable is marked as free.
1359 *--------------------------------------------------------------
1361 int OS_Close(int fd)
1366 * Catch it if fd is a bogus value
1368 ASSERT((fd >= 0) && (fd < WIN32_OPEN_MAX));
1369 ASSERT(fdTable[fd].type != FD_UNUSED);
1371 switch (fdTable[fd].type) {
1378 case FD_SOCKET_SYNC:
1379 case FD_SOCKET_ASYNC:
1381 * Closing a socket that has an async read outstanding causes a
1382 * tcp reset and possible data loss. The shutdown call seems to
1385 shutdown(fdTable[fd].fid.sock, 2);
1387 * closesocket returns: 0 success, SOCKET_ERROR failure
1389 if (closesocket(fdTable[fd].fid.sock) == SOCKET_ERROR)
1393 return -1; /* fake failure */
1396 Win32FreeDescriptor(fd);
1401 *--------------------------------------------------------------
1405 * Cancel outstanding asynchronous reads and prevent subsequent
1406 * reads from completing.
1409 * Socket or file is shutdown. Return values mimic Unix shutdown:
1410 * 0 success, -1 failure
1412 *--------------------------------------------------------------
1414 int OS_CloseRead(int fd)
1419 * Catch it if fd is a bogus value
1421 ASSERT((fd >= 0) && (fd < WIN32_OPEN_MAX));
1422 ASSERT(fdTable[fd].type == FD_SOCKET_ASYNC
1423 || fdTable[fd].type == FD_SOCKET_SYNC);
1425 if (shutdown(fdTable[fd].fid.sock,0) == SOCKET_ERROR)
1431 *--------------------------------------------------------------
1435 * This function was formerly OS_Select. It's purpose is
1436 * to pull I/O completion events off the queue and dispatch
1437 * them to the appropriate place.
1443 * Handlers are called.
1445 *--------------------------------------------------------------
1447 int OS_DoIo(struct timeval *tmo)
1450 unsigned long bytes;
1451 POVERLAPPED_REQUEST pOv;
1458 * We can loop in here, but not too long, as wait handlers
1460 * For cgi stdin, apparently select returns when io completion
1461 * ports don't, so don't wait the full timeout.
1464 ms = (tmo->tv_sec*1000 + tmo->tv_usec/1000) / 2;
1468 ms_last = tb.time*1000 + tb.millitm;
1470 if(tmo && (ms = tmo->tv_sec*1000 + tmo->tv_usec/1000)> 100)
1472 if (!GetQueuedCompletionStatus(hIoCompPort, &bytes, &fd,
1473 (LPOVERLAPPED *)&pOv, ms) && !pOv) {
1474 err = WSAGetLastError();
1475 return 0; /* timeout */
1478 ASSERT((fd >= 0) && (fd < WIN32_OPEN_MAX));
1479 /* call callback if descriptor still valid */
1481 if(pOv->instance == fdTable[fd].instance)
1482 (*pOv->procPtr)(pOv->clientData, bytes);
1486 ms -= (tb.time*1000 + tb.millitm - ms_last);
1487 ms_last = tb.time*1000 + tb.millitm;
1492 static int isAddrOK(struct sockaddr_in * inet_sockaddr, const char * okAddrs)
1494 static const char *token = " ,;:\t";
1498 if (okAddrs == NULL) return TRUE;
1500 ipaddr = inet_ntoa(inet_sockaddr->sin_addr);
1501 p = strstr(okAddrs, ipaddr);
1503 if (p == NULL) return FALSE;
1507 p += strlen(ipaddr);
1508 return (strchr(token, *p) != NULL);
1511 if (strchr(token, *--p) != NULL)
1513 p += strlen(ipaddr) + 1;
1514 return (strchr(token, *p) != NULL);
1521 static int CALLBACK isAddrOKCallback(LPWSABUF lpCallerId,
1530 struct sockaddr_in *sockaddr = (struct sockaddr_in *) lpCallerId->buf;
1532 // Touch the args to avoid warnings
1533 dc0 = NULL; dc1 = NULL; dc2 = NULL; dc3 = NULL; dc4 = NULL; dc5 = NULL;
1535 if ((void *) data == NULL) return CF_ACCEPT;
1537 if (sockaddr->sin_family != AF_INET) return CF_ACCEPT;
1539 return isAddrOK(sockaddr, (const char *) data) ? CF_ACCEPT : CF_REJECT;
1543 static printLastError(const char * text)
1548 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1549 FORMAT_MESSAGE_FROM_SYSTEM |
1550 FORMAT_MESSAGE_IGNORE_INSERTS,
1559 fprintf(stderr, "%s: %s\n", text, (LPCTSTR) buf);
1563 static int acceptNamedPipe()
1567 if (! ConnectNamedPipe(hListen, &listenOverlapped))
1569 switch (GetLastError())
1571 case ERROR_PIPE_CONNECTED:
1573 // A client connected after CreateNamedPipe but
1574 // before ConnectNamedPipe. Its a good connection.
1578 case ERROR_IO_PENDING:
1580 // Wait for a connection to complete.
1582 while (WaitForSingleObject(listenOverlapped.hEvent,
1583 ACCEPT_TIMEOUT) == WAIT_TIMEOUT)
1585 if (shutdownPending)
1594 case ERROR_PIPE_LISTENING:
1596 // The pipe handle is in nonblocking mode.
1600 // The previous client closed its handle (and we failed
1601 // to call DisconnectNamedPipe)
1605 printLastError("unexpected ConnectNamedPipe() error");
1609 ipcFd = Win32NewDescriptor(FD_PIPE_SYNC, (int) hListen, -1);
1612 DisconnectNamedPipe(hListen);
1618 static int acceptSocket(const char *webServerAddrs)
1625 struct sockaddr sockaddr;
1626 int sockaddrLen = sizeof(sockaddr);
1630 const struct timeval timeout = {1, 0};
1634 FD_SET((unsigned int) hListen, &readfds);
1636 if (select(0, &readfds, NULL, NULL, &timeout) == 0)
1638 if (shutdownPending)
1651 hSock = accept((SOCKET) hListen, &sockaddr, &sockaddrLen);
1653 if (hSock == INVALID_SOCKET)
1658 if (isAddrOK((struct sockaddr_in *) &sockaddr, webServerAddrs))
1665 hSock = WSAAccept((unsigned int) hListen,
1669 (DWORD) webServerAddrs);
1671 if (hSock != INVALID_SOCKET)
1676 if (WSAGetLastError() != WSAECONNREFUSED)
1683 if (hSock == INVALID_SOCKET)
1685 /* Use FormatMessage() */
1686 fprintf(stderr, "accept()/WSAAccept() failed: %d", WSAGetLastError());
1690 ipcFd = Win32NewDescriptor(FD_SOCKET_SYNC, hSock, -1);
1700 *----------------------------------------------------------------------
1704 * Accepts a new FastCGI connection. This routine knows whether
1705 * we're dealing with TCP based sockets or NT Named Pipes for IPC.
1707 * fail_on_intr is ignored in the Win lib.
1710 * -1 if the operation fails, otherwise this is a valid IPC fd.
1712 *----------------------------------------------------------------------
1714 int OS_Accept(int listen_sock, int fail_on_intr, const char *webServerAddrs)
1718 // Touch args to prevent warnings
1719 listen_sock = 0; fail_on_intr = 0;
1721 // @todo Muliple listen sockets and sockets other than 0 are not
1722 // supported due to the use of globals.
1724 if (shutdownPending)
1730 // The mutex is to keep other processes (and threads, when supported)
1731 // from going into the accept cycle. The accept cycle needs to
1732 // periodically break out to check the state of the shutdown flag
1733 // and there's no point to having more than one thread do that.
1735 if (acceptMutex != INVALID_HANDLE_VALUE)
1737 if (WaitForSingleObject(acceptMutex, INFINITE) == WAIT_FAILED)
1739 printLastError("WaitForSingleObject() failed");
1744 if (shutdownPending)
1748 else if (listenType == FD_PIPE_SYNC)
1750 ipcFd = acceptNamedPipe();
1752 else if (listenType == FD_SOCKET_SYNC)
1754 ipcFd = acceptSocket(webServerAddrs);
1758 fprintf(stderr, "unknown listenType (%d)\n", listenType);
1761 if (acceptMutex != INVALID_HANDLE_VALUE)
1763 ReleaseMutex(acceptMutex);
1770 *----------------------------------------------------------------------
1774 * OS IPC routine to close an IPC connection.
1780 * IPC connection is closed.
1782 *----------------------------------------------------------------------
1784 int OS_IpcClose(int ipcFd)
1790 * Catch it if fd is a bogus value
1792 ASSERT((ipcFd >= 0) && (ipcFd < WIN32_OPEN_MAX));
1793 ASSERT(fdTable[ipcFd].type != FD_UNUSED);
1795 switch(listenType) {
1799 * Make sure that the client (ie. a Web Server in this case) has
1800 * read all data from the pipe before we disconnect.
1802 if(!FlushFileBuffers(fdTable[ipcFd].fid.fileHandle))
1804 if(DisconnectNamedPipe(fdTable[ipcFd].fid.fileHandle)) {
1812 case FD_SOCKET_SYNC:
1825 *----------------------------------------------------------------------
1829 * Determines whether this process is a FastCGI process or not.
1832 * Returns 1 if FastCGI, 0 if not.
1837 *----------------------------------------------------------------------
1839 int OS_IsFcgi(int sock)
1841 // Touch args to prevent warnings
1844 /* XXX This is broken for sock */
1846 return (listenType != FD_UNUSED);
1850 *----------------------------------------------------------------------
1854 * Sets selected flag bits in an open file descriptor. Currently
1855 * this is only to put a SOCKET into non-blocking mode.
1857 *----------------------------------------------------------------------
1859 void OS_SetFlags(int fd, int flags)
1861 unsigned long pLong = 1L;
1864 if (fdTable[fd].type == FD_SOCKET_SYNC && flags == O_NONBLOCK) {
1865 if (ioctlsocket(fdTable[fd].fid.sock, FIONBIO, &pLong) ==
1867 exit(WSAGetLastError());
1869 if (!CreateIoCompletionPort((HANDLE)fdTable[fd].fid.sock,
1870 hIoCompPort, fd, 1)) {
1871 err = GetLastError();
1875 fdTable[fd].type = FD_SOCKET_ASYNC;