#include "gnunet_strings_lib.h"
#include "gnunet_time_lib.h"
+#include <regex.h>
+
/**
* After how many milliseconds do we always print
* that "message X was repeated N times"? Use 12h.
*/
static char *component;
+/**
+ * Running component (without pid).
+ */
+static char *component_nopid;
+
/**
* Minimum log level.
*/
/**
* Number of log calls to ignore.
*/
-static unsigned int skip_log;
+unsigned int skip_log;
/**
* 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;
+};
+
+/**
+ * Dynamic array of logging definitions
+ */
+struct LogDef *logdefs = NULL;
+
+/**
+ * Allocated size of logdefs array (in units)
+ */
+int logdefs_size = 0;
+
+/**
+ * The number of units used in logdefs array.
+ */
+int logdefs_len = 0;
+
+/**
+ * GNUNET_YES if GNUNET_LOG environment variable is already parsed.
+ */
+int gnunet_log_parsed = GNUNET_NO;
+
+/**
+ * GNUNET_YES if GNUNET_FORCE_LOG environment variable is already parsed.
+ */
+int gnunet_force_log_parsed = GNUNET_NO;
+
+/**
+ * GNUNET_YES if at least one definition with forced == 1 is available.
+ */
+int gnunet_force_log_present = GNUNET_NO;
+
#ifdef WINDOWS
/**
* Contains the number of performance counts per second.
static enum GNUNET_ErrorType
get_type (const char *log)
{
+ if (log == NULL)
+ return GNUNET_ERROR_TYPE_UNSPECIFIED;
if (0 == strcasecmp (log, _("DEBUG")))
return GNUNET_ERROR_TYPE_DEBUG;
if (0 == strcasecmp (log, _("INFO")))
return GNUNET_ERROR_TYPE_INVALID;
}
+#if !defined(GNUNET_CULL_LOGGING)
+/**
+ * Utility function - reallocates logdefs array to be twice as large.
+ */
+static void
+resize_logdefs ()
+{
+ logdefs_size = (logdefs_size + 1) * 2;
+ logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
+}
+
+
+/**
+ * Abort the process, generate a core dump if possible.
+ */
+void
+GNUNET_abort ()
+{
+#if WINDOWS
+ DebugBreak ();
+#endif
+ abort ();
+}
+
+
+/**
+ * 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 (char *component, char *file, 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 (strlen (component) == 0)
+ component = (char *) ".*";
+ r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
+ if (r != 0)
+ {
+ return r;
+ }
+ if (strlen (file) == 0)
+ file = (char *) ".*";
+ r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
+ if (r != 0)
+ {
+ regfree (&n.component_regex);
+ return r;
+ }
+ if ((NULL == function) || (strlen (function) == 0))
+ function = (char *) ".*";
+ r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
+ if (r != 0)
+ {
+ 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 (comp == NULL)
+ /* 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_force_log_present == GNUNET_NO)
+ 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) &&
+ (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) == 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.
+ */
+ return caller_level <= GNUNET_ERROR_TYPE_WARNING;
+}
+
+
+/**
+ * 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 (tmp == NULL)
+ 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 (errno != 0 || 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 (errno != 0 || 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;
+ }
+ start = p + 1;
+ state += 1;
+ 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 (level == GNUNET_ERROR_TYPE_INVALID ||
+ level == GNUNET_ERROR_TYPE_UNSPECIFIED ||
+ 0 != add_definition (comp, file, function, from_line, to_line,
+ level, force))
+ {
+ GNUNET_free (def);
+ return counter;
+ }
+ counter += 1;
+ start = p + 1;
+ break;
+ default:
+ break;
+ }
+ default:
+ break;
+ }
+ }
+ GNUNET_free (def);
+ return counter;
+}
+
+/**
+ * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
+ */
+static void
+parse_all_definitions ()
+{
+ if (gnunet_log_parsed == GNUNET_NO)
+ parse_definitions ("GNUNET_LOG", 0);
+ gnunet_log_parsed = GNUNET_YES;
+ if (gnunet_force_log_parsed == GNUNET_NO)
+ gnunet_force_log_present =
+ parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
+ gnunet_force_log_parsed = GNUNET_YES;
+}
+#endif
+
/**
* Setup logging.
FILE *altlog;
int dirwarn;
char *fn;
- const char *env_loglevel;
- int env_minlevel = 0;
- int env_min_force_level = 100000;
+ const char *env_logfile = NULL;
+ int altlog_fd;
+ min_level = get_type (loglevel);
+#if !defined(GNUNET_CULL_LOGGING)
+ parse_all_definitions ();
+#endif
#ifdef WINDOWS
QueryPerformanceFrequency (&performance_frequency);
#endif
GNUNET_free_non_null (component);
GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
- env_loglevel = getenv ("GNUNET_LOGLEVEL");
- if (env_loglevel != NULL)
- env_minlevel = get_type (env_loglevel);
- env_loglevel = getenv ("GNUNET_FORCE_LOGLEVEL");
- if (env_loglevel != NULL)
- env_min_force_level = get_type (env_loglevel);
- min_level = get_type (loglevel);
- if (env_minlevel > min_level)
- min_level = env_minlevel;
- if (env_min_force_level < min_level)
- min_level = env_min_force_level;
+ GNUNET_free_non_null (component_nopid);
+ component_nopid = GNUNET_strdup (comp);
+
+ env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
+ if ((env_logfile != NULL) && (strlen (env_logfile) > 0))
+ logfile = env_logfile;
+
if (logfile == NULL)
return GNUNET_OK;
fn = GNUNET_STRINGS_filename_expand (logfile);
if (NULL == fn)
return GNUNET_SYSERR;
dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
- altlog = FOPEN (fn, "a");
- if (altlog == NULL)
+#if WINDOWS
+ altlog_fd = OPEN (fn, O_APPEND |
+ O_BINARY |
+ O_WRONLY | O_CREAT,
+ _S_IREAD | _S_IWRITE);
+#else
+ altlog_fd = OPEN (fn, O_APPEND |
+ O_WRONLY | O_CREAT,
+ S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
+#endif
+ if (altlog_fd != -1)
{
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
+ int dup_return;
+ if (GNUNET_stderr != NULL)
+ fclose (GNUNET_stderr);
+ dup_return = dup2 (altlog_fd, 2);
+ (void) close (altlog_fd);
+ if (dup_return != -1)
+ {
+ altlog = fdopen (2, "ab");
+ if (altlog == NULL)
+ {
+ (void) close (2);
+ altlog_fd = -1;
+ }
+ }
+ else
+ {
+ altlog_fd = -1;
+ }
+ }
+ if (altlog_fd == -1)
+ {
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", fn);
if (dirwarn)
GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
_("Failed to create or access directory for log file `%s'\n"),
return GNUNET_SYSERR;
}
GNUNET_free (fn);
- if (GNUNET_stderr != NULL)
- fclose (GNUNET_stderr);
GNUNET_stderr = altlog;
return GNUNET_OK;
}
* @param msg the actual message
*/
static void
-output_message (enum GNUNET_ErrorType kind,
- const char *comp, const char *datestr, const char *msg)
+output_message (enum GNUNET_ErrorType kind, const char *comp,
+ const char *datestr, const char *msg)
{
struct CustomLogger *pos;
if (GNUNET_stderr != NULL)
{
- fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
+ FPRINTF (GNUNET_stderr, "%s %s %s %s", datestr, comp,
GNUNET_error_type_to_string (kind), msg);
fflush (GNUNET_stderr);
}
* @param va arguments to the format string "message"
*/
static void
-mylog (enum GNUNET_ErrorType kind,
- const char *comp, const char *message, va_list va)
+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 timeval timeofday;
struct tm *tmptr;
size_t size;
- char *buf;
va_list vacp;
- if (skip_log > 0)
- {
- skip_log--;
- return;
- }
- if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
- return;
va_copy (vacp, va);
size = VSNPRINTF (NULL, 0, message, vacp) + 1;
+ GNUNET_assert (0 != size);
va_end (vacp);
- buf = malloc (size);
- if (buf == NULL)
- return; /* oops */
- VSNPRINTF (buf, size, message, va);
- time (&timetmp);
- memset (date, 0, DATE_STR_SIZE);
- tmptr = localtime (&timetmp);
- gettimeofday (&timeofday, NULL);
- if (NULL != tmptr)
{
+ char buf[size];
+
+ VSNPRINTF (buf, size, message, va);
+ time (&timetmp);
+ memset (date, 0, DATE_STR_SIZE);
+ tmptr = localtime (&timetmp);
+ gettimeofday (&timeofday, NULL);
+ if (NULL != tmptr)
+ {
#ifdef WINDOWS
- LARGE_INTEGER pc;
-
- pc.QuadPart = 0;
- QueryPerformanceCounter (&pc);
- strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
- snprintf (date, sizeof (date), date2,
- (long long) (pc.QuadPart /
- (performance_frequency.QuadPart / 1000)));
+ LARGE_INTEGER pc;
+
+ pc.QuadPart = 0;
+ QueryPerformanceCounter (&pc);
+ strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
+ snprintf (date, sizeof (date), date2,
+ (long long) (pc.QuadPart /
+ (performance_frequency.QuadPart / 1000)));
#else
- strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
- snprintf (date, sizeof (date), date2, timeofday.tv_usec);
+ strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
+ snprintf (date, sizeof (date), date2, timeofday.tv_usec);
#endif
+ }
+ else
+ strcpy (date, "localtime error");
+ if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
+ (last_bulk_time.abs_value != 0) &&
+ (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
+ {
+ last_bulk_repeat++;
+ if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
+ BULK_DELAY_THRESHOLD) || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
+ flush_bulk (date);
+ return;
+ }
+ flush_bulk (date);
+ strncpy (last_bulk, buf, sizeof (last_bulk));
+ last_bulk_repeat = 0;
+ last_bulk_kind = kind;
+ last_bulk_time = GNUNET_TIME_absolute_get ();
+ strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
+ output_message (kind, comp, date, buf);
}
- else
- strcpy (date, "localtime error");
- if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
- (last_bulk_time.abs_value != 0) &&
- (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
- {
- last_bulk_repeat++;
- if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
- BULK_DELAY_THRESHOLD) || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
- flush_bulk (date);
- free (buf);
- return;
- }
- flush_bulk (date);
- strncpy (last_bulk, buf, sizeof (last_bulk));
- last_bulk_repeat = 0;
- last_bulk_kind = kind;
- last_bulk_time = GNUNET_TIME_absolute_get ();
- strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
- output_message (kind, comp, date, buf);
- free (buf);
}
* @param ... arguments for format string
*/
void
-GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
+GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
{
va_list va;
* @param ... arguments for format string
*/
void
-GNUNET_log_from (enum GNUNET_ErrorType kind,
- const char *comp, const char *message, ...)
+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);
return _("INFO");
if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
return _("DEBUG");
+ if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
+ return _("NONE");
return _("INVALID");
}
return (const char *) ret.encoding;
}
+/**
+ * Convert a peer identity to a string (for printing debug messages).
+ * This is one of the very few calls in the entire API that is
+ * NOT reentrant!
+ *
+ * @param pid the peer identity
+ * @return string form of the pid; will be overwritten by next
+ * call to GNUNET_i2s.
+ */
+const char *
+GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid)
+{
+ static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
+
+ GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
+ return (const char *) ret.encoding;
+}
/**
off = 0;
if (un->sun_path[0] == '\0')
off++;
- snprintf (buf,
- sizeof (buf),
- "%s%.*s",
- (off == 1) ? "@" : "",
+ snprintf (buf, sizeof (buf), "%s%.*s", (off == 1) ? "@" : "",
(int) (addrlen - sizeof (sa_family_t) - 1 - off),
&un->sun_path[off]);
return buf;
projects / oweals / gnunet.git / blobdiff