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 time_t server_start_time = 0; /* time of server startup */
86 static sigset_t block_set; /* signals to block during server calls */
87 static int fd_socket = -1; /* socket to exchange file descriptors with the server */
90 static void fatal_error( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
91 static void fatal_perror( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
92 static void server_connect_error( const char *serverdir ) __attribute__((noreturn));
95 /* die on a fatal error; use only during initialization */
96 static void fatal_error( const char *err, ... )
100 va_start( args, err );
101 fprintf( stderr, "wine: " );
102 vfprintf( stderr, err, args );
107 /* die on a fatal error; use only during initialization */
108 static void fatal_perror( const char *err, ... )
112 va_start( args, err );
113 fprintf( stderr, "wine: " );
114 vfprintf( stderr, err, args );
121 /***********************************************************************
122 * wine_server_exit_thread (NTDLL.@)
124 void wine_server_exit_thread( int status )
126 struct wine_pthread_thread_info info;
130 RemoveEntryList( &NtCurrentTeb()->TlsLinks );
133 info.stack_base = NtCurrentTeb()->DeallocationStack;
134 info.teb_base = NtCurrentTeb();
135 info.teb_sel = wine_get_fs();
136 info.exit_status = status;
139 NtFreeVirtualMemory( GetCurrentProcess(), &info.stack_base, &size, MEM_RELEASE | MEM_SYSTEM );
140 info.stack_size = size;
143 NtFreeVirtualMemory( GetCurrentProcess(), &info.teb_base, &size, MEM_RELEASE | MEM_SYSTEM );
144 info.teb_size = size;
146 sigprocmask( SIG_BLOCK, &block_set, NULL );
147 close( ntdll_get_thread_data()->wait_fd[0] );
148 close( ntdll_get_thread_data()->wait_fd[1] );
149 close( ntdll_get_thread_data()->reply_fd );
150 close( ntdll_get_thread_data()->request_fd );
151 wine_pthread_exit_thread( &info );
155 /***********************************************************************
156 * server_abort_thread
158 void server_abort_thread( int status )
160 sigprocmask( SIG_BLOCK, &block_set, NULL );
161 close( ntdll_get_thread_data()->wait_fd[0] );
162 close( ntdll_get_thread_data()->wait_fd[1] );
163 close( ntdll_get_thread_data()->reply_fd );
164 close( ntdll_get_thread_data()->request_fd );
165 wine_pthread_abort_thread( status );
169 /***********************************************************************
170 * server_protocol_error
172 void server_protocol_error( const char *err, ... )
176 va_start( args, err );
177 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
178 vfprintf( stderr, err, args );
180 server_abort_thread(1);
184 /***********************************************************************
185 * server_protocol_perror
187 void server_protocol_perror( const char *err )
189 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
191 server_abort_thread(1);
195 /***********************************************************************
198 * Send a request to the server.
200 static void send_request( const struct __server_request_info *req )
205 if (!req->u.req.request_header.request_size)
207 if ((ret = write( ntdll_get_thread_data()->request_fd, &req->u.req,
208 sizeof(req->u.req) )) == sizeof(req->u.req)) return;
213 struct iovec vec[__SERVER_MAX_DATA+1];
215 vec[0].iov_base = (void *)&req->u.req;
216 vec[0].iov_len = sizeof(req->u.req);
217 for (i = 0; i < req->data_count; i++)
219 vec[i+1].iov_base = (void *)req->data[i].ptr;
220 vec[i+1].iov_len = req->data[i].size;
222 if ((ret = writev( ntdll_get_thread_data()->request_fd, vec, i+1 )) ==
223 req->u.req.request_header.request_size + sizeof(req->u.req)) return;
226 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
227 if (errno == EPIPE) server_abort_thread(0);
228 server_protocol_perror( "write" );
232 /***********************************************************************
235 * Read data from the reply buffer; helper for wait_reply.
237 static void read_reply_data( void *buffer, size_t size )
243 if ((ret = read( ntdll_get_thread_data()->reply_fd, buffer, size )) > 0)
245 if (!(size -= ret)) return;
246 buffer = (char *)buffer + ret;
250 if (errno == EINTR) continue;
251 if (errno == EPIPE) break;
252 server_protocol_perror("read");
254 /* the server closed the connection; time to die... */
255 server_abort_thread(0);
259 /***********************************************************************
262 * Wait for a reply from the server.
264 inline static void wait_reply( struct __server_request_info *req )
266 read_reply_data( &req->u.reply, sizeof(req->u.reply) );
267 if (req->u.reply.reply_header.reply_size)
268 read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
272 /***********************************************************************
273 * wine_server_call (NTDLL.@)
275 * Perform a server call.
278 * req_ptr [I/O] Function dependent data
281 * Depends on server function being called, but usually an NTSTATUS code.
284 * Use the SERVER_START_REQ and SERVER_END_REQ to help you fill out the
285 * server request structure for the particular call. E.g:
286 *| SERVER_START_REQ( event_op )
288 *| req->handle = handle;
289 *| req->op = SET_EVENT;
290 *| ret = wine_server_call( req );
294 unsigned int wine_server_call( void *req_ptr )
296 struct __server_request_info * const req = req_ptr;
299 sigprocmask( SIG_BLOCK, &block_set, &old_set );
302 sigprocmask( SIG_SETMASK, &old_set, NULL );
303 return req->u.reply.reply_header.error;
307 /***********************************************************************
308 * wine_server_send_fd (NTDLL.@)
310 * Send a file descriptor to the server.
313 * fd [I] file descriptor to send
318 void wine_server_send_fd( int fd )
320 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
324 struct msghdr msghdr;
328 vec.iov_base = (void *)&data;
329 vec.iov_len = sizeof(data);
331 msghdr.msg_name = NULL;
332 msghdr.msg_namelen = 0;
333 msghdr.msg_iov = &vec;
334 msghdr.msg_iovlen = 1;
336 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
337 msghdr.msg_accrights = (void *)&fd;
338 msghdr.msg_accrightslen = sizeof(fd);
339 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
340 cmsg.len = sizeof(cmsg);
341 cmsg.level = SOL_SOCKET;
342 cmsg.type = SCM_RIGHTS;
344 msghdr.msg_control = &cmsg;
345 msghdr.msg_controllen = sizeof(cmsg);
346 msghdr.msg_flags = 0;
347 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
349 data.tid = GetCurrentThreadId();
354 if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
355 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
356 if (errno == EINTR) continue;
357 if (errno == EPIPE) server_abort_thread(0);
358 server_protocol_perror( "sendmsg" );
363 /***********************************************************************
366 * Receive a file descriptor passed from the server.
368 static int receive_fd( obj_handle_t *handle )
373 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
374 struct msghdr msghdr;
377 msghdr.msg_accrights = (void *)&fd;
378 msghdr.msg_accrightslen = sizeof(fd);
379 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
380 struct msghdr msghdr;
383 cmsg.len = sizeof(cmsg);
384 cmsg.level = SOL_SOCKET;
385 cmsg.type = SCM_RIGHTS;
387 msghdr.msg_control = &cmsg;
388 msghdr.msg_controllen = sizeof(cmsg);
389 msghdr.msg_flags = 0;
390 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
392 msghdr.msg_name = NULL;
393 msghdr.msg_namelen = 0;
394 msghdr.msg_iov = &vec;
395 msghdr.msg_iovlen = 1;
396 vec.iov_base = (void *)handle;
397 vec.iov_len = sizeof(*handle);
401 if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
403 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
406 if (fd == -1) server_protocol_error( "no fd received for handle %d\n", *handle );
407 fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
411 if (errno == EINTR) continue;
412 if (errno == EPIPE) break;
413 server_protocol_perror("recvmsg");
415 /* the server closed the connection; time to die... */
416 server_abort_thread(0);
420 /***********************************************************************
423 * Store the cached fd value for a given handle back into the server.
424 * Returns the new fd, which can be different if there was already an
425 * fd in the cache for that handle.
427 inline static int store_cached_fd( int *fd, obj_handle_t handle )
431 SERVER_START_REQ( set_handle_info )
433 req->handle = handle;
437 if (!(ret = wine_server_call( req )))
439 if (reply->cur_fd != *fd)
441 /* someone was here before us */
457 /***********************************************************************
458 * wine_server_fd_to_handle (NTDLL.@)
460 * Allocate a file handle for a Unix file descriptor.
463 * fd [I] Unix file descriptor.
464 * access [I] Win32 access flags.
465 * inherit [I] Indicates whether this handle is inherited by child processes.
466 * handle [O] Address where Wine file handle will be stored.
471 int wine_server_fd_to_handle( int fd, unsigned int access, int inherit, obj_handle_t *handle )
476 wine_server_send_fd( fd );
478 SERVER_START_REQ( alloc_file_handle )
480 req->access = access;
481 req->inherit = inherit;
483 if (!(ret = wine_server_call( req ))) *handle = reply->handle;
490 /***********************************************************************
491 * wine_server_handle_to_fd (NTDLL.@)
493 * Retrieve the file descriptor corresponding to a file handle.
496 * handle [I] Wine file handle.
497 * access [I] Win32 file access rights requested.
498 * unix_fd [O] Address where Unix file descriptor will be stored.
499 * flags [O] Address where the Unix flags associated with file will be stored. Optional.
504 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd, int *flags )
506 obj_handle_t fd_handle;
512 SERVER_START_REQ( get_handle_fd )
514 req->handle = handle;
515 req->access = access;
516 if (!(ret = wine_server_call( req ))) fd = reply->fd;
517 if (flags) *flags = reply->flags;
524 /* it wasn't in the cache, get it from the server */
525 fd = receive_fd( &fd_handle );
526 /* and store it back into the cache */
527 ret = store_cached_fd( &fd, fd_handle );
530 if (fd_handle == handle) break;
531 /* if we received a different handle this means there was
532 * a race with another thread; we restart everything from
533 * scratch in this case.
537 if ((fd != -1) && ((fd = dup(fd)) == -1)) return STATUS_TOO_MANY_OPENED_FILES;
539 return STATUS_SUCCESS;
543 /***********************************************************************
544 * wine_server_release_fd (NTDLL.@)
546 * Release the Unix file descriptor returned by wine_server_handle_to_fd.
549 * handle [I] Wine file handle.
550 * unix_fd [I] Unix file descriptor to release.
555 void wine_server_release_fd( obj_handle_t handle, int unix_fd )
561 /***********************************************************************
564 * Start a new wine server.
566 static void start_server( const char *oldcwd )
568 static int started; /* we only try once */
576 if (pid == -1) fatal_perror( "fork" );
579 argv[0] = "wineserver";
580 argv[1] = TRACE_ON(server) ? "-d" : NULL;
582 /* if server is explicitly specified, use this */
583 if ((p = getenv("WINESERVER")))
585 if (p[0] != '/' && oldcwd[0] == '/') /* make it an absolute path */
587 if (!(path = malloc( strlen(oldcwd) + strlen(p) + 1 )))
588 fatal_error( "out of memory\n" );
589 sprintf( path, "%s/%s", oldcwd, p );
592 wine_exec_wine_binary( p, argv, NULL, FALSE );
593 fatal_perror( "could not exec the server '%s'\n"
594 " specified in the WINESERVER environment variable", p );
596 /* now use the standard search strategy */
597 wine_exec_wine_binary( argv[0], argv, NULL, FALSE );
598 fatal_error( "could not exec wineserver\n" );
600 waitpid( pid, &status, 0 );
601 status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
602 if (status == 2) return; /* server lock held by someone else, will retry later */
603 if (status) exit(status); /* server failed */
609 /***********************************************************************
610 * server_connect_error
612 * Try to display a meaningful explanation of why we couldn't connect
615 static void server_connect_error( const char *serverdir )
620 if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
621 fatal_error( "for some mysterious reason, the wine server never started.\n" );
624 fl.l_whence = SEEK_SET;
627 if (fcntl( fd, F_GETLK, &fl ) != -1)
629 if (fl.l_type == F_WRLCK) /* the file is locked */
630 fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
631 " You probably need to kill that process (it might be pid %d).\n",
633 fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
635 fatal_error( "the file system of '%s' doesn't support locks,\n"
636 " and there is a 'socket' file in that directory that prevents wine from starting.\n"
637 " You should make sure no wine server is running, remove that file and try again.\n",
642 /***********************************************************************
645 * Attempt to connect to an existing server socket.
646 * We need to be in the server directory already.
648 static int server_connect( const char *oldcwd, const char *serverdir )
650 struct sockaddr_un addr;
654 /* chdir to the server directory */
655 if (chdir( serverdir ) == -1)
657 if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
659 if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
662 /* make sure we are at the right place */
663 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
664 if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
665 if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
667 for (retry = 0; retry < 6; retry++)
669 /* if not the first try, wait a bit to leave the previous server time to exit */
672 usleep( 100000 * retry * retry );
673 start_server( oldcwd );
674 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
676 else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
678 if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
679 start_server( oldcwd );
680 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
683 /* make sure the socket is sane (ISFIFO needed for Solaris) */
684 if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
685 fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
686 if (st.st_uid != getuid())
687 fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
689 /* try to connect to it */
690 addr.sun_family = AF_UNIX;
691 strcpy( addr.sun_path, SOCKETNAME );
692 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
693 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
696 if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
697 if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
699 fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
704 server_connect_error( serverdir );
708 /***********************************************************************
711 * Remove a directory and all its contents; helper for create_config_dir.
713 static void rm_rf( const char *path )
715 int err = errno; /* preserve errno */
721 if (!(buffer = malloc( strlen(path) + 256 + 1 ))) goto done;
722 strcpy( buffer, path );
723 p = buffer + strlen(buffer);
726 if ((dir = opendir( path )))
728 while ((de = readdir( dir )))
730 if (!strcmp( de->d_name, "." ) || !strcmp( de->d_name, ".." )) continue;
731 strcpy( p, de->d_name );
732 if (unlink( buffer ) != -1) continue;
733 if (errno == EISDIR ||
734 (errno == EPERM && !lstat( buffer, &st ) && S_ISDIR(st.st_mode)))
736 /* recurse in the sub-directory */
749 /***********************************************************************
752 * Create the wine configuration dir (~/.wine).
754 static void create_config_dir(void)
756 const char *config_dir = wine_get_config_dir();
761 if (!(tmp_dir = malloc( strlen(config_dir) + sizeof("-XXXXXX") )))
762 fatal_error( "out of memory\n" );
763 strcpy( tmp_dir, config_dir );
764 strcat( tmp_dir, "-XXXXXX" );
765 if ((fd = mkstemps( tmp_dir, 0 )) == -1)
766 fatal_perror( "can't get temp file name for %s", config_dir );
769 if (mkdir( tmp_dir, 0777 ) == -1)
770 fatal_perror( "cannot create temp dir %s", tmp_dir );
772 MESSAGE( "wine: creating configuration directory '%s'...\n", config_dir );
777 fatal_perror( "fork" );
783 argv[0] = "wineprefixcreate";
786 argv[3] = "--prefix";
789 wine_exec_wine_binary( argv[0], (char **)argv, NULL, FALSE );
791 fatal_perror( "could not exec wineprefixcreate" );
797 while ((wret = waitpid( pid, &status, 0 )) != pid)
799 if (wret == -1 && errno != EINTR) fatal_perror( "wait4" );
801 if (!WIFEXITED(status) || WEXITSTATUS(status))
804 fatal_error( "wineprefixcreate failed while creating '%s'.\n", config_dir );
807 if (rename( tmp_dir, config_dir ) == -1)
810 if (errno != EEXIST && errno != ENOTEMPTY)
811 fatal_perror( "rename '%s' to '%s'", tmp_dir, config_dir );
812 /* else it was probably created by a concurrent wine process */
815 MESSAGE( "wine: '%s' created successfully.\n", config_dir );
819 /***********************************************************************
820 * server_init_process
822 * Start the server and create the initial socket pair.
824 void server_init_process(void)
828 obj_handle_t dummy_handle;
829 const char *server_dir = wine_get_server_dir();
831 if (!server_dir) /* this means the config dir doesn't exist */
834 server_dir = wine_get_server_dir();
837 /* retrieve the current directory */
838 for (size = 512; ; size *= 2)
840 if (!(oldcwd = malloc( size ))) break;
841 if (getcwd( oldcwd, size )) break;
843 if (errno == ERANGE) continue;
848 /* connect to the server */
849 fd_socket = server_connect( oldcwd, server_dir );
851 /* switch back to the starting directory */
858 /* setup the signal mask */
859 sigemptyset( &block_set );
860 sigaddset( &block_set, SIGALRM );
861 sigaddset( &block_set, SIGIO );
862 sigaddset( &block_set, SIGINT );
863 sigaddset( &block_set, SIGHUP );
864 sigaddset( &block_set, SIGUSR1 );
865 sigaddset( &block_set, SIGUSR2 );
866 sigaddset( &block_set, SIGCHLD );
868 /* receive the first thread request fd on the main socket */
869 ntdll_get_thread_data()->request_fd = receive_fd( &dummy_handle );
873 /***********************************************************************
876 * Send an init thread request. Return 0 if OK.
878 size_t server_init_thread( int unix_pid, int unix_tid, void *entry_point )
882 struct sigaction sig_act;
885 sig_act.sa_handler = SIG_IGN;
886 sig_act.sa_flags = 0;
887 sigemptyset( &sig_act.sa_mask );
889 /* ignore SIGPIPE so that we get an EPIPE error instead */
890 sigaction( SIGPIPE, &sig_act, NULL );
891 /* automatic child reaping to avoid zombies */
893 sig_act.sa_flags |= SA_NOCLDWAIT;
895 sigaction( SIGCHLD, &sig_act, NULL );
897 /* create the server->client communication pipes */
898 if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
899 if (pipe( ntdll_get_thread_data()->wait_fd ) == -1) server_protocol_perror( "pipe" );
900 wine_server_send_fd( reply_pipe[1] );
901 wine_server_send_fd( ntdll_get_thread_data()->wait_fd[1] );
902 ntdll_get_thread_data()->reply_fd = reply_pipe[0];
903 close( reply_pipe[1] );
905 /* set close on exec flag */
906 fcntl( ntdll_get_thread_data()->reply_fd, F_SETFD, 1 );
907 fcntl( ntdll_get_thread_data()->wait_fd[0], F_SETFD, 1 );
908 fcntl( ntdll_get_thread_data()->wait_fd[1], F_SETFD, 1 );
910 SERVER_START_REQ( init_thread )
912 req->unix_pid = unix_pid;
913 req->unix_tid = unix_tid;
914 req->teb = NtCurrentTeb();
915 req->peb = NtCurrentTeb()->Peb;
916 req->entry = entry_point;
917 req->ldt_copy = &wine_ldt_copy;
918 req->reply_fd = reply_pipe[1];
919 req->wait_fd = ntdll_get_thread_data()->wait_fd[1];
920 req->debug_level = (TRACE_ON(server) != 0);
921 ret = wine_server_call( req );
922 NtCurrentTeb()->ClientId.UniqueProcess = (HANDLE)reply->pid;
923 NtCurrentTeb()->ClientId.UniqueThread = (HANDLE)reply->tid;
924 info_size = reply->info_size;
925 version = reply->version;
926 server_start_time = reply->server_start;
930 if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
931 if (version != SERVER_PROTOCOL_VERSION)
932 server_protocol_error( "version mismatch %d/%d.\n"
933 "Your %s binary was not upgraded correctly,\n"
934 "or you have an older one somewhere in your PATH.\n"
935 "Or maybe the wrong wineserver is still running?\n",
936 version, SERVER_PROTOCOL_VERSION,
937 (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );