2005-11-18 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / w32-io.c
index 311eb3c..fd83e53 100644 (file)
@@ -1,49 +1,48 @@
-/* w32-io.c - W32 API I/O functions
- *     Copyright (C) 2000 Werner Koch (dd9jn)
- *
- * This file is part of GPGME.
- *
- * GPGME is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * GPGME is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
- */
-
+/* w32-io.c - W32 API I/O functions.
+   Copyright (C) 2000 Werner Koch (dd9jn)
+   Copyright (C) 2001, 2002, 2003, 2004 g10 Code GmbH
+
+   This file is part of GPGME.
+   GPGME is free software; you can redistribute it and/or modify it
+   under the terms of the GNU Lesser General Public License as
+   published by the Free Software Foundation; either version 2.1 of
+   the License, or (at your option) any later version.
+   
+   GPGME is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+   
+   You should have received a copy of the GNU Lesser General Public
+   License along with this program; if not, write to the Free Software
+   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+   02111-1307, USA.  */
+
+#ifdef HAVE_CONFIG_H
 #include <config.h>
-#ifdef HAVE_DOSISH_SYSTEM
-
+#endif
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
 #include <errno.h>
-#include <sys/time.h>
-#include <sys/types.h>
 #include <signal.h>
 #include <fcntl.h>
+#include <sys/time.h>
+#include <sys/types.h>
 #include <windows.h>
-#include "syshdr.h"
+#include <io.h>
 
 #include "util.h"
 #include "sema.h"
-#include "io.h"
-
+#include "priv-io.h"
+#include "debug.h"
 
-/* 
- * We assume that a HANDLE can be represented by an int which should be true   
- * for all i386 systems (HANDLE is defined as void *) and these are the only
- * systems for which Windows is available.
- * Further we assume that -1 denotes an invalid handle.
- */
+/* We assume that a HANDLE can be represented by an int which should
+   be true for all i386 systems (HANDLE is defined as void *) and
+   these are the only systems for which Windows is available.  Further
+   we assume that -1 denotes an invalid handle.  */
 
 #define fd_to_handle(a)  ((HANDLE)(a))
 #define handle_to_fd(a)  ((int)(a))
@@ -52,6 +51,7 @@
 
 #define READBUF_SIZE 4096
 #define WRITEBUF_SIZE 4096
+#define PIPEBUF_SIZE  4096
 #define MAX_READERS 20
 #define MAX_WRITERS 20
 
@@ -225,7 +225,7 @@ create_reader (HANDLE fd)
     sec_attr.nLength = sizeof sec_attr;
     sec_attr.bInheritHandle = FALSE;
 
-    c = xtrycalloc (1, sizeof *c );
+    c = calloc (1, sizeof *c );
     if (!c)
         return NULL;
 
@@ -241,7 +241,7 @@ create_reader (HANDLE fd)
             CloseHandle (c->have_space_ev);
         if (c->stopped)
             CloseHandle (c->stopped);
-        xfree (c);
+        free (c);
         return NULL;
     }
 
@@ -259,9 +259,15 @@ create_reader (HANDLE fd)
             CloseHandle (c->have_space_ev);
         if (c->stopped)
             CloseHandle (c->stopped);
-        xfree (c);
+        free (c);
         return NULL;
     }    
+    else {
+      /* We set the priority of the thread higher because we know that
+         it only runs for a short time.  This greatly helps to increase
+         the performance of the I/O. */
+      SetThreadPriority (c->thread_hd, THREAD_PRIORITY_HIGHEST);
+    }
 
     return c;
 }
@@ -269,9 +275,11 @@ create_reader (HANDLE fd)
 static void
 destroy_reader (struct reader_context_s *c)
 {
+    LOCK (c->mutex);
     c->stop_me = 1;
     if (c->have_space_ev) 
         SetEvent (c->have_space_ev);
+    UNLOCK (c->mutex);
 
     DEBUG1 ("waiting for thread %p termination ...", c->thread_hd );
     WaitForSingleObject (c->stopped, INFINITE);
@@ -285,7 +293,7 @@ destroy_reader (struct reader_context_s *c)
         CloseHandle (c->have_space_ev);
     CloseHandle (c->thread_hd);
     DESTROY_LOCK (c->mutex);
-    xfree (c);
+    free (c);
 }
 
 
@@ -394,12 +402,11 @@ _gpgme_io_read ( int fd, void *buffer, size_t count )
     UNLOCK (c->mutex);
 
     DEBUG2 ("fd %d: got %d bytes\n", fd, nread );
