2002-06-14 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / wait.c
index a830c2d..6c99d3e 100644 (file)
@@ -1,6 +1,6 @@
 /* wait.c 
  *     Copyright (C) 2000 Werner Koch (dd9jn)
- *      Copyright (C) 2001 g10 Code GmbH
+ *      Copyright (C) 2001, 2002 g10 Code GmbH
  *
  * This file is part of GPGME.
  *
@@ -26,7 +26,6 @@
 #include <assert.h>
 #include <errno.h>
 #include <sys/types.h>
-#include "syshdr.h"
 
 #include "util.h"
 #include "context.h"
 #include "io.h"
 #include "engine.h"
 
-struct wait_item_s;
-struct proc_s;
+struct fd_table fdt_global;
 
-static struct proc_s *proc_queue;
-DEFINE_STATIC_LOCK (proc_queue_lock);
+static GpgmeCtx *ctx_done_list;
+static int ctx_done_list_size;
+static int ctx_done_list_length;
+DEFINE_STATIC_LOCK (ctx_done_list_lock);
 
-static int fd_table_size;
-static struct io_select_fd_s *fd_table;
-DEFINE_STATIC_LOCK (fd_table_lock);
+static GpgmeIdleFunc idle_function;
 
-static void (*idle_function) (void);
-
-
-struct proc_s {
-    struct proc_s *next;
-    int pid;
-    GpgmeCtx ctx;
-    struct wait_item_s *handler_list;
-    int ready;
+struct wait_item_s
+{
+  struct wait_item_s *next;
+  GpgmeIOCb handler;
+  void *handler_value;
+  int dir;
 };
 
-struct wait_item_s {
-    struct wait_item_s *next;
-    int (*handler)(void*,int,int);
-    void *handler_value;
-    int inbound;       /* this is an inbound data handler fd */
-    struct proc_s *proc; /* backlink */
-    int ready;
-    int frozen; /* copy of the frozen flag from the fd_table */
-};
+static void run_idle (void);
 
+\f
+void
+_gpgme_fd_table_init (fd_table_t fdt)
+{
+  INIT_LOCK (fdt->lock);
+  fdt->fds = NULL;
+  fdt->size = 0;
+}
 
+void
+_gpgme_fd_table_deinit (fd_table_t fdt)
+{
+  DESTROY_LOCK (fdt->lock);
+  if (fdt->fds)
+    xfree (fdt->fds);
+}
 
-static int do_select ( void );
-static void run_idle (void);
+/* XXX We should keep a marker and roll over for speed.  */
+GpgmeError
+_gpgme_fd_table_put (fd_table_t fdt, int fd, int dir, void *opaque, int *idx)
+{
+  int i, j;
+  struct io_select_fd_s *new_fds;
+
+  LOCK (fdt->lock);
+  for (i = 0; i < fdt->size; i++)
+    {
+      if (fdt->fds[i].fd == -1)
+       break;
+    }
+  if (i == fdt->size)
+    {
+#define FDT_ALLOCSIZE 10
+      new_fds = xtryrealloc (fdt->fds, (fdt->size + FDT_ALLOCSIZE)
+                            * sizeof (*new_fds));
+      if (!new_fds)
+       {
+         UNLOCK (fdt->lock);
+         return mk_error (Out_Of_Core);
+       }
+      
+      fdt->fds = new_fds;
+      fdt->size += FDT_ALLOCSIZE;
+      for (j = 0; j < FDT_ALLOCSIZE; j++)
+       fdt->fds[i + j].fd = -1;
+    }
 
+  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;
+  UNLOCK (fdt->lock);
+  *idx = i;
+  return 0;
+}
 
