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_add_queue, /* add_queue */
93 NULL, /* remove_queue */
96 no_signal, /* signal */
97 no_get_fd, /* get_fd */
98 no_map_access, /* map_access */
99 default_get_sd, /* get_sd */
100 default_set_sd, /* set_sd */
101 no_lookup_name, /* lookup_name */
102 no_open_file, /* open_file */
103 no_close_handle, /* close_handle */
104 master_socket_destroy /* destroy */
107 static const struct fd_ops master_socket_fd_ops =
109 NULL, /* get_poll_events */
110 master_socket_poll_event, /* poll_event */
112 NULL, /* get_fd_type */
114 NULL, /* queue_async */
115 NULL, /* reselect_async */
116 NULL /* cancel_async */
120 struct thread *current = NULL; /* thread handling the current request */
121 unsigned int global_error = 0; /* global error code for when no thread is current */
122 timeout_t server_start_time = 0; /* server startup time */
124 static struct master_socket *master_socket; /* the master socket object */
125 static int force_shutdown;
127 /* socket communication static structures */
128 static struct iovec myiovec;
129 static struct msghdr msghdr;
130 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
135 size_t len; /* size of structure */
136 int level; /* SOL_SOCKET */
137 int type; /* SCM_RIGHTS */
139 int fd; /* fd to pass */
141 static struct cmsg_fd cmsg = { { sizeof(cmsg.header) + sizeof(cmsg.fd), SOL_SOCKET, SCM_RIGHTS }, -1 };
142 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
144 /* complain about a protocol error and terminate the client connection */
145 void fatal_protocol_error( struct thread *thread, const char *err, ... )
149 va_start( args, err );
150 fprintf( stderr, "Protocol error:%04x: ", thread->id );
151 vfprintf( stderr, err, args );
153 thread->exit_code = 1;
154 kill_thread( thread, 1 );
157 /* complain about a protocol error and terminate the client connection */
158 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
162 va_start( args, err );
163 fprintf( stderr, "Protocol error:%04x: ", thread->id );
164 vfprintf( stderr, err, args );
167 thread->exit_code = 1;
168 kill_thread( thread, 1 );
171 /* die on a fatal error */
172 void fatal_error( const char *err, ... )
176 va_start( args, err );
177 fprintf( stderr, "wineserver: " );
178 vfprintf( stderr, err, args );
183 /* die on a fatal error */
184 void fatal_perror( const char *err, ... )
188 va_start( args, err );
189 fprintf( stderr, "wineserver: " );
190 vfprintf( stderr, err, args );
196 /* allocate the reply data */
197 void *set_reply_data_size( data_size_t size )
199 assert( size <= get_reply_max_size() );
200 if (size && !(current->reply_data = mem_alloc( size ))) size = 0;
201 current->reply_size = size;
202 return current->reply_data;
205 /* write the remaining part of the reply */
206 void write_reply( struct thread *thread )
210 if ((ret = write( get_unix_fd( thread->reply_fd ),
211 (char *)thread->reply_data + thread->reply_size - thread->reply_towrite,
212 thread->reply_towrite )) >= 0)
214 if (!(thread->reply_towrite -= ret))
216 free( thread->reply_data );
217 thread->reply_data = NULL;
218 /* sent everything, can go back to waiting for requests */
219 set_fd_events( thread->request_fd, POLLIN );
220 set_fd_events( thread->reply_fd, 0 );
225 kill_thread( thread, 0 ); /* normal death */
226 else if (errno != EWOULDBLOCK && errno != EAGAIN)
227 fatal_protocol_perror( thread, "reply write" );
230 /* send a reply to the current thread */
231 static void send_reply( union generic_reply *reply )
235 if (!current->reply_size)
237 if ((ret = write( get_unix_fd( current->reply_fd ),
238 reply, sizeof(*reply) )) != sizeof(*reply)) goto error;
244 vec[0].iov_base = (void *)reply;
245 vec[0].iov_len = sizeof(*reply);
246 vec[1].iov_base = current->reply_data;
247 vec[1].iov_len = current->reply_size;
249 if ((ret = writev( get_unix_fd( current->reply_fd ), vec, 2 )) < sizeof(*reply)) goto error;
251 if ((current->reply_towrite = current->reply_size - (ret - sizeof(*reply))))
253 /* couldn't write it all, wait for POLLOUT */
254 set_fd_events( current->reply_fd, POLLOUT );
255 set_fd_events( current->request_fd, 0 );
259 free( current->reply_data );
260 current->reply_data = NULL;
265 fatal_protocol_error( current, "partial write %d\n", ret );
266 else if (errno == EPIPE)
267 kill_thread( current, 0 ); /* normal death */
269 fatal_protocol_perror( current, "reply write" );
272 /* call a request handler */
273 static void call_req_handler( struct thread *thread )
275 union generic_reply reply;
276 enum request req = thread->req.request_header.req;
279 current->reply_size = 0;
281 memset( &reply, 0, sizeof(reply) );
283 if (debug_level) trace_request();
285 if (req < REQ_NB_REQUESTS)
286 req_handlers[req]( ¤t->req, &reply );
288 set_error( STATUS_NOT_IMPLEMENTED );
292 if (current->reply_fd)
294 reply.reply_header.error = current->error;
295 reply.reply_header.reply_size = current->reply_size;
296 if (debug_level) trace_reply( req, &reply );
297 send_reply( &reply );
301 current->exit_code = 1;
302 kill_thread( current, 1 ); /* no way to continue without reply fd */
308 /* read a request from a thread */
309 void read_request( struct thread *thread )
313 if (!thread->req_toread) /* no pending request */
315 if ((ret = read( get_unix_fd( thread->request_fd ), &thread->req,
316 sizeof(thread->req) )) != sizeof(thread->req)) goto error;
317 if (!(thread->req_toread = thread->req.request_header.request_size))
319 /* no data, handle request at once */
320 call_req_handler( thread );
323 if (!(thread->req_data = malloc( thread->req_toread )))
325 fatal_protocol_error( thread, "no memory for %u bytes request %d\n",
326 thread->req_toread, thread->req.request_header.req );
331 /* read the variable sized data */
334 ret = read( get_unix_fd( thread->request_fd ),
335 (char *)thread->req_data + thread->req.request_header.request_size
336 - thread->req_toread,
337 thread->req_toread );
339 if (!(thread->req_toread -= ret))
341 call_req_handler( thread );
342 free( thread->req_data );
343 thread->req_data = NULL;
349 if (!ret) /* closed pipe */
350 kill_thread( thread, 0 );
352 fatal_protocol_error( thread, "partial read %d\n", ret );
353 else if (errno != EWOULDBLOCK && errno != EAGAIN)
354 fatal_protocol_perror( thread, "read" );
357 /* receive a file descriptor on the process socket */
358 int receive_fd( struct process *process )
363 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
364 msghdr.msg_accrightslen = sizeof(int);
365 msghdr.msg_accrights = (void *)&fd;
366 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
367 msghdr.msg_control = &cmsg;
368 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
370 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
372 myiovec.iov_base = (void *)&data;
373 myiovec.iov_len = sizeof(data);
375 ret = recvmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
376 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
380 if (ret == sizeof(data))
382 struct thread *thread;
384 if (data.tid) thread = get_thread_from_id( data.tid );
385 else thread = (struct thread *)grab_object( get_process_first_thread( process ));
387 if (!thread || thread->process != process || thread->state == TERMINATED)
390 fprintf( stderr, "%04x: *fd* %d <- %d bad thread id\n",
391 data.tid, data.fd, fd );
397 fprintf( stderr, "%04x: *fd* %d <- %d\n",
398 thread->id, data.fd, fd );
399 thread_add_inflight_fd( thread, data.fd, fd );
401 if (thread) release_object( thread );
407 kill_process( process, 0 );
411 fprintf( stderr, "Protocol error: process %04x: partial recvmsg %d for fd\n",
413 kill_process( process, 1 );
417 if (errno != EWOULDBLOCK && errno != EAGAIN)
419 fprintf( stderr, "Protocol error: process %04x: ", process->id );
421 kill_process( process, 1 );
427 /* send an fd to a client */
428 int send_client_fd( struct process *process, int fd, obj_handle_t handle )
433 fprintf( stderr, "%04x: *fd* %p -> %d\n",
434 current ? current->id : process->id, handle, fd );
436 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
437 msghdr.msg_accrightslen = sizeof(fd);
438 msghdr.msg_accrights = (void *)&fd;
439 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
440 msghdr.msg_control = &cmsg;
441 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
443 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
445 myiovec.iov_base = (void *)&handle;
446 myiovec.iov_len = sizeof(handle);
448 ret = sendmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
450 if (ret == sizeof(handle)) return 0;
454 fprintf( stderr, "Protocol error: process %04x: partial sendmsg %d\n", process->id, ret );
455 kill_process( process, 1 );
457 else if (errno == EPIPE)
459 kill_process( process, 0 );
463 fprintf( stderr, "Protocol error: process %04x: ", process->id );
465 kill_process( process, 1 );
470 /* get current tick count to return to client */
471 unsigned int get_tick_count(void)
473 return (current_time - server_start_time) / 10000;
476 static void master_socket_dump( struct object *obj, int verbose )
478 struct master_socket *sock = (struct master_socket *)obj;
479 assert( obj->ops == &master_socket_ops );
480 fprintf( stderr, "Master socket fd=%p\n", sock->fd );
483 static void master_socket_destroy( struct object *obj )
485 struct master_socket *sock = (struct master_socket *)obj;
486 assert( obj->ops == &master_socket_ops );
487 release_object( sock->fd );
490 /* handle a socket event */
491 static void master_socket_poll_event( struct fd *fd, int event )
493 struct master_socket *sock = get_fd_user( fd );
494 assert( master_socket->obj.ops == &master_socket_ops );
496 assert( sock == master_socket ); /* there is only one master socket */
498 if (event & (POLLERR | POLLHUP))
500 /* this is not supposed to happen */
501 fprintf( stderr, "wineserver: Error on master socket\n" );
502 set_fd_events( sock->fd, -1 );
504 else if (event & POLLIN)
506 struct sockaddr_un dummy;
507 unsigned int len = sizeof(dummy);
508 int client = accept( get_unix_fd( master_socket->fd ), (struct sockaddr *) &dummy, &len );
509 if (client == -1) return;
512 remove_timeout_user( sock->timeout );
513 sock->timeout = NULL;
515 fcntl( client, F_SETFL, O_NONBLOCK );
516 create_process( client, NULL, 0 );
520 /* remove the socket upon exit */
521 static void socket_cleanup(void)
523 static int do_it_once;
524 if (!do_it_once++) unlink( server_socket_name );
527 /* create a directory and check its permissions */
528 static void create_dir( const char *name, struct stat *st )
530 if (lstat( name, st ) == -1)
532 if (errno != ENOENT) fatal_perror( "lstat %s", name );
533 if (mkdir( name, 0700 ) == -1 && errno != EEXIST) fatal_perror( "mkdir %s", name );
534 if (lstat( name, st ) == -1) fatal_perror( "lstat %s", name );
536 if (!S_ISDIR(st->st_mode)) fatal_error( "%s is not a directory\n", name );
537 if (st->st_uid != getuid()) fatal_error( "%s is not owned by you\n", name );
538 if (st->st_mode & 077) fatal_error( "%s must not be accessible by other users\n", name );
541 /* create the server directory and chdir to it */
542 static void create_server_dir( const char *dir )
544 char *p, *server_dir;
547 if (!(server_dir = strdup( dir ))) fatal_error( "out of memory\n" );
549 /* first create the base directory if needed */
551 p = strrchr( server_dir, '/' );
553 create_dir( server_dir, &st );
555 /* now create the server directory */
558 create_dir( server_dir, &st );
560 if (chdir( server_dir ) == -1) fatal_perror( "chdir %s", server_dir );
561 if (stat( ".", &st2 ) == -1) fatal_perror( "stat %s", server_dir );
562 if (st.st_dev != st2.st_dev || st.st_ino != st2.st_ino)
563 fatal_error( "chdir did not end up in %s\n", server_dir );
568 /* create the lock file and return its file descriptor */
569 static int create_server_lock(void)
574 if (lstat( server_lock_name, &st ) == -1)
577 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name );
581 if (!S_ISREG(st.st_mode))
582 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name );
585 if ((fd = open( server_lock_name, O_CREAT|O_TRUNC|O_WRONLY, 0600 )) == -1)
586 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name );
590 /* wait for the server lock */
591 int wait_for_lock(void)
593 const char *server_dir = wine_get_server_dir();
597 if (!server_dir) return 0; /* no server dir, so no lock to wait on */
599 create_server_dir( server_dir );
600 fd = create_server_lock();
603 fl.l_whence = SEEK_SET;
606 r = fcntl( fd, F_SETLKW, &fl );
612 /* kill the wine server holding the lock */
613 int kill_lock_owner( int sig )
615 const char *server_dir = wine_get_server_dir();
620 if (!server_dir) return 0; /* no server dir, nothing to do */
622 create_server_dir( server_dir );
623 fd = create_server_lock();
625 for (i = 0; i < 10; i++)
628 fl.l_whence = SEEK_SET;
631 if (fcntl( fd, F_GETLK, &fl ) == -1) goto done;
632 if (fl.l_type != F_WRLCK) goto done; /* the file is not locked */
633 if (!pid) /* first time around */
635 if (!(pid = fl.l_pid)) goto done; /* shouldn't happen */
638 if (kill( pid, SIGINT ) == -1) goto done;
639 kill( pid, SIGCONT );
642 else /* just send the specified signal and return */
644 ret = (kill( pid, sig ) != -1);
648 else if (fl.l_pid != pid) goto done; /* no longer the same process */
651 /* waited long enough, now kill it */
652 kill( pid, SIGKILL );
659 /* acquire the main server lock */
660 static void acquire_lock(void)
662 struct sockaddr_un addr;
665 int fd, slen, got_lock = 0;
667 fd = create_server_lock();
670 fl.l_whence = SEEK_SET;
673 if (fcntl( fd, F_SETLK, &fl ) != -1)
675 /* check for crashed server */
676 if (stat( server_socket_name, &st ) != -1 && /* there is a leftover socket */
677 stat( "core", &st ) != -1 && st.st_size) /* and there is a non-empty core file */
680 "Warning: a previous instance of the wine server seems to have crashed.\n"
681 "Please run 'gdb %s %s/core',\n"
682 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
683 server_argv0, wine_get_server_dir() );
685 unlink( server_socket_name ); /* we got the lock, we can safely remove the socket */
687 /* in that case we reuse fd without closing it, this ensures
688 * that we hold the lock until the process exits */
697 /* check whether locks work at all on this file system */
698 if (fcntl( fd, F_GETLK, &fl ) == -1) break;
701 exit(2); /* we didn't get the lock, exit with special status */
703 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name );
705 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
709 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
710 addr.sun_family = AF_UNIX;
711 strcpy( addr.sun_path, server_socket_name );
712 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
713 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
716 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
718 if ((errno == EEXIST) || (errno == EADDRINUSE))
721 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
722 exit(2); /* we didn't get the lock, exit with special status */
724 fatal_perror( "bind" );
726 atexit( socket_cleanup );
727 chmod( server_socket_name, 0600 ); /* make sure no other user can connect */
728 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
730 if (!(master_socket = alloc_object( &master_socket_ops )) ||
731 !(master_socket->fd = create_anonymous_fd( &master_socket_fd_ops, fd, &master_socket->obj, 0 )))
732 fatal_error( "out of memory\n" );
733 master_socket->timeout = NULL;
734 set_fd_events( master_socket->fd, POLLIN );
735 make_object_static( &master_socket->obj );
738 /* open the master server socket and start waiting for new clients */
739 void open_master_socket(void)
741 const char *server_dir = wine_get_server_dir();
742 int fd, pid, status, sync_pipe[2];
745 /* make sure no request is larger than the maximum size */
746 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
747 assert( sizeof(union generic_reply) == sizeof(struct request_max_size) );
749 if (!server_dir) fatal_error( "directory %s cannot be accessed\n", wine_get_config_dir() );
750 create_server_dir( server_dir );
754 if (pipe( sync_pipe ) == -1) fatal_perror( "pipe" );
760 close( sync_pipe[0] );
764 /* close stdin and stdout */
765 if ((fd = open( "/dev/null", O_RDWR )) != -1)
774 write( sync_pipe[1], &dummy, 1 );
775 close( sync_pipe[1] );
779 fatal_perror( "fork" );
782 default: /* parent */
783 close( sync_pipe[1] );
785 /* wait for child to signal us and then exit */
786 if (read( sync_pipe[0], &dummy, 1 ) == 1) _exit(0);
788 /* child terminated, propagate exit status */
789 wait4( pid, &status, 0, NULL );
790 if (WIFEXITED(status)) _exit( WEXITSTATUS(status) );
794 else /* remain in the foreground */
799 /* setup msghdr structure constant fields */
800 msghdr.msg_name = NULL;
801 msghdr.msg_namelen = 0;
802 msghdr.msg_iov = &myiovec;
803 msghdr.msg_iovlen = 1;
805 /* init the process tracing mechanism */
806 init_tracing_mechanism();
809 /* master socket timer expiration handler */
810 static void close_socket_timeout( void *arg )
812 master_socket->timeout = NULL;
815 /* if a new client is waiting, we keep on running */
816 if (!force_shutdown && check_fd_events( master_socket->fd, POLLIN )) return;
818 if (debug_level) fprintf( stderr, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
821 close_objects(); /* shut down everything properly */
823 exit( force_shutdown );
826 /* close the master socket and stop waiting for new clients */
827 void close_master_socket(void)
829 if (master_socket_timeout == TIMEOUT_INFINITE) return; /* just keep running forever */
831 if (master_socket_timeout)
832 master_socket->timeout = add_timeout_user( master_socket_timeout, close_socket_timeout, NULL );
834 close_socket_timeout( NULL ); /* close it right away */
837 /* forced shutdown, used for wineserver -k */
838 void shutdown_master_socket(void)
841 master_socket_timeout = 0;
842 if (master_socket->timeout)
844 remove_timeout_user( master_socket->timeout );
845 close_socket_timeout( NULL );
847 set_fd_events( master_socket->fd, -1 ); /* stop waiting for new clients */