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
56 #include "wine/library.h"
57 #include "wine/pthread.h"
58 #include "wine/server.h"
59 #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 * server_abort_thread
122 void server_abort_thread( int status )
124 sigprocmask( SIG_BLOCK, &block_set, NULL );
125 close( NtCurrentTeb()->wait_fd[0] );
126 close( NtCurrentTeb()->wait_fd[1] );
127 close( NtCurrentTeb()->reply_fd );
128 close( NtCurrentTeb()->request_fd );
129 wine_pthread_abort_thread( status );
133 /***********************************************************************
134 * server_protocol_error
136 void server_protocol_error( const char *err, ... )
140 va_start( args, err );
141 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
142 vfprintf( stderr, err, args );
144 server_abort_thread(1);
148 /***********************************************************************
149 * server_protocol_perror
151 void server_protocol_perror( const char *err )
153 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
155 server_abort_thread(1);
159 /***********************************************************************
162 * Send a request to the server.
164 static void send_request( const struct __server_request_info *req )
169 if (!req->u.req.request_header.request_size)
171 if ((ret = write( NtCurrentTeb()->request_fd, &req->u.req,
172 sizeof(req->u.req) )) == sizeof(req->u.req)) return;
177 struct iovec vec[__SERVER_MAX_DATA+1];
179 vec[0].iov_base = (void *)&req->u.req;
180 vec[0].iov_len = sizeof(req->u.req);
181 for (i = 0; i < req->data_count; i++)
183 vec[i+1].iov_base = (void *)req->data[i].ptr;
184 vec[i+1].iov_len = req->data[i].size;
186 if ((ret = writev( NtCurrentTeb()->request_fd, vec, i+1 )) ==
187 req->u.req.request_header.request_size + sizeof(req->u.req)) return;
190 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
191 if (errno == EPIPE) server_abort_thread(0);
192 server_protocol_perror( "write" );
196 /***********************************************************************
199 * Read data from the reply buffer; helper for wait_reply.
201 static void read_reply_data( void *buffer, size_t size )
207 if ((ret = read( NtCurrentTeb()->reply_fd, buffer, size )) > 0)
209 if (!(size -= ret)) return;
210 buffer = (char *)buffer + ret;
214 if (errno == EINTR) continue;
215 if (errno == EPIPE) break;
216 server_protocol_perror("read");
218 /* the server closed the connection; time to die... */
219 server_abort_thread(0);
223 /***********************************************************************
226 * Wait for a reply from the server.
228 inline static void wait_reply( struct __server_request_info *req )
230 read_reply_data( &req->u.reply, sizeof(req->u.reply) );
231 if (req->u.reply.reply_header.reply_size)
232 read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
236 /***********************************************************************
237 * wine_server_call (NTDLL.@)
239 * Perform a server call.
242 * req_ptr [I/O] Function dependent data
245 * Depends on server function being called, but usually an NTSTATUS code.
248 * Use the SERVER_START_REQ and SERVER_END_REQ to help you fill out the
249 * server request structure for the particular call. E.g:
250 *| SERVER_START_REQ( event_op )
252 *| req->handle = handle;
253 *| req->op = SET_EVENT;
254 *| ret = wine_server_call( req );
258 unsigned int wine_server_call( void *req_ptr )
260 struct __server_request_info * const req = req_ptr;
263 sigprocmask( SIG_BLOCK, &block_set, &old_set );
266 sigprocmask( SIG_SETMASK, &old_set, NULL );
267 return req->u.reply.reply_header.error;
271 /***********************************************************************
272 * wine_server_send_fd (NTDLL.@)
274 * Send a file descriptor to the server.
277 * fd [I] file descriptor to send
282 void wine_server_send_fd( int fd )
284 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
288 struct msghdr msghdr;
292 vec.iov_base = (void *)&data;
293 vec.iov_len = sizeof(data);
295 msghdr.msg_name = NULL;
296 msghdr.msg_namelen = 0;
297 msghdr.msg_iov = &vec;
298 msghdr.msg_iovlen = 1;
300 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
301 msghdr.msg_accrights = (void *)&fd;
302 msghdr.msg_accrightslen = sizeof(fd);
303 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
304 cmsg.len = sizeof(cmsg);
305 cmsg.level = SOL_SOCKET;
306 cmsg.type = SCM_RIGHTS;
308 msghdr.msg_control = &cmsg;
309 msghdr.msg_controllen = sizeof(cmsg);
310 msghdr.msg_flags = 0;
311 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
313 data.tid = GetCurrentThreadId();
318 if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
319 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
320 if (errno == EINTR) continue;
321 if (errno == EPIPE) server_abort_thread(0);
322 server_protocol_perror( "sendmsg" );
327 /***********************************************************************
330 * Receive a file descriptor passed from the server.
332 static int receive_fd( obj_handle_t *handle )
337 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
338 struct msghdr msghdr;
341 msghdr.msg_accrights = (void *)&fd;
342 msghdr.msg_accrightslen = sizeof(fd);
343 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
344 struct msghdr msghdr;
347 cmsg.len = sizeof(cmsg);
348 cmsg.level = SOL_SOCKET;
349 cmsg.type = SCM_RIGHTS;
351 msghdr.msg_control = &cmsg;
352 msghdr.msg_controllen = sizeof(cmsg);
353 msghdr.msg_flags = 0;
354 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
356 msghdr.msg_name = NULL;
357 msghdr.msg_namelen = 0;
358 msghdr.msg_iov = &vec;
359 msghdr.msg_iovlen = 1;
360 vec.iov_base = (void *)handle;
361 vec.iov_len = sizeof(*handle);
365 if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
367 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
370 if (fd == -1) server_protocol_error( "no fd received for handle %d\n", *handle );
371 fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
375 if (errno == EINTR) continue;
376 if (errno == EPIPE) break;
377 server_protocol_perror("recvmsg");
379 /* the server closed the connection; time to die... */
380 server_abort_thread(0);
384 /***********************************************************************
387 * Store the cached fd value for a given handle back into the server.
388 * Returns the new fd, which can be different if there was already an
389 * fd in the cache for that handle.
391 inline static int store_cached_fd( int *fd, obj_handle_t handle )
395 SERVER_START_REQ( set_handle_info )
397 req->handle = handle;
401 if (!(ret = wine_server_call( req )))
403 if (reply->cur_fd != *fd)
405 /* someone was here before us */
421 /***********************************************************************
422 * wine_server_fd_to_handle (NTDLL.@)
424 * Allocate a file handle for a Unix file descriptor.
427 * fd [I] Unix file descriptor.
428 * access [I] Win32 access flags.
429 * inherit [I] Indicates whether this handle is inherited by child processes.
430 * handle [O] Address where Wine file handle will be stored.
435 int wine_server_fd_to_handle( int fd, unsigned int access, int inherit, obj_handle_t *handle )
440 wine_server_send_fd( fd );
442 SERVER_START_REQ( alloc_file_handle )
444 req->access = access;
445 req->inherit = inherit;
447 if (!(ret = wine_server_call( req ))) *handle = reply->handle;
454 /***********************************************************************
455 * wine_server_handle_to_fd (NTDLL.@)
457 * Retrieve the file descriptor corresponding to a file handle.
460 * handle [I] Wine file handle.
461 * access [I] Win32 file access rights requested.
462 * unix_fd [O] Address where Unix file descriptor will be stored.
463 * flags [O] Address where the Unix flags associated with file will be stored. Optional.
468 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd, int *flags )
470 obj_handle_t fd_handle;
476 SERVER_START_REQ( get_handle_fd )
478 req->handle = handle;
479 req->access = access;
480 if (!(ret = wine_server_call( req ))) fd = reply->fd;
481 if (flags) *flags = reply->flags;
488 /* it wasn't in the cache, get it from the server */
489 fd = receive_fd( &fd_handle );
490 /* and store it back into the cache */
491 ret = store_cached_fd( &fd, fd_handle );
494 if (fd_handle == handle) break;
495 /* if we received a different handle this means there was
496 * a race with another thread; we restart everything from
497 * scratch in this case.
501 if ((fd != -1) && ((fd = dup(fd)) == -1)) return STATUS_TOO_MANY_OPENED_FILES;
503 return STATUS_SUCCESS;
507 /***********************************************************************
508 * wine_server_release_fd (NTDLL.@)
510 * Release the Unix file descriptor returned by wine_server_handle_to_fd.
513 * handle [I] Wine file handle.
514 * unix_fd [I] Unix file descriptor to release.
519 void wine_server_release_fd( obj_handle_t handle, int unix_fd )
525 /***********************************************************************
528 * Start a new wine server.
530 static void start_server( const char *oldcwd )
532 static int started; /* we only try once */
540 if (pid == -1) fatal_perror( "fork" );
543 argv[0] = "wineserver";
544 argv[1] = TRACE_ON(server) ? "-d" : NULL;
546 /* if server is explicitly specified, use this */
547 if ((p = getenv("WINESERVER")))
549 if (p[0] != '/' && oldcwd[0] == '/') /* make it an absolute path */
551 if (!(path = malloc( strlen(oldcwd) + strlen(p) + 1 )))
552 fatal_error( "out of memory\n" );
553 sprintf( path, "%s/%s", oldcwd, p );
556 wine_exec_wine_binary( p, argv, NULL, FALSE );
557 fatal_perror( "could not exec the server '%s'\n"
558 " specified in the WINESERVER environment variable", p );
560 /* now use the standard search strategy */
561 wine_exec_wine_binary( argv[0], argv, NULL, FALSE );
562 fatal_error( "could not exec wineserver\n" );
564 waitpid( pid, &status, 0 );
565 status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
566 if (status == 2) return; /* server lock held by someone else, will retry later */
567 if (status) exit(status); /* server failed */
573 /***********************************************************************
574 * server_connect_error
576 * Try to display a meaningful explanation of why we couldn't connect
579 static void server_connect_error( const char *serverdir )
584 if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
585 fatal_error( "for some mysterious reason, the wine server never started.\n" );
588 fl.l_whence = SEEK_SET;
591 if (fcntl( fd, F_GETLK, &fl ) != -1)
593 if (fl.l_type == F_WRLCK) /* the file is locked */
594 fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
595 " You probably need to kill that process (it might be pid %d).\n",
597 fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
599 fatal_error( "the file system of '%s' doesn't support locks,\n"
600 " and there is a 'socket' file in that directory that prevents wine from starting.\n"
601 " You should make sure no wine server is running, remove that file and try again.\n",
606 /***********************************************************************
609 * Attempt to connect to an existing server socket.
610 * We need to be in the server directory already.
612 static int server_connect( const char *oldcwd, const char *serverdir )
614 struct sockaddr_un addr;
618 /* chdir to the server directory */
619 if (chdir( serverdir ) == -1)
621 if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
623 if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
626 /* make sure we are at the right place */
627 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
628 if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
629 if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
631 for (retry = 0; retry < 6; retry++)
633 /* if not the first try, wait a bit to leave the previous server time to exit */
636 usleep( 100000 * retry * retry );
637 start_server( oldcwd );
638 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
640 else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
642 if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
643 start_server( oldcwd );
644 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
647 /* make sure the socket is sane (ISFIFO needed for Solaris) */
648 if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
649 fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
650 if (st.st_uid != getuid())
651 fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
653 /* try to connect to it */
654 addr.sun_family = AF_UNIX;
655 strcpy( addr.sun_path, SOCKETNAME );
656 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
657 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
660 if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
661 if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
663 fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
668 server_connect_error( serverdir );
672 /***********************************************************************
675 * Remove a directory and all its contents; helper for create_config_dir.
677 static void rm_rf( const char *path )
679 int err = errno; /* preserve errno */
685 if (!(buffer = malloc( strlen(path) + 256 + 1 ))) goto done;
686 strcpy( buffer, path );
687 p = buffer + strlen(buffer);
690 if ((dir = opendir( path )))
692 while ((de = readdir( dir )))
694 if (!strcmp( de->d_name, "." ) || !strcmp( de->d_name, ".." )) continue;
695 strcpy( p, de->d_name );
696 if (unlink( buffer ) != -1) continue;
697 if (errno == EISDIR ||
698 (errno == EPERM && !lstat( buffer, &st ) && S_ISDIR(st.st_mode)))
700 /* recurse in the sub-directory */
713 /***********************************************************************
716 * Create the wine configuration dir (~/.wine).
718 static void create_config_dir(void)
720 const char *config_dir = wine_get_config_dir();
725 if (!(tmp_dir = malloc( strlen(config_dir) + sizeof("-XXXXXX") )))
726 fatal_error( "out of memory\n" );
727 strcpy( tmp_dir, config_dir );
728 strcat( tmp_dir, "-XXXXXX" );
729 if ((fd = mkstemps( tmp_dir, 0 )) == -1)
730 fatal_perror( "can't get temp file name for %s", config_dir );
733 if (mkdir( tmp_dir, 0777 ) == -1)
734 fatal_perror( "cannot create temp dir %s", tmp_dir );
736 MESSAGE( "wine: creating configuration directory '%s'...\n", config_dir );
741 fatal_perror( "fork" );
747 argv[0] = "wineprefixcreate";
749 argv[2] = "--prefix";
752 wine_exec_wine_binary( argv[0], (char **)argv, NULL, FALSE );
754 fatal_perror( "could not exec wineprefixcreate" );
760 while ((wret = waitpid( pid, &status, 0 )) != pid)
762 if (wret == -1 && errno != EINTR) fatal_perror( "wait4" );
764 if (!WIFEXITED(status) || WEXITSTATUS(status))
767 fatal_error( "wineprefixcreate failed while creating '%s'.\n", config_dir );
770 if (rename( tmp_dir, config_dir ) == -1)
773 if (errno != EEXIST && errno != ENOTEMPTY)
774 fatal_perror( "rename '%s' to '%s'", tmp_dir, config_dir );
775 /* else it was probably created by a concurrent wine process */
778 MESSAGE( "wine: '%s' created successfully.\n", config_dir );
782 /***********************************************************************
783 * server_init_process
785 * Start the server and create the initial socket pair.
787 void server_init_process(void)
791 obj_handle_t dummy_handle;
792 const char *server_dir = wine_get_server_dir();
794 if (!server_dir) /* this means the config dir doesn't exist */
797 server_dir = wine_get_server_dir();
800 /* retrieve the current directory */
801 for (size = 512; ; size *= 2)
803 if (!(oldcwd = malloc( size ))) break;
804 if (getcwd( oldcwd, size )) break;
806 if (errno == ERANGE) continue;
811 /* connect to the server */
812 fd_socket = server_connect( oldcwd, server_dir );
814 /* switch back to the starting directory */
821 /* setup the signal mask */
822 sigemptyset( &block_set );
823 sigaddset( &block_set, SIGALRM );
824 sigaddset( &block_set, SIGIO );
825 sigaddset( &block_set, SIGINT );
826 sigaddset( &block_set, SIGHUP );
827 sigaddset( &block_set, SIGUSR1 );
828 sigaddset( &block_set, SIGUSR2 );
830 /* receive the first thread request fd on the main socket */
831 NtCurrentTeb()->request_fd = receive_fd( &dummy_handle );
835 /***********************************************************************
838 * Send an init thread request. Return 0 if OK.
840 void server_init_thread( int unix_pid, int unix_tid, void *entry_point )
842 TEB *teb = NtCurrentTeb();
845 struct sigaction sig_act;
847 sig_act.sa_handler = SIG_IGN;
848 sig_act.sa_flags = 0;
849 sigemptyset( &sig_act.sa_mask );
851 /* ignore SIGPIPE so that we get a EPIPE error instead */
852 sigaction( SIGPIPE, &sig_act, NULL );
853 /* automatic child reaping to avoid zombies */
855 sig_act.sa_flags |= SA_NOCLDWAIT;
857 sigaction( SIGCHLD, &sig_act, NULL );
859 /* create the server->client communication pipes */
860 if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
861 if (pipe( teb->wait_fd ) == -1) server_protocol_perror( "pipe" );
862 wine_server_send_fd( reply_pipe[1] );
863 wine_server_send_fd( teb->wait_fd[1] );
864 teb->reply_fd = reply_pipe[0];
865 close( reply_pipe[1] );
867 /* set close on exec flag */
868 fcntl( teb->reply_fd, F_SETFD, 1 );
869 fcntl( teb->wait_fd[0], F_SETFD, 1 );
870 fcntl( teb->wait_fd[1], F_SETFD, 1 );
872 SERVER_START_REQ( init_thread )
874 req->unix_pid = unix_pid;
875 req->unix_tid = unix_tid;
877 req->entry = entry_point;
878 req->reply_fd = reply_pipe[1];
879 req->wait_fd = teb->wait_fd[1];
880 ret = wine_server_call( req );
881 teb->ClientId.UniqueProcess = (HANDLE)reply->pid;
882 teb->ClientId.UniqueThread = (HANDLE)reply->tid;
883 version = reply->version;
887 if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
888 if (version != SERVER_PROTOCOL_VERSION)
889 server_protocol_error( "version mismatch %d/%d.\n"
890 "Your %s binary was not upgraded correctly,\n"
891 "or you have an older one somewhere in your PATH.\n"
892 "Or maybe the wrong wineserver is still running?\n",
893 version, SERVER_PROTOCOL_VERSION,
894 (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );