*/
#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.
*/
*/
static char *component_nopid;
+/**
+ * Format string describing the name of the log file.
+ */
+static char *log_file_name;
+
/**
* Minimum log level.
*/
/**
* Number of log calls to ignore.
*/
-unsigned int skip_log;
+int skip_log = 0;
/**
* File descriptor to use for "stderr", or NULL for none.
/**
* Dynamic array of logging definitions
*/
-struct LogDef *logdefs = NULL;
+static struct LogDef *logdefs;
/**
* Allocated size of logdefs array (in units)
*/
-int logdefs_size = 0;
+static int logdefs_size;
/**
* The number of units used in logdefs array.
*/
-int logdefs_len = 0;
+static int logdefs_len;
/**
* GNUNET_YES if GNUNET_LOG environment variable is already parsed.
*/
-int gnunet_log_parsed = GNUNET_NO;
+static int gnunet_log_parsed;
/**
* GNUNET_YES if GNUNET_FORCE_LOG environment variable is already parsed.
*/
-int gnunet_force_log_parsed = GNUNET_NO;
+static int gnunet_force_log_parsed;
/**
* GNUNET_YES if at least one definition with forced == 1 is available.
*/
-int gnunet_force_log_present = GNUNET_NO;
+static int gnunet_force_log_present;
#ifdef WINDOWS
/**
* Contains the number of performance counts per second.
*/
-LARGE_INTEGER performance_frequency;
+static LARGE_INTEGER performance_frequency;
#endif
+
/**
* Convert a textual description of a loglevel
* to the respective GNUNET_GE_KIND.
static enum GNUNET_ErrorType
get_type (const char *log)
{
- if (log == NULL)
+ if (NULL == log)
return GNUNET_ERROR_TYPE_UNSPECIFIED;
if (0 == strcasecmp (log, _("DEBUG")))
return GNUNET_ERROR_TYPE_DEBUG;
return GNUNET_ERROR_TYPE_INVALID;
}
+
#if !defined(GNUNET_CULL_LOGGING)
/**
* Utility function - reallocates logdefs array to be twice as large.
}
+/**
+ * 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 dirwarn;
+ 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);
+ dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
+#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 (-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);
+ if (dirwarn)
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+ _("Failed to create or access directory for log file `%s'\n"),
+ fn);
+ return GNUNET_SYSERR;
+ }
+ GNUNET_stderr = altlog;
+ return GNUNET_OK;
+}
+
/**
* Utility function - adds a parsed definition to logdefs array.
*
if (logdefs_size == logdefs_len)
resize_logdefs ();
memset (&n, 0, sizeof (n));
- if (strlen (component) == 0)
+ if (0 == strlen (component))
component = (char *) ".*";
r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
- if (r != 0)
+ if (0 != r)
{
return r;
}
- if (strlen (file) == 0)
+ if (0 == strlen (file))
file = (char *) ".*";
r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
- if (r != 0)
+ if (0 != r)
{
regfree (&n.component_regex);
return r;
}
- if ((NULL == function) || (strlen (function) == 0))
+ if ((NULL == function) || (0 == strlen (function)))
function = (char *) ".*";
r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
- if (r != 0)
+ if (0 != r)
{
regfree (&n.component_regex);
regfree (&n.file_regex);
int i;
int force_only;
- if (comp == NULL)
+ 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_force_log_present == GNUNET_NO)
+ if ( (min_level >= 0) && (GNUNET_NO == gnunet_force_log_present) )
return caller_level <= min_level;
/* Only look for forced definitions? */
for (i = 0; i < logdefs_len; i++)
{
ld = &logdefs[i];
- if ((!force_only || ld->force) &&
+ 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))
+ (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;
int keep_looking = 1;
tmp = getenv (constname);
- if (tmp == NULL)
+ if (NULL == tmp)
return 0;
def = GNUNET_strdup (tmp);
- level = -1;
from_line = 0;
to_line = INT_MAX;
for (p = def, state = 0, start = def; keep_looking; p++)
{
errno = 0;
from_line = strtol (start, &t, 10);
- if (errno != 0 || from_line < 0)
+ if ( (0 != errno) || (from_line < 0) )
{
- free (def);
+ GNUNET_free (def);
return counter;
}
- if (t < p && t[0] == '-')
+ if ( (t < p) && ('-' == t[0]) )
{
errno = 0;
start = t + 1;
to_line = strtol (start, &t, 10);
- if (errno != 0 || to_line < 0 || t != p)
+ if ( (0 != errno) || (to_line < 0) || (t != p) )
{
- free (def);
+ GNUNET_free (def);
return counter;
}
}
break;
}
start = p + 1;
- state += 1;
+ state++;
break;
case '\0': /* found EOL */
keep_looking = 0;
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))
+ if ( (GNUNET_ERROR_TYPE_INVALID == level) ||
+ (GNUNET_ERROR_TYPE_UNSPECIFIED == level) ||
+ (0 != add_definition (comp, file, function, from_line, to_line,
+ level, force)) )
{
- free (def);
+ GNUNET_free (def);
return counter;
}
- counter += 1;
+ counter++;
start = p + 1;
break;
default:
break;
}
}
- free (def);
+ 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)
+ if (GNUNET_NO == gnunet_log_parsed)
parse_definitions ("GNUNET_LOG", 0);
gnunet_log_parsed = GNUNET_YES;
- if (gnunet_force_log_parsed == GNUNET_NO)
+ 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;
}
#endif
+
+
/**
* Setup logging.
*
int
GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
{
- FILE *altlog;
- int dirwarn;
- char *fn;
- const char *env_logfile = NULL;
+ const char *env_logfile;
+ const struct tm *tm;
+ time_t t;
min_level = get_type (loglevel);
#if !defined(GNUNET_CULL_LOGGING)
component_nopid = GNUNET_strdup (comp);
env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
- if ((env_logfile != NULL) && (strlen (env_logfile) > 0))
+ if ((NULL != env_logfile) && (strlen (env_logfile) > 0))
logfile = env_logfile;
-
- if (logfile == NULL)
+ if (NULL == logfile)
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)
- {
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
- if (dirwarn)
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
- _("Failed to create or access directory for log file `%s'\n"),
- fn);
- GNUNET_free (fn);
+ GNUNET_free_non_null (log_file_name);
+ log_file_name = GNUNET_STRINGS_filename_expand (logfile);
+ if (NULL == log_file_name)
return GNUNET_SYSERR;
- }
- GNUNET_free (fn);
- if (GNUNET_stderr != NULL)
- fclose (GNUNET_stderr);
- GNUNET_stderr = altlog;
- return GNUNET_OK;
+ t = time (NULL);
+ tm = gmtime (&t);
+ return setup_log_file (tm);
}
+
/**
* Add a custom logger.
*
loggers = entry;
}
+
/**
* Remove a custom logger.
*
GNUNET_free (pos);
}
+#if WINDOWS
+CRITICAL_SECTION output_message_cs;
+#endif
+
/**
* Actually output the log message.
const char *datestr, const char *msg)
{
struct CustomLogger *pos;
-
- if (GNUNET_stderr != NULL)
+#if WINDOWS
+ EnterCriticalSection (&output_message_cs);
+#endif
+ if (NULL != GNUNET_stderr)
{
- 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);
}
pos->logger (pos->logger_cls, kind, comp, datestr, msg);
pos = pos->next;
}
+#if WINDOWS
+ LeaveCriticalSection (&output_message_cs);
+#endif
}
char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
int rev;
char *last;
- char *ft;
+ const char *ft;
if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
return;
last[0] = '\0';
}
ft = GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
- (last_bulk_time));
+ (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);
- GNUNET_free (ft);
if (rev == 1)
last[0] = '\n';
output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
/**
* Ignore the next n calls to the log function.
*
- * @param n number of log calls to ignore
+ * @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 (unsigned int n, int check_reset)
+GNUNET_log_skip (int n, int check_reset)
{
- if (n == 0)
- {
- int ok;
+ int ok;
+ if (0 == n)
+ {
ok = (0 == skip_log);
skip_log = 0;
if (check_reset)
- GNUNET_assert (ok);
+ 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.
{
char date[DATE_STR_SIZE];
char date2[DATE_STR_SIZE];
- time_t timetmp;
- struct timeval timeofday;
struct tm *tmptr;
size_t size;
va_list vacp;
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;
+#ifdef WINDOWS
+ LARGE_INTEGER pc;
+ time_t timetmp;
- VSNPRINTF (buf, size, message, va);
+ offset = GNUNET_TIME_get_offset ();
time (&timetmp);
- memset (date, 0, DATE_STR_SIZE);
+ timetmp += offset / 1000;
tmptr = localtime (&timetmp);
- gettimeofday (&timeofday, NULL);
- if (NULL != tmptr)
+ pc.QuadPart = 0;
+ QueryPerformanceCounter (&pc);
+ if (NULL == tmptr)
+ {
+ strcpy (date, "localtime error");
+ }
+ else
{
-#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)));
+ (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);
-#endif
+ 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
+ {
+ strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
+ snprintf (date, sizeof (date), date2, timeofday.tv_usec);
+ }
+#endif
+ VSNPRINTF (buf, size, message, va);
+ if (NULL != tmptr)
+ (void) setup_log_file (tmptr);
if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
(last_bulk_time.abs_value != 0) &&
(0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
}
+/**
+ * Convert a short 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 short hash code
+ * @return string form; will be overwritten by next call to GNUNET_h2s.
+ */
+const char *
+GNUNET_short_h2s (const struct GNUNET_CRYPTO_ShortHashCode * hc)
+{
+ static struct GNUNET_CRYPTO_ShortHashAsciiEncoded ret;
+
+ GNUNET_CRYPTO_short_hash_to_enc (hc, &ret);
+ ret.short_encoding[8] = '\0';
+ return (const char *) ret.short_encoding;
+}
+
+
+/**
+ * Convert a short 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 short hash code
+ * @return string form; will be overwritten by next call to GNUNET_h2s_full.
+ */
+const char *
+GNUNET_short_h2s_full (const struct GNUNET_CRYPTO_ShortHashCode * hc)
+{
+ static struct GNUNET_CRYPTO_ShortHashAsciiEncoded ret;
+
+ GNUNET_CRYPTO_short_hash_to_enc (hc, &ret);
+ ret.short_encoding[sizeof (ret) - 1] = '\0';
+ return (const char *) ret.short_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
* @return string form; will be overwritten by next call to GNUNET_h2s.
*/
const char *
-GNUNET_h2s (const GNUNET_HashCode * hc)
+GNUNET_h2s (const struct GNUNET_HashCode * hc)
{
static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
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
* @return string form; will be overwritten by next call to GNUNET_h2s_full.
*/
const char *
-GNUNET_h2s_full (const GNUNET_HashCode * hc)
+GNUNET_h2s_full (const struct GNUNET_HashCode * hc)
{
static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
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
}
+/**
+ * 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;
+}
+
/**
* Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
off = 0;
if (un->sun_path[0] == '\0')
off++;
- snprintf (buf, sizeof (buf), "%s%.*s", (off == 1) ? "@" : "",
+ memset (buf, 0, sizeof (buf));
+ snprintf (buf, sizeof (buf) - 1, "%s%.*s", (off == 1) ? "@" : "",
(int) (addrlen - sizeof (sa_family_t) - 1 - off),
&un->sun_path[off]);
return buf;
}
+/**
+ * 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);
+}
+
+
/**
* Initializer
*/
#ifdef MINGW
GNInitWinEnv (NULL);
#endif
+#if WINDOWS
+ if (!InitializeCriticalSectionAndSpinCount (&output_message_cs, 0x00000400))\r
+ GNUNET_abort ();
+#endif
}
*/
void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
{
+#if WINDOWS
+ DeleteCriticalSection (&output_message_cs);
+#endif
#ifdef MINGW
GNShutdownWinEnv ();
#endif
projects / oweals / gnunet.git / blobdiff