GNUnet 0.21.1
scheduler.c
Go to the documentation of this file.
1/*
2 This file is part of GNUnet
3 Copyright (C) 2009-2017, 2022 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
9
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
26#include "platform.h"
27#include "gnunet_util_lib.h"
28#include "disk.h"
29// DEBUG
30#include <inttypes.h>
31
32#define LOG(kind, ...) GNUNET_log_from (kind, "util-scheduler", __VA_ARGS__)
33
34#define LOG_STRERROR(kind, syscall) GNUNET_log_from_strerror (kind, \
35 "util-scheduler", \
36 syscall)
37
38
39#if HAVE_EXECINFO_H
40#include "execinfo.h"
41
46#define USE_LSOF GNUNET_NO
47
51#define EXECINFO GNUNET_NO
52
56#define DEBUG_FDS GNUNET_NO
57
61#define MAX_TRACE_DEPTH 50
62#endif
63
68#define PROFILE_DELAYS GNUNET_NO
69
74#define DELAY_THRESHOLD GNUNET_TIME_UNIT_SECONDS
75
76
83{
90
97
102
107
108#if (SIGTERM != GNUNET_TERM_SIG)
112 struct GNUNET_SIGNAL_Context *shc_gterm;
113#endif
114
119
124
129};
130
131
136{
141
146
151
156
161
168
172 unsigned int fds_len;
173
180
186
187#if PROFILE_DELAYS
192#endif
193
200
205
210
215
221
226
231
232#if EXECINFO
237 char **backtrace_strings;
238
242 int num_backtrace_strings;
243#endif
244
249};
250
257
258
263{
265
267
272
278
284};
285
286
291{
297
303
309};
310
311
320
325
330
335
340
349
358
364
369
373static struct
375
379static struct
381
388
394
398static unsigned int ready_count;
399
405
411
416
421
427
432
437
438
446void
448 void *new_select_cls)
449{
450 scheduler_select = new_select;
451 scheduler_select_cls = new_select_cls;
452}
453
454
463{
464 if ((p >= 0) && (p < GNUNET_SCHEDULER_PRIORITY_COUNT))
465 return p;
466 GNUNET_assert (0);
467 return 0; /* make compiler happy */
468}
469
470
478{
479 struct GNUNET_SCHEDULER_Task *pos;
480 struct GNUNET_TIME_Absolute now;
482
486 if (NULL != pos)
487 {
488 if (0 != pos->reason)
489 {
490 return now;
491 }
492 else
493 {
494 timeout = pos->timeout;
495 }
496 }
497 for (pos = pending_head; NULL != pos; pos = pos->next)
498 {
499 if (0 != pos->reason)
500 {
501 return now;
502 }
503 else if ((pos->timeout.abs_value_us !=
504 GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us) &&
505 (timeout.abs_value_us > pos->timeout.abs_value_us))
506 {
507 timeout = pos->timeout;
508 }
509 }
510 return timeout;
511}
512
513
514static void
516{
518 {
523 }
524}
525
526
527static void
529{
532 ready_tail[p],
537}
538
539
545static void
547{
549
551 ready_tail[p],
552 task);
553 if (p > work_priority)
556 ready_count++;
557}
558
559
566void
568{
569 struct GNUNET_SCHEDULER_Task *pos;
570
572 "GNUNET_SCHEDULER_shutdown\n");
573 if (NULL != install_parent_control_task)
574 {
577 }
578 if (NULL != shutdown_pipe_task)
579 {
581 shutdown_pipe_task = NULL;
582 }
583 while (NULL != (pos = shutdown_head))
584 {
587 pos);
589 queue_ready_task (pos);
590 }
591}
592
593
599static void
601{
602#if EXECINFO
603 for (unsigned int i = 0; i < t->num_backtrace_strings; i++)
605 "Task %p trace %u: %s\n",
606 t,
607 i,
608 t->backtrace_strings[i]);
609#else
610 (void) t;
611#endif
612}
613
614
620static void
622{
624 "destroying task %p\n",
625 t);
626
627 if (GNUNET_YES == t->own_handles)
628 {
629 for (unsigned int i = 0; i != t->fds_len; ++i)
630 {
631 const struct GNUNET_NETWORK_Handle *fd = t->fds[i].fd;
632 const struct GNUNET_DISK_FileHandle *fh = t->fds[i].fh;
633 if (fd)
634 {
636 (struct GNUNET_NETWORK_Handle *) fd);
637 }
638 if (fh)
639 {
640 // FIXME: on WIN32 this is not enough! A function
641 // GNUNET_DISK_file_free_memory_only would be nice
642 GNUNET_free_nz ((void *) fh);
643 }
644 }
645 }
646 if (t->fds_len > 1)
647 {
649 }
650#if EXECINFO
651 GNUNET_free (t->backtrace_strings);
652#endif
653 GNUNET_free (t);
654}
655
656
661
666static pid_t my_pid;
667
671static void
673{
674 return;
675}
676
677
681static void
683{
684 static char c;
685 int old_errno = errno; /* backup errno */
686
687 if (getpid () != my_pid)
688 _exit (1); /* we have fork'ed since the signal handler was created,
689 * ignore the signal, see https://gnunet.org/vfork discussion */
693 &c, sizeof(c));
694 errno = old_errno;
695}
696
697
698static void
700{
701 struct GNUNET_SCHEDULER_Task *t;
702
703 if (ready_count > 0)
704 return;
705 for (t = pending_head; NULL != t; t = t->next)
706 if (GNUNET_YES == t->lifeness)
707 return;
708 for (t = shutdown_head; NULL != t; t = t->next)
709 if (GNUNET_YES == t->lifeness)
710 return;
711 for (t = pending_timeout_head; NULL != t; t = t->next)
712 if (GNUNET_YES == t->lifeness)
713 return;
714 /* No lifeness! */
716}
717
718
721 struct DriverContext *context);
722
723
724void
726 void *task_cls)
727{
729 struct GNUNET_SCHEDULER_Driver *driver;
730 struct DriverContext context = {
731 .scheduled_head = NULL,
732 .scheduled_tail = NULL,
733 .timeout = GNUNET_TIME_absolute_get ()
734 };
735
737 driver->cls = &context;
740 task_cls,
745 &context));
747 GNUNET_free (driver);
748}
749
750
757const struct GNUNET_SCHEDULER_TaskContext *
759{
760 GNUNET_assert (NULL != active_task);
761 return &tc;
762}
763
764
774unsigned int
776{
777 unsigned int ret;
778
779 GNUNET_assert (NULL != active_task);
781 return ready_count;
784 ret = 0;
785 for (struct GNUNET_SCHEDULER_Task *pos = ready_head[check_priority (p)];
786 NULL != pos;
787 pos = pos->next)
788 ret++;
790 // Don't count the dummy marker
791 ret--;
792 return ret;
793}
794
795
796void
798 const struct GNUNET_NETWORK_Handle *const *read_nh,
799 unsigned int read_nh_len,
800 const struct GNUNET_NETWORK_Handle *const *write_nh,
801 unsigned int write_nh_len,
802 const struct GNUNET_DISK_FileHandle *const *read_fh,
803 unsigned int read_fh_len,
804 const struct GNUNET_DISK_FileHandle *const *write_fh,
805 unsigned int write_fh_len)
806{
807 // FIXME: if we have exactly two network handles / exactly two file handles
808 // and they are equal, we can make one FdInfo with both
809 // GNUNET_SCHEDULER_ET_IN and GNUNET_SCHEDULER_ET_OUT set.
810 struct GNUNET_SCHEDULER_FdInfo *fdi;
811
812 t->fds_len = read_nh_len + write_nh_len + read_fh_len + write_fh_len;
813 if (1 == t->fds_len)
814 {
815 fdi = &t->fdx;
816 t->fds = fdi;
817 if (1 == read_nh_len)
818 {
819 GNUNET_assert (NULL != read_nh);
820 GNUNET_assert (NULL != *read_nh);
821 fdi->fd = *read_nh;
823 fdi->sock = GNUNET_NETWORK_get_fd (*read_nh);
824 t->read_fd = fdi->sock;
825 t->write_fd = -1;
826 }
827 else if (1 == write_nh_len)
828 {
829 GNUNET_assert (NULL != write_nh);
830 GNUNET_assert (NULL != *write_nh);
831 fdi->fd = *write_nh;
833 fdi->sock = GNUNET_NETWORK_get_fd (*write_nh);
834 t->read_fd = -1;
835 t->write_fd = fdi->sock;
836 }
837 else if (1 == read_fh_len)
838 {
839 GNUNET_assert (NULL != read_fh);
840 GNUNET_assert (NULL != *read_fh);
841 fdi->fh = *read_fh;
843 fdi->sock = (*read_fh)->fd; // FIXME: does not work under WIN32
844 t->read_fd = fdi->sock;
845 t->write_fd = -1;
846 }
847 else
848 {
849 GNUNET_assert (NULL != write_fh);
850 GNUNET_assert (NULL != *write_fh);
851 fdi->fh = *write_fh;
853 fdi->sock = (*write_fh)->fd; // FIXME: does not work under WIN32
854 t->read_fd = -1;
855 t->write_fd = fdi->sock;
856 }
857 }
858 else
859 {
861 t->fds = fdi;
862 t->read_fd = -1;
863 t->write_fd = -1;
864 unsigned int i;
865 for (i = 0; i != read_nh_len; ++i)
866 {
867 fdi->fd = read_nh[i];
868 GNUNET_assert (NULL != fdi->fd);
870 fdi->sock = GNUNET_NETWORK_get_fd (read_nh[i]);
871 ++fdi;
872 }
873 for (i = 0; i != write_nh_len; ++i)
874 {
875 fdi->fd = write_nh[i];
876 GNUNET_assert (NULL != fdi->fd);
878 fdi->sock = GNUNET_NETWORK_get_fd (write_nh[i]);
879 ++fdi;
880 }
881 for (i = 0; i != read_fh_len; ++i)
882 {
883 fdi->fh = read_fh[i];
884 GNUNET_assert (NULL != fdi->fh);
886 fdi->sock = (read_fh[i])->fd; // FIXME: does not work under WIN32
887 ++fdi;
888 }
889 for (i = 0; i != write_fh_len; ++i)
890 {
891 fdi->fh = write_fh[i];
892 GNUNET_assert (NULL != fdi->fh);
894 fdi->sock = (write_fh[i])->fd; // FIXME: does not work under WIN32
895 ++fdi;
896 }
897 }
898}
899
900
914static void
916{
917 struct GNUNET_SCHEDULER_FdInfo *fdi;
918 int success = GNUNET_YES;
919
920 for (unsigned int i = 0; i != t->fds_len; ++i)
921 {
922 fdi = &t->fds[i];
924 t,
925 fdi) && success;
927 }
928 if (GNUNET_YES != success)
929 {
931 "driver could not add task\n");
932 }
933}
934
935
936static void
938{
939 (void) cls;
942}
943
944
945static void
947{
948 char c;
949 const struct GNUNET_DISK_FileHandle *pr;
950
951 (void) cls;
952 shutdown_pipe_task = NULL;
956 /* consume the signal */
957 GNUNET_DISK_file_read (pr, &c, sizeof(c));
958 /* mark all active tasks as ready due to shutdown */
962 pr,
964 NULL);
965}
966
967
980void *
982{
984 int is_fd_task;
985 void *ret;
986
988 "canceling task %p\n",
989 task);
990
991 /* scheduler must be running */
993 is_fd_task = (NULL != task->fds);
994 if (is_fd_task)
995 {
996 int del_result = scheduler_driver->del (scheduler_driver->cls, task);
997 if (GNUNET_OK != del_result)
998 {
1000 "driver could not delete task\n");
1001 GNUNET_assert (0);
1002 }
1003 }
1004 if (! task->in_ready_list)
1005 {
1006 if (is_fd_task)
1007 {
1010 task);
1011 }
1012 else if (GNUNET_YES == task->on_shutdown)
1013 {
1016 task);
1017 }
1018 else
1019 {
1022 task);
1023 if (pending_timeout_last == task)
1024 pending_timeout_last = NULL;
1025 }
1026 }
1027 else
1028 {
1029 p = check_priority (task->priority);
1031 ready_tail[p],
1032 task);
1033 ready_count--;
1034 }
1035 ret = task->callback_cls;
1036 destroy_task (task);
1037 return ret;
1038}
1039
1040
1046static void
1048{
1049#if EXECINFO
1050 void *backtrace_array[MAX_TRACE_DEPTH];
1051
1052 t->num_backtrace_strings
1053 = backtrace (backtrace_array, MAX_TRACE_DEPTH);
1054 t->backtrace_strings =
1055 backtrace_symbols (backtrace_array,
1056 t->num_backtrace_strings);
1057 dump_backtrace (t);
1058#else
1059 (void) t;
1060#endif
1061}
1062
1063
1074void
1076 task,
1077 void *task_cls,
1079 reason,
1081 priority)
1082{
1083 struct GNUNET_SCHEDULER_Task *t;
1084
1085 /* scheduler must be running */
1087 GNUNET_assert (NULL != task);
1089 t->read_fd = -1;
1090 t->write_fd = -1;
1091 t->callback = task;
1092 t->callback_cls = task_cls;
1093#if PROFILE_DELAYS
1094 t->start_time = GNUNET_TIME_absolute_get ();
1095#endif
1096 t->reason = reason;
1100 "Adding continuation task %p\n",
1101 t);
1102 init_backtrace (t);
1104}
1105
1106
1118struct GNUNET_SCHEDULER_Task *
1122 void *task_cls)
1123{
1124 struct GNUNET_SCHEDULER_Task *t;
1125 struct GNUNET_SCHEDULER_Task *pos;
1127 struct GNUNET_TIME_Relative left;
1128
1129 /* scheduler must be running */
1131 GNUNET_assert (NULL != task);
1134 t->callback = task;
1135 t->callback_cls = task_cls;
1136 t->read_fd = -1;
1137 t->write_fd = -1;
1138#if PROFILE_DELAYS
1139 t->start_time = GNUNET_TIME_absolute_get ();
1140#endif
1141 t->timeout = at;
1142 t->priority = check_priority (priority);
1144 init_backtrace (t);
1145
1147 if (0 == left.rel_value_us)
1148 {
1150 if (priority > work_priority)
1151 work_priority = priority;
1152 return t;
1153 }
1154
1155 /* try tail first (optimization in case we are
1156 * appending to a long list of tasks with timeouts) */
1157 if ((NULL == pending_timeout_head) ||
1159 {
1162 t);
1163 }
1164 else
1165 {
1166 /* first move from heuristic start backwards to before start time */
1167 prev = pending_timeout_last;
1168 while ((NULL != prev) &&
1170 prev = prev->prev;
1171 /* now, move from heuristic start (or head of list) forward to insertion point */
1172 if (NULL == prev)
1174 else
1175 pos = prev->next;
1176 while ((NULL != pos) && (pos->timeout.abs_value_us <=
1178 {
1179 prev = pos;
1180 pos = pos->next;
1181 }
1184 prev,
1185 t);
1186 }
1187 /* finally, update heuristic insertion point to last insertion... */
1190 "Adding task %p\n",
1191 t);
1192 return t;
1193}
1194
1195
1207struct GNUNET_SCHEDULER_Task *
1210 priority,
1212 void *task_cls)
1213{
1216 priority,
1217 task,
1218 task_cls);
1219}
1220
1221
1231struct GNUNET_SCHEDULER_Task *
1234 void *task_cls)
1235{
1237 prio,
1238 task,
1239 task_cls);
1240}
1241
1242
1254struct GNUNET_SCHEDULER_Task *
1257 void *task_cls)
1258{
1261 task,
1262 task_cls);
1263}
1264
1265
1277struct GNUNET_SCHEDULER_Task *
1280 void *task_cls)
1281{
1284 task,
1285 task_cls);
1286}
1287
1288
1304struct GNUNET_SCHEDULER_Task *
1306 void *task_cls)
1307{
1308 struct GNUNET_SCHEDULER_Task *t;
1309
1312 t->callback = task;
1313 t->callback_cls = task_cls;
1314 t->read_fd = -1;
1315 t->write_fd = -1;
1316#if PROFILE_DELAYS
1317 t->start_time = GNUNET_TIME_absolute_get ();
1318#endif
1324 init_backtrace (t);
1325 return t;
1326}
1327
1328
1339struct GNUNET_SCHEDULER_Task *
1341 void *task_cls)
1342{
1343 struct GNUNET_SCHEDULER_Task *t;
1344
1345 /* scheduler must be running */
1347 GNUNET_assert (NULL != task);
1350 t->callback = task;
1351 t->callback_cls = task_cls;
1352 t->read_fd = -1;
1353 t->write_fd = -1;
1354#if PROFILE_DELAYS
1355 t->start_time = GNUNET_TIME_absolute_get ();
1356#endif
1360 t->lifeness = GNUNET_NO;
1363 t);
1365 "Adding shutdown task %p\n",
1366 t);
1367 init_backtrace (t);
1368 return t;
1369}
1370
1371
1372struct GNUNET_SCHEDULER_Task *
1375 void *task_cls)
1376{
1377 struct GNUNET_SCHEDULER_Task *ret;
1378
1379 ret = GNUNET_SCHEDULER_add_now (task, task_cls);
1380 ret->lifeness = lifeness;
1381 return ret;
1382}
1383
1384
1385#if DEBUG_FDS
1392void
1393check_fd (struct GNUNET_SCHEDULER_Task *t, int raw_fd)
1394{
1395 if (-1 != raw_fd)
1396 {
1397 int flags = fcntl (raw_fd, F_GETFD);
1398
1399 if ((flags == -1) && (errno == EBADF))
1400 {
1402 "Got invalid file descriptor %d!\n",
1403 raw_fd);
1404 init_backtrace (t);
1405 GNUNET_assert (0);
1406 }
1407 }
1408}
1409
1410
1411#endif
1412
1413
1439static struct GNUNET_SCHEDULER_Task *
1442 const struct GNUNET_NETWORK_Handle *read_nh,
1443 const struct GNUNET_NETWORK_Handle *write_nh,
1444 const struct GNUNET_DISK_FileHandle *read_fh,
1445 const struct GNUNET_DISK_FileHandle *write_fh,
1447 void *task_cls)
1448{
1449 struct GNUNET_SCHEDULER_Task *t;
1450
1451 /* scheduler must be running */
1453 GNUNET_assert (NULL != task);
1456 init_fd_info (t,
1457 &read_nh,
1458 read_nh ? 1 : 0,
1459 &write_nh,
1460 write_nh ? 1 : 0,
1461 &read_fh,
1462 read_fh ? 1 : 0,
1463 &write_fh,
1464 write_fh ? 1 : 0);
1465 t->callback = task;
1466 t->callback_cls = task_cls;
1467#if DEBUG_FDS
1468 check_fd (t, NULL != read_nh ? GNUNET_NETWORK_get_fd (read_nh) : -1);
1469 check_fd (t, NULL != write_nh ? GNUNET_NETWORK_get_fd (write_nh) : -1);
1470 check_fd (t, NULL != read_fh ? read_fh->fd : -1);
1471 check_fd (t, NULL != write_fh ? write_fh->fd : -1);
1472#endif
1473#if PROFILE_DELAYS
1474 t->start_time = GNUNET_TIME_absolute_get ();
1475#endif
1482 t);
1485 t->priority);
1486 init_backtrace (t);
1487 return t;
1488}
1489
1490
1511struct GNUNET_SCHEDULER_Task *
1513 struct GNUNET_NETWORK_Handle *rfd,
1515 void *task_cls)
1516{
1519 rfd, task, task_cls);
1520}
1521
1522
1545struct GNUNET_SCHEDULER_Task *
1548 priority,
1549 struct GNUNET_NETWORK_Handle *rfd,
1551 void *task_cls)
1552{
1554 rfd,
1555 GNUNET_YES,
1556 GNUNET_NO,
1557 task, task_cls);
1558}
1559
1560
1582struct GNUNET_SCHEDULER_Task *
1584 struct GNUNET_NETWORK_Handle *wfd,
1586 void *task_cls)
1587{
1590 wfd,
1592 task, task_cls);
1593}
1594
1595
1619struct GNUNET_SCHEDULER_Task *
1622 struct GNUNET_NETWORK_Handle *fd,
1623 int on_read,
1624 int on_write,
1626 void *task_cls)
1627{
1628 /* scheduler must be running */
1630 GNUNET_assert (on_read || on_write);
1632 return add_without_sets (delay, priority,
1633 on_read ? fd : NULL,
1634 on_write ? fd : NULL,
1635 NULL,
1636 NULL,
1637 task, task_cls);
1638}
1639
1640
1661struct GNUNET_SCHEDULER_Task *
1663 const struct GNUNET_DISK_FileHandle *rfd,
1665 void *task_cls)
1666{
1669 rfd, GNUNET_YES, GNUNET_NO,
1670 task, task_cls);
1671}
1672
1673
1694struct GNUNET_SCHEDULER_Task *
1696 const struct GNUNET_DISK_FileHandle *wfd,
1698 void *task_cls)
1699{
1702 wfd, GNUNET_NO, GNUNET_YES,
1703 task, task_cls);
1704}
1705
1706
1730struct GNUNET_SCHEDULER_Task *
1733 priority,
1734 const struct
1736 int on_read, int on_write,
1738 void *task_cls)
1739{
1740 /* scheduler must be running */
1742 GNUNET_assert (on_read || on_write);
1743 GNUNET_assert (fd->fd >= 0);
1744 return add_without_sets (delay, priority,
1745 NULL,
1746 NULL,
1747 on_read ? fd : NULL,
1748 on_write ? fd : NULL,
1749 task, task_cls);
1750}
1751
1752
1753void
1755 const struct GNUNET_NETWORK_Handle ***ntarget,
1756 unsigned int *extracted_nhandles,
1757 const struct GNUNET_DISK_FileHandle ***ftarget,
1758 unsigned int *extracted_fhandles)
1759{
1760 // FIXME: this implementation only works for unix, for WIN32 the file handles
1761 // in fdset must be handled separately
1762 const struct GNUNET_NETWORK_Handle **nhandles;
1763 const struct GNUNET_DISK_FileHandle **fhandles;
1764 unsigned int nhandles_len;
1765 unsigned int fhandles_len;
1766
1767 nhandles = NULL;
1768 fhandles = NULL;
1769 nhandles_len = 0;
1770 fhandles_len = 0;
1771 for (int sock = 0; sock != fdset->nsds; ++sock)
1772 {
1773 if (GNUNET_YES == GNUNET_NETWORK_fdset_test_native (fdset, sock))
1774 {
1775 struct GNUNET_NETWORK_Handle *nhandle;
1776 struct GNUNET_DISK_FileHandle *fhandle;
1777
1778 nhandle = GNUNET_NETWORK_socket_box_native (sock);
1779 if (NULL != nhandle)
1780 {
1781 GNUNET_array_append (nhandles, nhandles_len, nhandle);
1782 }
1783 else
1784 {
1785 fhandle = GNUNET_DISK_get_handle_from_int_fd (sock);
1786 if (NULL != fhandle)
1787 {
1788 GNUNET_array_append (fhandles, fhandles_len, fhandle);
1789 }
1790 else
1791 {
1792 GNUNET_assert (0);
1793 }
1794 }
1795 }
1796 }
1797 *ntarget = nhandles_len > 0 ? nhandles : NULL;
1798 *ftarget = fhandles_len > 0 ? fhandles : NULL;
1799 *extracted_nhandles = nhandles_len;
1800 *extracted_fhandles = fhandles_len;
1801}
1802
1803
1835struct GNUNET_SCHEDULER_Task *
1837 struct GNUNET_TIME_Relative delay,
1838 const struct GNUNET_NETWORK_FDSet *rs,
1839 const struct GNUNET_NETWORK_FDSet *ws,
1841 void *task_cls)
1842{
1843 struct GNUNET_SCHEDULER_Task *t;
1844 const struct GNUNET_NETWORK_Handle **read_nhandles = NULL;
1845 const struct GNUNET_NETWORK_Handle **write_nhandles = NULL;
1846 const struct GNUNET_DISK_FileHandle **read_fhandles = NULL;
1847 const struct GNUNET_DISK_FileHandle **write_fhandles = NULL;
1848 unsigned int read_nhandles_len = 0;
1849 unsigned int write_nhandles_len = 0;
1850 unsigned int read_fhandles_len = 0;
1851 unsigned int write_fhandles_len = 0;
1852
1853 /* scheduler must be running */
1855 GNUNET_assert (NULL != task);
1856 int no_rs = (NULL == rs);
1857 int no_ws = (NULL == ws);
1858 int empty_rs = (NULL != rs) && (0 == rs->nsds);
1859 int empty_ws = (NULL != ws) && (0 == ws->nsds);
1860 int no_fds = (no_rs && no_ws) ||
1861 (empty_rs && empty_ws) ||
1862 (no_rs && empty_ws) ||
1863 (no_ws && empty_rs);
1864 if (! no_fds)
1865 {
1866 if (NULL != rs)
1867 {
1868 extract_handles (rs,
1869 &read_nhandles,
1870 &read_nhandles_len,
1871 &read_fhandles,
1872 &read_fhandles_len);
1873 }
1874 if (NULL != ws)
1875 {
1876 extract_handles (ws,
1877 &write_nhandles,
1878 &write_nhandles_len,
1879 &write_fhandles,
1880 &write_fhandles_len);
1881 }
1882 }int no_fds_extracted = (0 == read_nhandles_len) &&
1890 (0 == read_fhandles_len) &&
1891 (0 == write_nhandles_len) &&
1892 (0 == write_fhandles_len);
1893 if (no_fds || no_fds_extracted)
1895 prio,
1896 task,
1897 task_cls);
1900 init_fd_info (t,
1901 read_nhandles,
1902 read_nhandles_len,
1903 write_nhandles,
1904 write_nhandles_len,
1905 read_fhandles,
1906 read_fhandles_len,
1907 write_fhandles,
1908 write_fhandles_len);
1909 t->callback = task;
1910 t->callback_cls = task_cls;
1912 /* free the arrays of pointers to network / file handles, the actual
1913 * handles will be freed in destroy_task */
1914 GNUNET_array_grow (read_nhandles, read_nhandles_len, 0);
1915 GNUNET_array_grow (write_nhandles, write_nhandles_len, 0);
1916 GNUNET_array_grow (read_fhandles, read_fhandles_len, 0);
1917 GNUNET_array_grow (write_fhandles, write_fhandles_len, 0);
1918#if PROFILE_DELAYS
1919 t->start_time = GNUNET_TIME_absolute_get ();
1920#endif
1922 t->priority =
1923 check_priority ((prio ==
1925 prio);
1929 t);
1932 t->priority);
1934 "Adding task %p\n",
1935 t);
1936 init_backtrace (t);
1937 return t;
1938}
1939
1940
1952void
1954 struct GNUNET_SCHEDULER_FdInfo *fdi)
1955{
1956 enum GNUNET_SCHEDULER_Reason reason;
1957
1958 reason = task->reason;
1959 if ((0 == (reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
1960 (0 != (GNUNET_SCHEDULER_ET_IN & fdi->et)))
1962 if ((0 == (reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
1963 (0 != (GNUNET_SCHEDULER_ET_OUT & fdi->et)))
1966 task->reason = reason;
1967 if (GNUNET_NO == task->in_ready_list)
1968 {
1971 task);
1972 queue_ready_task (task);
1973 }
1974}
1975
1976
1997int
1999{
2000 struct GNUNET_SCHEDULER_Task *pos;
2001 struct GNUNET_TIME_Absolute now;
2002
2003 /* check for tasks that reached the timeout! */
2004 now = GNUNET_TIME_absolute_get ();
2006 while (NULL != pos)
2007 {
2008 struct GNUNET_SCHEDULER_Task *next = pos->next;
2009 if (now.abs_value_us >= pos->timeout.abs_value_us)
2011 if (0 == pos->reason)
2012 break;
2015 pos);
2016 if (pending_timeout_last == pos)
2017 pending_timeout_last = NULL;
2018 queue_ready_task (pos);
2019 pos = next;
2020 }
2021 pos = pending_head;
2022 while (NULL != pos)
2023 {
2024 struct GNUNET_SCHEDULER_Task *next = pos->next;
2025 if (now.abs_value_us >= pos->timeout.abs_value_us)
2026 {
2030 pos);
2031 queue_ready_task (pos);
2032 }
2033 pos = next;
2034 }
2035
2036 if (0 == ready_count)
2037 {
2039
2040 if (timeout.abs_value_us > now.abs_value_us)
2041 {
2056 "GNUNET_SCHEDULER_do_work did not find any ready "
2057 "tasks and timeout has not been reached yet.\n");
2058 }
2059 else
2060 {
2065 GNUNET_assert (0);
2066 }
2067 }
2068 else
2069 {
2070 /* find out which task priority level we are going to
2071 process this time */
2074 /* yes, p>0 is correct, 0 is "KEEP" which should
2075 * always be an empty queue (see assertion)! */
2077 work_priority > 0;
2078 work_priority--)
2079 {
2081 if (NULL != pos)
2082 break;
2083 }
2084 GNUNET_assert (NULL != pos); /* ready_count wrong? */
2085
2086 /* process all *existing* tasks at this priority
2087 level, then yield */
2089 while (NULL != (pos = ready_head[work_priority])
2090 && pos != &pass_end_marker)
2091 {
2094 pos);
2095 ready_count--;
2098 active_task = pos;
2099#if PROFILE_DELAYS
2100 if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value_us >
2101 DELAY_THRESHOLD.rel_value_us)
2102 {
2104 "Task %p took %s to be scheduled\n",
2105 pos,
2107 GNUNET_TIME_absolute_get_duration (pos->start_time),
2108 GNUNET_YES));
2109 }
2110#endif
2111 tc.reason = pos->reason;
2114 // FIXME: do we have to remove FdInfos from fds if they are not ready?
2115 tc.fds_len = pos->fds_len;
2116 tc.fds = pos->fds;
2117 for (unsigned int i = 0; i != pos->fds_len; ++i)
2118 {
2119 struct GNUNET_SCHEDULER_FdInfo *fdi = &pos->fds[i];
2120 if (0 != (GNUNET_SCHEDULER_ET_IN & fdi->et))
2121 {
2123 fdi->sock);
2124 }
2125 if (0 != (GNUNET_SCHEDULER_ET_OUT & fdi->et))
2126 {
2128 fdi->sock);
2129 }
2130 }
2131 tc.read_ready = sh->rs;
2132 tc.write_ready = sh->ws;
2134 "Running task %p\n",
2135 pos);
2136 GNUNET_assert (NULL != pos->callback);
2137 {
2138 struct GNUNET_AsyncScopeSave old_scope;
2139 if (pos->scope.have_scope)
2140 GNUNET_async_scope_enter (&pos->scope.scope_id, &old_scope);
2141 else
2142 GNUNET_async_scope_get (&old_scope);
2143 pos->callback (pos->callback_cls);
2144 GNUNET_async_scope_restore (&old_scope);
2145 }
2146 if (NULL != pos->fds)
2147 {
2148 int del_result = scheduler_driver->del (scheduler_driver->cls,
2149 pos);
2150 if (GNUNET_OK != del_result)
2151 {
2153 "driver could not delete task %p\n", pos);
2154 GNUNET_assert (0);
2155 }
2156 }
2157 active_task = NULL;
2158 dump_backtrace (pos);
2159 destroy_task (pos);
2160 }
2162 }
2164 if (0 == ready_count)
2165 {
2167 get_timeout ());
2168 return GNUNET_NO;
2169 }
2172 return GNUNET_YES;
2173}
2174
2175
2209{
2211 const struct GNUNET_DISK_FileHandle *pr;
2212
2213 /* scheduler must not be running */
2216 /* general set-up */
2222 my_pid = getpid ();
2223 scheduler_driver = driver;
2224
2225 /* install signal handlers */
2227 "Registering signal handlers\n");
2228 sh->shc_int = GNUNET_SIGNAL_handler_install (SIGINT,
2230 sh->shc_term = GNUNET_SIGNAL_handler_install (SIGTERM,
2232#if (SIGTERM != GNUNET_TERM_SIG)
2235#endif
2236 sh->shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE,
2238 sh->shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT,
2240 sh->shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP,
2242
2243 /* Setup initial tasks */
2246 /* ensure this task runs first, by using a priority level reserved for
2247 the scheduler (not really shutdown, but start-up ;-) */
2251 NULL);
2254 pr,
2256 NULL);
2259 get_timeout ());
2260 /* begin main event loop */
2264 return sh;
2265}
2266
2267
2282void
2284{
2285 GNUNET_break (NULL == pending_head);
2287 GNUNET_break (NULL == shutdown_head);
2288 for (int i = 0; i != GNUNET_SCHEDULER_PRIORITY_COUNT; ++i)
2289 {
2290 GNUNET_break (NULL == ready_head[i]);
2291 }
2294
2295 /* uninstall signal handlers */
2298#if (SIGTERM != GNUNET_TERM_SIG)
2300#endif
2305 shutdown_pipe_handle = NULL;
2306 scheduler_driver = NULL;
2307 GNUNET_free (sh);
2308}
2309
2310
2311static enum GNUNET_GenericReturnValue
2313 struct DriverContext *context)
2314{
2315 struct GNUNET_NETWORK_FDSet *rs;
2316 struct GNUNET_NETWORK_FDSet *ws;
2317 int select_result;
2318
2319 GNUNET_assert (NULL != context);
2322 while ((NULL != context->scheduled_head) ||
2323 (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us !=
2324 context->timeout.abs_value_us))
2325 {
2326 struct GNUNET_TIME_Relative time_remaining;
2327
2329 "select timeout = %s\n",
2331
2334
2335 for (struct Scheduled *pos = context->scheduled_head;
2336 NULL != pos;
2337 pos = pos->next)
2338 {
2339 if (0 != (GNUNET_SCHEDULER_ET_IN & pos->et))
2340 {
2341 GNUNET_NETWORK_fdset_set_native (rs, pos->fdi->sock);
2342 }
2343 if (0 != (GNUNET_SCHEDULER_ET_OUT & pos->et))
2344 {
2345 GNUNET_NETWORK_fdset_set_native (ws, pos->fdi->sock);
2346 }
2347 }
2348 time_remaining = GNUNET_TIME_absolute_get_remaining (context->timeout);
2349 if (0 < ready_count)
2350 time_remaining = GNUNET_TIME_UNIT_ZERO;
2351 if (NULL == scheduler_select)
2352 {
2353 select_result = GNUNET_NETWORK_socket_select (rs,
2354 ws,
2355 NULL,
2356 time_remaining);
2357 }
2358 else
2359 {
2360 select_result = scheduler_select (scheduler_select_cls,
2361 rs,
2362 ws,
2363 NULL,
2364 time_remaining);
2365 }
2366 if (select_result == GNUNET_SYSERR)
2367 {
2368 if (errno == EINTR)
2369 continue;
2370
2372 "select");
2373#if USE_LSOF
2374 char lsof[512];
2375
2376 snprintf (lsof,
2377 sizeof(lsof),
2378 "lsof -p %d",
2379 getpid ());
2380 (void) close (1);
2381 (void) dup2 (2, 1);
2382 if (0 != system (lsof))
2384 "system");
2385#endif
2386#if DEBUG_FDS
2387 for (struct Scheduled *s = context->scheduled_head;
2388 NULL != s;
2389 s = s->next)
2390 {
2391 int flags = fcntl (s->fdi->sock,
2392 F_GETFD);
2393
2394 if ((flags == -1) &&
2395 (EBADF == errno))
2396 {
2398 "Got invalid file descriptor %d!\n",
2399 s->fdi->sock);
2400#if EXECINFO
2401 dump_backtrace (s->task);
2402#endif
2403 }
2404 }
2405#endif
2406 GNUNET_assert (0);
2409 return GNUNET_SYSERR;
2410 }
2411 if (select_result > 0)
2412 {
2413 for (struct Scheduled *pos = context->scheduled_head;
2414 NULL != pos;
2415 pos = pos->next)
2416 {
2417 int is_ready = GNUNET_NO;
2418
2419 if ((0 != (GNUNET_SCHEDULER_ET_IN & pos->et)) &&
2420 (GNUNET_YES ==
2422 pos->fdi->sock)) )
2423 {
2424 pos->fdi->et |= GNUNET_SCHEDULER_ET_IN;
2425 is_ready = GNUNET_YES;
2426 }
2427 if ((0 != (GNUNET_SCHEDULER_ET_OUT & pos->et)) &&
2428 (GNUNET_YES ==
2430 pos->fdi->sock)) )
2431 {
2432 pos->fdi->et |= GNUNET_SCHEDULER_ET_OUT;
2433 is_ready = GNUNET_YES;
2434 }
2435 if (GNUNET_YES == is_ready)
2436 {
2437 GNUNET_SCHEDULER_task_ready (pos->task,
2438 pos->fdi);
2439 }
2440 }
2441 }
2443 {
2445 "scheduler has more tasks ready!\n");
2446 }
2447 }
2450
2451 if ( (NULL == context->scheduled_head) &&
2452 (NULL != pending_timeout_head) &&
2453 (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us ==
2454 context->timeout.abs_value_us) )
2455 {
2456 /* Only remaining task has timeout of 'forever'.
2457 We exit here more as sanity measure, as just
2458 waiting forever isn't exactly useful. Still,
2459 this is indicative of a bug in the client code. */
2460 GNUNET_break (0);
2461 return GNUNET_NO;
2462 }
2463 return GNUNET_OK;
2464}
2465
2466
2467static int
2468select_add (void *cls,
2469 struct GNUNET_SCHEDULER_Task *task,
2470 struct GNUNET_SCHEDULER_FdInfo *fdi)
2471{
2472 struct DriverContext *context = cls;
2473
2474 GNUNET_assert (NULL != context);
2475 GNUNET_assert (NULL != task);
2476 GNUNET_assert (NULL != fdi);
2477 GNUNET_assert (0 != (GNUNET_SCHEDULER_ET_IN & fdi->et) ||
2478 0 != (GNUNET_SCHEDULER_ET_OUT & fdi->et));
2479
2480 if (! ((NULL != fdi->fd) ^ (NULL != fdi->fh)) || (fdi->sock < 0))
2481 {
2482 /* exactly one out of {fd, hf} must be != NULL and the OS handle must be valid */
2483 return GNUNET_SYSERR;
2484 }
2485
2486 struct Scheduled *scheduled = GNUNET_new (struct Scheduled);
2487 scheduled->task = task;
2488 scheduled->fdi = fdi;
2489 scheduled->et = fdi->et;
2490
2491 GNUNET_CONTAINER_DLL_insert (context->scheduled_head,
2492 context->scheduled_tail,
2493 scheduled);
2494 return GNUNET_OK;
2495}
2496
2497
2498static int
2499select_del (void *cls,
2501{
2502 struct DriverContext *context;
2503 struct Scheduled *pos;
2504 int ret;
2505
2506 GNUNET_assert (NULL != cls);
2507
2508 context = cls;
2510 pos = context->scheduled_head;
2511 while (NULL != pos)
2512 {
2513 struct Scheduled *next = pos->next;
2514 if (pos->task == task)
2515 {
2516 GNUNET_CONTAINER_DLL_remove (context->scheduled_head,
2517 context->scheduled_tail,
2518 pos);
2519 GNUNET_free (pos);
2520 ret = GNUNET_OK;
2521 }
2522 pos = next;
2523 }
2524 return ret;
2525}
2526
2527
2528static void
2530 struct GNUNET_TIME_Absolute dt)
2531{
2532 struct DriverContext *context = cls;
2533
2534 GNUNET_assert (NULL != context);
2535 context->timeout = dt;
2536}
2537
2538
2546{
2547 struct GNUNET_SCHEDULER_Driver *select_driver;
2548
2549 select_driver = GNUNET_new (struct GNUNET_SCHEDULER_Driver);
2550
2551 select_driver->add = &select_add;
2552 select_driver->del = &select_del;
2553 select_driver->set_wakeup = &select_set_wakeup;
2554
2555 return select_driver;
2556}
2557
2558
2571void
2573{
2574 struct GNUNET_AsyncScopeSave dummy_old_scope;
2575
2576 GNUNET_assert (NULL != active_task);
2577 /* Since we're in a task, the context will be automatically
2578 restored by the scheduler. */
2579 GNUNET_async_scope_enter (aid, &dummy_old_scope);
2580}
2581
2582
2583/* end of scheduler.c */
Internal DISK related helper functions.
static int ret
Final status code.
Definition: gnunet-arm.c:94
static struct GNUNET_TIME_Relative timeout
User defined timestamp for completing operations.
Definition: gnunet-arm.c:119
static struct GNUNET_TIME_Absolute start_time
Start time of the current round; used to determine how long one iteration takes (which influences how...
static pa_context * context
Pulseaudio context.
static struct GNUNET_IDENTITY_Handle * sh
Handle to IDENTITY service.
static struct GNUNET_DISK_FileHandle * fh
File handle to STDIN, for reading restart/quit commands.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-uri.c:38
static struct GNUNET_SCHEDULER_Task * t
Main task.
const struct GNUNET_DISK_FileHandle * GNUNET_DISK_pipe_handle(const struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd n)
Get the handle to a particular pipe end.
Definition: disk.c:1617
ssize_t GNUNET_DISK_file_write(const struct GNUNET_DISK_FileHandle *h, const void *buffer, size_t n)
Write a buffer to a file.
Definition: disk.c:686
struct GNUNET_DISK_PipeHandle * GNUNET_DISK_pipe(enum GNUNET_DISK_PipeFlags pf)
Creates an interprocess channel.
Definition: disk.c:1444
enum GNUNET_GenericReturnValue GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:1587
enum GNUNET_GenericReturnValue GNUNET_DISK_handle_invalid(const struct GNUNET_DISK_FileHandle *h)
Checks whether a handle is invalid.
Definition: disk.c:185
struct GNUNET_DISK_FileHandle * GNUNET_DISK_get_handle_from_int_fd(int fno)
Get a handle from a native integer FD.
Definition: disk.c:1330
ssize_t GNUNET_DISK_file_read(const struct GNUNET_DISK_FileHandle *h, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:622
@ GNUNET_DISK_PF_NONE
No special options, use non-blocking read/write operations.
@ GNUNET_DISK_PIPE_END_WRITE
The writing-end of a pipe.
@ GNUNET_DISK_PIPE_END_READ
The reading-end of a pipe.
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
#define GNUNET_CONTAINER_DLL_insert_after(head, tail, other, element)
Insert an element into a DLL after the given other element.
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
#define GNUNET_MAX(a, b)
GNUNET_SCHEDULER_Priority
Valid task priorities.
void GNUNET_async_scope_enter(const struct GNUNET_AsyncScopeId *aid, struct GNUNET_AsyncScopeSave *old_scope)
Set the async scope for the current thread.
void GNUNET_async_scope_get(struct GNUNET_AsyncScopeSave *scope_ret)
Get the current async scope.
void GNUNET_async_scope_restore(struct GNUNET_AsyncScopeSave *old_scope)
Clear the current thread's async scope.
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_SCHEDULER_PRIORITY_COUNT
Number of priorities (must be the last priority).
@ GNUNET_SCHEDULER_PRIORITY_KEEP
Run with the same priority as the current job.
@ GNUNET_SCHEDULER_PRIORITY_DEFAULT
Run with the default priority (normal P2P operations).
@ GNUNET_SCHEDULER_PRIORITY_SHUTDOWN
This is an internal priority level that is only used for tasks that are being triggered due to shutdo...
@ GNUNET_OK
@ GNUNET_YES
@ GNUNET_NO
@ GNUNET_SYSERR
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_array_grow(arr, size, tsize)
Grow a well-typed (!) array.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_new_array(n, type)
Allocate a size n array with structs or unions of the given type.
#define GNUNET_array_append(arr, len, element)
Append an element to an array (growing the array by one).
#define GNUNET_free(ptr)
Wrapper around free.
#define GNUNET_free_nz(ptr)
Wrapper around free.
void GNUNET_NETWORK_fdset_zero(struct GNUNET_NETWORK_FDSet *fds)
Reset FD set (clears all file descriptors).
Definition: network.c:917
void GNUNET_NETWORK_fdset_destroy(struct GNUNET_NETWORK_FDSet *fds)
Releases the associated memory of an fd set.
Definition: network.c:1186
int GNUNET_NETWORK_get_fd(const struct GNUNET_NETWORK_Handle *desc)
Return file descriptor for this network handle.
Definition: network.c:1000
struct GNUNET_NETWORK_FDSet * GNUNET_NETWORK_fdset_create(void)
Creates an fd set.
Definition: network.c:1170
struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_box_native(int fd)
Box a native socket (and check that it is a socket).
Definition: network.c:579
void GNUNET_NETWORK_fdset_set_native(struct GNUNET_NETWORK_FDSet *to, int nfd)
Set a native fd in a set.
Definition: network.c:1057
int GNUNET_NETWORK_fdset_test_native(const struct GNUNET_NETWORK_FDSet *to, int nfd)
Test native fd in a set.
Definition: network.c:1075
void GNUNET_NETWORK_socket_free_memory_only_(struct GNUNET_NETWORK_Handle *desc)
Only free memory of a socket, keep the file descriptor untouched.
Definition: network.c:565
int GNUNET_NETWORK_socket_select(struct GNUNET_NETWORK_FDSet *rfds, struct GNUNET_NETWORK_FDSet *wfds, struct GNUNET_NETWORK_FDSet *efds, struct GNUNET_TIME_Relative timeout)
Check if sockets meet certain conditions.
Definition: network.c:1260
void GNUNET_NETWORK_fdset_handle_set(struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_DISK_FileHandle *h)
Add a file handle to the fd set.
Definition: network.c:1091
void GNUNET_OS_install_parent_control_handler(void *cls)
Connects this process to its parent via pipe; essentially, the parent control handler will read signa...
Definition: os_priority.c:133
void GNUNET_SCHEDULER_shutdown()
Request the shutdown of a scheduler.
Definition: scheduler.c:567
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_net(struct GNUNET_TIME_Relative delay, struct GNUNET_NETWORK_Handle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1512
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now_with_lifeness(int lifeness, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible with the (transitive) ignore-shutdown flag either e...
Definition: scheduler.c:1373
void GNUNET_SCHEDULER_run(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Initialize and run scheduler.
Definition: scheduler.c:725
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_write_file(struct GNUNET_TIME_Relative delay, const struct GNUNET_DISK_FileHandle *wfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1695
void GNUNET_SCHEDULER_driver_done(struct GNUNET_SCHEDULER_Handle *sh)
Counter-part of GNUNET_SCHEDULER_driver_init.
Definition: scheduler.c:2283
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_net_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, struct GNUNET_NETWORK_Handle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified priority and to be run after the specified delay or wh...
Definition: scheduler.c:1546
void GNUNET_SCHEDULER_task_ready(struct GNUNET_SCHEDULER_Task *task, struct GNUNET_SCHEDULER_FdInfo *fdi)
Function used by event-loop implementations to signal the scheduler that a particular task is ready d...
Definition: scheduler.c:1953
void GNUNET_SCHEDULER_add_with_reason_and_priority(GNUNET_SCHEDULER_TaskCallback task, void *task_cls, enum GNUNET_SCHEDULER_Reason reason, enum GNUNET_SCHEDULER_Priority priority)
Continue the current execution with the given function.
Definition: scheduler.c:1075
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_file(struct GNUNET_TIME_Relative delay, const struct GNUNET_DISK_FileHandle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1662
int GNUNET_SCHEDULER_do_work(struct GNUNET_SCHEDULER_Handle *sh)
Function called by external event loop implementations to tell the scheduler to run some of the tasks...
Definition: scheduler.c:1998
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_write_net(struct GNUNET_TIME_Relative delay, struct GNUNET_NETWORK_Handle *wfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1583
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_select(enum GNUNET_SCHEDULER_Priority prio, struct GNUNET_TIME_Relative delay, const struct GNUNET_NETWORK_FDSet *rs, const struct GNUNET_NETWORK_FDSet *ws, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when any of the specified file descriptor set...
Definition: scheduler.c:1836
unsigned int GNUNET_SCHEDULER_get_load(enum GNUNET_SCHEDULER_Priority p)
Get information about the current load of this scheduler.
Definition: scheduler.c:775
const struct GNUNET_SCHEDULER_TaskContext * GNUNET_SCHEDULER_get_task_context()
Obtain the task context, giving the reason why the current task was started.
Definition: scheduler.c:758
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_file_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, const struct GNUNET_DISK_FileHandle *fd, int on_read, int on_write, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready.
Definition: scheduler.c:1731
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_at(struct GNUNET_TIME_Absolute at, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run at the specified time.
Definition: scheduler.c:1255
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received,...
Definition: scheduler.c:1340
struct GNUNET_SCHEDULER_Driver * GNUNET_SCHEDULER_driver_select()
Obtain the driver for using select() as the event loop.
Definition: scheduler.c:2545
void GNUNET_SCHEDULER_begin_async_scope(struct GNUNET_AsyncScopeId *aid)
Change the async scope for the currently executing task and (transitively) for all tasks scheduled by...
Definition: scheduler.c:2572
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:981
void GNUNET_SCHEDULER_set_select(GNUNET_SCHEDULER_select new_select, void *new_select_cls)
Sets the select function to use in the scheduler (scheduler_select).
Definition: scheduler.c:447
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1305
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_net_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, struct GNUNET_NETWORK_Handle *fd, int on_read, int on_write, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready.
Definition: scheduler.c:1620
GNUNET_SCHEDULER_Reason
Reasons why the schedule may have triggered the task now.
void(* GNUNET_SCHEDULER_TaskCallback)(void *cls)
Signature of the main function of a task.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1278
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1208
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_at_with_priority(struct GNUNET_TIME_Absolute at, enum GNUNET_SCHEDULER_Priority priority, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run at the specified time.
Definition: scheduler.c:1119
struct GNUNET_SCHEDULER_Handle * GNUNET_SCHEDULER_driver_init(const struct GNUNET_SCHEDULER_Driver *driver)
Function called by external event loop implementations to initialize the scheduler.
Definition: scheduler.c:2208
GNUNET_SCHEDULER_EventType
Possible events on FDs, used as a bitmask.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_with_priority(enum GNUNET_SCHEDULER_Priority prio, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified priority.
Definition: scheduler.c:1232
int(* GNUNET_SCHEDULER_select)(void *cls, struct GNUNET_NETWORK_FDSet *rfds, struct GNUNET_NETWORK_FDSet *wfds, struct GNUNET_NETWORK_FDSet *efds, struct GNUNET_TIME_Relative timeout)
Signature of the select function used by the scheduler.
@ GNUNET_SCHEDULER_REASON_TIMEOUT
The specified timeout has expired.
@ GNUNET_SCHEDULER_REASON_READ_READY
The reading socket is ready.
@ GNUNET_SCHEDULER_REASON_SHUTDOWN
We are shutting down and are running all shutdown-related tasks.
@ GNUNET_SCHEDULER_REASON_STARTUP
This is the very first task run during startup.
@ GNUNET_SCHEDULER_REASON_WRITE_READY
The writing socket is ready.
@ GNUNET_SCHEDULER_REASON_PREREQ_DONE
The prerequisite task is done.
@ GNUNET_SCHEDULER_ET_OUT
Buffer available for writing.
@ GNUNET_SCHEDULER_ET_NONE
No event (useful for timeout).
@ GNUNET_SCHEDULER_ET_IN
Data available for reading.
struct GNUNET_SIGNAL_Context * GNUNET_SIGNAL_handler_install(int signal, GNUNET_SIGNAL_Handler handler)
Install a signal handler that will be run if the given signal is received.
Definition: signal.c:52
void GNUNET_SIGNAL_handler_uninstall(struct GNUNET_SIGNAL_Context *ctx)
Uninstall a previously installed signal handler.
Definition: signal.c:78
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:436
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:405
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:570
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:111
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:316
#define GNUNET_TIME_UNIT_ZERO
Relative time zero.
#define GNUNET_TIME_UNIT_ZERO_ABS
Absolute time zero.
const char * GNUNET_STRINGS_absolute_time_to_string(struct GNUNET_TIME_Absolute t)
Like asctime, except for GNUnet time.
Definition: strings.c:617
#define GNUNET_TIME_UNIT_FOREVER_ABS
Constant used to specify "forever".
#define GNUNET_TERM_SIG
The termination signal.
Definition: platform.h:234
static void sighandler_pipe()
Signal handler called for SIGPIPE.
Definition: scheduler.c:672
static void dump_backtrace(struct GNUNET_SCHEDULER_Task *t)
Output stack trace of task t.
Definition: scheduler.c:600
static void driver_add_multiple(struct GNUNET_SCHEDULER_Task *t)
calls the given function func on each FdInfo related to t.
Definition: scheduler.c:915
static struct GNUNET_SCHEDULER_Task * shutdown_pipe_task
Task for reading from a pipe that signal handlers will use to initiate shutdown.
Definition: scheduler.c:393
static void select_set_wakeup(void *cls, struct GNUNET_TIME_Absolute dt)
Definition: scheduler.c:2529
static void destroy_task(struct GNUNET_SCHEDULER_Task *t)
Destroy a task (release associated resources)
Definition: scheduler.c:621
static enum GNUNET_SCHEDULER_Priority check_priority(enum GNUNET_SCHEDULER_Priority p)
Check that the given priority is legal (and return it).
Definition: scheduler.c:462
static void queue_ready_task(struct GNUNET_SCHEDULER_Task *task)
Put a task that is ready for execution into the ready queue.
Definition: scheduler.c:546
static int select_del(void *cls, struct GNUNET_SCHEDULER_Task *task)
Definition: scheduler.c:2499
static struct GNUNET_SCHEDULER_Task * install_parent_control_task
Task for installing parent control handlers (it might happen that the scheduler is shutdown before th...
Definition: scheduler.c:387
static struct GNUNET_SCHEDULER_Task * active_task
ID of the task that is running right now.
Definition: scheduler.c:368
static struct GNUNET_SCHEDULER_Task * ready_tail[GNUNET_SCHEDULER_PRIORITY_COUNT]
Tail of list of tasks ready to run right now, grouped by importance.
Definition: scheduler.c:379
static enum GNUNET_SCHEDULER_Priority current_priority
Priority of the task running right now.
Definition: scheduler.c:404
static struct GNUNET_SCHEDULER_Task * pending_head
Head of list of tasks waiting for an event.
Definition: scheduler.c:324
static void remove_pass_end_marker()
Definition: scheduler.c:515
#define DELAY_THRESHOLD
Task that were in the queue for longer than this are reported if PROFILE_DELAYS is active.
Definition: scheduler.c:74
void init_fd_info(struct GNUNET_SCHEDULER_Task *t, const struct GNUNET_NETWORK_Handle *const *read_nh, unsigned int read_nh_len, const struct GNUNET_NETWORK_Handle *const *write_nh, unsigned int write_nh_len, const struct GNUNET_DISK_FileHandle *const *read_fh, unsigned int read_fh_len, const struct GNUNET_DISK_FileHandle *const *write_fh, unsigned int write_fh_len)
Definition: scheduler.c:797
static unsigned int ready_count
Number of tasks on the ready list.
Definition: scheduler.c:398
static struct GNUNET_DISK_PipeHandle * shutdown_pipe_handle
Pipe used to communicate shutdown via signal.
Definition: scheduler.c:660
struct GNUNET_TIME_Absolute get_timeout()
chooses the nearest timeout from all pending tasks, to be used to tell the driver the next wakeup tim...
Definition: scheduler.c:477
static const struct GNUNET_SCHEDULER_Driver * scheduler_driver
The driver used for the event loop.
Definition: scheduler.c:319
void extract_handles(const struct GNUNET_NETWORK_FDSet *fdset, const struct GNUNET_NETWORK_Handle ***ntarget, unsigned int *extracted_nhandles, const struct GNUNET_DISK_FileHandle ***ftarget, unsigned int *extracted_fhandles)
Definition: scheduler.c:1754
static struct GNUNET_SCHEDULER_Task * pending_timeout_head
List of tasks waiting ONLY for a timeout event.
Definition: scheduler.c:348
static void install_parent_control_handler(void *cls)
Definition: scheduler.c:937
static int select_add(void *cls, struct GNUNET_SCHEDULER_Task *task, struct GNUNET_SCHEDULER_FdInfo *fdi)
Definition: scheduler.c:2468
static GNUNET_SCHEDULER_select scheduler_select
Function to use as a select() in the scheduler.
Definition: scheduler.c:426
static enum GNUNET_SCHEDULER_Priority work_priority
Priority used currently in GNUNET_SCHEDULER_do_work().
Definition: scheduler.c:420
static void shutdown_if_no_lifeness(void)
Definition: scheduler.c:699
static void * scheduler_select_cls
Closure for scheduler_select.
Definition: scheduler.c:436
static struct GNUNET_SCHEDULER_Task * pending_timeout_tail
List of tasks waiting ONLY for a timeout event.
Definition: scheduler.c:357
static struct GNUNET_SCHEDULER_Task * ready_head[GNUNET_SCHEDULER_PRIORITY_COUNT]
Head of list of tasks ready to run right now, grouped by importance.
Definition: scheduler.c:373
static struct GNUNET_SCHEDULER_Task pass_end_marker
Placed at the end of a ready queue to indicate where a scheduler run pass ends.
Definition: scheduler.c:256
static struct GNUNET_SCHEDULER_Task * add_without_sets(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, const struct GNUNET_NETWORK_Handle *read_nh, const struct GNUNET_NETWORK_Handle *write_nh, const struct GNUNET_DISK_FileHandle *read_fh, const struct GNUNET_DISK_FileHandle *write_fh, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when any of the specified file descriptor set...
Definition: scheduler.c:1440
static int current_lifeness
Value of the 'lifeness' flag for the current task.
Definition: scheduler.c:415
static void set_work_priority(enum GNUNET_SCHEDULER_Priority p)
Definition: scheduler.c:528
static void init_backtrace(struct GNUNET_SCHEDULER_Task *t)
Initialize backtrace data for task t.
Definition: scheduler.c:1047
static enum GNUNET_SCHEDULER_Priority max_priority_added
Priority of the highest task added in the current select iteration.
Definition: scheduler.c:410
static struct GNUNET_SCHEDULER_Task * pending_timeout_last
Last inserted task waiting ONLY for a timeout event.
Definition: scheduler.c:363
static void sighandler_shutdown(void)
Signal handler called for signals that should cause us to shutdown.
Definition: scheduler.c:682
#define LOG(kind,...)
Definition: scheduler.c:32
static void shutdown_pipe_cb(void *cls)
Definition: scheduler.c:946
#define LOG_STRERROR(kind, syscall)
Definition: scheduler.c:34
static enum GNUNET_GenericReturnValue select_loop(struct GNUNET_SCHEDULER_Handle *sh, struct DriverContext *context)
Definition: scheduler.c:2312
static struct GNUNET_SCHEDULER_Task * pending_tail
Tail of list of tasks waiting for an event.
Definition: scheduler.c:329
static struct GNUNET_SCHEDULER_Task * shutdown_tail
Tail of list of tasks waiting for shutdown.
Definition: scheduler.c:339
static struct GNUNET_SCHEDULER_TaskContext tc
Task context of the current task.
Definition: scheduler.c:431
static struct GNUNET_SCHEDULER_Task * shutdown_head
Head of list of tasks waiting for shutdown.
Definition: scheduler.c:334
static pid_t my_pid
Process ID of this process at the time we installed the various signal handlers.
Definition: scheduler.c:666
Driver context used by GNUNET_SCHEDULER_run.
Definition: scheduler.c:291
struct Scheduled * scheduled_head
the head of a DLL containing information about the events the select driver is waiting for
Definition: scheduler.c:296
struct GNUNET_TIME_Absolute timeout
the time when the select driver will wake up again (after calling select)
Definition: scheduler.c:308
struct Scheduled * scheduled_tail
the tail of a DLL containing information about the events the select driver is waiting for
Definition: scheduler.c:302
Identifier for an asynchronous execution context.
Saved async scope identifier or root scope.
int have_scope
GNUNET_YES unless this saved scope is the unnamed root scope.
struct GNUNET_AsyncScopeId scope_id
Saved scope.
Handle used to access files (and pipes).
int fd
File handle on Unix-like systems.
Handle used to manage a pipe.
Definition: disk.c:68
collection of IO descriptors
int nsds
Maximum number of any socket descriptor in the set (plus one)
handle to a socket
Definition: network.c:53
API an external event loop has to implement for GNUNET_SCHEDULER_driver_init.
void * cls
Closure to pass to the functions in this struct.
int(* add)(void *cls, struct GNUNET_SCHEDULER_Task *task, struct GNUNET_SCHEDULER_FdInfo *fdi)
Add a task to be run if the conditions specified in the et field of the given fdi are satisfied.
void(* set_wakeup)(void *cls, struct GNUNET_TIME_Absolute dt)
Set time at which we definitively want to get a wakeup call.
int(* del)(void *cls, struct GNUNET_SCHEDULER_Task *task)
Delete a task from the set of tasks to be run.
Information about an event relating to a file descriptor/socket.
int sock
Underlying OS handle the event was about.
enum GNUNET_SCHEDULER_EventType et
Type of the event that was generated related to sock.
const struct GNUNET_DISK_FileHandle * fh
GNUnet file handle the event is about, matches sock, NULL if this is about a network socket or if no ...
const struct GNUNET_NETWORK_Handle * fd
GNUnet network socket the event is about, matches sock, NULL if this is about a file handle or if no ...
Argument to be passed from the driver to GNUNET_SCHEDULER_do_work().
Definition: scheduler.c:83
struct GNUNET_NETWORK_FDSet * rs
Passed here to avoid constantly allocating/deallocating this element, but generally we want to get ri...
Definition: scheduler.c:89
struct GNUNET_SIGNAL_Context * shc_quit
context of the SIGQUIT handler
Definition: scheduler.c:118
struct GNUNET_SIGNAL_Context * shc_hup
context of the SIGHUP handler
Definition: scheduler.c:123
struct GNUNET_SIGNAL_Context * shc_int
context of the SIGINT handler
Definition: scheduler.c:101
struct GNUNET_SIGNAL_Context * shc_pipe
context of the SIGPIPE handler
Definition: scheduler.c:128
struct GNUNET_NETWORK_FDSet * ws
Passed here to avoid constantly allocating/deallocating this element, but generally we want to get ri...
Definition: scheduler.c:96
struct GNUNET_SIGNAL_Context * shc_term
context of the SIGTERM handler
Definition: scheduler.c:106
Context information passed to each scheduler task.
const struct GNUNET_NETWORK_FDSet * read_ready
Set of file descriptors ready for reading; note that additional bits may be set that were not in the ...
enum GNUNET_SCHEDULER_Reason reason
Reason why the task is run now.
unsigned int fds_len
Length of the following array.
const struct GNUNET_SCHEDULER_FdInfo * fds
Array of length fds_len with information about ready FDs.
const struct GNUNET_NETWORK_FDSet * write_ready
Set of file descriptors ready for writing; note that additional bits may be set that were not in the ...
Entry in list of pending tasks.
Definition: scheduler.c:136
enum GNUNET_SCHEDULER_Priority priority
Task priority.
Definition: scheduler.c:204
struct GNUNET_SCHEDULER_Task * prev
This is a linked list.
Definition: scheduler.c:145
void * callback_cls
Closure for the callback.
Definition: scheduler.c:155
int in_ready_list
Is this task in the ready list?
Definition: scheduler.c:230
int lifeness
Should the existence of this task in the queue be counted as reason to not shutdown the scheduler?
Definition: scheduler.c:220
enum GNUNET_SCHEDULER_Reason reason
Why is the task ready? Set after task is added to ready queue.
Definition: scheduler.c:199
int own_handles
Do we own the network and file handles referenced by the FdInfo structs in the fds array.
Definition: scheduler.c:179
struct GNUNET_AsyncScopeSave scope
Asynchronous scope of the task that scheduled this scope,.
Definition: scheduler.c:248
struct GNUNET_SCHEDULER_Task * next
This is a linked list.
Definition: scheduler.c:140
int on_shutdown
Is this task run on shutdown?
Definition: scheduler.c:225
struct GNUNET_SCHEDULER_FdInfo * fds
Information about which FDs are ready for this task (and why).
Definition: scheduler.c:160
unsigned int fds_len
Size of the fds array.
Definition: scheduler.c:172
struct GNUNET_TIME_Absolute timeout
Absolute timeout value for the task, or GNUNET_TIME_UNIT_FOREVER_ABS for "no timeout".
Definition: scheduler.c:185
GNUNET_SCHEDULER_TaskCallback callback
Function to run when ready.
Definition: scheduler.c:150
int write_fd
Set if we only wait for writing to a single FD, otherwise -1.
Definition: scheduler.c:214
struct GNUNET_SCHEDULER_FdInfo fdx
Storage location used for fds if we want to avoid a separate malloc() call in the common case that th...
Definition: scheduler.c:167
int read_fd
Set if we only wait for reading from a single FD, otherwise -1.
Definition: scheduler.c:209
Time for absolute times used by GNUnet, in microseconds.
uint64_t abs_value_us
The actual value.
Time for relative time used by GNUnet, in microseconds.
uint64_t rel_value_us
The actual value.
A struct representing an event the select driver is waiting for.
Definition: scheduler.c:263
struct Scheduled * next
Definition: scheduler.c:266
enum GNUNET_SCHEDULER_EventType et
the event types (multiple event types can be ORed) the select driver is expected to wait for
Definition: scheduler.c:283
struct Scheduled * prev
Definition: scheduler.c:264
struct GNUNET_SCHEDULER_FdInfo * fdi
information about the network socket / file descriptor where the event is expected to occur
Definition: scheduler.c:277
struct GNUNET_SCHEDULER_Task * task
the task, the event is related to
Definition: scheduler.c:271