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 */
83 static void master_socket_dump( struct object *obj, int verbose );
84 static void master_socket_destroy( struct object *obj );
85 static void master_socket_poll_event( struct fd *fd, int event );
87 static const struct object_ops master_socket_ops =
89 sizeof(struct master_socket), /* size */
90 master_socket_dump, /* dump */
91 no_get_type, /* get_type */
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 */
123 int server_dir_fd = -1; /* file descriptor for the server dir */
124 int config_dir_fd = -1; /* file descriptor for the config dir */
126 static struct master_socket *master_socket; /* the master socket object */
127 static struct timeout_user *master_timeout;
129 /* complain about a protocol error and terminate the client connection */
130 void fatal_protocol_error( struct thread *thread, const char *err, ... )
134 va_start( args, err );
135 fprintf( stderr, "Protocol error:%04x: ", thread->id );
136 vfprintf( stderr, err, args );
138 thread->exit_code = 1;
139 kill_thread( thread, 1 );
142 /* complain about a protocol error and terminate the client connection */
143 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
147 va_start( args, err );
148 fprintf( stderr, "Protocol error:%04x: ", thread->id );
149 vfprintf( stderr, err, args );
152 thread->exit_code = 1;
153 kill_thread( thread, 1 );
156 /* die on a fatal error */
157 void fatal_error( const char *err, ... )
161 va_start( args, err );
162 fprintf( stderr, "wineserver: " );
163 vfprintf( stderr, err, args );
168 /* die on a fatal error */
169 void fatal_perror( const char *err, ... )
173 va_start( args, err );
174 fprintf( stderr, "wineserver: " );
175 vfprintf( stderr, err, args );
181 /* allocate the reply data */
182 void *set_reply_data_size( data_size_t size )
184 assert( size <= get_reply_max_size() );
185 if (size && !(current->reply_data = mem_alloc( size ))) size = 0;
186 current->reply_size = size;
187 return current->reply_data;
190 /* write the remaining part of the reply */
191 void write_reply( struct thread *thread )
195 if ((ret = write( get_unix_fd( thread->reply_fd ),
196 (char *)thread->reply_data + thread->reply_size - thread->reply_towrite,
197 thread->reply_towrite )) >= 0)
199 if (!(thread->reply_towrite -= ret))
201 free( thread->reply_data );
202 thread->reply_data = NULL;
203 /* sent everything, can go back to waiting for requests */
204 set_fd_events( thread->request_fd, POLLIN );
205 set_fd_events( thread->reply_fd, 0 );
210 kill_thread( thread, 0 ); /* normal death */
211 else if (errno != EWOULDBLOCK && errno != EAGAIN)
212 fatal_protocol_perror( thread, "reply write" );
215 /* send a reply to the current thread */
216 static void send_reply( union generic_reply *reply )
220 if (!current->reply_size)
222 if ((ret = write( get_unix_fd( current->reply_fd ),
223 reply, sizeof(*reply) )) != sizeof(*reply)) goto error;
229 vec[0].iov_base = (void *)reply;
230 vec[0].iov_len = sizeof(*reply);
231 vec[1].iov_base = current->reply_data;
232 vec[1].iov_len = current->reply_size;
234 if ((ret = writev( get_unix_fd( current->reply_fd ), vec, 2 )) < sizeof(*reply)) goto error;
236 if ((current->reply_towrite = current->reply_size - (ret - sizeof(*reply))))
238 /* couldn't write it all, wait for POLLOUT */
239 set_fd_events( current->reply_fd, POLLOUT );
240 set_fd_events( current->request_fd, 0 );
244 free( current->reply_data );
245 current->reply_data = NULL;
250 fatal_protocol_error( current, "partial write %d\n", ret );
251 else if (errno == EPIPE)
252 kill_thread( current, 0 ); /* normal death */
254 fatal_protocol_perror( current, "reply write" );
257 /* call a request handler */
258 static void call_req_handler( struct thread *thread )
260 union generic_reply reply;
261 enum request req = thread->req.request_header.req;
264 current->reply_size = 0;
266 memset( &reply, 0, sizeof(reply) );
268 if (debug_level) trace_request();
270 if (req < REQ_NB_REQUESTS)
271 req_handlers[req]( ¤t->req, &reply );
273 set_error( STATUS_NOT_IMPLEMENTED );
277 if (current->reply_fd)
279 reply.reply_header.error = current->error;
280 reply.reply_header.reply_size = current->reply_size;
281 if (debug_level) trace_reply( req, &reply );
282 send_reply( &reply );
286 current->exit_code = 1;
287 kill_thread( current, 1 ); /* no way to continue without reply fd */
293 /* read a request from a thread */
294 void read_request( struct thread *thread )
298 if (!thread->req_toread) /* no pending request */
300 if ((ret = read( get_unix_fd( thread->request_fd ), &thread->req,
301 sizeof(thread->req) )) != sizeof(thread->req)) goto error;
302 if (!(thread->req_toread = thread->req.request_header.request_size))
304 /* no data, handle request at once */
305 call_req_handler( thread );
308 if (!(thread->req_data = malloc( thread->req_toread )))
310 fatal_protocol_error( thread, "no memory for %u bytes request %d\n",
311 thread->req_toread, thread->req.request_header.req );
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 )
347 struct msghdr msghdr;
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 char cmsg_buffer[256];
355 msghdr.msg_control = cmsg_buffer;
356 msghdr.msg_controllen = sizeof(cmsg_buffer);
357 msghdr.msg_flags = 0;
358 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
360 msghdr.msg_name = NULL;
361 msghdr.msg_namelen = 0;
362 msghdr.msg_iov = &vec;
363 msghdr.msg_iovlen = 1;
364 vec.iov_base = (void *)&data;
365 vec.iov_len = sizeof(data);
367 ret = recvmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
369 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
372 struct cmsghdr *cmsg;
373 for (cmsg = CMSG_FIRSTHDR( &msghdr ); cmsg; cmsg = CMSG_NXTHDR( &msghdr, cmsg ))
375 if (cmsg->cmsg_level != SOL_SOCKET) continue;
376 if (cmsg->cmsg_type == SCM_RIGHTS) fd = *(int *)CMSG_DATA(cmsg);
379 #endif /* 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 if (fd != -1) close( fd );
415 kill_process( process, 1 );
419 if (errno != EWOULDBLOCK && errno != EAGAIN)
421 fprintf( stderr, "Protocol error: process %04x: ", process->id );
423 kill_process( process, 1 );
429 /* send an fd to a client */
430 int send_client_fd( struct process *process, int fd, obj_handle_t handle )
433 struct msghdr msghdr;
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 char cmsg_buffer[256];
441 struct cmsghdr *cmsg;
442 msghdr.msg_control = cmsg_buffer;
443 msghdr.msg_controllen = sizeof(cmsg_buffer);
444 msghdr.msg_flags = 0;
445 cmsg = CMSG_FIRSTHDR( &msghdr );
446 cmsg->cmsg_len = CMSG_LEN( sizeof(fd) );
447 cmsg->cmsg_level = SOL_SOCKET;
448 cmsg->cmsg_type = SCM_RIGHTS;
449 *(int *)CMSG_DATA(cmsg) = fd;
450 msghdr.msg_controllen = cmsg->cmsg_len;
451 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
453 msghdr.msg_name = NULL;
454 msghdr.msg_namelen = 0;
455 msghdr.msg_iov = &vec;
456 msghdr.msg_iovlen = 1;
458 vec.iov_base = (void *)&handle;
459 vec.iov_len = sizeof(handle);
462 fprintf( stderr, "%04x: *fd* %04x -> %d\n", current ? current->id : process->id, handle, fd );
464 ret = sendmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
466 if (ret == sizeof(handle)) return 0;
470 fprintf( stderr, "Protocol error: process %04x: partial sendmsg %d\n", process->id, ret );
471 kill_process( process, 1 );
473 else if (errno == EPIPE)
475 kill_process( process, 0 );
479 fprintf( stderr, "Protocol error: process %04x: ", process->id );
481 kill_process( process, 1 );
486 /* get current tick count to return to client */
487 unsigned int get_tick_count(void)
489 return (current_time - server_start_time) / 10000;
492 static void master_socket_dump( struct object *obj, int verbose )
494 struct master_socket *sock = (struct master_socket *)obj;
495 assert( obj->ops == &master_socket_ops );
496 fprintf( stderr, "Master socket fd=%p\n", sock->fd );
499 static void master_socket_destroy( struct object *obj )
501 struct master_socket *sock = (struct master_socket *)obj;
502 assert( obj->ops == &master_socket_ops );
503 release_object( sock->fd );
506 /* handle a socket event */
507 static void master_socket_poll_event( struct fd *fd, int event )
509 struct master_socket *sock = get_fd_user( fd );
510 assert( master_socket->obj.ops == &master_socket_ops );
512 assert( sock == master_socket ); /* there is only one master socket */
514 if (event & (POLLERR | POLLHUP))
516 /* this is not supposed to happen */
517 fprintf( stderr, "wineserver: Error on master socket\n" );
518 set_fd_events( sock->fd, -1 );
520 else if (event & POLLIN)
522 struct sockaddr_un dummy;
523 unsigned int len = sizeof(dummy);
524 int client = accept( get_unix_fd( master_socket->fd ), (struct sockaddr *) &dummy, &len );
525 if (client == -1) return;
526 fcntl( client, F_SETFL, O_NONBLOCK );
527 create_process( client, NULL, 0 );
531 /* remove the socket upon exit */
532 static void socket_cleanup(void)
534 static int do_it_once;
535 if (!do_it_once++) unlink( server_socket_name );
538 /* create a directory and check its permissions */
539 static void create_dir( const char *name, struct stat *st )
541 if (lstat( name, st ) == -1)
543 if (errno != ENOENT) fatal_perror( "lstat %s", name );
544 if (mkdir( name, 0700 ) == -1 && errno != EEXIST) fatal_perror( "mkdir %s", name );
545 if (lstat( name, st ) == -1) fatal_perror( "lstat %s", name );
547 if (!S_ISDIR(st->st_mode)) fatal_error( "%s is not a directory\n", name );
548 if (st->st_uid != getuid()) fatal_error( "%s is not owned by you\n", name );
549 if (st->st_mode & 077) fatal_error( "%s must not be accessible by other users\n", name );
552 /* create the server directory and chdir to it */
553 static void create_server_dir( const char *dir )
555 char *p, *server_dir;
558 if (!(server_dir = strdup( dir ))) fatal_error( "out of memory\n" );
560 /* first create the base directory if needed */
562 p = strrchr( server_dir, '/' );
564 create_dir( server_dir, &st );
566 /* now create the server directory */
569 create_dir( server_dir, &st );
571 if (chdir( server_dir ) == -1) fatal_perror( "chdir %s", server_dir );
572 if ((server_dir_fd = open( ".", O_RDONLY )) == -1) fatal_perror( "open %s", server_dir );
573 if (fstat( server_dir_fd, &st2 ) == -1) fatal_perror( "stat %s", server_dir );
574 if (st.st_dev != st2.st_dev || st.st_ino != st2.st_ino)
575 fatal_error( "chdir did not end up in %s\n", server_dir );
580 /* create the lock file and return its file descriptor */
581 static int create_server_lock(void)
586 if (lstat( server_lock_name, &st ) == -1)
589 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name );
593 if (!S_ISREG(st.st_mode))
594 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name );
597 if ((fd = open( server_lock_name, O_CREAT|O_TRUNC|O_WRONLY, 0600 )) == -1)
598 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name );
602 /* wait for the server lock */
603 int wait_for_lock(void)
605 const char *server_dir = wine_get_server_dir();
609 if (!server_dir) return 0; /* no server dir, so no lock to wait on */
611 create_server_dir( server_dir );
612 fd = create_server_lock();
615 fl.l_whence = SEEK_SET;
618 r = fcntl( fd, F_SETLKW, &fl );
624 /* kill the wine server holding the lock */
625 int kill_lock_owner( int sig )
627 const char *server_dir = wine_get_server_dir();
632 if (!server_dir) return 0; /* no server dir, nothing to do */
634 create_server_dir( server_dir );
635 fd = create_server_lock();
637 for (i = 1; i <= 20; i++)
640 fl.l_whence = SEEK_SET;
643 if (fcntl( fd, F_GETLK, &fl ) == -1) goto done;
644 if (fl.l_type != F_WRLCK) goto done; /* the file is not locked */
645 if (!pid) /* first time around */
647 if (!(pid = fl.l_pid)) goto done; /* shouldn't happen */
650 if (kill( pid, SIGINT ) == -1) goto done;
651 kill( pid, SIGCONT );
654 else /* just send the specified signal and return */
656 ret = (kill( pid, sig ) != -1);
660 else if (fl.l_pid != pid) goto done; /* no longer the same process */
663 /* waited long enough, now kill it */
664 kill( pid, SIGKILL );
671 /* acquire the main server lock */
672 static void acquire_lock(void)
674 struct sockaddr_un addr;
677 int fd, slen, got_lock = 0;
679 fd = create_server_lock();
682 fl.l_whence = SEEK_SET;
685 if (fcntl( fd, F_SETLK, &fl ) != -1)
687 /* check for crashed server */
688 if (stat( server_socket_name, &st ) != -1 && /* there is a leftover socket */
689 stat( "core", &st ) != -1 && st.st_size) /* and there is a non-empty core file */
692 "Warning: a previous instance of the wine server seems to have crashed.\n"
693 "Please run 'gdb %s %s/core',\n"
694 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
695 server_argv0, wine_get_server_dir() );
697 unlink( server_socket_name ); /* we got the lock, we can safely remove the socket */
699 /* in that case we reuse fd without closing it, this ensures
700 * that we hold the lock until the process exits */
709 /* check whether locks work at all on this file system */
710 if (fcntl( fd, F_GETLK, &fl ) == -1) break;
713 exit(2); /* we didn't get the lock, exit with special status */
715 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name );
717 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
721 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
722 addr.sun_family = AF_UNIX;
723 strcpy( addr.sun_path, server_socket_name );
724 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
725 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
728 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
730 if ((errno == EEXIST) || (errno == EADDRINUSE))
733 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
734 exit(2); /* we didn't get the lock, exit with special status */
736 fatal_perror( "bind" );
738 atexit( socket_cleanup );
739 chmod( server_socket_name, 0600 ); /* make sure no other user can connect */
740 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
742 if (!(master_socket = alloc_object( &master_socket_ops )) ||
743 !(master_socket->fd = create_anonymous_fd( &master_socket_fd_ops, fd, &master_socket->obj, 0 )))
744 fatal_error( "out of memory\n" );
745 set_fd_events( master_socket->fd, POLLIN );
746 make_object_static( &master_socket->obj );
749 /* open the master server socket and start waiting for new clients */
750 void open_master_socket(void)
752 const char *server_dir = wine_get_server_dir();
753 const char *config_dir = wine_get_config_dir();
754 int fd, pid, status, sync_pipe[2];
757 /* make sure no request is larger than the maximum size */
758 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
759 assert( sizeof(union generic_reply) == sizeof(struct request_max_size) );
761 /* make sure the stdio fds are open */
762 fd = open( "/dev/null", O_RDWR );
763 while (fd >= 0 && fd <= 2) fd = dup( fd );
765 if (!server_dir) fatal_error( "directory %s cannot be accessed\n", config_dir );
766 if (chdir( config_dir ) == -1) fatal_perror( "chdir to %s", config_dir );
767 if ((config_dir_fd = open( ".", O_RDONLY )) == -1) fatal_perror( "open %s", config_dir );
769 create_server_dir( server_dir );
773 if (pipe( sync_pipe ) == -1) fatal_perror( "pipe" );
779 close( sync_pipe[0] );
783 /* close stdin and stdout */
789 write( sync_pipe[1], &dummy, 1 );
790 close( sync_pipe[1] );
794 fatal_perror( "fork" );
797 default: /* parent */
798 close( sync_pipe[1] );
800 /* wait for child to signal us and then exit */
801 if (read( sync_pipe[0], &dummy, 1 ) == 1) _exit(0);
803 /* child terminated, propagate exit status */
804 waitpid( pid, &status, 0 );
805 if (WIFEXITED(status)) _exit( WEXITSTATUS(status) );
809 else /* remain in the foreground */
814 /* init the process tracing mechanism */
815 init_tracing_mechanism();
819 /* master socket timer expiration handler */
820 static void close_socket_timeout( void *arg )
822 master_timeout = NULL;
824 if (debug_level) fprintf( stderr, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
827 close_objects(); /* shut down everything properly */
832 /* close the master socket and stop waiting for new clients */
833 void close_master_socket( timeout_t timeout )
837 release_object( master_socket );
838 master_socket = NULL;
840 if (master_timeout) /* cancel previous timeout */
841 remove_timeout_user( master_timeout );
843 master_timeout = add_timeout_user( timeout, close_socket_timeout, NULL );