-/* only to be called with a locked proc_queue */
-static int
-count_running_fds ( struct proc_s *proc )
+\f
+/**
+ * gpgme_register_idle:
+ * @fnc: Callers idle function
+ * 
+ * Register a function with GPGME called by GPGME whenever it feels
+ * that is is idle.  NULL may be used to remove this function.
+ *
+ * Return value: The idle function pointer that was passed to the
+ * function at the last time it was invoked, or NULL if the function
+ * is invoked the first time.
+ **/
+GpgmeIdleFunc
+gpgme_register_idle (GpgmeIdleFunc idle)
 {
-    struct wait_item_s *q;
-    int count = 0;
+  GpgmeIdleFunc old_idle = idle_function;
 
-    for (q=proc->handler_list; q; q=q->next) {
-        if ( !q->frozen && !q->ready )
-            count++;
-    }
-    return count;
+  idle_function = idle;
+  return old_idle;
 }
 
-/* only to be called with a locked proc_queue */
 static void
-set_process_ready ( struct proc_s *proc )
+run_idle ()
+{
+  _gpgme_engine_housecleaning ();
+  if (idle_function)
+    idle_function ();
+}
+
+\f
+/* Wait on all file descriptors listed in FDT and process them using
+   the registered callbacks.  Returns -1 on error (with errno set), 0
+   if nothing to run and 1 if it did run something.  */
+static int
+do_select (fd_table_t fdt)
 {
-    struct wait_item_s *q, *q2;
-    int i;
-
-    assert (proc);
-    DEBUG2 ("set_process_ready(%p) pid=%d", proc, proc->pid );
-    LOCK (fd_table_lock);
-    for (q = proc->handler_list; q; q=q2) {
-        q2 = q->next;
-        for (i=0; i < fd_table_size; i++ ) {
-            if (fd_table[i].fd != -1 && q == fd_table[i].opaque ) {
-                fd_table[i].opaque = NULL;
-                fd_table[i].fd = -1;
-            }
+  int i, n;
+  int any = 0;
+
+  LOCK (fdt->lock);
+  n = _gpgme_io_select (fdt->fds, fdt->size);
+
+  if (n <= 0) 
+    {
+      UNLOCK (fdt->lock);
+      return n;        /* Error or timeout.  */
+    }
+
+  for (i = 0; i < fdt->size && n; i++)
+    {
+      if (fdt->fds[i].fd != -1 && fdt->fds[i].signaled)
+       {
+         struct wait_item_s *item;
+
+         assert (n);
+         n--;
+            
+         item = (struct wait_item_s *) fdt->fds[i].opaque;
+         assert (item);
+         any = 1;
+
+         fdt->fds[i].signaled = 0;
+         UNLOCK (fdt->lock);
+         item->handler (item->handler_value, fdt->fds[i].fd);
+         LOCK (fdt->lock);
         }
-        xfree (q);
     }
-    UNLOCK (fd_table_lock);
-    proc->handler_list = NULL;
-    proc->ready = 1;
+  UNLOCK (fdt->lock);
+    
+  return any;
 }
 
+
+\f
 void
-_gpgme_remove_proc_from_wait_queue ( int pid )
+_gpgme_wait_event_cb (void *data, GpgmeEventIO type, void *type_data)
 {
-    struct proc_s *proc, *last;
-
-    DEBUG1 ("removing process %d", pid );
-    LOCK (proc_queue_lock);
-    for (last=NULL, proc=proc_queue; proc; last = proc, proc = proc->next ) {
-        if (proc->pid == pid ) {
-            set_process_ready (proc);
-            if (!last) 
-                proc_queue = proc->next;
-            else 
-                last->next = proc->next;
-            xfree (proc);
-            break;
-        }
+  if (type != GPGME_EVENT_DONE)
+    return;
+
+  if (ctx_done_list_size == ctx_done_list_length)
+    {
+#define CTX_DONE_LIST_SIZE_INITIAL 8
+      int new_size = ctx_done_list_size ? 2 * ctx_done_list_size
+       : CTX_DONE_LIST_SIZE_INITIAL;
+      GpgmeCtx *new_list = xtryrealloc (ctx_done_list,
+                                       new_size * sizeof (GpgmeCtx *));
+      assert (new_list);
+#if 0
+      if (!new_list)
+       return mk_error (Out_Of_Core);
+#endif
+      ctx_done_list = new_list;
+      ctx_done_list_size = new_size;
     }
-    UNLOCK (proc_queue_lock);
+  ctx_done_list[ctx_done_list_length++] = (GpgmeCtx) data;
 }
 
 
@@ -145,245 +222,173 @@ _gpgme_remove_proc_from_wait_queue ( int pid )
  * 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.
+ *  and no (or not the given) request has finished.
  **/
 GpgmeCtx 
-gpgme_wait ( GpgmeCtx c, int hang ) 
+gpgme_wait (GpgmeCtx ctx, GpgmeError *status, int hang)
 {
-    return _gpgme_wait_on_condition ( c, hang, NULL );
+  ctx = _gpgme_wait_on_condition (ctx, hang, NULL);
+  if (ctx && status)
+    *status = ctx->error;
+  return ctx;
 }
 
-GpgmeCtx 
-_gpgme_wait_on_condition ( GpgmeCtx c, int hang, volatile int *cond )
-{
-    DEBUG3 ("waiting... ctx=%p hang=%d cond=%p", c, hang, cond );
-    do {
-        int any = 0;
-        struct proc_s *proc;
-
-        do_select();
-
-        if ( cond && *cond )
-            hang = 0;
-        else {
-            LOCK (proc_queue_lock);
-            for (proc=proc_queue; proc; proc = proc->next ) {
-                if ( !proc->ready && !count_running_fds (proc) ) {
-                    set_process_ready (proc);
-                }
-                if (c && proc->ready && proc->ctx == c)
-                    hang = 0;
-                if ( !proc->ready )
-                    any = 1;
-            }
-            UNLOCK (proc_queue_lock);
-            if (!any)
-                hang = 0;
-        }
-        /* fixme: we should check here for hanging processes */
-
-        if (hang)
-            run_idle ();
-    } while (hang && !c->cancel );
-    c->cancel = 0; /* fixme: fix all functions, to return a cancel error */
-    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!!
- * Returns: 0 = nothing to run
- *          1 = did run something 
- */
-
-static int
-do_select ( void )
+GpgmeError
+_gpgme_wait_one (GpgmeCtx ctx)
 {
-    int i, n;
-    int any=0;
-    
-    n = _gpgme_io_select ( fd_table, fd_table_size );
-    if ( n <= 0 ) 
-        return 0; /* error or timeout */
-
-    for (i=0; i < fd_table_size && n; i++ ) {
-        if ( fd_table[i].fd != -1 && fd_table[i].signaled 
-             && !fd_table[i].frozen ) {
-            struct wait_item_s *q;
-
-            assert (n);
-            n--;
-            
-            q = fd_table[i].opaque;
-            assert ( q );
-            assert ( q->proc );
-            assert ( !q->ready );
-            any = 1;
-            if ( q->handler (q->handler_value,
-                             q->proc->pid, fd_table[i].fd ) ) {
-                DEBUG2 ("setting fd %d (q=%p) ready", fd_table[i].fd, q );
-                q->ready = 1;
-                /* free the table entry*/
-                LOCK (fd_table_lock);
-                fd_table[i].for_read = 0;
-                fd_table[i].for_write = 0;
-                fd_table[i].fd = -1;
-                fd_table[i].opaque = NULL;
-                UNLOCK (fd_table_lock);
-            }
-        }
+  GpgmeError err = 0;
+  int hang = 1;
+  DEBUG1 ("waiting... ctx=%p", ctx);
+  do
+    {
+      if (do_select (&ctx->fdt) < 0)
+       {
+         err = mk_error (File_Error);
+         hang = 0;
+       }
+      else
+       {
+         int any = 0;
+         int i;
+
+         LOCK (ctx->fdt.lock);
+         for (i = 0; i < ctx->fdt.size; i++)
+           {
+             if (ctx->fdt.fds[i].fd != -1)
+               {
+                 any = 1;
+                 break;
+               }
+           }
+         if (!any)
+           hang = 0;
+         UNLOCK (ctx->fdt.lock);
+       }
     }
-    
-    return any;
+  while (hang && !ctx->cancel);
+  if (!err && ctx->cancel)
+    {
+      /* FIXME: Paranoia?  */
+      ctx->cancel = 0;
+      ctx->pending = 0;
+      ctx->error = mk_error (Canceled);
+    }
+  return err ? err : ctx->error;
 }
 
 
-
-/* 
- * called by rungpg.c to register something for select()
- */
-GpgmeError
-_gpgme_register_pipe_handler ( void *opaque, 
-                              int (*handler)(void*,int,int),
-                              void *handler_value,
-                              int pid, int fd, int inbound )
+GpgmeCtx 
+_gpgme_wait_on_condition (GpgmeCtx ctx, int hang, volatile int *cond)
 {
-    GpgmeCtx ctx = opaque;
-    struct wait_item_s *q;
-    struct proc_s *proc;
-    int i;
-
-    assert (opaque);
-    assert (handler);
-
-    /* Allocate a structure to hold info about the handler */
-    q = xtrycalloc ( 1, sizeof *q );
-    if ( !q )
-        return mk_error (Out_Of_Core);
-    q->inbound = inbound;
-    q->handler = handler;
-    q->handler_value = handler_value;
-
-    /* Put this into the process queue */
-    LOCK (proc_queue_lock);
-    for (proc=proc_queue; proc && proc->pid != pid; proc = proc->next)
-        ;
-    if (!proc) { /* a new process */
-        proc = xtrycalloc ( 1, sizeof *proc );
-        if (!proc) {
-            UNLOCK (proc_queue_lock);
-            return mk_error (Out_Of_Core);
+  DEBUG3 ("waiting... ctx=%p hang=%d cond=%p", ctx, hang, cond);
+  do
+    {
+      /* XXX We are ignoring all errors from select here.  */
+      do_select (&fdt_global);
+      
+      if (cond && *cond)
+       hang = 0;
+      else
+       {
+         int i;
+
+         LOCK (ctx_done_list_lock);
+         /* A process that is done is eligible for election if it is
+            the requested context or if it was not yet reported.  */
+         for (i = 0; i < ctx_done_list_length; i++)
+           if (!ctx || ctx == ctx_done_list[i])
+             break;
+         if (i < ctx_done_list_length)
+           {
+             if (!ctx)
+               ctx = ctx_done_list[i];
+             hang = 0;
+             ctx->pending = 0;
+             if (--ctx_done_list_length)
+               memcpy (&ctx_done_list[i],
+                       &ctx_done_list[i + 1],
+                       (ctx_done_list_length - i) * sizeof (GpgmeCtx *));
+           }
+         UNLOCK (ctx_done_list_lock);
         }
-        proc->pid = pid;
-        proc->ctx = ctx;
-        proc->next = proc_queue;
-        proc_queue = proc;
+      if (hang)
+       run_idle ();
     }
-    assert (proc->ctx == ctx);
-    q->proc = proc;
-    q->next = proc->handler_list;
-    proc->handler_list = q;
-    UNLOCK (proc_queue_lock);
-    
-    LOCK (fd_table_lock);
- again:  
-    for (i=0; i < fd_table_size; i++ ) {
-        if ( fd_table[i].fd == -1 ) {
-            fd_table[i].fd = fd;
-            fd_table[i].for_read = inbound;    
-            fd_table[i].for_write = !inbound;    
-            fd_table[i].signaled = 0;
-            fd_table[i].frozen = 0;
-            fd_table[i].opaque = q;
-            UNLOCK (fd_table_lock);
-            return 0;
-        }
-    }
-    if ( fd_table_size < 50 ) {
-        /* FIXME: We have to wait until there are no other readers of the 
-         * table, i.e that the io_select is not active in another thread */
-        struct io_select_fd_s *tmp;
-
-        tmp = xtryrealloc ( fd_table, (fd_table_size + 10) * sizeof *tmp );
-        if ( tmp ) {
-            for (i=0; i < 10; i++ )
-                tmp[fd_table_size+i].fd = -1;
-            fd_table_size += i;
-            fd_table = tmp;
-            goto again;
-        }
+  while (hang && (!ctx || !ctx->cancel));
+  if (ctx && ctx->cancel)
+    {
+      /* FIXME: Paranoia?  */
+      ctx->cancel = 0;
+      ctx->pending = 0;
+      ctx->error = mk_error (Canceled);
     }
-
-    UNLOCK (fd_table_lock);
-    xfree (q);
-    /* FIXME: remove the proc table entry */
-    return mk_error (Too_Many_Procs);
+  return ctx;
 }
 
-
-void
-_gpgme_freeze_fd ( int fd )
+\f
+struct tag
 {
-    int i;
-
-    LOCK (fd_table_lock);
-    for (i=0; i < fd_table_size; i++ ) {
-        if ( fd_table[i].fd == fd ) {
-            struct wait_item_s *q;
-
-            fd_table[i].frozen = 1;
-            if ( (q=fd_table[i].opaque) )
-                q->frozen = 1;
-            DEBUG2 ("fd %d frozen (q=%p)", fd, q );
-            break;
-        }
-    }
-    UNLOCK (fd_table_lock);
-}
+  fd_table_t fdt;
+  int idx;
+};
 
-void
-_gpgme_thaw_fd ( int fd )
+void *
+_gpgme_add_io_cb (void *data, int fd, int dir,
+                 GpgmeIOCb fnc, void *fnc_data)
 {
-    int i;
-
-    LOCK (fd_table_lock);
-    for (i=0; i < fd_table_size; i++ ) {
-        if ( fd_table[i].fd == fd ) {
-            struct wait_item_s *q;
-
-            fd_table[i].frozen = 0;
-            if ( (q=fd_table[i].opaque) )
-                q->frozen = 0;
-            DEBUG2 ("fd %d thawed (q=%p)", fd, q );
-            break;
-        }
+  GpgmeError err;
+  fd_table_t fdt = (fd_table_t) (data ? data : &fdt_global);
+  struct wait_item_s *item;
+  struct tag *tag;
+
+  assert (fdt);
+  assert (fnc);
+
+  tag = xtrymalloc (sizeof *tag);
+  if (!tag)
+    return NULL;
+  tag->fdt = fdt;
+
+  /* Allocate a structure to hold info about the handler.  */
+  item = xtrycalloc (1, sizeof *item);
+  if (!item)
+    {
+      xfree (tag);
+      return NULL;
+    }
+  item->dir = dir;
+  item->handler = fnc;
+  item->handler_value = fnc_data;
+
+  err = _gpgme_fd_table_put (fdt, fd, dir, item, &tag->idx);
+  if (err)
+    {
+      xfree (tag);
+      xfree (item);
+      errno = ENOMEM;
+      return 0;
     }
-    UNLOCK (fd_table_lock);
+  
+  return tag;
 }
 
-
-/**
- * gpgme_register_idle:
- * @fnc: Callers idle function
- * 
- * Register a function with GPGME called by GPGME whenever it feels
- * that is is idle.  NULL may be used to remove this function.
- **/
 void
-gpgme_register_idle ( void (*fnc)(void) )
+_gpgme_remove_io_cb (void *data)
 {
-    idle_function = fnc;
+  struct tag *tag = data;
+  fd_table_t fdt = tag->fdt;
+  int idx = tag->idx;
+
+  LOCK (fdt->lock);
+  DEBUG2 ("setting fd %d (item=%p) done", fdt->fds[idx].fd,
+         fdt->fds[idx].opaque);
+  xfree (fdt->fds[idx].opaque);
+  xfree (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;
 }
 
-
-static void
-run_idle ()
-{
-  _gpgme_engine_housecleaning ();
-  if (idle_function)
-    idle_function ();
-}