GNUnet  0.19.3
testing_api_cmd_netjail_start.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 #define NETJAIL_START_SCRIPT "netjail_start.sh"
34 
35 #define LOG(kind, ...) GNUNET_log (kind, __VA_ARGS__)
36 
42 {
47 
48  // Child Wait handle
50 
55 
60 
64  unsigned int *read_file;
65 };
66 
67 
72 static void
74 {
75  struct NetJailState *ns = cls;
76 
78  "netjail_start_cleanup!\n");
79 
80  if (NULL != ns->cwh)
81  {
83  "Cancel child\n");
85  ns->cwh = NULL;
86  }
87  if (NULL != ns->start_proc)
88  {
90  "Kill process\n");
91  GNUNET_assert (0 ==
92  GNUNET_OS_process_kill (ns->start_proc,
93  SIGKILL));
95  GNUNET_OS_process_wait (ns->start_proc));
96  GNUNET_OS_process_destroy (ns->start_proc);
97  ns->start_proc = NULL;
98  }
99  GNUNET_free (ns);
100 }
101 
102 
107 static void
110  long unsigned int exit_code)
111 {
112  struct NetJailState *ns = cls;
113 
114  GNUNET_OS_process_destroy (ns->start_proc);
115  ns->start_proc = NULL;
116  ns->cwh = NULL;
117  if (0 == exit_code)
118  {
120  }
121  else
122  {
124  "Child failed with error %lu!\n",
125  exit_code);
127  }
128 }
129 
130 
137 static void
138 netjail_start_run (void *cls,
140 {
141  struct NetJailState *ns = cls;
142  char pid[15];
143  enum GNUNET_GenericReturnValue helper_check;
144  char *data_dir;
145  char *script_name;
146  char *read_file;
147 
149  GNUNET_asprintf (&script_name, "%s%s", data_dir, NETJAIL_START_SCRIPT);
150  GNUNET_asprintf (&read_file, "%u", *(ns->read_file));
151 
152  helper_check = GNUNET_OS_check_helper_binary (
153  script_name,
154  GNUNET_YES,
155  NULL);
156 
158  "script_name %s\n",
159  script_name);
160 
161  if (GNUNET_NO == helper_check)
162  {
164  "No SUID for %s!\n",
165  script_name);
167  return;
168  }
169  if (GNUNET_SYSERR == helper_check)
170  {
172  "%s not found!\n",
173  script_name);
175  return;
176  }
177 
179  sizeof (pid),
180  "%u",
181  getpid ());
182  {
183  char *const script_argv[] = {
184  script_name,
185  ns->topology_config,
186  pid,
187  read_file,
188  NULL
189  };
190 
191  ns->start_proc
193  NULL,
194  NULL,
195  NULL,
196  script_name,
197  script_argv);
198 
199  }
200  ns->cwh = GNUNET_wait_child (ns->start_proc,
202  ns);
203  GNUNET_break (NULL != ns->cwh);
205  GNUNET_free (script_name);
206  GNUNET_free (data_dir);
207 }
208 
209 
219  char *topology_config,
220  unsigned int *read_file)
221 {
222  struct NetJailState *ns;
223 
224  ns = GNUNET_new (struct NetJailState);
225  ns->topology_config = topology_config;
226  ns->read_file = read_file;
227  return GNUNET_TESTING_command_new (ns, label,
230  NULL, &ns->ac);
231 }
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.
GNUNET_GenericReturnValue
Named constants for return values.
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
@ GNUNET_SYSERR
#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
@ GNUNET_ERROR_TYPE_DEBUG
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
int GNUNET_snprintf(char *buf, size_t size, const char *format,...) __attribute__((format(printf
Like snprintf, just aborts if the buffer is of insufficient size.
#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_ChildWaitHandle * cwh
struct GNUNET_OS_Process * start_proc
The process id of the start script.
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
struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_netjail_start(const char *label, char *topology_config, unsigned int *read_file)
Create command.
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_start_run(void *cls, struct GNUNET_TESTING_Interpreter *is)
The run method starts the script which setup the network namespaces.
#define LOG(kind,...)
#define NETJAIL_START_SCRIPT
static void netjail_start_cleanup(void *cls)
The cleanup function of this cmd frees resources the cmd allocated.