GNUnet  0.11.x
Data Structures | Macros | Functions | Variables
gnunet-helper-testbed.c File Reference

Helper binary that is started from a remote controller to start gnunet-service-testbed. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_lib.h"
#include "gnunet_testbed_service.h"
#include "testbed_helper.h"
#include "testbed_api.h"
#include <zlib.h>
Include dependency graph for gnunet-helper-testbed.c:

Go to the source code of this file.

Data Structures

struct  WriteContext
 Context for a single write on a chunk of memory. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log (kind, __VA_ARGS__)
 Generic logging shortcut. More...
 
#define LOG_DEBUG(...)   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
 Debug logging shorthand. More...
 

Functions

static void shutdown_task (void *cls)
 Task to shut down cleanly. More...
 
static void write_task (void *cls)
 Task to write to the standard out. More...
 
static void child_death_task (void *cls)
 Task triggered whenever we receive a SIGCHLD (child process died). More...
 
static int tokenizer_cb (void *cls, const struct GNUNET_MessageHeader *message)
 Functions with this signature are called whenever a complete message is received by the tokenizer. More...
 
static void read_task (void *cls)
 Task to read from stdin. More...
 
static void run (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
 Main function that will be run. More...
 
static void sighandler_child_death ()
 Signal handler called for SIGCHLD. More...
 
int main (int argc, char **argv)
 Main function. More...
 

Variables

static struct GNUNET_TESTING_Systemtest_system
 Handle to the testing system. More...
 
struct GNUNET_MessageStreamTokenizertokenizer
 Our message stream tokenizer. More...
 
static struct GNUNET_DISK_FileHandlestdin_fd
 Disk handle from stdin. More...
 
static struct GNUNET_DISK_FileHandlestdout_fd
 Disk handle for stdout. More...
 
static struct GNUNET_OS_Processtestbed
 The process handle to the testbed service. More...
 
static struct GNUNET_DISK_PipeHandlesigpipe
 Pipe used to communicate shutdown via signal. More...
 
static struct GNUNET_SCHEDULER_Taskread_task_id
 Task identifier for the read task. More...
 
static struct GNUNET_SCHEDULER_Taskwrite_task_id
 Task identifier for the write task. More...
 
static struct GNUNET_SCHEDULER_Taskchild_death_task_id
 Task to kill the child. More...
 
static int done_reading
 Are we done reading messages from stdin? More...
 
static int status
 Result to return in case we fail. More...
 

Detailed Description

Helper binary that is started from a remote controller to start gnunet-service-testbed.

This binary also receives configuration from the remove controller which is put in a temporary location with ports and paths fixed so that gnunet-service-testbed runs without any hurdles.

This helper monitors for three termination events. They are: (1)The stdin of the helper is closed for reading; (2)the helper received SIGTERM/SIGINT; (3)the testbed crashed. In case of events 1 and 2 the helper kills the testbed service. When testbed crashed (event 3), the helper should send a SIGTERM to its own process group; this behaviour will help terminate any child processes (peers) testbed has started and prevents them from leaking and running forever.

Author
Sree Harsha Totakura sreeh.nosp@m.arsh.nosp@m.a@tot.nosp@m.akur.nosp@m.a.in

Definition in file gnunet-helper-testbed.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log (kind, __VA_ARGS__)

Generic logging shortcut.

Definition at line 52 of file gnunet-helper-testbed.c.

Referenced by tokenizer_cb(), and write_task().

◆ LOG_DEBUG

#define LOG_DEBUG (   ...)    LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)

Debug logging shorthand.

Definition at line 57 of file gnunet-helper-testbed.c.

Referenced by child_death_task(), read_task(), run(), shutdown_task(), and tokenizer_cb().

Function Documentation

◆ shutdown_task()

static void shutdown_task ( void *  cls)
static

Task to shut down cleanly.

Parameters
clsNULL

Definition at line 144 of file gnunet-helper-testbed.c.

References WriteContext::data, GNUNET_break, GNUNET_DISK_file_close(), GNUNET_free, GNUNET_MST_destroy(), GNUNET_OK, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_SCHEDULER_cancel(), GNUNET_TERM_SIG, GNUNET_TESTING_system_destroy(), GNUNET_YES, and LOG_DEBUG.

Referenced by run().

145 {
146  LOG_DEBUG ("Shutting down\n");
147  if (NULL != testbed)
148  {
149  LOG_DEBUG ("Killing testbed\n");
151  }
152  if (NULL != read_task_id)
153  {
155  read_task_id = NULL;
156  }
157  if (NULL != write_task_id)
158  {
159  struct WriteContext *wc;
160 
162  write_task_id = NULL;
163  GNUNET_free (wc->data);
164  GNUNET_free (wc);
165  }
166  if (NULL != child_death_task_id)
167  {
169  child_death_task_id = NULL;
170  }
171  if (NULL != stdin_fd)
173  if (NULL != stdout_fd)
176  tokenizer = NULL;
177  if (NULL != testbed)
178  {
181  testbed = NULL;
182  }
183  if (NULL != test_system)
184  {
186  test_system = NULL;
187  }
188 }
static struct GNUNET_OS_Process * testbed
The process handle to the testbed service.
int GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1280
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:287
static struct GNUNET_DISK_FileHandle * stdout_fd
Disk handle for stdout.
static struct GNUNET_DISK_FileHandle * stdin_fd
Disk handle from stdin.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void GNUNET_MST_destroy(struct GNUNET_MessageStreamTokenizer *mst)
Destroys a tokenizer.
Definition: mst.c:411
static struct GNUNET_TESTING_System * test_system
Handle to the testing system.
static struct GNUNET_SCHEDULER_Task * write_task_id
Task identifier for the write task.
#define LOG_DEBUG(...)
Debug logging shorthand.
void GNUNET_TESTING_system_destroy(struct GNUNET_TESTING_System *system, int remove_paths)
Free system resources.
Definition: testing.c:527
static struct GNUNET_SCHEDULER_Task * read_task_id
Task identifier for the read task.
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:983
struct GNUNET_MessageStreamTokenizer * tokenizer
Our message stream tokenizer.
#define GNUNET_TERM_SIG
The termination signal.
Definition: platform.h:246
#define GNUNET_free(ptr)
Wrapper around free.
void * data
The data to write.
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:225
static struct GNUNET_SCHEDULER_Task * child_death_task_id
Task to kill the child.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:972
Context for a single write on a chunk of memory.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_task()

static void write_task ( void *  cls)
static

Task to write to the standard out.

Parameters
clsthe WriteContext

Definition at line 197 of file gnunet-helper-testbed.c.

References WriteContext::data, GNUNET_assert, GNUNET_DISK_file_write(), GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_SCHEDULER_add_write_file(), GNUNET_SYSERR, GNUNET_TIME_UNIT_FOREVER_REL, WriteContext::length, LOG, and WriteContext::pos.

Referenced by tokenizer_cb().

198 {
199  struct WriteContext *wc = cls;
200  ssize_t bytes_wrote;
201 
202  GNUNET_assert (NULL != wc);
203  write_task_id = NULL;
204  bytes_wrote = GNUNET_DISK_file_write (stdout_fd,
205  wc->data + wc->pos,
206  wc->length - wc->pos);
207  if (GNUNET_SYSERR == bytes_wrote)
208  {
209  LOG (GNUNET_ERROR_TYPE_WARNING, "Cannot reply back configuration\n");
210  GNUNET_free (wc->data);
211  GNUNET_free (wc);
212  return;
213  }
214  wc->pos += bytes_wrote;
215  if (wc->pos == wc->length)
216  {
217  GNUNET_free (wc->data);
218  GNUNET_free (wc);
219  return;
220  }
222  stdout_fd,
223  &write_task,
224  wc);
225 }
size_t pos
The current position from where the write operation should begin.
#define LOG(kind,...)
Generic logging shortcut.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
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:1700
static struct GNUNET_DISK_FileHandle * stdout_fd
Disk handle for stdout.
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:820
static void write_task(void *cls)
Task to write to the standard out.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
static struct GNUNET_SCHEDULER_Task * write_task_id
Task identifier for the write task.
size_t length
The length of the data.
#define GNUNET_free(ptr)
Wrapper around free.
void * data
The data to write.
Context for a single write on a chunk of memory.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ child_death_task()

