2 This file is part of GNUnet.
3 Copyright (C) 2011 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file util/test_common_logging_runtime_loglevels.c
23 * @brief testcase for the logging module (runtime log level adjustment)
27 #include "gnunet_util_lib.h"
29 #define VERBOSE GNUNET_NO
32 * How much time the child is allowed to waste on skipped log calls, at most.
33 * Raspberry Pi takes 113 microseconds tops, this is 3x that value.
35 #define MAX_SKIP_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, 400).rel_value_us
38 * How much time non-skipped log call should take, at least.
39 * Keep in sync with the value in the dummy!
41 #define OUTPUT_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS, 1000).rel_value_us
47 static struct GNUNET_OS_Process *proc;
49 /* Pipe to read from started processes stdout (on read end) */
50 static struct GNUNET_DISK_PipeHandle *pipe_stdout;
52 static struct GNUNET_SCHEDULER_Task * die_task;
54 static struct GNUNET_SCHEDULER_Task * read_task;
63 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending phase %d, ok is %d\n", phase,
67 if (0 != GNUNET_OS_process_kill (proc, GNUNET_TERM_SIG))
69 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
71 GNUNET_OS_process_wait (proc);
72 GNUNET_OS_process_destroy (proc);
75 if (NULL != read_task)
77 GNUNET_SCHEDULER_cancel (read_task);
80 GNUNET_DISK_pipe_close (pipe_stdout);
92 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "failing\n");
97 read_output_line (int phase_from1, int phase_to1, int phase_from2,
98 int phase_to2, char c, const char *expect_level,
99 long delay_morethan, long delay_lessthan, int phase,
101 int *len, long *delay, char level[8])
108 int delay_is_a_dummy;
109 int delay_outside_of_range;
114 if (!(phase >= phase_from1 && phase <= phase_to1) &&
115 !(phase >= phase_from2 && phase <= phase_to2))
118 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
119 "Trying to match '%c%s \\d\\r\\n' on %s\n", c, expect_level, p);
121 for (i = 0; i < *len && !stop; i++)
125 case 0: /* read first char */
128 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Expected '%c', but got '%c'\n", c,
135 case 1: /* read at most 7 char-long error level string, finished by ' ' */
151 case 2: /* read the delay, finished by '\n' */
154 if (r[i] == '\r' && r[i + 1] == '\n')
158 *delay = strtol (t, NULL, 10);
165 *delay = strtol (t, NULL, 10);
172 level_matches = (strcmp (expect_level, level) == 0);
173 delay_is_sane = (*delay >= 0) && (*delay <= 1000000);
174 delay_is_a_dummy = (c == 'L');
175 /* Delay must be either less than 'lessthan' (log call is skipped)
176 * or more than 'morethan' (log call is not skipped)
178 delay_outside_of_range = ((*delay < delay_lessthan) || (*delay >= delay_morethan));
179 if (delay_is_a_dummy)
180 delay_outside_of_range = 1;
183 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
184 "Wrong log format?\n");
186 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
187 "Wrong log level\n");
189 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
190 "Delay %ld is insane\n",
192 if (! delay_outside_of_range)
193 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
194 "Delay %ld is not outside of range (%ld ; %ld)\n",
198 if (!stop || !level_matches || !delay_is_sane || !delay_outside_of_range)
205 * Up to 8 non-skipped GNUNET_log() calls
206 * + extra line with delay for each one
208 #define LOG_MAX_NUM_LINES (8 * 2)
210 * Actual message is 17 chars at most
212 #define LOG_MAX_LINE_LENGTH (17)
214 #define LOG_BUFFER_SIZE LOG_MAX_NUM_LINES * LOG_MAX_LINE_LENGTH
216 static char buf[LOG_BUFFER_SIZE];
218 static char *buf_ptr;
224 read_call (void *cls)
226 const struct GNUNET_DISK_FileHandle *stdout_read_handle = cls;
233 rd = GNUNET_DISK_file_read (stdout_read_handle, buf_ptr,
234 sizeof (buf) - bytes);
240 FPRINTF (stderr, "got %d bytes, reading more\n", rd);
242 read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
245 (void*) stdout_read_handle);
250 FPRINTF (stderr, "bytes is %d:%s\n", bytes, buf);
253 /* +------CHILD OUTPUT--
264 * | 7D * * * * * * * *
270 if (bytes == LOG_BUFFER_SIZE ||
272 read_output_line (0, 3, 4, 9, 'L', "ERROR", -1,
274 &bytes, &delay, level)) ||
276 read_output_line (0, 3, 4, 9, '1', "ERROR", OUTPUT_DELAY,
277 MAX_SKIP_DELAY, phase, p,
278 &bytes, &delays[0], level)) ||
280 read_output_line (1, 3, 5, 9, 'L', "WARNING", -1,
282 &bytes, &delay, level)) ||
284 read_output_line (0, 3, 4, 9, '1', "WARNING", OUTPUT_DELAY,
285 MAX_SKIP_DELAY, phase, p,
286 &bytes, &delays[1], level)) ||
288 read_output_line (2, 3, 6, 7, 'L', "INFO", -1,
290 &bytes, &delay, level)) ||
292 read_output_line (0, 3, 4, 9, '1', "INFO", OUTPUT_DELAY,
293 MAX_SKIP_DELAY, phase, p,
294 &bytes, &delays[2], level)) ||
296 read_output_line (3, 3, 7, 7, 'L', "DEBUG", -1,
298 &bytes, &delay, level)) ||
300 read_output_line (0, 3, 4, 9, '1', "DEBUG", OUTPUT_DELAY,
301 MAX_SKIP_DELAY, phase, p,
302 &bytes, &delays[3], level)) ||
304 read_output_line (0, 3, 4, 9, 'L', "ERROR", -1,
306 &bytes, &delay, level)) ||
308 read_output_line (0, 3, 4, 9, '2', "ERROR", OUTPUT_DELAY,
309 MAX_SKIP_DELAY, phase, p,
310 &bytes, &delays[4], level)) ||
312 read_output_line (0, 3, 5, 9, 'L', "WARNING", -1,
314 &bytes, &delay, level)) ||
316 read_output_line (0, 3, 4, 9, '2', "WARNING", OUTPUT_DELAY,
317 MAX_SKIP_DELAY, phase, p,
318 &bytes, &delays[5], level)) ||
320 read_output_line (-1, -1, 6, 7, 'L', "INFO", -1,
322 &bytes, &delay, level)) ||
324 read_output_line (0, 3, 4, 9, '2', "INFO", OUTPUT_DELAY,
325 MAX_SKIP_DELAY, phase, p,
326 &bytes, &delays[6], level)) ||
328 read_output_line (-1, -1, 7, 7, 'L', "DEBUG", -1,
330 &bytes, &delay, level)) ||
332 read_output_line (0, 3, 4, 9, '2', "DEBUG", OUTPUT_DELAY,
333 MAX_SKIP_DELAY, phase, p,
334 &bytes, &delays[7], level)))
336 if (bytes == LOG_BUFFER_SIZE)
337 FPRINTF (stderr, "%s", "Ran out of buffer space!\n");
340 GNUNET_SCHEDULER_cancel (die_task);
341 GNUNET_SCHEDULER_add_now (&end_task, NULL);
345 GNUNET_SCHEDULER_cancel (die_task);
346 GNUNET_SCHEDULER_add_now (&end_task, NULL);
353 const struct GNUNET_DISK_FileHandle *stdout_read_handle;
355 pipe_stdout = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES);
357 if (pipe_stdout == NULL)
364 putenv ("GNUNET_LOG=");
365 putenv ("GNUNET_FORCE_LOG=");
366 putenv ("GNUNET_FORCE_LOGFILE=");
370 putenv ("GNUNET_LOG=;;;;ERROR");
373 putenv ("GNUNET_LOG=;;;;WARNING");
376 putenv ("GNUNET_LOG=;;;;INFO");
379 putenv ("GNUNET_LOG=;;;;DEBUG");
382 putenv ("GNUNET_FORCE_LOG=;;;;ERROR");
385 putenv ("GNUNET_FORCE_LOG=;;;;WARNING");
388 putenv ("GNUNET_FORCE_LOG=;;;;INFO");
391 putenv ("GNUNET_FORCE_LOG=;;;;DEBUG");
394 putenv ("GNUNET_LOG=blah;;;;ERROR");
397 putenv ("GNUNET_FORCE_LOG=blah;;;;ERROR");
401 proc = GNUNET_OS_start_process (GNUNET_NO, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
402 NULL, pipe_stdout, NULL,
404 "test_common_logging_dummy",
406 "./test_common_logging_dummy",
408 "test_common_logging_dummy", NULL);
409 GNUNET_assert (NULL != proc);
410 putenv ("GNUNET_FORCE_LOG=");
411 putenv ("GNUNET_LOG=");
413 /* Close the write end of the read pipe */
414 GNUNET_DISK_pipe_close_end (pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
417 GNUNET_DISK_pipe_handle (pipe_stdout, GNUNET_DISK_PIPE_END_READ);
420 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
421 (GNUNET_TIME_UNIT_SECONDS, 10),
427 memset (&buf, 0, sizeof (buf));
429 read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
432 (void*) stdout_read_handle);
445 main (int argc, char *argv[])
447 GNUNET_log_setup ("test-common-logging-runtime-loglevels",
451 GNUNET_SCHEDULER_run (&task, &ok);
455 /* end of test_common_logging_runtime_loglevels.c */