scheduler/client.c

   1 /*
   2  * Client part of the client/server communication
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   5  */
   6
   7 #include "config.h"
   8
   9 #include <assert.h>
  10 #include <ctype.h>
  11 #include <errno.h>
  12 #include <fcntl.h>
  13 #include <pwd.h>
  14 #include <signal.h>
  15 #include <stdio.h>
  16 #include <string.h>
  17 #include <sys/types.h>
  18 #ifdef HAVE_SYS_SOCKET_H
  19 # include <sys/socket.h>
  20 #endif
  21 #ifdef HAVE_SYS_WAIT_H
  22 #include <sys/wait.h>
  23 #endif
  24 #include <sys/un.h>
  25 #ifdef HAVE_SYS_MMAN_H
  26 #include <sys/mman.h>
  27 #endif
  28 #include <sys/stat.h>
  29 #include <sys/uio.h>
  30 #include <unistd.h>
  31 #include <stdarg.h>
  32
  33 #include "wine/port.h"
  34 #include "thread.h"
  35 #include "server.h"
  36 #include "winerror.h"
  37 #include "options.h"
  38
  39 /* Some versions of glibc don't define this */
  40 #ifndef SCM_RIGHTS
  41 #define SCM_RIGHTS 1
  42 #endif
  43
  44 #define CONFDIR    "/.wine"        /* directory for Wine config relative to $HOME */
  45 #define SERVERDIR  "/wineserver-"  /* server socket directory (hostname appended) */
  46 #define SOCKETNAME "socket"        /* name of the socket file */
  47
  48 #undef server_alloc_req
  49
  50 /* data structure used to pass an fd with sendmsg/recvmsg */
  51 struct cmsg_fd
  52 {
  53     int len;   /* sizeof structure */
  54     int level; /* SOL_SOCKET */
  55     int type;  /* SCM_RIGHTS */
  56     int fd;    /* fd to pass */
  57 };
  58
  59 static void *boot_thread_id;
  60
  61
  62 /* die on a fatal error; use only during initialization */
  63 static void fatal_error( const char *err, ... ) WINE_NORETURN;
  64 static void fatal_error( const char *err, ... )
  65 {
  66     va_list args;
  67
  68     va_start( args, err );
  69     fprintf( stderr, "wine: " );
  70     vfprintf( stderr, err, args );
  71     va_end( args );
  72     exit(1);
  73 }
  74
  75 /* die on a fatal error; use only during initialization */
  76 static void fatal_perror( const char *err, ... ) WINE_NORETURN;
  77 static void fatal_perror( const char *err, ... )
  78 {
  79     va_list args;
  80
  81     va_start( args, err );
  82     fprintf( stderr, "wine: " );
  83     vfprintf( stderr, err, args );
  84     perror( " " );
  85     va_end( args );
  86     exit(1);
  87 }
  88
  89 /***********************************************************************
  90  *           server_protocol_error
  91  */
  92 void server_protocol_error( const char *err, ... )
  93 {
  94     va_list args;
  95
  96     va_start( args, err );
  97     fprintf( stderr, "Client protocol error:%p: ", NtCurrentTeb()->tid );
  98     vfprintf( stderr, err, args );
  99     va_end( args );
 100     SYSDEPS_ExitThread(1);
 101 }
 102
 103
 104 /***********************************************************************
 105  *           server_perror
 106  */
 107 static void server_perror( const char *err )
 108 {
 109     fprintf( stderr, "Client protocol error:%p: ", NtCurrentTeb()->tid );
 110     perror( err );
 111     SYSDEPS_ExitThread(1);
 112 }
 113
 114
 115 /***********************************************************************
 116  *           __wine_server_exception_handler
 117  */
 118 DWORD __wine_server_exception_handler( PEXCEPTION_RECORD record, EXCEPTION_FRAME *frame,
 119                                        CONTEXT *context, EXCEPTION_FRAME **pdispatcher )
 120 {
 121     struct __server_exception_frame *server_frame = (struct __server_exception_frame *)frame;
 122     if ((record->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND)))
 123         *NtCurrentTeb()->buffer_info = server_frame->info;
 124     return ExceptionContinueSearch;
 125 }
 126
 127
 128 /***********************************************************************
 129  *           wine_server_alloc_req
 130  */
 131 void *wine_server_alloc_req( size_t fixed_size, size_t var_size )
 132 {
 133     unsigned int pos = NtCurrentTeb()->buffer_info->cur_pos;
 134     union generic_request *req = (union generic_request *)((char *)NtCurrentTeb()->buffer + pos);
 135     size_t size = sizeof(*req) + var_size;
 136
 137     assert( fixed_size <= sizeof(*req) );
 138     assert( var_size <= REQUEST_MAX_VAR_SIZE );
 139
 140     if ((char *)req + size > (char *)NtCurrentTeb()->buffer_info)
 141         server_protocol_error( "buffer overflow %d bytes\n",
 142                                (char *)req + size - (char *)NtCurrentTeb()->buffer_info );
 143     NtCurrentTeb()->buffer_info->cur_pos = pos + size;
 144     req->header.fixed_size = fixed_size;
 145     req->header.var_size = var_size;
 146     return req;
 147 }
 148
 149
 150 /***********************************************************************
 151  *           send_request
 152  *
 153  * Send a request to the server.
 154  */
 155 static void send_request( enum request req, struct request_header *header )
 156 {
 157     header->req = req;
 158     NtCurrentTeb()->buffer_info->cur_req = (char *)header - (char *)NtCurrentTeb()->buffer;
 159     /* write a single byte; the value is ignored anyway */
 160     if (write( NtCurrentTeb()->request_fd, header, 1 ) == -1)
 161     {
 162         if (errno == EPIPE) SYSDEPS_ExitThread(0);
 163         server_perror( "sendmsg" );
 164     }
 165 }
 166
 167 /***********************************************************************
 168  *           send_request_fd
 169  *
 170  * Send a request to the server, passing a file descriptor.
 171  */
 172 static void send_request_fd( enum request req, struct request_header *header, int fd )
 173 {
 174 #ifndef HAVE_MSGHDR_ACCRIGHTS
 175     struct cmsg_fd cmsg;
 176 #endif
 177     struct msghdr msghdr;
 178     struct iovec vec;
 179
 180     /* write a single byte; the value is ignored anyway */
 181     vec.iov_base = (void *)header;
 182     vec.iov_len  = 1;
 183
 184     msghdr.msg_name    = NULL;
 185     msghdr.msg_namelen = 0;
 186     msghdr.msg_iov     = &vec;
 187     msghdr.msg_iovlen  = 1;
 188
 189 #ifdef HAVE_MSGHDR_ACCRIGHTS
 190     msghdr.msg_accrights    = (void *)&fd;
 191     msghdr.msg_accrightslen = sizeof(fd);
 192 #else  /* HAVE_MSGHDR_ACCRIGHTS */
 193     cmsg.len   = sizeof(cmsg);
 194     cmsg.level = SOL_SOCKET;
 195     cmsg.type  = SCM_RIGHTS;
 196     cmsg.fd    = fd;
 197     msghdr.msg_control    = &cmsg;
 198     msghdr.msg_controllen = sizeof(cmsg);
 199     msghdr.msg_flags      = 0;
 200 #endif  /* HAVE_MSGHDR_ACCRIGHTS */
 201
 202     header->req = req;
 203
 204     if (sendmsg( NtCurrentTeb()->socket, &msghdr, 0 ) == -1)
 205     {
 206         if (errno == EPIPE) SYSDEPS_ExitThread(0);
 207         server_perror( "sendmsg" );
 208     }
 209 }
 210
 211 /***********************************************************************
 212  *           wait_reply
 213  *
 214  * Wait for a reply from the server.
 215  */
 216 static void wait_reply(void)
 217 {
 218     int ret;
 219     char dummy[1];
 220
 221     for (;;)
 222     {
 223         if ((ret = read( NtCurrentTeb()->reply_fd, dummy, 1 )) > 0) return;
 224         if (!ret) break;
 225         if (errno == EINTR) continue;
 226         if (errno == EPIPE) break;
 227         server_perror("read");
 228     }
 229     /* the server closed the connection; time to die... */
 230     SYSDEPS_ExitThread(0);
 231 }
 232
 233
 234 /***********************************************************************
 235  *           wine_server_call
 236  *
 237  * Perform a server call.
 238  */
 239 unsigned int wine_server_call( enum request req )
 240 {
 241     void *req_ptr = get_req_buffer();
 242     send_request( req, req_ptr );
 243     wait_reply();
 244     return ((struct request_header *)req_ptr)->error;
 245 }
 246
 247
 248 /***********************************************************************
 249  *           server_call_fd
 250  *
 251  * Perform a server call, passing a file descriptor.
 252  */
 253 unsigned int server_call_fd( enum request req, int fd_out )
 254 {
 255     unsigned int res;
 256     void *req_ptr = get_req_buffer();
 257
 258     send_request_fd( req, req_ptr, fd_out );
 259     wait_reply();
 260
 261     if ((res = ((struct request_header *)req_ptr)->error))
 262         SetLastError( RtlNtStatusToDosError(res) );
 263     return res;  /* error code */
 264 }
 265
 266
 267 /***********************************************************************
 268  *           set_handle_fd
 269  *
 270  * Store the fd for a given handle in the server
 271  */
 272 static int set_handle_fd( int handle, int fd )
 273 {
 274     SERVER_START_REQ
 275     {
 276         struct set_handle_info_request *req = wine_server_alloc_req( sizeof(*req), 0 );
 277         req->handle = handle;
 278         req->flags  = 0;
 279         req->mask   = 0;
 280         req->fd     = fd;
 281         if (!server_call( REQ_SET_HANDLE_INFO ))
 282         {
 283             if (req->cur_fd != fd)
 284             {
 285                 /* someone was here before us */
 286                 close( fd );
 287                 fd = req->cur_fd;
 288             }
 289             else fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
 290         }
 291         else
 292         {
 293             close( fd );
 294             fd = -1;
 295         }
 296     }
 297     SERVER_END_REQ;
 298     return fd;
 299 }
 300
 301
 302 /***********************************************************************
 303  *           wine_server_recv_fd
 304  *
 305  * Receive a file descriptor passed from the server.
 306  * The file descriptor must be closed after use.
 307  */
 308 int wine_server_recv_fd( int handle, int cache )
 309 {
 310     struct iovec vec;
 311     int ret, fd, server_handle;
 312
 313 #ifdef HAVE_MSGHDR_ACCRIGHTS
 314     struct msghdr msghdr;
 315
 316     fd = -1;
 317     msghdr.msg_accrights    = (void *)&fd;
 318     msghdr.msg_accrightslen = sizeof(fd);
 319 #else  /* HAVE_MSGHDR_ACCRIGHTS */
 320     struct msghdr msghdr;
 321     struct cmsg_fd cmsg;
 322
 323     cmsg.len   = sizeof(cmsg);
 324     cmsg.level = SOL_SOCKET;
 325     cmsg.type  = SCM_RIGHTS;
 326     cmsg.fd    = -1;
 327     msghdr.msg_control    = &cmsg;
 328     msghdr.msg_controllen = sizeof(cmsg);
 329     msghdr.msg_flags      = 0;
 330 #endif  /* HAVE_MSGHDR_ACCRIGHTS */
 331
 332     msghdr.msg_name    = NULL;
 333     msghdr.msg_namelen = 0;
 334     msghdr.msg_iov     = &vec;
 335     msghdr.msg_iovlen  = 1;
 336     vec.iov_base = (void *)&server_handle;
 337     vec.iov_len  = sizeof(server_handle);
 338
 339     for (;;)
 340     {
 341         if ((ret = recvmsg( NtCurrentTeb()->socket, &msghdr, 0 )) > 0)
 342         {
 343 #ifndef HAVE_MSGHDR_ACCRIGHTS
 344             fd = cmsg.fd;
 345 #endif
 346             if (handle != server_handle)
 347                 server_protocol_error( "recv_fd: got handle %d, expected %d\n",
 348                                        server_handle, handle );
 349             if (cache)
 350             {
 351                 fd = set_handle_fd( handle, fd );
 352                 if (fd != -1) fd = dup(fd);
 353             }
 354             return fd;
 355         }
 356         if (!ret) break;
 357         if (errno == EINTR) continue;
 358         if (errno == EPIPE) break;
 359         server_perror("recvmsg");
 360     }
 361     /* the server closed the connection; time to die... */
 362     SYSDEPS_ExitThread(0);
 363 }
 364
 365
 366 /***********************************************************************
 367  *           get_config_dir
 368  *
 369  * Return the configuration directory ($WINEPREFIX or $HOME/.wine)
 370  */
 371 const char *get_config_dir(void)
 372 {
 373     static char *confdir;
 374     if (!confdir)
 375     {
 376         const char *prefix = getenv( "WINEPREFIX" );
 377         if (prefix)
 378         {
 379             int len = strlen(prefix);
 380             if (!(confdir = strdup( prefix ))) fatal_error( "out of memory\n" );
 381             if (len > 1 && confdir[len-1] == '/') confdir[len-1] = 0;
 382         }
 383         else
 384         {
 385             const char *home = getenv( "HOME" );
 386             if (!home)
 387             {
 388                 struct passwd *pwd = getpwuid( getuid() );
 389                 if (!pwd) fatal_error( "could not find your home directory\n" );
 390                 home = pwd->pw_dir;
 391             }
 392             if (!(confdir = malloc( strlen(home) + strlen(CONFDIR) + 1 )))
 393                 fatal_error( "out of memory\n" );
 394             strcpy( confdir, home );
 395             strcat( confdir, CONFDIR );
 396         }
 397         mkdir( confdir, 0755 );  /* just in case */
 398     }
 399     return confdir;
 400 }
 401
 402
 403 /***********************************************************************
 404  *           start_server
 405  *
 406  * Start a new wine server.
 407  */
 408 static void start_server( const char *oldcwd )
 409 {
 410     static int started;  /* we only try once */
 411     char *path, *p;
 412     if (!started)
 413     {
 414         int status;
 415         int pid = fork();
 416         if (pid == -1) fatal_perror( "fork" );
 417         if (!pid)
 418         {
 419             /* if server is explicitly specified, use this */
 420             if ((p = getenv("WINESERVER")))
 421             {
 422                 execl( p, "wineserver", NULL );
 423                 fatal_perror( "could not exec the server '%s'\n"
 424                               "    specified in the WINESERVER environment variable", p );
 425             }
 426
 427             /* first try the installation dir */
 428             execl( BINDIR "/wineserver", "wineserver", NULL );
 429
 430             /* now try the dir we were launched from */
 431             if (full_argv0)
 432             {
 433                 if (!(path = malloc( strlen(full_argv0) + 20 )))
 434                     fatal_error( "out of memory\n" );
 435                 if ((p = strrchr( strcpy( path, full_argv0 ), '/' )))
 436                 {
 437                     strcpy( p, "/wineserver" );
 438                     execl( path, "wineserver", NULL );
 439                     strcpy( p, "/server/wineserver" );
 440                     execl( path, "wineserver", NULL );
 441                 }
 442                 free(path);
 443             }
 444
 445             /* now try the path */
 446             execlp( "wineserver", "wineserver", NULL );
 447
 448             /* and finally the current dir */
 449             if (!(path = malloc( strlen(oldcwd) + 20 )))
 450                 fatal_error( "out of memory\n" );
 451             p = strcpy( path, oldcwd ) + strlen( oldcwd );
 452             strcpy( p, "/wineserver" );
 453             execl( path, "wineserver", NULL );
 454             strcpy( p, "/server/wineserver" );
 455             execl( path, "wineserver", NULL );
 456             free(path);
 457             fatal_error( "could not exec wineserver\n" );
 458         }
 459         started = 1;
 460         waitpid( pid, &status, 0 );
 461         status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
 462         if (status) exit(status);  /* server failed */
 463     }
 464 }
 465
 466 /***********************************************************************
 467  *           server_connect
 468  *
 469  * Attempt to connect to an existing server socket.
 470  * We need to be in the server directory already.
 471  */
 472 static int server_connect( const char *oldcwd, const char *serverdir )
 473 {
 474     struct sockaddr_un addr;
 475     struct stat st;
 476     int s, slen, retry;
 477
 478     /* chdir to the server directory */
 479     if (chdir( serverdir ) == -1)
 480     {
 481         if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
 482         start_server( "." );
 483         if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
 484     }
 485
 486     /* make sure we are at the right place */
 487     if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
 488     if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
 489     if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
 490
 491     for (retry = 0; retry < 3; retry++)
 492     {
 493         /* if not the first try, wait a bit to leave the server time to exit */
 494         if (retry) usleep( 100000 * retry * retry );
 495
 496         /* check for an existing socket */
 497         if (lstat( SOCKETNAME, &st ) == -1)
 498         {
 499             if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
 500             start_server( oldcwd );
 501             if (lstat( SOCKETNAME, &st ) == -1) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
 502         }
 503
 504         /* make sure the socket is sane (ISFIFO needed for Solaris) */
 505         if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
 506             fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
 507         if (st.st_uid != getuid())
 508             fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
 509
 510         /* try to connect to it */
 511         addr.sun_family = AF_UNIX;
 512         strcpy( addr.sun_path, SOCKETNAME );
 513         slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
 514 #ifdef HAVE_SOCKADDR_SUN_LEN
 515         addr.sun_len = slen;
 516 #endif
 517         if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
 518         if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
 519         {
 520             fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
 521             return s;
 522         }
 523         close( s );
 524     }
 525     fatal_error( "file '%s/%s' exists,\n"
 526                  "   but I cannot connect to it; maybe the server has crashed?\n"
 527                  "   If this is the case, you should remove this socket file and try again.\n",
 528                  serverdir, SOCKETNAME );
 529 }
 530
 531
 532 /***********************************************************************
 533  *           CLIENT_InitServer
 534  *
 535  * Start the server and create the initial socket pair.
 536  */
 537 int CLIENT_InitServer(void)
 538 {
 539     int fd, size;
 540     char hostname[64];
 541     char *oldcwd, *serverdir;
 542     const char *configdir;
 543
 544     /* retrieve the current directory */
 545     for (size = 512; ; size *= 2)
 546     {
 547         if (!(oldcwd = malloc( size ))) break;
 548         if (getcwd( oldcwd, size )) break;
 549         free( oldcwd );
 550         if (errno == ERANGE) continue;
 551         oldcwd = NULL;
 552         break;
 553     }
 554
 555     /* if argv[0] is a relative path, make it absolute */
 556     full_argv0 = argv0;
 557     if (oldcwd && argv0[0] != '/' && strchr( argv0, '/' ))
 558     {
 559         char *new_argv0 = malloc( strlen(oldcwd) + strlen(argv0) + 2 );
 560         if (new_argv0)
 561         {
 562             strcpy( new_argv0, oldcwd );
 563             strcat( new_argv0, "/" );
 564             strcat( new_argv0, argv0 );
 565             full_argv0 = new_argv0;
 566         }
 567     }
 568
 569     /* get the server directory name */
 570     if (gethostname( hostname, sizeof(hostname) ) == -1) fatal_perror( "gethostname" );
 571     configdir = get_config_dir();
 572     serverdir = malloc( strlen(configdir) + strlen(SERVERDIR) + strlen(hostname) + 1 );
 573     if (!serverdir) fatal_error( "out of memory\n" );
 574     strcpy( serverdir, configdir );
 575     strcat( serverdir, SERVERDIR );
 576     strcat( serverdir, hostname );
 577
 578     /* connect to the server */
 579     fd = server_connect( oldcwd, serverdir );
 580
 581     /* switch back to the starting directory */
 582     if (oldcwd)
 583     {
 584         chdir( oldcwd );
 585         free( oldcwd );
 586     }
 587     return fd;
 588 }
 589
 590
 591 /***********************************************************************
 592  *           CLIENT_InitThread
 593  *
 594  * Send an init thread request. Return 0 if OK.
 595  */
 596 int CLIENT_InitThread(void)
 597 {
 598     struct get_thread_buffer_request *req;
 599     TEB *teb = NtCurrentTeb();
 600     int fd, ret, size;
 601
 602     /* ignore SIGPIPE so that we get a EPIPE error instead  */
 603     signal( SIGPIPE, SIG_IGN );
 604
 605     teb->request_fd = wine_server_recv_fd( -1, 0 );
 606     if (teb->request_fd == -1) server_protocol_error( "no request fd passed on first request\n" );
 607     fcntl( teb->request_fd, F_SETFD, 1 ); /* set close on exec flag */
 608
 609     teb->reply_fd = wine_server_recv_fd( -1, 0 );
 610     if (teb->reply_fd == -1) server_protocol_error( "no reply fd passed on first request\n" );
 611     fcntl( teb->reply_fd, F_SETFD, 1 ); /* set close on exec flag */
 612
 613     fd = wine_server_recv_fd( -1, 0 );
 614     if (fd == -1) server_protocol_error( "no fd received for thread buffer\n" );
 615
 616     if ((size = lseek( fd, 0, SEEK_END )) == -1) server_perror( "lseek" );
 617     teb->buffer = mmap( 0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0 );
 618     close( fd );
 619     if (teb->buffer == (void*)-1) server_perror( "mmap" );
 620     teb->buffer_info = (struct server_buffer_info *)((char *)teb->buffer + size) - 1;
 621
 622     wait_reply();
 623
 624     req = (struct get_thread_buffer_request *)teb->buffer;
 625     teb->pid = req->pid;
 626     teb->tid = req->tid;
 627     if (req->version != SERVER_PROTOCOL_VERSION)
 628         server_protocol_error( "version mismatch %d/%d.\n"
 629                                "Your %s binary was not upgraded correctly,\n"
 630                                "or you have an older one somewhere in your PATH.\n",
 631                                req->version, SERVER_PROTOCOL_VERSION,
 632                                (req->version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );
 633     if (req->boot) boot_thread_id = teb->tid;
 634     else if (boot_thread_id == teb->tid) boot_thread_id = 0;
 635
 636     SERVER_START_REQ
 637     {
 638         struct init_thread_request *req = wine_server_alloc_req( sizeof(*req), 0 );
 639         req->unix_pid = getpid();
 640         req->teb      = teb;
 641         req->entry    = teb->entry_point;
 642         ret = wine_server_call( REQ_INIT_THREAD );
 643     }
 644     SERVER_END_REQ;
 645     return ret;
 646 }
 647
 648
 649 /***********************************************************************
 650  *           CLIENT_BootDone
 651  *
 652  * Signal that we have finished booting, and set debug level.
 653  */
 654 int CLIENT_BootDone( int debug_level )
 655 {
 656     int ret;
 657     SERVER_START_REQ
 658     {
 659         struct boot_done_request *req = wine_server_alloc_req( sizeof(*req), 0 );
 660         req->debug_level = debug_level;
 661         ret = server_call( REQ_BOOT_DONE );
 662     }
 663     SERVER_END_REQ;
 664     return ret;
 665 }
 666
 667
 668 /***********************************************************************
 669  *           CLIENT_IsBootThread
 670  *
 671  * Return TRUE if current thread is the boot thread.
 672  */
 673 int CLIENT_IsBootThread(void)
 674 {
 675     return (GetCurrentThreadId() == (DWORD)boot_thread_id);
 676 }