2005-09-12 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / wait.c
index f54209d..16a9f23 100644 (file)
 /* wait.c 
- *     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
- */
-
+   Copyright (C) 2000 Werner Koch (dd9jn)
+   Copyright (C) 2001, 2002, 2003, 2004, 2005 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.  */
+
+#if HAVE_CONFIG_H
 #include <config.h>
-#include <stdio.h>
+#endif
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
 #include <errno.h>
-#include <sys/time.h>
 #include <sys/types.h>
-#include <unistd.h>
-#include <sys/wait.h>
 
 #include "util.h"
 #include "context.h"
 #include "ops.h"
 #include "wait.h"
-
-#define DEBUG_SELECT_ENABLED 1
-
-#if DEBUG_SELECT_ENABLED
-# define DEBUG_SELECT(a) fprintf a
-#else
-# define DEBUG_SELECT(a) do { } while(0)
-#endif
-
-/* Fixme: implement the following stuff to make the code MT safe.
- * To avoid the need to link against a specific threads lib, such
- * an implementation should require the caller to register a function
- * which does this task.
- * enter_crit() and leave_crit() are used to embrace an area of code
- * which should be executed only by one thread at a time.
- * lock_xxxx() and unlock_xxxx()  protect access to an data object.
- *  */
-#define enter_crit()    do { } while (0)
-#define leave_crit()    do { } while (0)
-#define lock_queue()    do { } while (0)
-#define unlock_queue()  do { } while (0)
-
-struct wait_queue_item_s {
-    struct wait_queue_item_s *next;
-    volatile int used; 
-    volatile int active;
-    int (*handler)(void*,pid_t,int);
-    void *handler_value;
-    pid_t pid;
-    int   fd;  
-    int   inbound;       /* this is an inbound data handler fd */
-
-    int exited;
-    int exit_status;  
-    int exit_signal;
-
-    GpgmeCtx ctx;
-};
-
-
-static struct wait_queue_item_s wait_queue[SIZEOF_WAIT_QUEUE];
-
-static int the_big_select ( void );
-
-
-static void
-init_wait_queue (void)
+#include "sema.h"
+#include "priv-io.h"
+#include "engine.h"
+#include "debug.h"
+
+\f
+void
+_gpgme_fd_table_init (fd_table_t fdt)
 {
-    int i;
-    static int initialized = 0;
-
-    if ( initialized )  /* FIXME: This leads to a race */
-        return;
-
-    lock_queue ();
-    for (i=1; i < SIZEOF_WAIT_QUEUE; i++ )
-        wait_queue[i-1].next = &wait_queue[i];
-    initialized = 1;
-    unlock_queue();
+  fdt->fds = NULL;
+  fdt->size = 0;
 }
 
-static struct wait_queue_item_s *
-queue_item_from_context ( GpgmeCtx ctx )
+void
+_gpgme_fd_table_deinit (fd_table_t fdt)
 {
-    struct wait_queue_item_s *q;
-
-    for (q=wait_queue; q; q = q->next) {
-        if ( q->used && q->ctx == ctx )
-            return q;
-    }
-    return NULL;
+  if (fdt->fds)
+    free (fdt->fds);
 }
 
 
-static void
-propagate_term_results ( const struct wait_queue_item_s *first_q )
+/* XXX We should keep a marker and roll over for speed.  */
+static gpgme_error_t
+fd_table_put (fd_table_t fdt, int fd, int dir, void *opaque, int *idx)
 {
-    struct wait_queue_item_s *q;
-    
-    for (q=wait_queue; q; q = q->next) {
-        if ( q->used && q != first_q && !q->exited
-             && q->pid == first_q->pid  ) {
-            q->exited = first_q->exited;
-            q->exit_status = first_q->exit_status;
-            q->exit_signal = first_q->exit_signal;
-        }
-    }
-}
+  unsigned int i, j;
+  struct io_select_fd_s *new_fds;
 
