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 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, 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 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 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
 352 #define FILE_FUNCTION(type, expr)                               \
 353     int handle;                                                 \
 354                                                                 \
 355     if (!lookup_handle(fd, (type), EBADF, NULL, &handle))       \
 356         return -1;                                              \
 357                                                                 \
 358     return (expr);
 359
 360 /*
 361  * POSIX equivalent for close().
 362  */
 363 int
 364 posix_close(int fd)
 365 {
 366     int result;
 367     int handle;
 368     enum fdmap_io_type type;
 369
 370     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 371         return -1;
 372
 373     free_fd(fd);
 374     switch (type) {
 375     case FDMAP_IO_SOCKET:
 376         result = closesocket(handle);
 377         if (result == SOCKET_ERROR) {
 378             errno = WSAGetLastError();
 379             return -1;
 380         }
 381         return result;
 382     case FDMAP_IO_FILE:
 383        return _close(handle);
 384     }
 385     CANT_REACH();
 386     return -1;
 387 }
 388
 389 /*
 390  * posix_fsync forces file sync with the disk.
 391  * In order for the power report report to accurate timestamp,
 392  * the _commit() is to force a sync with disk and therefore
 393  * an update for file time.
 394  */
 395 int
 396 posix_fsync(int fd)
 397 {
 398     FILE_FUNCTION(FDMAP_IO_FILE, _commit(handle))
 399 }
 400
 401 /*
 402  * POSIX equivalent for fstat().
 403  * fstat() is used instead of _fstat(),
 404  * otherwise problems with the 32/64 time definitions
 405  * in WIN32.
 406  */
 407 #undef fstat
 408 int
 409 posix_fstat(int fd, struct stat *buffer)
 410 {
 411     FILE_FUNCTION(FDMAP_IO_ANY, fstat(handle, buffer))
 412 }
 413
 414 /*
 415  * POSIX equivalent for lseek().
 416  */
 417 off_t
 418 posix_lseek(int fd, off_t offset, int origin)
 419 {
 420     FILE_FUNCTION(FDMAP_IO_FILE, _lseek(handle, offset, origin))
 421 }
 422
 423 /*
 424  * POSIX equivalent for open().
 425  * Implements file locks when opening files to provide equivalent
 426  * F_GETLK/F_SETLK.
 427  */
 428 int
 429 posix_open(const char *fname, int oflag, ...)
 430 {
 431     va_list ap;
 432     int pmode = 0, new_fd;
 433     int handle;
 434
 435     if (oflag & O_CREAT) {
 436         va_start(ap, oflag);
 437         pmode = va_arg(ap, int);
 438         va_end(ap);
 439     }
 440
 441     if ((new_fd = get_fd()) < 0)
 442         return -1;
 443
 444     /*
 445      * We don't implement fcntl() for F_SETLK.  Instead, we lock *all*
 446      * files we open.  Not ideal, but it works for Empire.
 447      */
 448     handle = _sopen(fname, oflag,
 449         oflag & O_RDONLY ? SH_DENYNO : SH_DENYWR, pmode);
 450     if (handle == -1) {
 451         free_fd(new_fd);
 452         return -1;
 453     }
 454     set_fd(new_fd, FDMAP_IO_FILE, handle);
 455     return new_fd;
 456 }
 457
 458 #define SHARED_FUNCTION(socket_expr, file_expr)                     \
 459     int result;                                                     \
 460     int handle;                                                     \
 461     enum fdmap_io_type type;                                        \
 462                                                                     \
 463     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))    \
 464         return -1;                                                  \
 465                                                                     \
 466     switch (type) {                                                 \
 467     case FDMAP_IO_SOCKET:                                           \
 468         result = (socket_expr);                                     \
 469         if (result == SOCKET_ERROR) {                               \
 470             errno = WSAGetLastError();                              \
 471             return -1;                                              \
 472         }                                                           \
 473         return result;                                              \
 474     case FDMAP_IO_FILE:                                             \
 475         return (file_expr);                                         \
 476     }                                                               \
 477     CANT_REACH();                                                   \
 478     return -1;
 479
 480 /*
 481  * POSIX equivalent for read().
 482  */
 483 ssize_t
 484 posix_read(int fd, void *buffer, size_t count)
 485 {
 486     SHARED_FUNCTION(recv(handle, buffer, count, 0),
 487         _read(handle, buffer, count))
 488 }
 489
 490 /*
 491  * POSIX equivalent for readv
 492  * Modelled after the GNU's libc/sysdeps/posix/readv.c
 493  */
 494 ssize_t
 495 readv(int fd, const struct iovec *iov, int iovcnt)
 496 {
 497     int i;
 498     unsigned char *buffer, *buffer_location;
 499     size_t total_bytes = 0;
 500     int bytes_read;
 501     size_t bytes_left;
 502
 503     for (i = 0; i < iovcnt; i++) {
 504         total_bytes += iov[i].iov_len;
 505     }
 506
 507     buffer = malloc(total_bytes);
 508     if (buffer == NULL)
 509         return -1;
 510
 511     bytes_read = posix_read(fd, buffer, total_bytes);
 512     if (bytes_read <= 0) {
 513         free(buffer);
 514         return -1;
 515     }
 516
 517     bytes_left = bytes_read;
 518     buffer_location = buffer;
 519     for (i = 0; i < iovcnt; i++) {
 520         size_t copy = MIN(iov[i].iov_len, bytes_left);
 521
 522         memcpy(iov[i].iov_base, buffer_location, copy);
 523
 524         buffer_location += copy;
 525         bytes_left -= copy;
 526         if (bytes_left == 0)
 527             break;
 528     }
 529
 530     free(buffer);
 531
 532     return bytes_read;
 533 }
 534
 535 /*
 536  * POSIX equivalent for write().
 537  */
 538 ssize_t
 539 posix_write(int fd, const void *buffer, size_t count)
 540 {
 541     SHARED_FUNCTION(send(handle, buffer, count, 0),
 542         _write(handle, buffer, count))
 543 }
 544
 545 /*
 546  * POSIX equivalent for writev
 547  * Modelled after the GNU's libc/sysdeps/posix/writev.c
 548  */
 549 ssize_t
 550 writev(int fd, const struct iovec *iov, int iovcnt)
 551 {
 552     int i;
 553     unsigned char *buffer, *buffer_location;
 554     size_t total_bytes = 0;
 555     int bytes_written;
 556
 557     for (i = 0; i < iovcnt; i++)
 558         total_bytes += iov[i].iov_len;
 559
 560     if (total_bytes == 0)
 561         return 0;
 562
 563     buffer = malloc(total_bytes);
 564     if (buffer == NULL)
 565         return -1;
 566
 567     buffer_location = buffer;
 568     for (i = 0; i < iovcnt; i++) {
 569         memcpy(buffer_location, iov[i].iov_base, iov[i].iov_len);
 570         buffer_location += iov[i].iov_len;
 571     }
 572
 573     bytes_written = posix_write(fd, buffer, total_bytes);
 574
 575     free(buffer);
 576
 577     if (bytes_written <= 0)
 578         return -1;
 579     return bytes_written;
 580 }
 581
 582 /*
 583  * POSIX equivalent for fileno().
 584  * As fopen/fclose/fcloseall are not implemented as POSIX
 585  * equivalent functions, the mapping is done when required
 586  * by a call to fileno().  The garbage collection of the
 587  * file descriptors allocated is done in set_fd() when the
 588  * handle is reused.
 589  */
 590 int
 591 posix_fileno(FILE *stream)
 592 {
 593     int fd;
 594     int handle;
 595
 596     if (stream == NULL) {
 597         errno = EBADF;
 598         return -1;
 599     }
 600
 601     handle = _fileno(stream);
 602
 603     fd = lookup_fd(handle, FDMAP_IO_FILE);
 604     if (fd >= 0)
 605         return fd;
 606
 607     if ((fd = get_fd()) < 0) {
 608         errno = EBADF;
 609         return -1;
 610     }
 611
 612     set_fd(fd, FDMAP_IO_FILE, handle);
 613     return fd;
 614 }
 615
 616 /*
 617  * POSIX equivalent for fcntl().
 618  * Currently supports only the F_GETFL/F_SETFL/O_NONBLOCK
 619  * Currently ignores F_GETLK/F_SETLK as the file locks are
 620  * implement in open()
 621  */
 622 int
 623 fcntl(int fd, int cmd, ...)
 624 {
 625     va_list ap;
 626     int value;
 627     unsigned int nonblocking;
 628     int result;
 629     long bytes_returned;
 630     int handle;
 631     enum fdmap_io_type type;
 632
 633     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 634         return -1;
 635
 636     switch (cmd)
 637     {
 638     case F_GETFL:
 639         /*
 640          * F_GETFL and F_SETFL only support O_NONBLOCK
 641          * for sockets currently
 642          */
 643         if (type == FDMAP_IO_SOCKET) {
 644             result = WSAIoctl(handle, FIONBIO, NULL, 0,&nonblocking,
 645                 sizeof (nonblocking), &bytes_returned, NULL, NULL);
 646
 647             if(result < 0) {
 648                 errno = WSAGetLastError();
 649                 return -1;
 650             }
 651
 652             if (nonblocking)
 653                 return O_NONBLOCK;
 654             else
 655                 return 0;
 656         }
 657         break;
 658     case F_SETFL:
 659         if (type == FDMAP_IO_SOCKET) {
 660             va_start(ap, cmd);
 661             value = va_arg(ap, int);
 662             va_end(ap);
 663             if (value & O_NONBLOCK)
 664                 nonblocking = 1;
 665             else
 666                 nonblocking = 0;
 667
 668             result = WSAIoctl(handle, FIONBIO, &nonblocking,
 669                 sizeof (nonblocking), NULL, 0, &bytes_returned,
 670                 NULL, NULL);
 671
 672             if(result < 0) {
 673                 errno = WSAGetLastError();
 674                 return -1;
 675             }
 676             return result;
 677         }
 678         break;
 679     case F_SETLK:
 680         /*
 681          * The POSIX equivalent is not available in WIN32
 682          * That implement the file locking in the file open
 683          * by using sopen instead of open.
 684          */
 685         return 0;
 686     }
 687     errno = EINVAL;
 688     return -1;
 689 }