WM_PAINT(wParam) might be a valid HDC.
[wine/multimedia.git] / scheduler / client.c
blob548de13dea6ded80bf86475db1cddb416ea4f79d
1 /*
2 * Client part of the client/server communication
4 * Copyright (C) 1998 Alexandre Julliard
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include "config.h"
22 #include "wine/port.h"
24 #include <assert.h>
25 #include <ctype.h>
26 #include <errno.h>
27 #include <fcntl.h>
28 #include <signal.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <sys/types.h>
32 #ifdef HAVE_SYS_SOCKET_H
33 # include <sys/socket.h>
34 #endif
35 #ifdef HAVE_SYS_WAIT_H
36 #include <sys/wait.h>
37 #endif
38 #ifdef HAVE_SYS_UN_H
39 #include <sys/un.h>
40 #endif
41 #ifdef HAVE_SYS_MMAN_H
42 #include <sys/mman.h>
43 #endif
44 #include <sys/stat.h>
45 #ifdef HAVE_SYS_UIO_H
46 #include <sys/uio.h>
47 #endif
48 #ifdef HAVE_UNISTD_H
49 # include <unistd.h>
50 #endif
51 #include <stdarg.h>
53 #include "thread.h"
54 #include "wine/library.h"
55 #include "wine/server.h"
56 #include "winerror.h"
57 #include "options.h"
59 /* Some versions of glibc don't define this */
60 #ifndef SCM_RIGHTS
61 #define SCM_RIGHTS 1
62 #endif
64 #define SOCKETNAME "socket" /* name of the socket file */
65 #define LOCKNAME "lock" /* name of the lock file */
67 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
68 /* data structure used to pass an fd with sendmsg/recvmsg */
69 struct cmsg_fd
71 int len; /* size of structure */
72 int level; /* SOL_SOCKET */
73 int type; /* SCM_RIGHTS */
74 int fd; /* fd to pass */
76 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
78 static DWORD boot_thread_id;
79 static sigset_t block_set; /* signals to block during server calls */
80 static int fd_socket; /* socket to exchange file descriptors with the server */
82 #ifdef __GNUC__
83 static void fatal_error( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
84 static void fatal_perror( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
85 static void server_connect_error( const char *serverdir ) __attribute__((noreturn));
86 #endif
88 /* die on a fatal error; use only during initialization */
89 static void fatal_error( const char *err, ... )
91 va_list args;
93 va_start( args, err );
94 fprintf( stderr, "wine: " );
95 vfprintf( stderr, err, args );
96 va_end( args );
97 exit(1);
100 /* die on a fatal error; use only during initialization */
101 static void fatal_perror( const char *err, ... )
103 va_list args;
105 va_start( args, err );
106 fprintf( stderr, "wine: " );
107 vfprintf( stderr, err, args );
108 perror( " " );
109 va_end( args );
110 exit(1);
113 /***********************************************************************
114 * server_protocol_error
116 void server_protocol_error( const char *err, ... )
118 va_list args;
120 va_start( args, err );
121 fprintf( stderr, "wine client error:%lx: ", NtCurrentTeb()->tid );
122 vfprintf( stderr, err, args );
123 va_end( args );
124 SYSDEPS_AbortThread(1);
128 /***********************************************************************
129 * server_protocol_perror
131 void server_protocol_perror( const char *err )
133 fprintf( stderr, "wine client error:%lx: ", NtCurrentTeb()->tid );
134 perror( err );
135 SYSDEPS_AbortThread(1);
139 /***********************************************************************
140 * send_request
142 * Send a request to the server.
144 static void send_request( const struct __server_request_info *req )
146 int i, ret;
148 if (!req->u.req.request_header.request_size)
150 if ((ret = write( NtCurrentTeb()->request_fd, &req->u.req,
151 sizeof(req->u.req) )) == sizeof(req->u.req)) return;
154 else
156 struct iovec vec[__SERVER_MAX_DATA+1];
158 vec[0].iov_base = (void *)&req->u.req;
159 vec[0].iov_len = sizeof(req->u.req);
160 for (i = 0; i < req->data_count; i++)
162 vec[i+1].iov_base = (void *)req->data[i].ptr;
163 vec[i+1].iov_len = req->data[i].size;
165 if ((ret = writev( NtCurrentTeb()->request_fd, vec, i+1 )) ==
166 req->u.req.request_header.request_size + sizeof(req->u.req)) return;
169 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
170 if (errno == EPIPE) SYSDEPS_AbortThread(0);
171 server_protocol_perror( "sendmsg" );
175 /***********************************************************************
176 * read_reply_data
178 * Read data from the reply buffer; helper for wait_reply.
180 static void read_reply_data( void *buffer, size_t size )
182 int ret;
184 for (;;)
186 if ((ret = read( NtCurrentTeb()->reply_fd, buffer, size )) > 0)
188 if (!(size -= ret)) return;
189 buffer = (char *)buffer + ret;
190 continue;
192 if (!ret) break;
193 if (errno == EINTR) continue;
194 if (errno == EPIPE) break;
195 server_protocol_perror("read");
197 /* the server closed the connection; time to die... */
198 SYSDEPS_AbortThread(0);
202 /***********************************************************************
203 * wait_reply
205 * Wait for a reply from the server.
207 inline static void wait_reply( struct __server_request_info *req )
209 read_reply_data( &req->u.reply, sizeof(req->u.reply) );
210 if (req->u.reply.reply_header.reply_size)
211 read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
215 /***********************************************************************
216 * wine_server_call (NTDLL.@)
218 * Perform a server call.
220 unsigned int wine_server_call( void *req_ptr )
222 struct __server_request_info * const req = req_ptr;
223 sigset_t old_set;
225 sigprocmask( SIG_BLOCK, &block_set, &old_set );
226 send_request( req );
227 wait_reply( req );
228 sigprocmask( SIG_SETMASK, &old_set, NULL );
229 return req->u.reply.reply_header.error;
233 /***********************************************************************
234 * wine_server_send_fd
236 * Send a file descriptor to the server.
238 void wine_server_send_fd( int fd )
240 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
241 struct cmsg_fd cmsg;
242 #endif
243 struct send_fd data;
244 struct msghdr msghdr;
245 struct iovec vec;
246 int ret;
248 vec.iov_base = (void *)&data;
249 vec.iov_len = sizeof(data);
251 msghdr.msg_name = NULL;
252 msghdr.msg_namelen = 0;
253 msghdr.msg_iov = &vec;
254 msghdr.msg_iovlen = 1;
256 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
257 msghdr.msg_accrights = (void *)&fd;
258 msghdr.msg_accrightslen = sizeof(fd);
259 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
260 cmsg.len = sizeof(cmsg);
261 cmsg.level = SOL_SOCKET;
262 cmsg.type = SCM_RIGHTS;
263 cmsg.fd = fd;
264 msghdr.msg_control = &cmsg;
265 msghdr.msg_controllen = sizeof(cmsg);
266 msghdr.msg_flags = 0;
267 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
269 data.tid = GetCurrentThreadId();
270 data.fd = fd;
272 for (;;)
274 if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
275 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
276 if (errno == EINTR) continue;
277 if (errno == EPIPE) SYSDEPS_AbortThread(0);
278 server_protocol_perror( "sendmsg" );
283 /***********************************************************************
284 * receive_fd
286 * Receive a file descriptor passed from the server.
288 static int receive_fd( obj_handle_t *handle )
290 struct iovec vec;
291 int ret, fd;
293 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
294 struct msghdr msghdr;
296 fd = -1;
297 msghdr.msg_accrights = (void *)&fd;
298 msghdr.msg_accrightslen = sizeof(fd);
299 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
300 struct msghdr msghdr;
301 struct cmsg_fd cmsg;
303 cmsg.len = sizeof(cmsg);
304 cmsg.level = SOL_SOCKET;
305 cmsg.type = SCM_RIGHTS;
306 cmsg.fd = -1;
307 msghdr.msg_control = &cmsg;
308 msghdr.msg_controllen = sizeof(cmsg);
309 msghdr.msg_flags = 0;
310 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
312 msghdr.msg_name = NULL;
313 msghdr.msg_namelen = 0;
314 msghdr.msg_iov = &vec;
315 msghdr.msg_iovlen = 1;
316 vec.iov_base = (void *)handle;
317 vec.iov_len = sizeof(*handle);
319 for (;;)
321 if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
323 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
324 fd = cmsg.fd;
325 #endif
326 if (fd == -1) server_protocol_error( "no fd received for handle %d\n", *handle );
327 fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
328 return fd;
330 if (!ret) break;
331 if (errno == EINTR) continue;
332 if (errno == EPIPE) break;
333 server_protocol_perror("recvmsg");
335 /* the server closed the connection; time to die... */
336 SYSDEPS_AbortThread(0);
340 /***********************************************************************
341 * store_cached_fd
343 * Store the cached fd value for a given handle back into the server.
344 * Returns the new fd, which can be different if there was already an
345 * fd in the cache for that handle.
347 inline static int store_cached_fd( int fd, obj_handle_t handle )
349 SERVER_START_REQ( set_handle_info )
351 req->handle = handle;
352 req->flags = 0;
353 req->mask = 0;
354 req->fd = fd;
355 if (!wine_server_call( req ))
357 if (reply->cur_fd != fd)
359 /* someone was here before us */
360 close( fd );
361 fd = reply->cur_fd;
364 else
366 close( fd );
367 fd = -1;
370 SERVER_END_REQ;
371 return fd;
375 /***********************************************************************
376 * wine_server_fd_to_handle (NTDLL.@)
378 * Allocate a file handle for a Unix fd.
380 int wine_server_fd_to_handle( int fd, unsigned int access, int inherit, obj_handle_t *handle )
382 int ret;
384 *handle = 0;
385 wine_server_send_fd( fd );
387 SERVER_START_REQ( alloc_file_handle )
389 req->access = access;
390 req->inherit = inherit;
391 req->fd = fd;
392 if (!(ret = wine_server_call( req ))) *handle = reply->handle;
394 SERVER_END_REQ;
395 return ret;
399 /***********************************************************************
400 * wine_server_handle_to_fd (NTDLL.@)
402 * Retrieve the Unix fd corresponding to a file handle.
404 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd,
405 enum fd_type *type, int *flags )
407 obj_handle_t fd_handle;
408 int ret, fd = -1;
410 *unix_fd = -1;
411 for (;;)
413 SERVER_START_REQ( get_handle_fd )
415 req->handle = handle;
416 req->access = access;
417 if (!(ret = wine_server_call( req ))) fd = reply->fd;
418 if (type) *type = reply->type;
419 if (flags) *flags = reply->flags;
421 SERVER_END_REQ;
422 if (ret) return ret;
424 if (fd != -1) break;
426 /* it wasn't in the cache, get it from the server */
427 fd = receive_fd( &fd_handle );
428 /* and store it back into the cache */
429 fd = store_cached_fd( fd, fd_handle );
431 if (fd_handle == handle) break;
432 /* if we received a different handle this means there was
433 * a race with another thread; we restart everything from
434 * scratch in this case.
438 if ((fd != -1) && ((fd = dup(fd)) == -1)) return STATUS_TOO_MANY_OPENED_FILES;
439 *unix_fd = fd;
440 return STATUS_SUCCESS;
444 /***********************************************************************
445 * start_server
447 * Start a new wine server.
449 static void start_server( const char *oldcwd )
451 static int started; /* we only try once */
452 char *path, *p;
453 if (!started)
455 int status;
456 int pid = fork();
457 if (pid == -1) fatal_perror( "fork" );
458 if (!pid)
460 /* if server is explicitly specified, use this */
461 if ((p = getenv("WINESERVER")))
463 if (p[0] != '/' && oldcwd[0] == '/') /* make it an absolute path */
465 if (!(path = malloc( strlen(oldcwd) + strlen(p) + 1 )))
466 fatal_error( "out of memory\n" );
467 sprintf( path, "%s/%s", oldcwd, p );
468 p = path;
470 execl( p, p, NULL );
471 fatal_perror( "could not exec the server '%s'\n"
472 " specified in the WINESERVER environment variable", p );
475 /* first try the installation dir */
476 execl( BINDIR "/wineserver", "wineserver", NULL );
478 /* now try the dir we were launched from */
479 if (full_argv0)
481 if (!(path = malloc( strlen(full_argv0) + 20 )))
482 fatal_error( "out of memory\n" );
483 if ((p = strrchr( strcpy( path, full_argv0 ), '/' )))
485 strcpy( p, "/wineserver" );
486 execl( path, path, NULL );
488 free(path);
491 /* finally try the path */
492 execlp( "wineserver", "wineserver", NULL );
493 fatal_error( "could not exec wineserver\n" );
495 waitpid( pid, &status, 0 );
496 status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
497 if (status == 2) return; /* server lock held by someone else, will retry later */
498 if (status) exit(status); /* server failed */
499 started = 1;
504 /***********************************************************************
505 * server_connect_error
507 * Try to display a meaningful explanation of why we couldn't connect
508 * to the server.
510 static void server_connect_error( const char *serverdir )
512 int fd;
513 struct flock fl;
515 if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
516 fatal_error( "for some mysterious reason, the wine server never started.\n" );
518 fl.l_type = F_WRLCK;
519 fl.l_whence = SEEK_SET;
520 fl.l_start = 0;
521 fl.l_len = 1;
522 if (fcntl( fd, F_GETLK, &fl ) != -1)
524 if (fl.l_type == F_WRLCK) /* the file is locked */
525 fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
526 " You probably need to kill that process (it might be pid %d).\n",
527 (int)fl.l_pid );
528 fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
530 fatal_error( "the file system of '%s' doesn't support locks,\n"
531 " and there is a 'socket' file in that directory that prevents wine from starting.\n"
532 " You should make sure no wine server is running, remove that file and try again.\n",
533 serverdir );
537 /***********************************************************************
538 * server_connect
540 * Attempt to connect to an existing server socket.
541 * We need to be in the server directory already.
543 static int server_connect( const char *oldcwd, const char *serverdir )
545 struct sockaddr_un addr;
546 struct stat st;
547 int s, slen, retry;
549 /* chdir to the server directory */
550 if (chdir( serverdir ) == -1)
552 if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
553 start_server( "." );
554 if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
557 /* make sure we are at the right place */
558 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
559 if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
560 if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
562 for (retry = 0; retry < 6; retry++)
564 /* if not the first try, wait a bit to leave the previous server time to exit */
565 if (retry)
567 usleep( 100000 * retry * retry );
568 start_server( oldcwd );
569 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
571 else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
573 if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
574 start_server( oldcwd );
575 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
578 /* make sure the socket is sane (ISFIFO needed for Solaris) */
579 if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
580 fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
581 if (st.st_uid != getuid())
582 fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
584 /* try to connect to it */
585 addr.sun_family = AF_UNIX;
586 strcpy( addr.sun_path, SOCKETNAME );
587 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
588 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
589 addr.sun_len = slen;
590 #endif
591 if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
592 if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
594 fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
595 return s;
597 close( s );
599 server_connect_error( serverdir );
603 /***********************************************************************
604 * CLIENT_InitServer
606 * Start the server and create the initial socket pair.
608 void CLIENT_InitServer(void)
610 int size;
611 char *oldcwd;
612 obj_handle_t dummy_handle;
614 /* retrieve the current directory */
615 for (size = 512; ; size *= 2)
617 if (!(oldcwd = malloc( size ))) break;
618 if (getcwd( oldcwd, size )) break;
619 free( oldcwd );
620 if (errno == ERANGE) continue;
621 oldcwd = NULL;
622 break;
625 /* if argv[0] is a relative path, make it absolute */
626 full_argv0 = argv0;
627 if (oldcwd && argv0[0] != '/' && strchr( argv0, '/' ))
629 char *new_argv0 = malloc( strlen(oldcwd) + strlen(argv0) + 2 );
630 if (new_argv0)
632 strcpy( new_argv0, oldcwd );
633 strcat( new_argv0, "/" );
634 strcat( new_argv0, argv0 );
635 full_argv0 = new_argv0;
639 /* connect to the server */
640 fd_socket = server_connect( oldcwd, wine_get_server_dir() );
642 /* switch back to the starting directory */
643 if (oldcwd)
645 chdir( oldcwd );
646 free( oldcwd );
649 /* setup the signal mask */
650 sigemptyset( &block_set );
651 sigaddset( &block_set, SIGALRM );
652 sigaddset( &block_set, SIGIO );
653 sigaddset( &block_set, SIGINT );
654 sigaddset( &block_set, SIGHUP );
655 sigaddset( &block_set, SIGUSR1 );
656 sigaddset( &block_set, SIGUSR2 );
658 /* receive the first thread request fd on the main socket */
659 NtCurrentTeb()->request_fd = receive_fd( &dummy_handle );
661 CLIENT_InitThread();
665 /***********************************************************************
666 * CLIENT_InitThread
668 * Send an init thread request. Return 0 if OK.
670 void CLIENT_InitThread(void)
672 TEB *teb = NtCurrentTeb();
673 int version, ret;
674 int reply_pipe[2];
675 struct sigaction sig_act;
677 sig_act.sa_handler = SIG_IGN;
678 sig_act.sa_flags = 0;
679 sigemptyset( &sig_act.sa_mask );
681 /* ignore SIGPIPE so that we get a EPIPE error instead */
682 sigaction( SIGPIPE, &sig_act, NULL );
683 /* automatic child reaping to avoid zombies */
684 #ifdef SA_NOCLDWAIT
685 sig_act.sa_flags |= SA_NOCLDWAIT;
686 #endif
687 sigaction( SIGCHLD, &sig_act, NULL );
689 /* create the server->client communication pipes */
690 if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
691 if (pipe( teb->wait_fd ) == -1) server_protocol_perror( "pipe" );
692 wine_server_send_fd( reply_pipe[1] );
693 wine_server_send_fd( teb->wait_fd[1] );
694 teb->reply_fd = reply_pipe[0];
695 close( reply_pipe[1] );
697 /* set close on exec flag */
698 fcntl( teb->reply_fd, F_SETFD, 1 );
699 fcntl( teb->wait_fd[0], F_SETFD, 1 );
700 fcntl( teb->wait_fd[1], F_SETFD, 1 );
702 SERVER_START_REQ( init_thread )
704 req->unix_pid = getpid();
705 req->unix_tid = SYSDEPS_GetUnixTid();
706 req->teb = teb;
707 req->entry = teb->entry_point;
708 req->reply_fd = reply_pipe[1];
709 req->wait_fd = teb->wait_fd[1];
710 ret = wine_server_call( req );
711 teb->pid = reply->pid;
712 teb->tid = reply->tid;
713 version = reply->version;
714 if (reply->boot) boot_thread_id = teb->tid;
715 else if (boot_thread_id == teb->tid) boot_thread_id = 0;
717 SERVER_END_REQ;
719 if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
720 if (version != SERVER_PROTOCOL_VERSION)
721 server_protocol_error( "version mismatch %d/%d.\n"
722 "Your %s binary was not upgraded correctly,\n"
723 "or you have an older one somewhere in your PATH.\n"
724 "Or maybe the wrong wineserver is still running?\n",
725 version, SERVER_PROTOCOL_VERSION,
726 (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );
730 /***********************************************************************
731 * CLIENT_BootDone
733 * Signal that we have finished booting, and set debug level.
735 void CLIENT_BootDone( int debug_level )
737 SERVER_START_REQ( boot_done )
739 req->debug_level = debug_level;
740 wine_server_call( req );
742 SERVER_END_REQ;
746 /***********************************************************************
747 * CLIENT_IsBootThread
749 * Return TRUE if current thread is the boot thread.
751 int CLIENT_IsBootThread(void)
753 return (GetCurrentThreadId() == (DWORD)boot_thread_id);