msi: Implement Installer::OpenDatabase.
[wine] / dlls / ntdll / server.c
1 /*
2  * Wine server communication
3  *
4  * Copyright (C) 1998 Alexandre Julliard
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <ctype.h>
26 #include <dirent.h>
27 #include <errno.h>
28 #include <fcntl.h>
29 #include <signal.h>
30 #include <stdarg.h>
31 #include <stdio.h>
32 #include <string.h>
33 #include <sys/types.h>
34 #ifdef HAVE_SYS_SOCKET_H
35 # include <sys/socket.h>
36 #endif
37 #ifdef HAVE_SYS_WAIT_H
38 #include <sys/wait.h>
39 #endif
40 #ifdef HAVE_SYS_UN_H
41 #include <sys/un.h>
42 #endif
43 #ifdef HAVE_SYS_MMAN_H
44 #include <sys/mman.h>
45 #endif
46 #ifdef HAVE_SYS_STAT_H
47 # include <sys/stat.h>
48 #endif
49 #ifdef HAVE_SYS_UIO_H
50 #include <sys/uio.h>
51 #endif
52 #ifdef HAVE_UNISTD_H
53 # include <unistd.h>
54 #endif
55
56 #include "ntstatus.h"
57 #define WIN32_NO_STATUS
58 #include "wine/library.h"
59 #include "wine/pthread.h"
60 #include "wine/server.h"
61 #include "wine/debug.h"
62 #include "ntdll_misc.h"
63
64 WINE_DEFAULT_DEBUG_CHANNEL(server);
65
66 /* Some versions of glibc don't define this */
67 #ifndef SCM_RIGHTS
68 #define SCM_RIGHTS 1
69 #endif
70
71 #define SOCKETNAME "socket"        /* name of the socket file */
72 #define LOCKNAME   "lock"          /* name of the lock file */
73
74 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
75 /* data structure used to pass an fd with sendmsg/recvmsg */
76 struct cmsg_fd
77 {
78     struct
79     {
80         size_t len;   /* size of structure */
81         int    level; /* SOL_SOCKET */
82         int    type;  /* SCM_RIGHTS */
83     } header;
84     int fd;          /* fd to pass */
85 };
86 #endif  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
87
88 timeout_t server_start_time = 0;  /* time of server startup */
89
90 extern struct wine_pthread_functions pthread_functions;
91
92 sigset_t server_block_set;  /* signals to block during server calls */
93 static int fd_socket = -1;  /* socket to exchange file descriptors with the server */
94
95 static RTL_CRITICAL_SECTION fd_cache_section;
96 static RTL_CRITICAL_SECTION_DEBUG critsect_debug =
97 {
98     0, 0, &fd_cache_section,
99     { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
100       0, 0, { (DWORD_PTR)(__FILE__ ": fd_cache_section") }
101 };
102 static RTL_CRITICAL_SECTION fd_cache_section = { &critsect_debug, -1, 0, 0, 0, 0 };
103
104
105 #ifdef __GNUC__
106 static void fatal_error( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
107 static void fatal_perror( const char *err, ... ) __attribute__((noreturn, format(printf,1,2)));
108 static void server_connect_error( const char *serverdir ) __attribute__((noreturn));
109 #endif
110
111 /* die on a fatal error; use only during initialization */
112 static void fatal_error( const char *err, ... )
113 {
114     va_list args;
115
116     va_start( args, err );
117     fprintf( stderr, "wine: " );
118     vfprintf( stderr, err, args );
119     va_end( args );
120     exit(1);
121 }
122
123 /* die on a fatal error; use only during initialization */
124 static void fatal_perror( const char *err, ... )
125 {
126     va_list args;
127
128     va_start( args, err );
129     fprintf( stderr, "wine: " );
130     vfprintf( stderr, err, args );
131     perror( " " );
132     va_end( args );
133     exit(1);
134 }
135
136
137 /***********************************************************************
138  *           server_exit_thread
139  */
140 void server_exit_thread( int status )
141 {
142     struct wine_pthread_thread_info info;
143     SIZE_T size;
144     int fds[4];
145
146     RtlAcquirePebLock();
147     RemoveEntryList( &NtCurrentTeb()->TlsLinks );
148     RtlReleasePebLock();
149
150     info.stack_base  = NtCurrentTeb()->DeallocationStack;
151     info.teb_base    = NtCurrentTeb();
152     info.teb_sel     = wine_get_fs();
153     info.exit_status = status;
154
155     fds[0] = ntdll_get_thread_data()->wait_fd[0];
156     fds[1] = ntdll_get_thread_data()->wait_fd[1];
157     fds[2] = ntdll_get_thread_data()->reply_fd;
158     fds[3] = ntdll_get_thread_data()->request_fd;
159     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, NULL );
160
161     size = 0;
162     NtFreeVirtualMemory( GetCurrentProcess(), &info.stack_base, &size, MEM_RELEASE | MEM_SYSTEM );
163     info.stack_size = size;
164
165     size = 0;
166     NtFreeVirtualMemory( GetCurrentProcess(), &info.teb_base, &size, MEM_RELEASE | MEM_SYSTEM );
167     info.teb_size = size;
168
169     close( fds[0] );
170     close( fds[1] );
171     close( fds[2] );
172     close( fds[3] );
173     pthread_functions.exit_thread( &info );
174 }
175
176
177 /***********************************************************************
178  *           server_abort_thread
179  */
180 void server_abort_thread( int status )
181 {
182     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, NULL );
183     close( ntdll_get_thread_data()->wait_fd[0] );
184     close( ntdll_get_thread_data()->wait_fd[1] );
185     close( ntdll_get_thread_data()->reply_fd );
186     close( ntdll_get_thread_data()->request_fd );
187     pthread_functions.abort_thread( status );
188 }
189
190
191 /***********************************************************************
192  *           server_protocol_error
193  */
194 void server_protocol_error( const char *err, ... )
195 {
196     va_list args;
197
198     va_start( args, err );
199     fprintf( stderr, "wine client error:%x: ", GetCurrentThreadId() );
200     vfprintf( stderr, err, args );
201     va_end( args );
202     server_abort_thread(1);
203 }
204
205
206 /***********************************************************************
207  *           server_protocol_perror
208  */
209 void server_protocol_perror( const char *err )
210 {
211     fprintf( stderr, "wine client error:%x: ", GetCurrentThreadId() );
212     perror( err );
213     server_abort_thread(1);
214 }
215
216
217 /***********************************************************************
218  *           send_request
219  *
220  * Send a request to the server.
221  */
222 static void send_request( const struct __server_request_info *req )
223 {
224     unsigned int i;
225     int ret;
226
227     if (!req->u.req.request_header.request_size)
228     {
229         if ((ret = write( ntdll_get_thread_data()->request_fd, &req->u.req,
230                           sizeof(req->u.req) )) == sizeof(req->u.req)) return;
231
232     }
233     else
234     {
235         struct iovec vec[__SERVER_MAX_DATA+1];
236
237         vec[0].iov_base = (void *)&req->u.req;
238         vec[0].iov_len = sizeof(req->u.req);
239         for (i = 0; i < req->data_count; i++)
240         {
241             vec[i+1].iov_base = (void *)req->data[i].ptr;
242             vec[i+1].iov_len = req->data[i].size;
243         }
244         if ((ret = writev( ntdll_get_thread_data()->request_fd, vec, i+1 )) ==
245             req->u.req.request_header.request_size + sizeof(req->u.req)) return;
246     }
247
248     if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
249     if (errno == EPIPE) server_abort_thread(0);
250     server_protocol_perror( "write" );
251 }
252
253
254 /***********************************************************************
255  *           read_reply_data
256  *
257  * Read data from the reply buffer; helper for wait_reply.
258  */
259 static void read_reply_data( void *buffer, size_t size )
260 {
261     int ret;
262
263     for (;;)
264     {
265         if ((ret = read( ntdll_get_thread_data()->reply_fd, buffer, size )) > 0)
266         {
267             if (!(size -= ret)) return;
268             buffer = (char *)buffer + ret;
269             continue;
270         }
271         if (!ret) break;
272         if (errno == EINTR) continue;
273         if (errno == EPIPE) break;
274         server_protocol_perror("read");
275     }
276     /* the server closed the connection; time to die... */
277     server_abort_thread(0);
278 }
279
280
281 /***********************************************************************
282  *           wait_reply
283  *
284  * Wait for a reply from the server.
285  */
286 static inline void wait_reply( struct __server_request_info *req )
287 {
288     read_reply_data( &req->u.reply, sizeof(req->u.reply) );
289     if (req->u.reply.reply_header.reply_size)
290         read_reply_data( req->reply_data, req->u.reply.reply_header.reply_size );
291 }
292
293
294 /***********************************************************************
295  *           wine_server_call (NTDLL.@)
296  *
297  * Perform a server call.
298  *
299  * PARAMS
300  *     req_ptr [I/O] Function dependent data
301  *
302  * RETURNS
303  *     Depends on server function being called, but usually an NTSTATUS code.
304  *
305  * NOTES
306  *     Use the SERVER_START_REQ and SERVER_END_REQ to help you fill out the
307  *     server request structure for the particular call. E.g:
308  *|     SERVER_START_REQ( event_op )
309  *|     {
310  *|         req->handle = handle;
311  *|         req->op     = SET_EVENT;
312  *|         ret = wine_server_call( req );
313  *|     }
314  *|     SERVER_END_REQ;
315  */
316 unsigned int wine_server_call( void *req_ptr )
317 {
318     struct __server_request_info * const req = req_ptr;
319     sigset_t old_set;
320
321     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, &old_set );
322     send_request( req );
323     wait_reply( req );
324     pthread_functions.sigprocmask( SIG_SETMASK, &old_set, NULL );
325     return req->u.reply.reply_header.error;
326 }
327
328
329 /***********************************************************************
330  *           server_enter_uninterrupted_section
331  */
332 void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset )
333 {
334     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, sigset );
335     RtlEnterCriticalSection( cs );
336 }
337
338
339 /***********************************************************************
340  *           server_leave_uninterrupted_section
341  */
342 void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset )
343 {
344     RtlLeaveCriticalSection( cs );
345     pthread_functions.sigprocmask( SIG_SETMASK, sigset, NULL );
346 }
347
348
349 /***********************************************************************
350  *           wine_server_send_fd   (NTDLL.@)
351  *
352  * Send a file descriptor to the server.
353  *
354  * PARAMS
355  *     fd [I] file descriptor to send
356  *
357  * RETURNS
358  *     nothing
359  */
360 void wine_server_send_fd( int fd )
361 {
362 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
363     struct cmsg_fd cmsg;
364 #endif
365     struct send_fd data;
366     struct msghdr msghdr;
367     struct iovec vec;
368     int ret;
369
370     vec.iov_base = (void *)&data;
371     vec.iov_len  = sizeof(data);
372
373     msghdr.msg_name    = NULL;
374     msghdr.msg_namelen = 0;
375     msghdr.msg_iov     = &vec;
376     msghdr.msg_iovlen  = 1;
377
378 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
379     msghdr.msg_accrights    = (void *)&fd;
380     msghdr.msg_accrightslen = sizeof(fd);
381 #else  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
382     cmsg.header.len   = sizeof(cmsg.header) + sizeof(fd);
383     cmsg.header.level = SOL_SOCKET;
384     cmsg.header.type  = SCM_RIGHTS;
385     cmsg.fd           = fd;
386     msghdr.msg_control    = &cmsg;
387     msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
388     msghdr.msg_flags      = 0;
389 #endif  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
390
391     data.tid = GetCurrentThreadId();
392     data.fd  = fd;
393
394     for (;;)
395     {
396         if ((ret = sendmsg( fd_socket, &msghdr, 0 )) == sizeof(data)) return;
397         if (ret >= 0) server_protocol_error( "partial write %d\n", ret );
398         if (errno == EINTR) continue;
399         if (errno == EPIPE) server_abort_thread(0);
400         server_protocol_perror( "sendmsg" );
401     }
402 }
403
404
405 /***********************************************************************
406  *           receive_fd
407  *
408  * Receive a file descriptor passed from the server.
409  */
410 static int receive_fd( obj_handle_t *handle )
411 {
412     struct iovec vec;
413     int ret, fd;
414
415 #ifdef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
416     struct msghdr msghdr;
417
418     fd = -1;
419     msghdr.msg_accrights    = (void *)&fd;
420     msghdr.msg_accrightslen = sizeof(fd);
421 #else  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
422     struct msghdr msghdr;
423     struct cmsg_fd cmsg;
424
425     cmsg.header.len   = sizeof(cmsg.header) + sizeof(fd);
426     cmsg.header.level = SOL_SOCKET;
427     cmsg.header.type  = SCM_RIGHTS;
428     cmsg.fd           = -1;
429     msghdr.msg_control    = &cmsg;
430     msghdr.msg_controllen = sizeof(cmsg.header) + sizeof(fd);
431     msghdr.msg_flags      = 0;
432 #endif  /* HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS */
433
434     msghdr.msg_name    = NULL;
435     msghdr.msg_namelen = 0;
436     msghdr.msg_iov     = &vec;
437     msghdr.msg_iovlen  = 1;
438     vec.iov_base = (void *)handle;
439     vec.iov_len  = sizeof(*handle);
440
441     for (;;)
442     {
443         if ((ret = recvmsg( fd_socket, &msghdr, 0 )) > 0)
444         {
445 #ifndef HAVE_STRUCT_MSGHDR_MSG_ACCRIGHTS
446             fd = cmsg.fd;
447 #endif
448             if (fd != -1) fcntl( fd, F_SETFD, 1 ); /* set close on exec flag */
449             return fd;
450         }
451         if (!ret) break;
452         if (errno == EINTR) continue;
453         if (errno == EPIPE) break;
454         server_protocol_perror("recvmsg");
455     }
456     /* the server closed the connection; time to die... */
457     server_abort_thread(0);
458 }
459
460
461 /***********************************************************************/
462 /* fd cache support */
463
464 struct fd_cache_entry
465 {
466     int fd;
467     enum server_fd_type type : 6;
468     unsigned int        access : 2;
469     unsigned int        options : 24;
470 };
471
472 #define FD_CACHE_BLOCK_SIZE  (65536 / sizeof(struct fd_cache_entry))
473 #define FD_CACHE_ENTRIES     128
474
475 static struct fd_cache_entry *fd_cache[FD_CACHE_ENTRIES];
476 static struct fd_cache_entry fd_cache_initial_block[FD_CACHE_BLOCK_SIZE];
477
478 static inline unsigned int handle_to_index( obj_handle_t handle, unsigned int *entry )
479 {
480     unsigned long idx = ((unsigned long)handle >> 2) - 1;
481     *entry = idx / FD_CACHE_BLOCK_SIZE;
482     return idx % FD_CACHE_BLOCK_SIZE;
483 }
484
485
486 /***********************************************************************
487  *           add_fd_to_cache
488  *
489  * Caller must hold fd_cache_section.
490  */
491 static int add_fd_to_cache( obj_handle_t handle, int fd, enum server_fd_type type,
492                             unsigned int access, unsigned int options )
493 {
494     unsigned int entry, idx = handle_to_index( handle, &entry );
495     int prev_fd;
496
497     if (entry >= FD_CACHE_ENTRIES)
498     {
499         FIXME( "too many allocated handles, not caching %p\n", handle );
500         return 0;
501     }
502
503     if (!fd_cache[entry])  /* do we need to allocate a new block of entries? */
504     {
505         if (!entry) fd_cache[0] = fd_cache_initial_block;
506         else
507         {
508             void *ptr = wine_anon_mmap( NULL, FD_CACHE_BLOCK_SIZE * sizeof(struct fd_cache_entry),
509                                         PROT_READ | PROT_WRITE, 0 );
510             if (ptr == MAP_FAILED) return 0;
511             fd_cache[entry] = ptr;
512         }
513     }
514     /* store fd+1 so that 0 can be used as the unset value */
515     prev_fd = interlocked_xchg( &fd_cache[entry][idx].fd, fd + 1 ) - 1;
516     fd_cache[entry][idx].type = type;
517     fd_cache[entry][idx].access = access;
518     fd_cache[entry][idx].options = options;
519     if (prev_fd != -1) close( prev_fd );
520     return 1;
521 }
522
523
524 /***********************************************************************
525  *           get_cached_fd
526  *
527  * Caller must hold fd_cache_section.
528  */
529 static inline int get_cached_fd( obj_handle_t handle, enum server_fd_type *type,
530                                  unsigned int *access, unsigned int *options )
531 {
532     unsigned int entry, idx = handle_to_index( handle, &entry );
533     int fd = -1;
534
535     if (entry < FD_CACHE_ENTRIES && fd_cache[entry])
536     {
537         fd = fd_cache[entry][idx].fd - 1;
538         if (type) *type = fd_cache[entry][idx].type;
539         if (access) *access = fd_cache[entry][idx].access;
540         if (options) *options = fd_cache[entry][idx].options;
541     }
542     return fd;
543 }
544
545
546 /***********************************************************************
547  *           server_remove_fd_from_cache
548  */
549 int server_remove_fd_from_cache( obj_handle_t handle )
550 {
551     unsigned int entry, idx = handle_to_index( handle, &entry );
552     int fd = -1;
553
554     if (entry < FD_CACHE_ENTRIES && fd_cache[entry])
555         fd = interlocked_xchg( &fd_cache[entry][idx].fd, 0 ) - 1;
556
557     return fd;
558 }
559
560
561 /***********************************************************************
562  *           server_get_unix_fd
563  *
564  * The returned unix_fd should be closed iff needs_close is non-zero.
565  */
566 int server_get_unix_fd( obj_handle_t handle, unsigned int wanted_access, int *unix_fd,
567                         int *needs_close, enum server_fd_type *type, unsigned int *options )
568 {
569     sigset_t sigset;
570     obj_handle_t fd_handle;
571     int ret = 0, fd;
572     unsigned int access = 0;
573
574     *unix_fd = -1;
575     *needs_close = 0;
576     wanted_access &= FILE_READ_DATA | FILE_WRITE_DATA;
577
578     server_enter_uninterrupted_section( &fd_cache_section, &sigset );
579
580     fd = get_cached_fd( handle, type, &access, options );
581     if (fd != -1) goto done;
582
583     SERVER_START_REQ( get_handle_fd )
584     {
585         req->handle = handle;
586         if (!(ret = wine_server_call( req )))
587         {
588             if (type) *type = reply->type;
589             if (options) *options = reply->options;
590             access = reply->access;
591             if ((fd = receive_fd( &fd_handle )) != -1)
592             {
593                 assert( fd_handle == handle );
594                 *needs_close = (reply->removable ||
595                                 !add_fd_to_cache( handle, fd, reply->type,
596                                                   reply->access, reply->options ));
597             }
598             else ret = STATUS_TOO_MANY_OPENED_FILES;
599         }
600     }
601     SERVER_END_REQ;
602
603 done:
604     server_leave_uninterrupted_section( &fd_cache_section, &sigset );
605     if (!ret && ((access & wanted_access) != wanted_access))
606     {
607         ret = STATUS_ACCESS_DENIED;
608         if (*needs_close) close( fd );
609     }
610     if (!ret) *unix_fd = fd;
611     return ret;
612 }
613
614
615 /***********************************************************************
616  *           wine_server_fd_to_handle   (NTDLL.@)
617  *
618  * Allocate a file handle for a Unix file descriptor.
619  *
620  * PARAMS
621  *     fd      [I] Unix file descriptor.
622  *     access  [I] Win32 access flags.
623  *     attributes [I] Object attributes.
624  *     handle  [O] Address where Wine file handle will be stored.
625  *
626  * RETURNS
627  *     NTSTATUS code
628  */
629 int wine_server_fd_to_handle( int fd, unsigned int access, unsigned int attributes, obj_handle_t *handle )
630 {
631     int ret;
632
633     *handle = 0;
634     wine_server_send_fd( fd );
635
636     SERVER_START_REQ( alloc_file_handle )
637     {
638         req->access     = access;
639         req->attributes = attributes;
640         req->fd         = fd;
641         if (!(ret = wine_server_call( req ))) *handle = reply->handle;
642     }
643     SERVER_END_REQ;
644     return ret;
645 }
646
647
648 /***********************************************************************
649  *           wine_server_handle_to_fd   (NTDLL.@)
650  *
651  * Retrieve the file descriptor corresponding to a file handle.
652  *
653  * PARAMS
654  *     handle  [I] Wine file handle.
655  *     access  [I] Win32 file access rights requested.
656  *     unix_fd [O] Address where Unix file descriptor will be stored.
657  *     options [O] Address where the file open options will be stored. Optional.
658  *
659  * RETURNS
660  *     NTSTATUS code
661  */
662 int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd,
663                               unsigned int *options )
664 {
665     int needs_close, ret = server_get_unix_fd( handle, access, unix_fd, &needs_close, NULL, options );
666
667     if (!ret && !needs_close)
668     {
669         if ((*unix_fd = dup(*unix_fd)) == -1) ret = FILE_GetNtStatus();
670     }
671     return ret;
672 }
673
674
675 /***********************************************************************
676  *           wine_server_release_fd   (NTDLL.@)
677  *
678  * Release the Unix file descriptor returned by wine_server_handle_to_fd.
679  *
680  * PARAMS
681  *     handle  [I] Wine file handle.
682  *     unix_fd [I] Unix file descriptor to release.
683  *
684  * RETURNS
685  *     nothing
686  */
687 void wine_server_release_fd( obj_handle_t handle, int unix_fd )
688 {
689     close( unix_fd );
690 }
691
692
693 /***********************************************************************
694  *           start_server
695  *
696  * Start a new wine server.
697  */
698 static void start_server(void)
699 {
700     static int started;  /* we only try once */
701     char *argv[3];
702     static char wineserver[] = "server/wineserver";
703     static char debug[] = "-d";
704
705     if (!started)
706     {
707         int status;
708         int pid = fork();
709         if (pid == -1) fatal_perror( "fork" );
710         if (!pid)
711         {
712             argv[0] = wineserver;
713             argv[1] = TRACE_ON(server) ? debug : NULL;
714             argv[2] = NULL;
715             wine_exec_wine_binary( argv[0], argv, getenv("WINESERVER") );
716             fatal_error( "could not exec wineserver\n" );
717         }
718         waitpid( pid, &status, 0 );
719         status = WIFEXITED(status) ? WEXITSTATUS(status) : 1;
720         if (status == 2) return;  /* server lock held by someone else, will retry later */
721         if (status) exit(status);  /* server failed */
722         started = 1;
723     }
724 }
725
726
727 /***********************************************************************
728  *           server_connect_error
729  *
730  * Try to display a meaningful explanation of why we couldn't connect
731  * to the server.
732  */
733 static void server_connect_error( const char *serverdir )
734 {
735     int fd;
736     struct flock fl;
737
738     if ((fd = open( LOCKNAME, O_WRONLY )) == -1)
739         fatal_error( "for some mysterious reason, the wine server never started.\n" );
740
741     fl.l_type   = F_WRLCK;
742     fl.l_whence = SEEK_SET;
743     fl.l_start  = 0;
744     fl.l_len    = 1;
745     if (fcntl( fd, F_GETLK, &fl ) != -1)
746     {
747         if (fl.l_type == F_WRLCK)  /* the file is locked */
748             fatal_error( "a wine server seems to be running, but I cannot connect to it.\n"
749                          "   You probably need to kill that process (it might be pid %d).\n",
750                          (int)fl.l_pid );
751         fatal_error( "for some mysterious reason, the wine server failed to run.\n" );
752     }
753     fatal_error( "the file system of '%s' doesn't support locks,\n"
754           "   and there is a 'socket' file in that directory that prevents wine from starting.\n"
755           "   You should make sure no wine server is running, remove that file and try again.\n",
756                  serverdir );
757 }
758
759
760 /***********************************************************************
761  *           server_connect
762  *
763  * Attempt to connect to an existing server socket.
764  * We need to be in the server directory already.
765  */
766 static int server_connect( const char *serverdir )
767 {
768     struct sockaddr_un addr;
769     struct stat st;
770     int s, slen, retry, fd_cwd;
771
772     /* retrieve the current directory */
773     fd_cwd = open( ".", O_RDONLY );
774     if (fd_cwd != -1) fcntl( fd_cwd, F_SETFD, 1 ); /* set close on exec flag */
775
776     /* chdir to the server directory */
777     if (chdir( serverdir ) == -1)
778     {
779         if (errno != ENOENT) fatal_perror( "chdir to %s", serverdir );
780         start_server();
781         if (chdir( serverdir ) == -1) fatal_perror( "chdir to %s", serverdir );
782     }
783
784     /* make sure we are at the right place */
785     if (stat( ".", &st ) == -1) fatal_perror( "stat %s", serverdir );
786     if (st.st_uid != getuid()) fatal_error( "'%s' is not owned by you\n", serverdir );
787     if (st.st_mode & 077) fatal_error( "'%s' must not be accessible by other users\n", serverdir );
788
789     for (retry = 0; retry < 6; retry++)
790     {
791         /* if not the first try, wait a bit to leave the previous server time to exit */
792         if (retry)
793         {
794             usleep( 100000 * retry * retry );
795             start_server();
796             if (lstat( SOCKETNAME, &st ) == -1) continue;  /* still no socket, wait a bit more */
797         }
798         else if (lstat( SOCKETNAME, &st ) == -1) /* check for an already existing socket */
799         {
800             if (errno != ENOENT) fatal_perror( "lstat %s/%s", serverdir, SOCKETNAME );
801             start_server();
802             if (lstat( SOCKETNAME, &st ) == -1) continue;  /* still no socket, wait a bit more */
803         }
804
805         /* make sure the socket is sane (ISFIFO needed for Solaris) */
806         if (!S_ISSOCK(st.st_mode) && !S_ISFIFO(st.st_mode))
807             fatal_error( "'%s/%s' is not a socket\n", serverdir, SOCKETNAME );
808         if (st.st_uid != getuid())
809             fatal_error( "'%s/%s' is not owned by you\n", serverdir, SOCKETNAME );
810
811         /* try to connect to it */
812         addr.sun_family = AF_UNIX;
813         strcpy( addr.sun_path, SOCKETNAME );
814         slen = sizeof(addr) - sizeof(addr.sun_path) + strlen(addr.sun_path) + 1;
815 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
816         addr.sun_len = slen;
817 #endif
818         if ((s = socket( AF_UNIX, SOCK_STREAM, 0 )) == -1) fatal_perror( "socket" );
819         if (connect( s, (struct sockaddr *)&addr, slen ) != -1)
820         {
821             /* switch back to the starting directory */
822             if (fd_cwd != -1)
823             {
824                 fchdir( fd_cwd );
825                 close( fd_cwd );
826             }
827             fcntl( s, F_SETFD, 1 ); /* set close on exec flag */
828             return s;
829         }
830         close( s );
831     }
832     server_connect_error( serverdir );
833 }
834
835
836 /***********************************************************************
837  *           rm_rf
838  *
839  * Remove a directory and all its contents; helper for create_config_dir.
840  */
841 static void rm_rf( const char *path )
842 {
843     int err = errno;  /* preserve errno */
844     DIR *dir;
845     char *buffer, *p;
846     struct stat st;
847     struct dirent *de;
848
849     if (!(buffer = malloc( strlen(path) + 256 + 1 ))) goto done;
850     strcpy( buffer, path );
851     p = buffer + strlen(buffer);
852     *p++ = '/';
853
854     if ((dir = opendir( path )))
855     {
856         while ((de = readdir( dir )))
857         {
858             if (!strcmp( de->d_name, "." ) || !strcmp( de->d_name, ".." )) continue;
859             strcpy( p, de->d_name );
860             if (unlink( buffer ) != -1) continue;
861             if (errno == EISDIR ||
862                 (errno == EPERM && !lstat( buffer, &st ) && S_ISDIR(st.st_mode)))
863             {
864                 /* recurse in the sub-directory */
865                 rm_rf( buffer );
866             }
867         }
868         closedir( dir );
869     }
870     free( buffer );
871     rmdir( path );
872 done:
873     errno = err;
874 }
875
876
877 /***********************************************************************
878  *           create_config_dir
879  *
880  * Create the wine configuration dir (~/.wine).
881  */
882 static void create_config_dir(void)
883 {
884     const char *config_dir = wine_get_config_dir();
885     char *tmp_dir;
886     int fd;
887     pid_t pid, wret;
888
889     if (!(tmp_dir = malloc( strlen(config_dir) + sizeof("-XXXXXX") )))
890         fatal_error( "out of memory\n" );
891     strcpy( tmp_dir, config_dir );
892     strcat( tmp_dir, "-XXXXXX" );
893     if ((fd = mkstemps( tmp_dir, 0 )) == -1)
894         fatal_perror( "can't get temp file name for %s", config_dir );
895     close( fd );
896     unlink( tmp_dir );
897     if (mkdir( tmp_dir, 0777 ) == -1)
898         fatal_perror( "cannot create temp dir %s", tmp_dir );
899
900     MESSAGE( "wine: creating configuration directory '%s'...\n", config_dir );
901     pid = fork();
902     if (pid == -1)
903     {
904         rmdir( tmp_dir );
905         fatal_perror( "fork" );
906     }
907     if (!pid)
908     {
909         char *argv[6];
910         static char argv0[] = "tools/wineprefixcreate",
911                     argv1[] = "--quiet",
912                     argv2[] = "--wait",
913                     argv3[] = "--prefix";
914
915         argv[0] = argv0;
916         argv[1] = argv1;
917         argv[2] = argv2;
918         argv[3] = argv3;
919         argv[4] = tmp_dir;
920         argv[5] = NULL;
921         wine_exec_wine_binary( argv[0], argv, NULL );
922         rmdir( tmp_dir );
923         fatal_perror( "could not exec wineprefixcreate" );
924     }
925     else
926     {
927         int status;
928
929         while ((wret = waitpid( pid, &status, 0 )) != pid)
930         {
931             if (wret == -1 && errno != EINTR) fatal_perror( "wait4" );
932         }
933         if (!WIFEXITED(status) || WEXITSTATUS(status))
934         {
935             rm_rf( tmp_dir );
936             fatal_error( "wineprefixcreate failed while creating '%s'.\n", config_dir );
937         }
938     }
939     if (rename( tmp_dir, config_dir ) == -1)
940     {
941         rm_rf( tmp_dir );
942         if (errno != EEXIST && errno != ENOTEMPTY)
943             fatal_perror( "rename '%s' to '%s'", tmp_dir, config_dir );
944         /* else it was probably created by a concurrent wine process */
945     }
946     free( tmp_dir );
947     MESSAGE( "wine: '%s' created successfully.\n", config_dir );
948 }
949
950
951 #ifdef __APPLE__
952 #include <mach/mach.h>
953 #include <mach/mach_error.h>
954 #include <servers/bootstrap.h>
955
956 /* send our task port to the server */
957 static void send_server_task_port(void)
958 {
959     mach_port_t bootstrap_port, wineserver_port;
960     kern_return_t kret;
961
962     struct {
963         mach_msg_header_t           header;
964         mach_msg_body_t             body;
965         mach_msg_port_descriptor_t  task_port;
966     } msg;
967
968     if (task_get_bootstrap_port(mach_task_self(), &bootstrap_port) != KERN_SUCCESS) return;
969
970     kret = bootstrap_look_up(bootstrap_port, (char*)wine_get_server_dir(), &wineserver_port);
971     if (kret != KERN_SUCCESS)
972         fatal_error( "cannot find the server port: 0x%08x\n", kret );
973
974     mach_port_deallocate(mach_task_self(), bootstrap_port);
975
976     msg.header.msgh_bits        = MACH_MSGH_BITS(MACH_MSG_TYPE_COPY_SEND, 0) | MACH_MSGH_BITS_COMPLEX;
977     msg.header.msgh_size        = sizeof(msg);
978     msg.header.msgh_remote_port = wineserver_port;
979     msg.header.msgh_local_port  = MACH_PORT_NULL;
980
981     msg.body.msgh_descriptor_count  = 1;
982     msg.task_port.name              = mach_task_self();
983     msg.task_port.disposition       = MACH_MSG_TYPE_COPY_SEND;
984     msg.task_port.type              = MACH_MSG_PORT_DESCRIPTOR;
985
986     kret = mach_msg_send(&msg.header);
987     if (kret != KERN_SUCCESS)
988         server_protocol_error( "mach_msg_send failed: 0x%08x\n", kret );
989
990     mach_port_deallocate(mach_task_self(), wineserver_port);
991 }
992 #endif  /* __APPLE__ */
993
994 /***********************************************************************
995  *           server_init_process
996  *
997  * Start the server and create the initial socket pair.
998  */
999 void server_init_process(void)
1000 {
1001     obj_handle_t dummy_handle;
1002     const char *env_socket = getenv( "WINESERVERSOCKET" );
1003
1004     if (env_socket)
1005     {
1006         fd_socket = atoi( env_socket );
1007         if (fcntl( fd_socket, F_SETFD, 1 ) == -1)
1008             fatal_perror( "Bad server socket %d", fd_socket );
1009         unsetenv( "WINESERVERSOCKET" );
1010     }
1011     else
1012     {
1013         const char *server_dir = wine_get_server_dir();
1014
1015         if (!server_dir)  /* this means the config dir doesn't exist */
1016         {
1017             create_config_dir();
1018             server_dir = wine_get_server_dir();
1019         }
1020
1021         /* connect to the server */
1022         fd_socket = server_connect( server_dir );
1023     }
1024
1025     /* setup the signal mask */
1026     sigemptyset( &server_block_set );
1027     sigaddset( &server_block_set, SIGALRM );
1028     sigaddset( &server_block_set, SIGIO );
1029     sigaddset( &server_block_set, SIGINT );
1030     sigaddset( &server_block_set, SIGHUP );
1031     sigaddset( &server_block_set, SIGUSR1 );
1032     sigaddset( &server_block_set, SIGUSR2 );
1033     sigaddset( &server_block_set, SIGCHLD );
1034     pthread_functions.sigprocmask( SIG_BLOCK, &server_block_set, NULL );
1035
1036     /* receive the first thread request fd on the main socket */
1037     ntdll_get_thread_data()->request_fd = receive_fd( &dummy_handle );
1038
1039 #ifdef __APPLE__
1040     send_server_task_port();
1041 #endif
1042 }
1043
1044
1045 /***********************************************************************
1046  *           server_init_process_done
1047  */
1048 NTSTATUS server_init_process_done(void)
1049 {
1050     PEB *peb = NtCurrentTeb()->Peb;
1051     IMAGE_NT_HEADERS *nt = RtlImageNtHeader( peb->ImageBaseAddress );
1052     NTSTATUS status;
1053
1054     /* Install signal handlers; this cannot be done earlier, since we cannot
1055      * send exceptions to the debugger before the create process event that
1056      * is sent by REQ_INIT_PROCESS_DONE.
1057      * We do need the handlers in place by the time the request is over, so
1058      * we set them up here. If we segfault between here and the server call
1059      * something is very wrong... */
1060     if (!SIGNAL_Init()) exit(1);
1061
1062     /* Signal the parent process to continue */
1063     SERVER_START_REQ( init_process_done )
1064     {
1065         req->module = peb->ImageBaseAddress;
1066         req->entry  = (char *)peb->ImageBaseAddress + nt->OptionalHeader.AddressOfEntryPoint;
1067         req->gui    = (nt->OptionalHeader.Subsystem != IMAGE_SUBSYSTEM_WINDOWS_CUI);
1068         status = wine_server_call( req );
1069     }
1070     SERVER_END_REQ;
1071
1072     pthread_functions.sigprocmask( SIG_UNBLOCK, &server_block_set, NULL );
1073     return status;
1074 }
1075
1076
1077 /***********************************************************************
1078  *           server_init_thread
1079  *
1080  * Send an init thread request. Return 0 if OK.
1081  */
1082 size_t server_init_thread( int unix_pid, int unix_tid, void *entry_point )
1083 {
1084     int version, ret;
1085     int reply_pipe[2];
1086     struct sigaction sig_act;
1087     size_t info_size;
1088
1089     sig_act.sa_handler = SIG_IGN;
1090     sig_act.sa_flags   = 0;
1091     sigemptyset( &sig_act.sa_mask );
1092
1093     /* ignore SIGPIPE so that we get an EPIPE error instead  */
1094     sigaction( SIGPIPE, &sig_act, NULL );
1095     /* automatic child reaping to avoid zombies */
1096 #ifdef SA_NOCLDWAIT
1097     sig_act.sa_flags |= SA_NOCLDWAIT;
1098 #endif
1099     sigaction( SIGCHLD, &sig_act, NULL );
1100
1101     /* create the server->client communication pipes */
1102     if (pipe( reply_pipe ) == -1) server_protocol_perror( "pipe" );
1103     if (pipe( ntdll_get_thread_data()->wait_fd ) == -1) server_protocol_perror( "pipe" );
1104     wine_server_send_fd( reply_pipe[1] );
1105     wine_server_send_fd( ntdll_get_thread_data()->wait_fd[1] );
1106     ntdll_get_thread_data()->reply_fd = reply_pipe[0];
1107     close( reply_pipe[1] );
1108
1109     /* set close on exec flag */
1110     fcntl( ntdll_get_thread_data()->reply_fd, F_SETFD, 1 );
1111     fcntl( ntdll_get_thread_data()->wait_fd[0], F_SETFD, 1 );
1112     fcntl( ntdll_get_thread_data()->wait_fd[1], F_SETFD, 1 );
1113
1114     SERVER_START_REQ( init_thread )
1115     {
1116         req->unix_pid    = unix_pid;
1117         req->unix_tid    = unix_tid;
1118         req->teb         = NtCurrentTeb();
1119         req->peb         = NtCurrentTeb()->Peb;
1120         req->entry       = entry_point;
1121         req->ldt_copy    = &wine_ldt_copy;
1122         req->reply_fd    = reply_pipe[1];
1123         req->wait_fd     = ntdll_get_thread_data()->wait_fd[1];
1124         req->debug_level = (TRACE_ON(server) != 0);
1125         ret = wine_server_call( req );
1126         NtCurrentTeb()->ClientId.UniqueProcess = ULongToHandle(reply->pid);
1127         NtCurrentTeb()->ClientId.UniqueThread  = ULongToHandle(reply->tid);
1128         info_size         = reply->info_size;
1129         version           = reply->version;
1130         server_start_time = reply->server_start;
1131     }
1132     SERVER_END_REQ;
1133
1134     if (ret) server_protocol_error( "init_thread failed with status %x\n", ret );
1135     if (version != SERVER_PROTOCOL_VERSION)
1136         server_protocol_error( "version mismatch %d/%d.\n"
1137                                "Your %s binary was not upgraded correctly,\n"
1138                                "or you have an older one somewhere in your PATH.\n"
1139                                "Or maybe the wrong wineserver is still running?\n",
1140                                version, SERVER_PROTOCOL_VERSION,
1141                                (version > SERVER_PROTOCOL_VERSION) ? "wine" : "wineserver" );
1142     return info_size;
1143 }