git.pond.sub.org Git - empserver/blob - src/lib/w32/posixio.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2007, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  *  ---
  21  *
  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.
  25  *
  26  *  ---
  27  *
  28  *  posixio.c: POSIX IO emulation layer for WIN32
  29  *
  30  *  Known contributors to this file:
  31  *     Ron Koenderink, 2007
  32  */
  33
  34 /*
  35  * POSIX has just one kind of file descriptors, while Windows has (at
  36  * least) two: one for sockets and one for files, with separate
  37  * functions to operate on them.  To present a more POSIX-like
  38  * interface to our application code, we provide a compatibility layer
  39  * that maps POSIX file descriptors to sockets and file handles behind
  40  * the scenes.  This actual mapping is done by the fdmap.  It doesn't
  41  * implement the finer points of POSIX correctly.  In particular, the
  42  * actual values of the file descriptors usually differ.
  43  */
  44
  45 #include <config.h>
  46 #include <winsock2.h>
  47 #undef NS_ALL
  48 #include <io.h>
  49 #include <sys/stat.h>
  50 #include <fcntl.h>
  51 #include <share.h>
  52
  53 #include <errno.h>
  54
  55 #include "unistd.h"
  56 #include "sys/uio.h"
  57 #include "empio.h"
  58 #include "prototypes.h"
  59
  60 /*
  61  * FD_SETSIZE is the size for the maximum number of sockets.
  62  * The number of file descriptors is in a variable _nhandle
  63  * based on the assertion output.  In order the simplify the
  64  * code and skip dynamic allocation, used double the socket size.
  65  */
  66 #define MAX_FDS (FD_SETSIZE * 2)
  67
  68 enum fdmap_io_type {
  69     FDMAP_IO_NOTUSED = 0,
  70     FDMAP_IO_FILE,
  71     FDMAP_IO_SOCKET,
  72     FDMAP_IO_ANY /* used for searching only (lookup_handle) */
  73 };
  74
  75 struct fdmap {
  76     int handle;
  77     enum fdmap_io_type type;
  78 };
  79
  80 static struct fdmap fdmap[MAX_FDS] = {
  81     {0, FDMAP_IO_FILE},
  82     {1, FDMAP_IO_FILE},
  83     {2, FDMAP_IO_FILE}
  84 };
  85 static int nfd = 3;
  86
  87 /*
  88  * Allocate a POSIX equivalent file descriptor.
  89  * Note once get_fd() is called either free_fd() or set_fd()
  90  * must be called before thread mutex is released as the
  91  * allocation/deallocation code is not thread safe.
  92  */
  93 static int
  94 get_fd(void)
  95 {
  96     int fd;
  97
  98     for (fd = 0; fd < nfd && fdmap[fd].type != FDMAP_IO_NOTUSED; fd++) ;
  99     if (fd == MAX_FDS) {
 100         errno = EMFILE;
 101         return -1;
 102     }
 103     if (fd == nfd) {
 104         fdmap[fd].type = FDMAP_IO_NOTUSED;
 105         nfd++;
 106     }
 107     return fd;
 108 }
 109
 110 /*
 111  * Deallocate a POSIX equivalent file descriptor.
 112  */
 113 static void
 114 free_fd(int fd)
 115 {
 116     fdmap[fd].type = FDMAP_IO_NOTUSED;
 117     for(; fdmap[nfd - 1].type == FDMAP_IO_NOTUSED; nfd--) ;
 118 }
 119
 120 /*
 121  * Complete the allocation of the file descriptor.
 122  */
 123 static void
 124 set_fd(int fd, enum fdmap_io_type type, int handle)
 125 {
 126     int i;
 127
 128     fdmap[fd].handle = handle;
 129     fdmap[fd].type = type;
 130
 131     /*
 132      * Garbage collection for posix_fileno(), currently not
 133      * replacing fclose() and fcloseall() so do not know when
 134      * a stream is closed.
 135      */
 136     for (i = 0; i < nfd; i++) {
 137         if (i != fd && type == fdmap[i].type && handle == fdmap[i].handle)
 138             free_fd(i);
 139     }
 140 }
 141
 142 /*
 143  * Find the windows handle (file or socket) for file descriptor.
 144  * Return windows handle and type of handle.
 145  * You can search for a specific type (FDMAP_IO_FILE or FDMAP_IO_SOCKET)
 146  * or for both search by using FDMAP_IO_ANY.
 147  * FDMAP_IO_NOTUSED is not valid type to search with.
 148  */
 149 static int
 150 lookup_handle(int fd, enum fdmap_io_type d_type, int error,
 151         enum fdmap_io_type *type_ptr, int *handle_ptr)
 152 {
 153
 154     if (fd < 0 || fd >= MAX_FDS) {
 155         if (error != 0)
 156             errno = error;
 157         return 0;
 158     } else if ((fdmap[fd].type != d_type && d_type != FDMAP_IO_ANY) ||
 159         (fdmap[fd].type == FDMAP_IO_NOTUSED && d_type == FDMAP_IO_ANY)) {
 160         if (error != 0)
 161             errno = error;
 162         return 0;
 163     }
 164     if (type_ptr != NULL)
 165         *type_ptr = fdmap[fd].type;
 166     if (handle_ptr != NULL)
 167         *handle_ptr = fdmap[fd].handle;
 168     return 1;
 169 }
 170
 171 /*
 172  * Find and return the file descriptor associated with windows handle.
 173  * You can search for FDMAP_IO_FILE or FDMAP_IO_SOCKET.
 174  * FDMAP_IO_ANY or FDMAP_IO_NOTUSED is not considered valid search
 175  * criteria.
 176  */
 177 static int
 178 lookup_fd(int handle, enum fdmap_io_type d_type)
 179 {
 180     int i;
 181
 182     for (i = 0; i < nfd; i++)
 183         if (fdmap[i].handle == handle && fdmap[i].type == d_type)
 184             return i;
 185     return -1;
 186 }
 187
 188 /*
 189  * Get the window socket handle for POSIX file descriptor.
 190  */
 191 int
 192 posix_fd2socket(int fd)
 193 {
 194     int handle;
 195     enum fdmap_io_type type;
 196
 197     if (!lookup_handle(fd, FDMAP_IO_SOCKET, WSAENOTSOCK,
 198         &type, &handle))
 199         return INVALID_SOCKET;
 200     return handle;
 201 }
 202
 203 #define SOCKET_FUNCTION(expr)                           \
 204     int result;                                         \
 205     int handle;                                         \
 206                                                         \
 207     if (!lookup_handle(fd, FDMAP_IO_SOCKET,             \
 208         ENOTSOCK, NULL, &handle))                       \
 209         return -1;                                      \
 210                                                         \
 211     result = (expr);                                    \
 212     if (result == SOCKET_ERROR) {                       \
 213         errno = WSAGetLastError();                      \
 214         return -1;                                      \
 215     }                                                   \
 216     return result;
 217
 218 /*
 219  * POSIX equivalent for accept().
 220  */
 221 #undef accept
 222 int
 223 posix_accept(int fd, struct sockaddr *addr, socklen_t *addrlen)
 224 {
 225     int new_fd;
 226     int handle, new_handle;
 227
 228     if (!lookup_handle(fd, FDMAP_IO_SOCKET, ENOTSOCK, NULL, &handle))
 229         return -1;
 230
 231     new_fd = get_fd();
 232     if (new_fd < 0)
 233         return -1;
 234
 235     new_handle = accept(handle, addr, addrlen);
 236     if (new_handle == INVALID_SOCKET) {
 237         free_fd(new_fd);
 238         errno = WSAGetLastError();
 239         return -1;
 240     }
 241     set_fd(new_fd, FDMAP_IO_SOCKET, new_handle);
 242     return new_fd;
 243 }
 244
 245 /*
 246  * POSIX equivalent for bind().
 247  */
 248 #undef bind
 249 int
 250 posix_bind(int fd, const struct sockaddr *name, int namelen)
 251 {
 252     SOCKET_FUNCTION(bind(handle, name, namelen))
 253 }
 254
 255 /*
 256  * POSIX equivalent for listen().
 257  */
 258 #undef listen
 259 int
 260 posix_listen(int fd, int backlog)
 261 {
 262     SOCKET_FUNCTION(listen(handle, backlog))
 263 }
 264
 265 /*
 266  * POSIX equivalent for setsockopt().
 267  */
 268 #undef setsockopt
 269 int
 270 posix_setsockopt(int fd, int level, int optname,
 271                       const void *optval, int optlen)
 272 {
 273     /*
 274      * SO_REUSEADDR requests from tcp_listen.c
 275      * to permit another bind even when the
 276      * port is still in state TIME_WAIT.  Windows' SO_REUSEADDR is
 277      * broken: it makes bind() succeed no matter what, even if
 278      * there's another server running on the same port.  Luckily,
 279      * bind() seems to be broken as well: it seems to succeed while
 280      * the port is in state TIME_WAIT by default; thus we get the
 281      * behavior we want by not setting SO_REUSEADDR.
 282      */
 283     if (level == SOL_SOCKET && optname == SO_REUSEADDR)
 284         return 0;
 285     {
 286         SOCKET_FUNCTION(setsockopt(handle, level, optname,
 287                         optval, optlen))
 288     }
 289 }
 290
 291 /*
 292  * POSIX equivalent for shutdown().
 293  */
 294 #undef shutdown
 295 int
 296 posix_shutdown(int fd, int how)
 297 {
 298     SOCKET_FUNCTION(shutdown(handle, how))
 299 }
 300
 301 /*
 302  * POSIX equivalent for socket().
 303  */
 304 #undef socket
 305 int
 306 posix_socket(int domain, int type, int protocol)
 307 {
 308     int handle;
 309     int new_fd;
 310
 311     if ((new_fd = get_fd()) < 0)
 312         return -1;
 313
 314     handle = socket(domain, type, protocol);
 315     if (handle == INVALID_SOCKET) {
 316         free_fd(new_fd);
 317         errno = WSAGetLastError();
 318         return -1;
 319     }
 320     set_fd(new_fd, FDMAP_IO_SOCKET, handle);
 321     return new_fd;
 322 }
 323
 324 #define FILE_FUNCTION(type, expr)                               \
 325     int handle;                                                 \
 326                                                                 \
 327     if (!lookup_handle(fd, (type), EBADF, NULL, &handle))       \
 328         return -1;                                              \
 329                                                                 \
 330     return (expr);
 331
 332 /*
 333  * POSIX equivalent for close().
 334  */
 335 int
 336 posix_close(int fd)
 337 {
 338     int result;
 339     int handle;
 340     enum fdmap_io_type type;
 341
 342     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 343         return -1;
 344
 345     free_fd(fd);
 346     switch (type) {
 347     case FDMAP_IO_SOCKET:
 348         result = closesocket(handle);
 349         if (result == SOCKET_ERROR) {
 350             errno = WSAGetLastError();
 351             return -1;
 352         }
 353         return result;
 354     case FDMAP_IO_FILE:
 355        return _close(handle);
 356     }
 357     CANT_REACH();
 358     return -1;
 359 }
 360
 361 /*
 362  * posix_fsync forces file sync with the disk.
 363  * In order for the power report report to accurate timestamp,
 364  * the _commit() is to force a sync with disk and therefore
 365  * an update for file time.
 366  */
 367 int
 368 posix_fsync(int fd)
 369 {
 370     FILE_FUNCTION(FDMAP_IO_FILE, _commit(handle))
 371 }
 372
 373 /*
 374  * POSIX equivalent for fstat().
 375  * fstat() is used instead of _fstat(),
 376  * otherwise problems with the 32/64 time definitions
 377  * in WIN32.
 378  */
 379 #undef fstat
 380 int
 381 posix_fstat(int fd, struct stat *buffer)
 382 {
 383     FILE_FUNCTION(FDMAP_IO_ANY, fstat(handle, buffer))
 384 }
 385
 386 /*
 387  * POSIX equivalent for lseek().
 388  */
 389 int
 390 posix_lseek(int fd, long offset, int origin)
 391 {
 392     FILE_FUNCTION(FDMAP_IO_FILE, _lseek(handle, offset, origin))
 393 }
 394
 395 /*
 396  * POSIX equivalent for open().
 397  * Implements file locks when opening files to provide equivalent
 398  * F_GETLK/F_SETLK.
 399  */
 400 int
 401 posix_open(const char *fname, int oflag, ...)
 402 {
 403     va_list ap;
 404     int pmode = 0, new_fd;
 405     int handle;
 406
 407     if (oflag & O_CREAT) {
 408         va_start(ap, oflag);
 409         pmode = va_arg(ap, int);
 410         va_end(ap);
 411     }
 412
 413     if ((new_fd = get_fd()) < 0)
 414         return -1;
 415
 416     /*
 417      * We don't implement fcntl() for F_SETLK.  Instead, we lock *all*
 418      * files we open.  Not ideal, but it works for Empire.
 419      */
 420     handle = _sopen(fname, oflag,
 421         oflag & O_RDONLY ? SH_DENYNO : SH_DENYWR, pmode);
 422     if (handle == -1) {
 423         free_fd(new_fd);
 424         return -1;
 425     }
 426     set_fd(new_fd, FDMAP_IO_FILE, handle);
 427     return new_fd;
 428 }
 429
 430 #define SHARED_FUNCTION(socket_expr, file_expr)                     \
 431     int result;                                                     \
 432     int handle;                                                     \
 433     enum fdmap_io_type type;                                        \
 434                                                                     \
 435     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))    \
 436         return -1;                                                  \
 437                                                                     \
 438     switch (type) {                                                 \
 439     case FDMAP_IO_SOCKET:                                           \
 440         result = (socket_expr);                                     \
 441         if (result == SOCKET_ERROR) {                               \
 442             errno = WSAGetLastError();                              \
 443             return -1;                                              \
 444         }                                                           \
 445         return result;                                              \
 446     case FDMAP_IO_FILE:                                             \
 447         return (file_expr);                                         \
 448     }                                                               \
 449     CANT_REACH();                                                   \
 450     return -1;
 451
 452 /*
 453  * POSIX equivalent for read().
 454  */
 455 int
 456 posix_read(int fd, void *buffer, unsigned int count)
 457 {
 458     SHARED_FUNCTION(recv(handle, buffer, count, 0),
 459         _read(handle, buffer, count))
 460 }
 461
 462 /*
 463  * POSIX equivalent for readv
 464  * Modelled after the GNU's libc/sysdeps/posix/readv.c
 465  */
 466 ssize_t
 467 readv(int fd, const struct iovec *iov, int iovcnt)
 468 {
 469     int i;
 470     unsigned char *buffer, *buffer_location;
 471     size_t total_bytes = 0;
 472     int bytes_read;
 473     size_t bytes_left;
 474
 475     for (i = 0; i < iovcnt; i++) {
 476         total_bytes += iov[i].iov_len;
 477     }
 478
 479     buffer = malloc(total_bytes);
 480     if (buffer == NULL)
 481         return -1;
 482
 483     bytes_read = posix_read(fd, buffer, total_bytes);
 484     if (bytes_read <= 0) {
 485         free(buffer);
 486         return -1;
 487     }
 488
 489     bytes_left = bytes_read;
 490     buffer_location = buffer;
 491     for (i = 0; i < iovcnt; i++) {
 492         size_t copy = MIN(iov[i].iov_len, bytes_left);
 493
 494         memcpy(iov[i].iov_base, buffer_location, copy);
 495
 496         buffer_location += copy;
 497         bytes_left -= copy;
 498         if (bytes_left == 0)
 499             break;
 500     }
 501
 502     free(buffer);
 503
 504     return bytes_read;
 505 }
 506
 507 /*
 508  * POSIX equivalent for write().
 509  */
 510 int
 511 posix_write(int fd, const void *buffer, unsigned int count)
 512 {
 513     SHARED_FUNCTION(send(handle, buffer, count, 0),
 514         _write(handle, buffer, count))
 515 }
 516
 517 /*
 518  * POSIX equivalent for writev
 519  * Modelled after the GNU's libc/sysdeps/posix/writev.c
 520  */
 521 ssize_t
 522 writev(int fd, const struct iovec *iov, int iovcnt)
 523 {
 524     int i;
 525     unsigned char *buffer, *buffer_location;
 526     size_t total_bytes = 0;
 527     int bytes_written;
 528
 529     for (i = 0; i < iovcnt; i++)
 530         total_bytes += iov[i].iov_len;
 531
 532     if (total_bytes == 0)
 533         return 0;
 534
 535     buffer = malloc(total_bytes);
 536     if (buffer == NULL)
 537         return -1;
 538
 539     buffer_location = buffer;
 540     for (i = 0; i < iovcnt; i++) {
 541         memcpy(buffer_location, iov[i].iov_base, iov[i].iov_len);
 542         buffer_location += iov[i].iov_len;
 543     }
 544
 545     bytes_written = posix_write(fd, buffer, total_bytes);
 546
 547     free(buffer);
 548
 549     if (bytes_written <= 0)
 550         return -1;
 551     return bytes_written;
 552 }
 553
 554 /*
 555  * POSIX equivalent for fileno().
 556  * As fopen/fclose/fcloseall are not implemented as POSIX
 557  * equivalent functions, the mapping is done when required
 558  * by a call to fileno().  The garbage collection of the
 559  * file descriptors allocated is done in set_fd() when the
 560  * handle is reused.
 561  */
 562 int
 563 posix_fileno(FILE *stream)
 564 {
 565     int fd;
 566     int handle;
 567
 568     if (stream == NULL) {
 569         errno = EBADF;
 570         return -1;
 571     }
 572
 573     handle = _fileno(stream);
 574
 575     fd = lookup_fd(handle, FDMAP_IO_FILE);
 576     if (fd >= 0)
 577         return fd;
 578
 579     if ((fd = get_fd()) < 0) {
 580         errno = EBADF;
 581         return -1;
 582     }
 583
 584     set_fd(fd, FDMAP_IO_FILE, handle);
 585     return fd;
 586 }
 587
 588 /*
 589  * POSIX equivalent for fcntl().
 590  * Currently supports only the F_GETFL/F_SETFL/O_NONBLOCK
 591  * Currently ignores F_GETLK/F_SETLK as the file locks are
 592  * implement in open()
 593  */
 594 int
 595 fcntl(int fd, int cmd, ...)
 596 {
 597     va_list ap;
 598     int value;
 599     unsigned int nonblocking;
 600     int result;
 601     long bytes_returned;
 602     int handle;
 603     enum fdmap_io_type type;
 604
 605     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 606         return -1;
 607
 608     switch (cmd)
 609     {
 610     case F_GETFL:
 611         /*
 612          * F_GETFL and F_SETFL only support O_NONBLOCK
 613          * for sockets currently
 614          */
 615         if (type == FDMAP_IO_SOCKET) {
 616             result = WSAIoctl(handle, FIONBIO, NULL, 0,&nonblocking,
 617                 sizeof (nonblocking), &bytes_returned, NULL, NULL);
 618
 619             if(result < 0) {
 620                 errno = WSAGetLastError();
 621                 return -1;
 622             }
 623
 624             if (nonblocking)
 625                 return O_NONBLOCK;
 626             else
 627                 return 0;
 628         }
 629         break;
 630     case F_SETFL:
 631         if (type == FDMAP_IO_SOCKET) {
 632             va_start(ap, cmd);
 633             value = va_arg(ap, int);
 634             va_end(ap);
 635             if (value & O_NONBLOCK)
 636                 nonblocking = 1;
 637             else
 638                 nonblocking = 0;
 639
 640             result = WSAIoctl(handle, FIONBIO, &nonblocking,
 641                 sizeof (nonblocking), NULL, 0, &bytes_returned,
 642                 NULL, NULL);
 643
 644             if(result < 0) {
 645                 errno = WSAGetLastError();
 646                 return -1;
 647             }
 648             return result;
 649         }
 650         break;
 651     case F_SETLK:
 652         /*
 653          * The POSIX equivalent is not available in WIN32
 654          * That implement the file locking in the file open
 655          * by using sopen instead of open.
 656          */
 657         return 0;
 658     }
 659     errno = EINVAL;
 660     return -1;
 661 }