static void child_death_task ( void *  cls)
static

Task triggered whenever we receive a SIGCHLD (child process died).

Parameters
clsclosure, NULL if we need to self-restart

Definition at line 235 of file gnunet-helper-testbed.c.

References GNUNET_break, GNUNET_DISK_file_read(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_pipe_handle(), GNUNET_ERROR_TYPE_ERROR, GNUNET_log_strerror, GNUNET_NO, GNUNET_OS_process_destroy(), GNUNET_OS_process_status(), GNUNET_SCHEDULER_add_read_file(), GNUNET_SCHEDULER_shutdown(), GNUNET_SYSERR, GNUNET_TERM_SIG, GNUNET_TIME_UNIT_FOREVER_REL, LOG_DEBUG, ret, and type.

Referenced by tokenizer_cb().

236 {
237  const struct GNUNET_DISK_FileHandle *pr;
238  char c[16];
240  unsigned long code;
241  int ret;
242 
244  child_death_task_id = NULL;
245  /* consume the signal */
246  GNUNET_break (0 < GNUNET_DISK_file_read (pr, &c, sizeof(c)));
247  LOG_DEBUG ("Got SIGCHLD\n");
248  if (NULL == testbed)
249  {
250  GNUNET_break (0);
251  return;
252  }
254  (ret = GNUNET_OS_process_status (testbed, &type, &code)));
255  if (GNUNET_NO != ret)
256  {
258  testbed = NULL;
259  /* Send SIGTERM to our process group */
260  if (0 != kill (0, GNUNET_TERM_SIG))
261  {
263  GNUNET_SCHEDULER_shutdown (); /* Couldn't send the signal, we shutdown frowning */
264  }
265  return;
266  }
267  LOG_DEBUG ("Child hasn't died. Resuming to monitor its status\n");
270  pr,
272  NULL);
273 }
static struct GNUNET_OS_Process * testbed
The process handle to the testbed service.
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:287
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:732
int GNUNET_OS_process_status(struct GNUNET_OS_Process *proc, enum GNUNET_OS_ProcessStatusType *type, unsigned long *code)
Retrieve the status of a process.
Definition: os_priority.c:946
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
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:1667
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:531
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
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:1672
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
GNUNET_OS_ProcessStatusType
Process status types.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
The reading-end of a pipe.
#define LOG_DEBUG(...)
Debug logging shorthand.
static struct GNUNET_DISK_PipeHandle * sigpipe
Pipe used to communicate shutdown via signal.
static void child_death_task(void *cls)
Task triggered whenever we receive a SIGCHLD (child process died).
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
#define GNUNET_TERM_SIG
The termination signal.
Definition: platform.h:246
Handle used to access files (and pipes).
static struct GNUNET_SCHEDULER_Task * child_death_task_id
Task to kill the child.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ tokenizer_cb()

