2 This file is part of GNUnet
3 (C) 2012 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file testbed/gnunet-testbed-helper.c
23 * @brief Helper binary that is started from a remote controller to start
24 * gnunet-service-testbed. This binary also receives configuration
25 * from the remove controller which is put in a temporary location
26 * with ports and paths fixed so that gnunet-service-testbed runs
27 * without any hurdles. This binary also kills the testbed service
28 * should the connection from the remote controller is dropped
29 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
34 #include "gnunet_util_lib.h"
35 #include "gnunet_testing_lib-new.h"
36 #include "gnunet_testbed_service.h"
37 #include "testbed_helper.h"
38 #include "testbed_api.h"
42 * Generic logging shortcut
44 #define LOG(kind, ...) \
45 GNUNET_log (kind, __VA_ARGS__)
48 * Debug logging shorthand
50 #define LOG_DEBUG(...) \
51 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
55 * Context for a single write on a chunk of memory
65 * The length of the data
70 * The current position from where the write operation should begin
77 * Handle to the testing system
79 static struct GNUNET_TESTING_System *test_system;
82 * Our message stream tokenizer
84 struct GNUNET_SERVER_MessageStreamTokenizer *tokenizer;
87 * Disk handle from stdin
89 static struct GNUNET_DISK_FileHandle *stdin_fd;
92 * Disk handle for stdout
94 static struct GNUNET_DISK_FileHandle *stdout_fd;
97 * The process handle to the testbed service
99 static struct GNUNET_OS_Process *testbed;
102 * Pipe handle to child's stdin
104 static struct GNUNET_DISK_PipeHandle *pipe_in;
107 * Pipe handle to child's stdout
109 static struct GNUNET_DISK_PipeHandle *pipe_out;
112 * Task identifier for the read task
114 static GNUNET_SCHEDULER_TaskIdentifier read_task_id;
117 * Task identifier for the write task
119 static GNUNET_SCHEDULER_TaskIdentifier write_task_id;
122 * Are we done reading messages from stdin?
124 static int done_reading;
127 * Result to return in case we fail
133 * Task to shutting down nicely
136 * @return tc the task context
139 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
141 LOG_DEBUG ("Shutting down\n");
142 if (GNUNET_SCHEDULER_NO_TASK != read_task_id)
144 GNUNET_SCHEDULER_cancel (read_task_id);
145 read_task_id = GNUNET_SCHEDULER_NO_TASK;
147 if (GNUNET_SCHEDULER_NO_TASK != write_task_id)
149 GNUNET_SCHEDULER_cancel (write_task_id);
150 write_task_id = GNUNET_SCHEDULER_NO_TASK;
152 if (NULL != stdin_fd)
153 (void) GNUNET_DISK_file_close (stdin_fd);
154 if (NULL != stdout_fd)
155 (void) GNUNET_DISK_file_close (stdin_fd);
156 GNUNET_SERVER_mst_destroy (tokenizer);
160 (void) GNUNET_OS_process_kill (testbed, SIGTERM);
161 GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (testbed));
162 GNUNET_OS_process_destroy (testbed);
167 (void) GNUNET_DISK_pipe_close (pipe_in);
170 if (NULL != pipe_out)
172 (void) GNUNET_DISK_pipe_close (pipe_out);
175 if (NULL != test_system)
177 GNUNET_TESTING_system_destroy (test_system, GNUNET_YES);
184 * Task to write to the standard out
190 write_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
192 struct WriteContext *wc = cls;
195 GNUNET_assert (NULL != wc);
196 write_task_id = GNUNET_SCHEDULER_NO_TASK;
197 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
199 GNUNET_free (wc->data);
203 bytes_wrote = GNUNET_DISK_file_write (stdout_fd, wc->data + wc->pos,
204 wc->length - wc->pos);
205 GNUNET_assert (GNUNET_SYSERR != bytes_wrote);
206 wc->pos += bytes_wrote;
207 if (wc->pos == wc->length)
209 GNUNET_free (wc->data);
213 write_task_id = GNUNET_SCHEDULER_add_write_file
214 (GNUNET_TIME_UNIT_FOREVER_REL, stdout_fd, &write_task, wc);
219 * Functions with this signature are called whenever a
220 * complete message is received by the tokenizer.
222 * Do not call GNUNET_SERVER_mst_destroy in callback
225 * @param client identification of the client
226 * @param message the actual message
228 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
231 tokenizer_cb (void *cls, void *client,
232 const struct GNUNET_MessageHeader *message)
234 const struct GNUNET_TESTBED_HelperInit *msg;
235 struct GNUNET_TESTBED_HelperReply *reply;
236 struct GNUNET_CONFIGURATION_Handle *cfg;
237 struct WriteContext *wc;
242 uLongf ul_config_size;
246 if ((sizeof (struct GNUNET_TESTBED_HelperInit) >= ntohs (message->size)) ||
247 (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT != ntohs (message->type)))
249 LOG (GNUNET_ERROR_TYPE_WARNING,
250 "Received unexpected message -- exiting\n");
253 msg = (const struct GNUNET_TESTBED_HelperInit *) message;
254 cname_size = ntohs (msg->cname_size);
255 controller = (char *) &msg[1];
256 if ('\0' != controller[cname_size])
258 LOG (GNUNET_ERROR_TYPE_WARNING,
259 "Controller name cannot be empty -- exiting\n");
262 ul_config_size = (uLongf) ntohs (msg->config_size);
263 config = GNUNET_malloc (ul_config_size);
264 xconfig_size = ntohs (message->size) -
265 (cname_size + 1 + sizeof (struct GNUNET_TESTBED_HelperInit));
266 if (Z_OK != uncompress ((Bytef *) config, &ul_config_size,
267 (const Bytef *) (controller + cname_size + 1),
268 (uLongf) xconfig_size))
270 LOG (GNUNET_ERROR_TYPE_WARNING,
271 "Error while uncompressing config -- exiting\n");
272 GNUNET_free (config);
275 cfg = GNUNET_CONFIGURATION_create ();
276 if (GNUNET_OK != GNUNET_CONFIGURATION_deserialize (cfg, config,
277 ul_config_size, GNUNET_NO))
279 LOG (GNUNET_ERROR_TYPE_WARNING,
280 "Unable to deserialize config -- exiting\n");
281 GNUNET_free (config);
284 GNUNET_free (config);
285 test_system = GNUNET_TESTING_system_create ("testbed-helper", controller);
286 GNUNET_assert (NULL != test_system);
287 GNUNET_assert (GNUNET_OK == GNUNET_TESTING_configuration_create
289 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string
290 (cfg, "PATHS", "DEFAULTCONFIG", &config));
291 pipe_in = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_YES, GNUNET_NO);
292 pipe_out = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO, GNUNET_YES);
293 if ((NULL == pipe_in) || (NULL == pipe_out))
295 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
296 GNUNET_free (config);
299 if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, config))
301 LOG (GNUNET_ERROR_TYPE_WARNING,
302 "Unable to write config file: %s -- exiting\n", config);
303 GNUNET_free (config);
306 LOG_DEBUG ("Staring testbed with config: %s\n", config);
307 testbed = GNUNET_OS_start_process
308 (GNUNET_YES, GNUNET_OS_INHERIT_STD_ERR /*verbose? */, pipe_in, pipe_out,
309 "gnunet-service-testbed", "gnunet-service-testbed", "-c", config, NULL);
310 GNUNET_free (config);
313 LOG (GNUNET_ERROR_TYPE_WARNING,
314 "Error staring gnunet-service-testbed -- exiting\n");
317 GNUNET_DISK_pipe_close_end (pipe_out, GNUNET_DISK_PIPE_END_WRITE);
318 GNUNET_DISK_pipe_close_end (pipe_in, GNUNET_DISK_PIPE_END_READ);
319 done_reading = GNUNET_YES;
320 config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
321 xconfig_size = GNUNET_TESTBED_compress_config (config, config_size, &xconfig);
322 wc = GNUNET_malloc (sizeof (struct WriteContext));
323 wc->length = xconfig_size + sizeof (struct GNUNET_TESTBED_HelperReply);
324 reply = GNUNET_realloc (xconfig, wc->length);
325 memmove (&reply[1], reply, xconfig_size);
326 reply->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY);
327 reply->header.size = htons ((uint16_t) wc->length);
328 reply->config_size = htons ((uint16_t) config_size);
330 write_task_id = GNUNET_SCHEDULER_add_write_file
331 (GNUNET_TIME_UNIT_FOREVER_REL, stdout_fd, &write_task, wc);
336 GNUNET_SCHEDULER_shutdown ();
337 return GNUNET_SYSERR;
342 * Task to read from stdin
345 * @return tc the task context
348 read_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
350 char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
353 read_task_id = GNUNET_SCHEDULER_NO_TASK;
354 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
356 sread = GNUNET_DISK_file_read (stdin_fd, buf, sizeof (buf));
357 if (GNUNET_SYSERR == sread)
359 GNUNET_break (0); /* FIXME: stdin closed - kill child */
360 GNUNET_SCHEDULER_shutdown ();
363 if (GNUNET_YES == done_reading)
365 /* didn't expect any more data! */
367 GNUNET_SCHEDULER_shutdown ();
370 LOG_DEBUG ("Read %u bytes\n", sread);
372 GNUNET_SERVER_mst_receive (tokenizer, NULL, buf, sread,
373 GNUNET_NO, GNUNET_NO))
376 GNUNET_SCHEDULER_shutdown ();
379 read_task_id = /* No timeout while reading */
380 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
381 stdin_fd, &read_task, NULL);
386 * Main function that will be run.
389 * @param args remaining command-line arguments
390 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
391 * @param cfg configuration
394 run (void *cls, char *const *args, const char *cfgfile,
395 const struct GNUNET_CONFIGURATION_Handle * cfg)
397 LOG_DEBUG ("Starting testbed helper...\n");
398 tokenizer = GNUNET_SERVER_mst_create (&tokenizer_cb, NULL);
399 stdin_fd = GNUNET_DISK_get_handle_from_native (stdin);
400 stdout_fd = GNUNET_DISK_get_handle_from_native (stdout);
402 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
403 stdin_fd, &read_task, NULL);
404 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
405 &shutdown_task, NULL);
412 * @param argc the number of command line arguments
413 * @param argv command line arg array
414 * @return return code
416 int main (int argc, char **argv)
418 struct GNUNET_GETOPT_CommandLineOption options[] = {
419 GNUNET_GETOPT_OPTION_END
424 GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-helper",
425 "Helper for starting gnunet-service-testbed",
426 options, &run, NULL))
428 return (GNUNET_OK == ret) ? 0 : 1;
431 /* end of gnunet-testbed-helper.c */