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
  47 #include <errno.h>
  48 #include <fcntl.h>
  49 #include <io.h>
  50 #include <share.h>
  51 #include <stdio.h>
  52 #include <stdarg.h>
  53 #include <sys/stat.h>
  54
  55 #include "misc.h"
  56 #include "sys/socket.h"
  57 #include "sys/uio.h"
  58 #include "unistd.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 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, socklen_t 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, socklen_t optlen)
 272 {
 273     /*
 274      * SO_REUSEADDR requests to permit another bind even when the
 275      * port is still in state TIME_WAIT.  Windows' SO_REUSEADDR is
 276      * broken: it makes bind() succeed no matter what, even if
 277      * there's another server running on the same port.  Luckily,
 278      * bind() seems to be broken as well: it seems to succeed while
 279      * the port is in state TIME_WAIT by default; thus we get the
 280      * behavior we want by not setting SO_REUSEADDR.
 281      */
 282     if (level == SOL_SOCKET && optname == SO_REUSEADDR)
 283         return 0;
 284     {
 285         SOCKET_FUNCTION(setsockopt(handle, level, optname,
 286                         optval, optlen))
 287     }
 288 }
 289
 290 /*
 291  * POSIX equivalent for shutdown().
 292  */
 293 #undef shutdown
 294 int
 295 posix_shutdown(int fd, int how)
 296 {
 297     SOCKET_FUNCTION(shutdown(handle, how))
 298 }
 299
 300 /*
 301  * POSIX equivalent for socket().
 302  */
 303 #undef socket
 304 int
 305 posix_socket(int domain, int type, int protocol)
 306 {
 307     int handle;
 308     int new_fd;
 309
 310     if ((new_fd = get_fd()) < 0)
 311         return -1;
 312
 313     handle = socket(domain, type, protocol);
 314     if (handle == INVALID_SOCKET) {
 315         free_fd(new_fd);
 316         errno = WSAGetLastError();
 317         return -1;
 318     }
 319     set_fd(new_fd, FDMAP_IO_SOCKET, handle);
 320     return new_fd;
 321 }
 322
 323 #ifdef HAVE_GETADDRINFO
 324 const char *
 325 inet_ntop(int af, const void *source, char *dest, socklen_t len)
 326 {
 327     if (af == AF_INET)
 328     {
 329         struct sockaddr_in in;
 330         memset(&in, 0, sizeof(in));
 331         in.sin_family = AF_INET;
 332         memcpy(&in.sin_addr, source, sizeof(struct in_addr));
 333         getnameinfo((struct sockaddr *)&in,
 334                     sizeof(struct sockaddr_in), dest, len,
 335                     NULL, 0, NI_NUMERICHOST);
 336         return dest;
 337     }
 338     else if (af == AF_INET6)
 339     {
 340         struct sockaddr_in6 in;
 341         memset(&in, 0, sizeof(in));
 342         in.sin6_family = AF_INET6;
 343         memcpy(&in.sin6_addr, source, sizeof(struct in_addr6));
 344         getnameinfo((struct sockaddr *)&in,
 345                     sizeof(struct sockaddr_in6), dest, len,
 346                     NULL, 0, NI_NUMERICHOST);
 347         return dest;
 348     }
 349     return NULL;
 350 }
 351 #endif
 352
 353 #define FILE_FUNCTION(type, expr)                               \
 354     int handle;                                                 \
 355                                                                 \
 356     if (!lookup_handle(fd, (type), EBADF, NULL, &handle))       \
 357         return -1;                                              \
 358                                                                 \
 359     return (expr);
 360
 361 /*
 362  * POSIX equivalent for close().
 363  */
 364 int
 365 posix_close(int fd)
 366 {
 367     int result;
 368     int handle;
 369     enum fdmap_io_type type;
 370
 371     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 372         return -1;
 373
 374     free_fd(fd);
 375     switch (type) {
 376     case FDMAP_IO_SOCKET:
 377         result = closesocket(handle);
 378         if (result == SOCKET_ERROR) {
 379             errno = WSAGetLastError();
 380             return -1;
 381         }
 382         return result;
 383     case FDMAP_IO_FILE:
 384        return _close(handle);
 385     }
 386     CANT_REACH();
 387     return -1;
 388 }
 389
 390 /*
 391  * posix_fsync forces file sync with the disk.
 392  * In order for the power report report to accurate timestamp,
 393  * the _commit() is to force a sync with disk and therefore
 394  * an update for file time.
 395  */
 396 int
 397 posix_fsync(int fd)
 398 {
 399     FILE_FUNCTION(FDMAP_IO_FILE, _commit(handle))
 400 }
 401
 402 /*
 403  * POSIX equivalent for fstat().
 404  * fstat() is used instead of _fstat(),
 405  * otherwise problems with the 32/64 time definitions
 406  * in WIN32.
 407  */
 408 #undef fstat
 409 int
 410 posix_fstat(int fd, struct stat *buffer)
 411 {
 412     FILE_FUNCTION(FDMAP_IO_ANY, fstat(handle, buffer))
 413 }
 414
 415 /*
 416  * POSIX equivalent for lseek().
 417  */
 418 off_t
 419 posix_lseek(int fd, off_t offset, int origin)
 420 {
 421     FILE_FUNCTION(FDMAP_IO_FILE, _lseek(handle, offset, origin))
 422 }
 423
 424 /*
 425  * POSIX equivalent for open().
 426  * Implements file locks when opening files to provide equivalent
 427  * F_GETLK/F_SETLK.
 428  */
 429 int
 430 posix_open(const char *fname, int oflag, ...)
 431 {
 432     va_list ap;
 433     int pmode = 0, new_fd;
 434     int handle;
 435
 436     if (oflag & O_CREAT) {
 437         va_start(ap, oflag);
 438         pmode = va_arg(ap, int);
 439         va_end(ap);
 440     }
 441
 442     if ((new_fd = get_fd()) < 0)
 443         return -1;
 444
 445     /*
 446      * We don't implement fcntl() for F_SETLK.  Instead, we lock *all*
 447      * files we open.  Not ideal, but it works for Empire.
 448      */
 449     handle = _sopen(fname, oflag,
 450         oflag & O_RDONLY ? SH_DENYNO : SH_DENYWR, pmode);
 451     if (handle == -1) {
 452         free_fd(new_fd);
 453         return -1;
 454     }
 455     set_fd(new_fd, FDMAP_IO_FILE, handle);
 456     return new_fd;
 457 }
 458
 459 #define SHARED_FUNCTION(socket_expr, file_expr)                     \
 460     int result;                                                     \
 461     int handle;                                                     \
 462     enum fdmap_io_type type;                                        \
 463                                                                     \
 464     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))    \
 465         return -1;                                                  \
 466                                                                     \
 467     switch (type) {                                                 \
 468     case FDMAP_IO_SOCKET:                                           \
 469         result = (socket_expr);                                     \
 470         if (result == SOCKET_ERROR) {                               \
 471             errno = WSAGetLastError();                              \
 472             return -1;                                              \
 473         }                                                           \
 474         return result;                                              \
 475     case FDMAP_IO_FILE:                                             \
 476         return (file_expr);                                         \
 477     }                                                               \
 478     CANT_REACH();                                                   \
 479     return -1;
 480
 481 /*
 482  * POSIX equivalent for read().
 483  */
 484 ssize_t
 485 posix_read(int fd, void *buffer, size_t count)
 486 {
 487     SHARED_FUNCTION(recv(handle, buffer, count, 0),
 488         _read(handle, buffer, count))
 489 }
 490
 491 /*
 492  * POSIX equivalent for readv
 493  * Modelled after the GNU's libc/sysdeps/posix/readv.c
 494  */
 495 ssize_t
 496 readv(int fd, const struct iovec *iov, int iovcnt)
 497 {
 498     int i;
 499     unsigned char *buffer, *buffer_location;
 500     size_t total_bytes = 0;
 501     int bytes_read;
 502     size_t bytes_left;
 503
 504     for (i = 0; i < iovcnt; i++) {
 505         total_bytes += iov[i].iov_len;
 506     }
 507
 508     buffer = malloc(total_bytes);
 509     if (buffer == NULL && total_bytes != 0)
 510         return -1;
 511
 512     bytes_read = posix_read(fd, buffer, total_bytes);
 513     if (bytes_read <= 0) {
 514         free(buffer);
 515         return -1;
 516     }
 517
 518     bytes_left = bytes_read;
 519     buffer_location = buffer;
 520     for (i = 0; i < iovcnt; i++) {
 521         size_t copy = MIN(iov[i].iov_len, bytes_left);
 522
 523         memcpy(iov[i].iov_base, buffer_location, copy);
 524
 525         buffer_location += copy;
 526         bytes_left -= copy;
 527         if (bytes_left == 0)
 528             break;
 529     }
 530
 531     free(buffer);
 532
 533     return bytes_read;
 534 }
 535
 536 /*
 537  * POSIX equivalent for write().
 538  */
 539 ssize_t
 540 posix_write(int fd, const void *buffer, size_t count)
 541 {
 542     SHARED_FUNCTION(send(handle, buffer, count, 0),
 543         _write(handle, buffer, count))
 544 }
 545
 546 /*
 547  * POSIX equivalent for writev
 548  * Modelled after the GNU's libc/sysdeps/posix/writev.c
 549  */
 550 ssize_t
 551 writev(int fd, const struct iovec *iov, int iovcnt)
 552 {
 553     int i;
 554     unsigned char *buffer, *buffer_location;
 555     size_t total_bytes = 0;
 556     int bytes_written;
 557
 558     for (i = 0; i < iovcnt; i++)
 559         total_bytes += iov[i].iov_len;
 560
 561     buffer = malloc(total_bytes);
 562     if (buffer == NULL && total_bytes != 0)
 563         return -1;
 564
 565     buffer_location = buffer;
 566     for (i = 0; i < iovcnt; i++) {
 567         memcpy(buffer_location, iov[i].iov_base, iov[i].iov_len);
 568         buffer_location += iov[i].iov_len;
 569     }
 570
 571     bytes_written = posix_write(fd, buffer, total_bytes);
 572
 573     free(buffer);
 574
 575     if (bytes_written <= 0)
 576         return -1;
 577     return bytes_written;
 578 }
 579
 580 /*
 581  * POSIX equivalent for fileno().
 582  * As fopen/fclose/fcloseall are not implemented as POSIX
 583  * equivalent functions, the mapping is done when required
 584  * by a call to fileno().  The garbage collection of the
 585  * file descriptors allocated is done in set_fd() when the
 586  * handle is reused.
 587  */
 588 int
 589 fileno(FILE *stream)
 590 {
 591     int fd;
 592     int handle;
 593
 594     if (stream == NULL) {
 595         errno = EBADF;
 596         return -1;
 597     }
 598
 599     handle = _fileno(stream);
 600
 601     fd = lookup_fd(handle, FDMAP_IO_FILE);
 602     if (fd >= 0)
 603         return fd;
 604
 605     if ((fd = get_fd()) < 0) {
 606         errno = EBADF;
 607         return -1;
 608     }
 609
 610     set_fd(fd, FDMAP_IO_FILE, handle);
 611     return fd;
 612 }
 613
 614 /*
 615  * POSIX equivalent for fcntl().
 616  * Currently supports only the F_GETFL/F_SETFL/O_NONBLOCK
 617  * Currently ignores F_GETLK/F_SETLK as the file locks are
 618  * implement in open()
 619  */
 620 int
 621 fcntl(int fd, int cmd, ...)
 622 {
 623     va_list ap;
 624     int value;
 625     unsigned int nonblocking;
 626     int result;
 627     long bytes_returned;
 628     int handle;
 629     enum fdmap_io_type type;
 630
 631     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 632         return -1;
 633
 634     switch (cmd)
 635     {
 636     case F_GETFL:
 637         /*
 638          * F_GETFL and F_SETFL only support O_NONBLOCK
 639          * for sockets currently
 640          */
 641         if (type == FDMAP_IO_SOCKET) {
 642             result = WSAIoctl(handle, FIONBIO, NULL, 0,&nonblocking,
 643                 sizeof (nonblocking), &bytes_returned, NULL, NULL);
 644
 645             if(result < 0) {
 646                 errno = WSAGetLastError();
 647                 return -1;
 648             }
 649
 650             if (nonblocking)
 651                 return O_NONBLOCK;
 652             else
 653                 return 0;
 654         }
 655         break;
 656     case F_SETFL:
 657         if (type == FDMAP_IO_SOCKET) {
 658             va_start(ap, cmd);
 659             value = va_arg(ap, int);
 660             va_end(ap);
 661             if (value & O_NONBLOCK)
 662                 nonblocking = 1;
 663             else
 664                 nonblocking = 0;
 665
 666             result = WSAIoctl(handle, FIONBIO, &nonblocking,
 667                 sizeof (nonblocking), NULL, 0, &bytes_returned,
 668                 NULL, NULL);
 669
 670             if(result < 0) {
 671                 errno = WSAGetLastError();
 672                 return -1;
 673             }
 674             return result;
 675         }
 676         break;
 677     case F_SETLK:
 678         /*
 679          * The POSIX equivalent is not available in WIN32
 680          * That implement the file locking in the file open
 681          * by using sopen instead of open.
 682          */
 683         return 0;
 684     }
 685     errno = EINVAL;
 686     return -1;
 687 }