2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2010, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * See files README, COPYING and CREDITS in the root of the source
23 * tree for related information and legal notices. It is expected
24 * that future projects/authors will amend these files as needed.
28 * play.c: Playing the game
30 * Known contributors to this file:
31 * Markus Armbruster, 2007-2009
32 * Ron Koenderink, 2007-2009
44 #include <sys/socket.h>
46 #include <sys/select.h>
56 static CRITICAL_SECTION signal_critical_section;
57 static LPCRITICAL_SECTION signal_critical_section_ptr = NULL;
59 static unsigned char bounce_buf[RING_SIZE];
61 * Set bounce_empty to indicate bounce_buf is available for the stdin thread
64 static HANDLE bounce_empty;
66 * Set bounce_full to indicate bounce_buf is contains data from the
67 * stdin thread and is available for recv_input
69 static HANDLE bounce_full;
70 /* Ctrl-C (SIGINT) was detected, generate EINTR for the w32_select() */
71 static HANDLE ctrl_c_event;
72 static int bounce_status, bounce_error;
76 void (*sa_handler)(int sig);
80 static void (*ctrl_handler)(int sig) = { SIG_DFL };
83 * Ctrl-C handler for emulating the SIGINT in WIN32
86 w32_signal_handler(DWORD ctrl_type)
88 if (ctrl_type == CTRL_C_EVENT) {
89 EnterCriticalSection(signal_critical_section_ptr);
90 if (ctrl_handler != SIG_DFL) {
92 LeaveCriticalSection(signal_critical_section_ptr);
93 SetEvent(ctrl_c_event);
96 LeaveCriticalSection(signal_critical_section_ptr);
102 * WIN32 equivalent for sigaction supports the following:
103 * set handler for SIGINT using WIN32 Ctrl-C handler
104 * reset handler SIGINT to SIG_DFL
108 sigaction(int signal, struct sigaction *action, struct sigaction *oaction)
113 if (signal == SIGPIPE)
114 assert(action->sa_handler == SIG_IGN);
116 assert(signal == SIGINT && action->sa_handler != SIG_IGN);
117 if (ctrl_handler == action->sa_handler)
119 if (signal_critical_section_ptr == NULL) {
120 signal_critical_section_ptr = &signal_critical_section;
121 InitializeCriticalSection(signal_critical_section_ptr);
123 EnterCriticalSection(signal_critical_section_ptr);
124 if (!SetConsoleCtrlHandler(w32_signal_handler,
125 action->sa_handler != SIG_DFL)) {
126 errno = GetLastError();
127 LeaveCriticalSection(signal_critical_section_ptr);
130 ctrl_handler = action->sa_handler;
131 LeaveCriticalSection(signal_critical_section_ptr);
137 * Read the stdin in WIN32 environment
138 * WIN32 does not support select type function on console input
139 * so the client uses a separate thread to read input
142 stdin_read_thread(void *dummy)
145 switch (WaitForSingleObject(bounce_empty, INFINITE)) {
148 bounce_error = GetLastError();
151 bounce_status = _read(0, bounce_buf, sizeof(bounce_buf));
152 bounce_error = errno;
159 SetEvent(bounce_full);
164 * Initialize and start the stdin reading thread for WIN32
167 sysdep_stdin_init(void)
169 bounce_empty = CreateEvent(NULL, FALSE, TRUE, NULL);
170 bounce_full = CreateEvent(NULL, TRUE, FALSE, NULL);
171 ctrl_c_event = CreateEvent(NULL, FALSE, FALSE, NULL);
172 _beginthread(stdin_read_thread, 0, NULL);
176 * This function uses to WaitForMultipleObjects to wait for both
177 * stdin and socket reading or writing.
178 * Stdin is treated special in WIN32. Waiting for stdin is done
179 * via a bounce_full event which is set in the stdin thread.
180 * Execute command file reading is done via handle.
181 * WaitForMultipleObjects will only respond with one object,
182 * so an additonal select is also done to determine
183 * which individual events are active.
186 w32_select(int nfds, fd_set *rdfd, fd_set *wrfd, fd_set *errfd,
187 struct timeval *time)
191 int inp, sockfd, result, s_result, num_handles;
192 struct timeval tv_time = {0, 0};
193 fd_set rdsock, wrsock;
195 switch (rdfd->fd_count) {
198 sockfd = rdfd->fd_array[0];
201 inp = rdfd->fd_array[0];
202 sockfd = rdfd->fd_array[1];
207 sock = w32_fd2socket(sockfd);
209 assert(wrfd->fd_count == 0
210 || (wrfd->fd_count == 1 && wrfd->fd_array[0] == (SOCKET)sockfd));
211 assert(inp < 0 || inp == input_fd);
214 handles[num_handles++] = ctrl_c_event;
216 handles[num_handles++]
217 = inp ? (HANDLE)_get_osfhandle(inp) : bounce_full;
218 /* always wait on the socket */
219 handles[num_handles++] = WSACreateEvent();
221 if (wrfd->fd_count > 0)
222 WSAEventSelect(sock, handles[num_handles - 1],
223 FD_READ | FD_WRITE | FD_CLOSE);
225 WSAEventSelect(sock, handles[num_handles - 1],
228 result = WaitForMultipleObjects(num_handles, handles, 0, INFINITE);
230 errno = GetLastError();
231 WSACloseEvent(handles[num_handles - 1]);
234 WSACloseEvent(handles[num_handles - 1]);
236 if (result == WAIT_OBJECT_0) {
243 FD_SET(sock, &rdsock);
245 FD_SET(sock, &wrsock);
246 s_result = select(sock + 1, &rdsock, &wrsock, NULL, &tv_time);
249 w32_set_winsock_errno();
253 if (!FD_ISSET(sock, &rdsock))
254 FD_CLR((SOCKET)sockfd, rdfd);
255 if (!FD_ISSET(sock, &wrsock))
256 FD_CLR((SOCKET)sockfd, wrfd);
257 if (inp >= 0 && result == WAIT_OBJECT_0 + 1)
260 FD_CLR((SOCKET)inp, rdfd);
266 * Read input from the user either stdin or from file.
267 * For stdin, read from bounce_buf which filled by the stdin thread
268 * otherwise use the regular ring_from_file.
271 w32_ring_from_file_or_bounce_buf(struct ring *r, int fd)
276 return ring_from_file(r, fd);
278 if (bounce_status < 0) {
279 errno = bounce_error;
282 for (i = 0; i < bounce_status; i++) {
283 if (ring_putc(r, bounce_buf[i]) == EOF) {
284 /* more work to do, hold on to bounce_buf */
285 memmove(bounce_buf, bounce_buf + i, bounce_status - i);
293 ResetEvent(bounce_full);
294 SetEvent(bounce_empty);
297 #define ring_from_file w32_ring_from_file_or_bounce_buf
298 #define select(nfds, rd, wr, error, time) \
299 w32_select((nfds), (rd), (wr), (error), (time))
300 #define sigemptyset(mask) ((void)0)
302 #define sysdep_stdin_init() ((void)0)
305 #define EOF_COOKIE "ctld\n"
306 #define INTR_COOKIE "aborted\n"
309 int send_eof; /* need to send EOF_COOKIE */
310 static volatile sig_atomic_t send_intr; /* need to send INTR_COOKIE */
313 * Receive and process server output from SOCK.
314 * Return number of characters received on success, -1 on error.
317 recv_output(int sock)
320 * Read a chunk of server output and feed its characters into a
321 * simple state machine.
322 * Initial state is SCANNING_ID.
323 * In state SCANNING_ID, buffer the character. If it's a space,
324 * decode the id that has been buffered, and enter state BUFFERING
325 * or COPYING depending on its value.
326 * In state BUFFERING, buffer the character. If it's newline,
327 * pass id and buffered text to servercmd(), then enter state
329 * In state COPYING, pass the character to outch(). If it's
330 * newline, enter state SCANNING_ID.
333 SCANNING_ID, BUFFERING, COPYING
334 } state = SCANNING_ID;
336 static struct lbuf lbuf;
342 n = read(sock, buf, sizeof(buf));
346 for (i = 0; i < n; i++) {
351 /* FIXME gripe unexpected! */
355 lbuf_putc(&lbuf, ch);
358 line = lbuf_line(&lbuf);
374 /* unknown or unexpected id, treat like C_DATA */
382 len = lbuf_putc(&lbuf, ch);
384 line = lbuf_line(&lbuf);
385 servercmd(id, line, len);
402 * Receive command input from FD into INBUF.
403 * Return 1 on receipt of input, zero on EOF, -1 on error.
406 recv_input(int fd, struct ring *inbuf)
408 static struct lbuf cmdbuf;
413 n = ring_from_file(inbuf, fd);
418 if (lbuf_len(&cmdbuf)) {
419 /* incomplete line */
420 ring_putc(inbuf, '\n');
424 * Can't put EOF cookie into INBUF here, it may not fit.
425 * Leave it to caller.
430 /* copy input to AUXFP etc. */
431 for (i = -n; i < 0; i++) {
432 ch = ring_peek(inbuf, i);
434 if (ch != '\r' && lbuf_putc(&cmdbuf, ch)) {
435 line = lbuf_line(&cmdbuf);
454 * The session must be in the playing phase.
455 * Return 0 when the session ended, -1 on error.
461 * Player input flows from INPUT_FD through recv_input() into ring
462 * buffer INBUF, which drains into SOCK. This must not block.
463 * Server output flows from SOCK into recv_output(). Reading SOCK
467 struct ring inbuf; /* input buffer, draining to SOCK */
468 int eof_fd0; /* read fd 0 hit EOF? */
469 int input_eol; /* input ends with '\n'? */
474 sigemptyset(&sa.sa_mask);
475 sa.sa_handler = intr;
476 sigaction(SIGINT, &sa, NULL);
477 sa.sa_handler = SIG_IGN;
478 sigaction(SIGPIPE, &sa, NULL);
481 eof_fd0 = input_eol = send_eof = send_intr = 0;
490 * Want to read player input only when we don't need to send
491 * cookies, and INPUT_FD is still open, and INBUF can accept
494 if (!send_intr && !send_eof && input_fd >= 0 && ring_space(&inbuf))
495 FD_SET(input_fd, &rdfd);
496 /* Want to send player input only when we have something */
497 if (send_intr || send_eof || ring_len(&inbuf))
499 /* Always want to read server output */
502 n = select(MAX(input_fd, sock) + 1, &rdfd, &wrfd, NULL, NULL);
504 if (errno != EINTR) {
510 if ((send_eof || send_intr) && !input_eol
511 && ring_putc(&inbuf, '\n') != EOF)
513 if (send_eof && input_eol
514 && ring_putm(&inbuf, EOF_COOKIE, sizeof(EOF_COOKIE) - 1) >= 0)
516 if (send_intr && input_eol
517 && ring_putm(&inbuf, INTR_COOKIE, sizeof(INTR_COOKIE) - 1) >= 0) {
520 /* execute aborted, switch back to fd 0 */
522 input_fd = eof_fd0 ? -1 : 0;
529 /* read player input */
530 if (input_fd >= 0 && FD_ISSET(input_fd, &rdfd)) {
531 n = recv_input(input_fd, &inbuf);
533 perror("read stdin"); /* FIXME stdin misleading, could be execing */
540 /* execute done, switch back to fd 0 */
542 input_fd = eof_fd0 ? -1 : 0;
544 /* stop reading input, drain socket ring buffers */
547 sa.sa_handler = SIG_DFL;
548 sigaction(SIGINT, &sa, NULL);
551 input_eol = ring_peek(&inbuf, -1) == '\n';
554 /* send it to the server */
555 if (FD_ISSET(sock, &wrfd)) {
556 n = ring_to_file(&inbuf, sock);
558 perror("write socket");
563 /* read server output and print it */
564 if (FD_ISSET(sock, &rdfd)) {
565 n = recv_output(sock);
567 perror("read socket");