Okay, it runs at least on Windows 95
[gpgme.git] / gpgme / w32-io.c
1 /* w32-io.c - W32 API I/O functions
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GPGME 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #ifdef HAVE_DOSISH_SYSTEM
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <assert.h>
28 #include <errno.h>
29 #include <sys/time.h>
30 #include <sys/types.h>
31 #include <unistd.h>
32 #include <signal.h>
33 #include <fcntl.h>
34 #include <windows.h>
35
36 #include "util.h"
37 #include "io.h"
38
39 #define DEBUG_SELECT_ENABLED 0
40
41 #if DEBUG_SELECT_ENABLED
42 # define DEBUG_SELECT(a) fprintf a
43 #else
44 # define DEBUG_SELECT(a) do { } while(0)
45 #endif
46
47
48
49 /* 
50  * We assume that a HANDLE can be represented by an int which should be true   
51  * for all i386 systems (HANDLE is defined as void *) and these are the only
52  * systems for which Windows is available.
53  * Further we assume that -1 denotes an invalid handle.
54  */
55
56 #define fd_to_handle(a)  ((HANDLE)(a))
57 #define handle_to_fd(a)  ((int)(a))
58 #define pid_to_handle(a) ((HANDLE)(a))
59 #define handle_to_pid(a) ((int)(a))
60
61
62 int
63 _gpgme_io_read ( int fd, void *buffer, size_t count )
64 {
65     int nread = 0;
66     HANDLE h = fd_to_handle (fd);
67
68     DEBUG_SELECT ((stderr,"** fd %d: about to read %d bytes\n", fd, (int)count ));
69     if ( !ReadFile ( h, buffer, count, &nread, NULL) ) {
70         fprintf (stderr, "** ReadFile failed: ec=%d\n", (int)GetLastError ());
71         return -1;
72     }
73     DEBUG_SELECT ((stderr,"** fd %d:           got %d bytes\n", fd, nread ));
74
75     return nread;
76 }
77
78
79 int
80 _gpgme_io_write ( int fd, const void *buffer, size_t count )
81 {
82     int nwritten;
83     HANDLE h = fd_to_handle (fd);
84
85     DEBUG_SELECT ((stderr,"** fd %d: about to write %d bytes\n", fd, (int)count ));
86     if ( !WriteFile ( h, buffer, count, &nwritten, NULL) ) {
87         fprintf (stderr, "** WriteFile failed: ec=%d\n", (int)GetLastError ());
88         return -1;
89     }
90     DEBUG_SELECT ((stderr,"** fd %d:          wrote %d bytes\n", fd, nwritten ));
91
92     return nwritten;
93 }
94
95 int
96 _gpgme_io_pipe ( int filedes[2], int inherit_idx )
97 {
98     HANDLE r, w;
99     SECURITY_ATTRIBUTES sec_attr;
100
101     memset (&sec_attr, 0, sizeof sec_attr );
102     sec_attr.nLength = sizeof sec_attr;
103     sec_attr.bInheritHandle = FALSE;
104     
105     if (!CreatePipe ( &r, &w, &sec_attr, 0))
106         return -1;
107     /* make one end inheritable */
108     if ( inherit_idx == 0 ) {
109         HANDLE h;
110         if (!DuplicateHandle( GetCurrentProcess(), r,
111                               GetCurrentProcess(), &h, 0,
112                               TRUE, DUPLICATE_SAME_ACCESS ) ) {
113             fprintf (stderr, "** DuplicateHandle failed: ec=%d\n",
114                      (int)GetLastError());
115             CloseHandle (r);
116             CloseHandle (w);
117             return -1;
118         }
119         CloseHandle (r);
120         r = h;
121     }
122     else if ( inherit_idx == 1 ) {
123         HANDLE h;
124         if (!DuplicateHandle( GetCurrentProcess(), w,
125                               GetCurrentProcess(), &h, 0,
126                               TRUE, DUPLICATE_SAME_ACCESS ) ) {
127             fprintf (stderr, "** DuplicateHandle failed: ec=%d\n",
128                      (int)GetLastError());
129             CloseHandle (r);
130             CloseHandle (w);
131             return -1;
132         }
133         CloseHandle (w);
134         w = h;
135     }
136
137     filedes[0] = handle_to_fd (r);
138     filedes[1] = handle_to_fd (w);
139     DEBUG_SELECT ((stderr,"** create pipe %p %p %d %d inherit=%d\n", r, w,
140                    filedes[0], filedes[1], inherit_idx ));
141     return 0;
142 }
143
144 int
145 _gpgme_io_close ( int fd )
146 {
147     if ( fd == -1 )
148         return -1;
149
150     DEBUG_SELECT ((stderr,"** closing handle for fd %d\n", fd));
151     if ( !CloseHandle (fd_to_handle (fd)) ) { 
152         fprintf (stderr, "** CloseHandle for fd %d failed: ec=%d\n",
153                  fd, (int)GetLastError ());
154         return -1;
155     }
156
157     return 0;
158 }
159
160
161 int
162 _gpgme_io_set_nonblocking ( int fd )
163 {
164     return 0;
165 }
166
167
168 static char *
169 build_commandline ( char **argv )
170 {
171     int i, n = 0;
172     char *buf, *p;
173
174     /* FIXME: we have to quote some things because under Windows the 
175      * program parses the commandline and does some unquoting */
176     for (i=0; argv[i]; i++)
177         n += strlen (argv[i]) + 1;
178     buf = p = xtrymalloc (n);
179     if ( !buf )
180         return NULL;
181     *buf = 0;
182     if ( argv[0] )
183         p = stpcpy (p, argv[0]);
184     for (i = 1; argv[i]; i++)
185         p = stpcpy (stpcpy (p, " "), argv[i]);
186
187     return buf;
188 }
189
190
191 int
192 _gpgme_io_spawn ( const char *path, char **argv,
193                   struct spawn_fd_item_s *fd_child_list,
194                   struct spawn_fd_item_s *fd_parent_list )
195 {
196     SECURITY_ATTRIBUTES sec_attr;
197     PROCESS_INFORMATION pi = {
198         NULL,      /* returns process handle */
199         0,         /* returns primary thread handle */
200         0,         /* returns pid */
201         0         /* returns tid */
202     };
203     STARTUPINFO si;
204     char *envblock = NULL;
205     int cr_flags = CREATE_DEFAULT_ERROR_MODE
206                  | GetPriorityClass (GetCurrentProcess ());
207     int i;
208     char *arg_string;
209     int duped_stdin = 0;
210     int duped_stderr = 0;
211     HANDLE hnul = INVALID_HANDLE_VALUE;
212
213     memset (&sec_attr, 0, sizeof sec_attr );
214     sec_attr.nLength = sizeof sec_attr;
215     sec_attr.bInheritHandle = FALSE;
216
217     arg_string = build_commandline ( argv );
218     if (!arg_string )
219         return -1; 
220
221     memset (&si, 0, sizeof si);
222     si.cb = sizeof (si);
223     si.dwFlags = STARTF_USESTDHANDLES;
224     si.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
225     si.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
226     si.hStdError = GetStdHandle (STD_ERROR_HANDLE);
227
228     for (i=0; fd_child_list[i].fd != -1; i++ ) {
229         if (fd_child_list[i].dup_to == 0 ) {
230             si.hStdInput = fd_to_handle (fd_child_list[i].fd);
231             DEBUG_SELECT ((stderr,"** using %d for stdin\n", fd_child_list[i].fd ));
232             duped_stdin=1;
233         }
234         else if (fd_child_list[i].dup_to == 1 ) {
235             si.hStdOutput = fd_to_handle (fd_child_list[i].fd);
236             DEBUG_SELECT ((stderr,"** using %d for stdout\n", fd_child_list[i].fd ));
237         }
238         else if (fd_child_list[i].dup_to == 2 ) {
239             si.hStdError = fd_to_handle (fd_child_list[i].fd);
240             DEBUG_SELECT ((stderr,"** using %d for stderr\n", fd_child_list[i].fd ));
241             duped_stderr = 1;
242         }
243     }
244
245     if( !duped_stdin || !duped_stderr ) {
246         SECURITY_ATTRIBUTES sa;
247
248         memset (&sa, 0, sizeof sa );
249         sa.nLength = sizeof sa;
250         sa.bInheritHandle = TRUE;
251         hnul = CreateFile ( "/dev/nul",
252                             GENERIC_READ|GENERIC_WRITE,
253                             FILE_SHARE_READ|FILE_SHARE_WRITE,
254                             &sa,
255                             OPEN_EXISTING,
256                             FILE_ATTRIBUTE_NORMAL,
257                             NULL );
258         if ( hnul == INVALID_HANDLE_VALUE ) {
259             fprintf (stderr,"can't open `/dev/nul': ec=%d\n",
260                      (int)GetLastError () );
261             xfree (arg_string);
262             return -1;
263         }
264         /* Make sure that the process has a connected stdin */
265         if ( !duped_stdin ) {
266             si.hStdInput = hnul;
267             DEBUG_SELECT ((stderr,"** using %d for stdin\n", (int)hnul ));
268         }
269         /* We normally don't want all the normal output */
270         if ( !duped_stderr ) {
271             if (!getenv ("GPGME_DEBUG") ) {
272                 si.hStdError = hnul;
273                 DEBUG_SELECT ((stderr,"** using %d for stderr\n", (int)hnul ));
274             }
275         }
276     }
277
278     DEBUG_SELECT ((stderr,"** CreateProcess ...\n"));
279     DEBUG_SELECT ((stderr,"** args=`%s'\n", arg_string));
280     cr_flags |= CREATE_SUSPENDED; 
281     if ( !CreateProcessA (GPG_PATH,
282                           arg_string,
283                           &sec_attr,     /* process security attributes */
284                           &sec_attr,     /* thread security attributes */
285                           TRUE,          /* inherit handles */
286                           cr_flags,      /* creation flags */
287                           envblock,      /* environment */
288                           NULL,          /* use current drive/directory */
289                           &si,           /* startup information */
290                           &pi            /* returns process information */
291         ) ) {
292         fprintf (stderr, "** CreateProcess failed: ec=%d\n",
293                  (int) GetLastError ());
294         xfree (arg_string);
295         return -1;
296     }
297
298     /* close the /dev/nul handle if used */
299     if (hnul != INVALID_HANDLE_VALUE ) {
300         if ( !CloseHandle ( hnul ) )
301             fprintf (stderr, "** CloseHandle(hnul) failed: ec=%d\n", 
302                      (int)GetLastError());
303     }
304
305     /* Close the other ends of the pipes */
306     for (i=0; fd_parent_list[i].fd != -1; i++ ) {
307         DEBUG_SELECT ((stderr,"** Closing fd %d\n", fd_parent_list[i].fd ));
308         if ( !CloseHandle ( fd_to_handle (fd_parent_list[i].fd) ) )
309             fprintf (stderr, "** CloseHandle failed: ec=%d\n",                 
310                      (int)GetLastError());
311     }
312
313     DEBUG_SELECT ((stderr,"** CreateProcess ready\n"
314                    "**   hProcess=%p  hThread=%p\n"
315                    "**   dwProcessID=%d dwThreadId=%d\n",
316                    pi.hProcess, pi.hThread, 
317                    (int) pi.dwProcessId, (int) pi.dwThreadId));
318
319     if ( ResumeThread ( pi.hThread ) < 0 ) {
320         fprintf (stderr, "** ResumeThread failed: ec=%d\n",
321                  (int)GetLastError ());
322     }
323
324     if ( !CloseHandle (pi.hThread) ) { 
325         fprintf (stderr, "** CloseHandle of thread failed: ec=%d\n",
326                  (int)GetLastError ());
327     }
328
329     return handle_to_pid (pi.hProcess);
330 }
331
332
333
334
335 int
336 _gpgme_io_waitpid ( int pid, int hang, int *r_status, int *r_signal )
337 {
338     HANDLE proc = fd_to_handle (pid);
339     int code, exc, ret = 0;
340
341     *r_status = 0;
342     *r_signal = 0;
343     code = WaitForSingleObject ( proc, hang? INFINITE : NULL );
344     switch (code) {
345       case WAIT_FAILED:
346         fprintf (stderr, "** WFSO pid=%d failed: %d\n",
347                  (int)pid, (int)GetLastError () );
348         break;
349
350       case WAIT_OBJECT_0:
351         if (!GetExitCodeProcess (proc, &exc)) {
352             fprintf (stderr, "** GECP pid=%d failed: ec=%d\n",
353                      (int)pid, (int)GetLastError () );
354             *r_status = 4; 
355         }
356         else {
357             DEBUG_SELECT ((stderr,"** GECP pid=%d exit code=%d\n",
358                            (int)pid,  exc));
359             *r_status = exc;
360         }
361         ret = 1;
362         break;
363
364       case WAIT_TIMEOUT:
365         DEBUG_SELECT ((stderr,"** WFSO pid=%d timed out\n", (int)pid));
366         break;
367
368       default:
369         fprintf (stderr, "** WFSO pid=%d returned %d\n", (int)pid, code );
370         break;
371     }
372     return ret;
373 }
374
375
376 /*
377  * Select on the list of fds.
378  * Returns: -1 = error
379  *           0 = timeout or nothing to select
380  *          >0 = number of signaled fds
381  */
382 int
383 _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
384 {
385 #if 0 /* We can't use WFMO becaus a pipe handle is not a suitable object */
386     HANDLE waitbuf[MAXIMUM_WAIT_OBJECTS];
387     int code, nwait;
388     int i, any, any_write;
389     int count;
390
391  restart:
392     DEBUG_SELECT ((stderr, "gpgme:select on [ "));
393     any = any_write = 0;
394     nwait = 0;
395     for ( i=0; i < nfds; i++ ) {
396         if ( fds[i].fd == -1 ) 
397             continue;
398         if ( fds[i].for_read || fds[i].for_write ) {
399             if ( nwait >= DIM (waitbuf) ) {
400                 DEBUG_SELECT ((stderr,stderr, "oops ]\n" ));
401                 fprintf (stderr, "** Too many objects for WFMO!\n" );
402                 return -1;
403             }
404             else {
405                 if ( fds[i].for_read ) 
406                     waitbuf[nwait++] = fd_to_handle (fds[i].fd);
407                 DEBUG_SELECT ((stderr, "%c%d ",
408                                fds[i].for_read? 'r':'w',fds[i].fd ));
409                 any = 1;
410             }
411         }
412         fds[i].signaled = 0;
413     }
414     DEBUG_SELECT ((stderr, "]\n" ));
415     if (!any) 
416         return 0;
417
418     count = 0;
419     for ( i=0; i < nfds; i++ ) {
420         if ( fds[i].fd == -1 ) 
421             continue;
422         if ( fds[i].for_write ) {
423             fds[i].signaled = 1;
424             any_write =1;
425             count++;
426         }
427     }
428     code = WaitForMultipleObjects ( nwait, waitbuf, 0, any_write? 0:1000);
429     if (code == WAIT_FAILED ) {
430         int le = (int)GetLastError ();
431         if ( le == ERROR_INVALID_HANDLE  || le == ERROR_INVALID_EVENT_COUNT ) {
432             any = 0;
433             for ( i=0; i < nfds; i++ ) {
434                 if ( fds[i].fd == -1 ) 
435                     continue;
436                 if ( fds[i].for_read /*|| fds[i].for_write*/ ) {
437                     int navail;
438                     if (PeekNamedPipe (fd_to_handle (fds[i].fd), 
439                                        NULL, 0, NULL,
440                                        &navail, NULL) && navail ) {
441                         fds[i].signaled = 1;
442                         any = 1;
443                         count++;
444                     }
445                 }
446             }
447             if (any)
448                 return count;
449             /* find that handle and remove it from the list*/
450             for (i=0; i < nwait; i++ ) {
451                 code = WaitForSingleObject ( waitbuf[i], NULL );
452                 if (!code) {
453                     int k, j = handle_to_fd (waitbuf[i]);
454
455                     fprintf (stderr, "** handle meanwhile signaled %d\n", j);
456                     for (k=0 ; k < nfds; k++ ) {
457                         if ( fds[k].fd == j ) {
458                             fds[k].signaled = 1;
459                             count++;
460                             return count; 
461                         }
462                     }
463                     fprintf (stderr, "** oops, or not???\n");
464                 }
465                 if ( GetLastError () == ERROR_INVALID_HANDLE) {
466                     int k, j = handle_to_fd (waitbuf[i]);
467                     
468                     fprintf (stderr, "** WFMO invalid handle %d removed\n", j);
469                     for (k=0 ; k < nfds; i++ ) {
470                         if ( fds[k].fd == j ) {
471                             fds[k].for_read = fds[k].for_write = 0;
472                             goto restart;
473                         }
474                     }
475                     fprintf (stderr, "** oops, or not???\n");
476                 }
477             }
478         }
479
480         fprintf (stderr, "** WFMO failed: %d\n", le );
481         count = -1;
482     }
483     else if ( code == WAIT_TIMEOUT ) {
484         fprintf (stderr, "** WFMO timed out\n" );
485     }  
486     else if ( code >= WAIT_OBJECT_0 && code < WAIT_OBJECT_0 + nwait ) {
487         /* This WFMO is a really silly function:  It does return either
488          * the index of the signaled object or if 2 objects have been
489          * signalled at the same time, the index of the object with the
490          * lowest object is returned - so and how do we find out
491          * how many objects have been signaled???.
492          * The only solution I can imagine is to test each object starting
493          * with the returned index individually - how dull.
494          */
495         any = 0;
496         for (i=code - WAIT_OBJECT_0; i < nwait; i++ ) {
497             if (WaitForSingleObject ( waitbuf[i], NULL ) == WAIT_OBJECT_0) {
498                 fds[i].signaled = 1;
499                 any = 1;
500                 count++;
501             }
502         }
503         if (!any) {
504             fprintf (stderr,
505                      "** Oops: No signaled objects found after WFMO\n");
506             count = -1;
507         }
508     }
509     else {
510         fprintf (stderr, "** WFMO returned %d\n", code );
511         count = -1;
512     }
513
514     return count;
515 #else  /* This is the code we use */
516     int i, any, count;
517     int once_more = 0;
518
519     DEBUG_SELECT ((stderr, "gpgme:fakedselect on [ "));
520     any = 0;
521     for ( i=0; i < nfds; i++ ) {
522         if ( fds[i].fd == -1 ) 
523             continue;
524         if ( fds[i].for_read || fds[i].for_write ) {
525             DEBUG_SELECT ((stderr, "%c%d ",
526                            fds[i].for_read? 'r':'w',fds[i].fd ));
527             any = 1;
528         }
529         fds[i].signaled = 0;
530     }
531     DEBUG_SELECT ((stderr, "]\n" ));
532     if (!any) 
533         return 0;
534
535  restart:
536     count = 0;
537     /* no way to see whether a handle is ready fro writing, signal all */
538     for ( i=0; i < nfds; i++ ) {
539         if ( fds[i].fd == -1 ) 
540             continue;
541         if ( fds[i].for_write ) {
542             fds[i].signaled = 1;
543             count++;
544         }
545     }
546
547     /* now peek on all read handles */
548     for ( i=0; i < nfds; i++ ) {
549         if ( fds[i].fd == -1 ) 
550             continue;
551         if ( fds[i].for_read ) {
552             int navail;
553
554             if ( !PeekNamedPipe (fd_to_handle (fds[i].fd),
555                                  NULL, 0, NULL, &navail, NULL) ) {
556                 fprintf (stderr, "** select: PeekFile failed: ec=%d\n",
557                          (int)GetLastError ());
558             }
559             else if ( navail ) {
560                 fprintf (stderr, "** fd %d has %d bytes to read\n",
561                          fds[i].fd, navail );
562                 fds[i].signaled = 1;
563                 count++;
564             }
565         }
566     }
567     if ( !once_more && !count ) {
568         once_more = 1;
569         Sleep (300);
570         goto restart;
571     }
572
573     if ( count ) {
574         DEBUG_SELECT ((stderr, "gpgme:      signaled [ "));
575         for ( i=0; i < nfds; i++ ) {
576             if ( fds[i].fd == -1 ) 
577                 continue;
578             if ( (fds[i].for_read || fds[i].for_write) && fds[i].signaled ) {
579                 DEBUG_SELECT ((stderr, "%c%d ",
580                                fds[i].for_read? 'r':'w',fds[i].fd ));
581             }
582         }
583         DEBUG_SELECT ((stderr, "]\n" ));
584     }
585     
586     return count;
587 #endif
588 }
589
590 #endif /*HAVE_DOSISH_SYSTEM*/
591
592
593
594
595
596
597
598
599