summaryrefslogtreecommitdiff
path: root/src/testing/testing_api_cmd_block_until_external_trigger.c
blob: 2439afeaf87ceb676d6e929b04bb4d677a9ca262 (plain)
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
      This file is part of GNUnet
      Copyright (C) 2021 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 testing_api_cmd_block_until_all_peers_started.c
 * @brief cmd to block the interpreter loop until all peers started.
 * @author t3sserakt
 */
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_ng_lib.h"

/**
 * Generic logging shortcut
 */
#define LOG(kind, ...) GNUNET_log (kind, __VA_ARGS__)

/**
 * Struct with information for callbacks.
 *
 */
struct BlockState
{
  /**
   * Flag to indicate if all peers have started.
   *
   */
  unsigned int *stop_blocking;
};


/**
 * Trait function of this cmd does nothing.
 *
 */
static int
block_until_all_peers_started_traits (void *cls,
                                      const void **ret,
                                      const char *trait,
                                      unsigned int index)
{
  return GNUNET_OK;
}


/**
 * The cleanup function of this cmd frees resources the cmd allocated.
 *
 */
static void
block_until_all_peers_started_cleanup (void *cls,
                                       const struct GNUNET_TESTING_Command *cmd)
{
  struct BlockState *bs = cls;

  GNUNET_free (bs);
}


/**
 * This function does nothing but to start the cmd.
 *
 */
static void
block_until_all_peers_started_run (void *cls,
                                   const struct GNUNET_TESTING_Command *cmd,
                                   struct GNUNET_TESTING_Interpreter *is)
{
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "block_until_all_peers_started_run!\n");
}


/**
 * Function to check if BlockState#all_peers_started is GNUNET_YES. In that case interpreter_next will be called.
 *
 */
static int
block_until_all_peers_started_finish (void *cls,
                                      GNUNET_SCHEDULER_TaskCallback cont,
                                      void *cont_cls)
{
  struct BlockState *bs = cls;
  unsigned int *ret = bs->stop_blocking;

  if (GNUNET_YES == *ret)
  {
    cont (cont_cls);
  }

  return *ret;
}


/**
 * Create command.
 *
 * @param label name for command.
 * @param all_peers_started Flag which will be set from outside.
 * @return command.
 */
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_block_until_external_trigger (const char *label,
                                                 unsigned int *
                                                 stop_blocking)
{
  struct BlockState *bs;

  bs = GNUNET_new (struct BlockState);
  bs->stop_blocking = stop_blocking;

  struct GNUNET_TESTING_Command cmd = {
    .cls = bs,
    .label = label,
    .run = &block_until_all_peers_started_run,
    .finish = &block_until_all_peers_started_finish,
    .cleanup = &block_until_all_peers_started_cleanup,
    .traits = &block_until_all_peers_started_traits
  };

  return cmd;
}