2 * Server-side request handling
4 * Copyright (C) 1998 Alexandre Julliard
20 #include <sys/types.h>
21 #ifdef HAVE_SYS_SOCKET_H
22 # include <sys/socket.h>
33 #define WANT_REQUEST_HANDLERS
36 /* Some versions of glibc don't define this */
41 /* path names for server master Unix socket */
42 #define CONFDIR "/.wine" /* directory for Wine config relative to $HOME */
43 #define SERVERDIR "wineserver-" /* server socket directory (hostname appended) */
44 #define SOCKETNAME "socket" /* name of the socket file */
48 struct object obj; /* object header */
51 static void master_socket_dump( struct object *obj, int verbose );
52 static void master_socket_poll_event( struct object *obj, int event );
53 static void master_socket_destroy( struct object *obj );
55 static const struct object_ops master_socket_ops =
57 sizeof(struct master_socket), /* size */
58 master_socket_dump, /* dump */
59 no_add_queue, /* add_queue */
60 NULL, /* remove_queue */
63 NULL, /* get_poll_events */
64 master_socket_poll_event, /* poll_event */
65 no_get_fd, /* get_fd */
67 no_get_file_info, /* get_file_info */
68 master_socket_destroy /* destroy */
72 struct thread *current = NULL; /* thread handling the current request */
73 unsigned int global_error = 0; /* global error code for when no thread is current */
75 static struct master_socket *master_socket; /* the master socket object */
77 /* socket communication static structures */
78 static struct iovec myiovec;
79 static struct msghdr msghdr;
80 #ifndef HAVE_MSGHDR_ACCRIGHTS
83 int len; /* sizeof structure */
84 int level; /* SOL_SOCKET */
85 int type; /* SCM_RIGHTS */
86 int fd; /* fd to pass */
88 static struct cmsg_fd cmsg = { sizeof(cmsg), SOL_SOCKET, SCM_RIGHTS, -1 };
89 #endif /* HAVE_MSGHDR_ACCRIGHTS */
91 /* complain about a protocol error and terminate the client connection */
92 void fatal_protocol_error( struct thread *thread, const char *err, ... )
96 va_start( args, err );
97 fprintf( stderr, "Protocol error:%p: ", thread );
98 vfprintf( stderr, err, args );
100 thread->exit_code = 1;
101 kill_thread( thread, 1 );
104 /* complain about a protocol error and terminate the client connection */
105 void fatal_protocol_perror( struct thread *thread, const char *err, ... )
109 va_start( args, err );
110 fprintf( stderr, "Protocol error:%p: ", thread );
111 vfprintf( stderr, err, args );
114 thread->exit_code = 1;
115 kill_thread( thread, 1 );
118 /* die on a fatal error */
119 void fatal_error( const char *err, ... )
123 va_start( args, err );
124 fprintf( stderr, "wineserver: " );
125 vfprintf( stderr, err, args );
130 /* die on a fatal error */
131 void fatal_perror( const char *err, ... )
135 va_start( args, err );
136 fprintf( stderr, "wineserver: " );
137 vfprintf( stderr, err, args );
143 /* call a request handler */
144 static inline void call_req_handler( struct thread *thread, union generic_request *request )
146 enum request req = request->header.req;
151 if (debug_level) trace_request( thread, request );
153 if (request->header.var_size)
155 if ((unsigned int)request->header.var_offset +
156 request->header.var_size > MAX_REQUEST_LENGTH)
158 fatal_protocol_error( current, "bad request offset/size %d/%d\n",
159 request->header.var_offset, request->header.var_size );
164 if (req < REQ_NB_REQUESTS)
166 req_handlers[req]( request );
167 if (current) send_reply( current, request );
171 fatal_protocol_error( current, "bad request %d\n", req );
174 /* read a request from a thread */
175 void read_request( struct thread *thread )
177 union generic_request req;
180 if ((ret = read( thread->obj.fd, &req, sizeof(req) )) == sizeof(req))
182 call_req_handler( thread, &req );
185 if (!ret) /* closed pipe */
186 kill_thread( thread, 0 );
188 fatal_protocol_error( thread, "partial read %d\n", ret );
189 else if (errno != EWOULDBLOCK && errno != EAGAIN)
190 fatal_protocol_perror( thread, "read" );
193 /* send a reply to a thread */
194 void send_reply( struct thread *thread, union generic_request *request )
198 if (debug_level) trace_reply( thread, request );
200 request->header.error = thread->error;
202 if ((ret = write( thread->reply_fd, request, sizeof(*request) )) != sizeof(*request))
205 fatal_protocol_error( thread, "partial write %d\n", ret );
206 else if (errno == EPIPE)
207 kill_thread( thread, 0 ); /* normal death */
209 fatal_protocol_perror( thread, "reply write" );
213 /* receive a file descriptor on the process socket */
214 int receive_fd( struct process *process )
219 #ifdef HAVE_MSGHDR_ACCRIGHTS
220 msghdr.msg_accrightslen = sizeof(int);
221 msghdr.msg_accrights = (void *)&fd;
222 #else /* HAVE_MSGHDR_ACCRIGHTS */
223 msghdr.msg_control = &cmsg;
224 msghdr.msg_controllen = sizeof(cmsg);
226 #endif /* HAVE_MSGHDR_ACCRIGHTS */
228 myiovec.iov_base = &data;
229 myiovec.iov_len = sizeof(data);
231 ret = recvmsg( process->obj.fd, &msghdr, 0 );
232 #ifndef HAVE_MSGHDR_ACCRIGHTS
236 if (ret == sizeof(data))
238 struct thread *thread;
240 if (data.tid) thread = get_thread_from_id( data.tid );
241 else thread = (struct thread *)grab_object( process->thread_list );
243 if (!thread || thread->process != process)
246 fprintf( stderr, "%08x: *fd* %d <- %d bad thread id\n",
247 (unsigned int)data.tid, data.fd, fd );
253 fprintf( stderr, "%08x: *fd* %d <- %d\n",
254 (unsigned int)thread, data.fd, fd );
255 thread_add_inflight_fd( thread, data.fd, fd );
257 if (thread) release_object( thread );
264 fprintf( stderr, "Protocol error: process %p: partial recvmsg %d for fd\n",
266 kill_process( process, NULL, 1 );
270 if (errno != EWOULDBLOCK && errno != EAGAIN)
272 fprintf( stderr, "Protocol error: process %p: ", process );
274 kill_process( process, NULL, 1 );
280 /* send an fd to a client */
281 int send_client_fd( struct process *process, int fd, handle_t handle )
286 fprintf( stderr, "%08x: *fd* %d -> %d\n", (unsigned int)current, handle, fd );
288 #ifdef HAVE_MSGHDR_ACCRIGHTS
289 msghdr.msg_accrightslen = sizeof(fd);
290 msghdr.msg_accrights = (void *)&fd;
291 #else /* HAVE_MSGHDR_ACCRIGHTS */
292 msghdr.msg_control = &cmsg;
293 msghdr.msg_controllen = sizeof(cmsg);
295 #endif /* HAVE_MSGHDR_ACCRIGHTS */
297 myiovec.iov_base = (void *)&handle;
298 myiovec.iov_len = sizeof(handle);
300 ret = sendmsg( process->obj.fd, &msghdr, 0 );
302 if (ret == sizeof(handle)) return 0;
307 fprintf( stderr, "Protocol error: process %p: partial sendmsg %d\n", process, ret );
308 kill_process( process, NULL, 1 );
312 fprintf( stderr, "Protocol error: process %p: ", process );
314 kill_process( process, NULL, 1 );
319 static void master_socket_dump( struct object *obj, int verbose )
321 struct master_socket *sock = (struct master_socket *)obj;
322 assert( obj->ops == &master_socket_ops );
323 fprintf( stderr, "Master socket fd=%d\n", sock->obj.fd );
326 /* handle a socket event */
327 static void master_socket_poll_event( struct object *obj, int event )
329 struct master_socket *sock = (struct master_socket *)obj;
330 assert( obj->ops == &master_socket_ops );
332 assert( sock == master_socket ); /* there is only one master socket */
334 if (event & (POLLERR | POLLHUP))
336 /* this is not supposed to happen */
337 fprintf( stderr, "wineserver: Error on master socket\n" );
338 release_object( obj );
340 else if (event & POLLIN)
342 struct sockaddr_un dummy;
343 int len = sizeof(dummy);
344 int client = accept( master_socket->obj.fd, (struct sockaddr *) &dummy, &len );
345 if (client == -1) return;
346 fcntl( client, F_SETFL, O_NONBLOCK );
347 create_process( client );
351 /* remove the socket upon exit */
352 static void socket_cleanup(void)
354 static int do_it_once;
355 if (!do_it_once++) unlink( SOCKETNAME );
358 static void master_socket_destroy( struct object *obj )
363 /* return the configuration directory ($WINEPREFIX or $HOME/.wine) */
364 const char *get_config_dir(void)
366 static char *confdir;
369 const char *prefix = getenv( "WINEPREFIX" );
372 int len = strlen(prefix);
373 if (!(confdir = strdup( prefix ))) fatal_error( "out of memory\n" );
374 if (len > 1 && confdir[len-1] == '/') confdir[len-1] = 0;
378 const char *home = getenv( "HOME" );
381 struct passwd *pwd = getpwuid( getuid() );
382 if (!pwd) fatal_error( "could not find your home directory\n" );
385 if (!(confdir = malloc( strlen(home) + strlen(CONFDIR) + 1 )))
386 fatal_error( "out of memory\n" );
387 strcpy( confdir, home );
388 strcat( confdir, CONFDIR );
394 /* create the server directory and chdir to it */
395 static void create_server_dir(void)
399 const char *confdir = get_config_dir();
402 if (gethostname( hostname, sizeof(hostname) ) == -1) fatal_perror( "gethostname" );
404 if (!(serverdir = malloc( strlen(SERVERDIR) + strlen(hostname) + 1 )))
405 fatal_error( "out of memory\n" );
407 if (chdir( confdir ) == -1) fatal_perror( "chdir %s", confdir );
409 strcpy( serverdir, SERVERDIR );
410 strcat( serverdir, hostname );
412 if (chdir( serverdir ) == -1)
414 if (errno != ENOENT) fatal_perror( "chdir %s", serverdir );
415 if (mkdir( serverdir, 0700 ) == -1) fatal_perror( "mkdir %s", serverdir );
416 if (chdir( serverdir ) == -1) fatal_perror( "chdir %s", serverdir );
418 if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
419 if (!S_ISDIR(st.st_mode)) fatal_error( "%s is not a directory\n", serverdir );
420 if (st.st_uid != getuid()) fatal_error( "%s is not owned by you\n", serverdir );
421 if (st.st_mode & 077) fatal_error( "%s must not be accessible by other users\n", serverdir );
424 /* open the master server socket and start waiting for new clients */
425 void open_master_socket(void)
427 struct sockaddr_un addr;
430 /* make sure no request is larger than the maximum size */
431 assert( sizeof(union generic_request) == sizeof(struct request_max_size) );
434 if ((fd = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
435 addr.sun_family = AF_UNIX;
436 strcpy( addr.sun_path, SOCKETNAME );
437 slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
438 #ifdef HAVE_SOCKADDR_SUN_LEN
441 if (bind( fd, (struct sockaddr *)&addr, slen ) == -1)
443 if ((errno == EEXIST) || (errno == EADDRINUSE))
444 exit(0); /* pretend we succeeded to start */
446 fatal_perror( "bind" );
448 atexit( socket_cleanup );
450 chmod( SOCKETNAME, 0600 ); /* make sure no other user can connect */
451 if (listen( fd, 5 ) == -1) fatal_perror( "listen" );
453 if (!(master_socket = alloc_object( &master_socket_ops, fd )))
454 fatal_error( "out of memory\n" );
455 set_select_events( &master_socket->obj, POLLIN );
457 /* setup msghdr structure constant fields */
458 msghdr.msg_name = NULL;
459 msghdr.msg_namelen = 0;
460 msghdr.msg_iov = &myiovec;
461 msghdr.msg_iovlen = 1;
463 /* go in the background */
467 fatal_perror( "fork" );
472 _exit(0); /* do not call atexit functions */
476 /* close the master socket and stop waiting for new clients */
477 void close_master_socket(void)
479 /* if a new client is waiting, we keep on running */
480 if (!check_select_events( master_socket->obj.fd, POLLIN ))
481 release_object( master_socket );
484 /* lock/unlock the master socket to stop accepting new clients */
485 void lock_master_socket( int locked )
487 set_select_events( &master_socket->obj, locked ? 0 : POLLIN );