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 no_lookup_name, /* lookup_name */
100 no_close_handle, /* close_handle */
101 master_socket_destroy /* destroy */
104 static const struct fd_ops master_socket_fd_ops =
106 NULL, /* get_poll_events */
107 master_socket_poll_event, /* poll_event */
108 no_flush, /* flush */
109 no_get_file_info, /* get_file_info */
110 no_queue_async, /* queue_async */
111 no_cancel_async /* cancel_async */
115 struct thread *current = NULL; /* thread handling the current request */
116 unsigned int global_error = 0; /* global error code for when no thread is current */
117 time_t server_start_time = 0; /* server startup time */
119 static struct master_socket *master_socket; /* the master socket object */
121 /* socket communication static structures */
122 static struct iovec myiovec;
123 static struct msghdr msghdr;
124 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
129 size_t len; /* size of structure */
130 int level; /* SOL_SOCKET */
131 int type; /* SCM_RIGHTS */
133 int fd; /* fd to pass */
135 static struct cmsg_fd cmsg = { { sizeof(cmsg.header) + sizeof(cmsg.fd), SOL_SOCKET, SCM_RIGHTS }, -1 };
136 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
138 /* complain about a protocol error and terminate the client connection */
139 void fatal_protocol_error( struct thread *thread, const char *err, ... )
143 va_start( args, err );
144 fprintf( stderr, "Protocol error:%p: ", thread );
145 vfprintf( stderr, err, args );
147 thread->exit_code = 1;
148 kill_thread( thread, 1 );
151 /* complain about a protocol error and terminate the client connection */
152 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
156 va_start( args, err );
157 fprintf( stderr, "Protocol error:%p: ", thread );
158 vfprintf( stderr, err, args );
161 thread->exit_code = 1;
162 kill_thread( thread, 1 );
165 /* die on a fatal error */
166 void fatal_error( const char *err, ... )
170 va_start( args, err );
171 fprintf( stderr, "wineserver: " );
172 vfprintf( stderr, err, args );
177 /* die on a fatal error */
178 void fatal_perror( const char *err, ... )
182 va_start( args, err );
183 fprintf( stderr, "wineserver: " );
184 vfprintf( stderr, err, args );
190 /* allocate the reply data */
191 void *set_reply_data_size( size_t size )
193 assert( size <= get_reply_max_size() );
194 if (size && !(current->reply_data = mem_alloc( size ))) size = 0;
195 current->reply_size = size;
196 return current->reply_data;
199 /* write the remaining part of the reply */
200 void write_reply( struct thread *thread )
204 if ((ret = write( get_unix_fd( thread->reply_fd ),
205 (char *)thread->reply_data + thread->reply_size - thread->reply_towrite,
206 thread->reply_towrite )) >= 0)
208 if (!(thread->reply_towrite -= ret))
210 free( thread->reply_data );
211 thread->reply_data = NULL;
212 /* sent everything, can go back to waiting for requests */
213 set_fd_events( thread->request_fd, POLLIN );
214 set_fd_events( thread->reply_fd, 0 );
219 kill_thread( thread, 0 ); /* normal death */
220 else if (errno != EWOULDBLOCK && errno != EAGAIN)
221 fatal_protocol_perror( thread, "reply write" );
224 /* send a reply to the current thread */
225 static void send_reply( union generic_reply *reply )
229 if (!current->reply_size)
231 if ((ret = write( get_unix_fd( current->reply_fd ),
232 reply, sizeof(*reply) )) != sizeof(*reply)) goto error;
238 vec[0].iov_base = (void *)reply;
239 vec[0].iov_len = sizeof(*reply);
240 vec[1].iov_base = current->reply_data;
241 vec[1].iov_len = current->reply_size;
243 if ((ret = writev( get_unix_fd( current->reply_fd ), vec, 2 )) < sizeof(*reply)) goto error;
245 if ((current->reply_towrite = current->reply_size - (ret - sizeof(*reply))))
247 /* couldn't write it all, wait for POLLOUT */
248 set_fd_events( current->reply_fd, POLLOUT );
249 set_fd_events( current->request_fd, 0 );
253 if (current->reply_data)
255 free( current->reply_data );
256 current->reply_data = NULL;
262 fatal_protocol_error( current, "partial write %d\n", ret );
263 else if (errno == EPIPE)
264 kill_thread( current, 0 ); /* normal death */
266 fatal_protocol_perror( current, "reply write" );
269 /* call a request handler */
270 static void call_req_handler( struct thread *thread )
272 union generic_reply reply;
273 enum request req = thread->req.request_header.req;
276 current->reply_size = 0;
278 memset( &reply, 0, sizeof(reply) );
280 if (debug_level) trace_request();
282 if (req < REQ_NB_REQUESTS)
283 req_handlers[req]( ¤t->req, &reply );
285 set_error( STATUS_NOT_IMPLEMENTED );
289 if (current->reply_fd)
291 reply.reply_header.error = current->error;
292 reply.reply_header.reply_size = current->reply_size;
293 if (debug_level) trace_reply( req, &reply );
294 send_reply( &reply );
296 else fatal_protocol_error( current, "no reply fd for request %d\n", req );
301 /* read a request from a thread */
302 void read_request( struct thread *thread )
306 if (!thread->req_toread) /* no pending request */
308 if ((ret = read( get_unix_fd( thread->request_fd ), &thread->req,
309 sizeof(thread->req) )) != sizeof(thread->req)) goto error;
310 if (!(thread->req_toread = thread->req.request_header.request_size))
312 /* no data, handle request at once */
313 call_req_handler( thread );
316 if (!(thread->req_data = malloc( thread->req_toread )))
317 fatal_protocol_error( thread, "no memory for %d bytes request\n", thread->req_toread );
320 /* read the variable sized data */
323 ret = read( get_unix_fd( thread->request_fd ),
324 (char *)thread->req_data + thread->req.request_header.request_size
325 - thread->req_toread,
326 thread->req_toread );
328 if (!(thread->req_toread -= ret))
330 call_req_handler( thread );
331 free( thread->req_data );
332 thread->req_data = NULL;
338 if (!ret) /* closed pipe */
339 kill_thread( thread, 0 );
341 fatal_protocol_error( thread, "partial read %d\n", ret );
342 else if (errno != EWOULDBLOCK && errno != EAGAIN)
343 fatal_protocol_perror( thread, "read" );
346 /* receive a file descriptor on the process socket */
347 int receive_fd( struct process *process )
352 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
353 msghdr.msg_accrightslen = sizeof(int);
354 msghdr.msg_accrights = (void *)&fd;
355 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
356 msghdr.msg_control = &cmsg;
357 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
359 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
361 myiovec.iov_base = (void *)&data;
362 myiovec.iov_len = sizeof(data);
364 ret = recvmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
365 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
369 if (ret == sizeof(data))
371 struct thread *thread;
373 if (data.tid) thread = get_thread_from_id( data.tid );
374 else thread = (struct thread *)grab_object( get_process_first_thread( process ));
376 if (!thread || thread->process != process || thread->state == TERMINATED)
379 fprintf( stderr, "%04x: *fd* %d <- %d bad thread id\n",
380 data.tid, data.fd, fd );
386 fprintf( stderr, "%04x: *fd* %d <- %d\n",
387 thread->id, data.fd, fd );
388 thread_add_inflight_fd( thread, data.fd, fd );
390 if (thread) release_object( thread );
396 kill_process( process, NULL, 0 );
400 fprintf( stderr, "Protocol error: process %p: partial recvmsg %d for fd\n",
402 kill_process( process, NULL, 1 );
406 if (errno != EWOULDBLOCK && errno != EAGAIN)
408 fprintf( stderr, "Protocol error: process %p: ", process );
410 kill_process( process, NULL, 1 );
416 /* send an fd to a client */
417 int send_client_fd( struct process *process, int fd, obj_handle_t handle )
422 fprintf( stderr, "%04x: *fd* %p -> %d\n",
423 current ? current->id : process->id, handle, fd );
425 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
426 msghdr.msg_accrightslen = sizeof(fd);
427 msghdr.msg_accrights = (void *)&fd;
428 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
429 msghdr.msg_control = &cmsg;
430 msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
432 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
434 myiovec.iov_base = (void *)&handle;
435 myiovec.iov_len = sizeof(handle);
437 ret = sendmsg( get_unix_fd( process->msg_fd ), &msghdr, 0 );
439 if (ret == sizeof(handle)) return 0;
443 fprintf( stderr, "Protocol error: process %p: partial sendmsg %d\n", process, ret );
444 kill_process( process, NULL, 1 );
446 else if (errno == EPIPE)
448 kill_process( process, NULL, 0 );
452 fprintf( stderr, "Protocol error: process %p: ", process );
454 kill_process( process, NULL, 1 );
459 /* get current tick count to return to client */
460 unsigned int get_tick_count(void)
463 gettimeofday( &t, NULL );
464 return ((t.tv_sec - server_start_time) * 1000) + (t.tv_usec / 1000);
467 static void master_socket_dump( struct object *obj, int verbose )
469 struct master_socket *sock = (struct master_socket *)obj;
470 assert( obj->ops == &master_socket_ops );
471 fprintf( stderr, "Master socket fd=%p\n", sock->fd );
474 static void master_socket_destroy( struct object *obj )
476 struct master_socket *sock = (struct master_socket *)obj;
477 assert( obj->ops == &master_socket_ops );
478 release_object( sock->fd );
481 /* handle a socket event */
482 static void master_socket_poll_event( struct fd *fd, int event )
484 struct master_socket *sock = get_fd_user( fd );
485 assert( master_socket->obj.ops == &master_socket_ops );
487 assert( sock == master_socket ); /* there is only one master socket */
489 if (event & (POLLERR | POLLHUP))
491 /* this is not supposed to happen */
492 fprintf( stderr, "wineserver: Error on master socket\n" );
493 release_object( sock );
495 else if (event & POLLIN)
497 struct sockaddr_un dummy;
498 unsigned int len = sizeof(dummy);
499 int client = accept( get_unix_fd( master_socket->fd ), (struct sockaddr *) &dummy, &len );
500 if (client == -1) return;
503 remove_timeout_user( sock->timeout );
504 sock->timeout = NULL;
506 fcntl( client, F_SETFL, O_NONBLOCK );
507 create_process( client );
511 /* remove the socket upon exit */
512 static void socket_cleanup(void)
514 static int do_it_once;
515 if (!do_it_once++) unlink( server_socket_name );
518 /* create a directory and check its permissions */
519 static void create_dir( const char *name, struct stat *st )
521 if (lstat( name, st ) == -1)
523 if (errno != ENOENT) fatal_perror( "lstat %s", name );
524 if (mkdir( name, 0700 ) == -1 && errno != EEXIST) fatal_perror( "mkdir %s", name );
525 if (lstat( name, st ) == -1) fatal_perror( "lstat %s", name );
527 if (!S_ISDIR(st->st_mode)) fatal_error( "%s is not a directory\n", name );
528 if (st->st_uid != getuid()) fatal_error( "%s is not owned by you\n", name );
529 if (st->st_mode & 077) fatal_error( "%s must not be accessible by other users\n", name );
532 /* create the server directory and chdir to it */
533 static void create_server_dir( const char *dir )
535 char *p, *server_dir;
538 if (!(server_dir = strdup( dir ))) fatal_error( "out of memory\n" );
540 /* first create the base directory if needed */
542 p = strrchr( server_dir, '/' );
544 create_dir( server_dir, &st );
546 /* now create the server directory */
549 create_dir( server_dir, &st );
551 if (chdir( server_dir ) == -1) fatal_perror( "chdir %s", server_dir );
552 if (stat( ".", &st2 ) == -1) fatal_perror( "stat %s", server_dir );
553 if (st.st_dev != st2.st_dev || st.st_ino != st2.st_ino)
554 fatal_error( "chdir did not end up in %s\n", server_dir );
559 /* create the lock file and return its file descriptor */
560 static int create_server_lock(void)
565 if (lstat( server_lock_name, &st ) == -1)
568 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name );
572 if (!S_ISREG(st.st_mode))
573 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name );
576 if ((fd = open( server_lock_name, O_CREAT|O_TRUNC|O_WRONLY, 0600 )) == -1)
577 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name );
581 /* wait for the server lock */
582 int wait_for_lock(void)
584 const char *server_dir = wine_get_server_dir();
588 if (!server_dir) return 0; /* no server dir, so no lock to wait on */
590 create_server_dir( server_dir );
591 fd = create_server_lock();
594 fl.l_whence = SEEK_SET;
597 r = fcntl( fd, F_SETLKW, &fl );
603 /* kill the wine server holding the lock */
604 int kill_lock_owner( int sig )
606 const char *server_dir = wine_get_server_dir();
611 if (!server_dir) return 0; /* no server dir, nothing to do */
613 create_server_dir( server_dir );
614 fd = create_server_lock();
616 for (i = 0; i < 10; i++)
619 fl.l_whence = SEEK_SET;
622 if (fcntl( fd, F_GETLK, &fl ) == -1) goto done;
623 if (fl.l_type != F_WRLCK) goto done; /* the file is not locked */
624 if (!pid) /* first time around */
626 if (!(pid = fl.l_pid)) goto done; /* shouldn't happen */
629 if (kill( pid, SIGINT ) == -1) goto done;
630 kill( pid, SIGCONT );
633 else /* just send the specified signal and return */
635 ret = (kill( pid, sig ) != -1);
639 else if (fl.l_pid != pid) goto done; /* no longer the same process */
642 /* waited long enough, now kill it */
643 kill( pid, SIGKILL );
650 /* acquire the main server lock */
651 static void acquire_lock(void)
653 struct sockaddr_un addr;
656 int fd, slen, got_lock = 0;
658 fd = create_server_lock();
661 fl.l_whence = SEEK_SET;
664 if (fcntl( fd, F_SETLK, &fl ) != -1)
666 /* check for crashed server */
667 if (stat( server_socket_name, &st ) != -1 && /* there is a leftover socket */
668 stat( "core", &st ) != -1 && st.st_size) /* and there is a non-empty core file */
671 "Warning: a previous instance of the wine server seems to have crashed.\n"
672 "Please run 'gdb %s %s/core',\n"
673 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
674 server_argv0, wine_get_server_dir() );
676 unlink( server_socket_name ); /* we got the lock, we can safely remove the socket */
678 /* in that case we reuse fd without closing it, this ensures
679 * that we hold the lock until the process exits */
688 /* check whether locks work at all on this file system */
689 if (fcntl( fd, F_GETLK, &fl ) == -1) break;
692 exit(2); /* we didn't get the lock, exit with special status */
694 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name );
696 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
700 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
701 addr.sun_family = AF_UNIX;
702 strcpy( addr.sun_path, server_socket_name );
703 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
704 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
707 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
709 if ((errno == EEXIST) || (errno == EADDRINUSE))
712 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
713 exit(2); /* we didn't get the lock, exit with special status */
715 fatal_perror( "bind" );
717 atexit( socket_cleanup );
718 chmod( server_socket_name, 0600 ); /* make sure no other user can connect */
719 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
721 if (!(master_socket = alloc_object( &master_socket_ops )) ||
722 !(master_socket->fd = create_anonymous_fd( &master_socket_fd_ops, fd, &master_socket->obj )))
723 fatal_error( "out of memory\n" );
724 master_socket->timeout = NULL;
725 set_fd_events( master_socket->fd, POLLIN );
726 make_object_static( &master_socket->obj );
729 /* open the master server socket and start waiting for new clients */
730 void open_master_socket(void)
732 const char *server_dir = wine_get_server_dir();
733 int fd, pid, status, sync_pipe[2];
736 /* make sure no request is larger than the maximum size */
737 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
738 assert( sizeof(union generic_reply) == sizeof(struct request_max_size) );
740 if (!server_dir) fatal_error( "directory %s cannot be accessed\n", wine_get_config_dir() );
741 create_server_dir( server_dir );
745 if (pipe( sync_pipe ) == -1) fatal_perror( "pipe" );
751 close( sync_pipe[0] );
755 /* close stdin and stdout */
756 if ((fd = open( "/dev/null", O_RDWR )) != -1)
765 write( sync_pipe[1], &dummy, 1 );
766 close( sync_pipe[1] );
770 fatal_perror( "fork" );
773 default: /* parent */
774 close( sync_pipe[1] );
776 /* wait for child to signal us and then exit */
777 if (read( sync_pipe[0], &dummy, 1 ) == 1) _exit(0);
779 /* child terminated, propagate exit status */
780 wait4( pid, &status, 0, NULL );
781 if (WIFEXITED(status)) _exit( WEXITSTATUS(status) );
785 else /* remain in the foreground */
790 /* setup msghdr structure constant fields */
791 msghdr.msg_name = NULL;
792 msghdr.msg_namelen = 0;
793 msghdr.msg_iov = &myiovec;
794 msghdr.msg_iovlen = 1;
796 /* init startup time */
797 server_start_time = time(NULL);
800 /* master socket timer expiration handler */
801 static void close_socket_timeout( void *arg )
803 master_socket->timeout = NULL;
806 /* if a new client is waiting, we keep on running */
807 if (check_fd_events( master_socket->fd, POLLIN )) return;
809 if (debug_level) fprintf( stderr, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
812 close_objects(); /* shut down everything properly */
817 /* close the master socket and stop waiting for new clients */
818 void close_master_socket(void)
822 if (master_socket_timeout == -1) return; /* just keep running forever */
824 if (master_socket_timeout)
826 gettimeofday( &when, NULL );
827 add_timeout( &when, master_socket_timeout * 1000 );
828 master_socket->timeout = add_timeout_user( &when, close_socket_timeout, NULL );
830 else close_socket_timeout( NULL ); /* close it right away */
833 /* lock/unlock the master socket to stop accepting new clients */
834 void lock_master_socket( int locked )
836 set_fd_events( master_socket->fd, locked ? 0 : POLLIN );