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"
62 #include "ntdll_misc.h"
64 WINE_DEFAULT_DEBUG_CHANNEL(server);
66 /* Some versions of glibc don't define this */
71 #define SOCKETNAME "socket" /* name of the socket file */
72 #define LOCKNAME "lock" /* name of the lock file */
74 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
75 /* data structure used to pass an fd with sendmsg/recvmsg */
78 int len; /* size of structure */
79 int level; /* SOL_SOCKET */
80 int type; /* SCM_RIGHTS */
81 int fd; /* fd to pass */
83 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
85 static sigset_t block_set; /* signals to block during server calls */
86 static int fd_socket = -1; /* socket to exchange file descriptors with the server */
89 static void fatal_error( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
90 static void fatal_perror( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
91 static void server_connect_error( const char *serverdir ) __attribute__((noreturn));
94 /* die on a fatal error; use only during initialization */
95 static void fatal_error( const char *err, ... )
99 va_start( args, err );
100 fprintf( stderr, "wine: " );
101 vfprintf( stderr, err, args );
106 /* die on a fatal error; use only during initialization */
107 static void fatal_perror( const char *err, ... )
111 va_start( args, err );
112 fprintf( stderr, "wine: " );
113 vfprintf( stderr, err, args );
120 /***********************************************************************
121 * wine_server_exit_thread (NTDLL.@)
123 void wine_server_exit_thread( int status )
125 struct wine_pthread_thread_info info;
129 RemoveEntryList( &NtCurrentTeb()->TlsLinks );
132 info.stack_base = NtCurrentTeb()->DeallocationStack;
133 info.teb_base = NtCurrentTeb();
134 info.teb_sel = wine_get_fs();
135 info.exit_status = status;
138 NtFreeVirtualMemory( GetCurrentProcess(), &info.stack_base, &size, MEM_RELEASE | MEM_SYSTEM );
139 info.stack_size = size;
142 NtFreeVirtualMemory( GetCurrentProcess(), &info.teb_base, &size, MEM_RELEASE | MEM_SYSTEM );
143 info.teb_size = size;
145 sigprocmask( SIG_BLOCK, &block_set, NULL );
146 close( ntdll_get_thread_data()->wait_fd[0] );
147 close( ntdll_get_thread_data()->wait_fd[1] );
148 close( ntdll_get_thread_data()->reply_fd );
149 close( ntdll_get_thread_data()->request_fd );
150 wine_pthread_exit_thread( &info );
154 /***********************************************************************
155 * server_abort_thread
157 void server_abort_thread( int status )
159 sigprocmask( SIG_BLOCK, &block_set, NULL );
160 close( ntdll_get_thread_data()->wait_fd[0] );
161 close( ntdll_get_thread_data()->wait_fd[1] );
162 close( ntdll_get_thread_data()->reply_fd );
163 close( ntdll_get_thread_data()->request_fd );
164 wine_pthread_abort_thread( status );
168 /***********************************************************************
169 * server_protocol_error
171 void server_protocol_error( const char *err, ... )
175 va_start( args, err );
176 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
177 vfprintf( stderr, err, args );
179 server_abort_thread(1);
183 /***********************************************************************
184 * server_protocol_perror
186 void server_protocol_perror( const char *err )
188 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
190 server_abort_thread(1);
194 /***********************************************************************
197 * Send a request to the server.
199 static void send_request( const struct __server_request_info *req )
204 if (!req->u.req.request_header.request_size)
206 if ((ret = write( ntdll_get_thread_data()->request_fd, &req->u.req,
207 sizeof(req->u.req) )) == sizeof(req->u.req)) return;
212 struct iovec vec[__SERVER_MAX_DATA+1];
214 vec[0].iov_base = (void *)&req->u.req;
215 vec[0].iov_len = sizeof(req->u.req);
216 for (i = 0; i < req->data_count; i++)
218 vec[i+1].iov_base = (void *)req->data[i].ptr;
219 vec[i+1].iov_len = req->data[i].size;
221 if ((ret = writev( ntdll_get_thread_data()->request_fd, vec, i+1 )) ==
222 req->u.req.request_header.request_size + sizeof(req->u.req)) return;
225 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
226 if (errno == EPIPE) server_abort_thread(0);
227 server_protocol_perror( "write" );
231 /***********************************************************************
234 * Read data from the reply buffer; helper for wait_reply.
236 static void read_reply_data( void *buffer, size_t size )
242 if ((ret = read( ntdll_get_thread_data()->reply_fd, buffer, size )) > 0)
244 if (!(size -= ret)) return;
245 buffer = (char *)buffer + ret;
249 if (errno == EINTR) continue;
250 if (errno == EPIPE) break;
251 server_protocol_perror("read");
253 /* the server closed the connection; time to die... */
254 server_abort_thread(0);
258 /***********************************************************************
261 * Wait for a reply from the server.
263 inline static void wait_reply( struct __server_request_info *req )
265 read_reply_data( &req->u.reply, sizeof(req->u.reply) );
266 if (req->u.reply.reply_header.reply_size)
267 read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
271 /***********************************************************************
272 * wine_server_call (NTDLL.@)
274 * Perform a server call.
277 * req_ptr [I/O] Function dependent data
280 * Depends on server function being called, but usually an NTSTATUS code.
283 * Use the SERVER_START_REQ and SERVER_END_REQ to help you fill out the
284 * server request structure for the particular call. E.g:
285 *| SERVER_START_REQ( event_op )
287 *| req->handle = handle;
288 *| req->op = SET_EVENT;
289 *| ret = wine_server_call( req );
293 unsigned int wine_server_call( void *req_ptr )
295 struct __server_request_info * const req = req_ptr;
298 sigprocmask( SIG_BLOCK, &block_set, &old_set );
301 sigprocmask( SIG_SETMASK, &old_set, NULL );
302 return req->u.reply.reply_header.error;
306 /***********************************************************************
307 * wine_server_send_fd (NTDLL.@)
309 * Send a file descriptor to the server.
312 * fd [I] file descriptor to send
317 void wine_server_send_fd( int fd )
319 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
323 struct msghdr msghdr;
327 vec.iov_base = (void *)&data;
328 vec.iov_len = sizeof(data);
330 msghdr.msg_name = NULL;
331 msghdr.msg_namelen = 0;
332 msghdr.msg_iov = &vec;
333 msghdr.msg_iovlen = 1;
335 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
336 msghdr.msg_accrights = (void *)&fd;
337 msghdr.msg_accrightslen = sizeof(fd);
338 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
339 cmsg.len = sizeof(cmsg);
340 cmsg.level = SOL_SOCKET;
341 cmsg.type = SCM_RIGHTS;
343 msghdr.msg_control = &cmsg;
344 msghdr.msg_controllen = sizeof(cmsg);
345 msghdr.msg_flags = 0;
346 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
348 data.tid = GetCurrentThreadId();
353 if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
354 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
355 if (errno == EINTR) continue;
356 if (errno == EPIPE) server_abort_thread(0);
357 server_protocol_perror( "sendmsg" );
362 /***********************************************************************
365 * Receive a file descriptor passed from the server.
367 static int receive_fd( obj_handle_t *handle )
372 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
373 struct msghdr msghdr;
376 msghdr.msg_accrights = (void *)&fd;
377 msghdr.msg_accrightslen = sizeof(fd);
378 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
379 struct msghdr msghdr;
382 cmsg.len = sizeof(cmsg);
383 cmsg.level = SOL_SOCKET;
384 cmsg.type = SCM_RIGHTS;
386 msghdr.msg_control = &cmsg;
387 msghdr.msg_controllen = sizeof(cmsg);
388 msghdr.msg_flags = 0;
389 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
391 msghdr.msg_name = NULL;
392 msghdr.msg_namelen = 0;
393 msghdr.msg_iov = &vec;
394 msghdr.msg_iovlen = 1;
395 vec.iov_base = (void *)handle;
396 vec.iov_len = sizeof(*handle);
400 if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
402 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
405 if (fd == -1) server_protocol_error( "no fd received for handle %d\n", *handle );
406 fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
410 if (errno == EINTR) continue;
411 if (errno == EPIPE) break;
412 server_protocol_perror("recvmsg");
414 /* the server closed the connection; time to die... */
415 server_abort_thread(0);
419 /***********************************************************************
422 * Store the cached fd value for a given handle back into the server.
423 * Returns the new fd, which can be different if there was already an
424 * fd in the cache for that handle.
426 inline static int store_cached_fd( int *fd, obj_handle_t handle )
430 SERVER_START_REQ( set_handle_info )
432 req->handle = handle;
436 if (!(ret = wine_server_call( req )))
438 if (reply->cur_fd != *fd)
440 /* someone was here before us */
456 /***********************************************************************
457 * wine_server_fd_to_handle (NTDLL.@)
459 * Allocate a file handle for a Unix file descriptor.
462 * fd [I] Unix file descriptor.
463 * access [I] Win32 access flags.
464 * inherit [I] Indicates whether this handle is inherited by child processes.
465 * handle [O] Address where Wine file handle will be stored.
470 int wine_server_fd_to_handle( int fd, unsigned int access, int inherit, obj_handle_t *handle )
475 wine_server_send_fd( fd );
477 SERVER_START_REQ( alloc_file_handle )
479 req->access = access;
480 req->inherit = inherit;
482 if (!(ret = wine_server_call( req ))) *handle = reply->handle;
489 /***********************************************************************
490 * wine_server_handle_to_fd (NTDLL.@)
492 * Retrieve the file descriptor corresponding to a file handle.
495 * handle [I] Wine file handle.
496 * access [I] Win32 file access rights requested.
497 * unix_fd [O] Address where Unix file descriptor will be stored.
498 * flags [O] Address where the Unix flags associated with file will be stored. Optional.
503 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd, int *flags )
505 obj_handle_t fd_handle;
511 SERVER_START_REQ( get_handle_fd )
513 req->handle = handle;
514 req->access = access;
515 if (!(ret = wine_server_call( req ))) fd = reply->fd;
516 if (flags) *flags = reply->flags;
523 /* it wasn't in the cache, get it from the server */
524 fd = receive_fd( &fd_handle );
525 /* and store it back into the cache */
526 ret = store_cached_fd( &fd, fd_handle );
529 if (fd_handle == handle) break;
530 /* if we received a different handle this means there was
531 * a race with another thread; we restart everything from
532 * scratch in this case.
536 if ((fd != -1) && ((fd = dup(fd)) == -1)) return STATUS_TOO_MANY_OPENED_FILES;
538 return STATUS_SUCCESS;
542 /***********************************************************************
543 * wine_server_release_fd (NTDLL.@)
545 * Release the Unix file descriptor returned by wine_server_handle_to_fd.
548 * handle [I] Wine file handle.
549 * unix_fd [I] Unix file descriptor to release.
554 void wine_server_release_fd( obj_handle_t handle, int unix_fd )
560 /***********************************************************************
563 * Start a new wine server.
565 static void start_server( const char *oldcwd )
567 static int started; /* we only try once */
575 if (pid == -1) fatal_perror( "fork" );
578 argv[0] = "wineserver";
579 argv[1] = TRACE_ON(server) ? "-d" : NULL;
581 /* if server is explicitly specified, use this */
582 if ((p = getenv("WINESERVER")))
584 if (p[0] != '/' && oldcwd[0] == '/') /* make it an absolute path */
586 if (!(path = malloc( strlen(oldcwd) + strlen(p) + 1 )))
587 fatal_error( "out of memory\n" );
588 sprintf( path, "%s/%s", oldcwd, p );
591 wine_exec_wine_binary( p, argv, NULL, FALSE );
592 fatal_perror( "could not exec the server '%s'\n"
593 " specified in the WINESERVER environment variable", p );
595 /* now use the standard search strategy */
596 wine_exec_wine_binary( argv[0], argv, NULL, FALSE );
597 fatal_error( "could not exec wineserver\n" );
599 waitpid( pid, &status, 0 );
600 status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
601 if (status == 2) return; /* server lock held by someone else, will retry later */
602 if (status) exit(status); /* server failed */
608 /***********************************************************************
609 * server_connect_error
611 * Try to display a meaningful explanation of why we couldn't connect
614 static void server_connect_error( const char *serverdir )
619 if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
620 fatal_error( "for some mysterious reason, the wine server never started.\n" );
623 fl.l_whence = SEEK_SET;
626 if (fcntl( fd, F_GETLK, &fl ) != -1)
628 if (fl.l_type == F_WRLCK) /* the file is locked */
629 fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
630 " You probably need to kill that process (it might be pid %d).\n",
632 fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
634 fatal_error( "the file system of '%s' doesn't support locks,\n"
635 " and there is a 'socket' file in that directory that prevents wine from starting.\n"
636 " You should make sure no wine server is running, remove that file and try again.\n",
641 /***********************************************************************
644 * Attempt to connect to an existing server socket.
645 * We need to be in the server directory already.
647 static int server_connect( const char *oldcwd, const char *serverdir )
649 struct sockaddr_un addr;
653 /* chdir to the server directory */
654 if (chdir( serverdir ) == -1)
656 if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
658 if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
661 /* make sure we are at the right place */
662 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
663 if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
664 if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
666 for (retry = 0; retry < 6; retry++)
668 /* if not the first try, wait a bit to leave the previous server time to exit */
671 usleep( 100000 * retry * retry );
672 start_server( oldcwd );
673 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
675 else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
677 if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
678 start_server( oldcwd );
679 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
682 /* make sure the socket is sane (ISFIFO needed for Solaris) */
683 if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
684 fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
685 if (st.st_uid != getuid())
686 fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
688 /* try to connect to it */
689 addr.sun_family = AF_UNIX;
690 strcpy( addr.sun_path, SOCKETNAME );
691 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
692 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
695 if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
696 if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
698 fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
703 server_connect_error( serverdir );
707 /***********************************************************************
710 * Remove a directory and all its contents; helper for create_config_dir.
712 static void rm_rf( const char *path )
714 int err = errno; /* preserve errno */
720 if (!(buffer = malloc( strlen(path) + 256 + 1 ))) goto done;
721 strcpy( buffer, path );
722 p = buffer + strlen(buffer);
725 if ((dir = opendir( path )))
727 while ((de = readdir( dir )))
729 if (!strcmp( de->d_name, "." ) || !strcmp( de->d_name, ".." )) continue;
730 strcpy( p, de->d_name );
731 if (unlink( buffer ) != -1) continue;
732 if (errno == EISDIR ||
733 (errno == EPERM && !lstat( buffer, &st ) && S_ISDIR(st.st_mode)))
735 /* recurse in the sub-directory */
748 /***********************************************************************
751 * Create the wine configuration dir (~/.wine).
753 static void create_config_dir(void)
755 const char *config_dir = wine_get_config_dir();
760 if (!(tmp_dir = malloc( strlen(config_dir) + sizeof("-XXXXXX") )))
761 fatal_error( "out of memory\n" );
762 strcpy( tmp_dir, config_dir );
763 strcat( tmp_dir, "-XXXXXX" );
764 if ((fd = mkstemps( tmp_dir, 0 )) == -1)
765 fatal_perror( "can't get temp file name for %s", config_dir );
768 if (mkdir( tmp_dir, 0777 ) == -1)
769 fatal_perror( "cannot create temp dir %s", tmp_dir );
771 MESSAGE( "wine: creating configuration directory '%s'...\n", config_dir );
776 fatal_perror( "fork" );
782 argv[0] = "wineprefixcreate";
785 argv[3] = "--prefix";
788 wine_exec_wine_binary( argv[0], (char **)argv, NULL, FALSE );
790 fatal_perror( "could not exec wineprefixcreate" );
796 while ((wret = waitpid( pid, &status, 0 )) != pid)
798 if (wret == -1 && errno != EINTR) fatal_perror( "wait4" );
800 if (!WIFEXITED(status) || WEXITSTATUS(status))
803 fatal_error( "wineprefixcreate failed while creating '%s'.\n", config_dir );
806 if (rename( tmp_dir, config_dir ) == -1)
809 if (errno != EEXIST && errno != ENOTEMPTY)
810 fatal_perror( "rename '%s' to '%s'", tmp_dir, config_dir );
811 /* else it was probably created by a concurrent wine process */
814 MESSAGE( "wine: '%s' created successfully.\n", config_dir );
818 /***********************************************************************
819 * server_init_process
821 * Start the server and create the initial socket pair.
823 void server_init_process(void)
827 obj_handle_t dummy_handle;
828 const char *server_dir = wine_get_server_dir();
830 if (!server_dir) /* this means the config dir doesn't exist */
833 server_dir = wine_get_server_dir();
836 /* retrieve the current directory */
837 for (size = 512; ; size *= 2)
839 if (!(oldcwd = malloc( size ))) break;
840 if (getcwd( oldcwd, size )) break;
842 if (errno == ERANGE) continue;
847 /* connect to the server */
848 fd_socket = server_connect( oldcwd, server_dir );
850 /* switch back to the starting directory */
857 /* setup the signal mask */
858 sigemptyset( &block_set );
859 sigaddset( &block_set, SIGALRM );
860 sigaddset( &block_set, SIGIO );
861 sigaddset( &block_set, SIGINT );
862 sigaddset( &block_set, SIGHUP );
863 sigaddset( &block_set, SIGUSR1 );
864 sigaddset( &block_set, SIGUSR2 );
865 sigaddset( &block_set, SIGCHLD );
867 /* receive the first thread request fd on the main socket */
868 ntdll_get_thread_data()->request_fd = receive_fd( &dummy_handle );
872 /***********************************************************************
875 * Send an init thread request. Return 0 if OK.
877 void server_init_thread( int unix_pid, int unix_tid, void *entry_point )
881 struct sigaction sig_act;
883 sig_act.sa_handler = SIG_IGN;
884 sig_act.sa_flags = 0;
885 sigemptyset( &sig_act.sa_mask );
887 /* ignore SIGPIPE so that we get an EPIPE error instead */
888 sigaction( SIGPIPE, &sig_act, NULL );
889 /* automatic child reaping to avoid zombies */
891 sig_act.sa_flags |= SA_NOCLDWAIT;
893 sigaction( SIGCHLD, &sig_act, NULL );
895 /* create the server->client communication pipes */
896 if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
897 if (pipe( ntdll_get_thread_data()->wait_fd ) == -1) server_protocol_perror( "pipe" );
898 wine_server_send_fd( reply_pipe[1] );
899 wine_server_send_fd( ntdll_get_thread_data()->wait_fd[1] );
900 ntdll_get_thread_data()->reply_fd = reply_pipe[0];
901 close( reply_pipe[1] );
903 /* set close on exec flag */
904 fcntl( ntdll_get_thread_data()->reply_fd, F_SETFD, 1 );
905 fcntl( ntdll_get_thread_data()->wait_fd[0], F_SETFD, 1 );
906 fcntl( ntdll_get_thread_data()->wait_fd[1], F_SETFD, 1 );
908 SERVER_START_REQ( init_thread )
910 req->unix_pid = unix_pid;
911 req->unix_tid = unix_tid;
912 req->teb = NtCurrentTeb();
913 req->entry = entry_point;
914 req->reply_fd = reply_pipe[1];
915 req->wait_fd = ntdll_get_thread_data()->wait_fd[1];
916 ret = wine_server_call( req );
917 NtCurrentTeb()->ClientId.UniqueProcess = (HANDLE)reply->pid;
918 NtCurrentTeb()->ClientId.UniqueThread = (HANDLE)reply->tid;
919 version = reply->version;
923 if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
924 if (version != SERVER_PROTOCOL_VERSION)
925 server_protocol_error( "version mismatch %d/%d.\n"
926 "Your %s binary was not upgraded correctly,\n"
927 "or you have an older one somewhere in your PATH.\n"
928 "Or maybe the wrong wineserver is still running?\n",
929 version, SERVER_PROTOCOL_VERSION,
930 (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );