* event-loop.c (toplevel) [!HAVE_POLL] [NO_FD_SET]: Remove unused
[platform/upstream/binutils.git] / gdb / event-loop.c
1 /* Event loop machinery for GDB, the GNU debugger.
2    Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
3    Written by Elena Zannoni <ezannoni@cygnus.com> of Cygnus Solutions.
4
5    This file is part of GDB.
6
7    This program 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    This program 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,
20    Boston, MA 02111-1307, USA. */
21
22 #include "defs.h"
23 #include "top.h"
24 #include "event-loop.h"
25 #include "event-top.h"
26
27 #ifdef HAVE_POLL
28 #if defined (HAVE_POLL_H)
29 #include <poll.h>
30 #elif defined (HAVE_SYS_POLL_H)
31 #include <sys/poll.h>
32 #endif
33 #endif
34
35 #include <sys/types.h>
36 #include "gdb_string.h"
37 #include <errno.h>
38 #include <sys/time.h>
39
40 typedef struct gdb_event gdb_event;
41 typedef void (event_handler_func) (int);
42
43 /* Event for the GDB event system.  Events are queued by calling
44    async_queue_event and serviced later on by gdb_do_one_event. An
45    event can be, for instance, a file descriptor becoming ready to be
46    read. Servicing an event simply means that the procedure PROC will
47    be called.  We have 2 queues, one for file handlers that we listen
48    to in the event loop, and one for the file handlers+events that are
49    ready. The procedure PROC associated with each event is always the
50    same (handle_file_event).  Its duty is to invoke the handler
51    associated with the file descriptor whose state change generated
52    the event, plus doing other cleanups and such. */
53
54 struct gdb_event
55   {
56     event_handler_func *proc;   /* Procedure to call to service this event. */
57     int fd;                     /* File descriptor that is ready. */
58     struct gdb_event *next_event;       /* Next in list of events or NULL. */
59   };
60
61 /* Information about each file descriptor we register with the event
62    loop. */
63
64 typedef struct file_handler
65   {
66     int fd;                     /* File descriptor. */
67     int mask;                   /* Events we want to monitor: POLLIN, etc. */
68     int ready_mask;             /* Events that have been seen since
69                                    the last time. */
70     handler_func *proc;         /* Procedure to call when fd is ready. */
71     gdb_client_data client_data;        /* Argument to pass to proc. */
72     int error;                  /* Was an error detected on this fd? */
73     struct file_handler *next_file;     /* Next registered file descriptor. */
74   }
75 file_handler;
76
77 /* PROC is a function to be invoked when the READY flag is set. This
78    happens when there has been a signal and the corresponding signal
79    handler has 'triggered' this async_signal_handler for
80    execution. The actual work to be done in response to a signal will
81    be carried out by PROC at a later time, within process_event. This
82    provides a deferred execution of signal handlers.
83    Async_init_signals takes care of setting up such an
84    asyn_signal_handler for each interesting signal. */
85 typedef struct async_signal_handler
86   {
87     int ready;                  /* If ready, call this handler from the main event loop, 
88                                    using invoke_async_handler. */
89     struct async_signal_handler *next_handler;  /* Ptr to next handler */
90     sig_handler_func *proc;     /* Function to call to do the work */
91     gdb_client_data client_data;        /* Argument to async_handler_func */
92   }
93 async_signal_handler;
94
95
96 /* Event queue:  
97    - the first event in the queue is the head of the queue. 
98    It will be the next to be serviced.
99    - the last event in the queue 
100
101    Events can be inserted at the front of the queue or at the end of
102    the queue.  Events will be extracted from the queue for processing
103    starting from the head.  Therefore, events inserted at the head of
104    the queue will be processed in a last in first out fashion, while
105    those inserted at the tail of the queue will be processed in a first
106    in first out manner.  All the fields are NULL if the queue is
107    empty. */
108
109 static struct
110   {
111     gdb_event *first_event;     /* First pending event */
112     gdb_event *last_event;      /* Last pending event */
113   }
114 event_queue;
115
116 /* Gdb_notifier is just a list of file descriptors gdb is interested in.
117    These are the input file descriptor, and the target file
118    descriptor. We have two flavors of the notifier, one for platforms
119    that have the POLL function, the other for those that don't, and
120    only support SELECT. Each of the elements in the gdb_notifier list is
121    basically a description of what kind of events gdb is interested
122    in, for each fd. */
123
124 /* As of 1999-04-30 only the input file descriptor is registered with the
125    event loop. */
126
127 /* Do we use poll or select ? */
128 #ifdef HAVE_POLL
129 #define USE_POLL 1
130 #else
131 #define USE_POLL 0
132 #endif /* HAVE_POLL */
133
134 static unsigned char use_poll = USE_POLL;
135
136 static struct
137   {
138     /* Ptr to head of file handler list. */
139     file_handler *first_file_handler;
140
141 #ifdef HAVE_POLL
142     /* Ptr to array of pollfd structures. */
143     struct pollfd *poll_fds;
144
145     /* Timeout in milliseconds for calls to poll(). */
146     int poll_timeout;
147 #endif
148
149     /* Masks to be used in the next call to select.
150        Bits are set in response to calls to create_file_handler. */
151     fd_set check_masks[3];
152
153     /* What file descriptors were found ready by select. */
154     fd_set ready_masks[3];
155
156     /* Number of file descriptors to monitor. (for poll) */
157     /* Number of valid bits (highest fd value + 1). (for select) */
158     int num_fds;
159
160     /* Time structure for calls to select(). */
161     struct timeval select_timeout;
162
163     /* Flag to tell whether the timeout should be used. */
164     int timeout_valid;
165   }
166 gdb_notifier;
167
168 /* Structure associated with a timer. PROC will be executed at the
169    first occasion after WHEN. */
170 struct gdb_timer
171   {
172     struct timeval when;
173     int timer_id;
174     struct gdb_timer *next;
175     timer_handler_func *proc;   /* Function to call to do the work */
176     gdb_client_data client_data;        /* Argument to async_handler_func */
177   }
178 gdb_timer;
179
180 /* List of currently active timers. It is sorted in order of
181    increasing timers. */
182 static struct
183   {
184     /* Pointer to first in timer list. */
185     struct gdb_timer *first_timer;
186
187     /* Id of the last timer created. */
188     int num_timers;
189   }
190 timer_list;
191
192 /* All the async_signal_handlers gdb is interested in are kept onto
193    this list. */
194 static struct
195   {
196     /* Pointer to first in handler list. */
197     async_signal_handler *first_handler;
198
199     /* Pointer to last in handler list. */
200     async_signal_handler *last_handler;
201   }
202 sighandler_list;
203
204 /* Are any of the handlers ready?  Check this variable using
205    check_async_ready. This is used by process_event, to determine
206    whether or not to invoke the invoke_async_signal_handler
207    function. */
208 static int async_handler_ready = 0;
209
210 static void create_file_handler (int fd, int mask, handler_func * proc, gdb_client_data client_data);
211 static void invoke_async_signal_handler (void);
212 static void handle_file_event (int event_file_desc);
213 static int gdb_wait_for_event (void);
214 static int gdb_do_one_event (void *data);
215 static int check_async_ready (void);
216 static void async_queue_event (gdb_event * event_ptr, queue_position position);
217 static gdb_event *create_file_event (int fd);
218 static int process_event (void);
219 static void handle_timer_event (int dummy);
220 static void poll_timers (void);
221 \f
222
223 /* Insert an event object into the gdb event queue at 
224    the specified position.
225    POSITION can be head or tail, with values TAIL, HEAD.
226    EVENT_PTR points to the event to be inserted into the queue.
227    The caller must allocate memory for the event. It is freed
228    after the event has ben handled.
229    Events in the queue will be processed head to tail, therefore,
230    events inserted at the head of the queue will be processed
231    as last in first out. Event appended at the tail of the queue
232    will be processed first in first out. */
233 static void
234 async_queue_event (gdb_event * event_ptr, queue_position position)
235 {
236   if (position == TAIL)
237     {
238       /* The event will become the new last_event. */
239
240       event_ptr->next_event = NULL;
241       if (event_queue.first_event == NULL)
242         event_queue.first_event = event_ptr;
243       else
244         event_queue.last_event->next_event = event_ptr;
245       event_queue.last_event = event_ptr;
246     }
247   else if (position == HEAD)
248     {
249       /* The event becomes the new first_event. */
250
251       event_ptr->next_event = event_queue.first_event;
252       if (event_queue.first_event == NULL)
253         event_queue.last_event = event_ptr;
254       event_queue.first_event = event_ptr;
255     }
256 }
257
258 /* Create a file event, to be enqueued in the event queue for
259    processing. The procedure associated to this event is always
260    handle_file_event, which will in turn invoke the one that was
261    associated to FD when it was registered with the event loop. */
262 static gdb_event *
263 create_file_event (int fd)
264 {
265   gdb_event *file_event_ptr;
266
267   file_event_ptr = (gdb_event *) xmalloc (sizeof (gdb_event));
268   file_event_ptr->proc = handle_file_event;
269   file_event_ptr->fd = fd;
270   return (file_event_ptr);
271 }
272
273 /* Process one event.
274    The event can be the next one to be serviced in the event queue,
275    or an asynchronous event handler can be invoked in response to
276    the reception of a signal.
277    If an event was processed (either way), 1 is returned otherwise
278    0 is returned.   
279    Scan the queue from head to tail, processing therefore the high
280    priority events first, by invoking the associated event handler
281    procedure. */
282 static int
283 process_event (void)
284 {
285   gdb_event *event_ptr, *prev_ptr;
286   event_handler_func *proc;
287   int fd;
288
289   /* First let's see if there are any asynchronous event handlers that
290      are ready. These would be the result of invoking any of the
291      signal handlers. */
292
293   if (check_async_ready ())
294     {
295       invoke_async_signal_handler ();
296       return 1;
297     }
298
299   /* Look in the event queue to find an event that is ready
300      to be processed. */
301
302   for (event_ptr = event_queue.first_event; event_ptr != NULL;
303        event_ptr = event_ptr->next_event)
304     {
305       /* Call the handler for the event. */
306
307       proc = event_ptr->proc;
308       fd = event_ptr->fd;
309
310       /* Let's get rid of the event from the event queue.  We need to
311          do this now because while processing the event, the proc
312          function could end up calling 'error' and therefore jump out
313          to the caller of this function, gdb_do_one_event. In that
314          case, we would have on the event queue an event wich has been
315          processed, but not deleted. */
316
317       if (event_queue.first_event == event_ptr)
318         {
319           event_queue.first_event = event_ptr->next_event;
320           if (event_ptr->next_event == NULL)
321             event_queue.last_event = NULL;
322         }
323       else
324         {
325           prev_ptr = event_queue.first_event;
326           while (prev_ptr->next_event != event_ptr)
327             prev_ptr = prev_ptr->next_event;
328
329           prev_ptr->next_event = event_ptr->next_event;
330           if (event_ptr->next_event == NULL)
331             event_queue.last_event = prev_ptr;
332         }
333       xfree (event_ptr);
334
335       /* Now call the procedure associated with the event. */
336       (*proc) (fd);
337       return 1;
338     }
339
340   /* this is the case if there are no event on the event queue. */
341   return 0;
342 }
343
344 /* Process one high level event.  If nothing is ready at this time,
345    wait for something to happen (via gdb_wait_for_event), then process
346    it.  Returns >0 if something was done otherwise returns <0 (this
347    can happen if there are no event sources to wait for).  If an error
348    occurs catch_errors() which calls this function returns zero. */
349
350 static int
351 gdb_do_one_event (void *data)
352 {
353   /* Any events already waiting in the queue? */
354   if (process_event ())
355     {
356       return 1;
357     }
358
359   /* Are any timers that are ready? If so, put an event on the queue. */
360   poll_timers ();
361
362   /* Wait for a new event.  If gdb_wait_for_event returns -1,
363      we should get out because this means that there are no
364      event sources left. This will make the event loop stop,
365      and the application exit. */
366
367   if (gdb_wait_for_event () < 0)
368     {
369       return -1;
370     }
371
372   /* Handle any new events occurred while waiting. */
373   if (process_event ())
374     {
375       return 1;
376     }
377
378   /* If gdb_wait_for_event has returned 1, it means that one
379      event has been handled. We break out of the loop. */
380   return 1;
381 }
382
383 /* Start up the event loop. This is the entry point to the event loop
384    from the command loop. */
385
386 void
387 start_event_loop (void)
388 {
389   /* Loop until there is nothing to do. This is the entry point to the
390      event loop engine. gdb_do_one_event, called via catch_errors()
391      will process one event for each invocation.  It blocks waits for
392      an event and then processes it.  >0 when an event is processed, 0
393      when catch_errors() caught an error and <0 when there are no
394      longer any event sources registered. */
395   while (1)
396     {
397       int result = catch_errors (gdb_do_one_event, 0, "", RETURN_MASK_ALL);
398       if (result < 0)
399         break;
400       if (result == 0)
401         {
402           /* FIXME: this should really be a call to a hook that is
403              interface specific, because interfaces can display the
404              prompt in their own way. */
405           display_gdb_prompt (0);
406           /* Maybe better to set a flag to be checked somewhere as to
407              whether display the prompt or not. */
408         }
409     }
410
411   /* We are done with the event loop. There are no more event sources
412      to listen to.  So we exit GDB. */
413   return;
414 }
415 \f
416
417 /* Wrapper function for create_file_handler, so that the caller
418    doesn't have to know implementation details about the use of poll
419    vs. select. */
420 void
421 add_file_handler (int fd, handler_func * proc, gdb_client_data client_data)
422 {
423 #ifdef HAVE_POLL
424   struct pollfd fds;
425 #endif
426
427   if (use_poll)
428     {
429 #ifdef HAVE_POLL
430       /* Check to see if poll () is usable. If not, we'll switch to
431          use select. This can happen on systems like
432          m68k-motorola-sys, `poll' cannot be used to wait for `stdin'.
433          On m68k-motorola-sysv, tty's are not stream-based and not
434          `poll'able. */
435       fds.fd = fd;
436       fds.events = POLLIN;
437       if (poll (&fds, 1, 0) == 1 && (fds.revents & POLLNVAL))
438         use_poll = 0;
439 #else
440       internal_error (__FILE__, __LINE__,
441                       "use_poll without HAVE_POLL");
442 #endif /* HAVE_POLL */
443     }
444   if (use_poll)
445     {
446 #ifdef HAVE_POLL
447       create_file_handler (fd, POLLIN, proc, client_data);
448 #else
449       internal_error (__FILE__, __LINE__,
450                       "use_poll without HAVE_POLL");
451 #endif
452     }
453   else
454     create_file_handler (fd, GDB_READABLE | GDB_EXCEPTION, proc, client_data);
455 }
456
457 /* Add a file handler/descriptor to the list of descriptors we are
458    interested in.  
459    FD is the file descriptor for the file/stream to be listened to.  
460    For the poll case, MASK is a combination (OR) of
461    POLLIN, POLLRDNORM, POLLRDBAND, POLLPRI, POLLOUT, POLLWRNORM,
462    POLLWRBAND: these are the events we are interested in. If any of them 
463    occurs, proc should be called.
464    For the select case, MASK is a combination of READABLE, WRITABLE, EXCEPTION.
465    PROC is the procedure that will be called when an event occurs for
466    FD.  CLIENT_DATA is the argument to pass to PROC. */
467 static void
468 create_file_handler (int fd, int mask, handler_func * proc, gdb_client_data client_data)
469 {
470   file_handler *file_ptr;
471
472   /* Do we already have a file handler for this file? (We may be
473      changing its associated procedure). */
474   for (file_ptr = gdb_notifier.first_file_handler; file_ptr != NULL;
475        file_ptr = file_ptr->next_file)
476     {
477       if (file_ptr->fd == fd)
478         break;
479     }
480
481   /* It is a new file descriptor. Add it to the list. Otherwise, just
482      change the data associated with it. */
483   if (file_ptr == NULL)
484     {
485       file_ptr = (file_handler *) xmalloc (sizeof (file_handler));
486       file_ptr->fd = fd;
487       file_ptr->ready_mask = 0;
488       file_ptr->next_file = gdb_notifier.first_file_handler;
489       gdb_notifier.first_file_handler = file_ptr;
490     }
491   file_ptr->proc = proc;
492   file_ptr->client_data = client_data;
493   file_ptr->mask = mask;
494
495   if (use_poll)
496     {
497 #ifdef HAVE_POLL
498       gdb_notifier.num_fds++;
499       if (gdb_notifier.poll_fds)
500         gdb_notifier.poll_fds =
501           (struct pollfd *) xrealloc (gdb_notifier.poll_fds,
502                                       (gdb_notifier.num_fds
503                                        * sizeof (struct pollfd)));
504       else
505         gdb_notifier.poll_fds =
506           (struct pollfd *) xmalloc (sizeof (struct pollfd));
507       (gdb_notifier.poll_fds + gdb_notifier.num_fds - 1)->fd = fd;
508       (gdb_notifier.poll_fds + gdb_notifier.num_fds - 1)->events = mask;
509       (gdb_notifier.poll_fds + gdb_notifier.num_fds - 1)->revents = 0;
510 #else
511       internal_error (__FILE__, __LINE__,
512                       "use_poll without HAVE_POLL");
513 #endif /* HAVE_POLL */
514     }
515   else
516     {
517       if (mask & GDB_READABLE)
518         FD_SET (fd, &gdb_notifier.check_masks[0]);
519       else
520         FD_CLR (fd, &gdb_notifier.check_masks[0]);
521
522       if (mask & GDB_WRITABLE)
523         FD_SET (fd, &gdb_notifier.check_masks[1]);
524       else
525         FD_CLR (fd, &gdb_notifier.check_masks[1]);
526
527       if (mask & GDB_EXCEPTION)
528         FD_SET (fd, &gdb_notifier.check_masks[2]);
529       else
530         FD_CLR (fd, &gdb_notifier.check_masks[2]);
531
532       if (gdb_notifier.num_fds <= fd)
533         gdb_notifier.num_fds = fd + 1;
534     }
535 }
536
537 /* Remove the file descriptor FD from the list of monitored fd's: 
538    i.e. we don't care anymore about events on the FD. */
539 void
540 delete_file_handler (int fd)
541 {
542   file_handler *file_ptr, *prev_ptr = NULL;
543   int i;
544 #ifdef HAVE_POLL
545   int j;
546   struct pollfd *new_poll_fds;
547 #endif
548
549   /* Find the entry for the given file. */
550
551   for (file_ptr = gdb_notifier.first_file_handler; file_ptr != NULL;
552        file_ptr = file_ptr->next_file)
553     {
554       if (file_ptr->fd == fd)
555         break;
556     }
557
558   if (file_ptr == NULL)
559     return;
560
561   if (use_poll)
562     {
563 #ifdef HAVE_POLL
564       /* Create a new poll_fds array by copying every fd's information but the
565          one we want to get rid of. */
566
567       new_poll_fds =
568         (struct pollfd *) xmalloc ((gdb_notifier.num_fds - 1) * sizeof (struct pollfd));
569
570       for (i = 0, j = 0; i < gdb_notifier.num_fds; i++)
571         {
572           if ((gdb_notifier.poll_fds + i)->fd != fd)
573             {
574               (new_poll_fds + j)->fd = (gdb_notifier.poll_fds + i)->fd;
575               (new_poll_fds + j)->events = (gdb_notifier.poll_fds + i)->events;
576               (new_poll_fds + j)->revents = (gdb_notifier.poll_fds + i)->revents;
577               j++;
578             }
579         }
580       xfree (gdb_notifier.poll_fds);
581       gdb_notifier.poll_fds = new_poll_fds;
582       gdb_notifier.num_fds--;
583 #else
584       internal_error (__FILE__, __LINE__,
585                       "use_poll without HAVE_POLL");
586 #endif /* HAVE_POLL */
587     }
588   else
589     {
590       if (file_ptr->mask & GDB_READABLE)
591         FD_CLR (fd, &gdb_notifier.check_masks[0]);
592       if (file_ptr->mask & GDB_WRITABLE)
593         FD_CLR (fd, &gdb_notifier.check_masks[1]);
594       if (file_ptr->mask & GDB_EXCEPTION)
595         FD_CLR (fd, &gdb_notifier.check_masks[2]);
596
597       /* Find current max fd. */
598
599       if ((fd + 1) == gdb_notifier.num_fds)
600         {
601           gdb_notifier.num_fds--;
602           for (i = gdb_notifier.num_fds; i; i--)
603             {
604               if (FD_ISSET (i - 1, &gdb_notifier.check_masks[0])
605                   || FD_ISSET (i - 1, &gdb_notifier.check_masks[1])
606                   || FD_ISSET (i - 1, &gdb_notifier.check_masks[2]))
607                 break;
608             }
609           gdb_notifier.num_fds = i;
610         }
611     }
612
613   /* Deactivate the file descriptor, by clearing its mask, 
614      so that it will not fire again. */
615
616   file_ptr->mask = 0;
617
618   /* Get rid of the file handler in the file handler list. */
619   if (file_ptr == gdb_notifier.first_file_handler)
620     gdb_notifier.first_file_handler = file_ptr->next_file;
621   else
622     {
623       for (prev_ptr = gdb_notifier.first_file_handler;
624            prev_ptr->next_file != file_ptr;
625            prev_ptr = prev_ptr->next_file)
626         ;
627       prev_ptr->next_file = file_ptr->next_file;
628     }
629   xfree (file_ptr);
630 }
631
632 /* Handle the given event by calling the procedure associated to the
633    corresponding file handler.  Called by process_event indirectly,
634    through event_ptr->proc.  EVENT_FILE_DESC is file descriptor of the
635    event in the front of the event queue. */
636 static void
637 handle_file_event (int event_file_desc)
638 {
639   file_handler *file_ptr;
640   int mask;
641 #ifdef HAVE_POLL
642   int error_mask;
643   int error_mask_returned;
644 #endif
645
646   /* Search the file handler list to find one that matches the fd in
647      the event. */
648   for (file_ptr = gdb_notifier.first_file_handler; file_ptr != NULL;
649        file_ptr = file_ptr->next_file)
650     {
651       if (file_ptr->fd == event_file_desc)
652         {
653           /* With poll, the ready_mask could have any of three events
654              set to 1: POLLHUP, POLLERR, POLLNVAL. These events cannot
655              be used in the requested event mask (events), but they
656              can be returned in the return mask (revents). We need to
657              check for those event too, and add them to the mask which
658              will be passed to the handler. */
659
660           /* See if the desired events (mask) match the received
661              events (ready_mask). */
662
663           if (use_poll)
664             {
665 #ifdef HAVE_POLL
666               error_mask = POLLHUP | POLLERR | POLLNVAL;
667               mask = (file_ptr->ready_mask & file_ptr->mask) |
668                 (file_ptr->ready_mask & error_mask);
669               error_mask_returned = mask & error_mask;
670
671               if (error_mask_returned != 0)
672                 {
673                   /* Work in progress. We may need to tell somebody what
674                      kind of error we had. */
675                   if (error_mask_returned & POLLHUP)
676                     printf_unfiltered ("Hangup detected on fd %d\n", file_ptr->fd);
677                   if (error_mask_returned & POLLERR)
678                     printf_unfiltered ("Error detected on fd %d\n", file_ptr->fd);
679                   if (error_mask_returned & POLLNVAL)
680                     printf_unfiltered ("Invalid or non-`poll'able fd %d\n", file_ptr->fd);
681                   file_ptr->error = 1;
682                 }
683               else
684                 file_ptr->error = 0;
685 #else
686               internal_error (__FILE__, __LINE__,
687                               "use_poll without HAVE_POLL");
688 #endif /* HAVE_POLL */
689             }
690           else
691             {
692               if (file_ptr->ready_mask & GDB_EXCEPTION)
693                 {
694                   printf_unfiltered ("Exception condition detected on fd %d\n", file_ptr->fd);
695                   file_ptr->error = 1;
696                 }
697               else
698                 file_ptr->error = 0;
699               mask = file_ptr->ready_mask & file_ptr->mask;
700             }
701
702           /* Clear the received events for next time around. */
703           file_ptr->ready_mask = 0;
704
705           /* If there was a match, then call the handler. */
706           if (mask != 0)
707             (*file_ptr->proc) (file_ptr->error, file_ptr->client_data);
708           break;
709         }
710     }
711 }
712
713 /* Called by gdb_do_one_event to wait for new events on the 
714    monitored file descriptors. Queue file events as they are 
715    detected by the poll. 
716    If there are no events, this function will block in the 
717    call to poll.
718    Return -1 if there are no files descriptors to monitor, 
719    otherwise return 0. */
720 static int
721 gdb_wait_for_event (void)
722 {
723   file_handler *file_ptr;
724   gdb_event *file_event_ptr;
725   int num_found = 0;
726   int i;
727
728   /* Make sure all output is done before getting another event. */
729   gdb_flush (gdb_stdout);
730   gdb_flush (gdb_stderr);
731
732   if (gdb_notifier.num_fds == 0)
733     return -1;
734
735   if (use_poll)
736     {
737 #ifdef HAVE_POLL
738       num_found =
739         poll (gdb_notifier.poll_fds,
740               (unsigned long) gdb_notifier.num_fds,
741               gdb_notifier.timeout_valid ? gdb_notifier.poll_timeout : -1);
742
743       /* Don't print anything if we get out of poll because of a
744          signal. */
745       if (num_found == -1 && errno != EINTR)
746         perror_with_name ("Poll");
747 #else
748       internal_error (__FILE__, __LINE__,
749                       "use_poll without HAVE_POLL");
750 #endif /* HAVE_POLL */
751     }
752   else
753     {
754       gdb_notifier.ready_masks[0] = gdb_notifier.check_masks[0];
755       gdb_notifier.ready_masks[1] = gdb_notifier.check_masks[1];
756       gdb_notifier.ready_masks[2] = gdb_notifier.check_masks[2];
757       num_found = select (gdb_notifier.num_fds,
758                           &gdb_notifier.ready_masks[0],
759                           &gdb_notifier.ready_masks[1],
760                           &gdb_notifier.ready_masks[2],
761                           gdb_notifier.timeout_valid
762                           ? &gdb_notifier.select_timeout : NULL);
763
764       /* Clear the masks after an error from select. */
765       if (num_found == -1)
766         {
767           FD_ZERO (&gdb_notifier.ready_masks[0]);
768           FD_ZERO (&gdb_notifier.ready_masks[1]);
769           FD_ZERO (&gdb_notifier.ready_masks[2]);
770           /* Dont print anything is we got a signal, let gdb handle it. */
771           if (errno != EINTR)
772             perror_with_name ("Select");
773         }
774     }
775
776   /* Enqueue all detected file events. */
777
778   if (use_poll)
779     {
780 #ifdef HAVE_POLL
781       for (i = 0; (i < gdb_notifier.num_fds) && (num_found > 0); i++)
782         {
783           if ((gdb_notifier.poll_fds + i)->revents)
784             num_found--;
785           else
786             continue;
787
788           for (file_ptr = gdb_notifier.first_file_handler;
789                file_ptr != NULL;
790                file_ptr = file_ptr->next_file)
791             {
792               if (file_ptr->fd == (gdb_notifier.poll_fds + i)->fd)
793                 break;
794             }
795
796           if (file_ptr)
797             {
798               /* Enqueue an event only if this is still a new event for
799                  this fd. */
800               if (file_ptr->ready_mask == 0)
801                 {
802                   file_event_ptr = create_file_event (file_ptr->fd);
803                   async_queue_event (file_event_ptr, TAIL);
804                 }
805             }
806
807           file_ptr->ready_mask = (gdb_notifier.poll_fds + i)->revents;
808         }
809 #else
810       internal_error (__FILE__, __LINE__,
811                       "use_poll without HAVE_POLL");
812 #endif /* HAVE_POLL */
813     }
814   else
815     {
816       for (file_ptr = gdb_notifier.first_file_handler;
817            (file_ptr != NULL) && (num_found > 0);
818            file_ptr = file_ptr->next_file)
819         {
820           int mask = 0;
821
822           if (FD_ISSET (file_ptr->fd, &gdb_notifier.ready_masks[0]))
823             mask |= GDB_READABLE;
824           if (FD_ISSET (file_ptr->fd, &gdb_notifier.ready_masks[1]))
825             mask |= GDB_WRITABLE;
826           if (FD_ISSET (file_ptr->fd, &gdb_notifier.ready_masks[2]))
827             mask |= GDB_EXCEPTION;
828
829           if (!mask)
830             continue;
831           else
832             num_found--;
833
834           /* Enqueue an event only if this is still a new event for
835              this fd. */
836
837           if (file_ptr->ready_mask == 0)
838             {
839               file_event_ptr = create_file_event (file_ptr->fd);
840               async_queue_event (file_event_ptr, TAIL);
841             }
842           file_ptr->ready_mask = mask;
843         }
844     }
845   return 0;
846 }
847 \f
848
849 /* Create an asynchronous handler, allocating memory for it. 
850    Return a pointer to the newly created handler.
851    This pointer will be used to invoke the handler by 
852    invoke_async_signal_handler.
853    PROC is the function to call with CLIENT_DATA argument 
854    whenever the handler is invoked. */
855 async_signal_handler *
856 create_async_signal_handler (sig_handler_func * proc, gdb_client_data client_data)
857 {
858   async_signal_handler *async_handler_ptr;
859
860   async_handler_ptr =
861     (async_signal_handler *) xmalloc (sizeof (async_signal_handler));
862   async_handler_ptr->ready = 0;
863   async_handler_ptr->next_handler = NULL;
864   async_handler_ptr->proc = proc;
865   async_handler_ptr->client_data = client_data;
866   if (sighandler_list.first_handler == NULL)
867     sighandler_list.first_handler = async_handler_ptr;
868   else
869     sighandler_list.last_handler->next_handler = async_handler_ptr;
870   sighandler_list.last_handler = async_handler_ptr;
871   return async_handler_ptr;
872 }
873
874 /* Mark the handler (ASYNC_HANDLER_PTR) as ready. This information will
875    be used when the handlers are invoked, after we have waited for
876    some event.  The caller of this function is the interrupt handler
877    associated with a signal. */
878 void
879 mark_async_signal_handler (async_signal_handler * async_handler_ptr)
880 {
881   ((async_signal_handler *) async_handler_ptr)->ready = 1;
882   async_handler_ready = 1;
883 }
884
885 /* Call all the handlers that are ready. */
886 static void
887 invoke_async_signal_handler (void)
888 {
889   async_signal_handler *async_handler_ptr;
890
891   if (async_handler_ready == 0)
892     return;
893   async_handler_ready = 0;
894
895   /* Invoke ready handlers. */
896
897   while (1)
898     {
899       for (async_handler_ptr = sighandler_list.first_handler;
900            async_handler_ptr != NULL;
901            async_handler_ptr = async_handler_ptr->next_handler)
902         {
903           if (async_handler_ptr->ready)
904             break;
905         }
906       if (async_handler_ptr == NULL)
907         break;
908       async_handler_ptr->ready = 0;
909       (*async_handler_ptr->proc) (async_handler_ptr->client_data);
910     }
911
912   return;
913 }
914
915 /* Delete an asynchronous handler (ASYNC_HANDLER_PTR). 
916    Free the space allocated for it.  */
917 void
918 delete_async_signal_handler (async_signal_handler ** async_handler_ptr)
919 {
920   async_signal_handler *prev_ptr;
921
922   if (sighandler_list.first_handler == (*async_handler_ptr))
923     {
924       sighandler_list.first_handler = (*async_handler_ptr)->next_handler;
925       if (sighandler_list.first_handler == NULL)
926         sighandler_list.last_handler = NULL;
927     }
928   else
929     {
930       prev_ptr = sighandler_list.first_handler;
931       while (prev_ptr->next_handler != (*async_handler_ptr) && prev_ptr)
932         prev_ptr = prev_ptr->next_handler;
933       prev_ptr->next_handler = (*async_handler_ptr)->next_handler;
934       if (sighandler_list.last_handler == (*async_handler_ptr))
935         sighandler_list.last_handler = prev_ptr;
936     }
937   xfree ((*async_handler_ptr));
938   (*async_handler_ptr) = NULL;
939 }
940
941 /* Is it necessary to call invoke_async_signal_handler? */
942 static int
943 check_async_ready (void)
944 {
945   return async_handler_ready;
946 }
947
948 /* Create a timer that will expire in MILLISECONDS from now. When the
949    timer is ready, PROC will be executed. At creation, the timer is
950    aded to the timers queue.  This queue is kept sorted in order of
951    increasing timers. Return a handle to the timer struct. */
952 int
953 create_timer (int milliseconds, timer_handler_func * proc, gdb_client_data client_data)
954 {
955   struct gdb_timer *timer_ptr, *timer_index, *prev_timer;
956   struct timeval time_now, delta;
957
958   /* compute seconds */
959   delta.tv_sec = milliseconds / 1000;
960   /* compute microseconds */
961   delta.tv_usec = (milliseconds % 1000) * 1000;
962
963   gettimeofday (&time_now, NULL);
964
965   timer_ptr = (struct gdb_timer *) xmalloc (sizeof (gdb_timer));
966   timer_ptr->when.tv_sec = time_now.tv_sec + delta.tv_sec;
967   timer_ptr->when.tv_usec = time_now.tv_usec + delta.tv_usec;
968   /* carry? */
969   if (timer_ptr->when.tv_usec >= 1000000)
970     {
971       timer_ptr->when.tv_sec += 1;
972       timer_ptr->when.tv_usec -= 1000000;
973     }
974   timer_ptr->proc = proc;
975   timer_ptr->client_data = client_data;
976   timer_list.num_timers++;
977   timer_ptr->timer_id = timer_list.num_timers;
978
979   /* Now add the timer to the timer queue, making sure it is sorted in
980      increasing order of expiration. */
981
982   for (timer_index = timer_list.first_timer;
983        timer_index != NULL;
984        timer_index = timer_index->next)
985     {
986       /* If the seconds field is greater or if it is the same, but the
987          microsecond field is greater. */
988       if ((timer_index->when.tv_sec > timer_ptr->when.tv_sec) ||
989           ((timer_index->when.tv_sec == timer_ptr->when.tv_sec)
990            && (timer_index->when.tv_usec > timer_ptr->when.tv_usec)))
991         break;
992     }
993
994   if (timer_index == timer_list.first_timer)
995     {
996       timer_ptr->next = timer_list.first_timer;
997       timer_list.first_timer = timer_ptr;
998
999     }
1000   else
1001     {
1002       for (prev_timer = timer_list.first_timer;
1003            prev_timer->next != timer_index;
1004            prev_timer = prev_timer->next)
1005         ;
1006
1007       prev_timer->next = timer_ptr;
1008       timer_ptr->next = timer_index;
1009     }
1010
1011   gdb_notifier.timeout_valid = 0;
1012   return timer_ptr->timer_id;
1013 }
1014
1015 /* There is a chance that the creator of the timer wants to get rid of
1016    it before it expires. */
1017 void
1018 delete_timer (int id)
1019 {
1020   struct gdb_timer *timer_ptr, *prev_timer = NULL;
1021
1022   /* Find the entry for the given timer. */
1023
1024   for (timer_ptr = timer_list.first_timer; timer_ptr != NULL;
1025        timer_ptr = timer_ptr->next)
1026     {
1027       if (timer_ptr->timer_id == id)
1028         break;
1029     }
1030
1031   if (timer_ptr == NULL)
1032     return;
1033   /* Get rid of the timer in the timer list. */
1034   if (timer_ptr == timer_list.first_timer)
1035     timer_list.first_timer = timer_ptr->next;
1036   else
1037     {
1038       for (prev_timer = timer_list.first_timer;
1039            prev_timer->next != timer_ptr;
1040            prev_timer = prev_timer->next)
1041         ;
1042       prev_timer->next = timer_ptr->next;
1043     }
1044   xfree (timer_ptr);
1045
1046   gdb_notifier.timeout_valid = 0;
1047 }
1048
1049 /* When a timer event is put on the event queue, it will be handled by
1050    this function.  Just call the assiciated procedure and delete the
1051    timer event from the event queue. Repeat this for each timer that
1052    has expired. */
1053 static void
1054 handle_timer_event (int dummy)
1055 {
1056   struct timeval time_now;
1057   struct gdb_timer *timer_ptr, *saved_timer;
1058
1059   gettimeofday (&time_now, NULL);
1060   timer_ptr = timer_list.first_timer;
1061
1062   while (timer_ptr != NULL)
1063     {
1064       if ((timer_ptr->when.tv_sec > time_now.tv_sec) ||
1065           ((timer_ptr->when.tv_sec == time_now.tv_sec) &&
1066            (timer_ptr->when.tv_usec > time_now.tv_usec)))
1067         break;
1068
1069       /* Get rid of the timer from the beginning of the list. */
1070       timer_list.first_timer = timer_ptr->next;
1071       saved_timer = timer_ptr;
1072       timer_ptr = timer_ptr->next;
1073       /* Call the procedure associated with that timer. */
1074       (*saved_timer->proc) (saved_timer->client_data);
1075       xfree (saved_timer);
1076     }
1077
1078   gdb_notifier.timeout_valid = 0;
1079 }
1080
1081 /* Check whether any timers in the timers queue are ready. If at least
1082    one timer is ready, stick an event onto the event queue.  Even in
1083    case more than one timer is ready, one event is enough, because the
1084    handle_timer_event() will go through the timers list and call the
1085    procedures associated with all that have expired. Update the
1086    timeout for the select() or poll() as well. */
1087 static void
1088 poll_timers (void)
1089 {
1090   struct timeval time_now, delta;
1091   gdb_event *event_ptr;
1092
1093   if (timer_list.first_timer != NULL)
1094     {
1095       gettimeofday (&time_now, NULL);
1096       delta.tv_sec = timer_list.first_timer->when.tv_sec - time_now.tv_sec;
1097       delta.tv_usec = timer_list.first_timer->when.tv_usec - time_now.tv_usec;
1098       /* borrow? */
1099       if (delta.tv_usec < 0)
1100         {
1101           delta.tv_sec -= 1;
1102           delta.tv_usec += 1000000;
1103         }
1104
1105       /* Oops it expired already. Tell select / poll to return
1106          immediately. (Cannot simply test if delta.tv_sec is negative
1107          because time_t might be unsigned.)  */
1108       if (timer_list.first_timer->when.tv_sec < time_now.tv_sec
1109           || (timer_list.first_timer->when.tv_sec == time_now.tv_sec
1110               && timer_list.first_timer->when.tv_usec < time_now.tv_usec))
1111         {
1112           delta.tv_sec = 0;
1113           delta.tv_usec = 0;
1114         }
1115
1116       if (delta.tv_sec == 0 && delta.tv_usec == 0)
1117         {
1118           event_ptr = (gdb_event *) xmalloc (sizeof (gdb_event));
1119           event_ptr->proc = handle_timer_event;
1120           event_ptr->fd = timer_list.first_timer->timer_id;
1121           async_queue_event (event_ptr, TAIL);
1122         }
1123
1124       /* Now we need to update the timeout for select/ poll, because we
1125          don't want to sit there while this timer is expiring. */
1126       if (use_poll)
1127         {
1128 #ifdef HAVE_POLL
1129           gdb_notifier.poll_timeout = delta.tv_sec * 1000;
1130 #else
1131           internal_error (__FILE__, __LINE__,
1132                           "use_poll without HAVE_POLL");
1133 #endif /* HAVE_POLL */
1134         }
1135       else
1136         {
1137           gdb_notifier.select_timeout.tv_sec = delta.tv_sec;
1138           gdb_notifier.select_timeout.tv_usec = delta.tv_usec;
1139         }
1140       gdb_notifier.timeout_valid = 1;
1141     }
1142   else
1143     gdb_notifier.timeout_valid = 0;
1144 }