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>
55 #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_get_fd, /* get_fd */
94 master_socket_destroy /* destroy */
97 static const struct fd_ops master_socket_fd_ops =
99 NULL, /* get_poll_events */
100 master_socket_poll_event, /* poll_event */
101 no_flush, /* flush */
102 no_get_file_info, /* get_file_info */
103 no_queue_async /* queue_async */
107 struct thread *current = NULL; /* thread handling the current request */
108 unsigned int global_error = 0; /* global error code for when no thread is current */
109 unsigned int server_start_ticks = 0; /* tick count offset from server startup */
111 static struct master_socket *master_socket; /* the master socket object */
113 /* socket communication static structures */
114 static struct iovec myiovec;
115 static struct msghdr msghdr;
116 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
119 int len; /* size of structure */
120 int level; /* SOL_SOCKET */
121 int type; /* SCM_RIGHTS */
122 int fd; /* fd to pass */
124 static struct cmsg_fd cmsg = { sizeof(cmsg), SOL_SOCKET, SCM_RIGHTS, -1 };
125 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
127 /* complain about a protocol error and terminate the client connection */
128 void fatal_protocol_error( struct thread *thread, const char *err, ... )
132 va_start( args, err );
133 fprintf( stderr, "Protocol error:%p: ", thread );
134 vfprintf( stderr, err, args );
136 thread->exit_code = 1;
137 kill_thread( thread, 1 );
140 /* complain about a protocol error and terminate the client connection */
141 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
145 va_start( args, err );
146 fprintf( stderr, "Protocol error:%p: ", thread );
147 vfprintf( stderr, err, args );
150 thread->exit_code = 1;
151 kill_thread( thread, 1 );
154 /* die on a fatal error */
155 void fatal_error( const char *err, ... )
159 va_start( args, err );
160 fprintf( stderr, "wineserver: " );
161 vfprintf( stderr, err, args );
166 /* die on a fatal error */
167 void fatal_perror( const char *err, ... )
171 va_start( args, err );
172 fprintf( stderr, "wineserver: " );
173 vfprintf( stderr, err, args );
179 /* allocate the reply data */
180 void *set_reply_data_size( size_t size )
182 assert( size <= get_reply_max_size() );
183 if (size && !(current->reply_data = mem_alloc( size ))) size = 0;
184 current->reply_size = size;
185 return current->reply_data;
188 /* write the remaining part of the reply */
189 void write_reply( struct thread *thread )
193 if ((ret = write( get_unix_fd( thread->reply_fd ),
194 (char *)thread->reply_data + thread->reply_size - thread->reply_towrite,
195 thread->reply_towrite )) >= 0)
197 if (!(thread->reply_towrite -= ret))
199 free( thread->reply_data );
200 thread->reply_data = NULL;
201 /* sent everything, can go back to waiting for requests */
202 set_fd_events( thread->request_fd, POLLIN );
203 set_fd_events( thread->reply_fd, 0 );
208 kill_thread( thread, 0 ); /* normal death */
209 else if (errno != EWOULDBLOCK && errno != EAGAIN)
210 fatal_protocol_perror( thread, "reply write" );
213 /* send a reply to the current thread */
214 static void send_reply( union generic_reply *reply )
218 if (!current->reply_size)
220 if ((ret = write( get_unix_fd( current->reply_fd ),
221 reply, sizeof(*reply) )) != sizeof(*reply)) goto error;
227 vec[0].iov_base = (void *)reply;
228 vec[0].iov_len = sizeof(*reply);
229 vec[1].iov_base = current->reply_data;
230 vec[1].iov_len = current->reply_size;
232 if ((ret = writev( get_unix_fd( current->reply_fd ), vec, 2 )) < sizeof(*reply)) goto error;
234 if ((current->reply_towrite = current->reply_size - (ret - sizeof(*reply))))
236 /* couldn't write it all, wait for POLLOUT */
237 set_fd_events( current->reply_fd, POLLOUT );
238 set_fd_events( current->request_fd, 0 );
242 if (current->reply_data)
244 free( current->reply_data );
245 current->reply_data = NULL;
251 fatal_protocol_error( current, "partial write %d\n", ret );
252 else if (errno == EPIPE)
253 kill_thread( current, 0 ); /* normal death */
255 fatal_protocol_perror( current, "reply write" );
258 /* call a request handler */
259 static void call_req_handler( struct thread *thread )
261 union generic_reply reply;
262 enum request req = thread->req.request_header.req;
265 current->reply_size = 0;
267 memset( &reply, 0, sizeof(reply) );
269 if (debug_level) trace_request();
271 if (req < REQ_NB_REQUESTS)
273 req_handlers[req]( ¤t->req, &reply );
276 if (current->reply_fd)
278 reply.reply_header.error = current->error;
279 reply.reply_header.reply_size = current->reply_size;
280 if (debug_level) trace_reply( req, &reply );
281 send_reply( &reply );
283 else fatal_protocol_error( current, "no reply fd for request %d\n", req );
288 fatal_protocol_error( current, "bad request %d\n", req );
291 /* read a request from a thread */
292 void read_request( struct thread *thread )
296 if (!thread->req_toread) /* no pending request */
298 if ((ret = read( get_unix_fd( thread->request_fd ), &thread->req,
299 sizeof(thread->req) )) != sizeof(thread->req)) goto error;
300 if (!(thread->req_toread = thread->req.request_header.request_size))
302 /* no data, handle request at once */
303 call_req_handler( thread );
306 if (!(thread->req_data = malloc( thread->req_toread )))
307 fatal_protocol_error( thread, "no memory for %d bytes request\n", thread->req_toread );
310 /* read the variable sized data */
313 ret = read( get_unix_fd( thread->request_fd ),
314 (char *)thread->req_data + thread->req.request_header.request_size
315 - thread->req_toread,
316 thread->req_toread );
318 if (!(thread->req_toread -= ret))
320 call_req_handler( thread );
321 free( thread->req_data );
322 thread->req_data = NULL;
328 if (!ret) /* closed pipe */
329 kill_thread( thread, 0 );
331 fatal_protocol_error( thread, "partial read %d\n", ret );
332 else if (errno != EWOULDBLOCK && errno != EAGAIN)
333 fatal_protocol_perror( thread, "read" );
336 /* receive a file descriptor on the process socket */
337 int receive_fd( struct process *process )
342 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
343 msghdr.msg_accrightslen = sizeof(int);
344 msghdr.msg_accrights = (void *)&fd;
345 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
346 msghdr.msg_control = &cmsg;
347 msghdr.msg_controllen = sizeof(cmsg);
349 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
351 myiovec.iov_base = (void *)&data;
352 myiovec.iov_len = sizeof(data);
354 ret = recvmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
355 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
359 if (ret == sizeof(data))
361 struct thread *thread;
363 if (data.tid) thread = get_thread_from_id( data.tid );
364 else thread = (struct thread *)grab_object( process->thread_list );
366 if (!thread || thread->process != process || thread->state == TERMINATED)
369 fprintf( stderr, "%04x: *fd* %d <- %d bad thread id\n",
370 data.tid, data.fd, fd );
376 fprintf( stderr, "%04x: *fd* %d <- %d\n",
377 thread->id, data.fd, fd );
378 thread_add_inflight_fd( thread, data.fd, fd );
380 if (thread) release_object( thread );
387 fprintf( stderr, "Protocol error: process %p: partial recvmsg %d for fd\n",
389 kill_process( process, NULL, 1 );
393 if (errno != EWOULDBLOCK && errno != EAGAIN)
395 fprintf( stderr, "Protocol error: process %p: ", process );
397 kill_process( process, NULL, 1 );
403 /* send an fd to a client */
404 int send_client_fd( struct process *process, int fd, obj_handle_t handle )
409 fprintf( stderr, "%04x: *fd* %p -> %d\n",
410 current ? current->id : process->id, handle, fd );
412 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
413 msghdr.msg_accrightslen = sizeof(fd);
414 msghdr.msg_accrights = (void *)&fd;
415 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
416 msghdr.msg_control = &cmsg;
417 msghdr.msg_controllen = sizeof(cmsg);
419 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
421 myiovec.iov_base = (void *)&handle;
422 myiovec.iov_len = sizeof(handle);
424 ret = sendmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
426 if (ret == sizeof(handle)) return 0;
430 fprintf( stderr, "Protocol error: process %p: partial sendmsg %d\n", process, ret );
431 kill_process( process, NULL, 1 );
433 else if (errno == EPIPE)
435 kill_process( process, NULL, 0 );
439 fprintf( stderr, "Protocol error: process %p: ", process );
441 kill_process( process, NULL, 1 );
446 /* get current tick count to return to client */
447 unsigned int get_tick_count(void)
450 gettimeofday( &t, NULL );
451 return (t.tv_sec * 1000) + (t.tv_usec / 1000) - server_start_ticks;
454 static void master_socket_dump( struct object *obj, int verbose )
456 struct master_socket *sock = (struct master_socket *)obj;
457 assert( obj->ops == &master_socket_ops );
458 fprintf( stderr, "Master socket fd=%p\n", sock->fd );
461 static void master_socket_destroy( struct object *obj )
463 struct master_socket *sock = (struct master_socket *)obj;
464 assert( obj->ops == &master_socket_ops );
465 release_object( sock->fd );
468 /* handle a socket event */
469 static void master_socket_poll_event( struct fd *fd, int event )
471 struct master_socket *sock = get_fd_user( fd );
472 assert( master_socket->obj.ops == &master_socket_ops );
474 assert( sock == master_socket ); /* there is only one master socket */
476 if (event & (POLLERR | POLLHUP))
478 /* this is not supposed to happen */
479 fprintf( stderr, "wineserver: Error on master socket\n" );
480 release_object( sock );
482 else if (event & POLLIN)
484 struct sockaddr_un dummy;
485 int len = sizeof(dummy);
486 int client = accept( get_unix_fd( master_socket->fd ), (struct sockaddr *) &dummy, &len );
487 if (client == -1) return;
490 remove_timeout_user( sock->timeout );
491 sock->timeout = NULL;
493 fcntl( client, F_SETFL, O_NONBLOCK );
494 create_process( client );
498 /* remove the socket upon exit */
499 static void socket_cleanup(void)
501 static int do_it_once;
502 if (!do_it_once++) unlink( server_socket_name );
505 /* create a directory and check its permissions */
506 static void create_dir( const char *name, struct stat *st )
508 if (lstat( name, st ) == -1)
510 if (errno != ENOENT) fatal_perror( "lstat %s", name );
511 if (mkdir( name, 0700 ) == -1) fatal_perror( "mkdir %s", name );
512 if (lstat( name, st ) == -1) fatal_perror( "lstat %s", name );
514 if (!S_ISDIR(st->st_mode)) fatal_error( "%s is not a directory\n", name );
515 if (st->st_uid != getuid()) fatal_error( "%s is not owned by you\n", name );
516 if (st->st_mode & 077) fatal_error( "%s must not be accessible by other users\n", name );
519 /* create the server directory and chdir to it */
520 static void create_server_dir(void)
522 char *p, *server_dir;
525 if (!(server_dir = strdup( wine_get_server_dir() ))) fatal_error( "out of memory\n" );
527 /* first create the base directory if needed */
529 p = strrchr( server_dir, '/' );
531 create_dir( server_dir, &st );
533 /* now create the server directory */
536 create_dir( server_dir, &st );
538 if (chdir( server_dir ) == -1) fatal_perror( "chdir %s", server_dir );
539 if (stat( ".", &st2 ) == -1) fatal_perror( "stat %s", server_dir );
540 if (st.st_dev != st2.st_dev || st.st_ino != st2.st_ino)
541 fatal_error( "chdir did not end up in %s\n", server_dir );
546 /* create the lock file and return its file descriptor */
547 static int create_server_lock(void)
552 if (lstat( server_lock_name, &st ) == -1)
555 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name );
559 if (!S_ISREG(st.st_mode))
560 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name );
563 if ((fd = open( server_lock_name, O_CREAT|O_TRUNC|O_WRONLY, 0600 )) == -1)
564 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name );
568 /* wait for the server lock */
569 int wait_for_lock(void)
575 fd = create_server_lock();
578 fl.l_whence = SEEK_SET;
581 r = fcntl( fd, F_SETLKW, &fl );
587 /* kill the wine server holding the lock */
588 int kill_lock_owner( int sig )
595 fd = create_server_lock();
597 for (i = 0; i < 10; i++)
600 fl.l_whence = SEEK_SET;
603 if (fcntl( fd, F_GETLK, &fl ) == -1) goto done;
604 if (fl.l_type != F_WRLCK) goto done; /* the file is not locked */
605 if (!pid) /* first time around */
607 if (!(pid = fl.l_pid)) goto done; /* shouldn't happen */
610 if (kill( pid, SIGINT ) == -1) goto done;
611 kill( pid, SIGCONT );
614 else /* just send the specified signal and return */
616 ret = (kill( pid, sig ) != -1);
620 else if (fl.l_pid != pid) goto done; /* no longer the same process */
623 /* waited long enough, now kill it */
624 kill( pid, SIGKILL );
631 /* acquire the main server lock */
632 static void acquire_lock(void)
634 struct sockaddr_un addr;
637 int fd, slen, got_lock = 0;
639 fd = create_server_lock();
642 fl.l_whence = SEEK_SET;
645 if (fcntl( fd, F_SETLK, &fl ) != -1)
647 /* check for crashed server */
648 if (stat( server_socket_name, &st ) != -1 && /* there is a leftover socket */
649 stat( "core", &st ) != -1 && st.st_size) /* and there is a non-empty core file */
652 "Warning: a previous instance of the wine server seems to have crashed.\n"
653 "Please run 'gdb %s %s/core',\n"
654 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
655 server_argv0, wine_get_server_dir() );
657 unlink( server_socket_name ); /* we got the lock, we can safely remove the socket */
659 /* in that case we reuse fd without closing it, this ensures
660 * that we hold the lock until the process exits */
669 /* check whether locks work at all on this file system */
670 if (fcntl( fd, F_GETLK, &fl ) == -1) break;
673 exit(2); /* we didn't get the lock, exit with special status */
675 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name );
677 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
681 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
682 addr.sun_family = AF_UNIX;
683 strcpy( addr.sun_path, server_socket_name );
684 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
685 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
688 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
690 if ((errno == EEXIST) || (errno == EADDRINUSE))
693 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
694 exit(2); /* we didn't get the lock, exit with special status */
696 fatal_perror( "bind" );
698 atexit( socket_cleanup );
699 chmod( server_socket_name, 0600 ); /* make sure no other user can connect */
700 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
702 if (!(master_socket = alloc_object( &master_socket_ops )) ||
703 !(master_socket->fd = create_anonymous_fd( &master_socket_fd_ops, fd, &master_socket->obj )))
704 fatal_error( "out of memory\n" );
705 master_socket->timeout = NULL;
706 set_fd_events( master_socket->fd, POLLIN );
709 /* open the master server socket and start waiting for new clients */
710 void open_master_socket(void)
712 int fd, pid, status, sync_pipe[2];
715 /* make sure no request is larger than the maximum size */
716 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
717 assert( sizeof(union generic_reply) == sizeof(struct request_max_size) );
723 if (pipe( sync_pipe ) == -1) fatal_perror( "pipe" );
729 close( sync_pipe[0] );
733 /* close stdin and stdout */
734 if ((fd = open( "/dev/null", O_RDWR )) != -1)
742 write( sync_pipe[1], &dummy, 1 );
743 close( sync_pipe[1] );
747 fatal_perror( "fork" );
750 default: /* parent */
751 close( sync_pipe[1] );
753 /* wait for child to signal us and then exit */
754 if (read( sync_pipe[0], &dummy, 1 ) == 1) _exit(0);
756 /* child terminated, propagate exit status */
757 wait4( pid, &status, 0, NULL );
758 if (WIFEXITED(status)) _exit( WEXITSTATUS(status) );
762 else /* remain in the foreground */
767 /* setup msghdr structure constant fields */
768 msghdr.msg_name = NULL;
769 msghdr.msg_namelen = 0;
770 msghdr.msg_iov = &myiovec;
771 msghdr.msg_iovlen = 1;
773 /* init startup ticks */
774 server_start_ticks = get_tick_count();
777 /* master socket timer expiration handler */
778 static void close_socket_timeout( void *arg )
780 master_socket->timeout = NULL;
783 /* if a new client is waiting, we keep on running */
784 if (check_fd_events( master_socket->fd, POLLIN )) return;
786 if (debug_level) fprintf( stderr, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
789 /* shut down everything properly */
790 release_object( master_socket );
792 close_global_hooks();
793 close_global_handles();
801 /* close the master socket and stop waiting for new clients */
802 void close_master_socket(void)
806 if (master_socket_timeout == -1) return; /* just keep running forever */
808 if (master_socket_timeout)
810 gettimeofday( &when, 0 );
811 add_timeout( &when, master_socket_timeout * 1000 );
812 master_socket->timeout = add_timeout_user( &when, close_socket_timeout, NULL );
814 else close_socket_timeout( NULL ); /* close it right away */
817 /* lock/unlock the master socket to stop accepting new clients */
818 void lock_master_socket( int locked )
820 set_fd_events( master_socket->fd, locked ? 0 : POLLIN );