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_get_fd
, /* get_fd */
97 master_socket_destroy
/* destroy */
100 static const struct fd_ops master_socket_fd_ops
=
102 NULL
, /* get_poll_events */
103 master_socket_poll_event
, /* poll_event */
104 no_flush
, /* flush */
105 no_get_file_info
, /* get_file_info */
106 no_queue_async
, /* queue_async */
107 no_cancel_async
/* cancel_async */
111 struct thread
*current
= NULL
; /* thread handling the current request */
112 unsigned int global_error
= 0; /* global error code for when no thread is current */
113 unsigned int server_start_ticks
= 0; /* tick count offset from server startup */
115 static struct master_socket
*master_socket
; /* the master socket object */
117 /* socket communication static structures */
118 static struct iovec myiovec
;
119 static struct msghdr msghdr
;
120 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
123 int len
; /* size of structure */
124 int level
; /* SOL_SOCKET */
125 int type
; /* SCM_RIGHTS */
126 int fd
; /* fd to pass */
128 static struct cmsg_fd cmsg
= { sizeof(cmsg
), SOL_SOCKET
, SCM_RIGHTS
, -1 };
129 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
131 /* complain about a protocol error and terminate the client connection */
132 void fatal_protocol_error( struct thread
*thread
, const char *err
, ... )
136 va_start( args
, err
);
137 fprintf( stderr
, "Protocol error:%p: ", thread
);
138 vfprintf( stderr
, err
, args
);
140 thread
->exit_code
= 1;
141 kill_thread( thread
, 1 );
144 /* complain about a protocol error and terminate the client connection */
145 void fatal_protocol_perror( struct thread
*thread
, const char *err
, ... )
149 va_start( args
, err
);
150 fprintf( stderr
, "Protocol error:%p: ", thread
);
151 vfprintf( stderr
, err
, args
);
154 thread
->exit_code
= 1;
155 kill_thread( thread
, 1 );
158 /* die on a fatal error */
159 void fatal_error( const char *err
, ... )
163 va_start( args
, err
);
164 fprintf( stderr
, "wineserver: " );
165 vfprintf( stderr
, err
, args
);
170 /* die on a fatal error */
171 void fatal_perror( const char *err
, ... )
175 va_start( args
, err
);
176 fprintf( stderr
, "wineserver: " );
177 vfprintf( stderr
, err
, args
);
183 /* allocate the reply data */
184 void *set_reply_data_size( size_t size
)
186 assert( size
<= get_reply_max_size() );
187 if (size
&& !(current
->reply_data
= mem_alloc( size
))) size
= 0;
188 current
->reply_size
= size
;
189 return current
->reply_data
;
192 /* write the remaining part of the reply */
193 void write_reply( struct thread
*thread
)
197 if ((ret
= write( get_unix_fd( thread
->reply_fd
),
198 (char *)thread
->reply_data
+ thread
->reply_size
- thread
->reply_towrite
,
199 thread
->reply_towrite
)) >= 0)
201 if (!(thread
->reply_towrite
-= ret
))
203 free( thread
->reply_data
);
204 thread
->reply_data
= NULL
;
205 /* sent everything, can go back to waiting for requests */
206 set_fd_events( thread
->request_fd
, POLLIN
);
207 set_fd_events( thread
->reply_fd
, 0 );
212 kill_thread( thread
, 0 ); /* normal death */
213 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
214 fatal_protocol_perror( thread
, "reply write" );
217 /* send a reply to the current thread */
218 static void send_reply( union generic_reply
*reply
)
222 if (!current
->reply_size
)
224 if ((ret
= write( get_unix_fd( current
->reply_fd
),
225 reply
, sizeof(*reply
) )) != sizeof(*reply
)) goto error
;
231 vec
[0].iov_base
= (void *)reply
;
232 vec
[0].iov_len
= sizeof(*reply
);
233 vec
[1].iov_base
= current
->reply_data
;
234 vec
[1].iov_len
= current
->reply_size
;
236 if ((ret
= writev( get_unix_fd( current
->reply_fd
), vec
, 2 )) < sizeof(*reply
)) goto error
;
238 if ((current
->reply_towrite
= current
->reply_size
- (ret
- sizeof(*reply
))))
240 /* couldn't write it all, wait for POLLOUT */
241 set_fd_events( current
->reply_fd
, POLLOUT
);
242 set_fd_events( current
->request_fd
, 0 );
246 if (current
->reply_data
)
248 free( current
->reply_data
);
249 current
->reply_data
= NULL
;
255 fatal_protocol_error( current
, "partial write %d\n", ret
);
256 else if (errno
== EPIPE
)
257 kill_thread( current
, 0 ); /* normal death */
259 fatal_protocol_perror( current
, "reply write" );
262 /* call a request handler */
263 static void call_req_handler( struct thread
*thread
)
265 union generic_reply reply
;
266 enum request req
= thread
->req
.request_header
.req
;
269 current
->reply_size
= 0;
271 memset( &reply
, 0, sizeof(reply
) );
273 if (debug_level
) trace_request();
275 if (req
< REQ_NB_REQUESTS
)
277 req_handlers
[req
]( ¤t
->req
, &reply
);
280 if (current
->reply_fd
)
282 reply
.reply_header
.error
= current
->error
;
283 reply
.reply_header
.reply_size
= current
->reply_size
;
284 if (debug_level
) trace_reply( req
, &reply
);
285 send_reply( &reply
);
287 else fatal_protocol_error( current
, "no reply fd for request %d\n", req
);
292 fatal_protocol_error( current
, "bad request %d\n", req
);
295 /* read a request from a thread */
296 void read_request( struct thread
*thread
)
300 if (!thread
->req_toread
) /* no pending request */
302 if ((ret
= read( get_unix_fd( thread
->request_fd
), &thread
->req
,
303 sizeof(thread
->req
) )) != sizeof(thread
->req
)) goto error
;
304 if (!(thread
->req_toread
= thread
->req
.request_header
.request_size
))
306 /* no data, handle request at once */
307 call_req_handler( thread
);
310 if (!(thread
->req_data
= malloc( thread
->req_toread
)))
311 fatal_protocol_error( thread
, "no memory for %d bytes request\n", thread
->req_toread
);
314 /* read the variable sized data */
317 ret
= read( get_unix_fd( thread
->request_fd
),
318 (char *)thread
->req_data
+ thread
->req
.request_header
.request_size
319 - thread
->req_toread
,
320 thread
->req_toread
);
322 if (!(thread
->req_toread
-= ret
))
324 call_req_handler( thread
);
325 free( thread
->req_data
);
326 thread
->req_data
= NULL
;
332 if (!ret
) /* closed pipe */
333 kill_thread( thread
, 0 );
335 fatal_protocol_error( thread
, "partial read %d\n", ret
);
336 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
337 fatal_protocol_perror( thread
, "read" );
340 /* receive a file descriptor on the process socket */
341 int receive_fd( struct process
*process
)
346 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
347 msghdr
.msg_accrightslen
= sizeof(int);
348 msghdr
.msg_accrights
= (void *)&fd
;
349 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
350 msghdr
.msg_control
= &cmsg
;
351 msghdr
.msg_controllen
= sizeof(cmsg
);
353 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
355 myiovec
.iov_base
= (void *)&data
;
356 myiovec
.iov_len
= sizeof(data
);
358 ret
= recvmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
359 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
363 if (ret
== sizeof(data
))
365 struct thread
*thread
;
367 if (data
.tid
) thread
= get_thread_from_id( data
.tid
);
368 else thread
= (struct thread
*)grab_object( get_process_first_thread( process
));
370 if (!thread
|| thread
->process
!= process
|| thread
->state
== TERMINATED
)
373 fprintf( stderr
, "%04x: *fd* %d <- %d bad thread id\n",
374 data
.tid
, data
.fd
, fd
);
380 fprintf( stderr
, "%04x: *fd* %d <- %d\n",
381 thread
->id
, data
.fd
, fd
);
382 thread_add_inflight_fd( thread
, data
.fd
, fd
);
384 if (thread
) release_object( thread
);
391 fprintf( stderr
, "Protocol error: process %p: partial recvmsg %d for fd\n",
393 kill_process( process
, NULL
, 1 );
397 if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
399 fprintf( stderr
, "Protocol error: process %p: ", process
);
401 kill_process( process
, NULL
, 1 );
407 /* send an fd to a client */
408 int send_client_fd( struct process
*process
, int fd
, obj_handle_t handle
)
413 fprintf( stderr
, "%04x: *fd* %p -> %d\n",
414 current
? current
->id
: process
->id
, handle
, fd
);
416 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
417 msghdr
.msg_accrightslen
= sizeof(fd
);
418 msghdr
.msg_accrights
= (void *)&fd
;
419 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
420 msghdr
.msg_control
= &cmsg
;
421 msghdr
.msg_controllen
= sizeof(cmsg
);
423 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
425 myiovec
.iov_base
= (void *)&handle
;
426 myiovec
.iov_len
= sizeof(handle
);
428 ret
= sendmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
430 if (ret
== sizeof(handle
)) return 0;
434 fprintf( stderr
, "Protocol error: process %p: partial sendmsg %d\n", process
, ret
);
435 kill_process( process
, NULL
, 1 );
437 else if (errno
== EPIPE
)
439 kill_process( process
, NULL
, 0 );
443 fprintf( stderr
, "Protocol error: process %p: ", process
);
445 kill_process( process
, NULL
, 1 );
450 /* get current tick count to return to client */
451 unsigned int get_tick_count(void)
454 gettimeofday( &t
, NULL
);
455 return (t
.tv_sec
* 1000) + (t
.tv_usec
/ 1000) - server_start_ticks
;
458 static void master_socket_dump( struct object
*obj
, int verbose
)
460 struct master_socket
*sock
= (struct master_socket
*)obj
;
461 assert( obj
->ops
== &master_socket_ops
);
462 fprintf( stderr
, "Master socket fd=%p\n", sock
->fd
);
465 static void master_socket_destroy( struct object
*obj
)
467 struct master_socket
*sock
= (struct master_socket
*)obj
;
468 assert( obj
->ops
== &master_socket_ops
);
469 release_object( sock
->fd
);
472 /* handle a socket event */
473 static void master_socket_poll_event( struct fd
*fd
, int event
)
475 struct master_socket
*sock
= get_fd_user( fd
);
476 assert( master_socket
->obj
.ops
== &master_socket_ops
);
478 assert( sock
== master_socket
); /* there is only one master socket */
480 if (event
& (POLLERR
| POLLHUP
))
482 /* this is not supposed to happen */
483 fprintf( stderr
, "wineserver: Error on master socket\n" );
484 release_object( sock
);
486 else if (event
& POLLIN
)
488 struct sockaddr_un dummy
;
489 int len
= sizeof(dummy
);
490 int client
= accept( get_unix_fd( master_socket
->fd
), (struct sockaddr
*) &dummy
, &len
);
491 if (client
== -1) return;
494 remove_timeout_user( sock
->timeout
);
495 sock
->timeout
= NULL
;
497 fcntl( client
, F_SETFL
, O_NONBLOCK
);
498 create_process( client
);
502 /* remove the socket upon exit */
503 static void socket_cleanup(void)
505 static int do_it_once
;
506 if (!do_it_once
++) unlink( server_socket_name
);
509 /* create a directory and check its permissions */
510 static void create_dir( const char *name
, struct stat
*st
)
512 if (lstat( name
, st
) == -1)
514 if (errno
!= ENOENT
) fatal_perror( "lstat %s", name
);
515 if (mkdir( name
, 0700 ) == -1 && errno
!= EEXIST
) fatal_perror( "mkdir %s", name
);
516 if (lstat( name
, st
) == -1) fatal_perror( "lstat %s", name
);
518 if (!S_ISDIR(st
->st_mode
)) fatal_error( "%s is not a directory\n", name
);
519 if (st
->st_uid
!= getuid()) fatal_error( "%s is not owned by you\n", name
);
520 if (st
->st_mode
& 077) fatal_error( "%s must not be accessible by other users\n", name
);
523 /* create the server directory and chdir to it */
524 static void create_server_dir(void)
526 char *p
, *server_dir
;
529 if (!(server_dir
= strdup( wine_get_server_dir() ))) fatal_error( "out of memory\n" );
531 /* first create the base directory if needed */
533 p
= strrchr( server_dir
, '/' );
535 create_dir( server_dir
, &st
);
537 /* now create the server directory */
540 create_dir( server_dir
, &st
);
542 if (chdir( server_dir
) == -1) fatal_perror( "chdir %s", server_dir
);
543 if (stat( ".", &st2
) == -1) fatal_perror( "stat %s", server_dir
);
544 if (st
.st_dev
!= st2
.st_dev
|| st
.st_ino
!= st2
.st_ino
)
545 fatal_error( "chdir did not end up in %s\n", server_dir
);
550 /* create the lock file and return its file descriptor */
551 static int create_server_lock(void)
556 if (lstat( server_lock_name
, &st
) == -1)
559 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name
);
563 if (!S_ISREG(st
.st_mode
))
564 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name
);
567 if ((fd
= open( server_lock_name
, O_CREAT
|O_TRUNC
|O_WRONLY
, 0600 )) == -1)
568 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name
);
572 /* wait for the server lock */
573 int wait_for_lock(void)
579 fd
= create_server_lock();
582 fl
.l_whence
= SEEK_SET
;
585 r
= fcntl( fd
, F_SETLKW
, &fl
);
591 /* kill the wine server holding the lock */
592 int kill_lock_owner( int sig
)
599 fd
= create_server_lock();
601 for (i
= 0; i
< 10; i
++)
604 fl
.l_whence
= SEEK_SET
;
607 if (fcntl( fd
, F_GETLK
, &fl
) == -1) goto done
;
608 if (fl
.l_type
!= F_WRLCK
) goto done
; /* the file is not locked */
609 if (!pid
) /* first time around */
611 if (!(pid
= fl
.l_pid
)) goto done
; /* shouldn't happen */
614 if (kill( pid
, SIGINT
) == -1) goto done
;
615 kill( pid
, SIGCONT
);
618 else /* just send the specified signal and return */
620 ret
= (kill( pid
, sig
) != -1);
624 else if (fl
.l_pid
!= pid
) goto done
; /* no longer the same process */
627 /* waited long enough, now kill it */
628 kill( pid
, SIGKILL
);
635 /* acquire the main server lock */
636 static void acquire_lock(void)
638 struct sockaddr_un addr
;
641 int fd
, slen
, got_lock
= 0;
643 fd
= create_server_lock();
646 fl
.l_whence
= SEEK_SET
;
649 if (fcntl( fd
, F_SETLK
, &fl
) != -1)
651 /* check for crashed server */
652 if (stat( server_socket_name
, &st
) != -1 && /* there is a leftover socket */
653 stat( "core", &st
) != -1 && st
.st_size
) /* and there is a non-empty core file */
656 "Warning: a previous instance of the wine server seems to have crashed.\n"
657 "Please run 'gdb %s %s/core',\n"
658 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
659 server_argv0
, wine_get_server_dir() );
661 unlink( server_socket_name
); /* we got the lock, we can safely remove the socket */
663 /* in that case we reuse fd without closing it, this ensures
664 * that we hold the lock until the process exits */
673 /* check whether locks work at all on this file system */
674 if (fcntl( fd
, F_GETLK
, &fl
) == -1) break;
677 exit(2); /* we didn't get the lock, exit with special status */
679 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name
);
681 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
685 if ((fd
= socket( AF_UNIX
, SOCK_STREAM
, 0 )) == -1) fatal_perror( "socket" );
686 addr
.sun_family
= AF_UNIX
;
687 strcpy( addr
.sun_path
, server_socket_name
);
688 slen
= sizeof(addr
) - sizeof(addr
.sun_path
) + strlen(addr
.sun_path
) + 1;
689 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
692 if (bind( fd
, (struct sockaddr
*)&addr
, slen
) == -1)
694 if ((errno
== EEXIST
) || (errno
== EADDRINUSE
))
697 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
698 exit(2); /* we didn't get the lock, exit with special status */
700 fatal_perror( "bind" );
702 atexit( socket_cleanup
);
703 chmod( server_socket_name
, 0600 ); /* make sure no other user can connect */
704 if (listen( fd
, 5 ) == -1) fatal_perror( "listen" );
706 if (!(master_socket
= alloc_object( &master_socket_ops
)) ||
707 !(master_socket
->fd
= create_anonymous_fd( &master_socket_fd_ops
, fd
, &master_socket
->obj
)))
708 fatal_error( "out of memory\n" );
709 master_socket
->timeout
= NULL
;
710 set_fd_events( master_socket
->fd
, POLLIN
);
713 /* open the master server socket and start waiting for new clients */
714 void open_master_socket(void)
716 int fd
, pid
, status
, sync_pipe
[2];
719 /* make sure no request is larger than the maximum size */
720 assert( sizeof(union generic_request
) == sizeof(struct request_max_size
) );
721 assert( sizeof(union generic_reply
) == sizeof(struct request_max_size
) );
727 if (pipe( sync_pipe
) == -1) fatal_perror( "pipe" );
733 close( sync_pipe
[0] );
737 /* close stdin and stdout */
738 if ((fd
= open( "/dev/null", O_RDWR
)) != -1)
746 write( sync_pipe
[1], &dummy
, 1 );
747 close( sync_pipe
[1] );
751 fatal_perror( "fork" );
754 default: /* parent */
755 close( sync_pipe
[1] );
757 /* wait for child to signal us and then exit */
758 if (read( sync_pipe
[0], &dummy
, 1 ) == 1) _exit(0);
760 /* child terminated, propagate exit status */
761 wait4( pid
, &status
, 0, NULL
);
762 if (WIFEXITED(status
)) _exit( WEXITSTATUS(status
) );
766 else /* remain in the foreground */
771 /* setup msghdr structure constant fields */
772 msghdr
.msg_name
= NULL
;
773 msghdr
.msg_namelen
= 0;
774 msghdr
.msg_iov
= &myiovec
;
775 msghdr
.msg_iovlen
= 1;
777 /* init startup ticks */
778 server_start_ticks
= get_tick_count();
781 /* master socket timer expiration handler */
782 static void close_socket_timeout( void *arg
)
784 master_socket
->timeout
= NULL
;
787 /* if a new client is waiting, we keep on running */
788 if (check_fd_events( master_socket
->fd
, POLLIN
)) return;
790 if (debug_level
) fprintf( stderr
, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
793 /* shut down everything properly */
794 release_object( master_socket
);
796 close_global_hooks();
797 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
, 0 );
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
);