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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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>
58 #include "wine/library.h"
62 #define WANT_REQUEST_HANDLERS
65 /* Some versions of glibc don't define this */
70 /* path names for server master Unix socket */
71 static const char * const server_socket_name = "socket"; /* name of the socket file */
72 static const char * const server_lock_name = "lock"; /* name of the server lock file */
76 struct object obj; /* object header */
77 struct fd *fd; /* file descriptor of the master socket */
78 struct timeout_user *timeout; /* timeout on last process exit */
81 static void master_socket_dump( struct object *obj, int verbose );
82 static void master_socket_destroy( struct object *obj );
83 static void master_socket_poll_event( struct fd *fd, int event );
85 static const struct object_ops master_socket_ops =
87 sizeof(struct master_socket), /* size */
88 master_socket_dump, /* dump */
89 no_add_queue, /* add_queue */
90 NULL, /* remove_queue */
93 no_signal, /* signal */
94 no_get_fd, /* get_fd */
95 no_map_access, /* map_access */
96 no_lookup_name, /* lookup_name */
97 no_close_handle, /* close_handle */
98 master_socket_destroy /* destroy */
101 static const struct fd_ops master_socket_fd_ops =
103 NULL, /* get_poll_events */
104 master_socket_poll_event, /* poll_event */
105 no_flush, /* flush */
106 no_get_file_info, /* get_file_info */
107 no_queue_async, /* queue_async */
108 no_cancel_async /* cancel_async */
112 struct thread *current = NULL; /* thread handling the current request */
113 unsigned int global_error = 0; /* global error code for when no thread is current */
114 time_t server_start_time = 0; /* server startup time */
116 static struct master_socket *master_socket; /* the master socket object */
118 /* socket communication static structures */
119 static struct iovec myiovec;
120 static struct msghdr msghdr;
121 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
126 size_t len; /* size of structure */
127 int level; /* SOL_SOCKET */
128 int type; /* SCM_RIGHTS */
130 int fd; /* fd to pass */
132 static struct cmsg_fd cmsg = { { sizeof(cmsg.header) + sizeof(cmsg.fd), SOL_SOCKET, SCM_RIGHTS }, -1 };
133 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
135 /* complain about a protocol error and terminate the client connection */
136 void fatal_protocol_error( struct thread *thread, const char *err, ... )
140 va_start( args, err );
141 fprintf( stderr, "Protocol error:%p: ", thread );
142 vfprintf( stderr, err, args );
144 thread->exit_code = 1;
145 kill_thread( thread, 1 );
148 /* complain about a protocol error and terminate the client connection */
149 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
153 va_start( args, err );
154 fprintf( stderr, "Protocol error:%p: ", thread );
155 vfprintf( stderr, err, args );
158 thread->exit_code = 1;
159 kill_thread( thread, 1 );
162 /* die on a fatal error */
163 void fatal_error( const char *err, ... )
167 va_start( args, err );
168 fprintf( stderr, "wineserver: " );
169 vfprintf( stderr, err, args );
174 /* die on a fatal error */
175 void fatal_perror( const char *err, ... )
179 va_start( args, err );
180 fprintf( stderr, "wineserver: " );
181 vfprintf( stderr, err, args );
187 /* allocate the reply data */
188 void *set_reply_data_size( size_t size )
190 assert( size <= get_reply_max_size() );
191 if (size && !(current->reply_data = mem_alloc( size ))) size = 0;
192 current->reply_size = size;
193 return current->reply_data;
196 /* write the remaining part of the reply */
197 void write_reply( struct thread *thread )
201 if ((ret = write( get_unix_fd( thread->reply_fd ),
202 (char *)thread->reply_data + thread->reply_size - thread->reply_towrite,
203 thread->reply_towrite )) >= 0)
205 if (!(thread->reply_towrite -= ret))
207 free( thread->reply_data );
208 thread->reply_data = NULL;
209 /* sent everything, can go back to waiting for requests */
210 set_fd_events( thread->request_fd, POLLIN );
211 set_fd_events( thread->reply_fd, 0 );
216 kill_thread( thread, 0 ); /* normal death */
217 else if (errno != EWOULDBLOCK && errno != EAGAIN)
218 fatal_protocol_perror( thread, "reply write" );
221 /* send a reply to the current thread */
222 static void send_reply( union generic_reply *reply )
226 if (!current->reply_size)
228 if ((ret = write( get_unix_fd( current->reply_fd ),
229 reply, sizeof(*reply) )) != sizeof(*reply)) goto error;
235 vec[0].iov_base = (void *)reply;
236 vec[0].iov_len = sizeof(*reply);
237 vec[1].iov_base = current->reply_data;
238 vec[1].iov_len = current->reply_size;
240 if ((ret = writev( get_unix_fd( current->reply_fd ), vec, 2 )) < sizeof(*reply)) goto error;
242 if ((current->reply_towrite = current->reply_size - (ret - sizeof(*reply))))
244 /* couldn't write it all, wait for POLLOUT */
245 set_fd_events( current->reply_fd, POLLOUT );
246 set_fd_events( current->request_fd, 0 );
250 if (current->reply_data)
252 free( current->reply_data );
253 current->reply_data = NULL;
259 fatal_protocol_error( current, "partial write %d\n", ret );
260 else if (errno == EPIPE)
261 kill_thread( current, 0 ); /* normal death */
263 fatal_protocol_perror( current, "reply write" );
266 /* call a request handler */
267 static void call_req_handler( struct thread *thread )
269 union generic_reply reply;
270 enum request req = thread->req.request_header.req;
273 current->reply_size = 0;
275 memset( &reply, 0, sizeof(reply) );
277 if (debug_level) trace_request();
279 if (req < REQ_NB_REQUESTS)
281 req_handlers[req]( ¤t->req, &reply );
284 if (current->reply_fd)
286 reply.reply_header.error = current->error;
287 reply.reply_header.reply_size = current->reply_size;
288 if (debug_level) trace_reply( req, &reply );
289 send_reply( &reply );
291 else fatal_protocol_error( current, "no reply fd for request %d\n", req );
296 fatal_protocol_error( current, "bad request %d\n", req );
299 /* read a request from a thread */
300 void read_request( struct thread *thread )
304 if (!thread->req_toread) /* no pending request */
306 if ((ret = read( get_unix_fd( thread->request_fd ), &thread->req,
307 sizeof(thread->req) )) != sizeof(thread->req)) goto error;
308 if (!(thread->req_toread = thread->req.request_header.request_size))
310 /* no data, handle request at once */
311 call_req_handler( thread );
314 if (!(thread->req_data = malloc( thread->req_toread )))
315 fatal_protocol_error( thread, "no memory for %d bytes request\n", thread->req_toread );
318 /* read the variable sized data */
321 ret = read( get_unix_fd( thread->request_fd ),
322 (char *)thread->req_data + thread->req.request_header.request_size
323 - thread->req_toread,
324 thread->req_toread );
326 if (!(thread->req_toread -= ret))
328 call_req_handler( thread );
329 free( thread->req_data );
330 thread->req_data = NULL;
336 if (!ret) /* closed pipe */
337 kill_thread( thread, 0 );
339 fatal_protocol_error( thread, "partial read %d\n", ret );
340 else if (errno != EWOULDBLOCK && errno != EAGAIN)
341 fatal_protocol_perror( thread, "read" );
344 /* receive a file descriptor on the process socket */
345 int receive_fd( struct process *process )
350 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
351 msghdr.msg_accrightslen = sizeof(int);
352 msghdr.msg_accrights = (void *)&fd;
353 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
354 msghdr.msg_control = &cmsg;
355 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
357 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
359 myiovec.iov_base = (void *)&data;
360 myiovec.iov_len = sizeof(data);
362 ret = recvmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
363 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
367 if (ret == sizeof(data))
369 struct thread *thread;
371 if (data.tid) thread = get_thread_from_id( data.tid );
372 else thread = (struct thread *)grab_object( get_process_first_thread( process ));
374 if (!thread || thread->process != process || thread->state == TERMINATED)
377 fprintf( stderr, "%04x: *fd* %d <- %d bad thread id\n",
378 data.tid, data.fd, fd );
384 fprintf( stderr, "%04x: *fd* %d <- %d\n",
385 thread->id, data.fd, fd );
386 thread_add_inflight_fd( thread, data.fd, fd );
388 if (thread) release_object( thread );
395 fprintf( stderr, "Protocol error: process %p: partial recvmsg %d for fd\n",
397 kill_process( process, NULL, 1 );
401 if (errno != EWOULDBLOCK && errno != EAGAIN)
403 fprintf( stderr, "Protocol error: process %p: ", process );
405 kill_process( process, NULL, 1 );
411 /* send an fd to a client */
412 int send_client_fd( struct process *process, int fd, obj_handle_t handle )
417 fprintf( stderr, "%04x: *fd* %p -> %d\n",
418 current ? current->id : process->id, handle, fd );
420 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
421 msghdr.msg_accrightslen = sizeof(fd);
422 msghdr.msg_accrights = (void *)&fd;
423 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
424 msghdr.msg_control = &cmsg;
425 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
427 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
429 myiovec.iov_base = (void *)&handle;
430 myiovec.iov_len = sizeof(handle);
432 ret = sendmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
434 if (ret == sizeof(handle)) return 0;
438 fprintf( stderr, "Protocol error: process %p: partial sendmsg %d\n", process, ret );
439 kill_process( process, NULL, 1 );
441 else if (errno == EPIPE)
443 kill_process( process, NULL, 0 );
447 fprintf( stderr, "Protocol error: process %p: ", process );
449 kill_process( process, NULL, 1 );
454 /* get current tick count to return to client */
455 unsigned int get_tick_count(void)
458 gettimeofday( &t, NULL );
459 return ((t.tv_sec - server_start_time) * 1000) + (t.tv_usec / 1000);
462 static void master_socket_dump( struct object *obj, int verbose )
464 struct master_socket *sock = (struct master_socket *)obj;
465 assert( obj->ops == &master_socket_ops );
466 fprintf( stderr, "Master socket fd=%p\n", sock->fd );
469 static void master_socket_destroy( struct object *obj )
471 struct master_socket *sock = (struct master_socket *)obj;
472 assert( obj->ops == &master_socket_ops );
473 release_object( sock->fd );
476 /* handle a socket event */
477 static void master_socket_poll_event( struct fd *fd, int event )
479 struct master_socket *sock = get_fd_user( fd );
480 assert( master_socket->obj.ops == &master_socket_ops );
482 assert( sock == master_socket ); /* there is only one master socket */
484 if (event & (POLLERR | POLLHUP))
486 /* this is not supposed to happen */
487 fprintf( stderr, "wineserver: Error on master socket\n" );
488 release_object( sock );
490 else if (event & POLLIN)
492 struct sockaddr_un dummy;
493 unsigned int len = sizeof(dummy);
494 int client = accept( get_unix_fd( master_socket->fd ), (struct sockaddr *) &dummy, &len );
495 if (client == -1) return;
498 remove_timeout_user( sock->timeout );
499 sock->timeout = NULL;
501 fcntl( client, F_SETFL, O_NONBLOCK );
502 create_process( client );
506 /* remove the socket upon exit */
507 static void socket_cleanup(void)
509 static int do_it_once;
510 if (!do_it_once++) unlink( server_socket_name );
513 /* create a directory and check its permissions */
514 static void create_dir( const char *name, struct stat *st )
516 if (lstat( name, st ) == -1)
518 if (errno != ENOENT) fatal_perror( "lstat %s", name );
519 if (mkdir( name, 0700 ) == -1 && errno != EEXIST) fatal_perror( "mkdir %s", name );
520 if (lstat( name, st ) == -1) fatal_perror( "lstat %s", name );
522 if (!S_ISDIR(st->st_mode)) fatal_error( "%s is not a directory\n", name );
523 if (st->st_uid != getuid()) fatal_error( "%s is not owned by you\n", name );
524 if (st->st_mode & 077) fatal_error( "%s must not be accessible by other users\n", name );
527 /* create the server directory and chdir to it */
528 static void create_server_dir(void)
530 char *p, *server_dir;
533 if (!(server_dir = strdup( wine_get_server_dir() ))) fatal_error( "out of memory\n" );
535 /* first create the base directory if needed */
537 p = strrchr( server_dir, '/' );
539 create_dir( server_dir, &st );
541 /* now create the server directory */
544 create_dir( server_dir, &st );
546 if (chdir( server_dir ) == -1) fatal_perror( "chdir %s", server_dir );
547 if (stat( ".", &st2 ) == -1) fatal_perror( "stat %s", server_dir );
548 if (st.st_dev != st2.st_dev || st.st_ino != st2.st_ino)
549 fatal_error( "chdir did not end up in %s\n", server_dir );
554 /* create the lock file and return its file descriptor */
555 static int create_server_lock(void)
560 if (lstat( server_lock_name, &st ) == -1)
563 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name );
567 if (!S_ISREG(st.st_mode))
568 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name );
571 if ((fd = open( server_lock_name, O_CREAT|O_TRUNC|O_WRONLY, 0600 )) == -1)
572 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name );
576 /* wait for the server lock */
577 int wait_for_lock(void)
583 fd = create_server_lock();
586 fl.l_whence = SEEK_SET;
589 r = fcntl( fd, F_SETLKW, &fl );
595 /* kill the wine server holding the lock */
596 int kill_lock_owner( int sig )
603 fd = create_server_lock();
605 for (i = 0; i < 10; i++)
608 fl.l_whence = SEEK_SET;
611 if (fcntl( fd, F_GETLK, &fl ) == -1) goto done;
612 if (fl.l_type != F_WRLCK) goto done; /* the file is not locked */
613 if (!pid) /* first time around */
615 if (!(pid = fl.l_pid)) goto done; /* shouldn't happen */
618 if (kill( pid, SIGINT ) == -1) goto done;
619 kill( pid, SIGCONT );
622 else /* just send the specified signal and return */
624 ret = (kill( pid, sig ) != -1);
628 else if (fl.l_pid != pid) goto done; /* no longer the same process */
631 /* waited long enough, now kill it */
632 kill( pid, SIGKILL );
639 /* acquire the main server lock */
640 static void acquire_lock(void)
642 struct sockaddr_un addr;
645 int fd, slen, got_lock = 0;
647 fd = create_server_lock();
650 fl.l_whence = SEEK_SET;
653 if (fcntl( fd, F_SETLK, &fl ) != -1)
655 /* check for crashed server */
656 if (stat( server_socket_name, &st ) != -1 && /* there is a leftover socket */
657 stat( "core", &st ) != -1 && st.st_size) /* and there is a non-empty core file */
660 "Warning: a previous instance of the wine server seems to have crashed.\n"
661 "Please run 'gdb %s %s/core',\n"
662 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
663 server_argv0, wine_get_server_dir() );
665 unlink( server_socket_name ); /* we got the lock, we can safely remove the socket */
667 /* in that case we reuse fd without closing it, this ensures
668 * that we hold the lock until the process exits */
677 /* check whether locks work at all on this file system */
678 if (fcntl( fd, F_GETLK, &fl ) == -1) break;
681 exit(2); /* we didn't get the lock, exit with special status */
683 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name );
685 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
689 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
690 addr.sun_family = AF_UNIX;
691 strcpy( addr.sun_path, server_socket_name );
692 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
693 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
696 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
698 if ((errno == EEXIST) || (errno == EADDRINUSE))
701 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
702 exit(2); /* we didn't get the lock, exit with special status */
704 fatal_perror( "bind" );
706 atexit( socket_cleanup );
707 chmod( server_socket_name, 0600 ); /* make sure no other user can connect */
708 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
710 if (!(master_socket = alloc_object( &master_socket_ops )) ||
711 !(master_socket->fd = create_anonymous_fd( &master_socket_fd_ops, fd, &master_socket->obj )))
712 fatal_error( "out of memory\n" );
713 master_socket->timeout = NULL;
714 set_fd_events( master_socket->fd, POLLIN );
715 make_object_static( &master_socket->obj );
718 /* open the master server socket and start waiting for new clients */
719 void open_master_socket(void)
721 int fd, pid, status, sync_pipe[2];
724 /* make sure no request is larger than the maximum size */
725 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
726 assert( sizeof(union generic_reply) == sizeof(struct request_max_size) );
732 if (pipe( sync_pipe ) == -1) fatal_perror( "pipe" );
738 close( sync_pipe[0] );
742 /* close stdin and stdout */
743 if ((fd = open( "/dev/null", O_RDWR )) != -1)
752 write( sync_pipe[1], &dummy, 1 );
753 close( sync_pipe[1] );
757 fatal_perror( "fork" );
760 default: /* parent */
761 close( sync_pipe[1] );
763 /* wait for child to signal us and then exit */
764 if (read( sync_pipe[0], &dummy, 1 ) == 1) _exit(0);
766 /* child terminated, propagate exit status */
767 wait4( pid, &status, 0, NULL );
768 if (WIFEXITED(status)) _exit( WEXITSTATUS(status) );
772 else /* remain in the foreground */
777 /* setup msghdr structure constant fields */
778 msghdr.msg_name = NULL;
779 msghdr.msg_namelen = 0;
780 msghdr.msg_iov = &myiovec;
781 msghdr.msg_iovlen = 1;
783 /* init startup time */
784 server_start_time = time(NULL);
787 /* master socket timer expiration handler */
788 static void close_socket_timeout( void *arg )
790 master_socket->timeout = NULL;
793 /* if a new client is waiting, we keep on running */
794 if (check_fd_events( master_socket->fd, POLLIN )) return;
796 if (debug_level) fprintf( stderr, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
799 close_objects(); /* shut down everything properly */
804 /* close the master socket and stop waiting for new clients */
805 void close_master_socket(void)
809 if (master_socket_timeout == -1) return; /* just keep running forever */
811 if (master_socket_timeout)
813 gettimeofday( &when, NULL );
814 add_timeout( &when, master_socket_timeout * 1000 );
815 master_socket->timeout = add_timeout_user( &when, close_socket_timeout, NULL );
817 else close_socket_timeout( NULL ); /* close it right away */
820 /* lock/unlock the master socket to stop accepting new clients */
821 void lock_master_socket( int locked )
823 set_fd_events( master_socket->fd, locked ? 0 : POLLIN );