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>
55 #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_get_fd
, /* get_fd */
94 master_socket_destroy
/* destroy */
97 static const struct fd_ops master_socket_fd_ops
=
99 NULL
, /* get_poll_events */
100 master_socket_poll_event
, /* poll_event */
101 no_flush
, /* flush */
102 no_get_file_info
, /* get_file_info */
103 no_queue_async
, /* queue_async */
104 no_cancel_async
/* cancel_async */
108 struct thread
*current
= NULL
; /* thread handling the current request */
109 unsigned int global_error
= 0; /* global error code for when no thread is current */
110 unsigned int server_start_ticks
= 0; /* tick count offset from server startup */
112 static struct master_socket
*master_socket
; /* the master socket object */
114 /* socket communication static structures */
115 static struct iovec myiovec
;
116 static struct msghdr msghdr
;
117 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
120 int len
; /* size of structure */
121 int level
; /* SOL_SOCKET */
122 int type
; /* SCM_RIGHTS */
123 int fd
; /* fd to pass */
125 static struct cmsg_fd cmsg
= { sizeof(cmsg
), SOL_SOCKET
, SCM_RIGHTS
, -1 };
126 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
128 /* complain about a protocol error and terminate the client connection */
129 void fatal_protocol_error( struct thread
*thread
, const char *err
, ... )
133 va_start( args
, err
);
134 fprintf( stderr
, "Protocol error:%p: ", thread
);
135 vfprintf( stderr
, err
, args
);
137 thread
->exit_code
= 1;
138 kill_thread( thread
, 1 );
141 /* complain about a protocol error and terminate the client connection */
142 void fatal_protocol_perror( struct thread
*thread
, const char *err
, ... )
146 va_start( args
, err
);
147 fprintf( stderr
, "Protocol error:%p: ", thread
);
148 vfprintf( stderr
, err
, args
);
151 thread
->exit_code
= 1;
152 kill_thread( thread
, 1 );
155 /* die on a fatal error */
156 void fatal_error( const char *err
, ... )
160 va_start( args
, err
);
161 fprintf( stderr
, "wineserver: " );
162 vfprintf( stderr
, err
, args
);
167 /* die on a fatal error */
168 void fatal_perror( const char *err
, ... )
172 va_start( args
, err
);
173 fprintf( stderr
, "wineserver: " );
174 vfprintf( stderr
, err
, args
);
180 /* allocate the reply data */
181 void *set_reply_data_size( size_t size
)
183 assert( size
<= get_reply_max_size() );
184 if (size
&& !(current
->reply_data
= mem_alloc( size
))) size
= 0;
185 current
->reply_size
= size
;
186 return current
->reply_data
;
189 /* write the remaining part of the reply */
190 void write_reply( struct thread
*thread
)
194 if ((ret
= write( get_unix_fd( thread
->reply_fd
),
195 (char *)thread
->reply_data
+ thread
->reply_size
- thread
->reply_towrite
,
196 thread
->reply_towrite
)) >= 0)
198 if (!(thread
->reply_towrite
-= ret
))
200 free( thread
->reply_data
);
201 thread
->reply_data
= NULL
;
202 /* sent everything, can go back to waiting for requests */
203 set_fd_events( thread
->request_fd
, POLLIN
);
204 set_fd_events( thread
->reply_fd
, 0 );
209 kill_thread( thread
, 0 ); /* normal death */
210 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
211 fatal_protocol_perror( thread
, "reply write" );
214 /* send a reply to the current thread */
215 static void send_reply( union generic_reply
*reply
)
219 if (!current
->reply_size
)
221 if ((ret
= write( get_unix_fd( current
->reply_fd
),
222 reply
, sizeof(*reply
) )) != sizeof(*reply
)) goto error
;
228 vec
[0].iov_base
= (void *)reply
;
229 vec
[0].iov_len
= sizeof(*reply
);
230 vec
[1].iov_base
= current
->reply_data
;
231 vec
[1].iov_len
= current
->reply_size
;
233 if ((ret
= writev( get_unix_fd( current
->reply_fd
), vec
, 2 )) < sizeof(*reply
)) goto error
;
235 if ((current
->reply_towrite
= current
->reply_size
- (ret
- sizeof(*reply
))))
237 /* couldn't write it all, wait for POLLOUT */
238 set_fd_events( current
->reply_fd
, POLLOUT
);
239 set_fd_events( current
->request_fd
, 0 );
243 if (current
->reply_data
)
245 free( current
->reply_data
);
246 current
->reply_data
= NULL
;
252 fatal_protocol_error( current
, "partial write %d\n", ret
);
253 else if (errno
== EPIPE
)
254 kill_thread( current
, 0 ); /* normal death */
256 fatal_protocol_perror( current
, "reply write" );
259 /* call a request handler */
260 static void call_req_handler( struct thread
*thread
)
262 union generic_reply reply
;
263 enum request req
= thread
->req
.request_header
.req
;
266 current
->reply_size
= 0;
268 memset( &reply
, 0, sizeof(reply
) );
270 if (debug_level
) trace_request();
272 if (req
< REQ_NB_REQUESTS
)
274 req_handlers
[req
]( ¤t
->req
, &reply
);
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
);
284 else fatal_protocol_error( current
, "no reply fd for request %d\n", req
);
289 fatal_protocol_error( current
, "bad request %d\n", req
);
292 /* read a request from a thread */
293 void read_request( struct thread
*thread
)
297 if (!thread
->req_toread
) /* no pending request */
299 if ((ret
= read( get_unix_fd( thread
->request_fd
), &thread
->req
,
300 sizeof(thread
->req
) )) != sizeof(thread
->req
)) goto error
;
301 if (!(thread
->req_toread
= thread
->req
.request_header
.request_size
))
303 /* no data, handle request at once */
304 call_req_handler( thread
);
307 if (!(thread
->req_data
= malloc( thread
->req_toread
)))
308 fatal_protocol_error( thread
, "no memory for %d bytes request\n", thread
->req_toread
);
311 /* read the variable sized data */
314 ret
= read( get_unix_fd( thread
->request_fd
),
315 (char *)thread
->req_data
+ thread
->req
.request_header
.request_size
316 - thread
->req_toread
,
317 thread
->req_toread
);
319 if (!(thread
->req_toread
-= ret
))
321 call_req_handler( thread
);
322 free( thread
->req_data
);
323 thread
->req_data
= NULL
;
329 if (!ret
) /* closed pipe */
330 kill_thread( thread
, 0 );
332 fatal_protocol_error( thread
, "partial read %d\n", ret
);
333 else if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
334 fatal_protocol_perror( thread
, "read" );
337 /* receive a file descriptor on the process socket */
338 int receive_fd( struct process
*process
)
343 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
344 msghdr
.msg_accrightslen
= sizeof(int);
345 msghdr
.msg_accrights
= (void *)&fd
;
346 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
347 msghdr
.msg_control
= &cmsg
;
348 msghdr
.msg_controllen
= sizeof(cmsg
);
350 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
352 myiovec
.iov_base
= (void *)&data
;
353 myiovec
.iov_len
= sizeof(data
);
355 ret
= recvmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
356 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
360 if (ret
== sizeof(data
))
362 struct thread
*thread
;
364 if (data
.tid
) thread
= get_thread_from_id( data
.tid
);
365 else thread
= (struct thread
*)grab_object( process
->thread_list
);
367 if (!thread
|| thread
->process
!= process
|| thread
->state
== TERMINATED
)
370 fprintf( stderr
, "%04x: *fd* %d <- %d bad thread id\n",
371 data
.tid
, data
.fd
, fd
);
377 fprintf( stderr
, "%04x: *fd* %d <- %d\n",
378 thread
->id
, data
.fd
, fd
);
379 thread_add_inflight_fd( thread
, data
.fd
, fd
);
381 if (thread
) release_object( thread
);
388 fprintf( stderr
, "Protocol error: process %p: partial recvmsg %d for fd\n",
390 kill_process( process
, NULL
, 1 );
394 if (errno
!= EWOULDBLOCK
&& errno
!= EAGAIN
)
396 fprintf( stderr
, "Protocol error: process %p: ", process
);
398 kill_process( process
, NULL
, 1 );
404 /* send an fd to a client */
405 int send_client_fd( struct process
*process
, int fd
, obj_handle_t handle
)
410 fprintf( stderr
, "%04x: *fd* %p -> %d\n",
411 current
? current
->id
: process
->id
, handle
, fd
);
413 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
414 msghdr
.msg_accrightslen
= sizeof(fd
);
415 msghdr
.msg_accrights
= (void *)&fd
;
416 #else /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
417 msghdr
.msg_control
= &cmsg
;
418 msghdr
.msg_controllen
= sizeof(cmsg
);
420 #endif /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
422 myiovec
.iov_base
= (void *)&handle
;
423 myiovec
.iov_len
= sizeof(handle
);
425 ret
= sendmsg( get_unix_fd( process
->msg_fd
), &msghdr
, 0 );
427 if (ret
== sizeof(handle
)) return 0;
431 fprintf( stderr
, "Protocol error: process %p: partial sendmsg %d\n", process
, ret
);
432 kill_process( process
, NULL
, 1 );
434 else if (errno
== EPIPE
)
436 kill_process( process
, NULL
, 0 );
440 fprintf( stderr
, "Protocol error: process %p: ", process
);
442 kill_process( process
, NULL
, 1 );
447 /* get current tick count to return to client */
448 unsigned int get_tick_count(void)
451 gettimeofday( &t
, NULL
);
452 return (t
.tv_sec
* 1000) + (t
.tv_usec
/ 1000) - server_start_ticks
;
455 static void master_socket_dump( struct object
*obj
, int verbose
)
457 struct master_socket
*sock
= (struct master_socket
*)obj
;
458 assert( obj
->ops
== &master_socket_ops
);
459 fprintf( stderr
, "Master socket fd=%p\n", sock
->fd
);
462 static void master_socket_destroy( struct object
*obj
)
464 struct master_socket
*sock
= (struct master_socket
*)obj
;
465 assert( obj
->ops
== &master_socket_ops
);
466 release_object( sock
->fd
);
469 /* handle a socket event */
470 static void master_socket_poll_event( struct fd
*fd
, int event
)
472 struct master_socket
*sock
= get_fd_user( fd
);
473 assert( master_socket
->obj
.ops
== &master_socket_ops
);
475 assert( sock
== master_socket
); /* there is only one master socket */
477 if (event
& (POLLERR
| POLLHUP
))
479 /* this is not supposed to happen */
480 fprintf( stderr
, "wineserver: Error on master socket\n" );
481 release_object( sock
);
483 else if (event
& POLLIN
)
485 struct sockaddr_un dummy
;
486 int len
= sizeof(dummy
);
487 int client
= accept( get_unix_fd( master_socket
->fd
), (struct sockaddr
*) &dummy
, &len
);
488 if (client
== -1) return;
491 remove_timeout_user( sock
->timeout
);
492 sock
->timeout
= NULL
;
494 fcntl( client
, F_SETFL
, O_NONBLOCK
);
495 create_process( client
);
499 /* remove the socket upon exit */
500 static void socket_cleanup(void)
502 static int do_it_once
;
503 if (!do_it_once
++) unlink( server_socket_name
);
506 /* create a directory and check its permissions */
507 static void create_dir( const char *name
, struct stat
*st
)
509 if (lstat( name
, st
) == -1)
511 if (errno
!= ENOENT
) fatal_perror( "lstat %s", name
);
512 if (mkdir( name
, 0700 ) == -1) fatal_perror( "mkdir %s", name
);
513 if (lstat( name
, st
) == -1) fatal_perror( "lstat %s", name
);
515 if (!S_ISDIR(st
->st_mode
)) fatal_error( "%s is not a directory\n", name
);
516 if (st
->st_uid
!= getuid()) fatal_error( "%s is not owned by you\n", name
);
517 if (st
->st_mode
& 077) fatal_error( "%s must not be accessible by other users\n", name
);
520 /* create the server directory and chdir to it */
521 static void create_server_dir(void)
523 char *p
, *server_dir
;
526 if (!(server_dir
= strdup( wine_get_server_dir() ))) fatal_error( "out of memory\n" );
528 /* first create the base directory if needed */
530 p
= strrchr( server_dir
, '/' );
532 create_dir( server_dir
, &st
);
534 /* now create the server directory */
537 create_dir( server_dir
, &st
);
539 if (chdir( server_dir
) == -1) fatal_perror( "chdir %s", server_dir
);
540 if (stat( ".", &st2
) == -1) fatal_perror( "stat %s", server_dir
);
541 if (st
.st_dev
!= st2
.st_dev
|| st
.st_ino
!= st2
.st_ino
)
542 fatal_error( "chdir did not end up in %s\n", server_dir
);
547 /* create the lock file and return its file descriptor */
548 static int create_server_lock(void)
553 if (lstat( server_lock_name
, &st
) == -1)
556 fatal_perror( "lstat %s/%s", wine_get_server_dir(), server_lock_name
);
560 if (!S_ISREG(st
.st_mode
))
561 fatal_error( "%s/%s is not a regular file\n", wine_get_server_dir(), server_lock_name
);
564 if ((fd
= open( server_lock_name
, O_CREAT
|O_TRUNC
|O_WRONLY
, 0600 )) == -1)
565 fatal_perror( "error creating %s/%s", wine_get_server_dir(), server_lock_name
);
569 /* wait for the server lock */
570 int wait_for_lock(void)
576 fd
= create_server_lock();
579 fl
.l_whence
= SEEK_SET
;
582 r
= fcntl( fd
, F_SETLKW
, &fl
);
588 /* kill the wine server holding the lock */
589 int kill_lock_owner( int sig
)
596 fd
= create_server_lock();
598 for (i
= 0; i
< 10; i
++)
601 fl
.l_whence
= SEEK_SET
;
604 if (fcntl( fd
, F_GETLK
, &fl
) == -1) goto done
;
605 if (fl
.l_type
!= F_WRLCK
) goto done
; /* the file is not locked */
606 if (!pid
) /* first time around */
608 if (!(pid
= fl
.l_pid
)) goto done
; /* shouldn't happen */
611 if (kill( pid
, SIGINT
) == -1) goto done
;
612 kill( pid
, SIGCONT
);
615 else /* just send the specified signal and return */
617 ret
= (kill( pid
, sig
) != -1);
621 else if (fl
.l_pid
!= pid
) goto done
; /* no longer the same process */
624 /* waited long enough, now kill it */
625 kill( pid
, SIGKILL
);
632 /* acquire the main server lock */
633 static void acquire_lock(void)
635 struct sockaddr_un addr
;
638 int fd
, slen
, got_lock
= 0;
640 fd
= create_server_lock();
643 fl
.l_whence
= SEEK_SET
;
646 if (fcntl( fd
, F_SETLK
, &fl
) != -1)
648 /* check for crashed server */
649 if (stat( server_socket_name
, &st
) != -1 && /* there is a leftover socket */
650 stat( "core", &st
) != -1 && st
.st_size
) /* and there is a non-empty core file */
653 "Warning: a previous instance of the wine server seems to have crashed.\n"
654 "Please run 'gdb %s %s/core',\n"
655 "type 'backtrace' at the gdb prompt and report the results. Thanks.\n\n",
656 server_argv0
, wine_get_server_dir() );
658 unlink( server_socket_name
); /* we got the lock, we can safely remove the socket */
660 /* in that case we reuse fd without closing it, this ensures
661 * that we hold the lock until the process exits */
670 /* check whether locks work at all on this file system */
671 if (fcntl( fd
, F_GETLK
, &fl
) == -1) break;
674 exit(2); /* we didn't get the lock, exit with special status */
676 fatal_perror( "fcntl %s/%s", wine_get_server_dir(), server_lock_name
);
678 /* it seems we can't use locks on this fs, so we will use the socket existence as lock */
682 if ((fd
= socket( AF_UNIX
, SOCK_STREAM
, 0 )) == -1) fatal_perror( "socket" );
683 addr
.sun_family
= AF_UNIX
;
684 strcpy( addr
.sun_path
, server_socket_name
);
685 slen
= sizeof(addr
) - sizeof(addr
.sun_path
) + strlen(addr
.sun_path
) + 1;
686 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
689 if (bind( fd
, (struct sockaddr
*)&addr
, slen
) == -1)
691 if ((errno
== EEXIST
) || (errno
== EADDRINUSE
))
694 fatal_error( "couldn't bind to the socket even though we hold the lock\n" );
695 exit(2); /* we didn't get the lock, exit with special status */
697 fatal_perror( "bind" );
699 atexit( socket_cleanup
);
700 chmod( server_socket_name
, 0600 ); /* make sure no other user can connect */
701 if (listen( fd
, 5 ) == -1) fatal_perror( "listen" );
703 if (!(master_socket
= alloc_object( &master_socket_ops
)) ||
704 !(master_socket
->fd
= create_anonymous_fd( &master_socket_fd_ops
, fd
, &master_socket
->obj
)))
705 fatal_error( "out of memory\n" );
706 master_socket
->timeout
= NULL
;
707 set_fd_events( master_socket
->fd
, POLLIN
);
710 /* open the master server socket and start waiting for new clients */
711 void open_master_socket(void)
713 int fd
, pid
, status
, sync_pipe
[2];
716 /* make sure no request is larger than the maximum size */
717 assert( sizeof(union generic_request
) == sizeof(struct request_max_size
) );
718 assert( sizeof(union generic_reply
) == sizeof(struct request_max_size
) );
724 if (pipe( sync_pipe
) == -1) fatal_perror( "pipe" );
730 close( sync_pipe
[0] );
734 /* close stdin and stdout */
735 if ((fd
= open( "/dev/null", O_RDWR
)) != -1)
743 write( sync_pipe
[1], &dummy
, 1 );
744 close( sync_pipe
[1] );
748 fatal_perror( "fork" );
751 default: /* parent */
752 close( sync_pipe
[1] );
754 /* wait for child to signal us and then exit */
755 if (read( sync_pipe
[0], &dummy
, 1 ) == 1) _exit(0);
757 /* child terminated, propagate exit status */
758 wait4( pid
, &status
, 0, NULL
);
759 if (WIFEXITED(status
)) _exit( WEXITSTATUS(status
) );
763 else /* remain in the foreground */
768 /* setup msghdr structure constant fields */
769 msghdr
.msg_name
= NULL
;
770 msghdr
.msg_namelen
= 0;
771 msghdr
.msg_iov
= &myiovec
;
772 msghdr
.msg_iovlen
= 1;
774 /* init startup ticks */
775 server_start_ticks
= get_tick_count();
778 /* master socket timer expiration handler */
779 static void close_socket_timeout( void *arg
)
781 master_socket
->timeout
= NULL
;
784 /* if a new client is waiting, we keep on running */
785 if (check_fd_events( master_socket
->fd
, POLLIN
)) return;
787 if (debug_level
) fprintf( stderr
, "wineserver: exiting (pid=%ld)\n", (long) getpid() );
790 /* shut down everything properly */
791 release_object( master_socket
);
793 close_global_hooks();
794 close_global_handles();
797 dump_objects(); /* dump any remaining objects */
803 /* close the master socket and stop waiting for new clients */
804 void close_master_socket(void)
808 if (master_socket_timeout
== -1) return; /* just keep running forever */
810 if (master_socket_timeout
)
812 gettimeofday( &when
, 0 );
813 add_timeout( &when
, master_socket_timeout
* 1000 );
814 master_socket
->timeout
= add_timeout_user( &when
, close_socket_timeout
, NULL
);
816 else close_socket_timeout( NULL
); /* close it right away */
819 /* lock/unlock the master socket to stop accepting new clients */
820 void lock_master_socket( int locked
)
822 set_fd_events( master_socket
->fd
, locked
? 0 : POLLIN
);