2005-09-12 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / wait.c
index e7ce286..16a9f23 100644 (file)
 /* wait.c 
- *     Copyright (C) 2000 Werner Koch (dd9jn)
- *      Copyright (C) 2001, 2002 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 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/types.h>
-#include "syshdr.h"
 
 #include "util.h"
 #include "context.h"
 #include "ops.h"
 #include "wait.h"
 #include "sema.h"
-#include "io.h"
+#include "priv-io.h"
 #include "engine.h"
+#include "debug.h"
 
-struct wait_item_s;
-struct proc_s;
-
-static struct proc_s *proc_queue;
-DEFINE_STATIC_LOCK (proc_queue_lock);
-
-static int fd_table_size;
-static struct io_select_fd_s *fd_table;
-DEFINE_STATIC_LOCK (fd_table_lock);
-
-static GpgmeIdleFunc idle_function;
-
-
-struct proc_s
-{
-  struct proc_s *next;
-  int pid;
-  GpgmeCtx ctx;
-  struct wait_item_s *handler_list;
-  /* Non-zero if the process has been completed.  */
-  int done;
-  /* Non-zero if the status for this process has been returned
-     already.  */
-  int reported;
-};
-
-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 done;
-    int frozen; /* copy of the frozen flag from the fd_table */
-};
-
-
-
-static int do_select ( void );
-static void run_idle (void);
-
-
-/* only to be called with a locked proc_queue */
-static int
-count_running_fds (struct proc_s *proc)
-{
-  struct wait_item_s *q;
-  int count = 0;
-
-  for (q = proc->handler_list; q; q=q->next)
-    {
-      if (!q->frozen && !q->done)
-       count++;
-    }
-  return count;
-}
-
-/* only to be called with a locked proc_queue */
-static void
-set_process_done (struct proc_s *proc)
+\f
+void
+_gpgme_fd_table_init (fd_table_t fdt)
 {
-  struct wait_item_s *q, *q2;
-  int i;
-
-  assert (proc);
-  DEBUG2 ("set_process_done(%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;
-            }
-        }
-      xfree (q);
-    }
-  UNLOCK (fd_table_lock);
-  proc->handler_list = NULL;
-  proc->done = 1;
+  fdt->fds = NULL;
+  fdt->size = 0;
 }
 
 void
-_gpgme_remove_proc_from_wait_queue (int pid)
+_gpgme_fd_table_deinit (fd_table_t fdt)
 {
-    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_done (proc);
-            if (!last) 
-             proc_queue = proc->next;
-            else 
-             last->next = proc->next;
-            xfree (proc);
-            break;
-         }
-      }
-    UNLOCK (proc_queue_lock);
+  if (fdt->fds)
+    free (fdt->fds);
 }
 
 
-/**
- * gpgme_wait:
- * @c: 
- * @hang: 
- * 
- * Wait for a finished request, if @c is given the function does only
- * wait on a finished 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 ctx, GpgmeError *status, int hang)
+/* 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)
 {
-  GpgmeCtx retctx = _gpgme_wait_on_condition (ctx, hang, NULL);
-  if (status)
-    *status = retctx->error;
-  return retctx;
-}
+  unsigned int i, j;
+  struct io_select_fd_s *new_fds;
 
-GpgmeCtx 
-_gpgme_wait_on_condition (GpgmeCtx ctx, int hang, volatile int *cond)
-{
-  DEBUG3 ("waiting... ctx=%p hang=%d cond=%p", ctx, hang, cond);
-  do
+  for (i = 0; i < fdt->size; i++)
     {
-      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)
-           {
-             /* A process is done if it has completed voluntarily, or
-                if the context it lived in was canceled.  */
-             if (!proc->done && !count_running_fds (proc))
-               set_process_done (proc);
-             else if (!proc->done && proc->ctx->cancel)
-               {
-                 set_process_done (proc);
-                 proc->ctx->cancel = 0;
-                 proc->ctx->error = mk_error (Canceled);
-               }
-             /* A process that is done is eligible for election if it
-                is in the requested context or if it was not yet
-                reported.  */
-             if (proc->done && (proc->ctx == ctx || (!ctx && !proc->reported)))
-               {
-                 if (!ctx)
-                   ctx = proc->ctx;
-                 hang = 0;
-                 ctx->pending = 0;
-                 proc->reported = 1;
-               }
-             if (!proc->done)
-               any = 1;
-            }
-         UNLOCK (proc_queue_lock);
-         if (!any)
-           hang = 0;
-        }
-      /* fixme: We should check here for hanging processes.  */
-
-      if (hang)
-       run_idle ();
+      if (fdt->fds[i].fd == -1)
+       break;
     }
