2 * Wine 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
22 #include "wine/port.h"
33 #include <sys/types.h>
34 #ifdef HAVE_SYS_SOCKET_H
35 # include <sys/socket.h>
37 #ifdef HAVE_SYS_WAIT_H
43 #ifdef HAVE_SYS_MMAN_H
46 #ifdef HAVE_SYS_STAT_H
47 # include <sys/stat.h>
57 #include "wine/library.h"
58 #include "wine/pthread.h"
59 #include "wine/server.h"
60 #include "wine/debug.h"
61 #include "ntdll_misc.h"
63 WINE_DEFAULT_DEBUG_CHANNEL(server);
65 /* Some versions of glibc don't define this */
70 #define SOCKETNAME "socket" /* name of the socket file */
71 #define LOCKNAME "lock" /* name of the lock file */
73 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
74 /* data structure used to pass an fd with sendmsg/recvmsg */
77 int len; /* size of structure */
78 int level; /* SOL_SOCKET */
79 int type; /* SCM_RIGHTS */
80 int fd; /* fd to pass */
82 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
84 static sigset_t block_set; /* signals to block during server calls */
85 static int fd_socket = -1; /* socket to exchange file descriptors with the server */
88 static void fatal_error( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
89 static void fatal_perror( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
90 static void server_connect_error( const char *serverdir ) __attribute__((noreturn));
93 /* die on a fatal error; use only during initialization */
94 static void fatal_error( const char *err, ... )
98 va_start( args, err );
99 fprintf( stderr, "wine: " );
100 vfprintf( stderr, err, args );
105 /* die on a fatal error; use only during initialization */
106 static void fatal_perror( const char *err, ... )
110 va_start( args, err );
111 fprintf( stderr, "wine: " );
112 vfprintf( stderr, err, args );
119 /***********************************************************************
120 * wine_server_exit_thread (NTDLL.@)
122 void wine_server_exit_thread( int status )
124 struct wine_pthread_thread_info info;
128 RemoveEntryList( &NtCurrentTeb()->TlsLinks );
131 info.stack_base = NtCurrentTeb()->DeallocationStack;
132 info.teb_base = NtCurrentTeb();
133 info.teb_sel = wine_get_fs();
134 info.exit_status = status;
137 NtFreeVirtualMemory( GetCurrentProcess(), &info.stack_base, &size, MEM_RELEASE | MEM_SYSTEM );
138 info.stack_size = size;
141 NtFreeVirtualMemory( GetCurrentProcess(), &info.teb_base, &size, MEM_RELEASE | MEM_SYSTEM );
142 info.teb_size = size;
144 sigprocmask( SIG_BLOCK, &block_set, NULL );
145 close( ntdll_get_thread_data()->wait_fd[0] );
146 close( ntdll_get_thread_data()->wait_fd[1] );
147 close( ntdll_get_thread_data()->reply_fd );
148 close( ntdll_get_thread_data()->request_fd );
149 wine_pthread_exit_thread( &info );
153 /***********************************************************************
154 * server_abort_thread
156 void server_abort_thread( int status )
158 sigprocmask( SIG_BLOCK, &block_set, NULL );
159 close( ntdll_get_thread_data()->wait_fd[0] );
160 close( ntdll_get_thread_data()->wait_fd[1] );
161 close( ntdll_get_thread_data()->reply_fd );
162 close( ntdll_get_thread_data()->request_fd );
163 wine_pthread_abort_thread( status );
167 /***********************************************************************
168 * server_protocol_error
170 void server_protocol_error( const char *err, ... )
174 va_start( args, err );
175 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
176 vfprintf( stderr, err, args );
178 server_abort_thread(1);
182 /***********************************************************************
183 * server_protocol_perror
185 void server_protocol_perror( const char *err )
187 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
189 server_abort_thread(1);
193 /***********************************************************************
196 * Send a request to the server.
198 static void send_request( const struct __server_request_info *req )
203 if (!req->u.req.request_header.request_size)
205 if ((ret = write( ntdll_get_thread_data()->request_fd, &req->u.req,
206 sizeof(req->u.req) )) == sizeof(req->u.req)) return;
211 struct iovec vec[__SERVER_MAX_DATA+1];
213 vec[0].iov_base = (void *)&req->u.req;
214 vec[0].iov_len = sizeof(req->u.req);
215 for (i = 0; i < req->data_count; i++)
217 vec[i+1].iov_base = (void *)req->data[i].ptr;
218 vec[i+1].iov_len = req->data[i].size;
220 if ((ret = writev( ntdll_get_thread_data()->request_fd, vec, i+1 )) ==
221 req->u.req.request_header.request_size + sizeof(req->u.req)) return;
224 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
225 if (errno == EPIPE) server_abort_thread(0);
226 server_protocol_perror( "write" );
230 /***********************************************************************
233 * Read data from the reply buffer; helper for wait_reply.
235 static void read_reply_data( void *buffer, size_t size )
241 if ((ret = read( ntdll_get_thread_data()->reply_fd, buffer, size )) > 0)
243 if (!(size -= ret)) return;
244 buffer = (char *)buffer + ret;
248 if (errno == EINTR) continue;
249 if (errno == EPIPE) break;
250 server_protocol_perror("read");
252 /* the server closed the connection; time to die... */
253 server_abort_thread(0);
257 /***********************************************************************
260 * Wait for a reply from the server.
262 inline static void wait_reply( struct __server_request_info *req )
264 read_reply_data( &req->u.reply, sizeof(req->u.reply) );
265 if (req->u.reply.reply_header.reply_size)
266 read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
270 /***********************************************************************
271 * wine_server_call (NTDLL.@)
273 * Perform a server call.
276 * req_ptr [I/O] Function dependent data
279 * Depends on server function being called, but usually an NTSTATUS code.
282 * Use the SERVER_START_REQ and SERVER_END_REQ to help you fill out the
283 * server request structure for the particular call. E.g:
284 *| SERVER_START_REQ( event_op )
286 *| req->handle = handle;
287 *| req->op = SET_EVENT;
288 *| ret = wine_server_call( req );
292 unsigned int wine_server_call( void *req_ptr )
294 struct __server_request_info * const req = req_ptr;
297 sigprocmask( SIG_BLOCK, &block_set, &old_set );
300 sigprocmask( SIG_SETMASK, &old_set, NULL );
301 return req->u.reply.reply_header.error;
305 /***********************************************************************
306 * wine_server_send_fd (NTDLL.@)
308 * Send a file descriptor to the server.
311 * fd [I] file descriptor to send
316 void wine_server_send_fd( int fd )
318 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
322 struct msghdr msghdr;
326 vec.iov_base = (void *)&data;
327 vec.iov_len = sizeof(data);
329 msghdr.msg_name = NULL;
330 msghdr.msg_namelen = 0;
331 msghdr.msg_iov = &vec;
332 msghdr.msg_iovlen = 1;
334 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
335 msghdr.msg_accrights = (void *)&fd;
336 msghdr.msg_accrightslen = sizeof(fd);
337 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
338 cmsg.len = sizeof(cmsg);
339 cmsg.level = SOL_SOCKET;
340 cmsg.type = SCM_RIGHTS;
342 msghdr.msg_control = &cmsg;
343 msghdr.msg_controllen = sizeof(cmsg);
344 msghdr.msg_flags = 0;
345 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
347 data.tid = GetCurrentThreadId();
352 if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
353 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
354 if (errno == EINTR) continue;
355 if (errno == EPIPE) server_abort_thread(0);
356 server_protocol_perror( "sendmsg" );
361 /***********************************************************************
364 * Receive a file descriptor passed from the server.
366 static int receive_fd( obj_handle_t *handle )
371 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
372 struct msghdr msghdr;
375 msghdr.msg_accrights = (void *)&fd;
376 msghdr.msg_accrightslen = sizeof(fd);
377 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
378 struct msghdr msghdr;
381 cmsg.len = sizeof(cmsg);
382 cmsg.level = SOL_SOCKET;
383 cmsg.type = SCM_RIGHTS;
385 msghdr.msg_control = &cmsg;
386 msghdr.msg_controllen = sizeof(cmsg);
387 msghdr.msg_flags = 0;
388 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
390 msghdr.msg_name = NULL;
391 msghdr.msg_namelen = 0;
392 msghdr.msg_iov = &vec;
393 msghdr.msg_iovlen = 1;
394 vec.iov_base = (void *)handle;
395 vec.iov_len = sizeof(*handle);
399 if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
401 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
404 if (fd == -1) server_protocol_error( "no fd received for handle %d\n", *handle );
405 fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
409 if (errno == EINTR) continue;
410 if (errno == EPIPE) break;
411 server_protocol_perror("recvmsg");
413 /* the server closed the connection; time to die... */
414 server_abort_thread(0);
418 /***********************************************************************
421 * Store the cached fd value for a given handle back into the server.
422 * Returns the new fd, which can be different if there was already an
423 * fd in the cache for that handle.
425 inline static int store_cached_fd( int *fd, obj_handle_t handle )
429 SERVER_START_REQ( set_handle_info )
431 req->handle = handle;
435 if (!(ret = wine_server_call( req )))
437 if (reply->cur_fd != *fd)
439 /* someone was here before us */
455 /***********************************************************************
456 * wine_server_fd_to_handle (NTDLL.@)
458 * Allocate a file handle for a Unix file descriptor.
461 * fd [I] Unix file descriptor.
462 * access [I] Win32 access flags.
463 * inherit [I] Indicates whether this handle is inherited by child processes.
464 * handle [O] Address where Wine file handle will be stored.
469 int wine_server_fd_to_handle( int fd, unsigned int access, int inherit, obj_handle_t *handle )
474 wine_server_send_fd( fd );
476 SERVER_START_REQ( alloc_file_handle )
478 req->access = access;
479 req->inherit = inherit;
481 if (!(ret = wine_server_call( req ))) *handle = reply->handle;
488 /***********************************************************************
489 * wine_server_handle_to_fd (NTDLL.@)
491 * Retrieve the file descriptor corresponding to a file handle.
494 * handle [I] Wine file handle.
495 * access [I] Win32 file access rights requested.
496 * unix_fd [O] Address where Unix file descriptor will be stored.
497 * flags [O] Address where the Unix flags associated with file will be stored. Optional.
502 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd, int *flags )
504 obj_handle_t fd_handle;
510 SERVER_START_REQ( get_handle_fd )
512 req->handle = handle;
513 req->access = access;
514 if (!(ret = wine_server_call( req ))) fd = reply->fd;
515 if (flags) *flags = reply->flags;
522 /* it wasn't in the cache, get it from the server */
523 fd = receive_fd( &fd_handle );
524 /* and store it back into the cache */
525 ret = store_cached_fd( &fd, fd_handle );
528 if (fd_handle == handle) break;
529 /* if we received a different handle this means there was
530 * a race with another thread; we restart everything from
531 * scratch in this case.
535 if ((fd != -1) && ((fd = dup(fd)) == -1)) return STATUS_TOO_MANY_OPENED_FILES;
537 return STATUS_SUCCESS;
541 /***********************************************************************
542 * wine_server_release_fd (NTDLL.@)
544 * Release the Unix file descriptor returned by wine_server_handle_to_fd.
547 * handle [I] Wine file handle.
548 * unix_fd [I] Unix file descriptor to release.
553 void wine_server_release_fd( obj_handle_t handle, int unix_fd )
559 /***********************************************************************
562 * Start a new wine server.
564 static void start_server( const char *oldcwd )
566 static int started; /* we only try once */
574 if (pid == -1) fatal_perror( "fork" );
577 argv[0] = "wineserver";
578 argv[1] = TRACE_ON(server) ? "-d" : NULL;
580 /* if server is explicitly specified, use this */
581 if ((p = getenv("WINESERVER")))
583 if (p[0] != '/' && oldcwd[0] == '/') /* make it an absolute path */
585 if (!(path = malloc( strlen(oldcwd) + strlen(p) + 1 )))
586 fatal_error( "out of memory\n" );
587 sprintf( path, "%s/%s", oldcwd, p );
590 wine_exec_wine_binary( p, argv, NULL, FALSE );
591 fatal_perror( "could not exec the server '%s'\n"
592 " specified in the WINESERVER environment variable", p );
594 /* now use the standard search strategy */
595 wine_exec_wine_binary( argv[0], argv, NULL, FALSE );
596 fatal_error( "could not exec wineserver\n" );
598 waitpid( pid, &status, 0 );
599 status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
600 if (status == 2) return; /* server lock held by someone else, will retry later */
601 if (status) exit(status); /* server failed */
607 /***********************************************************************
608 * server_connect_error
610 * Try to display a meaningful explanation of why we couldn't connect
613 static void server_connect_error( const char *serverdir )
618 if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
619 fatal_error( "for some mysterious reason, the wine server never started.\n" );
622 fl.l_whence = SEEK_SET;
625 if (fcntl( fd, F_GETLK, &fl ) != -1)
627 if (fl.l_type == F_WRLCK) /* the file is locked */
628 fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
629 " You probably need to kill that process (it might be pid %d).\n",
631 fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
633 fatal_error( "the file system of '%s' doesn't support locks,\n"
634 " and there is a 'socket' file in that directory that prevents wine from starting.\n"
635 " You should make sure no wine server is running, remove that file and try again.\n",
640 /***********************************************************************
643 * Attempt to connect to an existing server socket.
644 * We need to be in the server directory already.
646 static int server_connect( const char *oldcwd, const char *serverdir )
648 struct sockaddr_un addr;
652 /* chdir to the server directory */
653 if (chdir( serverdir ) == -1)
655 if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
657 if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
660 /* make sure we are at the right place */
661 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
662 if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
663 if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
665 for (retry = 0; retry < 6; retry++)
667 /* if not the first try, wait a bit to leave the previous server time to exit */
670 usleep( 100000 * retry * retry );
671 start_server( oldcwd );
672 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
674 else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
676 if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
677 start_server( oldcwd );
678 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
681 /* make sure the socket is sane (ISFIFO needed for Solaris) */
682 if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
683 fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
684 if (st.st_uid != getuid())
685 fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
687 /* try to connect to it */
688 addr.sun_family = AF_UNIX;
689 strcpy( addr.sun_path, SOCKETNAME );
690 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
691 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
694 if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
695 if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
697 fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
702 server_connect_error( serverdir );
706 /***********************************************************************
709 * Remove a directory and all its contents; helper for create_config_dir.
711 static void rm_rf( const char *path )
713 int err = errno; /* preserve errno */
719 if (!(buffer = malloc( strlen(path) + 256 + 1 ))) goto done;
720 strcpy( buffer, path );
721 p = buffer + strlen(buffer);
724 if ((dir = opendir( path )))
726 while ((de = readdir( dir )))
728 if (!strcmp( de->d_name, "." ) || !strcmp( de->d_name, ".." )) continue;
729 strcpy( p, de->d_name );
730 if (unlink( buffer ) != -1) continue;
731 if (errno == EISDIR ||
732 (errno == EPERM && !lstat( buffer, &st ) && S_ISDIR(st.st_mode)))
734 /* recurse in the sub-directory */
747 /***********************************************************************
750 * Create the wine configuration dir (~/.wine).
752 static void create_config_dir(void)
754 const char *config_dir = wine_get_config_dir();
759 if (!(tmp_dir = malloc( strlen(config_dir) + sizeof("-XXXXXX") )))
760 fatal_error( "out of memory\n" );
761 strcpy( tmp_dir, config_dir );
762 strcat( tmp_dir, "-XXXXXX" );
763 if ((fd = mkstemps( tmp_dir, 0 )) == -1)
764 fatal_perror( "can't get temp file name for %s", config_dir );
767 if (mkdir( tmp_dir, 0777 ) == -1)
768 fatal_perror( "cannot create temp dir %s", tmp_dir );
770 MESSAGE( "wine: creating configuration directory '%s'...\n", config_dir );
775 fatal_perror( "fork" );
781 argv[0] = "wineprefixcreate";
784 argv[3] = "--prefix";
787 wine_exec_wine_binary( argv[0], (char **)argv, NULL, FALSE );
789 fatal_perror( "could not exec wineprefixcreate" );
795 while ((wret = waitpid( pid, &status, 0 )) != pid)
797 if (wret == -1 && errno != EINTR) fatal_perror( "wait4" );
799 if (!WIFEXITED(status) || WEXITSTATUS(status))
802 fatal_error( "wineprefixcreate failed while creating '%s'.\n", config_dir );
805 if (rename( tmp_dir, config_dir ) == -1)
808 if (errno != EEXIST && errno != ENOTEMPTY)
809 fatal_perror( "rename '%s' to '%s'", tmp_dir, config_dir );
810 /* else it was probably created by a concurrent wine process */
813 MESSAGE( "wine: '%s' created successfully.\n", config_dir );
817 /***********************************************************************
818 * server_init_process
820 * Start the server and create the initial socket pair.
822 void server_init_process(void)
826 obj_handle_t dummy_handle;
827 const char *server_dir = wine_get_server_dir();
829 if (!server_dir) /* this means the config dir doesn't exist */
832 server_dir = wine_get_server_dir();
835 /* retrieve the current directory */
836 for (size = 512; ; size *= 2)
838 if (!(oldcwd = malloc( size ))) break;
839 if (getcwd( oldcwd, size )) break;
841 if (errno == ERANGE) continue;
846 /* connect to the server */
847 fd_socket = server_connect( oldcwd, server_dir );
849 /* switch back to the starting directory */
856 /* setup the signal mask */
857 sigemptyset( &block_set );
858 sigaddset( &block_set, SIGALRM );
859 sigaddset( &block_set, SIGIO );
860 sigaddset( &block_set, SIGINT );
861 sigaddset( &block_set, SIGHUP );
862 sigaddset( &block_set, SIGUSR1 );
863 sigaddset( &block_set, SIGUSR2 );
864 sigaddset( &block_set, SIGCHLD );
866 /* receive the first thread request fd on the main socket */
867 ntdll_get_thread_data()->request_fd = receive_fd( &dummy_handle );
871 /***********************************************************************
874 * Send an init thread request. Return 0 if OK.
876 void server_init_thread( int unix_pid, int unix_tid, void *entry_point )
880 struct sigaction sig_act;
882 sig_act.sa_handler = SIG_IGN;
883 sig_act.sa_flags = 0;
884 sigemptyset( &sig_act.sa_mask );
886 /* ignore SIGPIPE so that we get an EPIPE error instead */
887 sigaction( SIGPIPE, &sig_act, NULL );
888 /* automatic child reaping to avoid zombies */
890 sig_act.sa_flags |= SA_NOCLDWAIT;
892 sigaction( SIGCHLD, &sig_act, NULL );
894 /* create the server->client communication pipes */
895 if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
896 if (pipe( ntdll_get_thread_data()->wait_fd ) == -1) server_protocol_perror( "pipe" );
897 wine_server_send_fd( reply_pipe[1] );
898 wine_server_send_fd( ntdll_get_thread_data()->wait_fd[1] );
899 ntdll_get_thread_data()->reply_fd = reply_pipe[0];
900 close( reply_pipe[1] );
902 /* set close on exec flag */
903 fcntl( ntdll_get_thread_data()->reply_fd, F_SETFD, 1 );
904 fcntl( ntdll_get_thread_data()->wait_fd[0], F_SETFD, 1 );
905 fcntl( ntdll_get_thread_data()->wait_fd[1], F_SETFD, 1 );
907 SERVER_START_REQ( init_thread )
909 req->unix_pid = unix_pid;
910 req->unix_tid = unix_tid;
911 req->teb = NtCurrentTeb();
912 req->entry = entry_point;
913 req->reply_fd = reply_pipe[1];
914 req->wait_fd = ntdll_get_thread_data()->wait_fd[1];
915 ret = wine_server_call( req );
916 NtCurrentTeb()->ClientId.UniqueProcess = (HANDLE)reply->pid;
917 NtCurrentTeb()->ClientId.UniqueThread = (HANDLE)reply->tid;
918 version = reply->version;
922 if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
923 if (version != SERVER_PROTOCOL_VERSION)
924 server_protocol_error( "version mismatch %d/%d.\n"
925 "Your %s binary was not upgraded correctly,\n"
926 "or you have an older one somewhere in your PATH.\n"
927 "Or maybe the wrong wineserver is still running?\n",
928 version, SERVER_PROTOCOL_VERSION,
929 (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );