testing_api_cmd_netjail_start.c File Reference

Command to start the netjail script. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_lib.h"
#include "testing_api_topology.h"

Include dependency graph for testing_api_cmd_netjail_start.c:

Go to the source code of this file.

Data Structures
struct	NetJailState
	Struct to hold information for callbacks. More...

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

Functions
static void	netjail_start_cleanup (void *cls)
	The cleanup function of this cmd frees resources the cmd allocated. More...
static void	child_completed_callback (void *cls, enum GNUNET_OS_ProcessStatusType type, unsigned long int exit_code)
	Callback which will be called if the setup script finished. More...
static void	netjail_start_run (void *cls, struct GNUNET_TESTING_Interpreter *is)
	The run method starts the script which setup the network namespaces. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_netjail_setup (const char *label, const char *script, const char *topology_cmd_label)
	This command executes a shell script to setup the netjail environment. More...

Detailed Description

Command to start the netjail script.

Author

t3sserakt

Definition in file testing_api_cmd_netjail_start.c.

Macro Definition Documentation

LOG

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

Definition at line 31 of file testing_api_cmd_netjail_start.c.

Function Documentation

netjail_start_cleanup()

static void netjail_start_cleanup ( void *  cls )

static

The cleanup function of this cmd frees resources the cmd allocated.

Definition at line 69 of file testing_api_cmd_netjail_start.c.

{
  struct NetJailState *ns = cls;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "netjail_start_cleanup!\n");
  if (NULL != ns->cwh)
  {
    GNUNET_wait_child_cancel (ns->cwh);
    ns->cwh = NULL;
  }
  if (NULL != ns->start_proc)
  {
    GNUNET_assert (0 ==
                   GNUNET_OS_process_kill (ns->start_proc,
                                           SIGKILL));
    GNUNET_assert (GNUNET_OK ==
                   GNUNET_OS_process_wait (ns->start_proc));
    GNUNET_OS_process_destroy (ns->start_proc);
    ns->start_proc = NULL;
  }
  GNUNET_free (ns);
}

References GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_OK, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_wait_child_cancel(), and ns.

Referenced by GNUNET_TESTING_cmd_netjail_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

child_completed_callback()

static void child_completed_callback ( void *  cls, enum GNUNET_OS_ProcessStatusType  type, unsigned long int  exit_code  )

static

Callback which will be called if the setup script finished.

Definition at line 98 of file testing_api_cmd_netjail_start.c.

{
  struct NetJailState *ns = cls;
 
  GNUNET_OS_process_destroy (ns->start_proc);
  ns->start_proc = NULL;
  ns->cwh = NULL;
  if ( (GNUNET_OS_PROCESS_EXITED != type) ||
       (0 != exit_code) )
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Child failed with error %lu!\n",
                exit_code);
    GNUNET_TESTING_async_fail (&ns->ac);
    return;
  }
  GNUNET_TESTING_async_finish (&ns->ac);
}

References exit_code, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_OS_process_destroy(), GNUNET_OS_PROCESS_EXITED, GNUNET_TESTING_async_fail(), GNUNET_TESTING_async_finish(), ns, and type.

Referenced by netjail_start_run().

Here is the call graph for this function:

Here is the caller graph for this function:

netjail_start_run()

static void netjail_start_run ( void *  cls, struct GNUNET_TESTING_Interpreter *  is  )

static

The run method starts the script which setup the network namespaces.

Parameters

cls	closure.
is	interpreter state.

Definition at line 127 of file testing_api_cmd_netjail_start.c.

{
  struct NetJailState *ns = cls;
  const struct GNUNET_TESTING_Command *topo_cmd;
  char pid[15];
  enum GNUNET_GenericReturnValue helper_check;
  char *data_dir;
  char *script_name;
  const char *topology_data;
 
  topo_cmd = GNUNET_TESTING_interpreter_lookup_command (
    is,
    ns->topology_cmd_label);
  if (NULL == topo_cmd)
    GNUNET_TESTING_FAIL (is);
  if (GNUNET_OK !=
      GNUNET_TESTING_get_trait_topology_string (topo_cmd,
                                                &topology_data))
    GNUNET_TESTING_FAIL (is);
  data_dir = GNUNET_OS_installation_get_path (
    GNUNET_OS_project_data_gnunet (),
    GNUNET_OS_IPK_DATADIR);
  GNUNET_asprintf (&script_name,
                   "%s%s",
                   data_dir,
                   ns->script);
  helper_check = GNUNET_OS_check_helper_binary (
    script_name,
    true,
    NULL);
  if (GNUNET_NO == helper_check)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "No SUID for %s!\n",
                script_name);
    GNUNET_TESTING_interpreter_skip (is);
    return;
  }
  if (GNUNET_SYSERR == helper_check)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "%s not found!\n",
                script_name);
    GNUNET_TESTING_interpreter_skip (is);
    return;
  }
 
  GNUNET_snprintf (pid,
                   sizeof (pid),
                   "%u",
                   getpid ());
  {
    char *const script_argv[] = {
      script_name,
      (char *) topology_data,
      pid,
      (char*) "0",
      NULL
    };
 
    ns->start_proc
      = GNUNET_OS_start_process_vap (GNUNET_OS_INHERIT_STD_ERR,
                                     NULL,
                                     NULL,
                                     NULL,
                                     script_name,
                                     script_argv);
 
  }
  ns->cwh = GNUNET_wait_child (ns->start_proc,
                               &child_completed_callback,
                               ns);
  GNUNET_break (NULL != ns->cwh);
  GNUNET_free (script_name);
  GNUNET_free (data_dir);
}

References child_completed_callback(), GNUNET_asprintf(), GNUNET_break, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log, GNUNET_NO, GNUNET_OK, GNUNET_OS_check_helper_binary(), GNUNET_OS_INHERIT_STD_ERR, GNUNET_OS_installation_get_path(), GNUNET_OS_IPK_DATADIR, GNUNET_OS_project_data_gnunet(), GNUNET_OS_start_process_vap(), GNUNET_snprintf(), GNUNET_SYSERR, GNUNET_TESTING_FAIL, GNUNET_TESTING_interpreter_lookup_command(), GNUNET_TESTING_interpreter_skip(), GNUNET_wait_child(), is, ns, and pid.

Referenced by GNUNET_TESTING_cmd_netjail_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_netjail_setup()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_setup	(	const char *	label,
		const char *	script,
		const char *	topology_cmd_label
	)

This command executes a shell script to setup the netjail environment.

Parameters

label	name for command.
script	which script to run, e.g. GNUNET_TESTING_NETJAIL_START_SCRIPT
topology_config	Configuration file for the test topology.
read_file	Flag indicating if the the name of the topology file is send to the helper, or a string with the topology data.

Returns

command.

Definition at line 207 of file testing_api_cmd_netjail_start.c.

{
  struct NetJailState *ns;
 
  ns = GNUNET_new (struct NetJailState);
  ns->script = script;
  ns->topology_cmd_label = topology_cmd_label;
  return GNUNET_TESTING_command_new_ac (
    ns,
    label,
    &netjail_start_run,
    &netjail_start_cleanup,
    NULL,
    &ns->ac);
}

References GNUNET_new, GNUNET_TESTING_command_new_ac(), netjail_start_cleanup(), netjail_start_run(), ns, NetJailState::script, and NetJailState::topology_cmd_label.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function: