GNUnet  0.11.x
testing_api_cmd_netjail_stop.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2021 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_testing_ng_lib.h"
29 
30 
31 #define NETJAIL_STOP_SCRIPT "./../testing/netjail_stop.sh"
32 
33 // Child Wait handle
35 
40 struct NetJailState
41 {
42  // Number of local nodes in each namespace.
43  char *local_m;
44 
45  // The number of namespaces.
46  char *global_n;
47 
52 
53  // Flag indication if the script finished.
54  unsigned int finished;
55 };
56 
57 
62 static void
64  const struct GNUNET_TESTING_Command *cmd)
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 }
84 
85 
90 static int
92  const void **ret,
93  const char *trait,
94  unsigned int index)
95 {
96  return GNUNET_OK;
97 }
98 
99 
104 static void
107  long unsigned int exit_code)
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 }
123 
124 
132 static void
133 netjail_stop_run (void *cls,
134  const struct GNUNET_TESTING_Command *cmd,
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 }
175 
176 
181 static int
184  void *cont_cls)
185 {
186  struct NetJailState *ns = cls;
187 
188  if (ns->finished)
189  {
190  cont (cont_cls);
191  }
192  return ns->finished;
193 }
194 
195 
206  char *local_m,
207  char *global_n)
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 }
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
static struct GNUNET_NAMESTORE_Handle * ns
Handle to the namestore.
Definition: gnunet-abd.c:41
static long unsigned int exit_code
Handler exit code.
Definition: gnunet-qr.c:54
void GNUNET_wait_child_cancel(struct GNUNET_ChildWaitHandle *cwh)
Stop waiting on this child.
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_OK
Definition: gnunet_common.h:95
@ GNUNET_YES
Definition: gnunet_common.h:97
@ GNUNET_NO
Definition: gnunet_common.h:94
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
void GNUNET_TESTING_interpreter_fail()
Current command failed, clean up and fail the test case.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#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
#define GNUNET_new(type)
Allocate a struct or union of the given type.
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
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:983
GNUNET_OS_ProcessStatusType
Process status types.
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
@ 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
void(* GNUNET_SCHEDULER_TaskCallback)(void *cls)
Signature of the main function of a task.
Struct which defines a Child Wait handle.
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.
Global state of the interpreter, used by a command to access information about other commands.
Definition: testing.h:35
Struct to hold information for callbacks.
struct GNUNET_OS_Process * stop_proc
The process id of the start script.
char * local_m
Number of nodes in a network namespace.
char * global_n
Number of network namespaces.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_stop(const char *label, char *local_m, char *global_n)
Create command.
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 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.
static void netjail_stop_cleanup(void *cls, const struct GNUNET_TESTING_Command *cmd)
The cleanup function of this cmd frees resources the cmd allocated.
#define NETJAIL_STOP_SCRIPT
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.
struct GNUNET_ChildWaitHandle * cwh
struct GNUNET_TESTING_Interpreter * is