GNUnet  0.11.x
Data Structures | Macros | Functions | Variables
testing_api_cmd_netjail_stop.c File Reference
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_ng_lib.h"
Include dependency graph for testing_api_cmd_netjail_stop.c:

Go to the source code of this file.

Data Structures

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

Macros

#define NETJAIL_STOP_SCRIPT   "./../testing/netjail_stop.sh"
 

Functions

static void netjail_stop_cleanup (void *cls, const struct GNUNET_TESTING_Command *cmd)
 The cleanup function of this cmd frees resources the cmd allocated. More...
 
static int netjail_stop_traits (void *cls, const void **ret, const char *trait, unsigned int index)
 Trait function of this cmd does nothing. More...
 
static void child_completed_callback (void *cls, enum GNUNET_OS_ProcessStatusType type, long unsigned int exit_code)
 Callback which will be called if the setup script finished. More...
 
static void netjail_stop_run (void *cls, const struct GNUNET_TESTING_Command *cmd, struct GNUNET_TESTING_Interpreter *is)
 The run method starts the script which deletes the network namespaces. More...
 
static int netjail_stop_finish (void *cls, GNUNET_SCHEDULER_TaskCallback cont, void *cont_cls)
 This function checks the flag NetJailState::finished, if this cmd finished. More...
 
struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_stop (const char *label, char *local_m, char *global_n)
 Create command. More...
 

Variables

struct GNUNET_ChildWaitHandlecwh
 

Macro Definition Documentation

◆ NETJAIL_STOP_SCRIPT

#define NETJAIL_STOP_SCRIPT   "./../testing/netjail_stop.sh"

Definition at line 31 of file testing_api_cmd_netjail_stop.c.

Function Documentation

◆ netjail_stop_cleanup()

static void netjail_stop_cleanup ( void *  cls,
const struct GNUNET_TESTING_Command cmd 
)
static

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

Definition at line 63 of file testing_api_cmd_netjail_stop.c.

65 {
66  struct NetJailState *ns = cls;
67 
68  if (NULL != cwh)
69  {
71  cwh = NULL;
72  }
73  if (NULL != ns->stop_proc)
74  {
75  GNUNET_assert (0 ==
76  GNUNET_OS_process_kill (ns->stop_proc,
77  SIGKILL));
79  GNUNET_OS_process_wait (ns->stop_proc));
80  GNUNET_OS_process_destroy (ns->stop_proc);
81  ns->stop_proc = NULL;
82  }
83 }
static struct GNUNET_NAMESTORE_Handle * ns
Handle to the namestore.
Definition: gnunet-abd.c:41
void GNUNET_wait_child_cancel(struct GNUNET_ChildWaitHandle *cwh)
Stop waiting on this child.
@ GNUNET_OK
Definition: gnunet_common.h:95
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:983
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:286
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:224
Struct to hold information for callbacks.
struct GNUNET_ChildWaitHandle * cwh

References cwh, GNUNET_assert, GNUNET_OK, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_wait_child_cancel(), and ns.

Here is the call graph for this function:

◆ netjail_stop_traits()

static int netjail_stop_traits ( void *  cls,
const void **  ret,
const char *  trait,
unsigned int  index 
)
static

Trait function of this cmd does nothing.

Definition at line 91 of file testing_api_cmd_netjail_stop.c.

95 {
96  return GNUNET_OK;
97 }

References GNUNET_OK.

◆ child_completed_callback()

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

Callback which will be called if the setup script finished.

Definition at line 105 of file testing_api_cmd_netjail_stop.c.

108 {
109  struct NetJailState *ns = cls;
110 
111  cwh = NULL;
112  if (0 == exit_code)
113  {
114  ns->finished = GNUNET_YES;
115  }
116  else
117  {
118  ns->finished = GNUNET_SYSERR;
119  }
120  GNUNET_OS_process_destroy (ns->stop_proc);
121  ns->stop_proc = NULL;
122 }
static long unsigned int exit_code
Handler exit code.
Definition: gnunet-qr.c:54
@ GNUNET_YES
Definition: gnunet_common.h:97
@ GNUNET_SYSERR
Definition: gnunet_common.h:93

References cwh, exit_code, GNUNET_OS_process_destroy(), GNUNET_SYSERR, GNUNET_YES, and ns.

Referenced by netjail_stop_run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ netjail_stop_run()

static void netjail_stop_run ( void *  cls,
const struct GNUNET_TESTING_Command cmd,
struct GNUNET_TESTING_Interpreter is 
)
static

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

Parameters
clsclosure.
cmdCMD being run.
isinterpreter state.

Definition at line 133 of file testing_api_cmd_netjail_stop.c.

