2 This file is part of GNUnet.
3 Copyright (C) 2006-2013 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/>.
20 * @file util/common_logging.c
21 * @brief error handling API
22 * @author Christian Grothoff
25 #include "gnunet_crypto_lib.h"
26 #include "gnunet_disk_lib.h"
27 #include "gnunet_strings_lib.h"
32 * After how many milliseconds do we always print
33 * that "message X was repeated N times"? Use 12h.
35 #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000LL * 1000LL)
38 * After how many repetitions do we always print
39 * that "message X was repeated N times"? (even if
40 * we have not yet reached the delay threshold)
42 #define BULK_REPEAT_THRESHOLD 1000
45 * How many characters do we use for matching of
48 #define BULK_TRACK_SIZE 256
51 * How many characters do we use for matching of
54 #define COMP_TRACK_SIZE 32
57 * How many characters can a date/time string
60 #define DATE_STR_SIZE 64
63 * How many log files to keep?
65 #define ROTATION_KEEP 3
69 * Assumed maximum path length (for the log file name).
76 * Linked list of active loggers.
81 * This is a linked list.
83 struct CustomLogger *next;
97 * The last "bulk" error message that we have been logging.
98 * Note that this message maybe truncated to the first BULK_TRACK_SIZE
99 * characters, in which case it is NOT 0-terminated!
101 static char last_bulk[BULK_TRACK_SIZE];
104 * Type of the last bulk message.
106 static enum GNUNET_ErrorType last_bulk_kind;
109 * Time of the last bulk error message (0 for none)
111 static struct GNUNET_TIME_Absolute last_bulk_time;
114 * Number of times that bulk message has been repeated since.
116 static unsigned int last_bulk_repeat;
119 * Component when the last bulk was logged. Will be 0-terminated.
121 static char last_bulk_comp[COMP_TRACK_SIZE + 1];
126 static char *component;
129 * Running component (without pid).
131 static char *component_nopid;
134 * Format string describing the name of the log file.
136 static char *log_file_name;
141 static enum GNUNET_ErrorType min_level;
144 * Linked list of our custom loggres.
146 static struct CustomLogger *loggers;
149 * Number of log calls to ignore.
151 static int skip_log = 0;
154 * File descriptor to use for "stderr", or NULL for none.
156 static FILE *GNUNET_stderr;
159 * Represents a single logging definition
164 * Component name regex
166 regex_t component_regex;
174 * Function name regex
176 regex_t function_regex;
179 * Lowest line at which this definition matches.
180 * Defaults to 0. Must be <= to_line.
185 * Highest line at which this definition matches.
186 * Defaults to INT_MAX. Must be >= from_line.
191 * Maximal log level allowed for calls that match this definition.
192 * Calls with higher log level will be disabled.
198 * 1 if this definition comes from GNUNET_FORCE_LOG, which means that it
199 * overrides any configuration options. 0 otherwise.
205 #if !defined(GNUNET_CULL_LOGGING)
207 * Dynamic array of logging definitions
209 static struct LogDef *logdefs;
212 * Allocated size of logdefs array (in units)
214 static int logdefs_size;
217 * The number of units used in logdefs array.
219 static int logdefs_len;
222 * #GNUNET_YES if GNUNET_LOG environment variable is already parsed.
224 static int gnunet_log_parsed;
227 * #GNUNET_YES if GNUNET_FORCE_LOG environment variable is already parsed.
229 static int gnunet_force_log_parsed;
232 * #GNUNET_YES if at least one definition with forced == 1 is available.
234 static int gnunet_force_log_present;
239 * Contains the number of performance counts per second.
241 static LARGE_INTEGER performance_frequency;
246 * Convert a textual description of a loglevel
247 * to the respective GNUNET_GE_KIND.
249 * @param log loglevel to parse
250 * @return GNUNET_GE_INVALID if log does not parse
252 static enum GNUNET_ErrorType
253 get_type (const char *log)
256 return GNUNET_ERROR_TYPE_UNSPECIFIED;
257 if (0 == strcasecmp (log, _("DEBUG")))
258 return GNUNET_ERROR_TYPE_DEBUG;
259 if (0 == strcasecmp (log, _("INFO")))
260 return GNUNET_ERROR_TYPE_INFO;
261 if (0 == strcasecmp (log, _("MESSAGE")))
262 return GNUNET_ERROR_TYPE_MESSAGE;
263 if (0 == strcasecmp (log, _("WARNING")))
264 return GNUNET_ERROR_TYPE_WARNING;
265 if (0 == strcasecmp (log, _("ERROR")))
266 return GNUNET_ERROR_TYPE_ERROR;
267 if (0 == strcasecmp (log, _("NONE")))
268 return GNUNET_ERROR_TYPE_NONE;
269 return GNUNET_ERROR_TYPE_INVALID;
274 * Abort the process, generate a core dump if possible.
286 #if !defined(GNUNET_CULL_LOGGING)
288 * Utility function - reallocates logdefs array to be twice as large.
293 logdefs_size = (logdefs_size + 1) * 2;
294 logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
298 #if ! TALER_WALLET_ONLY
300 * Rotate logs, deleting the oldest log.
302 * @param new_name new name to add to the rotation
305 log_rotate (const char *new_name)
307 static char *rotation[ROTATION_KEEP];
308 static unsigned int rotation_off;
311 if ('\0' == *new_name)
312 return; /* not a real log file name */
313 discard = rotation[rotation_off % ROTATION_KEEP];
316 /* Note: can't log errors during logging (recursion!), so this
317 operation MUST silently fail... */
318 (void) UNLINK (discard);
319 GNUNET_free (discard);
321 rotation[rotation_off % ROTATION_KEEP] = GNUNET_strdup (new_name);
327 * Setup the log file.
329 * @param tm timestamp for which we should setup logging
330 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
333 setup_log_file (const struct tm *tm)
335 static char last_fn[PATH_MAX + 1];
336 char fn[PATH_MAX + 1];
342 if (NULL == log_file_name)
343 return GNUNET_SYSERR;
344 if (0 == strftime (fn, sizeof (fn), log_file_name, tm))
345 return GNUNET_SYSERR;
346 leftsquare = strrchr (fn, '[');
347 if ( (NULL != leftsquare) && (']' == leftsquare[1]) )
349 char *logfile_copy = GNUNET_strdup (fn);
351 logfile_copy[leftsquare - fn] = '\0';
352 logfile_copy[leftsquare - fn + 1] = '\0';
358 &logfile_copy[leftsquare - fn + 2]);
359 GNUNET_free (logfile_copy);
361 if (0 == strcmp (fn, last_fn))
362 return GNUNET_OK; /* no change */
363 log_rotate (last_fn);
364 strcpy (last_fn, fn);
366 GNUNET_DISK_directory_create_for_file (fn))
369 "Failed to create directory for `%s': %s\n",
372 return GNUNET_SYSERR;
375 altlog_fd = OPEN (fn, O_APPEND |
378 _S_IREAD | _S_IWRITE);
380 altlog_fd = OPEN (fn, O_APPEND |
382 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
386 if (NULL != GNUNET_stderr)
387 fclose (GNUNET_stderr);
388 dup_return = dup2 (altlog_fd, 2);
389 (void) close (altlog_fd);
390 if (-1 != dup_return)
392 altlog = fdopen (2, "ab");
406 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", fn);
407 return GNUNET_SYSERR;
409 GNUNET_stderr = altlog;
416 * Utility function - adds a parsed definition to logdefs array.
418 * @param component see struct LogDef, can't be NULL
419 * @param file see struct LogDef, can't be NULL
420 * @param function see struct LogDef, can't be NULL
421 * @param from_line see struct LogDef
422 * @param to_line see struct LogDef
423 * @param level see struct LogDef, must be >= 0
424 * @param force see struct LogDef
425 * @return 0 on success, regex-specific error otherwise
428 add_definition (const char *component,
430 const char *function,
439 if (logdefs_size == logdefs_len)
441 memset (&n, 0, sizeof (n));
442 if (0 == strlen (component))
443 component = (char *) ".*";
444 r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
449 if (0 == strlen (file))
450 file = (char *) ".*";
451 r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
454 regfree (&n.component_regex);
457 if ((NULL == function) || (0 == strlen (function)))
458 function = (char *) ".*";
459 r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
462 regfree (&n.component_regex);
463 regfree (&n.file_regex);
466 n.from_line = from_line;
470 logdefs[logdefs_len++] = n;
476 * Decides whether a particular logging call should or should not be allowed
477 * to be made. Used internally by GNUNET_log*()
479 * @param caller_level loglevel the caller wants to use
480 * @param comp component name the caller uses (NULL means that global
481 * component name is used)
482 * @param file file name containing the logging call, usually __FILE__
483 * @param function function which tries to make a logging call,
484 * usually __FUNCTION__
485 * @param line line at which the call is made, usually __LINE__
486 * @return 0 to disallow the call, 1 to allow it
489 GNUNET_get_log_call_status (int caller_level,
492 const char *function,
500 /* Use default component */
501 comp = component_nopid;
503 /* We have no definitions to override globally configured log level,
504 * so just use it right away.
506 if ( (min_level >= 0) && (GNUNET_NO == gnunet_force_log_present) )
507 return caller_level <= min_level;
509 /* Only look for forced definitions? */
510 force_only = min_level >= 0;
511 for (i = 0; i < logdefs_len; i++)
514 if (( (!force_only) || ld->force) &&
515 (line >= ld->from_line && line <= ld->to_line) &&
516 (0 == regexec (&ld->component_regex, comp, 0, NULL, 0)) &&
517 (0 == regexec (&ld->file_regex, file, 0, NULL, 0)) &&
518 (0 == regexec (&ld->function_regex, function, 0, NULL, 0)))
521 return caller_level <= ld->level;
524 /* No matches - use global level, if defined */
526 return caller_level <= min_level;
527 /* All programs/services previously defaulted to WARNING.
528 * Now *we* default to WARNING, and THEY default to NULL.
529 * Or rather we default to MESSAGE, since things aren't always bad.
531 return caller_level <= GNUNET_ERROR_TYPE_MESSAGE;
536 * Utility function - parses a definition
539 * component;file;function;from_line-to_line;level[/component...]
540 * All entries are mandatory, but may be empty.
541 * Empty entries for component, file and function are treated as
542 * "matches anything".
543 * Empty line entry is treated as "from 0 to INT_MAX"
544 * Line entry with only one line is treated as "this line only"
545 * Entry for level MUST NOT be empty.
546 * Entries for component, file and function that consist of a
547 * single character "*" are treated (at the moment) the same way
548 * empty entries are treated (wildcard matching is not implemented (yet?)).
549 * file entry is matched to the end of __FILE__. That is, it might be
550 * a base name, or a base name with leading directory names (some compilers
551 * define __FILE__ to absolute file path).
553 * @param constname name of the environment variable from which to get the
554 * string to be parsed
555 * @param force 1 if definitions found in constname are to be forced
556 * @return number of added definitions
559 parse_definitions (const char *constname, int force)
565 char *function = NULL;
571 int from_line, to_line;
573 int keep_looking = 1;
575 tmp = getenv (constname);
578 def = GNUNET_strdup (tmp);
581 for (p = def, state = 0, start = def; keep_looking; p++)
585 case ';': /* found a field separator */
589 case 0: /* within a component name */
592 case 1: /* within a file name */
595 case 2: /* within a function name */
596 /* after a file name there must be a function name */
599 case 3: /* within a from-to line range */
600 if (strlen (start) > 0)
603 from_line = strtol (start, &t, 10);
604 if ( (0 != errno) || (from_line < 0) )
609 if ( (t < p) && ('-' == t[0]) )
613 to_line = strtol (start, &t, 10);
614 if ( (0 != errno) || (to_line < 0) || (t != p) )
620 else /* one number means "match this line only" */
623 else /* default to 0-max */
630 fprintf(stderr, "ERROR: Unable to parse log defintion: Syntax error.\n");
636 case '\0': /* found EOL */
638 /* fall through to '/' */
639 case '/': /* found a definition separator */
642 case 4: /* within a log level */
645 level = get_type ((const char *) start);
646 if ( (GNUNET_ERROR_TYPE_INVALID == level) ||
647 (GNUNET_ERROR_TYPE_UNSPECIFIED == level) ||
648 (0 != add_definition (comp, file, function, from_line, to_line,
658 fprintf(stderr, "ERROR: Unable to parse log defintion: Syntax error.\n");
671 * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
674 parse_all_definitions ()
676 if (GNUNET_NO == gnunet_log_parsed)
677 parse_definitions ("GNUNET_LOG", 0);
678 gnunet_log_parsed = GNUNET_YES;
679 if (GNUNET_NO == gnunet_force_log_parsed)
680 gnunet_force_log_present =
681 parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
682 gnunet_force_log_parsed = GNUNET_YES;
690 * @param comp default component to use
691 * @param loglevel what types of messages should be logged
692 * @param logfile which file to write log messages to (can be NULL)
693 * @return #GNUNET_OK on success
696 GNUNET_log_setup (const char *comp,
697 const char *loglevel,
700 const char *env_logfile;
702 min_level = get_type (loglevel);
703 #if !defined(GNUNET_CULL_LOGGING)
704 parse_all_definitions ();
707 QueryPerformanceFrequency (&performance_frequency);
709 GNUNET_free_non_null (component);
710 GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
711 GNUNET_free_non_null (component_nopid);
712 component_nopid = GNUNET_strdup (comp);
714 env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
715 if ((NULL != env_logfile) && (strlen (env_logfile) > 0))
716 logfile = env_logfile;
719 GNUNET_free_non_null (log_file_name);
720 log_file_name = GNUNET_STRINGS_filename_expand (logfile);
721 if (NULL == log_file_name)
722 return GNUNET_SYSERR;
723 #if TALER_WALLET_ONLY || defined(GNUNET_CULL_LOGGING)
724 /* log file option not allowed for wallet logic */
725 GNUNET_assert (NULL == logfile);
734 return setup_log_file (tm);
741 * Add a custom logger. Note that installing any custom logger
742 * will disable the standard logger. When multiple custom loggers
743 * are installed, all will be called. The standard logger will
744 * only be used if no custom loggers are present.
746 * @param logger log function
747 * @param logger_cls closure for @a logger
750 GNUNET_logger_add (GNUNET_Logger logger,
753 struct CustomLogger *entry;
755 entry = GNUNET_new (struct CustomLogger);
756 entry->logger = logger;
757 entry->logger_cls = logger_cls;
758 entry->next = loggers;
764 * Remove a custom logger.
766 * @param logger log function
767 * @param logger_cls closure for @a logger
770 GNUNET_logger_remove (GNUNET_Logger logger,
773 struct CustomLogger *pos;
774 struct CustomLogger *prev;
778 while ((NULL != pos) &&
779 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
784 GNUNET_assert (NULL != pos);
788 prev->next = pos->next;
793 CRITICAL_SECTION output_message_cs;
798 * Actually output the log message.
800 * @param kind how severe was the issue
801 * @param comp component responsible
802 * @param datestr current date/time
803 * @param msg the actual message
806 output_message (enum GNUNET_ErrorType kind,
811 struct CustomLogger *pos;
814 EnterCriticalSection (&output_message_cs);
816 /* only use the standard logger if no custom loggers are present */
817 if ( (NULL != GNUNET_stderr) &&
820 if (kind == GNUNET_ERROR_TYPE_MESSAGE) {
821 /* The idea here is to produce "normal" output messages
822 * for end users while still having the power of the
823 * logging engine for developer needs. So ideally this
824 * is what it should look like when CLI tools are used
825 * interactively, yet the same message shouldn't look
826 * this way if the output is going to logfiles or robots
827 * instead. Is this the right place to do this? --lynX
829 FPRINTF (GNUNET_stderr,
833 FPRINTF (GNUNET_stderr,
837 GNUNET_error_type_to_string (kind),
840 fflush (GNUNET_stderr);
845 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
849 LeaveCriticalSection (&output_message_cs);
855 * Flush an existing bulk report to the output.
857 * @param datestr our current timestamp
860 flush_bulk (const char *datestr)
862 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
867 if ( (0 == last_bulk_time.abs_value_us) ||
868 (0 == last_bulk_repeat) )
871 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
873 last = &last_bulk[BULK_TRACK_SIZE - 1];
874 else if (last != last_bulk)
881 ft = GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
882 (last_bulk_time), GNUNET_YES);
883 snprintf (msg, sizeof (msg),
884 _("Message `%.*s' repeated %u times in the last %s\n"),
885 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
888 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
889 last_bulk_time = GNUNET_TIME_absolute_get ();
890 last_bulk_repeat = 0;
895 * Ignore the next n calls to the log function.
897 * @param n number of log calls to ignore (could be negative)
898 * @param check_reset #GNUNET_YES to assert that the log skip counter is currently zero
901 GNUNET_log_skip (int n,
908 ok = (0 == skip_log);
921 * Get the number of log calls that are going to be skipped
923 * @return number of log calls to be ignored
926 GNUNET_get_log_skip ()
933 * Output a log message using the default mechanism.
935 * @param kind how severe was the issue
936 * @param comp component responsible
937 * @param message the actual message
938 * @param va arguments to the format string "message"
941 mylog (enum GNUNET_ErrorType kind,
946 char date[DATE_STR_SIZE];
947 char date2[DATE_STR_SIZE];
953 size = VSNPRINTF (NULL,
957 GNUNET_assert (0 != size);
969 offset = GNUNET_TIME_get_offset ();
971 timetmp += offset / 1000;
972 tmptr = localtime (&timetmp);
974 QueryPerformanceCounter (&pc);
977 strcpy (date, "localtime error");
984 "%b %d %H:%M:%S-%%020llu",
991 (long long) (pc.QuadPart /
992 (performance_frequency.QuadPart / 1000))))
996 struct timeval timeofday;
998 gettimeofday (&timeofday,
1000 offset = GNUNET_TIME_get_offset ();
1003 timeofday.tv_sec += offset / 1000LL;
1004 timeofday.tv_usec += (offset % 1000LL) * 1000LL;
1005 if (timeofday.tv_usec > 1000000LL)
1007 timeofday.tv_usec -= 1000000LL;
1013 timeofday.tv_sec += offset / 1000LL;
1014 if (timeofday.tv_usec > - (offset % 1000LL) * 1000LL)
1016 timeofday.tv_usec += (offset % 1000LL) * 1000LL;
1020 timeofday.tv_usec += 1000000LL + (offset % 1000LL) * 1000LL;
1024 tmptr = localtime (&timeofday.tv_sec);
1035 "%b %d %H:%M:%S-%%06u",
1050 #if ! (defined(GNUNET_CULL_LOGGING) || TALER_WALLET_ONLY)
1052 (void) setup_log_file (tmptr);
1054 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
1055 (0 != last_bulk_time.abs_value_us) &&
1058 sizeof (last_bulk))))
1061 if ( (GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value_us >
1062 BULK_DELAY_THRESHOLD) ||
1063 (last_bulk_repeat > BULK_REPEAT_THRESHOLD) )
1070 sizeof (last_bulk));
1071 last_bulk_repeat = 0;
1072 last_bulk_kind = kind;
1073 last_bulk_time = GNUNET_TIME_absolute_get ();
1074 strncpy (last_bulk_comp,
1077 output_message (kind,
1086 * Main log function.
1088 * @param kind how serious is the error?
1089 * @param message what is the message (format string)
1090 * @param ... arguments for format string
1093 GNUNET_log_nocheck (enum GNUNET_ErrorType kind,
1094 const char *message, ...)
1098 va_start (va, message);
1099 mylog (kind, component, message, va);
1105 * Log function that specifies an alternative component.
1106 * This function should be used by plugins.
1108 * @param kind how serious is the error?
1109 * @param comp component responsible for generating the message
1110 * @param message what is the message (format string)
1111 * @param ... arguments for format string
1114 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
1115 const char *message, ...)
1118 char comp_w_pid[128];
1121 comp = component_nopid;
1123 va_start (va, message);
1124 GNUNET_snprintf (comp_w_pid, sizeof (comp_w_pid), "%s-%d", comp, getpid ());
1125 mylog (kind, comp_w_pid, message, va);
1131 * Convert error type to string.
1133 * @param kind type to convert
1134 * @return string corresponding to the type
1137 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
1139 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
1141 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
1142 return _("WARNING");
1143 if ((kind & GNUNET_ERROR_TYPE_MESSAGE) > 0)
1144 return _("MESSAGE");
1145 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
1147 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
1149 if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
1151 return _("INVALID");
1156 * Convert a hash to a string (for printing debug messages).
1157 * This is one of the very few calls in the entire API that is
1160 * @param hc the hash code
1161 * @return string form; will be overwritten by next call to GNUNET_h2s.
1164 GNUNET_h2s (const struct GNUNET_HashCode * hc)
1166 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1168 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
1169 ret.encoding[8] = '\0';
1170 return (const char *) ret.encoding;
1175 * Convert a hash to a string (for printing debug messages).
1176 * This is one of the very few calls in the entire API that is
1177 * NOT reentrant! Identical to #GNUNET_h2s(), except that another
1178 * buffer is used so both #GNUNET_h2s() and #GNUNET_h2s2() can be
1179 * used within the same log statement.
1181 * @param hc the hash code
1182 * @return string form; will be overwritten by next call to GNUNET_h2s.
1185 GNUNET_h2s2 (const struct GNUNET_HashCode * hc)
1187 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1189 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
1190 ret.encoding[8] = '\0';
1191 return (const char *) ret.encoding;
1197 * Convert a public key value to a string (for printing debug messages).
1198 * This is one of the very few calls in the entire API that is
1201 * @param hc the hash code
1205 GNUNET_p2s (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
1207 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1208 struct GNUNET_HashCode hc;
1210 GNUNET_CRYPTO_hash (p,
1213 GNUNET_CRYPTO_hash_to_enc (&hc,
1215 ret.encoding[6] = '\0';
1216 return (const char *) ret.encoding;
1222 * Convert a public key value to a string (for printing debug messages).
1223 * This is one of the very few calls in the entire API that is
1226 * @param hc the hash code
1230 GNUNET_p2s2 (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
1232 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1233 struct GNUNET_HashCode hc;
1235 GNUNET_CRYPTO_hash (p,
1238 GNUNET_CRYPTO_hash_to_enc (&hc,
1240 ret.encoding[6] = '\0';
1241 return (const char *) ret.encoding;
1247 * Convert a public key value to a string (for printing debug messages).
1248 * This is one of the very few calls in the entire API that is
1251 * @param hc the hash code
1255 GNUNET_e2s (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
1257 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1258 struct GNUNET_HashCode hc;
1260 GNUNET_CRYPTO_hash (p,
1263 GNUNET_CRYPTO_hash_to_enc (&hc,
1265 ret.encoding[6] = '\0';
1266 return (const char *) ret.encoding;
1272 * Convert a public key value to a string (for printing debug messages).
1273 * This is one of the very few calls in the entire API that is
1276 * @param hc the hash code
1280 GNUNET_e2s2 (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
1282 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1283 struct GNUNET_HashCode hc;
1285 GNUNET_CRYPTO_hash (p,
1288 GNUNET_CRYPTO_hash_to_enc (&hc,
1290 ret.encoding[6] = '\0';
1291 return (const char *) ret.encoding;
1297 * Convert a short hash value to a string (for printing debug messages).
1298 * This is one of the very few calls in the entire API that is
1301 * @param shc the hash code
1305 GNUNET_sh2s (const struct GNUNET_ShortHashCode *shc)
1307 static char buf[64];
1309 GNUNET_STRINGS_data_to_string (shc,
1314 return (const char *) buf;
1319 * Convert a hash to a string (for printing debug messages).
1320 * This is one of the very few calls in the entire API that is
1323 * @param hc the hash code
1324 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
1327 GNUNET_h2s_full (const struct GNUNET_HashCode * hc)
1329 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1331 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
1332 ret.encoding[sizeof (ret) - 1] = '\0';
1333 return (const char *) ret.encoding;
1338 * Convert a peer identity to a string (for printing debug messages).
1339 * This is one of the very few calls in the entire API that is
1342 * @param pid the peer identity
1343 * @return string form of the pid; will be overwritten by next
1344 * call to #GNUNET_i2s.
1347 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
1354 ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&pid->public_key);
1365 * Convert a peer identity to a string (for printing debug messages).
1366 * This is one of the very few calls in the entire API that is
1367 * NOT reentrant! Identical to #GNUNET_i2s(), except that another
1368 * buffer is used so both #GNUNET_i2s() and #GNUNET_i2s2() can be
1369 * used within the same log statement.
1371 * @param pid the peer identity
1372 * @return string form of the pid; will be overwritten by next
1373 * call to #GNUNET_i2s.
1376 GNUNET_i2s2 (const struct GNUNET_PeerIdentity *pid)
1383 ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&pid->public_key);
1394 * Convert a peer identity to a string (for printing debug messages).
1395 * This is one of the very few calls in the entire API that is
1398 * @param pid the peer identity
1399 * @return string form of the pid; will be overwritten by next
1400 * call to #GNUNET_i2s_full.
1403 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid)
1405 static char buf[256];
1408 ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&pid->public_key);
1416 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
1417 * (for printing debug messages). This is one of the very few calls
1418 * in the entire API that is NOT reentrant!
1420 * @param addr the address
1421 * @param addrlen the length of the address in @a addr
1422 * @return nicely formatted string for the address
1423 * will be overwritten by next call to #GNUNET_a2s.
1426 GNUNET_a2s (const struct sockaddr *addr,
1430 #define LEN GNUNET_MAX ((INET6_ADDRSTRLEN + 8), \
1431 (1 + sizeof (struct sockaddr_un) - sizeof (sa_family_t)))
1433 #define LEN (INET6_ADDRSTRLEN + 8)
1435 static char buf[LEN];
1438 const struct sockaddr_in *v4;
1439 const struct sockaddr_un *un;
1440 const struct sockaddr_in6 *v6;
1444 return _("unknown address");
1445 switch (addr->sa_family)
1448 if (addrlen != sizeof (struct sockaddr_in))
1449 return "<invalid v4 address>";
1450 v4 = (const struct sockaddr_in *) addr;
1451 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
1452 if (0 == ntohs (v4->sin_port))
1455 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v4->sin_port));
1459 if (addrlen != sizeof (struct sockaddr_in6))
1460 return "<invalid v4 address>";
1461 v6 = (const struct sockaddr_in6 *) addr;
1463 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
1464 if (0 == ntohs (v6->sin6_port))
1467 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v6->sin6_port));
1471 if (addrlen <= sizeof (sa_family_t))
1472 return "<unbound UNIX client>";
1473 un = (const struct sockaddr_un *) addr;
1475 if ('\0' == un->sun_path[0])
1477 memset (buf, 0, sizeof (buf));
1478 GNUNET_snprintf (buf,
1481 (1 == off) ? "@" : "",
1482 (int) (addrlen - sizeof (sa_family_t) - off),
1483 &un->sun_path[off]);
1486 return _("invalid address");
1492 * Log error message about missing configuration option.
1494 * @param kind log level
1495 * @param section section with missing option
1496 * @param option name of missing option
1499 GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
1500 const char *section,
1504 _("Configuration fails to specify option `%s' in section `%s'!\n"),
1511 * Log error message about invalid configuration option value.
1513 * @param kind log level
1514 * @param section section with invalid option
1515 * @param option name of invalid option
1516 * @param required what is required that is invalid about the option
1519 GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
1520 const char *section,
1522 const char *required)
1525 _("Configuration specifies invalid value for option `%s' in section `%s': %s\n"),
1526 option, section, required);
1533 void __attribute__ ((constructor))
1534 GNUNET_util_cl_init ()
1536 GNUNET_stderr = stderr;
1538 GNInitWinEnv (NULL);
1541 if (!InitializeCriticalSectionAndSpinCount (&output_message_cs, 0x00000400))
1550 void __attribute__ ((destructor))
1551 GNUNET_util_cl_fini ()
1554 DeleteCriticalSection (&output_message_cs);
1557 GNShutdownWinEnv ();
1561 /* end of common_logging.c */