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"
31 #include <sys/types.h>
32 #ifdef HAVE_SYS_SOCKET_H
33 # include <sys/socket.h>
35 #ifdef HAVE_SYS_WAIT_H
41 #ifdef HAVE_SYS_MMAN_H
55 #include "wine/library.h"
56 #include "wine/pthread.h"
57 #include "wine/server.h"
59 #include "ntdll_misc.h"
61 /* Some versions of glibc don't define this */
66 #define SOCKETNAME "socket" /* name of the socket file */
67 #define LOCKNAME "lock" /* name of the lock file */
69 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
70 /* data structure used to pass an fd with sendmsg/recvmsg */
73 int len; /* size of structure */
74 int level; /* SOL_SOCKET */
75 int type; /* SCM_RIGHTS */
76 int fd; /* fd to pass */
78 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
80 static sigset_t block_set; /* signals to block during server calls */
81 static int fd_socket = -1; /* socket to exchange file descriptors with the server */
84 static void fatal_error( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
85 static void fatal_perror( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
86 static void server_connect_error( const char *serverdir ) __attribute__((noreturn));
89 /* die on a fatal error; use only during initialization */
90 static void fatal_error( const char *err, ... )
94 va_start( args, err );
95 fprintf( stderr, "wine: " );
96 vfprintf( stderr, err, args );
101 /* die on a fatal error; use only during initialization */
102 static void fatal_perror( const char *err, ... )
106 va_start( args, err );
107 fprintf( stderr, "wine: " );
108 vfprintf( stderr, err, args );
115 /***********************************************************************
116 * server_abort_thread
118 void server_abort_thread( int status )
120 sigprocmask( SIG_BLOCK, &block_set, NULL );
121 close( NtCurrentTeb()->wait_fd[0] );
122 close( NtCurrentTeb()->wait_fd[1] );
123 close( NtCurrentTeb()->reply_fd );
124 close( NtCurrentTeb()->request_fd );
125 wine_pthread_abort_thread( status );
129 /***********************************************************************
130 * server_protocol_error
132 void server_protocol_error( const char *err, ... )
136 va_start( args, err );
137 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
138 vfprintf( stderr, err, args );
140 server_abort_thread(1);
144 /***********************************************************************
145 * server_protocol_perror
147 void server_protocol_perror( const char *err )
149 fprintf( stderr, "wine client error:%lx: ", GetCurrentThreadId() );
151 server_abort_thread(1);
155 /***********************************************************************
158 * Send a request to the server.
160 static void send_request( const struct __server_request_info *req )
164 if (!req->u.req.request_header.request_size)
166 if ((ret = write( NtCurrentTeb()->request_fd, &req->u.req,
167 sizeof(req->u.req) )) == sizeof(req->u.req)) return;
172 struct iovec vec[__SERVER_MAX_DATA+1];
174 vec[0].iov_base = (void *)&req->u.req;
175 vec[0].iov_len = sizeof(req->u.req);
176 for (i = 0; i < req->data_count; i++)
178 vec[i+1].iov_base = (void *)req->data[i].ptr;
179 vec[i+1].iov_len = req->data[i].size;
181 if ((ret = writev( NtCurrentTeb()->request_fd, vec, i+1 )) ==
182 req->u.req.request_header.request_size + sizeof(req->u.req)) return;
185 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
186 if (errno == EPIPE) server_abort_thread(0);
187 server_protocol_perror( "sendmsg" );
191 /***********************************************************************
194 * Read data from the reply buffer; helper for wait_reply.
196 static void read_reply_data( void *buffer, size_t size )
202 if ((ret = read( NtCurrentTeb()->reply_fd, buffer, size )) > 0)
204 if (!(size -= ret)) return;
205 buffer = (char *)buffer + ret;
209 if (errno == EINTR) continue;
210 if (errno == EPIPE) break;
211 server_protocol_perror("read");
213 /* the server closed the connection; time to die... */
214 server_abort_thread(0);
218 /***********************************************************************
221 * Wait for a reply from the server.
223 inline static void wait_reply( struct __server_request_info *req )
225 read_reply_data( &req->u.reply, sizeof(req->u.reply) );
226 if (req->u.reply.reply_header.reply_size)
227 read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
231 /***********************************************************************
232 * wine_server_call (NTDLL.@)
234 * Perform a server call.
236 unsigned int wine_server_call( void *req_ptr )
238 struct __server_request_info * const req = req_ptr;
241 sigprocmask( SIG_BLOCK, &block_set, &old_set );
244 sigprocmask( SIG_SETMASK, &old_set, NULL );
245 return req->u.reply.reply_header.error;
249 /***********************************************************************
250 * wine_server_send_fd
252 * Send a file descriptor to the server.
254 void wine_server_send_fd( int fd )
256 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
260 struct msghdr msghdr;
264 vec.iov_base = (void *)&data;
265 vec.iov_len = sizeof(data);
267 msghdr.msg_name = NULL;
268 msghdr.msg_namelen = 0;
269 msghdr.msg_iov = &vec;
270 msghdr.msg_iovlen = 1;
272 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
273 msghdr.msg_accrights = (void *)&fd;
274 msghdr.msg_accrightslen = sizeof(fd);
275 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
276 cmsg.len = sizeof(cmsg);
277 cmsg.level = SOL_SOCKET;
278 cmsg.type = SCM_RIGHTS;
280 msghdr.msg_control = &cmsg;
281 msghdr.msg_controllen = sizeof(cmsg);
282 msghdr.msg_flags = 0;
283 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
285 data.tid = GetCurrentThreadId();
290 if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
291 if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
292 if (errno == EINTR) continue;
293 if (errno == EPIPE) server_abort_thread(0);
294 server_protocol_perror( "sendmsg" );
299 /***********************************************************************
302 * Receive a file descriptor passed from the server.
304 static int receive_fd( obj_handle_t *handle )
309 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
310 struct msghdr msghdr;
313 msghdr.msg_accrights = (void *)&fd;
314 msghdr.msg_accrightslen = sizeof(fd);
315 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
316 struct msghdr msghdr;
319 cmsg.len = sizeof(cmsg);
320 cmsg.level = SOL_SOCKET;
321 cmsg.type = SCM_RIGHTS;
323 msghdr.msg_control = &cmsg;
324 msghdr.msg_controllen = sizeof(cmsg);
325 msghdr.msg_flags = 0;
326 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
328 msghdr.msg_name = NULL;
329 msghdr.msg_namelen = 0;
330 msghdr.msg_iov = &vec;
331 msghdr.msg_iovlen = 1;
332 vec.iov_base = (void *)handle;
333 vec.iov_len = sizeof(*handle);
337 if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
339 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
342 if (fd == -1) server_protocol_error( "no fd received for handle %d\n", *handle );
343 fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
347 if (errno == EINTR) continue;
348 if (errno == EPIPE) break;
349 server_protocol_perror("recvmsg");
351 /* the server closed the connection; time to die... */
352 server_abort_thread(0);
356 /***********************************************************************
359 * Store the cached fd value for a given handle back into the server.
360 * Returns the new fd, which can be different if there was already an
361 * fd in the cache for that handle.
363 inline static int store_cached_fd( int fd, obj_handle_t handle )
365 SERVER_START_REQ( set_handle_info )
367 req->handle = handle;
371 if (!wine_server_call( req ))
373 if (reply->cur_fd != fd)
375 /* someone was here before us */
391 /***********************************************************************
392 * wine_server_fd_to_handle (NTDLL.@)
394 * Allocate a file handle for a Unix fd.
396 int wine_server_fd_to_handle( int fd, unsigned int access, int inherit, obj_handle_t *handle )
401 wine_server_send_fd( fd );
403 SERVER_START_REQ( alloc_file_handle )
405 req->access = access;
406 req->inherit = inherit;
408 if (!(ret = wine_server_call( req ))) *handle = reply->handle;
415 /***********************************************************************
416 * wine_server_handle_to_fd (NTDLL.@)
418 * Retrieve the Unix fd corresponding to a file handle.
420 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd,
421 enum fd_type *type, int *flags )
423 obj_handle_t fd_handle;
429 SERVER_START_REQ( get_handle_fd )
431 req->handle = handle;
432 req->access = access;
433 if (!(ret = wine_server_call( req ))) fd = reply->fd;
434 if (type) *type = reply->type;
435 if (flags) *flags = reply->flags;
442 /* it wasn't in the cache, get it from the server */
443 fd = receive_fd( &fd_handle );
444 /* and store it back into the cache */
445 fd = store_cached_fd( fd, fd_handle );
447 if (fd_handle == handle) break;
448 /* if we received a different handle this means there was
449 * a race with another thread; we restart everything from
450 * scratch in this case.
454 if ((fd != -1) && ((fd = dup(fd)) == -1)) return STATUS_TOO_MANY_OPENED_FILES;
456 return STATUS_SUCCESS;
460 /***********************************************************************
463 * Start a new wine server.
465 static void start_server( const char *oldcwd )
467 static int started; /* we only try once */
475 if (pid == -1) fatal_perror( "fork" );
478 /* if server is explicitly specified, use this */
479 if ((p = getenv("WINESERVER")))
481 if (p[0] != '/' && oldcwd[0] == '/') /* make it an absolute path */
483 if (!(path = malloc( strlen(oldcwd) + strlen(p) + 1 )))
484 fatal_error( "out of memory\n" );
485 sprintf( path, "%s/%s", oldcwd, p );
489 fatal_perror( "could not exec the server '%s'\n"
490 " specified in the WINESERVER environment variable", p );
492 /* now use the standard search strategy */
493 argv[0] = "wineserver";
495 wine_exec_wine_binary( "wineserver", argv, NULL );
496 fatal_error( "could not exec wineserver\n" );
498 waitpid( pid, &status, 0 );
499 status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
500 if (status == 2) return; /* server lock held by someone else, will retry later */
501 if (status) exit(status); /* server failed */
507 /***********************************************************************
508 * server_connect_error
510 * Try to display a meaningful explanation of why we couldn't connect
513 static void server_connect_error( const char *serverdir )
518 if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
519 fatal_error( "for some mysterious reason, the wine server never started.\n" );
522 fl.l_whence = SEEK_SET;
525 if (fcntl( fd, F_GETLK, &fl ) != -1)
527 if (fl.l_type == F_WRLCK) /* the file is locked */
528 fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
529 " You probably need to kill that process (it might be pid %d).\n",
531 fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
533 fatal_error( "the file system of '%s' doesn't support locks,\n"
534 " and there is a 'socket' file in that directory that prevents wine from starting.\n"
535 " You should make sure no wine server is running, remove that file and try again.\n",
540 /***********************************************************************
543 * Attempt to connect to an existing server socket.
544 * We need to be in the server directory already.
546 static int server_connect( const char *oldcwd, const char *serverdir )
548 struct sockaddr_un addr;
552 /* chdir to the server directory */
553 if (chdir( serverdir ) == -1)
555 if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
557 if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
560 /* make sure we are at the right place */
561 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
562 if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
563 if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
565 for (retry = 0; retry < 6; retry++)
567 /* if not the first try, wait a bit to leave the previous server time to exit */
570 usleep( 100000 * retry * retry );
571 start_server( oldcwd );
572 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
574 else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
576 if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
577 start_server( oldcwd );
578 if (lstat( SOCKETNAME, &st ) == -1) continue; /* still no socket, wait a bit more */
581 /* make sure the socket is sane (ISFIFO needed for Solaris) */
582 if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
583 fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
584 if (st.st_uid != getuid())
585 fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
587 /* try to connect to it */
588 addr.sun_family = AF_UNIX;
589 strcpy( addr.sun_path, SOCKETNAME );
590 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
591 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
594 if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
595 if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
597 fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
602 server_connect_error( serverdir );
606 /***********************************************************************
607 * server_init_process
609 * Start the server and create the initial socket pair.
611 void server_init_process(void)
615 obj_handle_t dummy_handle;
617 /* retrieve the current directory */
618 for (size = 512; ; size *= 2)
620 if (!(oldcwd = malloc( size ))) break;
621 if (getcwd( oldcwd, size )) break;
623 if (errno == ERANGE) continue;
628 /* connect to the server */
629 fd_socket = server_connect( oldcwd, wine_get_server_dir() );
631 /* switch back to the starting directory */
638 /* setup the signal mask */
639 sigemptyset( &block_set );
640 sigaddset( &block_set, SIGALRM );
641 sigaddset( &block_set, SIGIO );
642 sigaddset( &block_set, SIGINT );
643 sigaddset( &block_set, SIGHUP );
644 sigaddset( &block_set, SIGUSR1 );
645 sigaddset( &block_set, SIGUSR2 );
647 /* receive the first thread request fd on the main socket */
648 NtCurrentTeb()->request_fd = receive_fd( &dummy_handle );
652 /***********************************************************************
655 * Send an init thread request. Return 0 if OK.
657 void server_init_thread( int unix_pid, int unix_tid )
659 TEB *teb = NtCurrentTeb();
662 struct sigaction sig_act;
664 sig_act.sa_handler = SIG_IGN;
665 sig_act.sa_flags = 0;
666 sigemptyset( &sig_act.sa_mask );
668 /* ignore SIGPIPE so that we get a EPIPE error instead */
669 sigaction( SIGPIPE, &sig_act, NULL );
670 /* automatic child reaping to avoid zombies */
672 sig_act.sa_flags |= SA_NOCLDWAIT;
674 sigaction( SIGCHLD, &sig_act, NULL );
676 /* create the server->client communication pipes */
677 if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
678 if (pipe( teb->wait_fd ) == -1) server_protocol_perror( "pipe" );
679 wine_server_send_fd( reply_pipe[1] );
680 wine_server_send_fd( teb->wait_fd[1] );
681 teb->reply_fd = reply_pipe[0];
682 close( reply_pipe[1] );
684 /* set close on exec flag */
685 fcntl( teb->reply_fd, F_SETFD, 1 );
686 fcntl( teb->wait_fd[0], F_SETFD, 1 );
687 fcntl( teb->wait_fd[1], F_SETFD, 1 );
689 SERVER_START_REQ( init_thread )
691 req->unix_pid = unix_pid;
692 req->unix_tid = unix_tid;
694 req->entry = teb->entry_point;
695 req->reply_fd = reply_pipe[1];
696 req->wait_fd = teb->wait_fd[1];
697 ret = wine_server_call( req );
698 teb->ClientId.UniqueProcess = (HANDLE)reply->pid;
699 teb->ClientId.UniqueThread = (HANDLE)reply->tid;
700 version = reply->version;
704 if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
705 if (version != SERVER_PROTOCOL_VERSION)
706 server_protocol_error( "version mismatch %d/%d.\n"
707 "Your %s binary was not upgraded correctly,\n"
708 "or you have an older one somewhere in your PATH.\n"
709 "Or maybe the wrong wineserver is still running?\n",
710 version, SERVER_PROTOCOL_VERSION,
711 (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );