GNUnet  0.19.3
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 #include "gnunet_testing_plugin.h"
30 #include "gnunet_testing_barrier.h"
32 
33 
34 #define NETJAIL_STOP_SCRIPT "netjail_stop.sh"
35 
40 struct NetJailState
41 {
46 
47  // Child Wait handle
49 
53  char *topology_config;
54 
59 
63  unsigned int *read_file;
64 
65 };
66 
67 
72 static void
74 {
75  struct NetJailState *ns = cls;
76 
77  if (NULL != ns->cwh)
78  {
80  ns->cwh = NULL;
81  }
82  if (NULL != ns->stop_proc)
83  {
84  GNUNET_assert (0 ==
85  GNUNET_OS_process_kill (ns->stop_proc,
86  SIGKILL));
88  GNUNET_OS_process_wait (ns->stop_proc));
89  GNUNET_OS_process_destroy (ns->stop_proc);
90  ns->stop_proc = NULL;
91  }
92  GNUNET_free (ns);
93 }
94 
95 
100 static void
103  long unsigned int exit_code)
104 {
105  struct NetJailState *ns = cls;
106 
107  ns->cwh = NULL;
108  GNUNET_OS_process_destroy (ns->stop_proc);
109  ns->stop_proc = NULL;
110  if (0 == exit_code)
111  {
113  }
114  else
115  {
117  }
118 }
119 
120 
127 static void
128 netjail_stop_run (void *cls,
130 {
131  struct NetJailState *ns = cls;
132  char *pid;
133  char *data_dir;
134  char *script_name;
135  char *read_file;
136 
137 
139  GNUNET_asprintf (&script_name, "%s%s", data_dir, NETJAIL_STOP_SCRIPT);
140  GNUNET_asprintf (&read_file, "%u", *(ns->read_file));
141  unsigned int helper_check = GNUNET_OS_check_helper_binary (
142  script_name,
143  GNUNET_YES,
144  NULL);
145 
146  if (GNUNET_NO == helper_check)
147  {
149  "No SUID for %s!\n",
150  script_name);
152  }
153  else if (GNUNET_NO == helper_check)
154  {
156  "%s not found!\n",
157  script_name);
159  }
160 
162  "%u",
163  getpid ());
164  {
165  char *const script_argv[] = {script_name,
166  ns->topology_config,
167  pid,
168  read_file,
169  NULL};
171  NULL,
172  NULL,
173  NULL,
174  script_name,
175  script_argv);
176  }
177  ns->cwh = GNUNET_wait_child (ns->stop_proc,
179  ns);
180  GNUNET_break (NULL != ns->cwh);
182  GNUNET_free (pid);
183 }
184 
185 
188  char *topology_config,
189  unsigned int *read_file)
190 {
191  struct NetJailState *ns;
192 
193  ns = GNUNET_new (struct NetJailState);
194  ns->topology_config = topology_config;
195  ns->read_file = read_file;
196  return GNUNET_TESTING_command_new (ns, label,
199  NULL, &ns->ac);
200 }
static struct GNUNET_NAMESTORE_Handle * ns
Handle to the namestore.
Definition: gnunet-abd.c:41
struct GNUNET_TESTING_Interpreter * is
static int exit_code
Global exit code.
Definition: gnunet-qr.c:43
static struct GNUNET_PeerIdentity pid
Identity of the peer we transmit to / connect to.
API to manage barriers.
void GNUNET_TESTING_async_finish(struct GNUNET_TESTING_AsyncContext *ac)
The asynchronous command of ac has finished.
void GNUNET_TESTING_async_fail(struct GNUNET_TESTING_AsyncContext *ac)
The asynchronous command of ac has failed.
struct GNUNET_TESTING_Command GNUNET_TESTING_command_new(void *cls, const char *label, GNUNET_TESTING_CommandRunRoutine run, GNUNET_TESTING_CommandCleanupRoutine cleanup, GNUNET_TESTING_CommandGetTraits traits, struct GNUNET_TESTING_AsyncContext *ac)
Create a new command.
void GNUNET_TESTING_interpreter_fail(struct GNUNET_TESTING_Interpreter *is)
Current command failed, clean up and fail the test case.
#define GNUNET_log(kind,...)
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.
@ GNUNET_OK
@ GNUNET_YES
@ GNUNET_NO
#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
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
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:580
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:942
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:273
enum GNUNET_GenericReturnValue GNUNET_OS_check_helper_binary(const char *binary, bool check_suid, const char *params)
Check whether an executable exists and possibly if the suid bit is set on the file.
char * GNUNET_OS_installation_get_path(enum GNUNET_OS_InstallationPathKind dirkind)
Get the path to a specific GNUnet installation directory or, with GNUNET_OS_IPK_SELF_PREFIX,...
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:210
@ GNUNET_OS_INHERIT_STD_ERR
When this flag is set, the child process will inherit stderr of the parent.
Definition: gnunet_os_lib.h:95
@ GNUNET_OS_IPK_DATADIR
Return the directory where data is installed (share/gnunet/)
enum GNUNET_GenericReturnValue read_file(char const *const filename, char **buffer)
Definition: pabc_helper.c:71
Struct which defines a Child Wait handle.
State each asynchronous command must have in its closure.
A command to be run by the interpreter.
char label[127+1]
Label for the command.
Global state of the interpreter, used by a command to access information about other commands.
Struct to hold information for callbacks.
struct GNUNET_OS_Process * stop_proc
The process id of the start script.
struct GNUNET_ChildWaitHandle * cwh
unsigned int * read_file
Shall we read the topology from file, or from a string.
char * topology_config
Configuration file for the test topology.
struct GNUNET_TESTING_AsyncContext ac
Context for our asynchronous completion.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
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
struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_stop(const char *label, char *topology_config, unsigned int *read_file)
This command executes a shell script to remove the netjail environment.
static void netjail_stop_cleanup(void *cls)
The cleanup function of this cmd frees resources the cmd allocated.
static void netjail_stop_run(void *cls, struct GNUNET_TESTING_Interpreter *is)
The run method starts the script which deletes the network namespaces.