+    if (nread > 0)
+      _gpgme_debug (2, "fd %d: got `%.*s'\n", fd, nread, buffer);
 
     return nread;
 }
-
-
-
 /*
  * The writer does use a simple buffering strategy so that we are
  * informed about write errors as soon as possible (i.e. with the the
@@ -476,7 +483,7 @@ create_writer (HANDLE fd)
     sec_attr.nLength = sizeof sec_attr;
     sec_attr.bInheritHandle = FALSE;
 
-    c = xtrycalloc (1, sizeof *c );
+    c = calloc (1, sizeof *c );
     if (!c)
         return NULL;
 
@@ -492,7 +499,7 @@ create_writer (HANDLE fd)
             CloseHandle (c->is_empty);
         if (c->stopped)
             CloseHandle (c->stopped);
-        xfree (c);
+        free (c);
         return NULL;
     }
 
@@ -510,9 +517,15 @@ create_writer (HANDLE fd)
             CloseHandle (c->is_empty);
         if (c->stopped)
             CloseHandle (c->stopped);
-        xfree (c);
+        free (c);
         return NULL;
     }    
+    else {
+      /* We set the priority of the thread higher because we know that
+         it only runs for a short time.  This greatly helps to increase
+         the performance of the I/O. */
+      SetThreadPriority (c->thread_hd, THREAD_PRIORITY_HIGHEST);
+    }
 
     return c;
 }
@@ -520,9 +533,11 @@ create_writer (HANDLE fd)
 static void
 destroy_writer (struct writer_context_s *c)
 {
+    LOCK (c->mutex);
     c->stop_me = 1;
     if (c->have_data) 
         SetEvent (c->have_data);
+    UNLOCK (c->mutex);
 
     DEBUG1 ("waiting for thread %p termination ...", c->thread_hd );
     WaitForSingleObject (c->stopped, INFINITE);
@@ -536,7 +551,7 @@ destroy_writer (struct writer_context_s *c)
         CloseHandle (c->is_empty);
     CloseHandle (c->thread_hd);
     DESTROY_LOCK (c->mutex);
-    xfree (c);
+    free (c);
 }
 
 
@@ -597,6 +612,7 @@ _gpgme_io_write ( int fd, const void *buffer, size_t count )
     struct writer_context_s *c = find_writer (fd,1);
 
     DEBUG2 ("fd %d: about to write %d bytes\n", fd, (int)count );
