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"
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_signal
, /* signal */
94 no_get_fd
, /* get_fd */
95 no_map_access
, /* map_access */
96 no_lookup_name
, /* lookup_name */
97 no_close_handle
, /* close_handle */
98 master_socket_destroy
/* destroy */
101 static const struct fd_ops master_socket_fd_ops
=
103 NULL
, /* get_poll_events */
104 master_socket_poll_event
, /* poll_event */
105 no_flush
, /* flush */
106 no_get_file_info
, /* get_file_info */
107 no_queue_async
, /* queue_async */
108 no_cancel_async
/* cancel_async */
112 struct thread
*current
= NULL
; /* thread handling the current request */
113 unsigned int global_error
= 0; /* global error code for when no thread is current */
114 time_t server_start_time
= 0; /* server startup time */
116 static struct master_socket
*master_socket
; /* the master socket object */
118 /* socket communication static structures */
119 static struct iovec myiovec
;
120 static struct msghdr msghdr
;
121 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
126 size_t len
; /* size of structure */
127 int level
; /* SOL_SOCKET */
128 int type
; /* SCM_RIGHTS */
130 int fd
; /* fd to pass */
132 static struct cmsg_fd cmsg
= { { sizeof(cmsg
.header
) + sizeof(cmsg
.fd
), SOL_SOCKET
, SCM_RIGHTS
}, -1 };
133 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
135 /* complain about a protocol error and terminate the client connection */
136 void fatal_protocol_error( struct thread
*thread
, const char *err
, ... )
140 va_start( args
, err
);
141 fprintf( stderr
, "Protocol error:%p: ", thread
);
142 vfprintf( stderr
, err
, args
);
144 thread
->exit_code
= 1;
145 kill_thread( thread
, 1 );
148 /* complain about a protocol error and terminate the client connection */
149 void fatal_protocol_perror( struct thread
*thread
, const char *err
, ... )
153 va_start( args
, err
);
154 fprintf( stderr
, "Protocol error:%p: ", thread
);
155 vfprintf( stderr
, err
, args
);
158 thread
->exit_code
= 1;
159 kill_thread( thread
, 1 );
162 /* die on a fatal error */
163 void fatal_error( const char *err
, ... )
167 va_start( args
, err
);
168 fprintf( stderr
, "wineserver: " );
169 vfprintf( stderr
, err
, args
);
174 /* die on a fatal error */
175 void fatal_perror( const char *err
, ... )
179 va_start( args
, err
);
180 fprintf( stderr
, "wineserver: " );
181 vfprintf( stderr
, err
, args
);
187 /* allocate the reply data */
188 void *set_reply_data_size( size_t size
)
190 assert( size
<= get_reply_max_size() );
191 if (size
&& !(current
->reply_data
= mem_alloc( size
))) size
= 0;
192 current
->reply_size
= size
;
193 return current
->reply_data
;
196 /* write the remaining part of the reply */
197 void write_reply( struct thread
*thread
)
201 if ((ret
= write( get_unix_fd( thread
->reply_fd
),
202 (char *)thread
->reply_data
+ thread
->reply_size
- thread
->reply_towrite
,
203 thread
->reply_towrite
)) >= 0)
205 if (!(thread
->reply_towrite
-= ret
))
207 free( thread
->reply_data
);
208 thread
->reply_data
= NULL
;
209 /* sent everything, can go back to waiting for requests */
210 set_fd_events( thread
->request_fd
, POLLIN
);
211 set_fd_events( thread
->reply_fd
, 0 );
216 kill_thread( thread
, 0 ); /* normal death */
217 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
218 fatal_protocol_perror( thread
, "reply write" );
221 /* send a reply to the current thread */
222 static void send_reply( union generic_reply
*reply
)
226 if (!current
->reply_size
)
228 if ((ret
= write( get_unix_fd( current
->reply_fd
),
229 reply
, sizeof(*reply
) )) != sizeof(*reply
)) goto error
;
235 vec
[0].iov_base
= (void *)reply
;
236 vec
[0].iov_len
= sizeof(*reply
);
237 vec
[1].iov_base
= current
->reply_data
;
238 vec
[1].iov_len
= current
->reply_size
;
240 if ((ret
= writev( get_unix_fd( current
->reply_fd
), vec
, 2 )) < sizeof(*reply
)) goto error
;
242 if ((current
->reply_towrite
= current
->reply_size
- (ret
- sizeof(*reply
))))
244 /* couldn't write it all, wait for POLLOUT */
245 set_fd_events( current
->reply_fd
, POLLOUT
);
246 set_fd_events( current
->request_fd
, 0 );
250 if (current
->reply_data
)
252 free( current
->reply_data
);
253 current
->reply_data
= NULL
;
259 fatal_protocol_error( current
, "partial write %d\n", ret
);
260 else if (errno
== EPIPE
)
261 kill_thread( current
, 0 ); /* normal death */
263 fatal_protocol_perror( current
, "reply write" );
266 /* call a request handler */
267 static void call_req_handler( struct thread
*thread
)
269 union generic_reply reply
;
270 enum request req
= thread
->req
.request_header
.req
;
273 current
->reply_size
= 0;
275 memset( &reply
, 0, sizeof(reply
) );
277 if (debug_level
) trace_request();
279 if (req
< REQ_NB_REQUESTS
)
281 req_handlers
[req
]( ¤t
->req
, &reply
);
284 if (current
->reply_fd
)
286 reply
.reply_header
.error
= current
->error
;
287 reply
.reply_header
.reply_size
= current
->reply_size
;
288 if (debug_level
) trace_reply( req
, &reply
);
289 send_reply( &reply
);
291 else fatal_protocol_error( current
, "no reply fd for request %d\n", req
);
296 fatal_protocol_error( current
, "bad request %d\n", req
);
299 /* read a request from a thread */
300 void read_request( struct thread
*thread
)
304 if (!thread
->req_toread
) /* no pending request */
306 if ((ret
= read( get_unix_fd( thread
->request_fd
), &thread
->req
,
307 sizeof(thread
->req
) )) != sizeof(thread
->req
)) goto error
;
308 if (!(thread
->req_toread
= thread
->req
.request_header
.request_size
))
310 /* no data, handle request at once */
311 call_req_handler( thread
);
314 if (!(thread
->req_data
= malloc( thread
->req_toread
)))
315 fatal_protocol_error( thread
, "no memory for %d bytes request\n", thread
->req_toread
);
318 /* read the variable sized data */
321 ret
= read( get_unix_fd( thread
->request_fd
),
322 (char *)thread
->req_data
+ thread
->req
.request_header
.request_size
323 - thread
->req_toread
,
324 thread
->req_toread
);
326 if (!(thread
->req_toread
-= ret
))
328 call_req_handler( thread
);
329 free( thread
->req_data
);
330 thread
->req_data
= NULL
;
336 if (!ret
) /* closed pipe */
337 kill_thread( thread
, 0 );
339 fatal_protocol_error( thread
, "partial read %d\n", ret
);
340 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
341 fatal_protocol_perror( thread
, "read" );
344 /* receive a file descriptor on the process socket */
345 int receive_fd( struct process
*process
)
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 msghdr
.msg_control
= &cmsg
;
355 msghdr
.msg_controllen
= sizeof(cmsg
.header
) + sizeof(fd
);
357 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
359 myiovec
.iov_base
= (void *)&data
;
360 myiovec
.iov_len
= sizeof(data
);
362 ret
= recvmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
363 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
367 if (ret
== sizeof(data
))
369 struct thread
*thread
;
371 if (data
.tid
) thread
= get_thread_from_id( data
.tid
);
372 else thread
= (struct thread
*)grab_object( get_process_first_thread( process
));
374 if (!thread
|| thread
->process
!= process
|| thread
->state
== TERMINATED
)
377 fprintf( stderr
, "%04x: *fd* %d <- %d bad thread id\n",
378 data
.tid
, data
.fd
, fd
);
384 fprintf( stderr
, "%04x: *fd* %d <- %d\n",
385 thread
->id
, data
.fd
, fd
);
386 thread_add_inflight_fd( thread
, data
.fd
, fd
);
388 if (thread
) release_object( thread
);
394 kill_process( process
, NULL
, 0 );
398 fprintf( stderr
, "Protocol error: process %p: partial recvmsg %d for fd\n",
400 kill_process( process
, NULL
, 1 );
404 if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
406 fprintf( stderr
, "Protocol error: process %p: ", process
);
408 kill_process( process
, NULL
, 1 );
414 /* send an fd to a client */
415 int send_client_fd( struct process
*process
, int fd
, obj_handle_t handle
)
420 fprintf( stderr
, "%04x: *fd* %p -> %d\n",
421 current
? current
->id
: process
->id
, handle
, fd
);
423 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
424 msghdr
.msg_accrightslen
= sizeof(fd
);
425 msghdr
.msg_accrights
= (void *)&fd
;
426 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
427 msghdr
.msg_control
= &cmsg
;
428 msghdr
.msg_controllen
= sizeof(cmsg
.header
) + sizeof(fd
);
430 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
432 myiovec
.iov_base
= (void *)&handle
;
433 myiovec
.iov_len
= sizeof(handle
);
435 ret
= sendmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
437 if (ret
== sizeof(handle
)) return 0;
441 fprintf( stderr
, "Protocol error: process %p: partial sendmsg %d\n", process
, ret
);
442 kill_process( process
, NULL
, 1 );
444 else if (errno
== EPIPE
)
446 kill_process( process
, NULL
, 0 );
450 fprintf( stderr
, "Protocol error: process %p: ", process
);
452 kill_process( process
, NULL
, 1 );
457 /* get current tick count to return to client */
458 unsigned int get_tick_count(void)
461 gettimeofday( &t
, NULL
);
462 return ((t
.tv_sec
- server_start_time
) * 1000) + (t
.tv_usec
/ 1000);
465 static void master_socket_dump( struct object
*obj
, int verbose
)
467 struct master_socket
*sock
= (struct master_socket
*)obj
;
468 assert( obj
->ops
== &master_socket_ops
);
469 fprintf( stderr
, "Master socket fd=%p\n", sock
->fd
);
472 static void master_socket_destroy( struct object
*obj
)
474 struct master_socket
*sock
= (struct master_socket
*)obj
;
475 assert( obj
->ops
== &master_socket_ops
);
476 release_object( sock
->fd
);
479 /* handle a socket event */
480 static void master_socket_poll_event( struct fd
*fd
, int event
)
482 struct master_socket
*sock
= get_fd_user( fd
);
483 assert( master_socket
->obj
.ops
== &master_socket_ops
);
485 assert( sock
== master_socket
); /* there is only one master socket */
487 if (event
& (POLLERR
| POLLHUP
))
489 /* this is not supposed to happen */
490 fprintf( stderr
, "wineserver: Error on master socket\n" );
491 release_object( sock
);
493 else if (event
& POLLIN
)
495 struct sockaddr_un dummy
;
496 unsigned int len
= sizeof(dummy
);
497 int client
= accept( get_unix_fd( master_socket
->fd
), (struct sockaddr
*) &dummy
, &len
);
498 if (client
== -1) return;
501 remove_timeout_user( sock
->timeout
);
502 sock
->timeout
= NULL
;
504 fcntl( client
, F_SETFL
, O_NONBLOCK
);
505 create_process( client
);
509 /* remove the socket upon exit */
510 static void socket_cleanup(void)
512 static int do_it_once
;
513 if (!do_it_once
++) unlink( server_socket_name
);
516 /* create a directory and check its permissions */
517 static void create_dir( const char *name
, struct stat
*st
)
519 if (lstat( name
, st
) == -1)
521 if (errno
!= ENOENT
) fatal_perror( "lstat %s", name
);
522 if (mkdir( name
, 0700 ) == -1 && errno
!= EEXIST
) fatal_perror( "mkdir %s", name
);
523 if (lstat( name
, st
) == -1) fatal_perror( "lstat %s", name
);
525 if (!S_ISDIR(st
->st_mode
)) fatal_error( "%s is not a directory\n", name
);
526 if (st
->st_uid
!= getuid()) fatal_error( "%s is not owned by you\n", name
);
527 if (st
->st_mode
& 077) fatal_error( "%s must not be accessible by other users\n", name
);
530 /* create the server directory and chdir to it */
531 static void create_server_dir( const char *dir
)
533 char *p
, *server_dir
;
536 if (!(server_dir
= strdup( dir
))) fatal_error( "out of memory\n" );
538 /* first create the base directory if needed */
540 p
= strrchr( server_dir
, '/' );
542 create_dir( server_dir
, &st
);
544 /* now create the server directory */
547 create_dir( server_dir
, &st
);
549 if (chdir( server_dir
) == -1) fatal_perror( "chdir %s", server_dir
);
550 if (stat( ".", &st2
) == -1) fatal_perror( "stat %s", server_dir
);
551 if (st
.st_dev
!= st2
.st_dev
|| st
.st_ino
!= st2
.st_ino
)
552 fatal_error( "chdir did not end up in %s\n", server_dir
);
557 /* create the lock file and return its file descriptor */
558 static int create_server_lock(void)
563 if (lstat( server_lock_name
, &st
) == -1)
566 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name
);
570 if (!S_ISREG(st
.st_mode
))
571 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name
);
574 if ((fd
= open( server_lock_name
, O_CREAT
|O_TRUNC
|O_WRONLY
, 0600 )) == -1)
575 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name
);
579 /* wait for the server lock */
580 int wait_for_lock(void)
582 const char *server_dir
= wine_get_server_dir();
586 if (!server_dir
) return 0; /* no server dir, so no lock to wait on */
588 create_server_dir( server_dir
);
589 fd
= create_server_lock();
592 fl
.l_whence
= SEEK_SET
;
595 r
= fcntl( fd
, F_SETLKW
, &fl
);
601 /* kill the wine server holding the lock */
602 int kill_lock_owner( int sig
)
604 const char *server_dir
= wine_get_server_dir();
609 if (!server_dir
) return 0; /* no server dir, nothing to do */
611 create_server_dir( server_dir
);
612 fd
= create_server_lock();
614 for (i
= 0; i
< 10; i
++)
617 fl
.l_whence
= SEEK_SET
;
620 if (fcntl( fd
, F_GETLK
, &fl
) == -1) goto done
;
621 if (fl
.l_type
!= F_WRLCK
) goto done
; /* the file is not locked */
622 if (!pid
) /* first time around */
624 if (!(pid
= fl
.l_pid
)) goto done
; /* shouldn't happen */
627 if (kill( pid
, SIGINT
) == -1) goto done
;
628 kill( pid
, SIGCONT
);
631 else /* just send the specified signal and return */
633 ret
= (kill( pid
, sig
) != -1);
637 else if (fl
.l_pid
!= pid
) goto done
; /* no longer the same process */
640 /* waited long enough, now kill it */
641 kill( pid
, SIGKILL
);
648 /* acquire the main server lock */
649 static void acquire_lock(void)
651 struct sockaddr_un addr
;
654 int fd
, slen
, got_lock
= 0;
656 fd
= create_server_lock();
659 fl
.l_whence
= SEEK_SET
;
662 if (fcntl( fd
, F_SETLK
, &fl
) != -1)
664 /* check for crashed server */
665 if (stat( server_socket_name
, &st
) != -1 && /* there is a leftover socket */
666 stat( "core", &st
) != -1 && st
.st_size
) /* and there is a non-empty core file */
669 "Warning: a previous instance of the wine server seems to have crashed.\n"
670 "Please run 'gdb %s %s/core',\n"
671 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
672 server_argv0
, wine_get_server_dir() );
674 unlink( server_socket_name
); /* we got the lock, we can safely remove the socket */
676 /* in that case we reuse fd without closing it, this ensures
677 * that we hold the lock until the process exits */
686 /* check whether locks work at all on this file system */
687 if (fcntl( fd
, F_GETLK
, &fl
) == -1) break;
690 exit(2); /* we didn't get the lock, exit with special status */
692 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name
);
694 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
698 if ((fd
= socket( AF_UNIX
, SOCK_STREAM
, 0 )) == -1) fatal_perror( "socket" );
699 addr
.sun_family
= AF_UNIX
;
700 strcpy( addr
.sun_path
, server_socket_name
);
701 slen
= sizeof(addr
) - sizeof(addr
.sun_path
) + strlen(addr
.sun_path
) + 1;
702 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
705 if (bind( fd
, (struct sockaddr
*)&addr
, slen
) == -1)
707 if ((errno
== EEXIST
) || (errno
== EADDRINUSE
))
710 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
711 exit(2); /* we didn't get the lock, exit with special status */
713 fatal_perror( "bind" );
715 atexit( socket_cleanup
);
716 chmod( server_socket_name
, 0600 ); /* make sure no other user can connect */
717 if (listen( fd
, 5 ) == -1) fatal_perror( "listen" );
719 if (!(master_socket
= alloc_object( &master_socket_ops
)) ||
720 !(master_socket
->fd
= create_anonymous_fd( &master_socket_fd_ops
, fd
, &master_socket
->obj
)))
721 fatal_error( "out of memory\n" );
722 master_socket
->timeout
= NULL
;
723 set_fd_events( master_socket
->fd
, POLLIN
);
724 make_object_static( &master_socket
->obj
);
727 /* open the master server socket and start waiting for new clients */
728 void open_master_socket(void)
730 const char *server_dir
= wine_get_server_dir();
731 int fd
, pid
, status
, sync_pipe
[2];
734 /* make sure no request is larger than the maximum size */
735 assert( sizeof(union generic_request
) == sizeof(struct request_max_size
) );
736 assert( sizeof(union generic_reply
) == sizeof(struct request_max_size
) );
738 if (!server_dir
) fatal_error( "directory %s cannot be accessed\n", wine_get_config_dir() );
739 create_server_dir( server_dir
);
743 if (pipe( sync_pipe
) == -1) fatal_perror( "pipe" );
749 close( sync_pipe
[0] );
753 /* close stdin and stdout */
754 if ((fd
= open( "/dev/null", O_RDWR
)) != -1)
763 write( sync_pipe
[1], &dummy
, 1 );
764 close( sync_pipe
[1] );
768 fatal_perror( "fork" );
771 default: /* parent */
772 close( sync_pipe
[1] );
774 /* wait for child to signal us and then exit */
775 if (read( sync_pipe
[0], &dummy
, 1 ) == 1) _exit(0);
777 /* child terminated, propagate exit status */
778 wait4( pid
, &status
, 0, NULL
);
779 if (WIFEXITED(status
)) _exit( WEXITSTATUS(status
) );
783 else /* remain in the foreground */
788 /* setup msghdr structure constant fields */
789 msghdr
.msg_name
= NULL
;
790 msghdr
.msg_namelen
= 0;
791 msghdr
.msg_iov
= &myiovec
;
792 msghdr
.msg_iovlen
= 1;
794 /* init startup time */
795 server_start_time
= time(NULL
);
798 /* master socket timer expiration handler */
799 static void close_socket_timeout( void *arg
)
801 master_socket
->timeout
= NULL
;
804 /* if a new client is waiting, we keep on running */
805 if (check_fd_events( master_socket
->fd
, POLLIN
)) return;
807 if (debug_level
) fprintf( stderr
, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
810 close_objects(); /* shut down everything properly */
815 /* close the master socket and stop waiting for new clients */
816 void close_master_socket(void)
820 if (master_socket_timeout
== -1) return; /* just keep running forever */
822 if (master_socket_timeout
)
824 gettimeofday( &when
, NULL
);
825 add_timeout( &when
, master_socket_timeout
* 1000 );
826 master_socket
->timeout
= add_timeout_user( &when
, close_socket_timeout
, NULL
);
828 else close_socket_timeout( NULL
); /* close it right away */
831 /* lock/unlock the master socket to stop accepting new clients */
832 void lock_master_socket( int locked
)
834 set_fd_events( master_socket
->fd
, locked
? 0 : POLLIN
);