1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*
This file is part of GNUnet
Copyright (C) 2022 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @file include/gnunet_testing_barrier.h
* @brief API to manage barriers.
* @author t3sserakt
*/
#ifndef GNUNET_TESTING_BARRIER_LIB_H
#define GNUNET_TESTING_BARRIER_LIB_H
#include "gnunet_testing_plugin.h"
struct GNUNET_TESTING_Barrier;
#define GNUNET_TESTING_BARRIER_MAX 32
/**
* An entry for a barrier list
* FIXME: why is this in the public API!??!
*/
struct GNUNET_TESTING_BarrierListEntry
{
/* DLL */
struct GNUNET_TESTING_BarrierListEntry *next;
/* DLL */
struct GNUNET_TESTING_BarrierListEntry *prev;
/* The barrier name*/
char *barrier_name;
/**
* Number of commands attached to the barrier.
*/
unsigned int expected_reaches;
};
/**
* A list to hold barriers provided by plugins
* FIXME: why is this in the public API!??!
*/
struct GNUNET_TESTING_BarrierList
{
/** List head **/
struct GNUNET_TESTING_BarrierListEntry *head;
/** List tail **/
struct GNUNET_TESTING_BarrierListEntry *tail;
};
/**
* Command to create a barrier.
*
* FIXME: high-level it is baffling how we need both the GNUNET_TESTING_Barrier
* and the Command that creates barriers. Conceptually this seems to be
* very much separate. Can we move _Barrier completely into testing as private?
*
* @param label The label of this command.
* @param percentage_to_be_reached If this percentage of processes reached
* this barrier, all processes waiting at
* this barrier can pass it. Must not be
* used together with number_to_be_reached.
* @param number_to_be_reached If this number of processes reached
* this barrier, all processes waiting at
* this barrier can pass it. Must not be
* used together with percentage_to_be_reached.
*/
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_barrier_create (
const char *label,
double percentage_to_be_reached,
unsigned int number_to_be_reached);
/**
* If this command is executed the the process is signaling the master process
* that it reached a barrier. If this command is synchronous it will block.
*
* FIXME: Now this, as it returns a Command, seems to me like it should be
* part of the public API?
*
* @param label name for command.
* @param barrier_label The name of the barrier we waited for and which was reached.
* @param asynchronous_finish If #GNUNET_YES this command will not block.
* @param node_number The global number of the node the cmd runs on.
* @param running_on_master Is this cmd running on the master loop?
* @param write_message Callback to write messages to the master loop.
* @return command.
*/
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_barrier_reached (
const char *label,
const char *barrier_label,
unsigned int asynchronous_finish, /* FIXME: why not a bool? */
unsigned int node_number,
unsigned int running_on_master, /* FIXME: why not a bool? */
GNUNET_TESTING_cmd_helper_write_cb write_message); /* FIXME: no 'cls' closure argument!? */
#endif
/* end of testing_barrier.h */
|