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