+    _gpgme_debug (2, "fd %d: write `%.*s'\n", fd, (int) count, buffer);
     if ( !c ) {
         DEBUG0 ( "no writer thread\n");
         return -1;
@@ -643,9 +659,9 @@ _gpgme_io_pipe ( int filedes[2], int inherit_idx )
     sec_attr.nLength = sizeof sec_attr;
     sec_attr.bInheritHandle = FALSE;
     
-    if (!CreatePipe ( &r, &w, &sec_attr, 0))
+    if (!CreatePipe ( &r, &w, &sec_attr, PIPEBUF_SIZE))
         return -1;
-    /* make one end inheritable */
+    /* Make one end inheritable. */
     if ( inherit_idx == 0 ) {
         HANDLE h;
         if (!DuplicateHandle( GetCurrentProcess(), r,
@@ -759,23 +775,36 @@ _gpgme_io_set_nonblocking ( int fd )
 static char *
 build_commandline ( char **argv )
 {
-    int i, n = 0;
-    char *buf, *p;
-
-    /* FIXME: we have to quote some things because under Windows the 
-     * program parses the commandline and does some unquoting */
-    for (i=0; argv[i]; i++)
-        n += strlen (argv[i]) + 1;
-    buf = p = xtrymalloc (n);
-    if ( !buf )
-        return NULL;
-    *buf = 0;
-    if ( argv[0] )
+  int i, n = 0;
+  char *buf, *p;
+  
+  /* FIXME: we have to quote some things because under Windows the
+   * program parses the commandline and does some unquoting.  For now
+   * we only do very basic quoting to the first argument because this
+   * one often contains a space (e.g. C:\\Program Files\GNU\GnuPG\gpg.exe) 
+   * and we would produce an invalid line in that case.  */
+  for (i=0; argv[i]; i++)
+    n += strlen (argv[i]) + 2 + 1; /* 2 extra bytes for possible quoting */
+  buf = p = malloc (n);
+  if ( !buf )
+    return NULL;
+  *buf = 0;
+  if ( argv[0] )
+    {
+      if (strpbrk (argv[0], " \t"))
+        p = stpcpy (stpcpy (stpcpy (p, "\""), argv[0]), "\"");
+      else
         p = stpcpy (p, argv[0]);
-    for (i = 1; argv[i]; i++)
-        p = stpcpy (stpcpy (p, " "), argv[i]);
-
-    return buf;
+      for (i = 1; argv[i]; i++)
+        {
+          if (!*argv[i])
+            p = stpcpy (p, " \"\"");
+          else
+            p = stpcpy (stpcpy (p, " "), argv[i]);
+        }
+    }
+  
+  return buf;
 }
 
 
@@ -800,7 +829,8 @@ _gpgme_io_spawn ( const char *path, char **argv,
     int duped_stdin = 0;
     int duped_stderr = 0;
     HANDLE hnul = INVALID_HANDLE_VALUE;
-    int debug_me = !!getenv ("GPGME_DEBUG");
+    /* FIXME.  */
+    int debug_me = 0;
 
     memset (&sec_attr, 0, sizeof sec_attr );
     sec_attr.nLength = sizeof sec_attr;
@@ -813,7 +843,7 @@ _gpgme_io_spawn ( const char *path, char **argv,
     memset (&si, 0, sizeof si);
     si.cb = sizeof (si);
     si.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
-    si.wShowWindow = debug_me? SW_SHOW : SW_MINIMIZE;
+    si.wShowWindow = debug_me? SW_SHOW : SW_HIDE;
     si.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
     si.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
     si.hStdError = GetStdHandle (STD_ERROR_HANDLE);
@@ -850,7 +880,7 @@ _gpgme_io_spawn ( const char *path, char **argv,
                             NULL );
         if ( hnul == INVALID_HANDLE_VALUE ) {
             DEBUG1 ("can't open `nul': ec=%d\n", (int)GetLastError ());
-            xfree (arg_string);
+            free (arg_string);
             return -1;
         }
         /* Make sure that the process has a connected stdin */
@@ -879,22 +909,19 @@ _gpgme_io_spawn ( const char *path, char **argv,
                           &pi            /* returns process information */
         ) ) {
         DEBUG1 ("CreateProcess failed: ec=%d\n", (int) GetLastError ());
-        xfree (arg_string);
+        free (arg_string);
         return -1;
     }
 
-    /* close the /dev/nul handle if used */
+    /* Close the /dev/nul handle if used. */
     if (hnul != INVALID_HANDLE_VALUE ) {
         if ( !CloseHandle ( hnul ) )
             DEBUG1 ("CloseHandle(hnul) failed: ec=%d\n", (int)GetLastError());
     }
 
-    /* Close the other ends of the pipes */
-    for (i=0; fd_parent_list[i].fd != -1; i++ ) {
-        DEBUG1 ("Closing fd %d\n", fd_parent_list[i].fd );
-        if ( !CloseHandle ( fd_to_handle (fd_parent_list[i].fd) ) )
-            DEBUG1 ("CloseHandle failed: ec=%d", (int)GetLastError());
-    }
+    /* Close the other ends of the pipes. */
+    for (i = 0; fd_parent_list[i].fd != -1; i++)
+      _gpgme_io_close (fd_parent_list[i].fd);
 
     DEBUG4 ("CreateProcess ready\n"
             "-   hProcess=%p  hThread=%p\n"
@@ -915,60 +942,6 @@ _gpgme_io_spawn ( const char *path, char **argv,
 }
 
 
-
-
-int
-_gpgme_io_waitpid ( int pid, int hang, int *r_status, int *r_signal )
-{
-    HANDLE proc = fd_to_handle (pid);
-    int code, ret = 0;
-    DWORD exc;
-
-    *r_status = 0;
-    *r_signal = 0;
-    code = WaitForSingleObject ( proc, hang? INFINITE : 0 );
-    switch (code) {
-      case WAIT_FAILED:
-        DEBUG2 ("WFSO pid=%d failed: %d\n", (int)pid, (int)GetLastError () );
-        break;
-
-      case WAIT_OBJECT_0:
-        if (!GetExitCodeProcess (proc, &exc)) {
-            DEBUG2 ("** GECP pid=%d failed: ec=%d\n",
-                    (int)pid, (int)GetLastError () );
-            *r_status = 4; 
-        }
-        else {
-            DEBUG2 ("GECP pid=%d exit code=%d\n", (int)pid,  exc);
-            *r_status = exc;
-        }
-        ret = 1;
-        break;
-
-      case WAIT_TIMEOUT:
-        if (hang)
-            DEBUG1 ("WFSO pid=%d timed out\n", (int)pid);
-        break;
-
-      default:
-        DEBUG2 ("WFSO pid=%d returned %d\n", (int)pid, code );
-        break;
-    }
-    return ret;
-}
-
-int
-_gpgme_io_kill ( int pid, int hard )
-{
-    HANDLE proc = fd_to_handle (pid);
-
-    #warning I am not sure how to kill a process
-    /* fixme: figure out how this can be done */
-    return 0;
-}
-
-
-
 /*
  * Select on the list of fds.
  * Returns: -1 = error
@@ -976,7 +949,7 @@ _gpgme_io_kill ( int pid, int hard )
  *          >0 = number of signaled fds
  */
 int
-_gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
+_gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds, int nonblock )
 {
     HANDLE waitbuf[MAXIMUM_WAIT_OBJECTS];
     int    waitidx[MAXIMUM_WAIT_OBJECTS];
@@ -986,7 +959,7 @@ _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
     void *dbg_help;
 
  restart:
-    DEBUG_BEGIN (dbg_help, "select on [ ");
+    DEBUG_BEGIN (dbg_help, 3, "select on [ ");
     any = 0;
     nwait = 0;
     count = 0;
@@ -1028,11 +1001,18 @@ _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
                         DEBUG0 ("Too many objects for WFMO!" );
                         return -1;
                     }
-                    waitidx[nwait]   = i;
-                    waitbuf[nwait++] = c->is_empty;
+                    LOCK (c->mutex);
+                    if ( !c->nbytes ) {
+                        waitidx[nwait]   = i;
+                        waitbuf[nwait++] = c->is_empty;
+                        DEBUG_ADD1 (dbg_help, "w%d ", fds[i].fd );
+                        any = 1;
+                    }
+                    else {
+                        DEBUG_ADD1 (dbg_help, "w%d(ignored) ", fds[i].fd );
+                    }
+                    UNLOCK (c->mutex);
                 }
-                DEBUG_ADD1 (dbg_help, "w%d ", fds[i].fd );
-                any = 1;
             }
         }
     }
@@ -1040,7 +1020,7 @@ _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
     if (!any) 
         return 0;
 
-    code = WaitForMultipleObjects ( nwait, waitbuf, 0, 1000);
+    code = WaitForMultipleObjects ( nwait, waitbuf, 0, nonblock ? 0 : 1000);
     if ( code >= WAIT_OBJECT_0 && code < WAIT_OBJECT_0 + nwait ) {
         /* This WFMO is a really silly function:  It does return either
          * the index of the signaled object or if 2 objects have been
@@ -1052,7 +1032,7 @@ _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
          */
         any = 0;
         for (i=code - WAIT_OBJECT_0; i < nwait; i++ ) {
-            if (WaitForSingleObject ( waitbuf[i], NULL ) == WAIT_OBJECT_0) {
+            if (WaitForSingleObject (waitbuf[i], 0) == WAIT_OBJECT_0) {
                 assert (waitidx[i] >=0 && waitidx[i] < nfds);
                 fds[waitidx[i]].signaled = 1;
                 any = 1;
@@ -1073,7 +1053,7 @@ _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
             int k, j = handle_to_fd (waitbuf[i]);
                     
             DEBUG1 ("WFMO invalid handle %d removed\n", j);
-            for (k=0 ; k < nfds; i++ ) {
+            for (k=0 ; k < nfds; k++ ) {
                 if ( fds[k].fd == j ) {
                     fds[k].for_read = fds[k].for_write = 0;
                     goto restart;
@@ -1090,7 +1070,7 @@ _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
     }
 
     if ( count ) {
-        DEBUG_BEGIN (dbg_help, " signaled [ ");
+        DEBUG_BEGIN (dbg_help, 3, " signaled [ ");
         for ( i=0; i < nfds; i++ ) {
             if ( fds[i].fd == -1 ) 
                 continue;
@@ -1105,13 +1085,29 @@ _gpgme_io_select ( struct io_select_fd_s *fds, size_t nfds )
     return count;
 }
 
-#endif /*HAVE_DOSISH_SYSTEM*/
-
-
-
-
+void
+_gpgme_io_subsystem_init (void)
+{
+  
+}
 
 
+/* Write the printable version of FD to the buffer BUF of length
+   BUFLEN.  The printable version is the representation on the command
+   line that the child process expects.  */
+int
+_gpgme_io_fd2str (char *buf, int buflen, int fd)
+{
+  return snprintf (buf, buflen, "%d", fd);
+}
 
+\f
+/* The following interface is only useful for GPGME Glib.  */
 
+/* Look up the giochannel for file descriptor FD.  */
+void *
+gpgme_get_giochannel (int fd)
+{
+  return NULL;
+}