Release 20010510.
[wine/multimedia.git] / scheduler / client.c
blob5253ea29d90f77f30da3b86ac42133bd001bf929
1 /*
2 * Client part of the client/server communication
4 * Copyright (C) 1998 Alexandre Julliard
5 */
7 #include "config.h"
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>
33 #include "wine/port.h"
34 #include "thread.h"
35 #include "server.h"
36 #include "winerror.h"
37 #include "options.h"
39 /* Some versions of glibc don't define this */
40 #ifndef SCM_RIGHTS
41 #define SCM_RIGHTS 1
42 #endif
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 */
48 /* data structure used to pass an fd with sendmsg/recvmsg */
49 struct cmsg_fd
51 int len; /* sizeof structure */
52 int level; /* SOL_SOCKET */
53 int type; /* SCM_RIGHTS */
54 int fd; /* fd to pass */
57 static void *boot_thread_id;
58 static sigset_t block_set; /* signals to block during server calls */
59 static int fd_socket; /* socket to exchange file descriptors with the server */
61 /* die on a fatal error; use only during initialization */
62 static void fatal_error( const char *err, ... ) WINE_NORETURN;
63 static void fatal_error( const char *err, ... )
65 va_list args;
67 va_start( args, err );
68 fprintf( stderr, "wine: " );
69 vfprintf( stderr, err, args );
70 va_end( args );
71 exit(1);
74 /* die on a fatal error; use only during initialization */
75 static void fatal_perror( const char *err, ... ) WINE_NORETURN;
76 static void fatal_perror( const char *err, ... )
78 va_list args;
80 va_start( args, err );
81 fprintf( stderr, "wine: " );
82 vfprintf( stderr, err, args );
83 perror( " " );
84 va_end( args );
85 exit(1);
88 /***********************************************************************
89 * server_protocol_error
91 void server_protocol_error( const char *err, ... )
93 va_list args;
95 va_start( args, err );
96 fprintf( stderr, "wine client error:%p: ", NtCurrentTeb()->tid );
97 vfprintf( stderr, err, args );
98 va_end( args );
99 SYSDEPS_ExitThread(1);
103 /***********************************************************************
104 * server_protocol_perror
106 void server_protocol_perror( const char *err )
108 fprintf( stderr, "wine client error:%p: ", NtCurrentTeb()->tid );
109 perror( err );
110 SYSDEPS_ExitThread(1);
114 /***********************************************************************
115 * __wine_server_exception_handler (NTDLL.@)
117 DWORD __wine_server_exception_handler( PEXCEPTION_RECORD record, EXCEPTION_FRAME *frame,
118 CONTEXT *context, EXCEPTION_FRAME **pdispatcher )
120 struct __server_exception_frame *server_frame = (struct __server_exception_frame *)frame;
121 if ((record->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND)))
122 NtCurrentTeb()->buffer_pos = server_frame->buffer_pos;
123 return ExceptionContinueSearch;
127 /***********************************************************************
128 * wine_server_alloc_req (NTDLL.@)
130 void wine_server_alloc_req( union generic_request *req, size_t size )
132 unsigned int pos = NtCurrentTeb()->buffer_pos;
134 assert( size <= REQUEST_MAX_VAR_SIZE );
136 if (pos + size > NtCurrentTeb()->buffer_size)
137 server_protocol_error( "buffer overflow %d bytes\n",
138 pos + size - NtCurrentTeb()->buffer_pos );
140 NtCurrentTeb()->buffer_pos = pos + size;
141 req->header.var_offset = pos;
142 req->header.var_size = size;
146 /***********************************************************************
147 * send_request
149 * Send a request to the server.
151 static void send_request( union generic_request *request )
153 int ret;
155 if ((ret = write( NtCurrentTeb()->request_fd, request, sizeof(*request) )) == sizeof(*request))
156 return;
157 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
158 if (errno == EPIPE) SYSDEPS_ExitThread(0);
159 server_protocol_perror( "sendmsg" );
162 /***********************************************************************
163 * wait_reply
165 * Wait for a reply from the server.
167 static void wait_reply( union generic_request *req )
169 int ret;
171 for (;;)
173 if ((ret = read( NtCurrentTeb()->reply_fd, req, sizeof(*req) )) == sizeof(*req))
174 return;
175 if (!ret) break;
176 if (ret > 0) server_protocol_error( "partial read %d\n", ret );
177 if (errno == EINTR) continue;
178 if (errno == EPIPE) break;
179 server_protocol_perror("read");
181 /* the server closed the connection; time to die... */
182 SYSDEPS_ExitThread(0);
186 /***********************************************************************
187 * wine_server_call (NTDLL.@)
189 * Perform a server call.
191 unsigned int wine_server_call( union generic_request *req, size_t size )
193 sigset_t old_set;
195 memset( (char *)req + size, 0, sizeof(*req) - size );
196 sigprocmask( SIG_BLOCK, &block_set, &old_set );
197 send_request( req );
198 wait_reply( req );
199 sigprocmask( SIG_SETMASK, &old_set, NULL );
200 return req->header.error;
204 /***********************************************************************
205 * wine_server_send_fd
207 * Send a file descriptor to the server.
209 void wine_server_send_fd( int fd )
211 #ifndef HAVE_MSGHDR_ACCRIGHTS
212 struct cmsg_fd cmsg;
213 #endif
214 struct send_fd data;
215 struct msghdr msghdr;
216 struct iovec vec;
217 int ret;
219 vec.iov_base = (void *)&data;
220 vec.iov_len = sizeof(data);
222 msghdr.msg_name = NULL;
223 msghdr.msg_namelen = 0;
224 msghdr.msg_iov = &vec;
225 msghdr.msg_iovlen = 1;
227 #ifdef HAVE_MSGHDR_ACCRIGHTS
228 msghdr.msg_accrights = (void *)&fd;
229 msghdr.msg_accrightslen = sizeof(fd);
230 #else /* HAVE_MSGHDR_ACCRIGHTS */
231 cmsg.len = sizeof(cmsg);
232 cmsg.level = SOL_SOCKET;
233 cmsg.type = SCM_RIGHTS;
234 cmsg.fd = fd;
235 msghdr.msg_control = &cmsg;
236 msghdr.msg_controllen = sizeof(cmsg);
237 msghdr.msg_flags = 0;
238 #endif /* HAVE_MSGHDR_ACCRIGHTS */
240 data.tid = (void *)GetCurrentThreadId();
241 data.fd = fd;
243 for (;;)
245 if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
246 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
247 if (errno == EINTR) continue;
248 if (errno == EPIPE) SYSDEPS_ExitThread(0);
249 server_protocol_perror( "sendmsg" );
254 /***********************************************************************
255 * receive_fd
257 * Receive a file descriptor passed from the server.
259 static int receive_fd( handle_t *handle )
261 struct iovec vec;
262 int ret, fd;
264 #ifdef HAVE_MSGHDR_ACCRIGHTS
265 struct msghdr msghdr;
267 fd = -1;
268 msghdr.msg_accrights = (void *)&fd;
269 msghdr.msg_accrightslen = sizeof(fd);
270 #else /* HAVE_MSGHDR_ACCRIGHTS */
271 struct msghdr msghdr;
272 struct cmsg_fd cmsg;
274 cmsg.len = sizeof(cmsg);
275 cmsg.level = SOL_SOCKET;
276 cmsg.type = SCM_RIGHTS;
277 cmsg.fd = -1;
278 msghdr.msg_control = &cmsg;
279 msghdr.msg_controllen = sizeof(cmsg);
280 msghdr.msg_flags = 0;
281 #endif /* HAVE_MSGHDR_ACCRIGHTS */
283 msghdr.msg_name = NULL;
284 msghdr.msg_namelen = 0;
285 msghdr.msg_iov = &vec;
286 msghdr.msg_iovlen = 1;
287 vec.iov_base = (void *)handle;
288 vec.iov_len = sizeof(*handle);
290 for (;;)
292 if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
294 #ifndef HAVE_MSGHDR_ACCRIGHTS
295 fd = cmsg.fd;
296 #endif
297 if (fd == -1) server_protocol_error( "no fd received for handle %d\n", *handle );
298 fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
299 return fd;
301 if (!ret) break;
302 if (errno == EINTR) continue;
303 if (errno == EPIPE) break;
304 server_protocol_perror("recvmsg");
306 /* the server closed the connection; time to die... */
307 SYSDEPS_ExitThread(0);
311 /***********************************************************************
312 * wine_server_recv_fd
314 * Receive a file descriptor passed from the server.
315 * The file descriptor must not be closed.
316 * Return -2 if a race condition stole our file descriptor.
318 int wine_server_recv_fd( handle_t handle )
320 handle_t fd_handle;
322 int fd = receive_fd( &fd_handle );
324 /* now store it in the server fd cache for this handle */
326 SERVER_START_REQ( set_handle_info )
328 req->handle = fd_handle;
329 req->flags = 0;
330 req->mask = 0;
331 req->fd = fd;
332 if (!SERVER_CALL())
334 if (req->cur_fd != fd)
336 /* someone was here before us */
337 close( fd );
338 fd = req->cur_fd;
341 else
343 close( fd );
344 fd = -1;
347 SERVER_END_REQ;
349 if (handle != fd_handle) fd = -2; /* not the one we expected */
350 return fd;
354 /***********************************************************************
355 * get_config_dir
357 * Return the configuration directory ($WINEPREFIX or $HOME/.wine)
359 const char *get_config_dir(void)
361 static char *confdir;
362 if (!confdir)
364 const char *prefix = getenv( "WINEPREFIX" );
365 if (prefix)
367 int len = strlen(prefix);
368 if (!(confdir = strdup( prefix ))) fatal_error( "out of memory\n" );
369 if (len > 1 && confdir[len-1] == '/') confdir[len-1] = 0;
371 else
373 const char *home = getenv( "HOME" );
374 if (!home)
376 struct passwd *pwd = getpwuid( getuid() );
377 if (!pwd) fatal_error( "could not find your home directory\n" );
378 home = pwd->pw_dir;
380 if (!(confdir = malloc( strlen(home) + strlen(CONFDIR) + 1 )))
381 fatal_error( "out of memory\n" );
382 strcpy( confdir, home );
383 strcat( confdir, CONFDIR );
385 mkdir( confdir, 0755 ); /* just in case */
387 return confdir;
391 /***********************************************************************
392 * start_server
394 * Start a new wine server.
396 static void start_server( const char *oldcwd )
398 static int started; /* we only try once */
399 char *path, *p;
400 if (!started)
402 int status;
403 int pid = fork();
404 if (pid == -1) fatal_perror( "fork" );
405 if (!pid)
407 /* if server is explicitly specified, use this */
408 if ((p = getenv("WINESERVER")))
410 if (p[0] != '/' && oldcwd[0] == '/') /* make it an absolute path */
412 if (!(path = malloc( strlen(oldcwd) + strlen(p) + 1 )))
413 fatal_error( "out of memory\n" );
414 sprintf( path, "%s/%s", oldcwd, p );
415 p = path;
417 execl( p, "wineserver", NULL );
418 fatal_perror( "could not exec the server '%s'\n"
419 " specified in the WINESERVER environment variable", p );
422 /* first try the installation dir */
423 execl( BINDIR "/wineserver", "wineserver", NULL );
425 /* now try the dir we were launched from */
426 if (full_argv0)
428 if (!(path = malloc( strlen(full_argv0) + 20 )))
429 fatal_error( "out of memory\n" );
430 if ((p = strrchr( strcpy( path, full_argv0 ), '/' )))
432 strcpy( p, "/wineserver" );
433 execl( path, "wineserver", NULL );
434 strcpy( p, "/server/wineserver" );
435 execl( path, "wineserver", NULL );
437 free(path);
440 /* now try the path */
441 execlp( "wineserver", "wineserver", NULL );
443 /* and finally the current dir */
444 if (!(path = malloc( strlen(oldcwd) + 20 )))
445 fatal_error( "out of memory\n" );
446 p = strcpy( path, oldcwd ) + strlen( oldcwd );
447 strcpy( p, "/wineserver" );
448 execl( path, "wineserver", NULL );
449 strcpy( p, "/server/wineserver" );
450 execl( path, "wineserver", NULL );
451 free(path);
452 fatal_error( "could not exec wineserver\n" );
454 started = 1;
455 waitpid( pid, &status, 0 );
456 status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
457 if (status) exit(status); /* server failed */
461 /***********************************************************************
462 * server_connect
464 * Attempt to connect to an existing server socket.
465 * We need to be in the server directory already.
467 static int server_connect( const char *oldcwd, const char *serverdir )
469 struct sockaddr_un addr;
470 struct stat st;
471 int s, slen, retry;
473 /* chdir to the server directory */
474 if (chdir( serverdir ) == -1)
476 if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
477 start_server( "." );
478 if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
481 /* make sure we are at the right place */
482 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
483 if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
484 if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
486 for (retry = 0; retry < 3; retry++)
488 /* if not the first try, wait a bit to leave the server time to exit */
489 if (retry) usleep( 100000 * retry * retry );
491 /* check for an existing socket */
492 if (lstat( SOCKETNAME, &st ) == -1)
494 if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
495 start_server( oldcwd );
496 if (lstat( SOCKETNAME, &st ) == -1) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
499 /* make sure the socket is sane (ISFIFO needed for Solaris) */
500 if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
501 fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
502 if (st.st_uid != getuid())
503 fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
505 /* try to connect to it */
506 addr.sun_family = AF_UNIX;
507 strcpy( addr.sun_path, SOCKETNAME );
508 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
509 #ifdef HAVE_SOCKADDR_SUN_LEN
510 addr.sun_len = slen;
511 #endif
512 if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
513 if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
515 fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
516 return s;
518 close( s );
520 fatal_error( "file '%s/%s' exists,\n"
521 " but I cannot connect to it; maybe the wineserver has crashed?\n"
522 " If this is the case, you should remove this socket file and try again.\n",
523 serverdir, SOCKETNAME );
527 /***********************************************************************
528 * CLIENT_InitServer
530 * Start the server and create the initial socket pair.
532 void CLIENT_InitServer(void)
534 int size;
535 char hostname[64];
536 char *oldcwd, *serverdir;
537 const char *configdir;
538 handle_t dummy_handle;
540 /* retrieve the current directory */
541 for (size = 512; ; size *= 2)
543 if (!(oldcwd = malloc( size ))) break;
544 if (getcwd( oldcwd, size )) break;
545 free( oldcwd );
546 if (errno == ERANGE) continue;
547 oldcwd = NULL;
548 break;
551 /* if argv[0] is a relative path, make it absolute */
552 full_argv0 = argv0;
553 if (oldcwd && argv0[0] != '/' && strchr( argv0, '/' ))
555 char *new_argv0 = malloc( strlen(oldcwd) + strlen(argv0) + 2 );
556 if (new_argv0)
558 strcpy( new_argv0, oldcwd );
559 strcat( new_argv0, "/" );
560 strcat( new_argv0, argv0 );
561 full_argv0 = new_argv0;
565 /* get the server directory name */
566 if (gethostname( hostname, sizeof(hostname) ) == -1) fatal_perror( "gethostname" );
567 configdir = get_config_dir();
568 serverdir = malloc( strlen(configdir) + strlen(SERVERDIR) + strlen(hostname) + 1 );
569 if (!serverdir) fatal_error( "out of memory\n" );
570 strcpy( serverdir, configdir );
571 strcat( serverdir, SERVERDIR );
572 strcat( serverdir, hostname );
574 /* connect to the server */
575 fd_socket = server_connect( oldcwd, serverdir );
577 /* switch back to the starting directory */
578 if (oldcwd)
580 chdir( oldcwd );
581 free( oldcwd );
584 /* setup the signal mask */
585 sigemptyset( &block_set );
586 sigaddset( &block_set, SIGALRM );
587 sigaddset( &block_set, SIGIO );
588 sigaddset( &block_set, SIGINT );
589 sigaddset( &block_set, SIGHUP );
591 /* receive the first thread request fd on the main socket */
592 NtCurrentTeb()->request_fd = receive_fd( &dummy_handle );
594 CLIENT_InitThread();
598 /***********************************************************************
599 * set_request_buffer
601 inline static void set_request_buffer(void)
603 char *name;
604 int fd, ret;
605 unsigned int offset, size;
607 /* create a temporary file */
610 if (!(name = tmpnam(NULL))) server_protocol_perror( "tmpnam" );
611 fd = open( name, O_CREAT | O_EXCL | O_RDWR, 0600 );
612 } while ((fd == -1) && (errno == EEXIST));
614 if (fd == -1) server_protocol_perror( "create" );
615 unlink( name );
617 wine_server_send_fd( fd );
619 SERVER_START_REQ( set_thread_buffer )
621 req->fd = fd;
622 ret = SERVER_CALL();
623 offset = req->offset;
624 size = req->size;
626 SERVER_END_REQ;
627 if (ret) server_protocol_error( "set_thread_buffer failed with status %x\n", ret );
629 if ((NtCurrentTeb()->buffer = mmap( 0, size, PROT_READ | PROT_WRITE,
630 MAP_SHARED, fd, offset )) == (void*)-1)
631 server_protocol_perror( "mmap" );
633 close( fd );
634 NtCurrentTeb()->buffer_pos = 0;
635 NtCurrentTeb()->buffer_size = size;
639 /***********************************************************************
640 * CLIENT_InitThread
642 * Send an init thread request. Return 0 if OK.
644 void CLIENT_InitThread(void)
646 TEB *teb = NtCurrentTeb();
647 int version, ret;
648 int reply_pipe[2];
650 /* ignore SIGPIPE so that we get a EPIPE error instead */
651 signal( SIGPIPE, SIG_IGN );
653 /* create the server->client communication pipes */
654 if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
655 if (pipe( teb->wait_fd ) == -1) server_protocol_perror( "pipe" );
656 wine_server_send_fd( reply_pipe[1] );
657 wine_server_send_fd( teb->wait_fd[1] );
658 teb->reply_fd = reply_pipe[0];
660 /* set close on exec flag */
661 fcntl( teb->reply_fd, F_SETFD, 1 );
662 fcntl( teb->wait_fd[0], F_SETFD, 1 );
663 fcntl( teb->wait_fd[1], F_SETFD, 1 );
665 SERVER_START_REQ( init_thread )
667 req->unix_pid = getpid();
668 req->teb = teb;
669 req->entry = teb->entry_point;
670 req->reply_fd = reply_pipe[1];
671 req->wait_fd = teb->wait_fd[1];
672 ret = SERVER_CALL();
673 teb->pid = req->pid;
674 teb->tid = req->tid;
675 version = req->version;
676 if (req->boot) boot_thread_id = teb->tid;
677 else if (boot_thread_id == teb->tid) boot_thread_id = 0;
678 close( reply_pipe[1] );
680 SERVER_END_REQ;
682 if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
683 if (version != SERVER_PROTOCOL_VERSION)
684 server_protocol_error( "version mismatch %d/%d.\n"
685 "Your %s binary was not upgraded correctly,\n"
686 "or you have an older one somewhere in your PATH.\n"
687 "Or maybe the wrong wineserver is still running?\n",
688 version, SERVER_PROTOCOL_VERSION,
689 (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );
690 set_request_buffer();
694 /***********************************************************************
695 * CLIENT_BootDone
697 * Signal that we have finished booting, and set debug level.
699 void CLIENT_BootDone( int debug_level )
701 SERVER_START_REQ( boot_done )
703 req->debug_level = debug_level;
704 SERVER_CALL();
706 SERVER_END_REQ;
710 /***********************************************************************
711 * CLIENT_IsBootThread
713 * Return TRUE if current thread is the boot thread.
715 int CLIENT_IsBootThread(void)
717 return (GetCurrentThreadId() == (DWORD)boot_thread_id);