2 * Server-side request handling
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/port.h"
37 #include <sys/types.h>
38 #ifdef HAVE_SYS_SOCKET_H
39 # include <sys/socket.h>
41 #ifdef HAVE_SYS_WAIT_H
42 # include <sys/wait.h>
56 #define WIN32_NO_STATUS
61 #include "wine/library.h"
65 #define WANT_REQUEST_HANDLERS
68 /* Some versions of glibc don't define this */
73 /* path names for server master Unix socket */
74 static const char * const server_socket_name = "socket"; /* name of the socket file */
75 static const char * const server_lock_name = "lock"; /* name of the server lock file */
79 struct object obj; /* object header */
80 struct fd *fd; /* file descriptor of the master socket */
81 struct timeout_user *timeout; /* timeout on last process exit */
84 static void master_socket_dump( struct object *obj, int verbose );
85 static void master_socket_destroy( struct object *obj );
86 static void master_socket_poll_event( struct fd *fd, int event );
88 static const struct object_ops master_socket_ops =
90 sizeof(struct master_socket), /* size */
91 master_socket_dump, /* dump */
92 no_get_type, /* get_type */
93 no_add_queue, /* add_queue */
94 NULL, /* remove_queue */
97 no_signal, /* signal */
98 no_get_fd, /* get_fd */
99 no_map_access, /* map_access */
100 default_get_sd, /* get_sd */
101 default_set_sd, /* set_sd */
102 no_lookup_name, /* lookup_name */
103 no_open_file, /* open_file */
104 no_close_handle, /* close_handle */
105 master_socket_destroy /* destroy */
108 static const struct fd_ops master_socket_fd_ops =
110 NULL, /* get_poll_events */
111 master_socket_poll_event, /* poll_event */
113 NULL, /* get_fd_type */
115 NULL, /* queue_async */
116 NULL, /* reselect_async */
117 NULL /* cancel_async */
121 struct thread *current = NULL; /* thread handling the current request */
122 unsigned int global_error = 0; /* global error code for when no thread is current */
123 timeout_t server_start_time = 0; /* server startup time */
125 static struct master_socket *master_socket; /* the master socket object */
126 static int force_shutdown;
128 /* socket communication static structures */
129 static struct iovec myiovec;
130 static struct msghdr msghdr;
131 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
136 size_t len; /* size of structure */
137 int level; /* SOL_SOCKET */
138 int type; /* SCM_RIGHTS */
140 int fd; /* fd to pass */
142 static struct cmsg_fd cmsg = { { sizeof(cmsg.header) + sizeof(cmsg.fd), SOL_SOCKET, SCM_RIGHTS }, -1 };
143 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
145 /* complain about a protocol error and terminate the client connection */
146 void fatal_protocol_error( struct thread *thread, const char *err, ... )
150 va_start( args, err );
151 fprintf( stderr, "Protocol error:%04x: ", thread->id );
152 vfprintf( stderr, err, args );
154 thread->exit_code = 1;
155 kill_thread( thread, 1 );
158 /* complain about a protocol error and terminate the client connection */
159 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
163 va_start( args, err );
164 fprintf( stderr, "Protocol error:%04x: ", thread->id );
165 vfprintf( stderr, err, args );
168 thread->exit_code = 1;
169 kill_thread( thread, 1 );
172 /* die on a fatal error */
173 void fatal_error( const char *err, ... )
177 va_start( args, err );
178 fprintf( stderr, "wineserver: " );
179 vfprintf( stderr, err, args );
184 /* die on a fatal error */
185 void fatal_perror( const char *err, ... )
189 va_start( args, err );
190 fprintf( stderr, "wineserver: " );
191 vfprintf( stderr, err, args );
197 /* allocate the reply data */
198 void *set_reply_data_size( data_size_t size )
200 assert( size <= get_reply_max_size() );
201 if (size && !(current->reply_data = mem_alloc( size ))) size = 0;
202 current->reply_size = size;
203 return current->reply_data;
206 /* write the remaining part of the reply */
207 void write_reply( struct thread *thread )
211 if ((ret = write( get_unix_fd( thread->reply_fd ),
212 (char *)thread->reply_data + thread->reply_size - thread->reply_towrite,
213 thread->reply_towrite )) >= 0)
215 if (!(thread->reply_towrite -= ret))
217 free( thread->reply_data );
218 thread->reply_data = NULL;
219 /* sent everything, can go back to waiting for requests */
220 set_fd_events( thread->request_fd, POLLIN );
221 set_fd_events( thread->reply_fd, 0 );
226 kill_thread( thread, 0 ); /* normal death */
227 else if (errno != EWOULDBLOCK && errno != EAGAIN)
228 fatal_protocol_perror( thread, "reply write" );
231 /* send a reply to the current thread */
232 static void send_reply( union generic_reply *reply )
236 if (!current->reply_size)
238 if ((ret = write( get_unix_fd( current->reply_fd ),
239 reply, sizeof(*reply) )) != sizeof(*reply)) goto error;
245 vec[0].iov_base = (void *)reply;
246 vec[0].iov_len = sizeof(*reply);
247 vec[1].iov_base = current->reply_data;
248 vec[1].iov_len = current->reply_size;
250 if ((ret = writev( get_unix_fd( current->reply_fd ), vec, 2 )) < sizeof(*reply)) goto error;
252 if ((current->reply_towrite = current->reply_size - (ret - sizeof(*reply))))
254 /* couldn't write it all, wait for POLLOUT */
255 set_fd_events( current->reply_fd, POLLOUT );
256 set_fd_events( current->request_fd, 0 );
260 free( current->reply_data );
261 current->reply_data = NULL;
266 fatal_protocol_error( current, "partial write %d\n", ret );
267 else if (errno == EPIPE)
268 kill_thread( current, 0 ); /* normal death */
270 fatal_protocol_perror( current, "reply write" );
273 /* call a request handler */
274 static void call_req_handler( struct thread *thread )
276 union generic_reply reply;
277 enum request req = thread->req.request_header.req;
280 current->reply_size = 0;
282 memset( &reply, 0, sizeof(reply) );
284 if (debug_level) trace_request();
286 if (req < REQ_NB_REQUESTS)
287 req_handlers[req]( ¤t->req, &reply );
289 set_error( STATUS_NOT_IMPLEMENTED );
293 if (current->reply_fd)
295 reply.reply_header.error = current->error;
296 reply.reply_header.reply_size = current->reply_size;
297 if (debug_level) trace_reply( req, &reply );
298 send_reply( &reply );
302 current->exit_code = 1;
303 kill_thread( current, 1 ); /* no way to continue without reply fd */
309 /* read a request from a thread */
310 void read_request( struct thread *thread )
314 if (!thread->req_toread) /* no pending request */
316 if ((ret = read( get_unix_fd( thread->request_fd ), &thread->req,
317 sizeof(thread->req) )) != sizeof(thread->req)) goto error;
318 if (!(thread->req_toread = thread->req.request_header.request_size))
320 /* no data, handle request at once */
321 call_req_handler( thread );
324 if (!(thread->req_data = malloc( thread->req_toread )))
326 fatal_protocol_error( thread, "no memory for %u bytes request %d\n",
327 thread->req_toread, thread->req.request_header.req );
332 /* read the variable sized data */
335 ret = read( get_unix_fd( thread->request_fd ),
336 (char *)thread->req_data + thread->req.request_header.request_size
337 - thread->req_toread,
338 thread->req_toread );
340 if (!(thread->req_toread -= ret))
342 call_req_handler( thread );
343 free( thread->req_data );
344 thread->req_data = NULL;
350 if (!ret) /* closed pipe */
351 kill_thread( thread, 0 );
353 fatal_protocol_error( thread, "partial read %d\n", ret );
354 else if (errno != EWOULDBLOCK && errno != EAGAIN)
355 fatal_protocol_perror( thread, "read" );
358 /* receive a file descriptor on the process socket */
359 int receive_fd( struct process *process )
364 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
365 msghdr.msg_accrightslen = sizeof(int);
366 msghdr.msg_accrights = (void *)&fd;
367 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
368 msghdr.msg_control = &cmsg;
369 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
371 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
373 myiovec.iov_base = (void *)&data;
374 myiovec.iov_len = sizeof(data);
376 ret = recvmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
377 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
381 if (ret == sizeof(data))
383 struct thread *thread;
385 if (data.tid) thread = get_thread_from_id( data.tid );
386 else thread = (struct thread *)grab_object( get_process_first_thread( process ));
388 if (!thread || thread->process != process || thread->state == TERMINATED)
391 fprintf( stderr, "%04x: *fd* %d <- %d bad thread id\n",
392 data.tid, data.fd, fd );
398 fprintf( stderr, "%04x: *fd* %d <- %d\n",
399 thread->id, data.fd, fd );
400 thread_add_inflight_fd( thread, data.fd, fd );
402 if (thread) release_object( thread );
408 kill_process( process, 0 );
412 fprintf( stderr, "Protocol error: process %04x: partial recvmsg %d for fd\n",
414 kill_process( process, 1 );
418 if (errno != EWOULDBLOCK && errno != EAGAIN)
420 fprintf( stderr, "Protocol error: process %04x: ", process->id );
422 kill_process( process, 1 );
428 /* send an fd to a client */
429 int send_client_fd( struct process *process, int fd, obj_handle_t handle )
434 fprintf( stderr, "%04x: *fd* %p -> %d\n",
435 current ? current->id : process->id, handle, fd );
437 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
438 msghdr.msg_accrightslen = sizeof(fd);
439 msghdr.msg_accrights = (void *)&fd;
440 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
441 msghdr.msg_control = &cmsg;
442 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
444 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
446 myiovec.iov_base = (void *)&handle;
447 myiovec.iov_len = sizeof(handle);
449 ret = sendmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
451 if (ret == sizeof(handle)) return 0;
455 fprintf( stderr, "Protocol error: process %04x: partial sendmsg %d\n", process->id, ret );
456 kill_process( process, 1 );
458 else if (errno == EPIPE)
460 kill_process( process, 0 );
464 fprintf( stderr, "Protocol error: process %04x: ", process->id );
466 kill_process( process, 1 );
471 /* get current tick count to return to client */
472 unsigned int get_tick_count(void)
474 return (current_time - server_start_time) / 10000;
477 static void master_socket_dump( struct object *obj, int verbose )
479 struct master_socket *sock = (struct master_socket *)obj;
480 assert( obj->ops == &master_socket_ops );
481 fprintf( stderr, "Master socket fd=%p\n", sock->fd );
484 static void master_socket_destroy( struct object *obj )
486 struct master_socket *sock = (struct master_socket *)obj;
487 assert( obj->ops == &master_socket_ops );
488 release_object( sock->fd );
491 /* handle a socket event */
492 static void master_socket_poll_event( struct fd *fd, int event )
494 struct master_socket *sock = get_fd_user( fd );
495 assert( master_socket->obj.ops == &master_socket_ops );
497 assert( sock == master_socket ); /* there is only one master socket */
499 if (event & (POLLERR | POLLHUP))
501 /* this is not supposed to happen */
502 fprintf( stderr, "wineserver: Error on master socket\n" );
503 set_fd_events( sock->fd, -1 );
505 else if (event & POLLIN)
507 struct sockaddr_un dummy;
508 unsigned int len = sizeof(dummy);
509 int client = accept( get_unix_fd( master_socket->fd ), (struct sockaddr *) &dummy, &len );
510 if (client == -1) return;
513 remove_timeout_user( sock->timeout );
514 sock->timeout = NULL;
516 fcntl( client, F_SETFL, O_NONBLOCK );
517 create_process( client, NULL, 0 );
521 /* remove the socket upon exit */
522 static void socket_cleanup(void)
524 static int do_it_once;
525 if (!do_it_once++) unlink( server_socket_name );
528 /* create a directory and check its permissions */
529 static void create_dir( const char *name, struct stat *st )
531 if (lstat( name, st ) == -1)
533 if (errno != ENOENT) fatal_perror( "lstat %s", name );
534 if (mkdir( name, 0700 ) == -1 && errno != EEXIST) fatal_perror( "mkdir %s", name );
535 if (lstat( name, st ) == -1) fatal_perror( "lstat %s", name );
537 if (!S_ISDIR(st->st_mode)) fatal_error( "%s is not a directory\n", name );
538 if (st->st_uid != getuid()) fatal_error( "%s is not owned by you\n", name );
539 if (st->st_mode & 077) fatal_error( "%s must not be accessible by other users\n", name );
542 /* create the server directory and chdir to it */
543 static void create_server_dir( const char *dir )
545 char *p, *server_dir;
548 if (!(server_dir = strdup( dir ))) fatal_error( "out of memory\n" );
550 /* first create the base directory if needed */
552 p = strrchr( server_dir, '/' );
554 create_dir( server_dir, &st );
556 /* now create the server directory */
559 create_dir( server_dir, &st );
561 if (chdir( server_dir ) == -1) fatal_perror( "chdir %s", server_dir );
562 if (stat( ".", &st2 ) == -1) fatal_perror( "stat %s", server_dir );
563 if (st.st_dev != st2.st_dev || st.st_ino != st2.st_ino)
564 fatal_error( "chdir did not end up in %s\n", server_dir );
569 /* create the lock file and return its file descriptor */
570 static int create_server_lock(void)
575 if (lstat( server_lock_name, &st ) == -1)
578 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name );
582 if (!S_ISREG(st.st_mode))
583 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name );
586 if ((fd = open( server_lock_name, O_CREAT|O_TRUNC|O_WRONLY, 0600 )) == -1)
587 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name );
591 /* wait for the server lock */
592 int wait_for_lock(void)
594 const char *server_dir = wine_get_server_dir();
598 if (!server_dir) return 0; /* no server dir, so no lock to wait on */
600 create_server_dir( server_dir );
601 fd = create_server_lock();
604 fl.l_whence = SEEK_SET;
607 r = fcntl( fd, F_SETLKW, &fl );
613 /* kill the wine server holding the lock */
614 int kill_lock_owner( int sig )
616 const char *server_dir = wine_get_server_dir();
621 if (!server_dir) return 0; /* no server dir, nothing to do */
623 create_server_dir( server_dir );
624 fd = create_server_lock();
626 for (i = 0; i < 10; i++)
629 fl.l_whence = SEEK_SET;
632 if (fcntl( fd, F_GETLK, &fl ) == -1) goto done;
633 if (fl.l_type != F_WRLCK) goto done; /* the file is not locked */
634 if (!pid) /* first time around */
636 if (!(pid = fl.l_pid)) goto done; /* shouldn't happen */
639 if (kill( pid, SIGINT ) == -1) goto done;
640 kill( pid, SIGCONT );
643 else /* just send the specified signal and return */
645 ret = (kill( pid, sig ) != -1);
649 else if (fl.l_pid != pid) goto done; /* no longer the same process */
652 /* waited long enough, now kill it */
653 kill( pid, SIGKILL );
660 /* acquire the main server lock */
661 static void acquire_lock(void)
663 struct sockaddr_un addr;
666 int fd, slen, got_lock = 0;
668 fd = create_server_lock();
671 fl.l_whence = SEEK_SET;
674 if (fcntl( fd, F_SETLK, &fl ) != -1)
676 /* check for crashed server */
677 if (stat( server_socket_name, &st ) != -1 && /* there is a leftover socket */
678 stat( "core", &st ) != -1 && st.st_size) /* and there is a non-empty core file */
681 "Warning: a previous instance of the wine server seems to have crashed.\n"
682 "Please run 'gdb %s %s/core',\n"
683 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
684 server_argv0, wine_get_server_dir() );
686 unlink( server_socket_name ); /* we got the lock, we can safely remove the socket */
688 /* in that case we reuse fd without closing it, this ensures
689 * that we hold the lock until the process exits */
698 /* check whether locks work at all on this file system */
699 if (fcntl( fd, F_GETLK, &fl ) == -1) break;
702 exit(2); /* we didn't get the lock, exit with special status */
704 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name );
706 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
710 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
711 addr.sun_family = AF_UNIX;
712 strcpy( addr.sun_path, server_socket_name );
713 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
714 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
717 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
719 if ((errno == EEXIST) || (errno == EADDRINUSE))
722 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
723 exit(2); /* we didn't get the lock, exit with special status */
725 fatal_perror( "bind" );
727 atexit( socket_cleanup );
728 chmod( server_socket_name, 0600 ); /* make sure no other user can connect */
729 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
731 if (!(master_socket = alloc_object( &master_socket_ops )) ||
732 !(master_socket->fd = create_anonymous_fd( &master_socket_fd_ops, fd, &master_socket->obj, 0 )))
733 fatal_error( "out of memory\n" );
734 master_socket->timeout = NULL;
735 set_fd_events( master_socket->fd, POLLIN );
736 make_object_static( &master_socket->obj );
739 /* open the master server socket and start waiting for new clients */
740 void open_master_socket(void)
742 const char *server_dir = wine_get_server_dir();
743 int fd, pid, status, sync_pipe[2];
746 /* make sure no request is larger than the maximum size */
747 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
748 assert( sizeof(union generic_reply) == sizeof(struct request_max_size) );
750 if (!server_dir) fatal_error( "directory %s cannot be accessed\n", wine_get_config_dir() );
751 create_server_dir( server_dir );
755 if (pipe( sync_pipe ) == -1) fatal_perror( "pipe" );
761 close( sync_pipe[0] );
765 /* close stdin and stdout */
766 if ((fd = open( "/dev/null", O_RDWR )) != -1)
775 write( sync_pipe[1], &dummy, 1 );
776 close( sync_pipe[1] );
780 fatal_perror( "fork" );
783 default: /* parent */
784 close( sync_pipe[1] );
786 /* wait for child to signal us and then exit */
787 if (read( sync_pipe[0], &dummy, 1 ) == 1) _exit(0);
789 /* child terminated, propagate exit status */
790 wait4( pid, &status, 0, NULL );
791 if (WIFEXITED(status)) _exit( WEXITSTATUS(status) );
795 else /* remain in the foreground */
800 /* setup msghdr structure constant fields */
801 msghdr.msg_name = NULL;
802 msghdr.msg_namelen = 0;
803 msghdr.msg_iov = &myiovec;
804 msghdr.msg_iovlen = 1;
806 /* init the process tracing mechanism */
807 init_tracing_mechanism();
810 /* master socket timer expiration handler */
811 static void close_socket_timeout( void *arg )
813 master_socket->timeout = NULL;
816 /* if a new client is waiting, we keep on running */
817 if (!force_shutdown && check_fd_events( master_socket->fd, POLLIN )) return;
819 if (debug_level) fprintf( stderr, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
822 close_objects(); /* shut down everything properly */
824 exit( force_shutdown );
827 /* close the master socket and stop waiting for new clients */
828 void close_master_socket(void)
830 if (master_socket_timeout == TIMEOUT_INFINITE) return; /* just keep running forever */
832 if (master_socket_timeout)
833 master_socket->timeout = add_timeout_user( master_socket_timeout, close_socket_timeout, NULL );
835 close_socket_timeout( NULL ); /* close it right away */
838 /* forced shutdown, used for wineserver -k */
839 void shutdown_master_socket(void)
842 master_socket_timeout = 0;
843 if (master_socket->timeout)
845 remove_timeout_user( master_socket->timeout );
846 close_socket_timeout( NULL );
848 set_fd_events( master_socket->fd, -1 ); /* stop waiting for new clients */