Fixed a keylisting bug
[gpgme.git] / gpgme / wait.c
1 /* wait.c 
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *      Copyright (C) 2001 g10 Code GmbH
4  *
5  * This file is part of GPGME.
6  *
7  * GPGME is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GPGME is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <assert.h>
27 #include <errno.h>
28 #include <sys/types.h>
29 #include "syshdr.h"
30
31 #include "util.h"
32 #include "context.h"
33 #include "ops.h"
34 #include "wait.h"
35 #include "sema.h"
36 #include "io.h"
37
38 struct wait_item_s;
39 struct proc_s;
40
41 static struct proc_s *proc_queue;
42 DEFINE_STATIC_LOCK (proc_queue_lock);
43
44 static int fd_table_size;
45 static struct io_select_fd_s *fd_table;
46 DEFINE_STATIC_LOCK (fd_table_lock);
47
48 static void (*idle_function) (void);
49
50
51 struct proc_s {
52     struct proc_s *next;
53     int pid;
54     GpgmeCtx ctx;
55     struct wait_item_s *handler_list;
56     int ready;
57 };
58
59 struct wait_item_s {
60     struct wait_item_s *next;
61     int (*handler)(void*,int,int);
62     void *handler_value;
63     int inbound;       /* this is an inbound data handler fd */
64     struct proc_s *proc; /* backlink */
65     int ready;
66     int frozen; /* copy of the frozen flag from the fd_table */
67 };
68
69
70
71 static int do_select ( void );
72 static void run_idle (void);
73
74
75 /* only to be called with a locked proc_queue */
76 static int
77 count_running_fds ( struct proc_s *proc )
78 {
79     struct wait_item_s *q;
80     int count = 0;
81
82     for (q=proc->handler_list; q; q=q->next) {
83         if ( !q->frozen && !q->ready )
84             count++;
85     }
86     return count;
87 }
88
89 /* only to be called with a locked proc_queue */
90 static void
91 set_process_ready ( struct proc_s *proc )
92 {
93     struct wait_item_s *q, *q2;
94     int i;
95
96     assert (proc);
97     DEBUG2 ("set_process_ready(%p) pid=%d", proc, proc->pid );
98     LOCK (fd_table_lock);
99     for (q = proc->handler_list; q; q=q2) {
100         q2 = q->next;
101         for (i=0; i < fd_table_size; i++ ) {
102             if (fd_table[i].fd != -1 && q == fd_table[i].opaque ) {
103                 fd_table[i].opaque = NULL;
104                 fd_table[i].fd = -1;
105             }
106         }
107         xfree (q);
108     }
109     UNLOCK (fd_table_lock);
110     proc->handler_list = NULL;
111     proc->ready = 1;
112 }
113
114 void
115 _gpgme_remove_proc_from_wait_queue ( int pid )
116 {
117     struct proc_s *proc, *last;
118
119     DEBUG1 ("removing process %d", pid );
120     LOCK (proc_queue_lock);
121     for (last=NULL, proc=proc_queue; proc; last = proc, proc = proc->next ) {
122         if (proc->pid == pid ) {
123             set_process_ready (proc);
124             if (!last) 
125                 proc_queue = proc->next;
126             else 
127                 last->next = proc->next;
128             xfree (proc);
129             break;
130         }
131     }
132     UNLOCK (proc_queue_lock);
133 }
134
135
136 /**
137  * gpgme_wait:
138  * @c: 
139  * @hang: 
140  * 
141  * Wait for a finished request, if @c is given the function does only
142  * wait on a finished request for that context, otherwise it will return
143  * on any request.  When @hang is true the function will wait, otherwise
144  * it will return immediately when there is no pending finished request.
145  * 
146  * Return value: Context of the finished request or NULL if @hang is false
147  *  and no (or the given) request has finished.
148  **/
149 GpgmeCtx 
150 gpgme_wait ( GpgmeCtx c, int hang ) 
151 {
152     return _gpgme_wait_on_condition ( c, hang, NULL );
153 }
154
155 GpgmeCtx 
156 _gpgme_wait_on_condition ( GpgmeCtx c, int hang, volatile int *cond )
157 {
158     DEBUG3 ("waiting... ctx=%p hang=%d cond=%p", c, hang, cond );
159     do {
160         int any = 0;
161         struct proc_s *proc;
162
163         do_select();
164
165         if ( cond && *cond )
166             hang = 0;
167         else {
168             LOCK (proc_queue_lock);
169             for (proc=proc_queue; proc; proc = proc->next ) {
170                 if ( !proc->ready && !count_running_fds (proc) ) {
171                     set_process_ready (proc);
172                 }
173                 if (c && proc->ready && proc->ctx == c)
174                     hang = 0;
175                 if ( !proc->ready )
176                     any = 1;
177             }
178             UNLOCK (proc_queue_lock);
179             if (!any)
180                 hang = 0;
181         }
182         /* fixme: we should check here for hanging processes */
183
184         if (hang)
185             run_idle ();
186     } while (hang && !c->cancel );
187     c->cancel = 0; /* fixme: fix all functions, to return a cancel error */
188     return c;
189 }
190
191
192
193 /*
194  * We use this function to do the select stuff for all running
195  * gpgs.  A future version might provide a facility to delegate
196  * those selects to the GDK select stuff.
197  * This function must be called only by one thread!!
198  * Returns: 0 = nothing to run
199  *          1 = did run something 
200  */
201
202 static int
203 do_select ( void )
204 {
205     int i, n;
206     int any=0;
207     
208     n = _gpgme_io_select ( fd_table, fd_table_size );
209     if ( n <= 0 ) 
210         return 0; /* error or timeout */
211
212     for (i=0; i < fd_table_size && n; i++ ) {
213         if ( fd_table[i].fd != -1 && fd_table[i].signaled 
214              && !fd_table[i].frozen ) {
215             struct wait_item_s *q;
216
217             assert (n);
218             n--;
219             
220             q = fd_table[i].opaque;
221             assert ( q );
222             assert ( q->proc );
223             assert ( !q->ready );
224             any = 1;
225             if ( q->handler (q->handler_value,
226                              q->proc->pid, fd_table[i].fd ) ) {
227                 DEBUG2 ("setting fd %d (q=%p) ready", fd_table[i].fd, q );
228                 q->ready = 1;
229                 /* free the table entry*/
230                 LOCK (fd_table_lock);
231                 fd_table[i].for_read = 0;
232                 fd_table[i].for_write = 0;
233                 fd_table[i].fd = -1;
234                 fd_table[i].opaque = NULL;
235                 UNLOCK (fd_table_lock);
236             }
237         }
238     }
239     
240     return any;
241 }
242
243
244
245 /* 
246  * called by rungpg.c to register something for select()
247  */
248 GpgmeError
249 _gpgme_register_pipe_handler ( void *opaque, 
250                               int (*handler)(void*,int,int),
251                               void *handler_value,
252                               int pid, int fd, int inbound )
253 {
254     GpgmeCtx ctx = opaque;
255     struct wait_item_s *q;
256     struct proc_s *proc;
257     int i;
258
259     assert (opaque);
260     assert (handler);
261
262     /* Allocate a structure to hold info about the handler */
263     q = xtrycalloc ( 1, sizeof *q );
264     if ( !q )
265         return mk_error (Out_Of_Core);
266     q->inbound = inbound;
267     q->handler = handler;
268     q->handler_value = handler_value;
269
270     /* Put this into the process queue */
271     LOCK (proc_queue_lock);
272     for (proc=proc_queue; proc && proc->pid != pid; proc = proc->next)
273         ;
274     if (!proc) { /* a new process */
275         proc = xtrycalloc ( 1, sizeof *proc );
276         if (!proc) {
277             UNLOCK (proc_queue_lock);
278             return mk_error (Out_Of_Core);
279         }
280         proc->pid = pid;
281         proc->ctx = ctx;
282         proc->next = proc_queue;
283         proc_queue = proc;
284     }
285     assert (proc->ctx == ctx);
286     q->proc = proc;
287     q->next = proc->handler_list;
288     proc->handler_list = q;
289     UNLOCK (proc_queue_lock);
290     
291     LOCK (fd_table_lock);
292  again:  
293     for (i=0; i < fd_table_size; i++ ) {
294         if ( fd_table[i].fd == -1 ) {
295             fd_table[i].fd = fd;
296             fd_table[i].for_read = inbound;    
297             fd_table[i].for_write = !inbound;    
298             fd_table[i].signaled = 0;
299             fd_table[i].frozen = 0;
300             fd_table[i].opaque = q;
301             UNLOCK (fd_table_lock);
302             return 0;
303         }
304     }
305     if ( fd_table_size < 50 ) {
306         /* FIXME: We have to wait until there are no other readers of the 
307          * table, i.e that the io_select is not active in another thread */
308         struct io_select_fd_s *tmp;
309
310         tmp = xtryrealloc ( fd_table, (fd_table_size + 10) * sizeof *tmp );
311         if ( tmp ) {
312             for (i=0; i < 10; i++ )
313                 tmp[fd_table_size+i].fd = -1;
314             fd_table_size += i;
315             fd_table = tmp;
316             goto again;
317         }
318     }
319
320     UNLOCK (fd_table_lock);
321     xfree (q);
322     /* FIXME: remove the proc table entry */
323     return mk_error (Too_Many_Procs);
324 }
325
326
327 void
328 _gpgme_freeze_fd ( int fd )
329 {
330     int i;
331
332     LOCK (fd_table_lock);
333     for (i=0; i < fd_table_size; i++ ) {
334         if ( fd_table[i].fd == fd ) {
335             struct wait_item_s *q;
336
337             fd_table[i].frozen = 1;
338             if ( (q=fd_table[i].opaque) )
339                 q->frozen = 1;
340             DEBUG2 ("fd %d frozen (q=%p)", fd, q );
341             break;
342         }
343     }
344     UNLOCK (fd_table_lock);
345 }
346
347 void
348 _gpgme_thaw_fd ( int fd )
349 {
350     int i;
351
352     LOCK (fd_table_lock);
353     for (i=0; i < fd_table_size; i++ ) {
354         if ( fd_table[i].fd == fd ) {
355             struct wait_item_s *q;
356
357             fd_table[i].frozen = 0;
358             if ( (q=fd_table[i].opaque) )
359                 q->frozen = 0;
360             DEBUG2 ("fd %d thawed (q=%p)", fd, q );
361             break;
362         }
363     }
364     UNLOCK (fd_table_lock);
365 }
366
367
368 /**
369  * gpgme_register_idle:
370  * @fnc: Callers idle function
371  * 
372  * Register a function with GPGME called by GPGME whenever it feels
373  * that is is idle.  NULL may be used to remove this function.
374  **/
375 void
376 gpgme_register_idle ( void (*fnc)(void) )
377 {
378     idle_function = fnc;
379 }
380
381
382 static void
383 run_idle ()
384 {
385     _gpgme_gpg_housecleaning ();
386     if (idle_function)
387         idle_function ();
388 }
389