gdb: testsuite: print explicit test result for gdb.base/dfp-test.exp
[binutils-gdb.git] / gdbsupport / event-loop.cc
1 /* Event loop machinery for GDB, the GNU debugger.
2 Copyright (C) 1999-2022 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 3 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, see <http://www.gnu.org/licenses/>. */
19
20 #include "gdbsupport/common-defs.h"
21 #include "gdbsupport/event-loop.h"
22
23 #include <chrono>
24
25 #ifdef HAVE_POLL
26 #if defined (HAVE_POLL_H)
27 #include <poll.h>
28 #elif defined (HAVE_SYS_POLL_H)
29 #include <sys/poll.h>
30 #endif
31 #endif
32
33 #include <sys/types.h>
34 #include "gdbsupport/gdb_sys_time.h"
35 #include "gdbsupport/gdb_select.h"
36
37 /* See event-loop.h. */
38
39 debug_event_loop_kind debug_event_loop;
40
41 /* Tell create_file_handler what events we are interested in.
42 This is used by the select version of the event loop. */
43
44 #define GDB_READABLE (1<<1)
45 #define GDB_WRITABLE (1<<2)
46 #define GDB_EXCEPTION (1<<3)
47
48 /* Information about each file descriptor we register with the event
49 loop. */
50
51 struct file_handler
52 {
53 /* File descriptor. */
54 int fd;
55
56 /* Events we want to monitor: POLLIN, etc. */
57 int mask;
58
59 /* Events that have been seen since the last time. */
60 int ready_mask;
61
62 /* Procedure to call when fd is ready. */
63 handler_func *proc;
64
65 /* Argument to pass to proc. */
66 gdb_client_data client_data;
67
68 /* User-friendly name of this handler. */
69 std::string name;
70
71 /* If set, this file descriptor is used for a user interface. */
72 bool is_ui;
73
74 /* Was an error detected on this fd? */
75 int error;
76
77 /* Next registered file descriptor. */
78 struct file_handler *next_file;
79 };
80
81 /* Do we use poll or select ? */
82 #ifdef HAVE_POLL
83 #define USE_POLL 1
84 #else
85 #define USE_POLL 0
86 #endif /* HAVE_POLL */
87
88 static unsigned char use_poll = USE_POLL;
89
90 #ifdef USE_WIN32API
91 #include <windows.h>
92 #include <io.h>
93 #endif
94
95 /* Gdb_notifier is just a list of file descriptors gdb is interested in.
96 These are the input file descriptor, and the target file
97 descriptor. We have two flavors of the notifier, one for platforms
98 that have the POLL function, the other for those that don't, and
99 only support SELECT. Each of the elements in the gdb_notifier list is
100 basically a description of what kind of events gdb is interested
101 in, for each fd. */
102
103 static struct
104 {
105 /* Ptr to head of file handler list. */
106 file_handler *first_file_handler;
107
108 /* Next file handler to handle, for the select variant. To level
109 the fairness across event sources, we serve file handlers in a
110 round-robin-like fashion. The number and order of the polled
111 file handlers may change between invocations, but this is good
112 enough. */
113 file_handler *next_file_handler;
114
115 #ifdef HAVE_POLL
116 /* Ptr to array of pollfd structures. */
117 struct pollfd *poll_fds;
118
119 /* Next file descriptor to handle, for the poll variant. To level
120 the fairness across event sources, we poll the file descriptors
121 in a round-robin-like fashion. The number and order of the
122 polled file descriptors may change between invocations, but
123 this is good enough. */
124 int next_poll_fds_index;
125
126 /* Timeout in milliseconds for calls to poll(). */
127 int poll_timeout;
128 #endif
129
130 /* Masks to be used in the next call to select.
131 Bits are set in response to calls to create_file_handler. */
132 fd_set check_masks[3];
133
134 /* What file descriptors were found ready by select. */
135 fd_set ready_masks[3];
136
137 /* Number of file descriptors to monitor (for poll). */
138 /* Number of valid bits (highest fd value + 1) (for select). */
139 int num_fds;
140
141 /* Time structure for calls to select(). */
142 struct timeval select_timeout;
143
144 /* Flag to tell whether the timeout should be used. */
145 int timeout_valid;
146 }
147 gdb_notifier;
148
149 /* Structure associated with a timer. PROC will be executed at the
150 first occasion after WHEN. */
151 struct gdb_timer
152 {
153 std::chrono::steady_clock::time_point when;
154 int timer_id;
155 struct gdb_timer *next;
156 timer_handler_func *proc; /* Function to call to do the work. */
157 gdb_client_data client_data; /* Argument to async_handler_func. */
158 };
159
160 /* List of currently active timers. It is sorted in order of
161 increasing timers. */
162 static struct
163 {
164 /* Pointer to first in timer list. */
165 struct gdb_timer *first_timer;
166
167 /* Id of the last timer created. */
168 int num_timers;
169 }
170 timer_list;
171
172 static void create_file_handler (int fd, int mask, handler_func *proc,
173 gdb_client_data client_data,
174 std::string &&name, bool is_ui);
175 static int gdb_wait_for_event (int);
176 static int update_wait_timeout (void);
177 static int poll_timers (void);
178 \f
179 /* Process one high level event. If nothing is ready at this time,
180 wait for something to happen (via gdb_wait_for_event), then process
181 it. Returns >0 if something was done otherwise returns <0 (this
182 can happen if there are no event sources to wait for). */
183
184 int
185 gdb_do_one_event (void)
186 {
187 static int event_source_head = 0;
188 const int number_of_sources = 3;
189 int current = 0;
190
191 /* First let's see if there are any asynchronous signal handlers
192 that are ready. These would be the result of invoking any of the
193 signal handlers. */
194 if (invoke_async_signal_handlers ())
195 return 1;
196
197 /* To level the fairness across event sources, we poll them in a
198 round-robin fashion. */
199 for (current = 0; current < number_of_sources; current++)
200 {
201 int res;
202
203 switch (event_source_head)
204 {
205 case 0:
206 /* Are any timers that are ready? */
207 res = poll_timers ();
208 break;
209 case 1:
210 /* Are there events already waiting to be collected on the
211 monitored file descriptors? */
212 res = gdb_wait_for_event (0);
213 break;
214 case 2:
215 /* Are there any asynchronous event handlers ready? */
216 res = check_async_event_handlers ();
217 break;
218 default:
219 internal_error (__FILE__, __LINE__,
220 "unexpected event_source_head %d",
221 event_source_head);
222 }
223
224 event_source_head++;
225 if (event_source_head == number_of_sources)
226 event_source_head = 0;
227
228 if (res > 0)
229 return 1;
230 }
231
232 /* Block waiting for a new event. If gdb_wait_for_event returns -1,
233 we should get out because this means that there are no event
234 sources left. This will make the event loop stop, and the
235 application exit. */
236
237 if (gdb_wait_for_event (1) < 0)
238 return -1;
239
240 /* If gdb_wait_for_event has returned 1, it means that one event has
241 been handled. We break out of the loop. */
242 return 1;
243 }
244
245 /* See event-loop.h */
246
247 void
248 add_file_handler (int fd, handler_func *proc, gdb_client_data client_data,
249 std::string &&name, bool is_ui)
250 {
251 #ifdef HAVE_POLL
252 struct pollfd fds;
253 #endif
254
255 if (use_poll)
256 {
257 #ifdef HAVE_POLL
258 /* Check to see if poll () is usable. If not, we'll switch to
259 use select. This can happen on systems like
260 m68k-motorola-sys, `poll' cannot be used to wait for `stdin'.
261 On m68k-motorola-sysv, tty's are not stream-based and not
262 `poll'able. */
263 fds.fd = fd;
264 fds.events = POLLIN;
265 if (poll (&fds, 1, 0) == 1 && (fds.revents & POLLNVAL))
266 use_poll = 0;
267 #else
268 internal_error (__FILE__, __LINE__,
269 _("use_poll without HAVE_POLL"));
270 #endif /* HAVE_POLL */
271 }
272 if (use_poll)
273 {
274 #ifdef HAVE_POLL
275 create_file_handler (fd, POLLIN, proc, client_data, std::move (name),
276 is_ui);
277 #else
278 internal_error (__FILE__, __LINE__,
279 _("use_poll without HAVE_POLL"));
280 #endif
281 }
282 else
283 create_file_handler (fd, GDB_READABLE | GDB_EXCEPTION,
284 proc, client_data, std::move (name), is_ui);
285 }
286
287 /* Helper for add_file_handler.
288
289 For the poll case, MASK is a combination (OR) of POLLIN,
290 POLLRDNORM, POLLRDBAND, POLLPRI, POLLOUT, POLLWRNORM, POLLWRBAND:
291 these are the events we are interested in. If any of them occurs,
292 proc should be called.
293
294 For the select case, MASK is a combination of READABLE, WRITABLE,
295 EXCEPTION. PROC is the procedure that will be called when an event
296 occurs for FD. CLIENT_DATA is the argument to pass to PROC. */
297
298 static void
299 create_file_handler (int fd, int mask, handler_func * proc,
300 gdb_client_data client_data, std::string &&name,
301 bool is_ui)
302 {
303 file_handler *file_ptr;
304
305 /* Do we already have a file handler for this file? (We may be
306 changing its associated procedure). */
307 for (file_ptr = gdb_notifier.first_file_handler; file_ptr != NULL;
308 file_ptr = file_ptr->next_file)
309 {
310 if (file_ptr->fd == fd)
311 break;
312 }
313
314 /* It is a new file descriptor. Add it to the list. Otherwise, just
315 change the data associated with it. */
316 if (file_ptr == NULL)
317 {
318 file_ptr = new file_handler;
319 file_ptr->fd = fd;
320 file_ptr->ready_mask = 0;
321 file_ptr->next_file = gdb_notifier.first_file_handler;
322 gdb_notifier.first_file_handler = file_ptr;
323
324 if (use_poll)
325 {
326 #ifdef HAVE_POLL
327 gdb_notifier.num_fds++;
328 if (gdb_notifier.poll_fds)
329 gdb_notifier.poll_fds =
330 (struct pollfd *) xrealloc (gdb_notifier.poll_fds,
331 (gdb_notifier.num_fds
332 * sizeof (struct pollfd)));
333 else
334 gdb_notifier.poll_fds =
335 XNEW (struct pollfd);
336 (gdb_notifier.poll_fds + gdb_notifier.num_fds - 1)->fd = fd;
337 (gdb_notifier.poll_fds + gdb_notifier.num_fds - 1)->events = mask;
338 (gdb_notifier.poll_fds + gdb_notifier.num_fds - 1)->revents = 0;
339 #else
340 internal_error (__FILE__, __LINE__,
341 _("use_poll without HAVE_POLL"));
342 #endif /* HAVE_POLL */
343 }
344 else
345 {
346 if (mask & GDB_READABLE)
347 FD_SET (fd, &gdb_notifier.check_masks[0]);
348 else
349 FD_CLR (fd, &gdb_notifier.check_masks[0]);
350
351 if (mask & GDB_WRITABLE)
352 FD_SET (fd, &gdb_notifier.check_masks[1]);
353 else
354 FD_CLR (fd, &gdb_notifier.check_masks[1]);
355
356 if (mask & GDB_EXCEPTION)
357 FD_SET (fd, &gdb_notifier.check_masks[2]);
358 else
359 FD_CLR (fd, &gdb_notifier.check_masks[2]);
360
361 if (gdb_notifier.num_fds <= fd)
362 gdb_notifier.num_fds = fd + 1;
363 }
364 }
365
366 file_ptr->proc = proc;
367 file_ptr->client_data = client_data;
368 file_ptr->mask = mask;
369 file_ptr->name = std::move (name);
370 file_ptr->is_ui = is_ui;
371 }
372
373 /* Return the next file handler to handle, and advance to the next
374 file handler, wrapping around if the end of the list is
375 reached. */
376
377 static file_handler *
378 get_next_file_handler_to_handle_and_advance (void)
379 {
380 file_handler *curr_next;
381
382 /* The first time around, this is still NULL. */
383 if (gdb_notifier.next_file_handler == NULL)
384 gdb_notifier.next_file_handler = gdb_notifier.first_file_handler;
385
386 curr_next = gdb_notifier.next_file_handler;
387 gdb_assert (curr_next != NULL);
388
389 /* Advance. */
390 gdb_notifier.next_file_handler = curr_next->next_file;
391 /* Wrap around, if necessary. */
392 if (gdb_notifier.next_file_handler == NULL)
393 gdb_notifier.next_file_handler = gdb_notifier.first_file_handler;
394
395 return curr_next;
396 }
397
398 /* Remove the file descriptor FD from the list of monitored fd's:
399 i.e. we don't care anymore about events on the FD. */
400 void
401 delete_file_handler (int fd)
402 {
403 file_handler *file_ptr, *prev_ptr = NULL;
404 int i;
405 #ifdef HAVE_POLL
406 int j;
407 struct pollfd *new_poll_fds;
408 #endif
409
410 /* Find the entry for the given file. */
411
412 for (file_ptr = gdb_notifier.first_file_handler; file_ptr != NULL;
413 file_ptr = file_ptr->next_file)
414 {
415 if (file_ptr->fd == fd)
416 break;
417 }
418
419 if (file_ptr == NULL)
420 return;
421
422 if (use_poll)
423 {
424 #ifdef HAVE_POLL
425 /* Create a new poll_fds array by copying every fd's information
426 but the one we want to get rid of. */
427
428 new_poll_fds = (struct pollfd *)
429 xmalloc ((gdb_notifier.num_fds - 1) * sizeof (struct pollfd));
430
431 for (i = 0, j = 0; i < gdb_notifier.num_fds; i++)
432 {
433 if ((gdb_notifier.poll_fds + i)->fd != fd)
434 {
435 (new_poll_fds + j)->fd = (gdb_notifier.poll_fds + i)->fd;
436 (new_poll_fds + j)->events = (gdb_notifier.poll_fds + i)->events;
437 (new_poll_fds + j)->revents
438 = (gdb_notifier.poll_fds + i)->revents;
439 j++;
440 }
441 }
442 xfree (gdb_notifier.poll_fds);
443 gdb_notifier.poll_fds = new_poll_fds;
444 gdb_notifier.num_fds--;
445 #else
446 internal_error (__FILE__, __LINE__,
447 _("use_poll without HAVE_POLL"));
448 #endif /* HAVE_POLL */
449 }
450 else
451 {
452 if (file_ptr->mask & GDB_READABLE)
453 FD_CLR (fd, &gdb_notifier.check_masks[0]);
454 if (file_ptr->mask & GDB_WRITABLE)
455 FD_CLR (fd, &gdb_notifier.check_masks[1]);
456 if (file_ptr->mask & GDB_EXCEPTION)
457 FD_CLR (fd, &gdb_notifier.check_masks[2]);
458
459 /* Find current max fd. */
460
461 if ((fd + 1) == gdb_notifier.num_fds)
462 {
463 gdb_notifier.num_fds--;
464 for (i = gdb_notifier.num_fds; i; i--)
465 {
466 if (FD_ISSET (i - 1, &gdb_notifier.check_masks[0])
467 || FD_ISSET (i - 1, &gdb_notifier.check_masks[1])
468 || FD_ISSET (i - 1, &gdb_notifier.check_masks[2]))
469 break;
470 }
471 gdb_notifier.num_fds = i;
472 }
473 }
474
475 /* Deactivate the file descriptor, by clearing its mask,
476 so that it will not fire again. */
477
478 file_ptr->mask = 0;
479
480 /* If this file handler was going to be the next one to be handled,
481 advance to the next's next, if any. */
482 if (gdb_notifier.next_file_handler == file_ptr)
483 {
484 if (file_ptr->next_file == NULL
485 && file_ptr == gdb_notifier.first_file_handler)
486 gdb_notifier.next_file_handler = NULL;
487 else
488 get_next_file_handler_to_handle_and_advance ();
489 }
490
491 /* Get rid of the file handler in the file handler list. */
492 if (file_ptr == gdb_notifier.first_file_handler)
493 gdb_notifier.first_file_handler = file_ptr->next_file;
494 else
495 {
496 for (prev_ptr = gdb_notifier.first_file_handler;
497 prev_ptr->next_file != file_ptr;
498 prev_ptr = prev_ptr->next_file)
499 ;
500 prev_ptr->next_file = file_ptr->next_file;
501 }
502
503 delete file_ptr;
504 }
505
506 /* Handle the given event by calling the procedure associated to the
507 corresponding file handler. */
508
509 static void
510 handle_file_event (file_handler *file_ptr, int ready_mask)
511 {
512 int mask;
513 #ifdef HAVE_POLL
514 int error_mask;
515 #endif
516
517 {
518 {
519 /* With poll, the ready_mask could have any of three events
520 set to 1: POLLHUP, POLLERR, POLLNVAL. These events
521 cannot be used in the requested event mask (events), but
522 they can be returned in the return mask (revents). We
523 need to check for those event too, and add them to the
524 mask which will be passed to the handler. */
525
526 /* See if the desired events (mask) match the received
527 events (ready_mask). */
528
529 if (use_poll)
530 {
531 #ifdef HAVE_POLL
532 /* POLLHUP means EOF, but can be combined with POLLIN to
533 signal more data to read. */
534 error_mask = POLLHUP | POLLERR | POLLNVAL;
535 mask = ready_mask & (file_ptr->mask | error_mask);
536
537 if ((mask & (POLLERR | POLLNVAL)) != 0)
538 {
539 /* Work in progress. We may need to tell somebody
540 what kind of error we had. */
541 if (mask & POLLERR)
542 warning (_("Error detected on fd %d"), file_ptr->fd);
543 if (mask & POLLNVAL)
544 warning (_("Invalid or non-`poll'able fd %d"),
545 file_ptr->fd);
546 file_ptr->error = 1;
547 }
548 else
549 file_ptr->error = 0;
550 #else
551 internal_error (__FILE__, __LINE__,
552 _("use_poll without HAVE_POLL"));
553 #endif /* HAVE_POLL */
554 }
555 else
556 {
557 if (ready_mask & GDB_EXCEPTION)
558 {
559 warning (_("Exception condition detected on fd %d"),
560 file_ptr->fd);
561 file_ptr->error = 1;
562 }
563 else
564 file_ptr->error = 0;
565 mask = ready_mask & file_ptr->mask;
566 }
567
568 /* If there was a match, then call the handler. */
569 if (mask != 0)
570 {
571 event_loop_ui_debug_printf (file_ptr->is_ui,
572 "invoking fd file handler `%s`",
573 file_ptr->name.c_str ());
574 file_ptr->proc (file_ptr->error, file_ptr->client_data);
575 }
576 }
577 }
578 }
579
580 /* Wait for new events on the monitored file descriptors. Run the
581 event handler if the first descriptor that is detected by the poll.
582 If BLOCK and if there are no events, this function will block in
583 the call to poll. Return 1 if an event was handled. Return -1 if
584 there are no file descriptors to monitor. Return 1 if an event was
585 handled, otherwise returns 0. */
586
587 static int
588 gdb_wait_for_event (int block)
589 {
590 file_handler *file_ptr;
591 int num_found = 0;
592
593 /* Make sure all output is done before getting another event. */
594 flush_streams ();
595
596 if (gdb_notifier.num_fds == 0)
597 return -1;
598
599 if (block)
600 update_wait_timeout ();
601
602 if (use_poll)
603 {
604 #ifdef HAVE_POLL
605 int timeout;
606
607 if (block)
608 timeout = gdb_notifier.timeout_valid ? gdb_notifier.poll_timeout : -1;
609 else
610 timeout = 0;
611
612 num_found = poll (gdb_notifier.poll_fds,
613 (unsigned long) gdb_notifier.num_fds, timeout);
614
615 /* Don't print anything if we get out of poll because of a
616 signal. */
617 if (num_found == -1 && errno != EINTR)
618 perror_with_name (("poll"));
619 #else
620 internal_error (__FILE__, __LINE__,
621 _("use_poll without HAVE_POLL"));
622 #endif /* HAVE_POLL */
623 }
624 else
625 {
626 struct timeval select_timeout;
627 struct timeval *timeout_p;
628
629 if (block)
630 timeout_p = gdb_notifier.timeout_valid
631 ? &gdb_notifier.select_timeout : NULL;
632 else
633 {
634 memset (&select_timeout, 0, sizeof (select_timeout));
635 timeout_p = &select_timeout;
636 }
637
638 gdb_notifier.ready_masks[0] = gdb_notifier.check_masks[0];
639 gdb_notifier.ready_masks[1] = gdb_notifier.check_masks[1];
640 gdb_notifier.ready_masks[2] = gdb_notifier.check_masks[2];
641 num_found = gdb_select (gdb_notifier.num_fds,
642 &gdb_notifier.ready_masks[0],
643 &gdb_notifier.ready_masks[1],
644 &gdb_notifier.ready_masks[2],
645 timeout_p);
646
647 /* Clear the masks after an error from select. */
648 if (num_found == -1)
649 {
650 FD_ZERO (&gdb_notifier.ready_masks[0]);
651 FD_ZERO (&gdb_notifier.ready_masks[1]);
652 FD_ZERO (&gdb_notifier.ready_masks[2]);
653
654 /* Dont print anything if we got a signal, let gdb handle
655 it. */
656 if (errno != EINTR)
657 perror_with_name (("select"));
658 }
659 }
660
661 /* Avoid looking at poll_fds[i]->revents if no event fired. */
662 if (num_found <= 0)
663 return 0;
664
665 /* Run event handlers. We always run just one handler and go back
666 to polling, in case a handler changes the notifier list. Since
667 events for sources we haven't consumed yet wake poll/select
668 immediately, no event is lost. */
669
670 /* To level the fairness across event descriptors, we handle them in
671 a round-robin-like fashion. The number and order of descriptors
672 may change between invocations, but this is good enough. */
673 if (use_poll)
674 {
675 #ifdef HAVE_POLL
676 int i;
677 int mask;
678
679 while (1)
680 {
681 if (gdb_notifier.next_poll_fds_index >= gdb_notifier.num_fds)
682 gdb_notifier.next_poll_fds_index = 0;
683 i = gdb_notifier.next_poll_fds_index++;
684
685 gdb_assert (i < gdb_notifier.num_fds);
686 if ((gdb_notifier.poll_fds + i)->revents)
687 break;
688 }
689
690 for (file_ptr = gdb_notifier.first_file_handler;
691 file_ptr != NULL;
692 file_ptr = file_ptr->next_file)
693 {
694 if (file_ptr->fd == (gdb_notifier.poll_fds + i)->fd)
695 break;
696 }
697 gdb_assert (file_ptr != NULL);
698
699 mask = (gdb_notifier.poll_fds + i)->revents;
700 handle_file_event (file_ptr, mask);
701 return 1;
702 #else
703 internal_error (__FILE__, __LINE__,
704 _("use_poll without HAVE_POLL"));
705 #endif /* HAVE_POLL */
706 }
707 else
708 {
709 /* See comment about even source fairness above. */
710 int mask = 0;
711
712 do
713 {
714 file_ptr = get_next_file_handler_to_handle_and_advance ();
715
716 if (FD_ISSET (file_ptr->fd, &gdb_notifier.ready_masks[0]))
717 mask |= GDB_READABLE;
718 if (FD_ISSET (file_ptr->fd, &gdb_notifier.ready_masks[1]))
719 mask |= GDB_WRITABLE;
720 if (FD_ISSET (file_ptr->fd, &gdb_notifier.ready_masks[2]))
721 mask |= GDB_EXCEPTION;
722 }
723 while (mask == 0);
724
725 handle_file_event (file_ptr, mask);
726 return 1;
727 }
728 return 0;
729 }
730 \f
731 /* Create a timer that will expire in MS milliseconds from now. When
732 the timer is ready, PROC will be executed. At creation, the timer
733 is added to the timers queue. This queue is kept sorted in order
734 of increasing timers. Return a handle to the timer struct. */
735
736 int
737 create_timer (int ms, timer_handler_func *proc,
738 gdb_client_data client_data)
739 {
740 using namespace std::chrono;
741 struct gdb_timer *timer_ptr, *timer_index, *prev_timer;
742
743 steady_clock::time_point time_now = steady_clock::now ();
744
745 timer_ptr = new gdb_timer ();
746 timer_ptr->when = time_now + milliseconds (ms);
747 timer_ptr->proc = proc;
748 timer_ptr->client_data = client_data;
749 timer_list.num_timers++;
750 timer_ptr->timer_id = timer_list.num_timers;
751
752 /* Now add the timer to the timer queue, making sure it is sorted in
753 increasing order of expiration. */
754
755 for (timer_index = timer_list.first_timer;
756 timer_index != NULL;
757 timer_index = timer_index->next)
758 {
759 if (timer_index->when > timer_ptr->when)
760 break;
761 }
762
763 if (timer_index == timer_list.first_timer)
764 {
765 timer_ptr->next = timer_list.first_timer;
766 timer_list.first_timer = timer_ptr;
767
768 }
769 else
770 {
771 for (prev_timer = timer_list.first_timer;
772 prev_timer->next != timer_index;
773 prev_timer = prev_timer->next)
774 ;
775
776 prev_timer->next = timer_ptr;
777 timer_ptr->next = timer_index;
778 }
779
780 gdb_notifier.timeout_valid = 0;
781 return timer_ptr->timer_id;
782 }
783
784 /* There is a chance that the creator of the timer wants to get rid of
785 it before it expires. */
786 void
787 delete_timer (int id)
788 {
789 struct gdb_timer *timer_ptr, *prev_timer = NULL;
790
791 /* Find the entry for the given timer. */
792
793 for (timer_ptr = timer_list.first_timer; timer_ptr != NULL;
794 timer_ptr = timer_ptr->next)
795 {
796 if (timer_ptr->timer_id == id)
797 break;
798 }
799
800 if (timer_ptr == NULL)
801 return;
802 /* Get rid of the timer in the timer list. */
803 if (timer_ptr == timer_list.first_timer)
804 timer_list.first_timer = timer_ptr->next;
805 else
806 {
807 for (prev_timer = timer_list.first_timer;
808 prev_timer->next != timer_ptr;
809 prev_timer = prev_timer->next)
810 ;
811 prev_timer->next = timer_ptr->next;
812 }
813 delete timer_ptr;
814
815 gdb_notifier.timeout_valid = 0;
816 }
817
818 /* Convert a std::chrono duration to a struct timeval. */
819
820 template<typename Duration>
821 static struct timeval
822 duration_cast_timeval (const Duration &d)
823 {
824 using namespace std::chrono;
825 seconds sec = duration_cast<seconds> (d);
826 microseconds msec = duration_cast<microseconds> (d - sec);
827
828 struct timeval tv;
829 tv.tv_sec = sec.count ();
830 tv.tv_usec = msec.count ();
831 return tv;
832 }
833
834 /* Update the timeout for the select() or poll(). Returns true if the
835 timer has already expired, false otherwise. */
836
837 static int
838 update_wait_timeout (void)
839 {
840 if (timer_list.first_timer != NULL)
841 {
842 using namespace std::chrono;
843 steady_clock::time_point time_now = steady_clock::now ();
844 struct timeval timeout;
845
846 if (timer_list.first_timer->when < time_now)
847 {
848 /* It expired already. */
849 timeout.tv_sec = 0;
850 timeout.tv_usec = 0;
851 }
852 else
853 {
854 steady_clock::duration d = timer_list.first_timer->when - time_now;
855 timeout = duration_cast_timeval (d);
856 }
857
858 /* Update the timeout for select/ poll. */
859 if (use_poll)
860 {
861 #ifdef HAVE_POLL
862 gdb_notifier.poll_timeout = timeout.tv_sec * 1000;
863 #else
864 internal_error (__FILE__, __LINE__,
865 _("use_poll without HAVE_POLL"));
866 #endif /* HAVE_POLL */
867 }
868 else
869 {
870 gdb_notifier.select_timeout.tv_sec = timeout.tv_sec;
871 gdb_notifier.select_timeout.tv_usec = timeout.tv_usec;
872 }
873 gdb_notifier.timeout_valid = 1;
874
875 if (timer_list.first_timer->when < time_now)
876 return 1;
877 }
878 else
879 gdb_notifier.timeout_valid = 0;
880
881 return 0;
882 }
883
884 /* Check whether a timer in the timers queue is ready. If a timer is
885 ready, call its handler and return. Update the timeout for the
886 select() or poll() as well. Return 1 if an event was handled,
887 otherwise returns 0.*/
888
889 static int
890 poll_timers (void)
891 {
892 if (update_wait_timeout ())
893 {
894 struct gdb_timer *timer_ptr = timer_list.first_timer;
895 timer_handler_func *proc = timer_ptr->proc;
896 gdb_client_data client_data = timer_ptr->client_data;
897
898 /* Get rid of the timer from the beginning of the list. */
899 timer_list.first_timer = timer_ptr->next;
900
901 /* Delete the timer before calling the callback, not after, in
902 case the callback itself decides to try deleting the timer
903 too. */
904 delete timer_ptr;
905
906 /* Call the procedure associated with that timer. */
907 (proc) (client_data);
908
909 return 1;
910 }
911
912 return 0;
913 }