static int tokenizer_cb ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

Functions with this signature are called whenever a complete message is received by the tokenizer.

Do not call #GNUNET_mst_destroy() in this callback

Parameters
clsidentification of the client
messagethe actual message
Returns
GNUNET_OK on success, GNUNET_NO to stop further processing (no error) GNUNET_SYSERR to stop further processing with error

Definition at line 289 of file gnunet-helper-testbed.c.

References cfg, child_death_task(), config, GNUNET_TESTBED_HelperInit::config_size, WriteContext::data, done_reading, ENV_TESTBED_CONFIG, getenv(), GNUNET_asprintf(), GNUNET_assert, GNUNET_break, GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_deserialize(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_serialize(), GNUNET_CONFIGURATION_write(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_pipe_handle(), GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_malloc, GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT, GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY, GNUNET_new, GNUNET_OK, GNUNET_OS_get_libexec_binary_path(), GNUNET_OS_INHERIT_STD_ERR, GNUNET_OS_start_process(), GNUNET_realloc, GNUNET_SCHEDULER_add_read_file(), GNUNET_SCHEDULER_add_write_file(), GNUNET_SCHEDULER_shutdown(), GNUNET_strdup, GNUNET_strlcpy(), GNUNET_SYSERR, GNUNET_TESTBED_compress_config_(), GNUNET_TESTING_configuration_create(), GNUNET_TESTING_PREFIX, GNUNET_TESTING_system_create(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, hostname, GNUNET_TESTBED_HelperInit::hostname_size, WriteContext::length, LOG, LOG_DEBUG, msg, ret, GNUNET_MessageHeader::size, status, GNUNET_TESTBED_HelperInit::trusted_ip_size, GNUNET_MessageHeader::type, and write_task().

Referenced by run().

290 {
291  const struct GNUNET_TESTBED_HelperInit *msg;
292  struct GNUNET_TESTBED_HelperReply *reply;
294  struct WriteContext *wc;
295  char *binary;
296  char *trusted_ip;
297  char *hostname;
298  char *config;
299  char *xconfig;
300  char *evstr;
301  // char *str;
302  size_t config_size;
303  uLongf ul_config_size;
304  size_t xconfig_size;
305  uint16_t trusted_ip_size;
306  uint16_t hostname_size;
307  uint16_t msize;
308 
309  msize = ntohs (message->size);
310  if ((sizeof(struct GNUNET_TESTBED_HelperInit) >= msize) ||
311  (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT != ntohs (message->type)))
312  {
313  LOG (GNUNET_ERROR_TYPE_WARNING, "Received unexpected message -- exiting\n");
314  goto error;
315  }
316  msg = (const struct GNUNET_TESTBED_HelperInit *) message;
317  trusted_ip_size = ntohs (msg->trusted_ip_size);
318  trusted_ip = (char *) &msg[1];
319  if ('\0' != trusted_ip[trusted_ip_size])
320  {
321  LOG (GNUNET_ERROR_TYPE_WARNING, "Trusted IP cannot be empty -- exiting\n");
322  goto error;
323  }
324  hostname_size = ntohs (msg->hostname_size);
325  if ((sizeof(struct GNUNET_TESTBED_HelperInit) + trusted_ip_size + 1
326  + hostname_size) >= msize)
327  {
328  GNUNET_break (0);
329  LOG (GNUNET_ERROR_TYPE_WARNING, "Received unexpected message -- exiting\n");
330  goto error;
331  }
332  ul_config_size = (uLongf) ntohs (msg->config_size);
333  config = GNUNET_malloc (ul_config_size);
334  xconfig_size = msize - (trusted_ip_size + 1 + hostname_size
335  + sizeof(struct GNUNET_TESTBED_HelperInit));
336  int ret = uncompress ((Bytef *) config,
337  &ul_config_size,
338  (const Bytef *) (trusted_ip + trusted_ip_size + 1
339  + hostname_size),
340  (uLongf) xconfig_size);
341  if (Z_OK != ret)
342  {
343  switch (ret)
344  {
345  case Z_MEM_ERROR:
346  LOG (GNUNET_ERROR_TYPE_ERROR, "Not enough memory for decompression\n");
347  break;
348 
349  case Z_BUF_ERROR:
350  LOG (GNUNET_ERROR_TYPE_ERROR, "Output buffer too small\n");
351  break;
352 
353  case Z_DATA_ERROR:
354  LOG (GNUNET_ERROR_TYPE_ERROR, "Data corrupted/incomplete\n");
355  break;
356 
357  default:
358  GNUNET_break (0);
359  }
361  "Error while uncompressing config -- exiting\n");
362  GNUNET_free (config);
363  goto error;
364  }
366  if (GNUNET_OK !=
367  GNUNET_CONFIGURATION_deserialize (cfg, config, ul_config_size, NULL))
368  {
369  LOG (GNUNET_ERROR_TYPE_ERROR, "Unable to deserialize config -- exiting\n");
370  GNUNET_free (config);
371  goto error;
372  }
373  GNUNET_free (config);
374  hostname = NULL;
375  if (0 != hostname_size)
376  {
377  hostname = GNUNET_malloc (hostname_size + 1);
378  GNUNET_strlcpy (hostname,
379  ((char *) &msg[1]) + trusted_ip_size + 1,
380  hostname_size + 1);
381  }
382  /* unset GNUNET_TESTING_PREFIX if present as it is more relevant for testbed */
383  evstr = getenv (GNUNET_TESTING_PREFIX);
384  if (NULL != evstr)
385  {
386  /* unsetting the variable will invalidate the pointer! */
387  evstr = GNUNET_strdup (evstr);
388  GNUNET_break (0 == unsetenv (GNUNET_TESTING_PREFIX));
389  }
390  test_system =
391  GNUNET_TESTING_system_create ("testbed-helper", trusted_ip, hostname, NULL);
392  if (NULL != evstr)
393  {
394  char *evar;
395 
396  GNUNET_asprintf (&evar, GNUNET_TESTING_PREFIX "=%s", evstr);
397  GNUNET_assert (0 == putenv (evar)); /* consumes 'evar',
398  see putenv(): becomes part of envrionment! */
399  GNUNET_free (evstr);
400  evstr = NULL;
401  }
402  GNUNET_free (hostname);
403  hostname = NULL;
404  GNUNET_assert (NULL != test_system);
409  "PATHS",
410  "DEFAULTCONFIG",
411  &config));
412  if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, config))
413  {
415  "Unable to write config file: %s -- exiting\n",
416  config);
418  GNUNET_free (config);
419  goto error;
420  }
421  LOG_DEBUG ("Staring testbed with config: %s\n", config);
422  binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-testbed");
423  {
424  char *evar;
425 
426  /* expose testbed configuration through env variable */
427  GNUNET_asprintf (&evar, "%s=%s", ENV_TESTBED_CONFIG, config);
428  GNUNET_assert (0 == putenv (evar)); /* consumes 'evar',
429  see putenv(): becomes part of envrionment! */
430  evstr = NULL;
431  }
433  NULL,
434  NULL,
435  NULL,
436  binary,
437  "gnunet-service-testbed",
438  "-c",
439  config,
440  NULL);
441  GNUNET_free (binary);
442  GNUNET_free (config);
443  if (NULL == testbed)
444  {
446  "Error starting gnunet-service-testbed -- exiting\n");
448  goto error;
449  }
451  config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
453  cfg = NULL;
454  xconfig_size =
455  GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
456  GNUNET_free (config);
457  wc = GNUNET_new (struct WriteContext);
458  wc->length = xconfig_size + sizeof(struct GNUNET_TESTBED_HelperReply);
459  reply = GNUNET_realloc (xconfig, wc->length);
460  memmove (&reply[1], reply, xconfig_size);
461  reply->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY);
462  reply->header.size = htons ((uint16_t) wc->length);
463  reply->config_size = htons ((uint16_t) config_size);
464  wc->data = reply;
466  stdout_fd,
467  &write_task,
468  wc);
473  NULL);
474  return GNUNET_OK;
475 
476 error:
479  return GNUNET_SYSERR;
480 }
When this flag is set, the child process will inherit stderr of the parent.
Definition: gnunet_os_lib.h:91
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
struct GNUNET_OS_Process * GNUNET_OS_start_process(enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, struct GNUNET_DISK_PipeHandle *pipe_stdout, struct GNUNET_DISK_PipeHandle *pipe_stderr, const char *filename,...)
Start a process.
Definition: os_priority.c:678
static struct GNUNET_OS_Process * testbed
The process handle to the testbed service.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
int GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
#define LOG(kind,...)
Generic logging shortcut.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
#define GNUNET_TESTING_PREFIX
The environmental variable, if set, that dictates where testing should place generated peer configura...
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:1700
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:1667
static struct GNUNET_DISK_FileHandle * stdout_fd
Disk handle for stdout.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format...
Initialization message for gnunet-helper-testbed to start testbed service.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:531
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
int GNUNET_TESTING_configuration_create(struct GNUNET_TESTING_System *system, struct GNUNET_CONFIGURATION_Handle *cfg)
Create a new configuration using the given configuration as a template; ports and paths will be modif...
Definition: testing.c:1138
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
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:1672
static int status
Result to return in case we fail.
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
#define GNUNET_realloc(ptr, size)
Wrapper around realloc.
static void write_task(void *cls)
Task to write to the standard out.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
static const struct GNUNET_CONFIGURATION_Handle * config
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
The reading-end of a pipe.
static struct GNUNET_TESTING_System * test_system
Handle to the testing system.
uint16_t hostname_size
The hostname size excluding the NULL termination character - strlen (hostname); cannot be zero...
Reply message from helper process.
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
static struct GNUNET_SCHEDULER_Task * write_task_id
Task identifier for the write task.
#define GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT
The initialization message towards gnunet-testbed-helper.
#define LOG_DEBUG(...)
Debug logging shorthand.
struct GNUNET_TESTING_System * GNUNET_TESTING_system_create(const char *testdir, const char *trusted_ip, const char *hostname, const struct GNUNET_TESTING_SharedService *shared_services)
Create a system handle.
Definition: testing.c:447
#define GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY
The reply message from gnunet-testbed-helper.
char * getenv()
size_t GNUNET_TESTBED_compress_config_(const char *config, size_t size, char **xconfig)
Compresses given configuration using zlib compress.
Definition: testbed_api.c:1758
char * GNUNET_CONFIGURATION_serialize(const struct GNUNET_CONFIGURATION_Handle *cfg, size_t *size)
Serializes the given configuration.
static char * hostname
Our hostname; we give this to all the peers we start.
static struct GNUNET_DISK_PipeHandle * sigpipe
Pipe used to communicate shutdown via signal.
configuration data
Definition: configuration.c:84
uint16_t trusted_ip_size
The controller hostname size excluding the NULL termination character - strlen (hostname); cannot be ...
int GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
char * GNUNET_OS_get_libexec_binary_path(const char *progname)
Given the name of a gnunet-helper, gnunet-service or gnunet-daemon binary, try to prefix it with the ...
static void child_death_task(void *cls)
Task triggered whenever we receive a SIGCHLD (child process died).
int GNUNET_CONFIGURATION_deserialize(struct GNUNET_CONFIGURATION_Handle *cfg, const char *mem, size_t size, const char *basedir)
De-serializes configuration.
size_t length
The length of the data.
static int done_reading
Are we done reading messages from stdin?
uint16_t config_size
The size of the uncompressed configuration.
size_t GNUNET_strlcpy(char *dst, const char *src, size_t n)
Like strlcpy but portable.
Definition: strings.c:221
#define ENV_TESTBED_CONFIG
The environmental variable which when available refers to the configuration file the local testbed co...
Definition: testbed.h:776
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
void * data
The data to write.
static struct GNUNET_SCHEDULER_Task * child_death_task_id
Task to kill the child.
Context for a single write on a chunk of memory.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ read_task()

static void read_task ( void *  cls)
static

Task to read from stdin.

Parameters
clsNULL

Definition at line 489 of file gnunet-helper-testbed.c.

References buf, done_reading, GNUNET_break, GNUNET_break_op, GNUNET_DISK_file_read(), GNUNET_MAX_MESSAGE_SIZE, GNUNET_MST_from_buffer(), GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_read_file(), GNUNET_SCHEDULER_shutdown(), GNUNET_SYSERR, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, and LOG_DEBUG.

Referenced by run().

490 {
492  ssize_t sread;
493 
494  read_task_id = NULL;
495  sread = GNUNET_DISK_file_read (stdin_fd, buf, sizeof(buf));
496  if ((GNUNET_SYSERR == sread) || (0 == sread))
497  {
498  LOG_DEBUG ("STDIN closed\n");
500  return;
501  }
502  if (GNUNET_YES == done_reading)
503  {
504  /* didn't expect any more data! */
505  GNUNET_break_op (0);
507  return;
508  }
509  LOG_DEBUG ("Read %u bytes\n", (unsigned int) sread);
510  /* FIXME: could introduce a GNUNET_MST_read2 to read
511  directly from 'stdin_fd' and save a memcpy() here */
512  if (GNUNET_OK !=
514  {
515  GNUNET_break (0);
517  return;
518  }
519  read_task_id /* No timeout while reading */
521  stdin_fd,
522  &read_task,
523  NULL);
524 }
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:732
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:1667
static struct GNUNET_DISK_FileHandle * stdin_fd
Disk handle from stdin.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:531
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
static char buf[2048]
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
int GNUNET_MST_from_buffer(struct GNUNET_MessageStreamTokenizer *mst, const char *buf, size_t size, int purge, int one_shot)
Add incoming data to the receive buffer and call the callback for all complete messages.
Definition: mst.c:114
#define LOG_DEBUG(...)
Debug logging shorthand.
static struct GNUNET_SCHEDULER_Task * read_task_id
Task identifier for the read task.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
struct GNUNET_MessageStreamTokenizer * tokenizer
Our message stream tokenizer.
static int done_reading
Are we done reading messages from stdin?
static void read_task(void *cls)
Task to read from stdin.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ run()