-static int
-count_active_fds ( pid_t pid )
-{
-    struct wait_queue_item_s *q;
-    int count = 0;
-    
-    for (q=wait_queue; q; q = q->next) {
-        if ( q->used && q->active && q->pid == pid  ) 
-            count++;
+  for (i = 0; i < fdt->size; i++)
+    {
+      if (fdt->fds[i].fd == -1)
+       break;
     }
-    return count;
-}
-
-
-/* remove the given process from the queue */
-static void
-remove_process ( pid_t pid )
-{
-    struct wait_queue_item_s *q;
-    
-    for (q=wait_queue; q; q = q->next) {
-        if ( q->used ) {
-            close (q->fd);
-            q->handler = NULL;
-            q->ctx = NULL;
-            q->used = 0;
-        }
+  if (i == fdt->size)
+    {
+#define FDT_ALLOCSIZE 10
+      new_fds = realloc (fdt->fds, (fdt->size + FDT_ALLOCSIZE)
+                        * sizeof (*new_fds));
+      if (!new_fds)
+       return gpg_error_from_errno (errno);
+      
+      fdt->fds = new_fds;
+      fdt->size += FDT_ALLOCSIZE;
+      for (j = 0; j < FDT_ALLOCSIZE; j++)
+       fdt->fds[i + j].fd = -1;
     }
-}
 
-
-
-/**
- * gpgme_wait:
- * @c: 
- * @hang: 
- * 
- * Wait for a finished request, if @c is given the function does only
- * wait on a finsihed request for that context, otherwise it will return
- * on any request.  When @hang is true the function will wait, otherwise
- * it will return immediately when there is no pending finished request.
- * 
- * Return value: Context of the finished request or NULL if @hang is false
- *  and no (or the given) request has finished.
- **/
-GpgmeCtx 
-gpgme_wait ( GpgmeCtx c, int hang ) 
-{
-    return _gpgme_wait_on_condition ( c, hang, NULL );
+  fdt->fds[i].fd = fd;
+  fdt->fds[i].for_read = (dir == 1);
+  fdt->fds[i].for_write = (dir == 0);
+  fdt->fds[i].frozen = 0;
+  fdt->fds[i].signaled = 0;
+  fdt->fds[i].opaque = opaque;
+  *idx = i;
+  return 0;
 }
 
-GpgmeCtx 
-_gpgme_wait_on_condition ( GpgmeCtx c, int hang, volatile int *cond )
+\f
+/* Register the file descriptor FD with the handler FNC (which gets
+   FNC_DATA as its first argument) for the direction DIR.  DATA should
+   be the context for which the fd is added.  R_TAG will hold the tag
+   that can be used to remove the fd.  */
+gpgme_error_t
+_gpgme_add_io_cb (void *data, int fd, int dir, gpgme_io_cb_t fnc,
+                 void *fnc_data, void **r_tag)
 {
-    struct wait_queue_item_s *q;
-
-    init_wait_queue ();
-    do {
-        int did_work = the_big_select();
-
-        if ( cond && *cond )
-            hang = 0;
-
-        if ( !did_work ) {
-            int status;
-
-            /* We did no read/write - see whether this process is still
-             * alive */
-            assert (c); /* !c is not yet implemented */
-            q = queue_item_from_context ( c );
-            assert (q);
-            
-            if (q->exited)
-                ;
-            else if ( waitpid ( q->pid, &status, WNOHANG ) == q->pid ) {
-                q->exited = 1;     
-                if ( WIFSIGNALED (status) ) {
-                    q->exit_status = 4; /* Need some value here */
-                    q->exit_signal = WTERMSIG (status);
-                }
-                else if ( WIFEXITED (status) ) {
-                    q->exit_status = WEXITSTATUS (status);
-                }
-                else {
-                    q->exited++;
-                    q->exit_status = 4;
-                }
-                propagate_term_results (q);
-            }
-
-            if ( q->exited ) {
-                if ( !count_active_fds (q->pid) ) {
-                    /* Hmmm, as long as we don't have a callback for
-                     * the exit status, we have no use for these
-                     * values and therefore we can remove this from
-                     * the queue */
-                    remove_process (q->pid);
-                    hang = 0;
-                }
-            }
-        }
-    } while (hang);
-    return c;
-}
-
-
-
-/*
- * We use this function to do the select stuff for all running
- * gpgs.  A future version might provide a facility to delegate
- * those selects to the GDK select stuff.
- * This function must be called only by one thread!!
- * FIXME: The data structures and  algorithms are stupid.
- * Returns: 0 = nothing to run
- *          1 = did run something 
- */
-
-static int
-the_big_select ( void )
-{
-    static fd_set readfds;
-    static fd_set writefds;
-    struct wait_queue_item_s *q;
-    int max_fd, n;
-    struct timeval timeout = { 1, 0 }; /* Use a one second timeout */
-    
-    FD_ZERO ( &readfds );
-    FD_ZERO ( &writefds );
-    max_fd = 0;
-
-    
-    DEBUG_SELECT ((stderr, "gpgme:select on [ "));
-    lock_queue ();
-    for ( q = wait_queue; q; q = q->next ) {
-        if ( q->used && q->active ) {
-            if (q->inbound) {
-                assert ( !FD_ISSET ( q->fd, &readfds ) );
-                FD_SET ( q->fd, &readfds );
-                DEBUG_SELECT ((stderr, "r%d ", q->fd ));
-            }
-            else {
-                assert ( !FD_ISSET ( q->fd, &writefds ) );
-                FD_SET ( q->fd, &writefds );
-                DEBUG_SELECT ((stderr, "w%d ", q->fd ));
-            }
-            if ( q->fd > max_fd )
-                max_fd = q->fd;
-          }
+  gpgme_error_t err;
+  gpgme_ctx_t ctx = (gpgme_ctx_t) data;
+  fd_table_t fdt;
+  struct wait_item_s *item;
+  struct tag *tag;
+
+  assert (fnc);
+  assert (ctx);
+
+  fdt = &ctx->fdt;
+  assert (fdt);
+
+  tag = malloc (sizeof *tag);
+  if (!tag)
+    return gpg_error_from_errno (errno);
+  tag->ctx = ctx;
+
+  /* Allocate a structure to hold information about the handler.  */
+  item = calloc (1, sizeof *item);
+  if (!item)
+    {
+      int saved_errno = errno;
+      free (tag);
+      return gpg_error_from_errno (saved_errno);
     }
-    unlock_queue ();
-    DEBUG_SELECT ((stderr, "]\n" ));
-
-    n = select ( max_fd+1, &readfds, &writefds, NULL, &timeout );
-    if ( n <= 0 ) {
-        if ( n && errno != EINTR ) {
-            fprintf (stderr, "the_big_select: select failed: %s\n",
-                     strerror (errno) );
-        }
-        return 0;
+  item->ctx = ctx;
+  item->dir = dir;
+  item->handler = fnc;
+  item->handler_value = fnc_data;
+
+  err = fd_table_put (fdt, fd, dir, item, &tag->idx);
+  if (err)
+    {
+      free (tag);
+      free (item);
+      return err;
     }
 
-#if DEBUG_SELECT_ENABLED
-    { 
-        int i;
-
-        fprintf (stderr, "gpgme:select OK [ " );
-        for (i=0; i <= max_fd; i++ ) {
-            if (FD_ISSET (i, &readfds) )
-                fprintf (stderr, "r%d ", i );
-            if (FD_ISSET (i, &writefds) )
-                fprintf (stderr, "w%d ", i );
-        }
-        fprintf (stderr, "]\n" );
-    }
-#endif
-
-    /* something has to be done.  Go over the queue and call
-     * the handlers */
- restart:
-    while ( n ) {
-        lock_queue ();
-        for ( q = wait_queue; q; q = q->next ) {
-            if ( q->used && q->active && q->inbound 
-                 && FD_ISSET (q->fd, &readfds ) ) {
-                FD_CLR (q->fd, &readfds );
-                assert (n);
-                n--;
-                unlock_queue ();
-                if ( q->handler (q->handler_value, q->pid, q->fd ) )
-                    q->active = 0;
-                goto restart;
-            }
-            if ( q->used && q->active && !q->inbound
-                 && FD_ISSET (q->fd, &writefds ) ) {
-                FD_CLR (q->fd, &writefds );
-                assert (n);
-                n--;
-                unlock_queue ();
-                if ( q->handler (q->handler_value, q->pid, q->fd ) )
-                    q->active = 0;
-                goto restart;
-            }
-        }
-        unlock_queue ();
-    }
-    return 1;
+  *r_tag = tag;
+  return 0;
 }
 
 
-
-/* 
- * called by rungpg.c to register something for select()
- */
-GpgmeError
-_gpgme_register_pipe_handler( void *opaque, 
-                              int (*handler)(void*,pid_t,int),
-                              void *handler_value,
-                              pid_t pid, int fd, int inbound )
+void
+_gpgme_remove_io_cb (void *data)
 {
-    GpgmeCtx ctx = opaque;
-    struct wait_queue_item_s *q;
+  struct tag *tag = data;
+  gpgme_ctx_t ctx;
+  fd_table_t fdt;
+  int idx;
+
+  assert (tag);
+  ctx = tag->ctx;
+  assert (ctx);
+  fdt = &ctx->fdt;
+  assert (fdt);
+  idx = tag->idx;
+
+  DEBUG2 ("setting fd %d (item=%p) done", fdt->fds[idx].fd,
+         fdt->fds[idx].opaque);
+  free (fdt->fds[idx].opaque);
+  free (tag);
+
+  /* Free the table entry.  */
+  fdt->fds[idx].fd = -1;
+  fdt->fds[idx].for_read = 0;
+  fdt->fds[idx].for_write = 0;
+  fdt->fds[idx].opaque = NULL;
+}
 
-    init_wait_queue();
-    assert (opaque);
-    assert (handler);
-    
-    lock_queue ();
-    for ( q = wait_queue; q; q = q->next ) {
-        if ( !q->used ) {
-            q->used = 1;
-            q->active = 0;
-            break;
-        }
+\f
+/* This is slightly embarrassing.  The problem is that running an I/O
+   callback _may_ influence the status of other file descriptors.  Our
+   own event loops could compensate for that, but the external event
+   loops cannot.  FIXME: We may still want to optimize this a bit when
+   we are called from our own event loops.  So if CHECKED is 1, the
+   check is skipped.  */
+gpgme_error_t
+_gpgme_run_io_cb (struct io_select_fd_s *an_fds, int checked)
+{
+  struct wait_item_s *item;
+  item = (struct wait_item_s *) an_fds->opaque;
+  assert (item);
+
+  if (!checked)
+    {
+      int nr;
+      struct io_select_fd_s fds;
+
+      fds = *an_fds;
+      fds.signaled = 0;
+      /* Just give it a quick poll.  */
+      nr = _gpgme_io_select (&fds, 1, 1);
+      assert (nr <= 1);
+      if (nr < 0)
+       return errno;
+      else if (nr == 0)
+       /* The status changed in the meantime, there is nothing left
+          to do.  */
+       return 0;
     }
-    unlock_queue ();
-    if ( !q ) 
-        return mk_error (Too_Many_Procs);
 
-    q->fd = fd;
-    q->inbound = inbound;
-    q->handler = handler;
-    q->handler_value = handler_value;
-    q->pid = pid;
-    q->ctx = ctx;
-    
-    /* and enable this entry for the next select */
-    q->exited = 0;
-    q->active = 1;
-    return 0;
+  return item->handler (item->handler_value, an_fds->fd);
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-