2 This file is part of GNUnet.
3 (C) 2006-2013 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 util/common_logging.c
23 * @brief error handling API
25 * @author Christian Grothoff
28 #include "gnunet_common.h"
29 #include "gnunet_util_lib.h"
34 * After how many milliseconds do we always print
35 * that "message X was repeated N times"? Use 12h.
37 #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000LL * 1000LL)
40 * After how many repetitions do we always print
41 * that "message X was repeated N times"? (even if
42 * we have not yet reached the delay threshold)
44 #define BULK_REPEAT_THRESHOLD 1000
47 * How many characters do we use for matching of
50 #define BULK_TRACK_SIZE 256
53 * How many characters do we use for matching of
56 #define COMP_TRACK_SIZE 32
59 * How many characters can a date/time string
62 #define DATE_STR_SIZE 64
65 * How many log files to keep?
67 #define ROTATION_KEEP 3
71 * Assumed maximum path length (for the log file name).
78 * Linked list of active loggers.
83 * This is a linked list.
85 struct CustomLogger *next;
99 * The last "bulk" error message that we have been logging.
100 * Note that this message maybe truncated to the first BULK_TRACK_SIZE
101 * characters, in which case it is NOT 0-terminated!
103 static char last_bulk[BULK_TRACK_SIZE];
106 * Type of the last bulk message.
108 static enum GNUNET_ErrorType last_bulk_kind;
111 * Time of the last bulk error message (0 for none)
113 static struct GNUNET_TIME_Absolute last_bulk_time;
116 * Number of times that bulk message has been repeated since.
118 static unsigned int last_bulk_repeat;
121 * Component when the last bulk was logged. Will be 0-terminated.
123 static char last_bulk_comp[COMP_TRACK_SIZE + 1];
128 static char *component;
131 * Running component (without pid).
133 static char *component_nopid;
136 * Format string describing the name of the log file.
138 static char *log_file_name;
143 static enum GNUNET_ErrorType min_level;
146 * Linked list of our custom loggres.
148 static struct CustomLogger *loggers;
151 * Number of log calls to ignore.
156 * File descriptor to use for "stderr", or NULL for none.
158 static FILE *GNUNET_stderr;
161 * Represents a single logging definition
166 * Component name regex
168 regex_t component_regex;
176 * Function name regex
178 regex_t function_regex;
181 * Lowest line at which this definition matches.
182 * Defaults to 0. Must be <= to_line.
187 * Highest line at which this definition matches.
188 * Defaults to INT_MAX. Must be >= from_line.
193 * Maximal log level allowed for calls that match this definition.
194 * Calls with higher log level will be disabled.
200 * 1 if this definition comes from GNUNET_FORCE_LOG, which means that it
201 * overrides any configuration options. 0 otherwise.
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;
238 * Contains the number of performance counts per second.
240 static LARGE_INTEGER performance_frequency;
245 * Convert a textual description of a loglevel
246 * to the respective GNUNET_GE_KIND.
248 * @param log loglevel to parse
249 * @return GNUNET_GE_INVALID if log does not parse
251 static enum GNUNET_ErrorType
252 get_type (const char *log)
255 return GNUNET_ERROR_TYPE_UNSPECIFIED;
256 if (0 == strcasecmp (log, _("DEBUG")))
257 return GNUNET_ERROR_TYPE_DEBUG;
258 if (0 == strcasecmp (log, _("INFO")))
259 return GNUNET_ERROR_TYPE_INFO;
260 if (0 == strcasecmp (log, _("WARNING")))
261 return GNUNET_ERROR_TYPE_WARNING;
262 if (0 == strcasecmp (log, _("ERROR")))
263 return GNUNET_ERROR_TYPE_ERROR;
264 if (0 == strcasecmp (log, _("NONE")))
265 return GNUNET_ERROR_TYPE_NONE;
266 return GNUNET_ERROR_TYPE_INVALID;
270 #if !defined(GNUNET_CULL_LOGGING)
272 * Utility function - reallocates logdefs array to be twice as large.
277 logdefs_size = (logdefs_size + 1) * 2;
278 logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
283 * Abort the process, generate a core dump if possible.
296 * Rotate logs, deleting the oldest log.
298 * @param new_name new name to add to the rotation
301 log_rotate (const char *new_name)
303 static char *rotation[ROTATION_KEEP];
304 static unsigned int rotation_off;
307 if ('\0' == *new_name)
308 return; /* not a real log file name */
309 discard = rotation[rotation_off % ROTATION_KEEP];
312 /* Note: can't log errors during logging (recursion!), so this
313 operation MUST silently fail... */
314 (void) UNLINK (discard);
315 GNUNET_free (discard);
317 rotation[rotation_off % ROTATION_KEEP] = GNUNET_strdup (new_name);
323 * Setup the log file.
325 * @param tm timestamp for which we should setup logging
326 * @return GNUNET_OK on success, GNUNET_SYSERR on error
329 setup_log_file (const struct tm *tm)
331 static char last_fn[PATH_MAX + 1];
332 char fn[PATH_MAX + 1];
339 if (NULL == log_file_name)
340 return GNUNET_SYSERR;
341 if (0 == strftime (fn, sizeof (fn), log_file_name, tm))
342 return GNUNET_SYSERR;
343 leftsquare = strrchr (fn, '[');
344 if ( (NULL != leftsquare) && (']' == leftsquare[1]) )
346 char *logfile_copy = GNUNET_strdup (fn);
347 logfile_copy[leftsquare - fn] = '\0';
348 logfile_copy[leftsquare - fn + 1] = '\0';
349 snprintf (fn, PATH_MAX, "%s%d%s",
350 logfile_copy, getpid (), &logfile_copy[leftsquare - fn + 2]);
351 GNUNET_free (logfile_copy);
353 if (0 == strcmp (fn, last_fn))
354 return GNUNET_OK; /* no change */
355 log_rotate (last_fn);
356 strcpy (last_fn, fn);
357 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
359 altlog_fd = OPEN (fn, O_APPEND |
362 _S_IREAD | _S_IWRITE);
364 altlog_fd = OPEN (fn, O_APPEND |
366 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
370 if (NULL != GNUNET_stderr)
371 fclose (GNUNET_stderr);
372 dup_return = dup2 (altlog_fd, 2);
373 (void) close (altlog_fd);
374 if (-1 != dup_return)
376 altlog = fdopen (2, "ab");
390 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", fn);
392 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
393 _("Failed to create or access directory for log file `%s'\n"),
395 return GNUNET_SYSERR;
397 GNUNET_stderr = altlog;
402 * Utility function - adds a parsed definition to logdefs array.
404 * @param component see struct LogDef, can't be NULL
405 * @param file see struct LogDef, can't be NULL
406 * @param function see struct LogDef, can't be NULL
407 * @param from_line see struct LogDef
408 * @param to_line see struct LogDef
409 * @param level see struct LogDef, must be >= 0
410 * @param force see struct LogDef
411 * @return 0 on success, regex-specific error otherwise
414 add_definition (char *component, char *file, char *function, int from_line,
415 int to_line, int level, int force)
420 if (logdefs_size == logdefs_len)
422 memset (&n, 0, sizeof (n));
423 if (0 == strlen (component))
424 component = (char *) ".*";
425 r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
430 if (0 == strlen (file))
431 file = (char *) ".*";
432 r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
435 regfree (&n.component_regex);
438 if ((NULL == function) || (0 == strlen (function)))
439 function = (char *) ".*";
440 r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
443 regfree (&n.component_regex);
444 regfree (&n.file_regex);
447 n.from_line = from_line;
451 logdefs[logdefs_len++] = n;
457 * Decides whether a particular logging call should or should not be allowed
458 * to be made. Used internally by GNUNET_log*()
460 * @param caller_level loglevel the caller wants to use
461 * @param comp component name the caller uses (NULL means that global
462 * component name is used)
463 * @param file file name containing the logging call, usually __FILE__
464 * @param function function which tries to make a logging call,
465 * usually __FUNCTION__
466 * @param line line at which the call is made, usually __LINE__
467 * @return 0 to disallow the call, 1 to allow it
470 GNUNET_get_log_call_status (int caller_level, const char *comp,
471 const char *file, const char *function, int line)
478 /* Use default component */
479 comp = component_nopid;
481 /* We have no definitions to override globally configured log level,
482 * so just use it right away.
484 if ( (min_level >= 0) && (GNUNET_NO == gnunet_force_log_present) )
485 return caller_level <= min_level;
487 /* Only look for forced definitions? */
488 force_only = min_level >= 0;
489 for (i = 0; i < logdefs_len; i++)
492 if (( (!force_only) || ld->force) &&
493 (line >= ld->from_line && line <= ld->to_line) &&
494 (0 == regexec (&ld->component_regex, comp, 0, NULL, 0)) &&
495 (0 == regexec (&ld->file_regex, file, 0, NULL, 0)) &&
496 (0 == regexec (&ld->function_regex, function, 0, NULL, 0)))
499 return caller_level <= ld->level;
502 /* No matches - use global level, if defined */
504 return caller_level <= min_level;
505 /* All programs/services previously defaulted to WARNING.
506 * Now WE default to WARNING, and THEY default to NULL.
508 return caller_level <= GNUNET_ERROR_TYPE_WARNING;
513 * Utility function - parses a definition
516 * component;file;function;from_line-to_line;level[/component...]
517 * All entries are mandatory, but may be empty.
518 * Empty entries for component, file and function are treated as
519 * "matches anything".
520 * Empty line entry is treated as "from 0 to INT_MAX"
521 * Line entry with only one line is treated as "this line only"
522 * Entry for level MUST NOT be empty.
523 * Entries for component, file and function that consist of a
524 * single character "*" are treated (at the moment) the same way
525 * empty entries are treated (wildcard matching is not implemented (yet?)).
526 * file entry is matched to the end of __FILE__. That is, it might be
527 * a base name, or a base name with leading directory names (some compilers
528 * define __FILE__ to absolute file path).
530 * @param constname name of the environment variable from which to get the
531 * string to be parsed
532 * @param force 1 if definitions found in constname are to be forced
533 * @return number of added definitions
536 parse_definitions (const char *constname, int force)
542 char *function = NULL;
548 int from_line, to_line;
550 int keep_looking = 1;
552 tmp = getenv (constname);
555 def = GNUNET_strdup (tmp);
558 for (p = def, state = 0, start = def; keep_looking; p++)
562 case ';': /* found a field separator */
566 case 0: /* within a component name */
569 case 1: /* within a file name */
572 case 2: /* within a function name */
573 /* after a file name there must be a function name */
576 case 3: /* within a from-to line range */
577 if (strlen (start) > 0)
580 from_line = strtol (start, &t, 10);
581 if ( (0 != errno) || (from_line < 0) )
586 if ( (t < p) && ('-' == t[0]) )
590 to_line = strtol (start, &t, 10);
591 if ( (0 != errno) || (to_line < 0) || (t != p) )
597 else /* one number means "match this line only" */
600 else /* default to 0-max */
610 case '\0': /* found EOL */
612 /* fall through to '/' */
613 case '/': /* found a definition separator */
616 case 4: /* within a log level */
619 level = get_type ((const char *) start);
620 if ( (GNUNET_ERROR_TYPE_INVALID == level) ||
621 (GNUNET_ERROR_TYPE_UNSPECIFIED == level) ||
622 (0 != add_definition (comp, file, function, from_line, to_line,
644 * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
647 parse_all_definitions ()
649 if (GNUNET_NO == gnunet_log_parsed)
650 parse_definitions ("GNUNET_LOG", 0);
651 gnunet_log_parsed = GNUNET_YES;
652 if (GNUNET_NO == gnunet_force_log_parsed)
653 gnunet_force_log_present =
654 parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
655 gnunet_force_log_parsed = GNUNET_YES;
663 * @param comp default component to use
664 * @param loglevel what types of messages should be logged
665 * @param logfile which file to write log messages to (can be NULL)
666 * @return GNUNET_OK on success
669 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
671 const char *env_logfile;
675 min_level = get_type (loglevel);
676 #if !defined(GNUNET_CULL_LOGGING)
677 parse_all_definitions ();
680 QueryPerformanceFrequency (&performance_frequency);
682 GNUNET_free_non_null (component);
683 GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
684 GNUNET_free_non_null (component_nopid);
685 component_nopid = GNUNET_strdup (comp);
687 env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
688 if ((NULL != env_logfile) && (strlen (env_logfile) > 0))
689 logfile = env_logfile;
692 GNUNET_free_non_null (log_file_name);
693 log_file_name = GNUNET_STRINGS_filename_expand (logfile);
694 if (NULL == log_file_name)
695 return GNUNET_SYSERR;
698 return setup_log_file (tm);
703 * Add a custom logger.
705 * @param logger log function
706 * @param logger_cls closure for logger
709 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
711 struct CustomLogger *entry;
713 entry = GNUNET_malloc (sizeof (struct CustomLogger));
714 entry->logger = logger;
715 entry->logger_cls = logger_cls;
716 entry->next = loggers;
722 * Remove a custom logger.
724 * @param logger log function
725 * @param logger_cls closure for logger
728 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
730 struct CustomLogger *pos;
731 struct CustomLogger *prev;
735 while ((pos != NULL) &&
736 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
741 GNUNET_assert (pos != NULL);
745 prev->next = pos->next;
750 CRITICAL_SECTION output_message_cs;
755 * Actually output the log message.
757 * @param kind how severe was the issue
758 * @param comp component responsible
759 * @param datestr current date/time
760 * @param msg the actual message
763 output_message (enum GNUNET_ErrorType kind, const char *comp,
764 const char *datestr, const char *msg)
766 struct CustomLogger *pos;
768 EnterCriticalSection (&output_message_cs);
770 if (NULL != GNUNET_stderr)
772 FPRINTF (GNUNET_stderr, "%s %s %s %s", datestr, comp,
773 GNUNET_error_type_to_string (kind), msg);
774 fflush (GNUNET_stderr);
779 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
783 LeaveCriticalSection (&output_message_cs);
789 * Flush an existing bulk report to the output.
791 * @param datestr our current timestamp
794 flush_bulk (const char *datestr)
796 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
801 if ((0 == last_bulk_time.abs_value_us) || (0 == last_bulk_repeat))
804 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
806 last = &last_bulk[BULK_TRACK_SIZE - 1];
807 else if (last != last_bulk)
814 ft = GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
815 (last_bulk_time), GNUNET_YES);
816 snprintf (msg, sizeof (msg),
817 _("Message `%.*s' repeated %u times in the last %s\n"),
818 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
821 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
822 last_bulk_time = GNUNET_TIME_absolute_get ();
823 last_bulk_repeat = 0;
828 * Ignore the next n calls to the log function.
830 * @param n number of log calls to ignore (could be negative)
831 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
834 GNUNET_log_skip (int n, int check_reset)
840 ok = (0 == skip_log);
852 * Get the number of log calls that are going to be skipped
854 * @return number of log calls to be ignored
857 GNUNET_get_log_skip ()
863 * Output a log message using the default mechanism.
865 * @param kind how severe was the issue
866 * @param comp component responsible
867 * @param message the actual message
868 * @param va arguments to the format string "message"
871 mylog (enum GNUNET_ErrorType kind, const char *comp, const char *message,
874 char date[DATE_STR_SIZE];
875 char date2[DATE_STR_SIZE];
881 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
882 GNUNET_assert (0 != size);
884 memset (date, 0, DATE_STR_SIZE);
892 offset = GNUNET_TIME_get_offset ();
894 timetmp += offset / 1000;
895 tmptr = localtime (&timetmp);
897 QueryPerformanceCounter (&pc);
900 strcpy (date, "localtime error");
904 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
905 snprintf (date, sizeof (date), date2,
906 (long long) (pc.QuadPart /
907 (performance_frequency.QuadPart / 1000)));
910 struct timeval timeofday;
912 gettimeofday (&timeofday, NULL);
913 offset = GNUNET_TIME_get_offset ();
916 timeofday.tv_sec += offset / 1000LL;
917 timeofday.tv_usec += (offset % 1000LL) * 1000LL;
918 if (timeofday.tv_usec > 1000000LL)
920 timeofday.tv_usec -= 1000000LL;
926 timeofday.tv_sec += offset / 1000LL;
927 if (timeofday.tv_usec > - (offset % 1000LL) * 1000LL)
929 timeofday.tv_usec += (offset % 1000LL) * 1000LL;
933 timeofday.tv_usec += 1000000LL + (offset % 1000LL) * 1000LL;
937 tmptr = localtime (&timeofday.tv_sec);
940 strcpy (date, "localtime error");
944 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
945 snprintf (date, sizeof (date), date2, timeofday.tv_usec);
948 VSNPRINTF (buf, size, message, va);
950 (void) setup_log_file (tmptr);
951 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
952 (0 != last_bulk_time.abs_value_us) &&
953 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
956 if ( (GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value_us >
957 BULK_DELAY_THRESHOLD) ||
958 (last_bulk_repeat > BULK_REPEAT_THRESHOLD) )
963 strncpy (last_bulk, buf, sizeof (last_bulk));
964 last_bulk_repeat = 0;
965 last_bulk_kind = kind;
966 last_bulk_time = GNUNET_TIME_absolute_get ();
967 strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
968 output_message (kind, comp, date, buf);
976 * @param kind how serious is the error?
977 * @param message what is the message (format string)
978 * @param ... arguments for format string
981 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
985 va_start (va, message);
986 mylog (kind, component, message, va);
992 * Log function that specifies an alternative component.
993 * This function should be used by plugins.
995 * @param kind how serious is the error?
996 * @param comp component responsible for generating the message
997 * @param message what is the message (format string)
998 * @param ... arguments for format string
1001 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
1002 const char *message, ...)
1005 char comp_w_pid[128];
1008 comp = component_nopid;
1010 va_start (va, message);
1011 GNUNET_snprintf (comp_w_pid, sizeof (comp_w_pid), "%s-%d", comp, getpid ());
1012 mylog (kind, comp_w_pid, message, va);
1018 * Convert error type to string.
1020 * @param kind type to convert
1021 * @return string corresponding to the type
1024 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
1026 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
1028 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
1029 return _("WARNING");
1030 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
1032 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
1034 if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
1036 return _("INVALID");
1041 * Convert a short hash to a string (for printing debug messages).
1042 * This is one of the very few calls in the entire API that is
1045 * @param hc the short hash code
1046 * @return string form; will be overwritten by next call to GNUNET_h2s.
1049 GNUNET_short_h2s (const struct GNUNET_CRYPTO_ShortHashCode * hc)
1051 static struct GNUNET_CRYPTO_ShortHashAsciiEncoded ret;
1053 GNUNET_CRYPTO_short_hash_to_enc (hc, &ret);
1054 ret.short_encoding[8] = '\0';
1055 return (const char *) ret.short_encoding;
1060 * Convert a short hash to a string (for printing debug messages).
1061 * This is one of the very few calls in the entire API that is
1064 * @param hc the short hash code
1065 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
1068 GNUNET_short_h2s_full (const struct GNUNET_CRYPTO_ShortHashCode * hc)
1070 static struct GNUNET_CRYPTO_ShortHashAsciiEncoded ret;
1072 GNUNET_CRYPTO_short_hash_to_enc (hc, &ret);
1073 ret.short_encoding[sizeof (ret) - 1] = '\0';
1074 return (const char *) ret.short_encoding;
1078 * Convert a hash to a string (for printing debug messages).
1079 * This is one of the very few calls in the entire API that is
1082 * @param hc the hash code
1083 * @return string form; will be overwritten by next call to GNUNET_h2s.
1086 GNUNET_h2s (const struct GNUNET_HashCode * hc)
1088 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1090 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
1091 ret.encoding[8] = '\0';
1092 return (const char *) ret.encoding;
1097 * Convert a hash to a string (for printing debug messages).
1098 * This is one of the very few calls in the entire API that is
1101 * @param hc the hash code
1102 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
1105 GNUNET_h2s_full (const struct GNUNET_HashCode * hc)
1107 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1109 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
1110 ret.encoding[sizeof (ret) - 1] = '\0';
1111 return (const char *) ret.encoding;
1116 * Convert a peer identity to a string (for printing debug messages).
1117 * This is one of the very few calls in the entire API that is
1120 * @param pid the peer identity
1121 * @return string form of the pid; will be overwritten by next
1122 * call to GNUNET_i2s.
1125 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
1127 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1129 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
1130 ret.encoding[4] = '\0';
1131 return (const char *) ret.encoding;
1136 * Convert a peer identity to a string (for printing debug messages).
1137 * This is one of the very few calls in the entire API that is
1140 * @param pid the peer identity
1141 * @return string form of the pid; will be overwritten by next
1142 * call to GNUNET_i2s.
1145 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid)
1147 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1149 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
1150 return (const char *) ret.encoding;
1155 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
1156 * (for printing debug messages). This is one of the very few calls
1157 * in the entire API that is NOT reentrant!
1159 * @param addr the address
1160 * @param addrlen the length of the address
1161 * @return nicely formatted string for the address
1162 * will be overwritten by next call to GNUNET_a2s.
1165 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
1167 static char buf[INET6_ADDRSTRLEN + 8];
1169 const struct sockaddr_in *v4;
1170 const struct sockaddr_un *un;
1171 const struct sockaddr_in6 *v6;
1175 return _("unknown address");
1176 switch (addr->sa_family)
1179 if (addrlen != sizeof (struct sockaddr_in))
1180 return "<invalid v4 address>";
1181 v4 = (const struct sockaddr_in *) addr;
1182 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
1183 if (0 == ntohs (v4->sin_port))
1186 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v4->sin_port));
1190 if (addrlen != sizeof (struct sockaddr_in6))
1191 return "<invalid v4 address>";
1192 v6 = (const struct sockaddr_in6 *) addr;
1194 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
1195 if (0 == ntohs (v6->sin6_port))
1198 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v6->sin6_port));
1202 if (addrlen <= sizeof (sa_family_t))
1203 return "<unbound UNIX client>";
1204 un = (const struct sockaddr_un *) addr;
1206 if (un->sun_path[0] == '\0')
1208 memset (buf, 0, sizeof (buf));
1209 snprintf (buf, sizeof (buf) - 1, "%s%.*s", (off == 1) ? "@" : "",
1210 (int) (addrlen - sizeof (sa_family_t) - 1 - off),
1211 &un->sun_path[off]);
1214 return _("invalid address");
1220 * Log error message about missing configuration option.
1222 * @param kind log level
1223 * @param section section with missing option
1224 * @param option name of missing option
1227 GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
1228 const char *section,
1232 _("Configuration fails to specify option `%s' in section `%s'!\n"),
1239 * Log error message about invalid configuration option value.
1241 * @param kind log level
1242 * @param section section with invalid option
1243 * @param option name of invalid option
1244 * @param required what is required that is invalid about the option
1247 GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
1248 const char *section,
1250 const char *required)
1253 _("Configuration specifies invalid value for option `%s' in section `%s': %s\n"),
1254 option, section, required);
1261 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
1263 GNUNET_stderr = stderr;
1265 GNInitWinEnv (NULL);
1268 if (!InitializeCriticalSectionAndSpinCount (&output_message_cs, 0x00000400))
\r
1277 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
1280 DeleteCriticalSection (&output_message_cs);
1283 GNShutdownWinEnv ();
1287 /* end of common_logging.c */