static void run ( void *  cls,
char *const *  args,
const char *  cfgfile,
const struct GNUNET_CONFIGURATION_Handle cfg 
)
static

Main function that will be run.

Parameters
clsclosure
argsremaining command-line arguments
cfgfilename of the configuration file used (for saving, can be NULL!)
cfgconfiguration

Definition at line 536 of file gnunet-helper-testbed.c.

References GNUNET_DISK_get_handle_from_native(), GNUNET_MST_create(), GNUNET_SCHEDULER_add_read_file(), GNUNET_SCHEDULER_add_shutdown(), GNUNET_TIME_UNIT_FOREVER_REL, LOG_DEBUG, read_task(), shutdown_task(), and tokenizer_cb().

Referenced by main().

540 {
541  LOG_DEBUG ("Starting testbed helper...\n");
546  stdin_fd,
547  &read_task,
548  NULL);
550 }
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, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1331
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:1667
static struct GNUNET_DISK_FileHandle * stdout_fd
Disk handle for stdout.
static struct GNUNET_DISK_FileHandle * stdin_fd
Disk handle from stdin.
static int tokenizer_cb(void *cls, const struct GNUNET_MessageHeader *message)
Functions with this signature are called whenever a complete message is received by the tokenizer...
struct GNUNET_MessageStreamTokenizer * GNUNET_MST_create(GNUNET_MessageTokenizerCallback cb, void *cb_cls)
Create a message stream tokenizer.
Definition: mst.c:85
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
static void shutdown_task(void *cls)
Task to shut down cleanly.
#define LOG_DEBUG(...)
Debug logging shorthand.
static struct GNUNET_SCHEDULER_Task * read_task_id
Task identifier for the read task.
struct GNUNET_MessageStreamTokenizer * tokenizer
Our message stream tokenizer.
struct GNUNET_DISK_FileHandle * GNUNET_DISK_get_handle_from_native(FILE *fd)
Get a handle from a native FD.
Definition: disk.c:1332
static void read_task(void *cls)
Task to read from stdin.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ sighandler_child_death()

