dlls/ntdll/server.c

   1 /*
   2  * Wine server communication
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <assert.h>
  25 #include <ctype.h>
  26 #include <dirent.h>
  27 #include <errno.h>
  28 #include <fcntl.h>
  29 #include <signal.h>
  30 #include <stdarg.h>
  31 #include <stdio.h>
  32 #include <string.h>
  33 #include <sys/types.h>
  34 #ifdef HAVE_SYS_SOCKET_H
  35 # include <sys/socket.h>
  36 #endif
  37 #ifdef HAVE_SYS_WAIT_H
  38 #include <sys/wait.h>
  39 #endif
  40 #ifdef HAVE_SYS_UN_H
  41 #include <sys/un.h>
  42 #endif
  43 #ifdef HAVE_SYS_MMAN_H
  44 #include <sys/mman.h>
  45 #endif
  46 #ifdef HAVE_SYS_STAT_H
  47 # include <sys/stat.h>
  48 #endif
  49 #ifdef HAVE_SYS_UIO_H
  50 #include <sys/uio.h>
  51 #endif
  52 #ifdef HAVE_UNISTD_H
  53 # include <unistd.h>
  54 #endif
  55
  56 #include "ntstatus.h"
  57 #define WIN32_NO_STATUS
  58 #include "wine/library.h"
  59 #include "wine/pthread.h"
  60 #include "wine/server.h"
  61 #include "wine/debug.h"
  62 #include "ntdll_misc.h"
  63
  64 WINE_DEFAULT_DEBUG_CHANNEL(server);
  65
  66 /* Some versions of glibc don't define this */
  67 #ifndef SCM_RIGHTS
  68 #define SCM_RIGHTS 1
  69 #endif
  70
  71 #define SOCKETNAME "socket"        /* name of the socket file */
  72 #define LOCKNAME   "lock"          /* name of the lock file */
  73
  74 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
  75 /* data structure used to pass an fd with sendmsg/recvmsg */
  76 struct cmsg_fd
  77 {
  78     struct
  79     {
  80         size_t len;   /* size of structure */
  81         int    level; /* SOL_SOCKET */
  82         int    type;  /* SCM_RIGHTS */
  83     } header;
  84     int fd;          /* fd to pass */
  85 };
  86 #endif  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
  87
  88 timeout_t server_start_time = 0;  /* time of server startup */
  89
  90 extern struct wine_pthread_functions pthread_functions;
  91
  92 sigset_t server_block_set;  /* signals to block during server calls */
  93 static int fd_socket = -1;  /* socket to exchange file descriptors with the server */
  94
  95 static RTL_CRITICAL_SECTION fd_cache_section;
  96 static RTL_CRITICAL_SECTION_DEBUG critsect_debug =
  97 {
  98     0, 0, &fd_cache_section,
  99     { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
 100       0, 0, { (DWORD_PTR)(__FILE__ ": fd_cache_section") }
 101 };
 102 static RTL_CRITICAL_SECTION fd_cache_section = { &critsect_debug, -1, 0, 0, 0, 0 };
 103
 104
 105 #ifdef __GNUC__
 106 static void fatal_error( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
 107 static void fatal_perror( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
 108 static void server_connect_error( const char *serverdir ) __attribute__((noreturn));
 109 #endif
 110
 111 /* die on a fatal error; use only during initialization */
 112 static void fatal_error( const char *err, ... )
 113 {
 114     va_list args;
 115
 116     va_start( args, err );
 117     fprintf( stderr, "wine: " );
 118     vfprintf( stderr, err, args );
 119     va_end( args );
 120     exit(1);
 121 }
 122
 123 /* die on a fatal error; use only during initialization */
 124 static void fatal_perror( const char *err, ... )
 125 {
 126     va_list args;
 127
 128     va_start( args, err );
 129     fprintf( stderr, "wine: " );
 130     vfprintf( stderr, err, args );
 131     perror( " " );
 132     va_end( args );
 133     exit(1);
 134 }
 135
 136
 137 /***********************************************************************
 138  *           server_exit_thread
 139  */
 140 void server_exit_thread( int status )
 141 {
 142     struct wine_pthread_thread_info info;
 143     SIZE_T size;
 144     int fds[4];
 145
 146     RtlAcquirePebLock();
 147     RemoveEntryList( &NtCurrentTeb()->TlsLinks );
 148     RtlReleasePebLock();
 149
 150     info.stack_base  = NtCurrentTeb()->DeallocationStack;
 151     info.teb_base    = NtCurrentTeb();
 152     info.teb_sel     = wine_get_fs();
 153     info.exit_status = status;
 154
 155     fds[0] = ntdll_get_thread_data()->wait_fd[0];
 156     fds[1] = ntdll_get_thread_data()->wait_fd[1];
 157     fds[2] = ntdll_get_thread_data()->reply_fd;
 158     fds[3] = ntdll_get_thread_data()->request_fd;
 159     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, NULL );
 160
 161     size = 0;
 162     NtFreeVirtualMemory( GetCurrentProcess(), &info.stack_base, &size, MEM_RELEASE | MEM_SYSTEM );
 163     info.stack_size = size;
 164
 165     size = 0;
 166     NtFreeVirtualMemory( GetCurrentProcess(), &info.teb_base, &size, MEM_RELEASE | MEM_SYSTEM );
 167     info.teb_size = size;
 168
 169     close( fds[0] );
 170     close( fds[1] );
 171     close( fds[2] );
 172     close( fds[3] );
 173     pthread_functions.exit_thread( &info );
 174 }
 175
 176
 177 /***********************************************************************
 178  *           server_abort_thread
 179  */
 180 void server_abort_thread( int status )
 181 {
 182     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, NULL );
 183     close( ntdll_get_thread_data()->wait_fd[0] );
 184     close( ntdll_get_thread_data()->wait_fd[1] );
 185     close( ntdll_get_thread_data()->reply_fd );
 186     close( ntdll_get_thread_data()->request_fd );
 187     pthread_functions.abort_thread( status );
 188 }
 189
 190
 191 /***********************************************************************
 192  *           server_protocol_error
 193  */
 194 void server_protocol_error( const char *err, ... )
 195 {
 196     va_list args;
 197
 198     va_start( args, err );
 199     fprintf( stderr, "wine client error:%x: ", GetCurrentThreadId() );
 200     vfprintf( stderr, err, args );
 201     va_end( args );
 202     server_abort_thread(1);
 203 }
 204
 205
 206 /***********************************************************************
 207  *           server_protocol_perror
 208  */
 209 void server_protocol_perror( const char *err )
 210 {
 211     fprintf( stderr, "wine client error:%x: ", GetCurrentThreadId() );
 212     perror( err );
 213     server_abort_thread(1);
 214 }
 215
 216
 217 /***********************************************************************
 218  *           send_request
 219  *
 220  * Send a request to the server.
 221  */
 222 static unsigned int send_request( const struct __server_request_info *req )
 223 {
 224     unsigned int i;
 225     int ret;
 226
 227     if (!req->u.req.request_header.request_size)
 228     {
 229         if ((ret = write( ntdll_get_thread_data()->request_fd, &req->u.req,
 230                           sizeof(req->u.req) )) == sizeof(req->u.req)) return STATUS_SUCCESS;
 231
 232     }
 233     else
 234     {
 235         struct iovec vec[__SERVER_MAX_DATA+1];
 236
 237         vec[0].iov_base = (void *)&req->u.req;
 238         vec[0].iov_len = sizeof(req->u.req);
 239         for (i = 0; i < req->data_count; i++)
 240         {
 241             vec[i+1].iov_base = (void *)req->data[i].ptr;
 242             vec[i+1].iov_len = req->data[i].size;
 243         }
 244         if ((ret = writev( ntdll_get_thread_data()->request_fd, vec, i+1 )) ==
 245             req->u.req.request_header.request_size + sizeof(req->u.req)) return STATUS_SUCCESS;
 246     }
 247
 248     if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
 249     if (errno == EPIPE) server_abort_thread(0);
 250     if (errno == EFAULT) return STATUS_ACCESS_VIOLATION;
 251     server_protocol_perror( "write" );
 252 }
 253
 254
 255 /***********************************************************************
 256  *           read_reply_data
 257  *
 258  * Read data from the reply buffer; helper for wait_reply.
 259  */
 260 static void read_reply_data( void *buffer, size_t size )
 261 {
 262     int ret;
 263
 264     for (;;)
 265     {
 266         if ((ret = read( ntdll_get_thread_data()->reply_fd, buffer, size )) > 0)
 267         {
 268             if (!(size -= ret)) return;
 269             buffer = (char *)buffer + ret;
 270             continue;
 271         }
 272         if (!ret) break;
 273         if (errno == EINTR) continue;
 274         if (errno == EPIPE) break;
 275         server_protocol_perror("read");
 276     }
 277     /* the server closed the connection; time to die... */
 278     server_abort_thread(0);
 279 }
 280
 281
 282 /***********************************************************************
 283  *           wait_reply
 284  *
 285  * Wait for a reply from the server.
 286  */
 287 static inline unsigned int wait_reply( struct __server_request_info *req )
 288 {
 289     read_reply_data( &req->u.reply, sizeof(req->u.reply) );
 290     if (req->u.reply.reply_header.reply_size)
 291         read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
 292     return req->u.reply.reply_header.error;
 293 }
 294
 295
 296 /***********************************************************************
 297  *           wine_server_call (NTDLL.@)
 298  *
 299  * Perform a server call.
 300  *
 301  * PARAMS
 302  *     req_ptr [I/O] Function dependent data
 303  *
 304  * RETURNS
 305  *     Depends on server function being called, but usually an NTSTATUS code.
 306  *
 307  * NOTES
 308  *     Use the SERVER_START_REQ and SERVER_END_REQ to help you fill out the
 309  *     server request structure for the particular call. E.g:
 310  *|     SERVER_START_REQ( event_op )
 311  *|     {
 312  *|         req->handle = handle;
 313  *|         req->op     = SET_EVENT;
 314  *|         ret = wine_server_call( req );
 315  *|     }
 316  *|     SERVER_END_REQ;
 317  */
 318 unsigned int wine_server_call( void *req_ptr )
 319 {
 320     struct __server_request_info * const req = req_ptr;
 321     sigset_t old_set;
 322     unsigned int ret;
 323
 324     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, &old_set );
 325     ret = send_request( req );
 326     if (!ret) ret = wait_reply( req );
 327     pthread_functions.sigprocmask( SIG_SETMASK, &old_set, NULL );
 328     return ret;
 329 }
 330
 331
 332 /***********************************************************************
 333  *           server_enter_uninterrupted_section
 334  */
 335 void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset )
 336 {
 337     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, sigset );
 338     RtlEnterCriticalSection( cs );
 339 }
 340
 341
 342 /***********************************************************************
 343  *           server_leave_uninterrupted_section
 344  */
 345 void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset )
 346 {
 347     RtlLeaveCriticalSection( cs );
 348     pthread_functions.sigprocmask( SIG_SETMASK, sigset, NULL );
 349 }
 350
 351
 352 /***********************************************************************
 353  *           wine_server_send_fd   (NTDLL.@)
 354  *
 355  * Send a file descriptor to the server.
 356  *
 357  * PARAMS
 358  *     fd [I] file descriptor to send
 359  *
 360  * RETURNS
 361  *     nothing
 362  */
 363 void wine_server_send_fd( int fd )
 364 {
 365 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
 366     struct cmsg_fd cmsg;
 367 #endif
 368     struct send_fd data;
 369     struct msghdr msghdr;
 370     struct iovec vec;
 371     int ret;
 372
 373     vec.iov_base = (void *)&data;
 374     vec.iov_len  = sizeof(data);
 375
 376     msghdr.msg_name    = NULL;
 377     msghdr.msg_namelen = 0;
 378     msghdr.msg_iov     = &vec;
 379     msghdr.msg_iovlen  = 1;
 380
 381 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
 382     msghdr.msg_accrights    = (void *)&fd;
 383     msghdr.msg_accrightslen = sizeof(fd);
 384 #else  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
 385     cmsg.header.len   = sizeof(cmsg.header) + sizeof(fd);
 386     cmsg.header.level = SOL_SOCKET;
 387     cmsg.header.type  = SCM_RIGHTS;
 388     cmsg.fd           = fd;
 389     msghdr.msg_control    = &cmsg;
 390     msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
 391     msghdr.msg_flags      = 0;
 392 #endif  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
 393
 394     data.tid = GetCurrentThreadId();
 395     data.fd  = fd;
 396
 397     for (;;)
 398     {
 399         if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
 400         if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
 401         if (errno == EINTR) continue;
 402         if (errno == EPIPE) server_abort_thread(0);
 403         server_protocol_perror( "sendmsg" );
 404     }
 405 }
 406
 407
 408 /***********************************************************************
 409  *           receive_fd
 410  *
 411  * Receive a file descriptor passed from the server.
 412  */
 413 static int receive_fd( obj_handle_t *handle )
 414 {
 415     struct iovec vec;
 416     int ret, fd;
 417
 418 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
 419     struct msghdr msghdr;
 420
 421     fd = -1;
 422     msghdr.msg_accrights    = (void *)&fd;
 423     msghdr.msg_accrightslen = sizeof(fd);
 424 #else  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
 425     struct msghdr msghdr;
 426     struct cmsg_fd cmsg;
 427
 428     cmsg.header.len   = sizeof(cmsg.header) + sizeof(fd);
 429     cmsg.header.level = SOL_SOCKET;
 430     cmsg.header.type  = SCM_RIGHTS;
 431     cmsg.fd           = -1;
 432     msghdr.msg_control    = &cmsg;
 433     msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
 434     msghdr.msg_flags      = 0;
 435 #endif  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
 436
 437     msghdr.msg_name    = NULL;
 438     msghdr.msg_namelen = 0;
 439     msghdr.msg_iov     = &vec;
 440     msghdr.msg_iovlen  = 1;
 441     vec.iov_base = (void *)handle;
 442     vec.iov_len  = sizeof(*handle);
 443
 444     for (;;)
 445     {
 446         if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
 447         {
 448 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
 449             fd = cmsg.fd;
 450 #endif
 451             if (fd != -1) fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
 452             return fd;
 453         }
 454         if (!ret) break;
 455         if (errno == EINTR) continue;
 456         if (errno == EPIPE) break;
 457         server_protocol_perror("recvmsg");
 458     }
 459     /* the server closed the connection; time to die... */
 460     server_abort_thread(0);
 461 }
 462
 463
 464 /***********************************************************************/
 465 /* fd cache support */
 466
 467 struct fd_cache_entry
 468 {
 469     int fd;
 470     enum server_fd_type type : 6;
 471     unsigned int        access : 2;
 472     unsigned int        options : 24;
 473 };
 474
 475 #define FD_CACHE_BLOCK_SIZE  (65536 / sizeof(struct fd_cache_entry))
 476 #define FD_CACHE_ENTRIES     128
 477
 478 static struct fd_cache_entry *fd_cache[FD_CACHE_ENTRIES];
 479 static struct fd_cache_entry fd_cache_initial_block[FD_CACHE_BLOCK_SIZE];
 480
 481 static inline unsigned int handle_to_index( obj_handle_t handle, unsigned int *entry )
 482 {
 483     unsigned long idx = ((unsigned long)handle >> 2) - 1;
 484     *entry = idx / FD_CACHE_BLOCK_SIZE;
 485     return idx % FD_CACHE_BLOCK_SIZE;
 486 }
 487
 488
 489 /***********************************************************************
 490  *           add_fd_to_cache
 491  *
 492  * Caller must hold fd_cache_section.
 493  */
 494 static int add_fd_to_cache( obj_handle_t handle, int fd, enum server_fd_type type,
 495                             unsigned int access, unsigned int options )
 496 {
 497     unsigned int entry, idx = handle_to_index( handle, &entry );
 498     int prev_fd;
 499
 500     if (entry >= FD_CACHE_ENTRIES)
 501     {
 502         FIXME( "too many allocated handles, not caching %p\n", handle );
 503         return 0;
 504     }
 505
 506     if (!fd_cache[entry])  /* do we need to allocate a new block of entries? */
 507     {
 508         if (!entry) fd_cache[0] = fd_cache_initial_block;
 509         else
 510         {
 511             void *ptr = wine_anon_mmap( NULL, FD_CACHE_BLOCK_SIZE * sizeof(struct fd_cache_entry),
 512                                         PROT_READ | PROT_WRITE, 0 );
 513             if (ptr == MAP_FAILED) return 0;
 514             fd_cache[entry] = ptr;
 515         }
 516     }
 517     /* store fd+1 so that 0 can be used as the unset value */
 518     prev_fd = interlocked_xchg( &fd_cache[entry][idx].fd, fd + 1 ) - 1;
 519     fd_cache[entry][idx].type = type;
 520     fd_cache[entry][idx].access = access;
 521     fd_cache[entry][idx].options = options;
 522     if (prev_fd != -1) close( prev_fd );
 523     return 1;
 524 }
 525
 526
 527 /***********************************************************************
 528  *           get_cached_fd
 529  *
 530  * Caller must hold fd_cache_section.
 531  */
 532 static inline int get_cached_fd( obj_handle_t handle, enum server_fd_type *type,
 533                                  unsigned int *access, unsigned int *options )
 534 {
 535     unsigned int entry, idx = handle_to_index( handle, &entry );
 536     int fd = -1;
 537
 538     if (entry < FD_CACHE_ENTRIES && fd_cache[entry])
 539     {
 540         fd = fd_cache[entry][idx].fd - 1;
 541         if (type) *type = fd_cache[entry][idx].type;
 542         if (access) *access = fd_cache[entry][idx].access;
 543         if (options) *options = fd_cache[entry][idx].options;
 544     }
 545     return fd;
 546 }
 547
 548
 549 /***********************************************************************
 550  *           server_remove_fd_from_cache
 551  */
 552 int server_remove_fd_from_cache( obj_handle_t handle )
 553 {
 554     unsigned int entry, idx = handle_to_index( handle, &entry );
 555     int fd = -1;
 556
 557     if (entry < FD_CACHE_ENTRIES && fd_cache[entry])
 558         fd = interlocked_xchg( &fd_cache[entry][idx].fd, 0 ) - 1;
 559
 560     return fd;
 561 }
 562
 563
 564 /***********************************************************************
 565  *           server_get_unix_fd
 566  *
 567  * The returned unix_fd should be closed iff needs_close is non-zero.
 568  */
 569 int server_get_unix_fd( obj_handle_t handle, unsigned int wanted_access, int *unix_fd,
 570                         int *needs_close, enum server_fd_type *type, unsigned int *options )
 571 {
 572     sigset_t sigset;
 573     obj_handle_t fd_handle;
 574     int ret = 0, fd;
 575     unsigned int access = 0;
 576
 577     *unix_fd = -1;
 578     *needs_close = 0;
 579     wanted_access &= FILE_READ_DATA | FILE_WRITE_DATA;
 580
 581     server_enter_uninterrupted_section( &fd_cache_section, &sigset );
 582
 583     fd = get_cached_fd( handle, type, &access, options );
 584     if (fd != -1) goto done;
 585
 586     SERVER_START_REQ( get_handle_fd )
 587     {
 588         req->handle = handle;
 589         if (!(ret = wine_server_call( req )))
 590         {
 591             if (type) *type = reply->type;
 592             if (options) *options = reply->options;
 593             access = reply->access;
 594             if ((fd = receive_fd( &fd_handle )) != -1)
 595             {
 596                 assert( fd_handle == handle );
 597                 *needs_close = (reply->removable ||
 598                                 !add_fd_to_cache( handle, fd, reply->type,
 599                                                   reply->access, reply->options ));
 600             }
 601             else ret = STATUS_TOO_MANY_OPENED_FILES;
 602         }
 603     }
 604     SERVER_END_REQ;
 605
 606 done:
 607     server_leave_uninterrupted_section( &fd_cache_section, &sigset );
 608     if (!ret && ((access & wanted_access) != wanted_access))
 609     {
 610         ret = STATUS_ACCESS_DENIED;
 611         if (*needs_close) close( fd );
 612     }
 613     if (!ret) *unix_fd = fd;
 614     return ret;
 615 }
 616
 617
 618 /***********************************************************************
 619  *           wine_server_fd_to_handle   (NTDLL.@)
 620  *
 621  * Allocate a file handle for a Unix file descriptor.
 622  *
 623  * PARAMS
 624  *     fd      [I] Unix file descriptor.
 625  *     access  [I] Win32 access flags.
 626  *     attributes [I] Object attributes.
 627  *     handle  [O] Address where Wine file handle will be stored.
 628  *
 629  * RETURNS
 630  *     NTSTATUS code
 631  */
 632 int wine_server_fd_to_handle( int fd, unsigned int access, unsigned int attributes, obj_handle_t *handle )
 633 {
 634     int ret;
 635
 636     *handle = 0;
 637     wine_server_send_fd( fd );
 638
 639     SERVER_START_REQ( alloc_file_handle )
 640     {
 641         req->access     = access;
 642         req->attributes = attributes;
 643         req->fd         = fd;
 644         if (!(ret = wine_server_call( req ))) *handle = reply->handle;
 645     }
 646     SERVER_END_REQ;
 647     return ret;
 648 }
 649
 650
 651 /***********************************************************************
 652  *           wine_server_handle_to_fd   (NTDLL.@)
 653  *
 654  * Retrieve the file descriptor corresponding to a file handle.
 655  *
 656  * PARAMS
 657  *     handle  [I] Wine file handle.
 658  *     access  [I] Win32 file access rights requested.
 659  *     unix_fd [O] Address where Unix file descriptor will be stored.
 660  *     options [O] Address where the file open options will be stored. Optional.
 661  *
 662  * RETURNS
 663  *     NTSTATUS code
 664  */
 665 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd,
 666                               unsigned int *options )
 667 {
 668     int needs_close, ret = server_get_unix_fd( handle, access, unix_fd, &needs_close, NULL, options );
 669
 670     if (!ret && !needs_close)
 671     {
 672         if ((*unix_fd = dup(*unix_fd)) == -1) ret = FILE_GetNtStatus();
 673     }
 674     return ret;
 675 }
 676
 677
 678 /***********************************************************************
 679  *           wine_server_release_fd   (NTDLL.@)
 680  *
 681  * Release the Unix file descriptor returned by wine_server_handle_to_fd.
 682  *
 683  * PARAMS
 684  *     handle  [I] Wine file handle.
 685  *     unix_fd [I] Unix file descriptor to release.
 686  *
 687  * RETURNS
 688  *     nothing
 689  */
 690 void wine_server_release_fd( obj_handle_t handle, int unix_fd )
 691 {
 692     close( unix_fd );
 693 }
 694
 695
 696 /***********************************************************************
 697  *           start_server
 698  *
 699  * Start a new wine server.
 700  */
 701 static void start_server(void)
 702 {
 703     static int started;  /* we only try once */
 704     char *argv[3];
 705     static char wineserver[] = "server/wineserver";
 706     static char debug[] = "-d";
 707
 708     if (!started)
 709     {
 710         int status;
 711         int pid = fork();
 712         if (pid == -1) fatal_perror( "fork" );
 713         if (!pid)
 714         {
 715             argv[0] = wineserver;
 716             argv[1] = TRACE_ON(server) ? debug : NULL;
 717             argv[2] = NULL;
 718             wine_exec_wine_binary( argv[0], argv, getenv("WINESERVER") );
 719             fatal_error( "could not exec wineserver\n" );
 720         }
 721         waitpid( pid, &status, 0 );
 722         status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
 723         if (status == 2) return;  /* server lock held by someone else, will retry later */
 724         if (status) exit(status);  /* server failed */
 725         started = 1;
 726     }
 727 }
 728
 729
 730 /***********************************************************************
 731  *           server_connect_error
 732  *
 733  * Try to display a meaningful explanation of why we couldn't connect
 734  * to the server.
 735  */
 736 static void server_connect_error( const char *serverdir )
 737 {
 738     int fd;
 739     struct flock fl;
 740
 741     if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
 742         fatal_error( "for some mysterious reason, the wine server never started.\n" );
 743
 744     fl.l_type   = F_WRLCK;
 745     fl.l_whence = SEEK_SET;
 746     fl.l_start  = 0;
 747     fl.l_len    = 1;
 748     if (fcntl( fd, F_GETLK, &fl ) != -1)
 749     {
 750         if (fl.l_type == F_WRLCK)  /* the file is locked */
 751             fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
 752                          "   You probably need to kill that process (it might be pid %d).\n",
 753                          (int)fl.l_pid );
 754         fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
 755     }
 756     fatal_error( "the file system of '%s' doesn't support locks,\n"
 757           "   and there is a 'socket' file in that directory that prevents wine from starting.\n"
 758           "   You should make sure no wine server is running, remove that file and try again.\n",
 759                  serverdir );
 760 }
 761
 762
 763 /***********************************************************************
 764  *           server_connect
 765  *
 766  * Attempt to connect to an existing server socket.
 767  * We need to be in the server directory already.
 768  */
 769 static int server_connect( const char *serverdir )
 770 {
 771     struct sockaddr_un addr;
 772     struct stat st;
 773     int s, slen, retry, fd_cwd;
 774
 775     /* retrieve the current directory */
 776     fd_cwd = open( ".", O_RDONLY );
 777     if (fd_cwd != -1) fcntl( fd_cwd, F_SETFD, 1 ); /* set close on exec flag */
 778
 779     /* chdir to the server directory */
 780     if (chdir( serverdir ) == -1)
 781     {
 782         if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
 783         start_server();
 784         if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
 785     }
 786
 787     /* make sure we are at the right place */
 788     if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
 789     if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
 790     if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
 791
 792     for (retry = 0; retry < 6; retry++)
 793     {
 794         /* if not the first try, wait a bit to leave the previous server time to exit */
 795         if (retry)
 796         {
 797             usleep( 100000 * retry * retry );
 798             start_server();
 799             if (lstat( SOCKETNAME, &st ) == -1) continue;  /* still no socket, wait a bit more */
 800         }
 801         else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
 802         {
 803             if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
 804             start_server();
 805             if (lstat( SOCKETNAME, &st ) == -1) continue;  /* still no socket, wait a bit more */
 806         }
 807
 808         /* make sure the socket is sane (ISFIFO needed for Solaris) */
 809         if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
 810             fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
 811         if (st.st_uid != getuid())
 812             fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
 813
 814         /* try to connect to it */
 815         addr.sun_family = AF_UNIX;
 816         strcpy( addr.sun_path, SOCKETNAME );
 817         slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
 818 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
 819         addr.sun_len = slen;
 820 #endif
 821         if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
 822         if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
 823         {
 824             /* switch back to the starting directory */
 825             if (fd_cwd != -1)
 826             {
 827                 fchdir( fd_cwd );
 828                 close( fd_cwd );
 829             }
 830             fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
 831             return s;
 832         }
 833         close( s );
 834     }
 835     server_connect_error( serverdir );
 836 }
 837
 838
 839 /***********************************************************************
 840  *           rm_rf
 841  *
 842  * Remove a directory and all its contents; helper for create_config_dir.
 843  */
 844 static void rm_rf( const char *path )
 845 {
 846     int err = errno;  /* preserve errno */
 847     DIR *dir;
 848     char *buffer, *p;
 849     struct stat st;
 850     struct dirent *de;
 851
 852     if (!(buffer = malloc( strlen(path) + 256 + 1 ))) goto done;
 853     strcpy( buffer, path );
 854     p = buffer + strlen(buffer);
 855     *p++ = '/';
 856
 857     if ((dir = opendir( path )))
 858     {
 859         while ((de = readdir( dir )))
 860         {
 861             if (!strcmp( de->d_name, "." ) || !strcmp( de->d_name, ".." )) continue;
 862             strcpy( p, de->d_name );
 863             if (unlink( buffer ) != -1) continue;
 864             if (errno == EISDIR ||
 865                 (errno == EPERM && !lstat( buffer, &st ) && S_ISDIR(st.st_mode)))
 866             {
 867                 /* recurse in the sub-directory */
 868                 rm_rf( buffer );
 869             }
 870         }
 871         closedir( dir );
 872     }
 873     free( buffer );
 874     rmdir( path );
 875 done:
 876     errno = err;
 877 }
 878
 879
 880 /***********************************************************************
 881  *           create_config_dir
 882  *
 883  * Create the wine configuration dir (~/.wine).
 884  */
 885 static void create_config_dir(void)
 886 {
 887     const char *config_dir = wine_get_config_dir();
 888     char *tmp_dir;
 889     int fd;
 890     pid_t pid, wret;
 891
 892     if (!(tmp_dir = malloc( strlen(config_dir) + sizeof("-XXXXXX") )))
 893         fatal_error( "out of memory\n" );
 894     strcpy( tmp_dir, config_dir );
 895     strcat( tmp_dir, "-XXXXXX" );
 896     if ((fd = mkstemps( tmp_dir, 0 )) == -1)
 897         fatal_perror( "can't get temp file name for %s", config_dir );
 898     close( fd );
 899     unlink( tmp_dir );
 900     if (mkdir( tmp_dir, 0777 ) == -1)
 901         fatal_perror( "cannot create temp dir %s", tmp_dir );
 902
 903     MESSAGE( "wine: creating configuration directory '%s'...\n", config_dir );
 904     pid = fork();
 905     if (pid == -1)
 906     {
 907         rmdir( tmp_dir );
 908         fatal_perror( "fork" );
 909     }
 910     if (!pid)
 911     {
 912         char *argv[6];
 913         static char argv0[] = "tools/wineprefixcreate",
 914                     argv1[] = "--quiet",
 915                     argv2[] = "--wait",
 916                     argv3[] = "--prefix";
 917
 918         argv[0] = argv0;
 919         argv[1] = argv1;
 920         argv[2] = argv2;
 921         argv[3] = argv3;
 922         argv[4] = tmp_dir;
 923         argv[5] = NULL;
 924         wine_exec_wine_binary( argv[0], argv, NULL );
 925         rmdir( tmp_dir );
 926         fatal_perror( "could not exec wineprefixcreate" );
 927     }
 928     else
 929     {
 930         int status;
 931
 932         while ((wret = waitpid( pid, &status, 0 )) != pid)
 933         {
 934             if (wret == -1 && errno != EINTR) fatal_perror( "wait4" );
 935         }
 936         if (!WIFEXITED(status) || WEXITSTATUS(status))
 937         {
 938             rm_rf( tmp_dir );
 939             fatal_error( "wineprefixcreate failed while creating '%s'.\n", config_dir );
 940         }
 941     }
 942     if (rename( tmp_dir, config_dir ) == -1)
 943     {
 944         rm_rf( tmp_dir );
 945         if (errno != EEXIST && errno != ENOTEMPTY)
 946             fatal_perror( "rename '%s' to '%s'", tmp_dir, config_dir );
 947         /* else it was probably created by a concurrent wine process */
 948     }
 949     free( tmp_dir );
 950     MESSAGE( "wine: '%s' created successfully.\n", config_dir );
 951 }
 952
 953
 954 #ifdef __APPLE__
 955 #include <mach/mach.h>
 956 #include <mach/mach_error.h>
 957 #include <servers/bootstrap.h>
 958
 959 /* send our task port to the server */
 960 static void send_server_task_port(void)
 961 {
 962     mach_port_t bootstrap_port, wineserver_port;
 963     kern_return_t kret;
 964
 965     struct {
 966         mach_msg_header_t           header;
 967         mach_msg_body_t             body;
 968         mach_msg_port_descriptor_t  task_port;
 969     } msg;
 970
 971     if (task_get_bootstrap_port(mach_task_self(), &bootstrap_port) != KERN_SUCCESS) return;
 972
 973     kret = bootstrap_look_up(bootstrap_port, (char*)wine_get_server_dir(), &wineserver_port);
 974     if (kret != KERN_SUCCESS)
 975         fatal_error( "cannot find the server port: 0x%08x\n", kret );
 976
 977     mach_port_deallocate(mach_task_self(), bootstrap_port);
 978
 979     msg.header.msgh_bits        = MACH_MSGH_BITS(MACH_MSG_TYPE_COPY_SEND, 0) | MACH_MSGH_BITS_COMPLEX;
 980     msg.header.msgh_size        = sizeof(msg);
 981     msg.header.msgh_remote_port = wineserver_port;
 982     msg.header.msgh_local_port  = MACH_PORT_NULL;
 983
 984     msg.body.msgh_descriptor_count  = 1;
 985     msg.task_port.name              = mach_task_self();
 986     msg.task_port.disposition       = MACH_MSG_TYPE_COPY_SEND;
 987     msg.task_port.type              = MACH_MSG_PORT_DESCRIPTOR;
 988
 989     kret = mach_msg_send(&msg.header);
 990     if (kret != KERN_SUCCESS)
 991         server_protocol_error( "mach_msg_send failed: 0x%08x\n", kret );
 992
 993     mach_port_deallocate(mach_task_self(), wineserver_port);
 994 }
 995 #endif  /* __APPLE__ */
 996
 997 /***********************************************************************
 998  *           server_init_process
 999  *
1000  * Start the server and create the initial socket pair.
1001  */
1002 void server_init_process(void)
1003 {
1004     obj_handle_t dummy_handle;
1005     const char *env_socket = getenv( "WINESERVERSOCKET" );
1006
1007     if (env_socket)
1008     {
1009         fd_socket = atoi( env_socket );
1010         if (fcntl( fd_socket, F_SETFD, 1 ) == -1)
1011             fatal_perror( "Bad server socket %d", fd_socket );
1012         unsetenv( "WINESERVERSOCKET" );
1013     }
1014     else
1015     {
1016         const char *server_dir = wine_get_server_dir();
1017
1018         if (!server_dir)  /* this means the config dir doesn't exist */
1019         {
1020             create_config_dir();
1021             server_dir = wine_get_server_dir();
1022         }
1023
1024         /* connect to the server */
1025         fd_socket = server_connect( server_dir );
1026     }
1027
1028     /* setup the signal mask */
1029     sigemptyset( &server_block_set );
1030     sigaddset( &server_block_set, SIGALRM );
1031     sigaddset( &server_block_set, SIGIO );
1032     sigaddset( &server_block_set, SIGINT );
1033     sigaddset( &server_block_set, SIGHUP );
1034     sigaddset( &server_block_set, SIGUSR1 );
1035     sigaddset( &server_block_set, SIGUSR2 );
1036     sigaddset( &server_block_set, SIGCHLD );
1037     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, NULL );
1038
1039     /* receive the first thread request fd on the main socket */
1040     ntdll_get_thread_data()->request_fd = receive_fd( &dummy_handle );
1041
1042 #ifdef __APPLE__
1043     send_server_task_port();
1044 #endif
1045 }
1046
1047
1048 /***********************************************************************
1049  *           server_init_process_done
1050  */
1051 NTSTATUS server_init_process_done(void)
1052 {
1053     PEB *peb = NtCurrentTeb()->Peb;
1054     IMAGE_NT_HEADERS *nt = RtlImageNtHeader( peb->ImageBaseAddress );
1055     NTSTATUS status;
1056
1057     /* Install signal handlers; this cannot be done earlier, since we cannot
1058      * send exceptions to the debugger before the create process event that
1059      * is sent by REQ_INIT_PROCESS_DONE.
1060      * We do need the handlers in place by the time the request is over, so
1061      * we set them up here. If we segfault between here and the server call
1062      * something is very wrong... */
1063     if (!SIGNAL_Init()) exit(1);
1064
1065     /* Signal the parent process to continue */
1066     SERVER_START_REQ( init_process_done )
1067     {
1068         req->module = peb->ImageBaseAddress;
1069         req->entry  = (char *)peb->ImageBaseAddress + nt->OptionalHeader.AddressOfEntryPoint;
1070         req->gui    = (nt->OptionalHeader.Subsystem != IMAGE_SUBSYSTEM_WINDOWS_CUI);
1071         status = wine_server_call( req );
1072     }
1073     SERVER_END_REQ;
1074
1075     return status;
1076 }
1077
1078
1079 /***********************************************************************
1080  *           server_init_thread
1081  *
1082  * Send an init thread request. Return 0 if OK.
1083  */
1084 size_t server_init_thread( int unix_pid, int unix_tid, void *entry_point )
1085 {
1086     int version, ret;
1087     int reply_pipe[2];
1088     struct sigaction sig_act;
1089     size_t info_size;
1090
1091     sig_act.sa_handler = SIG_IGN;
1092     sig_act.sa_flags   = 0;
1093     sigemptyset( &sig_act.sa_mask );
1094
1095     /* ignore SIGPIPE so that we get an EPIPE error instead  */
1096     sigaction( SIGPIPE, &sig_act, NULL );
1097     /* automatic child reaping to avoid zombies */
1098 #ifdef SA_NOCLDWAIT
1099     sig_act.sa_flags |= SA_NOCLDWAIT;
1100 #endif
1101     sigaction( SIGCHLD, &sig_act, NULL );
1102
1103     /* create the server->client communication pipes */
1104     if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
1105     if (pipe( ntdll_get_thread_data()->wait_fd ) == -1) server_protocol_perror( "pipe" );
1106     wine_server_send_fd( reply_pipe[1] );
1107     wine_server_send_fd( ntdll_get_thread_data()->wait_fd[1] );
1108     ntdll_get_thread_data()->reply_fd = reply_pipe[0];
1109     close( reply_pipe[1] );
1110
1111     /* set close on exec flag */
1112     fcntl( ntdll_get_thread_data()->reply_fd, F_SETFD, 1 );
1113     fcntl( ntdll_get_thread_data()->wait_fd[0], F_SETFD, 1 );
1114     fcntl( ntdll_get_thread_data()->wait_fd[1], F_SETFD, 1 );
1115
1116     SERVER_START_REQ( init_thread )
1117     {
1118         req->unix_pid    = unix_pid;
1119         req->unix_tid    = unix_tid;
1120         req->teb         = NtCurrentTeb();
1121         req->peb         = NtCurrentTeb()->Peb;
1122         req->entry       = entry_point;
1123         req->ldt_copy    = &wine_ldt_copy;
1124         req->reply_fd    = reply_pipe[1];
1125         req->wait_fd     = ntdll_get_thread_data()->wait_fd[1];
1126         req->debug_level = (TRACE_ON(server) != 0);
1127         ret = wine_server_call( req );
1128         NtCurrentTeb()->ClientId.UniqueProcess = ULongToHandle(reply->pid);
1129         NtCurrentTeb()->ClientId.UniqueThread  = ULongToHandle(reply->tid);
1130         info_size         = reply->info_size;
1131         version           = reply->version;
1132         server_start_time = reply->server_start;
1133     }
1134     SERVER_END_REQ;
1135
1136     if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
1137     if (version != SERVER_PROTOCOL_VERSION)
1138         server_protocol_error( "version mismatch %d/%d.\n"
1139                                "Your %s binary was not upgraded correctly,\n"
1140                                "or you have an older one somewhere in your PATH.\n"
1141                                "Or maybe the wrong wineserver is still running?\n",
1142                                version, SERVER_PROTOCOL_VERSION,
1143                                (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );
1144     return info_size;
1145 }