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"
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_close_handle, /* close_handle */
99 master_socket_destroy /* destroy */
102 static const struct fd_ops master_socket_fd_ops =
104 NULL, /* get_poll_events */
105 master_socket_poll_event, /* poll_event */
106 no_flush, /* flush */
107 no_get_file_info, /* get_file_info */
108 no_queue_async, /* queue_async */
109 no_cancel_async /* cancel_async */
113 struct thread *current = NULL; /* thread handling the current request */
114 unsigned int global_error = 0; /* global error code for when no thread is current */
115 time_t server_start_time = 0; /* server startup time */
117 static struct master_socket *master_socket; /* the master socket object */
119 /* socket communication static structures */
120 static struct iovec myiovec;
121 static struct msghdr msghdr;
122 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
125 int len; /* size of structure */
126 int level; /* SOL_SOCKET */
127 int type; /* SCM_RIGHTS */
128 int fd; /* fd to pass */
130 static struct cmsg_fd cmsg = { sizeof(cmsg), SOL_SOCKET, SCM_RIGHTS, -1 };
131 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
133 /* complain about a protocol error and terminate the client connection */
134 void fatal_protocol_error( struct thread *thread, const char *err, ... )
138 va_start( args, err );
139 fprintf( stderr, "Protocol error:%p: ", thread );
140 vfprintf( stderr, err, args );
142 thread->exit_code = 1;
143 kill_thread( thread, 1 );
146 /* complain about a protocol error and terminate the client connection */
147 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
151 va_start( args, err );
152 fprintf( stderr, "Protocol error:%p: ", thread );
153 vfprintf( stderr, err, args );
156 thread->exit_code = 1;
157 kill_thread( thread, 1 );
160 /* die on a fatal error */
161 void fatal_error( const char *err, ... )
165 va_start( args, err );
166 fprintf( stderr, "wineserver: " );
167 vfprintf( stderr, err, args );
172 /* die on a fatal error */
173 void fatal_perror( const char *err, ... )
177 va_start( args, err );
178 fprintf( stderr, "wineserver: " );
179 vfprintf( stderr, err, args );
185 /* allocate the reply data */
186 void *set_reply_data_size( size_t size )
188 assert( size <= get_reply_max_size() );
189 if (size && !(current->reply_data = mem_alloc( size ))) size = 0;
190 current->reply_size = size;
191 return current->reply_data;
194 /* write the remaining part of the reply */
195 void write_reply( struct thread *thread )
199 if ((ret = write( get_unix_fd( thread->reply_fd ),
200 (char *)thread->reply_data + thread->reply_size - thread->reply_towrite,
201 thread->reply_towrite )) >= 0)
203 if (!(thread->reply_towrite -= ret))
205 free( thread->reply_data );
206 thread->reply_data = NULL;
207 /* sent everything, can go back to waiting for requests */
208 set_fd_events( thread->request_fd, POLLIN );
209 set_fd_events( thread->reply_fd, 0 );
214 kill_thread( thread, 0 ); /* normal death */
215 else if (errno != EWOULDBLOCK && errno != EAGAIN)
216 fatal_protocol_perror( thread, "reply write" );
219 /* send a reply to the current thread */
220 static void send_reply( union generic_reply *reply )
224 if (!current->reply_size)
226 if ((ret = write( get_unix_fd( current->reply_fd ),
227 reply, sizeof(*reply) )) != sizeof(*reply)) goto error;
233 vec[0].iov_base = (void *)reply;
234 vec[0].iov_len = sizeof(*reply);
235 vec[1].iov_base = current->reply_data;
236 vec[1].iov_len = current->reply_size;
238 if ((ret = writev( get_unix_fd( current->reply_fd ), vec, 2 )) < sizeof(*reply)) goto error;
240 if ((current->reply_towrite = current->reply_size - (ret - sizeof(*reply))))
242 /* couldn't write it all, wait for POLLOUT */
243 set_fd_events( current->reply_fd, POLLOUT );
244 set_fd_events( current->request_fd, 0 );
248 if (current->reply_data)
250 free( current->reply_data );
251 current->reply_data = NULL;
257 fatal_protocol_error( current, "partial write %d\n", ret );
258 else if (errno == EPIPE)
259 kill_thread( current, 0 ); /* normal death */
261 fatal_protocol_perror( current, "reply write" );
264 /* call a request handler */
265 static void call_req_handler( struct thread *thread )
267 union generic_reply reply;
268 enum request req = thread->req.request_header.req;
271 current->reply_size = 0;
273 memset( &reply, 0, sizeof(reply) );
275 if (debug_level) trace_request();
277 if (req < REQ_NB_REQUESTS)
279 req_handlers[req]( ¤t->req, &reply );
282 if (current->reply_fd)
284 reply.reply_header.error = current->error;
285 reply.reply_header.reply_size = current->reply_size;
286 if (debug_level) trace_reply( req, &reply );
287 send_reply( &reply );
289 else fatal_protocol_error( current, "no reply fd for request %d\n", req );
294 fatal_protocol_error( current, "bad request %d\n", req );
297 /* read a request from a thread */
298 void read_request( struct thread *thread )
302 if (!thread->req_toread) /* no pending request */
304 if ((ret = read( get_unix_fd( thread->request_fd ), &thread->req,
305 sizeof(thread->req) )) != sizeof(thread->req)) goto error;
306 if (!(thread->req_toread = thread->req.request_header.request_size))
308 /* no data, handle request at once */
309 call_req_handler( thread );
312 if (!(thread->req_data = malloc( thread->req_toread )))
313 fatal_protocol_error( thread, "no memory for %d bytes request\n", thread->req_toread );
316 /* read the variable sized data */
319 ret = read( get_unix_fd( thread->request_fd ),
320 (char *)thread->req_data + thread->req.request_header.request_size
321 - thread->req_toread,
322 thread->req_toread );
324 if (!(thread->req_toread -= ret))
326 call_req_handler( thread );
327 free( thread->req_data );
328 thread->req_data = NULL;
334 if (!ret) /* closed pipe */
335 kill_thread( thread, 0 );
337 fatal_protocol_error( thread, "partial read %d\n", ret );
338 else if (errno != EWOULDBLOCK && errno != EAGAIN)
339 fatal_protocol_perror( thread, "read" );
342 /* receive a file descriptor on the process socket */
343 int receive_fd( struct process *process )
348 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
349 msghdr.msg_accrightslen = sizeof(int);
350 msghdr.msg_accrights = (void *)&fd;
351 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
352 msghdr.msg_control = &cmsg;
353 msghdr.msg_controllen = sizeof(cmsg);
355 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
357 myiovec.iov_base = (void *)&data;
358 myiovec.iov_len = sizeof(data);
360 ret = recvmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
361 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
365 if (ret == sizeof(data))
367 struct thread *thread;
369 if (data.tid) thread = get_thread_from_id( data.tid );
370 else thread = (struct thread *)grab_object( get_process_first_thread( process ));
372 if (!thread || thread->process != process || thread->state == TERMINATED)
375 fprintf( stderr, "%04x: *fd* %d <- %d bad thread id\n",
376 data.tid, data.fd, fd );
382 fprintf( stderr, "%04x: *fd* %d <- %d\n",
383 thread->id, data.fd, fd );
384 thread_add_inflight_fd( thread, data.fd, fd );
386 if (thread) release_object( thread );
393 fprintf( stderr, "Protocol error: process %p: partial recvmsg %d for fd\n",
395 kill_process( process, NULL, 1 );
399 if (errno != EWOULDBLOCK && errno != EAGAIN)
401 fprintf( stderr, "Protocol error: process %p: ", process );
403 kill_process( process, NULL, 1 );
409 /* send an fd to a client */
410 int send_client_fd( struct process *process, int fd, obj_handle_t handle )
415 fprintf( stderr, "%04x: *fd* %p -> %d\n",
416 current ? current->id : process->id, handle, fd );
418 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
419 msghdr.msg_accrightslen = sizeof(fd);
420 msghdr.msg_accrights = (void *)&fd;
421 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
422 msghdr.msg_control = &cmsg;
423 msghdr.msg_controllen = sizeof(cmsg);
425 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
427 myiovec.iov_base = (void *)&handle;
428 myiovec.iov_len = sizeof(handle);
430 ret = sendmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
432 if (ret == sizeof(handle)) return 0;
436 fprintf( stderr, "Protocol error: process %p: partial sendmsg %d\n", process, ret );
437 kill_process( process, NULL, 1 );
439 else if (errno == EPIPE)
441 kill_process( process, NULL, 0 );
445 fprintf( stderr, "Protocol error: process %p: ", process );
447 kill_process( process, NULL, 1 );
452 /* get current tick count to return to client */
453 unsigned int get_tick_count(void)
456 gettimeofday( &t, NULL );
457 return ((t.tv_sec - server_start_time) * 1000) + (t.tv_usec / 1000);
460 static void master_socket_dump( struct object *obj, int verbose )
462 struct master_socket *sock = (struct master_socket *)obj;
463 assert( obj->ops == &master_socket_ops );
464 fprintf( stderr, "Master socket fd=%p\n", sock->fd );
467 static void master_socket_destroy( struct object *obj )
469 struct master_socket *sock = (struct master_socket *)obj;
470 assert( obj->ops == &master_socket_ops );
471 release_object( sock->fd );
474 /* handle a socket event */
475 static void master_socket_poll_event( struct fd *fd, int event )
477 struct master_socket *sock = get_fd_user( fd );
478 assert( master_socket->obj.ops == &master_socket_ops );
480 assert( sock == master_socket ); /* there is only one master socket */
482 if (event & (POLLERR | POLLHUP))
484 /* this is not supposed to happen */
485 fprintf( stderr, "wineserver: Error on master socket\n" );
486 release_object( sock );
488 else if (event & POLLIN)
490 struct sockaddr_un dummy;
491 unsigned int len = sizeof(dummy);
492 int client = accept( get_unix_fd( master_socket->fd ), (struct sockaddr *) &dummy, &len );
493 if (client == -1) return;
496 remove_timeout_user( sock->timeout );
497 sock->timeout = NULL;
499 fcntl( client, F_SETFL, O_NONBLOCK );
500 create_process( client );
504 /* remove the socket upon exit */
505 static void socket_cleanup(void)
507 static int do_it_once;
508 if (!do_it_once++) unlink( server_socket_name );
511 /* create a directory and check its permissions */
512 static void create_dir( const char *name, struct stat *st )
514 if (lstat( name, st ) == -1)
516 if (errno != ENOENT) fatal_perror( "lstat %s", name );
517 if (mkdir( name, 0700 ) == -1 && errno != EEXIST) fatal_perror( "mkdir %s", name );
518 if (lstat( name, st ) == -1) fatal_perror( "lstat %s", name );
520 if (!S_ISDIR(st->st_mode)) fatal_error( "%s is not a directory\n", name );
521 if (st->st_uid != getuid()) fatal_error( "%s is not owned by you\n", name );
522 if (st->st_mode & 077) fatal_error( "%s must not be accessible by other users\n", name );
525 /* create the server directory and chdir to it */
526 static void create_server_dir(void)
528 char *p, *server_dir;
531 if (!(server_dir = strdup( wine_get_server_dir() ))) fatal_error( "out of memory\n" );
533 /* first create the base directory if needed */
535 p = strrchr( server_dir, '/' );
537 create_dir( server_dir, &st );
539 /* now create the server directory */
542 create_dir( server_dir, &st );
544 if (chdir( server_dir ) == -1) fatal_perror( "chdir %s", server_dir );
545 if (stat( ".", &st2 ) == -1) fatal_perror( "stat %s", server_dir );
546 if (st.st_dev != st2.st_dev || st.st_ino != st2.st_ino)
547 fatal_error( "chdir did not end up in %s\n", server_dir );
552 /* create the lock file and return its file descriptor */
553 static int create_server_lock(void)
558 if (lstat( server_lock_name, &st ) == -1)
561 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name );
565 if (!S_ISREG(st.st_mode))
566 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name );
569 if ((fd = open( server_lock_name, O_CREAT|O_TRUNC|O_WRONLY, 0600 )) == -1)
570 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name );
574 /* wait for the server lock */
575 int wait_for_lock(void)
581 fd = create_server_lock();
584 fl.l_whence = SEEK_SET;
587 r = fcntl( fd, F_SETLKW, &fl );
593 /* kill the wine server holding the lock */
594 int kill_lock_owner( int sig )
601 fd = create_server_lock();
603 for (i = 0; i < 10; i++)
606 fl.l_whence = SEEK_SET;
609 if (fcntl( fd, F_GETLK, &fl ) == -1) goto done;
610 if (fl.l_type != F_WRLCK) goto done; /* the file is not locked */
611 if (!pid) /* first time around */
613 if (!(pid = fl.l_pid)) goto done; /* shouldn't happen */
616 if (kill( pid, SIGINT ) == -1) goto done;
617 kill( pid, SIGCONT );
620 else /* just send the specified signal and return */
622 ret = (kill( pid, sig ) != -1);
626 else if (fl.l_pid != pid) goto done; /* no longer the same process */
629 /* waited long enough, now kill it */
630 kill( pid, SIGKILL );
637 /* acquire the main server lock */
638 static void acquire_lock(void)
640 struct sockaddr_un addr;
643 int fd, slen, got_lock = 0;
645 fd = create_server_lock();
648 fl.l_whence = SEEK_SET;
651 if (fcntl( fd, F_SETLK, &fl ) != -1)
653 /* check for crashed server */
654 if (stat( server_socket_name, &st ) != -1 && /* there is a leftover socket */
655 stat( "core", &st ) != -1 && st.st_size) /* and there is a non-empty core file */
658 "Warning: a previous instance of the wine server seems to have crashed.\n"
659 "Please run 'gdb %s %s/core',\n"
660 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
661 server_argv0, wine_get_server_dir() );
663 unlink( server_socket_name ); /* we got the lock, we can safely remove the socket */
665 /* in that case we reuse fd without closing it, this ensures
666 * that we hold the lock until the process exits */
675 /* check whether locks work at all on this file system */
676 if (fcntl( fd, F_GETLK, &fl ) == -1) break;
679 exit(2); /* we didn't get the lock, exit with special status */
681 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name );
683 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
687 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
688 addr.sun_family = AF_UNIX;
689 strcpy( addr.sun_path, server_socket_name );
690 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
691 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
694 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
696 if ((errno == EEXIST) || (errno == EADDRINUSE))
699 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
700 exit(2); /* we didn't get the lock, exit with special status */
702 fatal_perror( "bind" );
704 atexit( socket_cleanup );
705 chmod( server_socket_name, 0600 ); /* make sure no other user can connect */
706 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
708 if (!(master_socket = alloc_object( &master_socket_ops )) ||
709 !(master_socket->fd = create_anonymous_fd( &master_socket_fd_ops, fd, &master_socket->obj )))
710 fatal_error( "out of memory\n" );
711 master_socket->timeout = NULL;
712 set_fd_events( master_socket->fd, POLLIN );
715 /* open the master server socket and start waiting for new clients */
716 void open_master_socket(void)
718 int fd, pid, status, sync_pipe[2];
721 /* make sure no request is larger than the maximum size */
722 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
723 assert( sizeof(union generic_reply) == sizeof(struct request_max_size) );
729 if (pipe( sync_pipe ) == -1) fatal_perror( "pipe" );
735 close( sync_pipe[0] );
739 /* close stdin and stdout */
740 if ((fd = open( "/dev/null", O_RDWR )) != -1)
748 write( sync_pipe[1], &dummy, 1 );
749 close( sync_pipe[1] );
753 fatal_perror( "fork" );
756 default: /* parent */
757 close( sync_pipe[1] );
759 /* wait for child to signal us and then exit */
760 if (read( sync_pipe[0], &dummy, 1 ) == 1) _exit(0);
762 /* child terminated, propagate exit status */
763 wait4( pid, &status, 0, NULL );
764 if (WIFEXITED(status)) _exit( WEXITSTATUS(status) );
768 else /* remain in the foreground */
773 /* setup msghdr structure constant fields */
774 msghdr.msg_name = NULL;
775 msghdr.msg_namelen = 0;
776 msghdr.msg_iov = &myiovec;
777 msghdr.msg_iovlen = 1;
779 /* init startup time */
780 server_start_time = time(NULL);
783 /* master socket timer expiration handler */
784 static void close_socket_timeout( void *arg )
786 master_socket->timeout = NULL;
789 /* if a new client is waiting, we keep on running */
790 if (check_fd_events( master_socket->fd, POLLIN )) return;
792 if (debug_level) fprintf( stderr, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
795 /* shut down everything properly */
796 release_object( master_socket );
798 close_global_handles();
800 dump_objects(); /* dump any remaining objects */
806 /* close the master socket and stop waiting for new clients */
807 void close_master_socket(void)
811 if (master_socket_timeout == -1) return; /* just keep running forever */
813 if (master_socket_timeout)
815 gettimeofday( &when, NULL );
816 add_timeout( &when, master_socket_timeout * 1000 );
817 master_socket->timeout = add_timeout_user( &when, close_socket_timeout, NULL );
819 else close_socket_timeout( NULL ); /* close it right away */
822 /* lock/unlock the master socket to stop accepting new clients */
823 void lock_master_socket( int locked )
825 set_fd_events( master_socket->fd, locked ? 0 : POLLIN );