static void sighandler_child_death ( )
static

Signal handler called for SIGCHLD.

Definition at line 557 of file gnunet-helper-testbed.c.

References GNUNET_break, GNUNET_DISK_file_write(), GNUNET_DISK_PIPE_END_WRITE, and GNUNET_DISK_pipe_handle().

Referenced by main().

558 {
559  static char c;
560  int old_errno; /* back-up errno */
561 
562  old_errno = errno;
563  GNUNET_break (
564  1 ==
567  &c,
568  sizeof(c)));
569  errno = old_errno;
570 }
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
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:1672
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:820
The writing-end of a pipe.
static struct GNUNET_DISK_PipeHandle * sigpipe
Pipe used to communicate shutdown via signal.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ main()

int main ( int  argc,
char **  argv 
)

Main function.

Parameters
argcthe number of command line arguments
argvcommand line arg array
Returns
return code

Definition at line 581 of file gnunet-helper-testbed.c.

References GNUNET_break, GNUNET_DISK_PF_NONE, GNUNET_DISK_pipe(), GNUNET_DISK_pipe_close(), GNUNET_GETOPT_OPTION_END, GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_SIGCHLD, GNUNET_SIGNAL_handler_install(), GNUNET_SIGNAL_handler_uninstall(), ret, run(), shc_chld, sighandler_child_death(), and status.

582 {
586  int ret;
587 
588  status = GNUNET_OK;
589  if (NULL ==
591  {
592  GNUNET_break (0);
593  return 1;
594  }
595  shc_chld =
597  ret = GNUNET_PROGRAM_run (argc,
598  argv,
599  "gnunet-helper-testbed",
600  "Helper for starting gnunet-service-testbed",
601  options,
602  &run,
603  NULL);
605  shc_chld = NULL;
607  if (GNUNET_OK != ret)
608  return 1;
609  return (GNUNET_OK == status) ? 0 : 1;
610 }
No special options, use non-blocking read/write operations.
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
#define GNUNET_SIGCHLD
Definition: platform.h:42
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
void GNUNET_SIGNAL_handler_uninstall(struct GNUNET_SIGNAL_Context *ctx)
Uninstall a previously installed signal handler.
Definition: signal.c:77
Definition of a command line option.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
static int status
Result to return in case we fail.
struct GNUNET_DISK_PipeHandle * GNUNET_DISK_pipe(enum GNUNET_DISK_PipeFlags pf)
Creates an interprocess channel.
Definition: disk.c:1456
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:51
int GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:1634
static struct GNUNET_DISK_PipeHandle * sigpipe
Pipe used to communicate shutdown via signal.
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
Main function that will be run.
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:372
static struct GNUNET_SIGNAL_Context * shc_chld
Child signal handler.
Definition: gnunet-qr.c:64
static void sighandler_child_death()
Signal handler called for SIGCHLD.
Here is the call graph for this function:

Variable Documentation

◆ test_system

struct GNUNET_TESTING_System* test_system
static

Handle to the testing system.

Definition at line 85 of file gnunet-helper-testbed.c.

◆ tokenizer

struct GNUNET_MessageStreamTokenizer* tokenizer

Our message stream tokenizer.

Definition at line 90 of file gnunet-helper-testbed.c.

◆ stdin_fd

struct GNUNET_DISK_FileHandle* stdin_fd
static

Disk handle from stdin.

Definition at line 95 of file gnunet-helper-testbed.c.

◆ stdout_fd

struct GNUNET_DISK_FileHandle* stdout_fd
static

Disk handle for stdout.

Definition at line 100 of file gnunet-helper-testbed.c.

◆ testbed

struct GNUNET_OS_Process* testbed
static

The process handle to the testbed service.

Definition at line 105 of file gnunet-helper-testbed.c.

◆ sigpipe

struct GNUNET_DISK_PipeHandle* sigpipe
static

Pipe used to communicate shutdown via signal.

Definition at line 110 of file gnunet-helper-testbed.c.

◆ read_task_id

struct GNUNET_SCHEDULER_Task* read_task_id
static

Task identifier for the read task.

Definition at line 115 of file gnunet-helper-testbed.c.

◆ write_task_id

struct GNUNET_SCHEDULER_Task* write_task_id
static

Task identifier for the write task.

Definition at line 120 of file gnunet-helper-testbed.c.

◆ child_death_task_id

struct GNUNET_SCHEDULER_Task* child_death_task_id
static

Task to kill the child.

Definition at line 125 of file gnunet-helper-testbed.c.

◆ done_reading

int done_reading
static

Are we done reading messages from stdin?

Definition at line 130 of file gnunet-helper-testbed.c.

Referenced by read_task(), and tokenizer_cb().

◆ status

int status
static

Result to return in case we fail.

Definition at line 135 of file gnunet-helper-testbed.c.

Referenced by main(), and tokenizer_cb().