136 {
137  struct NetJailState *ns = cls;
138  char *const script_argv[] = {NETJAIL_STOP_SCRIPT,
139  ns->local_m,
140  ns->global_n,
141  NULL};
142  unsigned int helper_check = GNUNET_OS_check_helper_binary (
144  GNUNET_YES,
145  NULL);
146 
147  if (GNUNET_NO == helper_check)
148  {
150  "No SUID for %s!\n",
153  }
154  else if (GNUNET_NO == helper_check)
155  {
157  "%s not found!\n",
160  }
161 
163  NULL,
164  NULL,
165  NULL,
167  script_argv);
168 
169  cwh = GNUNET_wait_child (ns->stop_proc,
171  ns);
172  GNUNET_break (NULL != cwh);
173 
174 }
struct GNUNET_ChildWaitHandle * GNUNET_wait_child(struct GNUNET_OS_Process *proc, GNUNET_ChildCompletedCallback cb, void *cb_cls)
Starts the handling of the child processes.
#define GNUNET_log(kind,...)
@ GNUNET_NO
Definition: gnunet_common.h:94
void GNUNET_TESTING_interpreter_fail()
Current command failed, clean up and fail the test case.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_ERROR
int GNUNET_OS_check_helper_binary(const char *binary, int check_suid, const char *params)
Check whether an executable exists and possibly if the suid bit is set on the file.
struct GNUNET_OS_Process * GNUNET_OS_start_process_vap(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, char *const argv[])
Start a process.
Definition: os_priority.c:604
@ GNUNET_OS_INHERIT_STD_ERR
When this flag is set, the child process will inherit stderr of the parent.
Definition: gnunet_os_lib.h:91
static void child_completed_callback(void *cls, enum GNUNET_OS_ProcessStatusType type, long unsigned int exit_code)
Callback which will be called if the setup script finished.
#define NETJAIL_STOP_SCRIPT

References child_completed_callback(), cwh, GNUNET_break, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_NO, GNUNET_OS_check_helper_binary(), GNUNET_OS_INHERIT_STD_ERR, GNUNET_OS_start_process_vap(), GNUNET_TESTING_interpreter_fail(), GNUNET_wait_child(), GNUNET_YES, NETJAIL_STOP_SCRIPT, and ns.

Here is the call graph for this function:

◆ netjail_stop_finish()

static int netjail_stop_finish ( void *  cls,
GNUNET_SCHEDULER_TaskCallback  cont,
void *  cont_cls 
)
static

This function checks the flag NetJailState::finished, if this cmd finished.

Definition at line 182 of file testing_api_cmd_netjail_stop.c.

185 {
186  struct NetJailState *ns = cls;
187 
188  if (ns->finished)
189  {
190  cont (cont_cls);
191  }
192  return ns->finished;
193 }

References ns.

◆ GNUNET_TESTING_cmd_netjail_stop()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_stop ( const char *  label,
char *  local_m,
char *  global_n 
)

Create command.

Parameters
labelname for command.
local_mNumber of local nodes in each namespace.
global_nThe number of namespaces.
Returns
command.

Definition at line 182 of file testing_api_cmd_netjail_stop.c.

208 {
209  struct NetJailState *ns;
210 
211  ns = GNUNET_new (struct NetJailState);
212  ns->local_m = local_m;
213  ns->global_n = global_n;
214 
215  struct GNUNET_TESTING_Command cmd = {
216  .cls = ns,
217  .label = label,
218  .run = &netjail_stop_run,
219  .finish = &netjail_stop_finish,
220  .cleanup = &netjail_stop_cleanup,
221  .traits = &netjail_stop_traits
222  };
223 
224  return cmd;
225 }
#define GNUNET_new(type)
Allocate a struct or union of the given type.
A command to be run by the interpreter.
const char * label
Label for the command.
void * cls
Closure for all commands with command-specific context information.
char * local_m
Number of nodes in a network namespace.
char * global_n
Number of network namespaces.
static int netjail_stop_traits(void *cls, const void **ret, const char *trait, unsigned int index)
Trait function of this cmd does nothing.
static void netjail_stop_cleanup(void *cls, const struct GNUNET_TESTING_Command *cmd)
The cleanup function of this cmd frees resources the cmd allocated.
static int netjail_stop_finish(void *cls, GNUNET_SCHEDULER_TaskCallback cont, void *cont_cls)
This function checks the flag NetJailState::finished, if this cmd finished.
static void netjail_stop_run(void *cls, const struct GNUNET_TESTING_Command *cmd, struct GNUNET_TESTING_Interpreter *is)
The run method starts the script which deletes the network namespaces.

Variable Documentation

◆ cwh