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 /* socket communication static structures */
130 static struct iovec myiovec
;
131 static struct msghdr msghdr
;
132 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
137 size_t len
; /* size of structure */
138 int level
; /* SOL_SOCKET */
139 int type
; /* SCM_RIGHTS */
141 int fd
; /* fd to pass */
143 static struct cmsg_fd cmsg
= { { sizeof(cmsg
.header
) + sizeof(cmsg
.fd
), SOL_SOCKET
, SCM_RIGHTS
}, -1 };
144 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
146 /* complain about a protocol error and terminate the client connection */
147 void fatal_protocol_error( struct thread
*thread
, const char *err
, ... )
151 va_start( args
, err
);
152 fprintf( stderr
, "Protocol error:%04x: ", thread
->id
);
153 vfprintf( stderr
, err
, args
);
155 thread
->exit_code
= 1;
156 kill_thread( thread
, 1 );
159 /* complain about a protocol error and terminate the client connection */
160 void fatal_protocol_perror( struct thread
*thread
, const char *err
, ... )
164 va_start( args
, err
);
165 fprintf( stderr
, "Protocol error:%04x: ", thread
->id
);
166 vfprintf( stderr
, err
, args
);
169 thread
->exit_code
= 1;
170 kill_thread( thread
, 1 );
173 /* die on a fatal error */
174 void fatal_error( const char *err
, ... )
178 va_start( args
, err
);
179 fprintf( stderr
, "wineserver: " );
180 vfprintf( stderr
, err
, args
);
185 /* die on a fatal error */
186 void fatal_perror( const char *err
, ... )
190 va_start( args
, err
);
191 fprintf( stderr
, "wineserver: " );
192 vfprintf( stderr
, err
, args
);
198 /* allocate the reply data */
199 void *set_reply_data_size( data_size_t size
)
201 assert( size
<= get_reply_max_size() );
202 if (size
&& !(current
->reply_data
= mem_alloc( size
))) size
= 0;
203 current
->reply_size
= size
;
204 return current
->reply_data
;
207 /* write the remaining part of the reply */
208 void write_reply( struct thread
*thread
)
212 if ((ret
= write( get_unix_fd( thread
->reply_fd
),
213 (char *)thread
->reply_data
+ thread
->reply_size
- thread
->reply_towrite
,
214 thread
->reply_towrite
)) >= 0)
216 if (!(thread
->reply_towrite
-= ret
))
218 free( thread
->reply_data
);
219 thread
->reply_data
= NULL
;
220 /* sent everything, can go back to waiting for requests */
221 set_fd_events( thread
->request_fd
, POLLIN
);
222 set_fd_events( thread
->reply_fd
, 0 );
227 kill_thread( thread
, 0 ); /* normal death */
228 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
229 fatal_protocol_perror( thread
, "reply write" );
232 /* send a reply to the current thread */
233 static void send_reply( union generic_reply
*reply
)
237 if (!current
->reply_size
)
239 if ((ret
= write( get_unix_fd( current
->reply_fd
),
240 reply
, sizeof(*reply
) )) != sizeof(*reply
)) goto error
;
246 vec
[0].iov_base
= (void *)reply
;
247 vec
[0].iov_len
= sizeof(*reply
);
248 vec
[1].iov_base
= current
->reply_data
;
249 vec
[1].iov_len
= current
->reply_size
;
251 if ((ret
= writev( get_unix_fd( current
->reply_fd
), vec
, 2 )) < sizeof(*reply
)) goto error
;
253 if ((current
->reply_towrite
= current
->reply_size
- (ret
- sizeof(*reply
))))
255 /* couldn't write it all, wait for POLLOUT */
256 set_fd_events( current
->reply_fd
, POLLOUT
);
257 set_fd_events( current
->request_fd
, 0 );
261 free( current
->reply_data
);
262 current
->reply_data
= NULL
;
267 fatal_protocol_error( current
, "partial write %d\n", ret
);
268 else if (errno
== EPIPE
)
269 kill_thread( current
, 0 ); /* normal death */
271 fatal_protocol_perror( current
, "reply write" );
274 /* call a request handler */
275 static void call_req_handler( struct thread
*thread
)
277 union generic_reply reply
;
278 enum request req
= thread
->req
.request_header
.req
;
281 current
->reply_size
= 0;
283 memset( &reply
, 0, sizeof(reply
) );
285 if (debug_level
) trace_request();
287 if (req
< REQ_NB_REQUESTS
)
288 req_handlers
[req
]( ¤t
->req
, &reply
);
290 set_error( STATUS_NOT_IMPLEMENTED
);
294 if (current
->reply_fd
)
296 reply
.reply_header
.error
= current
->error
;
297 reply
.reply_header
.reply_size
= current
->reply_size
;
298 if (debug_level
) trace_reply( req
, &reply
);
299 send_reply( &reply
);
303 current
->exit_code
= 1;
304 kill_thread( current
, 1 ); /* no way to continue without reply fd */
310 /* read a request from a thread */
311 void read_request( struct thread
*thread
)
315 if (!thread
->req_toread
) /* no pending request */
317 if ((ret
= read( get_unix_fd( thread
->request_fd
), &thread
->req
,
318 sizeof(thread
->req
) )) != sizeof(thread
->req
)) goto error
;
319 if (!(thread
->req_toread
= thread
->req
.request_header
.request_size
))
321 /* no data, handle request at once */
322 call_req_handler( thread
);
325 if (!(thread
->req_data
= malloc( thread
->req_toread
)))
327 fatal_protocol_error( thread
, "no memory for %u bytes request %d\n",
328 thread
->req_toread
, thread
->req
.request_header
.req
);
333 /* read the variable sized data */
336 ret
= read( get_unix_fd( thread
->request_fd
),
337 (char *)thread
->req_data
+ thread
->req
.request_header
.request_size
338 - thread
->req_toread
,
339 thread
->req_toread
);
341 if (!(thread
->req_toread
-= ret
))
343 call_req_handler( thread
);
344 free( thread
->req_data
);
345 thread
->req_data
= NULL
;
351 if (!ret
) /* closed pipe */
352 kill_thread( thread
, 0 );
354 fatal_protocol_error( thread
, "partial read %d\n", ret
);
355 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
356 fatal_protocol_perror( thread
, "read" );
359 /* receive a file descriptor on the process socket */
360 int receive_fd( struct process
*process
)
365 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
366 msghdr
.msg_accrightslen
= sizeof(int);
367 msghdr
.msg_accrights
= (void *)&fd
;
368 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
369 msghdr
.msg_control
= &cmsg
;
370 msghdr
.msg_controllen
= sizeof(cmsg
.header
) + sizeof(fd
);
372 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
374 myiovec
.iov_base
= (void *)&data
;
375 myiovec
.iov_len
= sizeof(data
);
377 ret
= recvmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
378 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
382 if (ret
== sizeof(data
))
384 struct thread
*thread
;
386 if (data
.tid
) thread
= get_thread_from_id( data
.tid
);
387 else thread
= (struct thread
*)grab_object( get_process_first_thread( process
));
389 if (!thread
|| thread
->process
!= process
|| thread
->state
== TERMINATED
)
392 fprintf( stderr
, "%04x: *fd* %d <- %d bad thread id\n",
393 data
.tid
, data
.fd
, fd
);
399 fprintf( stderr
, "%04x: *fd* %d <- %d\n",
400 thread
->id
, data
.fd
, fd
);
401 thread_add_inflight_fd( thread
, data
.fd
, fd
);
403 if (thread
) release_object( thread
);
409 kill_process( process
, 0 );
413 fprintf( stderr
, "Protocol error: process %04x: partial recvmsg %d for fd\n",
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
)
435 fprintf( stderr
, "%04x: *fd* %p -> %d\n",
436 current
? current
->id
: process
->id
, handle
, fd
);
438 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
439 msghdr
.msg_accrightslen
= sizeof(fd
);
440 msghdr
.msg_accrights
= (void *)&fd
;
441 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
442 msghdr
.msg_control
= &cmsg
;
443 msghdr
.msg_controllen
= sizeof(cmsg
.header
) + sizeof(fd
);
445 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
447 myiovec
.iov_base
= (void *)&handle
;
448 myiovec
.iov_len
= sizeof(handle
);
450 ret
= sendmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
452 if (ret
== sizeof(handle
)) return 0;
456 fprintf( stderr
, "Protocol error: process %04x: partial sendmsg %d\n", process
->id
, ret
);
457 kill_process( process
, 1 );
459 else if (errno
== EPIPE
)
461 kill_process( process
, 0 );
465 fprintf( stderr
, "Protocol error: process %04x: ", process
->id
);
467 kill_process( process
, 1 );
472 /* get current tick count to return to client */
473 unsigned int get_tick_count(void)
475 return (current_time
- server_start_time
) / 10000;
478 static void master_socket_dump( struct object
*obj
, int verbose
)
480 struct master_socket
*sock
= (struct master_socket
*)obj
;
481 assert( obj
->ops
== &master_socket_ops
);
482 fprintf( stderr
, "Master socket fd=%p\n", sock
->fd
);
485 static void master_socket_destroy( struct object
*obj
)
487 struct master_socket
*sock
= (struct master_socket
*)obj
;
488 assert( obj
->ops
== &master_socket_ops
);
489 release_object( sock
->fd
);
492 /* handle a socket event */
493 static void master_socket_poll_event( struct fd
*fd
, int event
)
495 struct master_socket
*sock
= get_fd_user( fd
);
496 assert( master_socket
->obj
.ops
== &master_socket_ops
);
498 assert( sock
== master_socket
); /* there is only one master socket */
500 if (event
& (POLLERR
| POLLHUP
))
502 /* this is not supposed to happen */
503 fprintf( stderr
, "wineserver: Error on master socket\n" );
504 set_fd_events( sock
->fd
, -1 );
506 else if (event
& POLLIN
)
508 struct sockaddr_un dummy
;
509 unsigned int len
= sizeof(dummy
);
510 int client
= accept( get_unix_fd( master_socket
->fd
), (struct sockaddr
*) &dummy
, &len
);
511 if (client
== -1) return;
512 fcntl( client
, F_SETFL
, O_NONBLOCK
);
513 create_process( client
, NULL
, 0 );
517 /* remove the socket upon exit */
518 static void socket_cleanup(void)
520 static int do_it_once
;
521 if (!do_it_once
++) unlink( server_socket_name
);
524 /* create a directory and check its permissions */
525 static void create_dir( const char *name
, struct stat
*st
)
527 if (lstat( name
, st
) == -1)
529 if (errno
!= ENOENT
) fatal_perror( "lstat %s", name
);
530 if (mkdir( name
, 0700 ) == -1 && errno
!= EEXIST
) fatal_perror( "mkdir %s", name
);
531 if (lstat( name
, st
) == -1) fatal_perror( "lstat %s", name
);
533 if (!S_ISDIR(st
->st_mode
)) fatal_error( "%s is not a directory\n", name
);
534 if (st
->st_uid
!= getuid()) fatal_error( "%s is not owned by you\n", name
);
535 if (st
->st_mode
& 077) fatal_error( "%s must not be accessible by other users\n", name
);
538 /* create the server directory and chdir to it */
539 static void create_server_dir( const char *dir
)
541 char *p
, *server_dir
;
544 if (!(server_dir
= strdup( dir
))) fatal_error( "out of memory\n" );
546 /* first create the base directory if needed */
548 p
= strrchr( server_dir
, '/' );
550 create_dir( server_dir
, &st
);
552 /* now create the server directory */
555 create_dir( server_dir
, &st
);
557 if (chdir( server_dir
) == -1) fatal_perror( "chdir %s", server_dir
);
558 if ((server_dir_fd
= open( ".", O_RDONLY
)) == -1) fatal_perror( "open %s", server_dir
);
559 if (fstat( server_dir_fd
, &st2
) == -1) fatal_perror( "stat %s", server_dir
);
560 if (st
.st_dev
!= st2
.st_dev
|| st
.st_ino
!= st2
.st_ino
)
561 fatal_error( "chdir did not end up in %s\n", server_dir
);
566 /* create the lock file and return its file descriptor */
567 static int create_server_lock(void)
572 if (lstat( server_lock_name
, &st
) == -1)
575 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name
);
579 if (!S_ISREG(st
.st_mode
))
580 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name
);
583 if ((fd
= open( server_lock_name
, O_CREAT
|O_TRUNC
|O_WRONLY
, 0600 )) == -1)
584 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name
);
588 /* wait for the server lock */
589 int wait_for_lock(void)
591 const char *server_dir
= wine_get_server_dir();
595 if (!server_dir
) return 0; /* no server dir, so no lock to wait on */
597 create_server_dir( server_dir
);
598 fd
= create_server_lock();
601 fl
.l_whence
= SEEK_SET
;
604 r
= fcntl( fd
, F_SETLKW
, &fl
);
610 /* kill the wine server holding the lock */
611 int kill_lock_owner( int sig
)
613 const char *server_dir
= wine_get_server_dir();
618 if (!server_dir
) return 0; /* no server dir, nothing to do */
620 create_server_dir( server_dir
);
621 fd
= create_server_lock();
623 for (i
= 1; i
<= 20; i
++)
626 fl
.l_whence
= SEEK_SET
;
629 if (fcntl( fd
, F_GETLK
, &fl
) == -1) goto done
;
630 if (fl
.l_type
!= F_WRLCK
) goto done
; /* the file is not locked */
631 if (!pid
) /* first time around */
633 if (!(pid
= fl
.l_pid
)) goto done
; /* shouldn't happen */
636 if (kill( pid
, SIGINT
) == -1) goto done
;
637 kill( pid
, SIGCONT
);
640 else /* just send the specified signal and return */
642 ret
= (kill( pid
, sig
) != -1);
646 else if (fl
.l_pid
!= pid
) goto done
; /* no longer the same process */
649 /* waited long enough, now kill it */
650 kill( pid
, SIGKILL
);
657 /* acquire the main server lock */
658 static void acquire_lock(void)
660 struct sockaddr_un addr
;
663 int fd
, slen
, got_lock
= 0;
665 fd
= create_server_lock();
668 fl
.l_whence
= SEEK_SET
;
671 if (fcntl( fd
, F_SETLK
, &fl
) != -1)
673 /* check for crashed server */
674 if (stat( server_socket_name
, &st
) != -1 && /* there is a leftover socket */
675 stat( "core", &st
) != -1 && st
.st_size
) /* and there is a non-empty core file */
678 "Warning: a previous instance of the wine server seems to have crashed.\n"
679 "Please run 'gdb %s %s/core',\n"
680 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
681 server_argv0
, wine_get_server_dir() );
683 unlink( server_socket_name
); /* we got the lock, we can safely remove the socket */
685 /* in that case we reuse fd without closing it, this ensures
686 * that we hold the lock until the process exits */
695 /* check whether locks work at all on this file system */
696 if (fcntl( fd
, F_GETLK
, &fl
) == -1) break;
699 exit(2); /* we didn't get the lock, exit with special status */
701 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name
);
703 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
707 if ((fd
= socket( AF_UNIX
, SOCK_STREAM
, 0 )) == -1) fatal_perror( "socket" );
708 addr
.sun_family
= AF_UNIX
;
709 strcpy( addr
.sun_path
, server_socket_name
);
710 slen
= sizeof(addr
) - sizeof(addr
.sun_path
) + strlen(addr
.sun_path
) + 1;
711 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
714 if (bind( fd
, (struct sockaddr
*)&addr
, slen
) == -1)
716 if ((errno
== EEXIST
) || (errno
== EADDRINUSE
))
719 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
720 exit(2); /* we didn't get the lock, exit with special status */
722 fatal_perror( "bind" );
724 atexit( socket_cleanup
);
725 chmod( server_socket_name
, 0600 ); /* make sure no other user can connect */
726 if (listen( fd
, 5 ) == -1) fatal_perror( "listen" );
728 if (!(master_socket
= alloc_object( &master_socket_ops
)) ||
729 !(master_socket
->fd
= create_anonymous_fd( &master_socket_fd_ops
, fd
, &master_socket
->obj
, 0 )))
730 fatal_error( "out of memory\n" );
731 set_fd_events( master_socket
->fd
, POLLIN
);
732 make_object_static( &master_socket
->obj
);
735 /* open the master server socket and start waiting for new clients */
736 void open_master_socket(void)
738 const char *server_dir
= wine_get_server_dir();
739 const char *config_dir
= wine_get_config_dir();
740 int fd
, pid
, status
, sync_pipe
[2];
743 /* make sure no request is larger than the maximum size */
744 assert( sizeof(union generic_request
) == sizeof(struct request_max_size
) );
745 assert( sizeof(union generic_reply
) == sizeof(struct request_max_size
) );
747 if (!server_dir
) fatal_error( "directory %s cannot be accessed\n", config_dir
);
748 if (chdir( config_dir
) == -1) fatal_perror( "chdir to %s", config_dir
);
749 if ((config_dir_fd
= open( ".", O_RDONLY
)) == -1) fatal_perror( "open %s", config_dir
);
751 create_server_dir( server_dir
);
755 if (pipe( sync_pipe
) == -1) fatal_perror( "pipe" );
761 close( sync_pipe
[0] );
765 /* close stdin and stdout */
766 if ((fd
= open( "/dev/null", O_RDWR
)) != -1)
775 write( sync_pipe
[1], &dummy
, 1 );
776 close( sync_pipe
[1] );
780 fatal_perror( "fork" );
783 default: /* parent */
784 close( sync_pipe
[1] );
786 /* wait for child to signal us and then exit */
787 if (read( sync_pipe
[0], &dummy
, 1 ) == 1) _exit(0);
789 /* child terminated, propagate exit status */
790 wait4( pid
, &status
, 0, NULL
);
791 if (WIFEXITED(status
)) _exit( WEXITSTATUS(status
) );
795 else /* remain in the foreground */
800 /* setup msghdr structure constant fields */
801 msghdr
.msg_name
= NULL
;
802 msghdr
.msg_namelen
= 0;
803 msghdr
.msg_iov
= &myiovec
;
804 msghdr
.msg_iovlen
= 1;
806 /* init the process tracing mechanism */
807 init_tracing_mechanism();
810 /* master socket timer expiration handler */
811 static void close_socket_timeout( void *arg
)
813 master_timeout
= NULL
;
815 if (debug_level
) fprintf( stderr
, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
818 close_objects(); /* shut down everything properly */
823 /* close the master socket and stop waiting for new clients */
824 void close_master_socket( timeout_t timeout
)
828 release_object( master_socket
);
829 master_socket
= NULL
;
831 if (master_timeout
) /* cancel previous timeout */
832 remove_timeout_user( master_timeout
);
834 master_timeout
= add_timeout_user( timeout
, close_socket_timeout
, NULL
);