123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2006-2013 GNUnet e.V.
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Affero General Public License for more details.
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @file util/common_logging.c
- * @brief error handling API
- * @author Christian Grothoff
- */
- #include "platform.h"
- #include "gnunet_crypto_lib.h"
- #include "gnunet_disk_lib.h"
- #include "gnunet_strings_lib.h"
- #include <regex.h>
- /**
- * After how many milliseconds do we always print
- * that "message X was repeated N times"? Use 12h.
- */
- #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000LL * 1000LL)
- /**
- * After how many repetitions do we always print
- * that "message X was repeated N times"? (even if
- * we have not yet reached the delay threshold)
- */
- #define BULK_REPEAT_THRESHOLD 1000
- /**
- * How many characters do we use for matching of
- * bulk messages?
- */
- #define BULK_TRACK_SIZE 256
- /**
- * How many characters do we use for matching of
- * bulk components?
- */
- #define COMP_TRACK_SIZE 32
- /**
- * How many characters can a date/time string
- * be at most?
- */
- #define DATE_STR_SIZE 64
- /**
- * How many log files to keep?
- */
- #define ROTATION_KEEP 3
- #ifndef PATH_MAX
- /**
- * Assumed maximum path length (for the log file name).
- */
- #define PATH_MAX 4096
- #endif
- /**
- * Linked list of active loggers.
- */
- struct CustomLogger
- {
- /**
- * This is a linked list.
- */
- struct CustomLogger *next;
- /**
- * Log function.
- */
- GNUNET_Logger logger;
- /**
- * Closure for logger.
- */
- void *logger_cls;
- };
- /**
- * Asynchronous scope of the current thread, or NULL if we have not
- * entered an async scope yet.
- */
- static GNUNET_THREAD_LOCAL struct GNUNET_AsyncScopeSave current_async_scope;
- /**
- * The last "bulk" error message that we have been logging.
- * Note that this message maybe truncated to the first BULK_TRACK_SIZE
- * characters, in which case it is NOT 0-terminated!
- */
- static GNUNET_THREAD_LOCAL char last_bulk[BULK_TRACK_SIZE] __nonstring;
- /**
- * Type of the last bulk message.
- */
- static GNUNET_THREAD_LOCAL enum GNUNET_ErrorType last_bulk_kind;
- /**
- * Time of the last bulk error message (0 for none)
- */
- static GNUNET_THREAD_LOCAL struct GNUNET_TIME_Absolute last_bulk_time;
- /**
- * Number of times that bulk message has been repeated since.
- */
- static GNUNET_THREAD_LOCAL unsigned int last_bulk_repeat;
- /**
- * Component when the last bulk was logged. Will be 0-terminated.
- */
- static GNUNET_THREAD_LOCAL char last_bulk_comp[COMP_TRACK_SIZE + 1];
- /**
- * Running component.
- */
- static char *component;
- /**
- * Running component (without pid).
- */
- static char *component_nopid;
- /**
- * Format string describing the name of the log file.
- */
- static char *log_file_name;
- /**
- * Minimum log level.
- */
- static enum GNUNET_ErrorType min_level;
- /**
- * Linked list of our custom loggres.
- */
- static struct CustomLogger *loggers;
- /**
- * Number of log calls to ignore.
- */
- static GNUNET_THREAD_LOCAL int skip_log = 0;
- /**
- * File descriptor to use for "stderr", or NULL for none.
- */
- static FILE *GNUNET_stderr;
- /**
- * Represents a single logging definition
- */
- struct LogDef
- {
- /**
- * Component name regex
- */
- regex_t component_regex;
- /**
- * File name regex
- */
- regex_t file_regex;
- /**
- * Function name regex
- */
- regex_t function_regex;
- /**
- * Lowest line at which this definition matches.
- * Defaults to 0. Must be <= to_line.
- */
- int from_line;
- /**
- * Highest line at which this definition matches.
- * Defaults to INT_MAX. Must be >= from_line.
- */
- int to_line;
- /**
- * Maximal log level allowed for calls that match this definition.
- * Calls with higher log level will be disabled.
- * Must be >= 0
- */
- int level;
- /**
- * 1 if this definition comes from GNUNET_FORCE_LOG, which means that it
- * overrides any configuration options. 0 otherwise.
- */
- int force;
- };
- #if ! defined(GNUNET_CULL_LOGGING)
- /**
- * Dynamic array of logging definitions
- */
- static struct LogDef *logdefs;
- /**
- * Allocated size of logdefs array (in units)
- */
- static int logdefs_size;
- /**
- * The number of units used in logdefs array.
- */
- static int logdefs_len;
- /**
- * #GNUNET_YES if GNUNET_LOG environment variable is already parsed.
- */
- static int gnunet_log_parsed;
- /**
- * #GNUNET_YES if GNUNET_FORCE_LOG environment variable is already parsed.
- */
- static int gnunet_force_log_parsed;
- /**
- * #GNUNET_YES if at least one definition with forced == 1 is available.
- */
- static int gnunet_force_log_present;
- #endif
- /**
- * Convert a textual description of a loglevel
- * to the respective GNUNET_GE_KIND.
- *
- * @param log loglevel to parse
- * @return GNUNET_GE_INVALID if log does not parse
- */
- static enum GNUNET_ErrorType
- get_type (const char *log)
- {
- if (NULL == log)
- return GNUNET_ERROR_TYPE_UNSPECIFIED;
- if (0 == strcasecmp (log, _ ("DEBUG")))
- return GNUNET_ERROR_TYPE_DEBUG;
- if (0 == strcasecmp (log, _ ("INFO")))
- return GNUNET_ERROR_TYPE_INFO;
- if (0 == strcasecmp (log, _ ("MESSAGE")))
- return GNUNET_ERROR_TYPE_MESSAGE;
- if (0 == strcasecmp (log, _ ("WARNING")))
- return GNUNET_ERROR_TYPE_WARNING;
- if (0 == strcasecmp (log, _ ("ERROR")))
- return GNUNET_ERROR_TYPE_ERROR;
- if (0 == strcasecmp (log, _ ("NONE")))
- return GNUNET_ERROR_TYPE_NONE;
- return GNUNET_ERROR_TYPE_INVALID;
- }
- /**
- * Abort the process, generate a core dump if possible.
- */
- void
- GNUNET_abort_ ()
- {
- abort ();
- }
- #if ! defined(GNUNET_CULL_LOGGING)
- /**
- * Utility function - reallocates logdefs array to be twice as large.
- */
- static void
- resize_logdefs (void)
- {
- logdefs_size = (logdefs_size + 1) * 2;
- logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof(struct LogDef));
- }
- /**
- * Rotate logs, deleting the oldest log.
- *
- * @param new_name new name to add to the rotation
- */
- static void
- log_rotate (const char *new_name)
- {
- static char *rotation[ROTATION_KEEP];
- static unsigned int rotation_off;
- char *discard;
- if ('\0' == *new_name)
- return; /* not a real log file name */
- discard = rotation[rotation_off % ROTATION_KEEP];
- if (NULL != discard)
- {
- /* Note: can't log errors during logging (recursion!), so this
- operation MUST silently fail... */
- (void) unlink (discard);
- GNUNET_free (discard);
- }
- rotation[rotation_off % ROTATION_KEEP] = GNUNET_strdup (new_name);
- rotation_off++;
- }
- /**
- * Setup the log file.
- *
- * @param tm timestamp for which we should setup logging
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
- */
- static int
- setup_log_file (const struct tm *tm)
- {
- static char last_fn[PATH_MAX + 1];
- char fn[PATH_MAX + 1];
- int altlog_fd;
- int dup_return;
- FILE *altlog;
- char *leftsquare;
- if (NULL == log_file_name)
- return GNUNET_SYSERR;
- if (0 == strftime (fn, sizeof(fn), log_file_name, tm))
- return GNUNET_SYSERR;
- leftsquare = strrchr (fn, '[');
- if ((NULL != leftsquare) && (']' == leftsquare[1]))
- {
- char *logfile_copy = GNUNET_strdup (fn);
- logfile_copy[leftsquare - fn] = '\0';
- logfile_copy[leftsquare - fn + 1] = '\0';
- snprintf (fn,
- PATH_MAX,
- "%s%d%s",
- logfile_copy,
- getpid (),
- &logfile_copy[leftsquare - fn + 2]);
- GNUNET_free (logfile_copy);
- }
- if (0 == strcmp (fn, last_fn))
- return GNUNET_OK; /* no change */
- log_rotate (last_fn);
- strcpy (last_fn, fn);
- if (GNUNET_SYSERR == GNUNET_DISK_directory_create_for_file (fn))
- {
- fprintf (stderr,
- "Failed to create directory for `%s': %s\n",
- fn,
- strerror (errno));
- return GNUNET_SYSERR;
- }
- altlog_fd = open (fn,
- O_APPEND | O_WRONLY | O_CREAT,
- S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
- if (-1 != altlog_fd)
- {
- if (NULL != GNUNET_stderr)
- fclose (GNUNET_stderr);
- dup_return = dup2 (altlog_fd, 2);
- (void) close (altlog_fd);
- if (-1 != dup_return)
- {
- altlog = fdopen (2, "ab");
- if (NULL == altlog)
- {
- (void) close (2);
- altlog_fd = -1;
- }
- }
- else
- {
- altlog_fd = -1;
- }
- }
- if (-1 == altlog_fd)
- {
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", fn);
- return GNUNET_SYSERR;
- }
- GNUNET_stderr = altlog;
- return GNUNET_OK;
- }
- /**
- * Utility function - adds a parsed definition to logdefs array.
- *
- * @param component see struct LogDef, can't be NULL
- * @param file see struct LogDef, can't be NULL
- * @param function see struct LogDef, can't be NULL
- * @param from_line see struct LogDef
- * @param to_line see struct LogDef
- * @param level see struct LogDef, must be >= 0
- * @param force see struct LogDef
- * @return 0 on success, regex-specific error otherwise
- */
- static int
- add_definition (const char *component,
- const char *file,
- const char *function,
- int from_line,
- int to_line,
- int level,
- int force)
- {
- struct LogDef n;
- int r;
- if (logdefs_size == logdefs_len)
- resize_logdefs ();
- memset (&n, 0, sizeof(n));
- if (0 == strlen (component))
- component = (char *) ".*";
- r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
- if (0 != r)
- {
- return r;
- }
- if (0 == strlen (file))
- file = (char *) ".*";
- r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
- if (0 != r)
- {
- regfree (&n.component_regex);
- return r;
- }
- if ((NULL == function) || (0 == strlen (function)))
- function = (char *) ".*";
- r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
- if (0 != r)
- {
- regfree (&n.component_regex);
- regfree (&n.file_regex);
- return r;
- }
- n.from_line = from_line;
- n.to_line = to_line;
- n.level = level;
- n.force = force;
- logdefs[logdefs_len++] = n;
- return 0;
- }
- /**
- * Decides whether a particular logging call should or should not be allowed
- * to be made. Used internally by GNUNET_log*()
- *
- * @param caller_level loglevel the caller wants to use
- * @param comp component name the caller uses (NULL means that global
- * component name is used)
- * @param file file name containing the logging call, usually __FILE__
- * @param function function which tries to make a logging call,
- * usually __FUNCTION__
- * @param line line at which the call is made, usually __LINE__
- * @return 0 to disallow the call, 1 to allow it
- */
- int
- GNUNET_get_log_call_status (int caller_level,
- const char *comp,
- const char *file,
- const char *function,
- int line)
- {
- struct LogDef *ld;
- int i;
- int force_only;
- if (NULL == comp)
- /* Use default component */
- comp = component_nopid;
- /* We have no definitions to override globally configured log level,
- * so just use it right away.
- */
- if ((min_level >= 0) && (GNUNET_NO == gnunet_force_log_present))
- return caller_level <= min_level;
- /* Only look for forced definitions? */
- force_only = min_level >= 0;
- for (i = 0; i < logdefs_len; i++)
- {
- ld = &logdefs[i];
- if (((! force_only) || ld->force) &&
- ((line >= ld->from_line) && (line <= ld->to_line) ) &&
- (0 == regexec (&ld->component_regex, comp, 0, NULL, 0)) &&
- (0 == regexec (&ld->file_regex, file, 0, NULL, 0)) &&
- (0 == regexec (&ld->function_regex, function, 0, NULL, 0)))
- {
- /* We're finished */
- return caller_level <= ld->level;
- }
- }
- /* No matches - use global level, if defined */
- if (min_level >= 0)
- return caller_level <= min_level;
- /* All programs/services previously defaulted to WARNING.
- * Now *we* default to WARNING, and THEY default to NULL.
- * Or rather we default to MESSAGE, since things aren't always bad.
- */
- return caller_level <= GNUNET_ERROR_TYPE_MESSAGE;
- }
- /**
- * Utility function - parses a definition
- *
- * Definition format:
- * component;file;function;from_line-to_line;level[/component...]
- * All entries are mandatory, but may be empty.
- * Empty entries for component, file and function are treated as
- * "matches anything".
- * Empty line entry is treated as "from 0 to INT_MAX"
- * Line entry with only one line is treated as "this line only"
- * Entry for level MUST NOT be empty.
- * Entries for component, file and function that consist of a
- * single character "*" are treated (at the moment) the same way
- * empty entries are treated (wildcard matching is not implemented (yet?)).
- * file entry is matched to the end of __FILE__. That is, it might be
- * a base name, or a base name with leading directory names (some compilers
- * define __FILE__ to absolute file path).
- *
- * @param constname name of the environment variable from which to get the
- * string to be parsed
- * @param force 1 if definitions found in constname are to be forced
- * @return number of added definitions
- */
- static int
- parse_definitions (const char *constname, int force)
- {
- char *def;
- const char *tmp;
- char *comp = NULL;
- char *file = NULL;
- char *function = NULL;
- char *p;
- char *start;
- char *t;
- short state;
- int level;
- int from_line, to_line;
- int counter = 0;
- int keep_looking = 1;
- tmp = getenv (constname);
- if (NULL == tmp)
- return 0;
- def = GNUNET_strdup (tmp);
- from_line = 0;
- to_line = INT_MAX;
- for (p = def, state = 0, start = def; keep_looking; p++)
- {
- switch (p[0])
- {
- case ';': /* found a field separator */
- p[0] = '\0';
- switch (state)
- {
- case 0: /* within a component name */
- comp = start;
- break;
- case 1: /* within a file name */
- file = start;
- break;
- case 2: /* within a function name */
- /* after a file name there must be a function name */
- function = start;
- break;
- case 3: /* within a from-to line range */
- if (strlen (start) > 0)
- {
- errno = 0;
- from_line = strtol (start, &t, 10);
- if ((0 != errno) || (from_line < 0))
- {
- GNUNET_free (def);
- return counter;
- }
- if ((t < p) && ('-' == t[0]))
- {
- errno = 0;
- start = t + 1;
- to_line = strtol (start, &t, 10);
- if ((0 != errno) || (to_line < 0) || (t != p))
- {
- GNUNET_free (def);
- return counter;
- }
- }
- else /* one number means "match this line only" */
- to_line = from_line;
- }
- else /* default to 0-max */
- {
- from_line = 0;
- to_line = INT_MAX;
- }
- break;
- default:
- fprintf (
- stderr,
- _ ("ERROR: Unable to parse log definition: Syntax error at `%s'.\n"),
- p);
- break;
- }
- start = p + 1;
- state++;
- break;
- case '\0': /* found EOL */
- keep_looking = 0;
- /* fall through to '/' */
- case '/': /* found a definition separator */
- switch (state)
- {
- case 4: /* within a log level */
- p[0] = '\0';
- state = 0;
- level = get_type ((const char *) start);
- if ((GNUNET_ERROR_TYPE_INVALID == level) ||
- (GNUNET_ERROR_TYPE_UNSPECIFIED == level) ||
- (0 != add_definition (comp,
- file,
- function,
- from_line,
- to_line,
- level,
- force)))
- {
- GNUNET_free (def);
- return counter;
- }
- counter++;
- start = p + 1;
- break;
- default:
- fprintf (
- stderr,
- _ ("ERROR: Unable to parse log definition: Syntax error at `%s'.\n"),
- p);
- break;
- }
- default:
- break;
- }
- }
- GNUNET_free (def);
- return counter;
- }
- /**
- * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
- */
- static void
- parse_all_definitions ()
- {
- if (GNUNET_NO == gnunet_force_log_parsed)
- gnunet_force_log_present =
- parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
- gnunet_force_log_parsed = GNUNET_YES;
- if (GNUNET_NO == gnunet_log_parsed)
- parse_definitions ("GNUNET_LOG", 0);
- gnunet_log_parsed = GNUNET_YES;
- }
- #endif
- /**
- * Setup logging.
- *
- * @param comp default component to use
- * @param loglevel what types of messages should be logged
- * @param logfile which file to write log messages to (can be NULL)
- * @return #GNUNET_OK on success
- */
- int
- GNUNET_log_setup (const char *comp,
- const char *loglevel,
- const char *logfile)
- {
- const char *env_logfile;
- min_level = get_type (loglevel);
- #if ! defined(GNUNET_CULL_LOGGING)
- parse_all_definitions ();
- #endif
- GNUNET_free (component);
- GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
- GNUNET_free (component_nopid);
- component_nopid = GNUNET_strdup (comp);
- env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
- if ((NULL != env_logfile) && (strlen (env_logfile) > 0))
- logfile = env_logfile;
- if (NULL == logfile)
- return GNUNET_OK;
- GNUNET_free (log_file_name);
- log_file_name = GNUNET_STRINGS_filename_expand (logfile);
- if (NULL == log_file_name)
- return GNUNET_SYSERR;
- #if defined(GNUNET_CULL_LOGGING)
- /* log file option not allowed for wallet logic */
- GNUNET_assert (NULL == logfile);
- return GNUNET_OK;
- #else
- {
- time_t t;
- const struct tm *tm;
- t = time (NULL);
- tm = gmtime (&t);
- return setup_log_file (tm);
- }
- #endif
- }
- /**
- * Add a custom logger. Note that installing any custom logger
- * will disable the standard logger. When multiple custom loggers
- * are installed, all will be called. The standard logger will
- * only be used if no custom loggers are present.
- *
- * @param logger log function
- * @param logger_cls closure for @a logger
- */
- void
- GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
- {
- struct CustomLogger *entry;
- entry = GNUNET_new (struct CustomLogger);
- entry->logger = logger;
- entry->logger_cls = logger_cls;
- entry->next = loggers;
- loggers = entry;
- }
- /**
- * Remove a custom logger.
- *
- * @param logger log function
- * @param logger_cls closure for @a logger
- */
- void
- GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
- {
- struct CustomLogger *pos;
- struct CustomLogger *prev;
- prev = NULL;
- pos = loggers;
- while ((NULL != pos) &&
- ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
- {
- prev = pos;
- pos = pos->next;
- }
- GNUNET_assert (NULL != pos);
- if (NULL == prev)
- loggers = pos->next;
- else
- prev->next = pos->next;
- GNUNET_free (pos);
- }
- /**
- * Actually output the log message.
- *
- * @param kind how severe was the issue
- * @param comp component responsible
- * @param datestr current date/time
- * @param msg the actual message
- */
- static void
- output_message (enum GNUNET_ErrorType kind,
- const char *comp,
- const char *datestr,
- const char *msg)
- {
- struct CustomLogger *pos;
- /* only use the standard logger if no custom loggers are present */
- if ((NULL != GNUNET_stderr) && (NULL == loggers))
- {
- if (kind == GNUNET_ERROR_TYPE_MESSAGE)
- {
- /* The idea here is to produce "normal" output messages
- * for end users while still having the power of the
- * logging engine for developer needs. So ideally this
- * is what it should look like when CLI tools are used
- * interactively, yet the same message shouldn't look
- * this way if the output is going to logfiles or robots
- * instead.
- */fprintf (GNUNET_stderr, "* %s", msg);
- }
- else if (GNUNET_YES == current_async_scope.have_scope)
- {
- static GNUNET_THREAD_LOCAL char id_buf[27];
- char *end;
- /* We're logging, so skip_log must be currently 0. */
- skip_log = 100;
- end = GNUNET_STRINGS_data_to_string (¤t_async_scope.scope_id,
- sizeof(struct GNUNET_AsyncScopeId),
- id_buf,
- sizeof(id_buf) - 1);
- GNUNET_assert (NULL != end);
- *end = '\0';
- skip_log = 0;
- fprintf (GNUNET_stderr,
- "%s %s(%s) %s %s",
- datestr,
- comp,
- id_buf,
- GNUNET_error_type_to_string (kind),
- msg);
- }
- else
- {
- fprintf (GNUNET_stderr,
- "%s %s %s %s",
- datestr,
- comp,
- GNUNET_error_type_to_string (kind),
- msg);
- }
- fflush (GNUNET_stderr);
- }
- pos = loggers;
- while (NULL != pos)
- {
- pos->logger (pos->logger_cls, kind, comp, datestr, msg);
- pos = pos->next;
- }
- }
- /**
- * Flush an existing bulk report to the output.
- *
- * @param datestr our current timestamp
- */
- static void
- flush_bulk (const char *datestr)
- {
- char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
- int rev;
- char *last;
- const char *ft;
- if ((0 == last_bulk_time.abs_value_us) || (0 == last_bulk_repeat))
- return;
- rev = 0;
- last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
- if (last == NULL)
- last = &last_bulk[BULK_TRACK_SIZE - 1];
- else if (last != last_bulk)
- last--;
- if (last[0] == '\n')
- {
- rev = 1;
- last[0] = '\0';
- }
- ft =
- GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (
- last_bulk_time),
- GNUNET_YES);
- snprintf (msg,
- sizeof(msg),
- _ ("Message `%.*s' repeated %u times in the last %s\n"),
- BULK_TRACK_SIZE,
- last_bulk,
- last_bulk_repeat,
- ft);
- if (rev == 1)
- last[0] = '\n';
- output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
- last_bulk_time = GNUNET_TIME_absolute_get ();
- last_bulk_repeat = 0;
- }
- /**
- * Ignore the next n calls to the log function.
- *
- * @param n number of log calls to ignore (could be negative)
- * @param check_reset #GNUNET_YES to assert that the log skip counter is currently zero
- */
- void
- GNUNET_log_skip (int n, int check_reset)
- {
- int ok;
- if (0 == n)
- {
- ok = (0 == skip_log);
- skip_log = 0;
- if (check_reset)
- GNUNET_break (ok);
- }
- else
- {
- skip_log += n;
- }
- }
- /**
- * Get the number of log calls that are going to be skipped
- *
- * @return number of log calls to be ignored
- */
- int
- GNUNET_get_log_skip ()
- {
- return skip_log;
- }
- /**
- * Output a log message using the default mechanism.
- *
- * @param kind how severe was the issue
- * @param comp component responsible
- * @param message the actual message
- * @param va arguments to the format string "message"
- */
- static void
- mylog (enum GNUNET_ErrorType kind,
- const char *comp,
- const char *message,
- va_list va)
- {
- char date[DATE_STR_SIZE];
- char date2[DATE_STR_SIZE];
- struct tm *tmptr;
- size_t size;
- va_list vacp;
- va_copy (vacp, va);
- size = vsnprintf (NULL, 0, message, vacp) + 1;
- GNUNET_assert (0 != size);
- va_end (vacp);
- memset (date, 0, DATE_STR_SIZE);
- {
- char buf[size];
- long long offset;
- struct timeval timeofday;
- gettimeofday (&timeofday, NULL);
- offset = GNUNET_TIME_get_offset ();
- if (offset > 0)
- {
- timeofday.tv_sec += offset / 1000LL;
- timeofday.tv_usec += (offset % 1000LL) * 1000LL;
- if (timeofday.tv_usec > 1000000LL)
- {
- timeofday.tv_usec -= 1000000LL;
- timeofday.tv_sec++;
- }
- }
- else
- {
- timeofday.tv_sec += offset / 1000LL;
- if (timeofday.tv_usec > -(offset % 1000LL) * 1000LL)
- {
- timeofday.tv_usec += (offset % 1000LL) * 1000LL;
- }
- else
- {
- timeofday.tv_usec += 1000000LL + (offset % 1000LL) * 1000LL;
- timeofday.tv_sec--;
- }
- }
- tmptr = localtime (&timeofday.tv_sec);
- if (NULL == tmptr)
- {
- strcpy (date, "localtime error");
- }
- else
- {
- if (0 == strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr))
- abort ();
- if (0 > snprintf (date, sizeof(date), date2, timeofday.tv_usec))
- abort ();
- }
- vsnprintf (buf, size, message, va);
- #if ! defined(GNUNET_CULL_LOGGING)
- if (NULL != tmptr)
- (void) setup_log_file (tmptr);
- #endif
- if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
- (0 != last_bulk_time.abs_value_us) &&
- (0 == strncmp (buf, last_bulk, sizeof(last_bulk))))
- {
- last_bulk_repeat++;
- if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value_us >
- BULK_DELAY_THRESHOLD) ||
- (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
- flush_bulk (date);
- return;
- }
- flush_bulk (date);
- GNUNET_strlcpy (last_bulk, buf, sizeof(last_bulk));
- last_bulk_repeat = 0;
- last_bulk_kind = kind;
- last_bulk_time = GNUNET_TIME_absolute_get ();
- GNUNET_strlcpy (last_bulk_comp, comp, sizeof(last_bulk_comp));
- output_message (kind, comp, date, buf);
- }
- }
- /**
- * Main log function.
- *
- * @param kind how serious is the error?
- * @param message what is the message (format string)
- * @param ... arguments for format string
- */
- void
- GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
- {
- va_list va;
- va_start (va, message);
- mylog (kind, component, message, va);
- va_end (va);
- }
- /**
- * Log function that specifies an alternative component.
- * This function should be used by plugins.
- *
- * @param kind how serious is the error?
- * @param comp component responsible for generating the message
- * @param message what is the message (format string)
- * @param ... arguments for format string
- */
- void
- GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind,
- const char *comp,
- const char *message,
- ...)
- {
- va_list va;
- char comp_w_pid[128];
- if (comp == NULL)
- comp = component_nopid;
- va_start (va, message);
- GNUNET_snprintf (comp_w_pid, sizeof(comp_w_pid), "%s-%d", comp, getpid ());
- mylog (kind, comp_w_pid, message, va);
- va_end (va);
- }
- /**
- * Convert error type to string.
- *
- * @param kind type to convert
- * @return string corresponding to the type
- */
- const char *
- GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
- {
- if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
- return _ ("ERROR");
- if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
- return _ ("WARNING");
- if ((kind & GNUNET_ERROR_TYPE_MESSAGE) > 0)
- return _ ("MESSAGE");
- if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
- return _ ("INFO");
- if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
- return _ ("DEBUG");
- if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
- return _ ("NONE");
- return _ ("INVALID");
- }
- /**
- * Convert a hash to a string (for printing debug messages).
- *
- * @param hc the hash code
- * @return string form; will be overwritten by next call to GNUNET_h2s.
- */
- const char *
- GNUNET_h2s (const struct GNUNET_HashCode *hc)
- {
- static GNUNET_THREAD_LOCAL struct GNUNET_CRYPTO_HashAsciiEncoded ret;
- GNUNET_CRYPTO_hash_to_enc (hc, &ret);
- ret.encoding[8] = '\0';
- return (const char *) ret.encoding;
- }
- /**
- * Convert a hash to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant! Identical to #GNUNET_h2s(), except that another
- * buffer is used so both #GNUNET_h2s() and #GNUNET_h2s2() can be
- * used within the same log statement.
- *
- * @param hc the hash code
- * @return string form; will be overwritten by next call to GNUNET_h2s.
- */
- const char *
- GNUNET_h2s2 (const struct GNUNET_HashCode *hc)
- {
- static GNUNET_THREAD_LOCAL struct GNUNET_CRYPTO_HashAsciiEncoded ret;
- GNUNET_CRYPTO_hash_to_enc (hc, &ret);
- ret.encoding[8] = '\0';
- return (const char *) ret.encoding;
- }
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
- const char *
- GNUNET_p2s (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
- {
- static GNUNET_THREAD_LOCAL struct GNUNET_CRYPTO_HashAsciiEncoded ret;
- struct GNUNET_HashCode hc;
- GNUNET_CRYPTO_hash (p, sizeof(*p), &hc);
- GNUNET_CRYPTO_hash_to_enc (&hc, &ret);
- ret.encoding[6] = '\0';
- return (const char *) ret.encoding;
- }
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
- const char *
- GNUNET_p2s2 (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
- {
- static GNUNET_THREAD_LOCAL struct GNUNET_CRYPTO_HashAsciiEncoded ret;
- struct GNUNET_HashCode hc;
- GNUNET_CRYPTO_hash (p, sizeof(*p), &hc);
- GNUNET_CRYPTO_hash_to_enc (&hc, &ret);
- ret.encoding[6] = '\0';
- return (const char *) ret.encoding;
- }
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
- const char *
- GNUNET_e2s (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
- {
- static GNUNET_THREAD_LOCAL struct GNUNET_CRYPTO_HashAsciiEncoded ret;
- struct GNUNET_HashCode hc;
- GNUNET_CRYPTO_hash (p, sizeof(*p), &hc);
- GNUNET_CRYPTO_hash_to_enc (&hc, &ret);
- ret.encoding[6] = '\0';
- return (const char *) ret.encoding;
- }
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
- const char *
- GNUNET_e2s2 (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
- {
- static GNUNET_THREAD_LOCAL struct GNUNET_CRYPTO_HashAsciiEncoded ret;
- struct GNUNET_HashCode hc;
- GNUNET_CRYPTO_hash (p, sizeof(*p), &hc);
- GNUNET_CRYPTO_hash_to_enc (&hc, &ret);
- ret.encoding[6] = '\0';
- return (const char *) ret.encoding;
- }
- /**
- * @ingroup logging
- * Convert a short hash value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param shc the hash code
- * @return string
- */
- const char *
- GNUNET_sh2s (const struct GNUNET_ShortHashCode *shc)
- {
- static GNUNET_THREAD_LOCAL char buf[64];
- GNUNET_STRINGS_data_to_string (shc, sizeof(*shc), buf, sizeof(buf));
- buf[6] = '\0';
- return (const char *) buf;
- }
- /**
- * @ingroup logging
- * Convert a UUID to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param uuid the UUID
- * @return string
- */
- const char *
- GNUNET_uuid2s (const struct GNUNET_Uuid *uuid)
- {
- static GNUNET_THREAD_LOCAL char buf[32];
- GNUNET_STRINGS_data_to_string (uuid, sizeof(*uuid), buf, sizeof(buf));
- buf[6] = '\0';
- return (const char *) buf;
- }
- /**
- * Convert a hash to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string form; will be overwritten by next call to GNUNET_h2s_full.
- */
- const char *
- GNUNET_h2s_full (const struct GNUNET_HashCode *hc)
- {
- static GNUNET_THREAD_LOCAL struct GNUNET_CRYPTO_HashAsciiEncoded ret;
- GNUNET_CRYPTO_hash_to_enc (hc, &ret);
- ret.encoding[sizeof(ret) - 1] = '\0';
- return (const char *) ret.encoding;
- }
- /**
- * Convert a peer identity to a string (for printing debug messages).
- *
- * @param pid the peer identity
- * @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s.
- */
- const char *
- GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
- {
- static GNUNET_THREAD_LOCAL char buf[5];
- char *ret;
- if (NULL == pid)
- return "NULL";
- ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&pid->public_key);
- GNUNET_strlcpy (buf, ret, sizeof(buf));
- GNUNET_free (ret);
- return buf;
- }
- /**
- * Convert a peer identity to a string (for printing debug messages).
- * Identical to #GNUNET_i2s(), except that another
- * buffer is used so both #GNUNET_i2s() and #GNUNET_i2s2() can be
- * used within the same log statement.
- *
- * @param pid the peer identity
- * @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s.
- */
- const char *
- GNUNET_i2s2 (const struct GNUNET_PeerIdentity *pid)
- {
- static GNUNET_THREAD_LOCAL char buf[5];
- char *ret;
- if (NULL == pid)
- return "NULL";
- ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&pid->public_key);
- GNUNET_strlcpy (buf, ret, sizeof(buf));
- GNUNET_free (ret);
- return buf;
- }
- /**
- * Convert a peer identity to a string (for printing debug messages).
- *
- * @param pid the peer identity
- * @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s_full.
- */
- const char *
- GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid)
- {
- static GNUNET_THREAD_LOCAL char buf[256];
- char *ret;
- ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&pid->public_key);
- strcpy (buf, ret);
- GNUNET_free (ret);
- return buf;
- }
- /**
- * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
- * (for printing debug messages). This is one of the very few calls
- * in the entire API that is NOT reentrant!
- *
- * @param addr the address
- * @param addrlen the length of the address in @a addr
- * @return nicely formatted string for the address
- * will be overwritten by next call to #GNUNET_a2s.
- */
- const char *
- GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
- {
- #define LEN \
- GNUNET_MAX ((INET6_ADDRSTRLEN + 8), \
- (1 + sizeof(struct sockaddr_un) - sizeof(sa_family_t)))
- static GNUNET_THREAD_LOCAL char buf[LEN];
- #undef LEN
- static GNUNET_THREAD_LOCAL char b2[6];
- const struct sockaddr_in *v4;
- const struct sockaddr_un *un;
- const struct sockaddr_in6 *v6;
- unsigned int off;
- if (addr == NULL)
- return _ ("unknown address");
- switch (addr->sa_family)
- {
- case AF_INET:
- if (addrlen != sizeof(struct sockaddr_in))
- return "<invalid v4 address>";
- v4 = (const struct sockaddr_in *) addr;
- inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
- if (0 == ntohs (v4->sin_port))
- return buf;
- strcat (buf, ":");
- GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v4->sin_port));
- strcat (buf, b2);
- return buf;
- case AF_INET6:
- if (addrlen != sizeof(struct sockaddr_in6))
- return "<invalid v6 address>";
- v6 = (const struct sockaddr_in6 *) addr;
- buf[0] = '[';
- inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
- if (0 == ntohs (v6->sin6_port))
- return &buf[1];
- strcat (buf, "]:");
- GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v6->sin6_port));
- strcat (buf, b2);
- return buf;
- case AF_UNIX:
- if (addrlen <= sizeof(sa_family_t))
- return "<unbound UNIX client>";
- un = (const struct sockaddr_un *) addr;
- off = 0;
- if ('\0' == un->sun_path[0])
- off++;
- memset (buf, 0, sizeof(buf));
- GNUNET_snprintf (buf,
- sizeof(buf),
- "%s%.*s",
- (1 == off) ? "@" : "",
- (int) (addrlen - sizeof(sa_family_t) - off),
- &un->sun_path[off]);
- return buf;
- default:
- return _ ("invalid address");
- }
- }
- /**
- * Log error message about missing configuration option.
- *
- * @param kind log level
- * @param section section with missing option
- * @param option name of missing option
- */
- void
- GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
- const char *section,
- const char *option)
- {
- GNUNET_log (kind,
- _ (
- "Configuration fails to specify option `%s' in section `%s'!\n"),
- option,
- section);
- }
- /**
- * Log error message about invalid configuration option value.
- *
- * @param kind log level
- * @param section section with invalid option
- * @param option name of invalid option
- * @param required what is required that is invalid about the option
- */
- void
- GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
- const char *section,
- const char *option,
- const char *required)
- {
- GNUNET_log (
- kind,
- _ (
- "Configuration specifies invalid value for option `%s' in section `%s': %s\n"),
- option,
- section,
- required);
- }
- /**
- * Set the async scope for the current thread.
- *
- * @param aid the async scope identifier
- * @param old_scope[out] location to save the old scope
- */
- void
- GNUNET_async_scope_enter (const struct GNUNET_AsyncScopeId *aid,
- struct GNUNET_AsyncScopeSave *old_scope)
- {
- *old_scope = current_async_scope;
- current_async_scope.have_scope = GNUNET_YES;
- current_async_scope.scope_id = *aid;
- }
- /**
- * Clear the current thread's async scope.
- *
- * @param old_scope scope to restore
- */
- void
- GNUNET_async_scope_restore (struct GNUNET_AsyncScopeSave *old_scope)
- {
- current_async_scope = *old_scope;
- }
- /**
- * Generate a fresh async scope identifier.
- *
- * @param[out] aid_ret pointer to where the result is stored
- */
- void
- GNUNET_async_scope_fresh (struct GNUNET_AsyncScopeId *aid_ret)
- {
- GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK,
- aid_ret,
- sizeof(struct GNUNET_AsyncScopeId));
- }
- /**
- * Get the current async scope.
- *
- * @param[out] scope_ret pointer to where the result is stored
- */
- void
- GNUNET_async_scope_get (struct GNUNET_AsyncScopeSave *scope_ret)
- {
- *scope_ret = current_async_scope;
- }
- /**
- * Initializer
- */
- void __attribute__ ((constructor))
- GNUNET_util_cl_init ()
- {
- GNUNET_stderr = stderr;
- }
- /**
- * Destructor
- */
- void __attribute__ ((destructor))
- GNUNET_util_cl_fini ()
- {
- }
- /* end of common_logging.c */
|