-  while (hang && (!ctx || !ctx->cancel));
-  if (ctx && ctx->cancel)
+  if (i == fdt->size)
     {
-      /* FIXME: Paranoia?  */
-      ctx->cancel = 0;
-      ctx->pending = 0;
-      ctx->error = mk_error (Canceled);
+#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;
     }
-  return ctx;
-}
-
-
-/*
- * 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)
-{
-  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->done);
-         any = 1;
-         if (q->handler (q->handler_value,
-                         q->proc->pid, fd_table[i].fd))
-           {
-             DEBUG2 ("setting fd %d (q=%p) done", fd_table[i].fd, q);
-             q->done = 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);
-            }
-        }
-    }
-    
-  return any;
+  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;
 }
 
-
-/* 
- * 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)
+\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)
 {
-  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)
+  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)
     {
-      /* A new process.  */
-      proc = xtrycalloc (1, sizeof *proc);
-      if (!proc)
-       {
-         UNLOCK (proc_queue_lock);
-         return mk_error (Out_Of_Core);
-        }
-      proc->pid = pid;
-      proc->ctx = ctx;
-      proc->next = proc_queue;
-      proc_queue = proc;
+      int saved_errno = errno;
+      free (tag);
+      return gpg_error_from_errno (saved_errno);
     }
-  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++)
+  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)
     {
-      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;
-        }
+      free (tag);
+      free (item);
+      return err;
     }
-  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;
-      }
-  }
 
-  UNLOCK (fd_table_lock);
-  xfree (q);
-  /* FIXME: Remove the proc table entry.  */
-  return mk_error (Too_Many_Procs);
+  *r_tag = tag;
+  return 0;
 }
 
 
 void
-_gpgme_freeze_fd (int fd)
+_gpgme_remove_io_cb (void *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 = 1;
-         q = fd_table[i].opaque;
-         if (q)
-           q->frozen = 1;
-         DEBUG2 ("fd %d frozen (q=%p)", fd, q);
-         break;
-        }
-    }
-  UNLOCK (fd_table_lock);
+  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;
 }
 
-void
-_gpgme_thaw_fd (int fd)
+\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)
 {
-  int i;
+  struct wait_item_s *item;
+  item = (struct wait_item_s *) an_fds->opaque;
+  assert (item);
 
-  LOCK (fd_table_lock);
-  for (i = 0; i < fd_table_size; i++)
+  if (!checked)
     {
-      if (fd_table[i].fd == fd)
-       {
-         struct wait_item_s *q;
-
-         fd_table[i].frozen = 0;
-         q = fd_table[i].opaque;
-         if (q)
-           q->frozen = 0;
-         DEBUG2 ("fd %d thawed (q=%p)", fd, q);
-         break;
-        }
+      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 (fd_table_lock);
-}
 
-
-/**
- * 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)
-{
-  GpgmeIdleFunc old_idle = idle_function;
-
-  idle_function = idle;
-  return old_idle;
-}
-
-
-static void
-run_idle ()
-{
-  _gpgme_engine_housecleaning ();
-  if (idle_function)
-    idle_function ();
+  return item->handler (item->handler_value, an_fds->fd);
 }