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 <direct.h>
  50 #include <sys/stat.h>
  51 #include <fcntl.h>
  52 #include <share.h>
  53
  54 #include <errno.h>
  55
  56 #include "unistd.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 dmap_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 char *optval, int optlen)
 272 {
 273     SOCKET_FUNCTION(setsockopt(handle, level, optname,
 274                     optval, optlen))
 275 }
 276
 277 /*
 278  * POSIX equivalent for shutdown().
 279  */
 280 #undef shutdown
 281 int
 282 posix_shutdown(int fd, int how)
 283 {
 284     SOCKET_FUNCTION(shutdown(handle, how))
 285 }
 286
 287 /*
 288  * POSIX equivalent for socket().
 289  */
 290 #undef socket
 291 int
 292 posix_socket(int domain, int type, int protocol)
 293 {
 294     int handle;
 295     int new_fd;
 296
 297     if ((new_fd = get_fd()) < 0)
 298         return -1;
 299
 300     handle = socket(domain, type, protocol);
 301     if (handle == INVALID_SOCKET) {
 302         free_fd(new_fd);
 303         errno = WSAGetLastError();
 304         return -1;
 305     }
 306     set_fd(new_fd, FDMAP_IO_SOCKET, handle);
 307     return new_fd;
 308 }
 309
 310 #define FILE_FUNCTION(type, expr)                               \
 311     int handle;                                                 \
 312                                                                 \
 313     if (!lookup_handle(fd, (type), EBADF, NULL, &handle))       \
 314         return -1;                                              \
 315                                                                 \
 316     return (expr);
 317
 318 /*
 319  * POSIX equivalent for close().
 320  */
 321 int
 322 posix_close(int fd)
 323 {
 324     int result;
 325     int handle;
 326     enum fdmap_io_type type;
 327
 328     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 329         return -1;
 330
 331     free_fd(fd);
 332     switch (type) {
 333     case FDMAP_IO_SOCKET:
 334         result = closesocket(handle);
 335         if (result == SOCKET_ERROR) {
 336             errno = WSAGetLastError();
 337             return -1;
 338         }
 339         return result;
 340     case FDMAP_IO_FILE:
 341        return _close(handle);
 342     }
 343     CANT_REACH();
 344     return -1;
 345 }
 346
 347 /*
 348  * posix_fsync forces file sync with the disk.
 349  * In order for the power report report to accurate timestamp,
 350  * the _commit() is to force a sync with disk and therefore
 351  * an update for file time.
 352  */
 353 int
 354 posix_fsync(int fd)
 355 {
 356     FILE_FUNCTION(FDMAP_IO_FILE, _commit(handle))
 357 }
 358
 359 /*
 360  * POSIX equivalent for fstat().
 361  * fstat() is used instead of _fstat(),
 362  * otherwise problems with the 32/64 time definitions
 363  * in WIN32.
 364  */
 365 #undef fstat
 366 int
 367 posix_fstat(int fd, struct stat *buffer)
 368 {
 369     FILE_FUNCTION(FDMAP_IO_ANY, fstat(handle, buffer))
 370 }
 371
 372 /*
 373  * POSIX equivalent for lseek().
 374  */
 375 int
 376 posix_lseek(int fd, long offset, int origin)
 377 {
 378     FILE_FUNCTION(FDMAP_IO_FILE, _lseek(handle, offset, origin))
 379 }
 380
 381 /*
 382  * POSIX equivalent for open().
 383  * Implements file locks when opening files to provide equivalent
 384  * F_GETLK/F_SETLK.
 385  */
 386 int
 387 posix_open(const char *fname, int oflag, ...)
 388 {
 389     va_list ap;
 390     int pmode = 0, new_fd;
 391     int handle;
 392
 393     if (oflag & O_CREAT) {
 394         va_start(ap, oflag);
 395         pmode = va_arg(ap, int);
 396         va_end(ap);
 397     }
 398
 399     if ((new_fd = get_fd()) < 0)
 400         return -1;
 401
 402     /*
 403      * We don't implement fcntl() for F_SETLK.  Instead, we lock *all*
 404      * files we open.  Not ideal, but it works for Empire.
 405      */
 406     _sopen_s(&handle, fname, oflag,
 407         oflag & O_RDONLY ? SH_DENYNO : SH_DENYWR, pmode);
 408     if (handle == -1) {
 409         free_fd(new_fd);
 410         return -1;
 411     }
 412     set_fd(new_fd, FDMAP_IO_FILE, handle);
 413     return new_fd;
 414 }
 415
 416 #define SHARED_FUNCTION(socket_expr, file_expr)                     \
 417     int result;                                                     \
 418     int handle;                                                     \
 419     enum fdmap_io_type type;                                        \
 420                                                                     \
 421     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))    \
 422         return -1;                                                  \
 423                                                                     \
 424     switch (type) {                                                 \
 425     case FDMAP_IO_SOCKET:                                           \
 426         result = (socket_expr);                                     \
 427         if (result == SOCKET_ERROR) {                               \
 428             errno = WSAGetLastError();                              \
 429             return -1;                                              \
 430         }                                                           \
 431         return result;                                              \
 432     case FDMAP_IO_FILE:                                             \
 433         return (file_expr);                                         \
 434     }                                                               \
 435     CANT_REACH();                                                   \
 436     return -1;
 437
 438 /*
 439  * POSIX equivalent for read().
 440  */
 441 int
 442 posix_read(int fd, void *buffer, unsigned int count)
 443 {
 444     SHARED_FUNCTION(recv(handle, buffer, count, 0),
 445         _read(handle, buffer, count))
 446 }
 447
 448 /*
 449  * POSIX equivalent for write().
 450  */
 451 int
 452 posix_write(int fd, const void *buffer, unsigned int count)
 453 {
 454     SHARED_FUNCTION(send(handle, buffer, count, 0),
 455         _write(handle, buffer, count))
 456 }
 457
 458 /*
 459  * POSIX equivalent for fileno().
 460  * As fopen/fclose/fcloseall are not implemented as POSIX
 461  * equivalent functions, the mapping is done when required
 462  * by a call to fileno().  The garbage collection of the
 463  * file descriptors allocated is done in set_fd() when the
 464  * handle is reused.
 465  */
 466 int
 467 posix_fileno(FILE *stream)
 468 {
 469     int fd;
 470     int handle;
 471
 472     if (stream == NULL) {
 473         errno = EBADF;
 474         return -1;
 475     }
 476
 477     handle = _fileno(stream);
 478
 479     fd = lookup_fd(handle, FDMAP_IO_FILE);
 480     if (fd >= 0)
 481         return fd;
 482
 483     if ((fd = get_fd()) < 0) {
 484         errno = EBADF;
 485         return -1;
 486     }
 487
 488     set_fd(fd, FDMAP_IO_FILE, handle);
 489     return fd;
 490 }
 491
 492 /*
 493  * POSIX equivalent for fcntl().
 494  * Currently supports only the F_GETFL/F_SETFL/O_NONBLOCK
 495  * Currently ignores F_GETLK/F_SETLK as the file locks are
 496  * implement in open()
 497  */
 498 int
 499 fcntl(int fd, int cmd, ...)
 500 {
 501     va_list ap;
 502     int value;
 503     unsigned int nonblocking;
 504     int result;
 505     long bytes_returned;
 506     int handle;
 507     enum fdmap_io_type type;
 508
 509     if (!lookup_handle(fd, FDMAP_IO_ANY, EBADF, &type, &handle))
 510         return -1;
 511
 512     switch (cmd)
 513     {
 514     case F_GETFL:
 515         /*
 516          * F_GETFL and F_SETFL only support O_NONBLOCK
 517          * for sockets currently
 518          */
 519         if (type == FDMAP_IO_SOCKET) {
 520             result = WSAIoctl(handle, FIONBIO, NULL, 0,&nonblocking,
 521                 sizeof (nonblocking), &bytes_returned, NULL, NULL);
 522
 523             if(result < 0) {
 524                 errno = WSAGetLastError();
 525                 return -1;
 526             }
 527
 528             if (nonblocking)
 529                 return O_NONBLOCK;
 530             else
 531                 return 0;
 532         }
 533         break;
 534     case F_SETFL:
 535         if (type == FDMAP_IO_SOCKET) {
 536             va_start(ap, cmd);
 537             value = va_arg(ap, int);
 538             va_end(ap);
 539             if (value & O_NONBLOCK)
 540                 nonblocking = 1;
 541             else
 542                 nonblocking = 0;
 543
 544             result = WSAIoctl(handle, FIONBIO, &nonblocking,
 545                 sizeof (nonblocking), NULL, 0, &bytes_returned,
 546                 NULL, NULL);
 547
 548             if(result < 0) {
 549                 errno = WSAGetLastError();
 550                 return -1;
 551             }
 552             return result;
 553         }
 554         break;
 555     case F_SETLK:
 556         /*
 557          * The POSIX equivalent is not available in WIN32
 558          * That implement the file locking in the file open
 559          * by using sopen instead of open.
 560          */
 561         return 0;
 562     }
 563     errno = EINVAL;
 564     return -1;
 565 }