X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=netatalk.git;a=blobdiff_plain;f=libatalk%2Futil%2Flogger.c;h=c1e981dd417d5bf8473a1764ad2cef98c1802291;hp=37be21bbc001a8a875870fa8991a8a95efbf9ce2;hb=85eb0fd28ff87289d2f49a0230c07e7a7c56e101;hpb=55d2e81fa20341a99afb6235d3a4e498e3ebcf0a diff --git a/libatalk/util/logger.c b/libatalk/util/logger.c index 37be21bb..c1e981dd 100644 --- a/libatalk/util/logger.c +++ b/libatalk/util/logger.c @@ -27,10 +27,9 @@ Netatalk 2001 (c) #include #include #include +#include -#include #include - #include #define OPEN_LOGS_AS_UID 0 @@ -40,30 +39,29 @@ Netatalk 2001 (c) #define MAXLOGSIZE 512 #define LOGLEVEL_STRING_IDENTIFIERS { \ - "LOG_NOTHING", \ - "LOG_SEVERE", \ - "LOG_ERROR", \ - "LOG_WARN", \ - "LOG_NOTE", \ - "LOG_INFO", \ - "LOG_DEBUG", \ - "LOG_DEBUG6", \ - "LOG_DEBUG7", \ - "LOG_DEBUG8", \ - "LOG_DEBUG9", \ - "LOG_MAXDEBUG"} + "NOTHING", \ + "SEVERE", \ + "ERROR", \ + "WARN", \ + "NOTE", \ + "INFO", \ + "DEBUG", \ + "DEBUG6", \ + "DEBUG7", \ + "DEBUG8", \ + "DEBUG9", \ + "MAXDEBUG"} /* these are the string identifiers corresponding to each logtype */ #define LOGTYPE_STRING_IDENTIFIERS { \ "Default", \ - "Core", \ "Logger", \ "CNID", \ "AFPDaemon", \ + "DSI", \ "ATalkDaemon", \ "PAPDaemon", \ - "UAMSDaemon", \ - "Console", \ + "UAMS", \ "end_of_list_marker"} \ /* ========================================================================= @@ -77,22 +75,33 @@ log_config_t log_config = { 0 }; 0: set ? 0: syslog ? -1: logfiles fd - log_maxdebug: force first LOG call to call make_log_entry which - then calls log_init because "inited" is still 0 + log_none: no logging by default 0: Display options */ -#define DEFAULT_LOG_CONFIG {0, 0, -1, log_maxdebug, 0} +#define DEFAULT_LOG_CONFIG {0, 0, -1, log_none, 0} UAM_MODULE_EXPORT logtype_conf_t type_configs[logtype_end_of_list_marker] = { DEFAULT_LOG_CONFIG, /* logtype_default */ - DEFAULT_LOG_CONFIG, /* logtype_core */ DEFAULT_LOG_CONFIG, /* logtype_logger */ DEFAULT_LOG_CONFIG, /* logtype_cnid */ DEFAULT_LOG_CONFIG, /* logtype_afpd */ + DEFAULT_LOG_CONFIG, /* logtype_dsi */ DEFAULT_LOG_CONFIG, /* logtype_atalkd */ DEFAULT_LOG_CONFIG, /* logtype_papd */ - DEFAULT_LOG_CONFIG, /* logtype_uams */ - DEFAULT_LOG_CONFIG /* logtype_console */ + DEFAULT_LOG_CONFIG /* logtype_uams */ +}; + +/* We use this in order to track the last n log messages in order to prevent flooding */ +#define LOG_FLOODING_MINCOUNT 5 /* this controls after how many consecutive messages must be detected + before we start to hide them */ +#define LOG_FLOODING_MAXCOUNT 1000 /* this controls after how many consecutive messages we force a + "repeated x times" message */ +#define LOG_FLOODING_ARRAY_SIZE 3 /* this contols how many messages in flow we track */ +struct log_flood_entry { + int count; + unsigned int hash; }; +static struct log_flood_entry log_flood_array[LOG_FLOODING_ARRAY_SIZE]; +static int log_flood_entries; /* These are used by the LOG macro to store __FILE__ and __LINE__ */ static const char *log_src_filename; @@ -113,54 +122,18 @@ static const unsigned int num_loglevel_strings = COUNT_ARRAY(arr_loglevel_string Internal function definitions ========================================================================= */ -/* - * If filename == NULL its for syslog logging, otherwise its for file-logging. - * "unsetuplog" calls with loglevel == NULL. - * loglevel == NULL means: - * if logtype == default - * disable logging - * else - * set to default logging - */ -static void setuplog_internal(const char *loglevel, const char *logtype, const char *filename) +/* Hash a log message */ +static unsigned int hash_message(const char *message) { - unsigned int typenum, levelnum; - - /* Parse logtype */ - for( typenum=0; typenum < num_logtype_strings; typenum++) { - if (strcasecmp(logtype, arr_logtype_strings[typenum]) == 0) - break; - } - if (typenum >= num_logtype_strings) { - return; - } + const char *p = message; + unsigned int hash = 0, i = 7; - /* Parse loglevel */ - if (loglevel == NULL) { - levelnum = 0; - } else { - for(levelnum=1; levelnum < num_loglevel_strings; levelnum++) { - if (strcasecmp(loglevel, arr_loglevel_strings[levelnum]) == 0) - break; - } - if (levelnum >= num_loglevel_strings) { - return; - } + while (*p) { + hash += *p * i; + i++; + p++; } - - /* is this a syslog setup or a filelog setup ? */ - if (filename == NULL) { - /* must be syslog */ - syslog_setup(levelnum, - typenum, - logoption_ndelay | logoption_pid, - logfacility_daemon); - } else { - /* this must be a filelog */ - log_setup(filename, levelnum, typenum); - } - - return; + return hash; } static void generate_message_details(char *message_details_buffer, @@ -256,11 +229,20 @@ static int get_syslog_equivalent(enum loglevels loglevel) } } -/* ========================================================================= - Global function definitions - ========================================================================= */ +/* Called by the LOG macro for syslog messages */ +static void make_syslog_entry(enum loglevels loglevel, enum logtypes logtype _U_, char *message) +{ + if ( !log_config.syslog_opened ) { + openlog(log_config.processname, + log_config.syslog_display_options, + log_config.syslog_facility); + log_config.syslog_opened = true; + } -void log_init(void) + syslog(get_syslog_equivalent(loglevel), "%s", message); +} + +static void log_init(void) { syslog_setup(log_info, logtype_default, @@ -268,7 +250,7 @@ void log_init(void) logfacility_daemon); } -void log_setup(const char *filename, enum loglevels loglevel, enum logtypes logtype) +static void log_setup(const char *filename, enum loglevels loglevel, enum logtypes logtype) { uid_t process_uid; @@ -319,12 +301,6 @@ void log_setup(const char *filename, enum loglevels loglevel, enum logtypes logt } } - /* Check if logging to a console */ - if (logtype == logtype_console) { - log_config.console = 1; - logtype = logtype_default; - } - /* Set new values */ type_configs[logtype].level = loglevel; @@ -344,8 +320,7 @@ void log_setup(const char *filename, enum loglevels loglevel, enum logtypes logt process_uid = geteuid(); if (process_uid) { if (seteuid(OPEN_LOGS_AS_UID) == -1) { - /* XXX failing silently */ - return; + process_uid = 0; } } type_configs[logtype].fd = open(filename, @@ -391,7 +366,7 @@ void log_setup(const char *filename, enum loglevels loglevel, enum logtypes logt } /* Setup syslog logging */ -void syslog_setup(int loglevel, enum logtypes logtype, int display_options, int facility) +static void syslog_setup(int loglevel, enum logtypes logtype, int display_options, int facility) { /* * FIXME: @@ -420,14 +395,64 @@ void syslog_setup(int loglevel, enum logtypes logtype, int display_options, int log_config.inited = 1; - LOG(log_note, logtype_logger, "Set syslog logging to level: %s", + LOG(log_info, logtype_logger, "Set syslog logging to level: %s", arr_loglevel_strings[loglevel]); } -void log_close(void) +/* + * If filename == NULL its for syslog logging, otherwise its for file-logging. + * "unsetuplog" calls with loglevel == NULL. + * loglevel == NULL means: + * if logtype == default + * disable logging + * else + * set to default logging + */ +static void setuplog_internal(const char *loglevel, const char *logtype, const char *filename) { + unsigned int typenum, levelnum; + + /* Parse logtype */ + for( typenum=0; typenum < num_logtype_strings; typenum++) { + if (strcasecmp(logtype, arr_logtype_strings[typenum]) == 0) + break; + } + if (typenum >= num_logtype_strings) { + return; + } + + /* Parse loglevel */ + if (loglevel == NULL) { + levelnum = 0; + } else { + for(levelnum=1; levelnum < num_loglevel_strings; levelnum++) { + if (strcasecmp(loglevel, arr_loglevel_strings[levelnum]) == 0) + break; + } + if (levelnum >= num_loglevel_strings) { + return; + } + } + + /* is this a syslog setup or a filelog setup ? */ + if (filename == NULL) { + /* must be syslog */ + syslog_setup(levelnum, + typenum, + logoption_ndelay | logoption_pid, + logfacility_daemon); + } else { + /* this must be a filelog */ + log_setup(filename, levelnum, typenum); + } + + return; } +/* ========================================================================= + Global function definitions + ========================================================================= */ + /* This function sets up the processname */ void set_processname(const char *processname) { @@ -435,19 +460,6 @@ void set_processname(const char *processname) log_config.processname[15] = 0; } -/* Called by the LOG macro for syslog messages */ -static void make_syslog_entry(enum loglevels loglevel, enum logtypes logtype _U_, char *message) -{ - if ( !log_config.syslog_opened ) { - openlog(log_config.processname, - log_config.syslog_display_options, - log_config.syslog_facility); - log_config.syslog_opened = true; - } - - syslog(get_syslog_equivalent(loglevel), "%s", message); -} - /* ------------------------------------------------------------------------- make_log_entry has 1 main flaws: The message in its entirity, must fit into the tempbuffer. @@ -503,7 +515,7 @@ void make_log_entry(enum loglevels loglevel, enum logtypes logtype, if (fd < 0) { /* no where to send the output, give up */ - return; + goto exit; } /* Initialise the Messages */ @@ -522,6 +534,66 @@ void make_log_entry(enum loglevels loglevel, enum logtypes logtype, temp_buffer[len+1] = 0; } + if (type_configs[logtype].level >= log_debug) + goto log; /* bypass flooding checks */ + + /* Prevent flooding: hash the message and check if we got the same one recently */ + int hash = hash_message(temp_buffer) + log_src_linenumber; + + /* Search for the same message by hash */ + for (int i = log_flood_entries - 1; i >= 0; i--) { + if (log_flood_array[i].hash == hash) { + + /* found same message */ + log_flood_array[i].count++; + + /* Check if that message has reached LOG_FLOODING_MAXCOUNT */ + if (log_flood_array[i].count >= LOG_FLOODING_MAXCOUNT) { + /* yes, log it and remove from array */ + + /* reusing log_details_buffer */ + sprintf(log_details_buffer, "message repeated %i times\n", + LOG_FLOODING_MAXCOUNT - 1); + write(fd, log_details_buffer, strlen(log_details_buffer)); + + if ((i + 1) == LOG_FLOODING_ARRAY_SIZE) { + /* last array element, just decrement count */ + log_flood_entries--; + goto exit; + } + /* move array elements down */ + for (int j = i + 1; j != LOG_FLOODING_ARRAY_SIZE ; j++) + log_flood_array[j-1] = log_flood_array[j]; + log_flood_entries--; + } + + if (log_flood_array[i].count < LOG_FLOODING_MINCOUNT) + /* log it */ + goto log; + /* discard it */ + goto exit; + } /* if */ + } /* for */ + + /* No matching message found, add this message to array*/ + if (log_flood_entries == LOG_FLOODING_ARRAY_SIZE) { + /* array is full, discard oldest entry printing "message repeated..." if count > 1 */ + if (log_flood_array[0].count >= LOG_FLOODING_MINCOUNT) { + /* reusing log_details_buffer */ + sprintf(log_details_buffer, "message repeated %i times\n", + log_flood_array[0].count - LOG_FLOODING_MINCOUNT + 1); + write(fd, log_details_buffer, strlen(log_details_buffer)); + } + for (int i = 1; i < LOG_FLOODING_ARRAY_SIZE; i++) { + log_flood_array[i-1] = log_flood_array[i]; + } + log_flood_entries--; + } + log_flood_array[log_flood_entries].count = 1; + log_flood_array[log_flood_entries].hash = hash; + log_flood_entries++; + +log: if ( ! log_config.console) { generate_message_details(log_details_buffer, sizeof(log_details_buffer), type_configs[logtype].set ? @@ -539,60 +611,38 @@ void make_log_entry(enum loglevels loglevel, enum logtypes logtype, write(fd, temp_buffer, strlen(temp_buffer)); } +exit: inlog = 0; } - -void setuplog(const char *logstr) +void setuplog(const char *logstr, const char *logfile) { - char *ptr, *ptrbak, *logtype, *loglevel = NULL, *filename = NULL; - ptr = strdup(logstr); - ptrbak = ptr; + char *ptr, *save; + char *logtype, *loglevel; + char c; - /* logtype */ - logtype = ptr; + save = ptr = strdup(logstr); - /* get loglevel */ - ptr = strpbrk(ptr, " \t"); - if (ptr) { - *ptr++ = 0; + while (*ptr) { while (*ptr && isspace(*ptr)) ptr++; - loglevel = ptr; - /* get filename */ - ptr = strpbrk(ptr, " \t"); - if (ptr) { - *ptr++ = 0; - while (*ptr && isspace(*ptr)) - ptr++; - } - filename = ptr; - if (filename && *filename == 0) - filename = NULL; - } + logtype = ptr; + ptr = strpbrk(ptr, ":"); + if (!ptr) + break; + *ptr = 0; - /* finally call setuplog, filename can be NULL */ - setuplog_internal(loglevel, logtype, filename); + ptr++; + loglevel = ptr; + while (*ptr && !isspace(*ptr)) + ptr++; + c = *ptr; + *ptr = 0; + setuplog_internal(loglevel, logtype, filename); + *ptr = c; + } - free(ptrbak); + free(save); } -void unsetuplog(const char *logstr) -{ - char *str, *logtype, *filename; - - str = strdup(logstr); - - /* logtype */ - logtype = str; - - /* get filename, can be NULL */ - strtok(str, " \t"); - filename = strtok(NULL, " \t"); - - /* finally call setuplog, filename can be NULL */ - setuplog_internal(NULL, str, filename); - - free(str); -}