diff options
Diffstat (limited to 'snmplib/snmp_debug.c')
| -rw-r--r-- | snmplib/snmp_debug.c | 578 |
1 files changed, 578 insertions, 0 deletions
diff --git a/snmplib/snmp_debug.c b/snmplib/snmp_debug.c new file mode 100644 index 0000000..27ce233 --- /dev/null +++ b/snmplib/snmp_debug.c @@ -0,0 +1,578 @@ +#include <net-snmp/net-snmp-config.h> + +#include <limits.h> +#include <stdio.h> +#if HAVE_STDLIB_H +#include <stdlib.h> +#endif +#if HAVE_STRING_H +#include <string.h> +#else +#include <strings.h> +#endif +#include <sys/types.h> +#if HAVE_NETINET_IN_H +#include <netinet/in.h> +#endif +#include <stdarg.h> + +#if HAVE_UNISTD_H +#include <unistd.h> +#endif +#if HAVE_DMALLOC_H +#include <dmalloc.h> +#endif + +#include <net-snmp/types.h> +#include <net-snmp/output_api.h> +#include <net-snmp/library/snmp_debug.h> /* For this file's "internal" definitions */ +#include <net-snmp/config_api.h> +#include <net-snmp/utilities.h> + +#include <net-snmp/library/mib.h> +#include <net-snmp/library/snmp_api.h> + +#define SNMP_DEBUG_DISABLED 0 +#define SNMP_DEBUG_ACTIVE 1 +#define SNMP_DEBUG_EXCLUDED 2 + +#ifndef NETSNMP_NO_DEBUGGING + +static int dodebug = NETSNMP_ALWAYS_DEBUG; +int debug_num_tokens = 0; +static int debug_print_everything = 0; + +netsnmp_token_descr dbg_tokens[MAX_DEBUG_TOKENS]; + +/* + * Number of spaces to indent debug outpur. Valid range is [0,INT_MAX] + */ +static int debugindent = 0; + +int +debug_indent_get(void) +{ + return debugindent; +} + +const char* +debug_indent(void) +{ +#define SPACES " " \ + " " + if ((sizeof(SPACES) - 1) < (unsigned int)debugindent) { + snmp_log(LOG_ERR, "Too deep indentation for debug_indent. " + "Consider using \"%%*s\", debug_indent_get(), \"\" instead."); + return SPACES; + } + return SPACES + sizeof(SPACES) - 1 - debugindent; +#undef SPACES +} + +void +debug_indent_add(int amount) +{ + if (-debugindent <= amount && amount <= INT_MAX - debugindent) + debugindent += amount; +} + +NETSNMP_IMPORT void +debug_config_register_tokens(const char *configtoken, char *tokens); + +void +debug_config_register_tokens(const char *configtoken, char *tokens) +{ + debug_register_tokens(tokens); +} + +NETSNMP_IMPORT void +debug_config_turn_on_debugging(const char *configtoken, char *line); + +void +debug_config_turn_on_debugging(const char *configtoken, char *line) +{ + snmp_set_do_debugging(atoi(line)); +} + +void +debug_register_tokens(const char *tokens) +{ + char *newp, *cp; + char *st = NULL; + int status; + + if (tokens == NULL || *tokens == 0) + return; + + newp = strdup(tokens); /* strtok_r messes it up */ + cp = strtok_r(newp, DEBUG_TOKEN_DELIMITER, &st); + while (cp) { + if (strlen(cp) < MAX_DEBUG_TOKEN_LEN) { + if (strcasecmp(cp, DEBUG_ALWAYS_TOKEN) == 0) { + debug_print_everything = 1; + } else if (debug_num_tokens < MAX_DEBUG_TOKENS) { + if ('-' == *cp) { + ++cp; + status = SNMP_DEBUG_EXCLUDED; + } + else + status = SNMP_DEBUG_ACTIVE; + dbg_tokens[debug_num_tokens].token_name = strdup(cp); + dbg_tokens[debug_num_tokens++].enabled = status; + snmp_log(LOG_NOTICE, "registered debug token %s, %d\n", cp, status); + } else { + snmp_log(LOG_NOTICE, "Unable to register debug token %s\n", cp); + } + } else { + snmp_log(LOG_NOTICE, "Debug token %s over length\n", cp); + } + cp = strtok_r(NULL, DEBUG_TOKEN_DELIMITER, &st); + } + free(newp); +} + +/* + * Print all registered tokens along with their current status + */ +void +debug_print_registered_tokens(void) { + int i; + + snmp_log(LOG_INFO, "%d tokens registered :\n", debug_num_tokens); + for (i=0; i<debug_num_tokens; i++) { + snmp_log( LOG_INFO, "%d) %s : %d\n", + i, dbg_tokens [i].token_name, dbg_tokens [i].enabled); + } +} + + +/* + * Enable logs on a given token + */ +int +debug_enable_token_logs (const char *token) { + int i; + + /* debugging flag is on or off */ + if (!dodebug) + return SNMPERR_GENERR; + + if (debug_num_tokens == 0 || debug_print_everything) { + /* no tokens specified, print everything */ + return SNMPERR_SUCCESS; + } else { + for(i=0; i < debug_num_tokens; i++) { + if (dbg_tokens[i].token_name && + strncmp(dbg_tokens[i].token_name, token, + strlen(dbg_tokens[i].token_name)) == 0) { + dbg_tokens[i].enabled = SNMP_DEBUG_ACTIVE; + return SNMPERR_SUCCESS; + } + } + } + return SNMPERR_GENERR; +} + +/* + * Diable logs on a given token + */ +int +debug_disable_token_logs (const char *token) { + int i; + + /* debugging flag is on or off */ + if (!dodebug) + return SNMPERR_GENERR; + + if (debug_num_tokens == 0 || debug_print_everything) { + /* no tokens specified, print everything */ + return SNMPERR_SUCCESS; + } else { + for(i=0; i < debug_num_tokens; i++) { + if (strncmp(dbg_tokens[i].token_name, token, + strlen(dbg_tokens[i].token_name)) == 0) { + dbg_tokens[i].enabled = SNMP_DEBUG_DISABLED; + return SNMPERR_SUCCESS; + } + } + } + return SNMPERR_GENERR; +} + +/* + * debug_is_token_registered(char *TOKEN): + * + * returns SNMPERR_SUCCESS + * or SNMPERR_GENERR + * + * if TOKEN has been registered and debugging support is turned on. + */ +int +debug_is_token_registered(const char *token) +{ + int i, rc; + + /* + * debugging flag is on or off + */ + if (!dodebug) + return SNMPERR_GENERR; + + if (debug_num_tokens == 0 || debug_print_everything) { + /* + * no tokens specified, print everything + */ + return SNMPERR_SUCCESS; + } + else + rc = SNMPERR_GENERR; /* ! found = err */ + + for (i = 0; i < debug_num_tokens; i++) { + if (SNMP_DEBUG_DISABLED == dbg_tokens[i].enabled) + continue; + if (dbg_tokens[i].token_name && + strncmp(dbg_tokens[i].token_name, token, + strlen(dbg_tokens[i].token_name)) == 0) { + if (SNMP_DEBUG_ACTIVE == dbg_tokens[i].enabled) + return SNMPERR_SUCCESS; /* active */ + else + return SNMPERR_GENERR; /* excluded */ + } + } + return rc; +} + +void +debugmsg(const char *token, const char *format, ...) +{ + if (debug_is_token_registered(token) == SNMPERR_SUCCESS) { + va_list debugargs; + + va_start(debugargs, format); + snmp_vlog(LOG_DEBUG, format, debugargs); + va_end(debugargs); + } +} + +void +debugmsg_oid(const char *token, const oid * theoid, size_t len) +{ + u_char *buf = NULL; + size_t buf_len = 0, out_len = 0; + + if (sprint_realloc_objid(&buf, &buf_len, &out_len, 1, theoid, len)) { + if (buf != NULL) { + debugmsg(token, "%s", buf); + } + } else { + if (buf != NULL) { + debugmsg(token, "%s [TRUNCATED]", buf); + } + } + + if (buf != NULL) { + free(buf); + } +} + +void +debugmsg_suboid(const char *token, const oid * theoid, size_t len) +{ + u_char *buf = NULL; + size_t buf_len = 0, out_len = 0; + int buf_overflow = 0; + + netsnmp_sprint_realloc_objid(&buf, &buf_len, &out_len, 1, + &buf_overflow, theoid, len); + if(buf_overflow) { + if (buf != NULL) { + debugmsg(token, "%s [TRUNCATED]", buf); + } + } else { + if (buf != NULL) { + debugmsg(token, "%s", buf); + } + } + + if (buf != NULL) { + free(buf); + } +} + +void +debugmsg_var(const char *token, netsnmp_variable_list * var) +{ + u_char *buf = NULL; + size_t buf_len = 0, out_len = 0; + + if (var == NULL || token == NULL) { + return; + } + + if (sprint_realloc_variable(&buf, &buf_len, &out_len, 1, + var->name, var->name_length, var)) { + if (buf != NULL) { + debugmsg(token, "%s", buf); + } + } else { + if (buf != NULL) { + debugmsg(token, "%s [TRUNCATED]", buf); + } + } + + if (buf != NULL) { + free(buf); + } +} + +void +debugmsg_oidrange(const char *token, const oid * theoid, size_t len, + size_t var_subid, oid range_ubound) +{ + u_char *buf = NULL; + size_t buf_len = 0, out_len = 0, i = 0; + int rc = 0; + + if (var_subid == 0) { + rc = sprint_realloc_objid(&buf, &buf_len, &out_len, 1, theoid, + len); + } else { + char tmpbuf[128]; + /* XXX - ? check for 0 == var_subid -1 ? */ + rc = sprint_realloc_objid(&buf, &buf_len, &out_len, 1, theoid, + var_subid-1); /* Adjust for C's 0-based array indexing */ + if (rc) { + sprintf(tmpbuf, ".%" NETSNMP_PRIo "u--%" NETSNMP_PRIo "u", + theoid[var_subid - 1], range_ubound); + rc = snmp_cstrcat(&buf, &buf_len, &out_len, 1, tmpbuf); + if (rc) { + for (i = var_subid; i < len; i++) { + sprintf(tmpbuf, ".%" NETSNMP_PRIo "u", theoid[i]); + if (!snmp_cstrcat(&buf, &buf_len, &out_len, 1, tmpbuf)) { + break; + } + } + } + } + } + + + if (buf != NULL) { + debugmsg(token, "%s%s", buf, rc ? "" : " [TRUNCATED]"); + free(buf); + } +} + +void +debugmsg_hex(const char *token, const u_char * thedata, size_t len) +{ + u_char *buf = NULL; + size_t buf_len = 0, out_len = 0; + + if (sprint_realloc_hexstring + (&buf, &buf_len, &out_len, 1, thedata, len)) { + if (buf != NULL) { + debugmsg(token, "%s", buf); + } + } else { + if (buf != NULL) { + debugmsg(token, "%s [TRUNCATED]", buf); + } + } + + if (buf != NULL) { + free(buf); + } +} + +void +debugmsg_hextli(const char *token, const u_char * thedata, size_t len) +{ + char buf[SPRINT_MAX_LEN], token2[SPRINT_MAX_LEN]; + u_char *b3 = NULL; + size_t b3_len = 0, o3_len = 0; + int incr; + sprintf(token2, "dumpx_%s", token); + + /* + * XX tracing lines removed from this function DEBUGTRACE; + */ + DEBUGIF(token2) { + for (incr = 16; len > 0; len -= incr, thedata += incr) { + if ((int) len < incr) { + incr = len; + } + /* + * XXnext two lines were DEBUGPRINTINDENT(token); + */ + sprintf(buf, "dumpx%s", token); + debugmsg(buf, "%s: %*s", token2, debug_indent_get(), ""); + if (sprint_realloc_hexstring + (&b3, &b3_len, &o3_len, 1, thedata, incr)) { + if (b3 != NULL) { + debugmsg(token2, "%s", b3); + } + } else { + if (b3 != NULL) { + debugmsg(token2, "%s [TRUNCATED]", b3); + } + } + o3_len = 0; + } + } + if (b3 != NULL) { + free(b3); + } +} + +void +debugmsgtoken(const char *token, const char *format, ...) +{ + va_list debugargs; + + va_start(debugargs, format); + debugmsg(token, "%s: ", token); + va_end(debugargs); +} + +void +debug_combo_nc(const char *token, const char *format, ...) +{ + va_list debugargs; + + va_start(debugargs, format); + snmp_log(LOG_DEBUG, "%s: ", token); + snmp_vlog(LOG_DEBUG, format, debugargs); + va_end(debugargs); +} + +/* + * for speed, these shouldn't be in default_storage space + */ +void +snmp_set_do_debugging(int val) +{ + dodebug = val; +} + +int +snmp_get_do_debugging(void) +{ + return dodebug; +} + +#else /* ! NETSNMP_NO_DEBUGGING */ + +#if __GNUC__ > 2 +#define UNUSED __attribute__((unused)) +#else +#define UNUSED +#endif + +int debug_indent_get(void) { return 0; } + +const char* debug_indent(void) { return ""; } + +void debug_indent_add(int amount UNUSED) { } + +NETSNMP_IMPORT void +debug_config_register_tokens(const char *configtoken, char *tokens); + +void +debug_config_register_tokens(const char *configtoken UNUSED, + char *tokens UNUSED) +{ } + +NETSNMP_IMPORT void +debug_config_turn_on_debugging(const char *configtoken, char *line); + +void +debug_config_turn_on_debugging(const char *configtoken UNUSED, + char *line UNUSED) +{ } + +void +debug_register_tokens(const char *tokens UNUSED) +{ } + +void +debug_print_registered_tokens(void) +{ } + + +int +debug_enable_token_logs (const char *token UNUSED) +{ return SNMPERR_GENERR; } + +int +debug_disable_token_logs (const char *token UNUSED) +{ return SNMPERR_GENERR; } + +int +debug_is_token_registered(const char *token UNUSED) +{ return SNMPERR_GENERR; } + +void +debugmsg(const char *token UNUSED, const char *format UNUSED, ...) +{ } + +void +debugmsg_oid(const char *token UNUSED, const oid * theoid UNUSED, + size_t len UNUSED) +{ } + +void +debugmsg_suboid(const char *token UNUSED, const oid * theoid UNUSED, + size_t len UNUSED) +{ } + +void +debugmsg_var(const char *token UNUSED, netsnmp_variable_list * var UNUSED) +{ } + +void +debugmsg_oidrange(const char *token UNUSED, const oid * theoid UNUSED, + size_t len UNUSED, size_t var_subid UNUSED, + oid range_ubound UNUSED) +{ } + +void +debugmsg_hex(const char *token UNUSED, const u_char * thedata UNUSED, + size_t len UNUSED) +{ } + +void +debugmsg_hextli(const char *token UNUSED, const u_char * thedata UNUSED, + size_t len UNUSED) +{ } + +void +debugmsgtoken(const char *token UNUSED, const char *format UNUSED, ...) +{ } + +void +debug_combo_nc(const char *token UNUSED, const char *format UNUSED, ...) +{ } + +void +snmp_set_do_debugging(int val UNUSED) +{ } + +int +snmp_get_do_debugging(void) +{ + return 0; +} + +#endif /* NETSNMP_NO_DEBUGGING */ + +void +snmp_debug_init(void) +{ + register_prenetsnmp_mib_handler("snmp", "doDebugging", + debug_config_turn_on_debugging, NULL, + "(1|0)"); + register_prenetsnmp_mib_handler("snmp", "debugTokens", + debug_config_register_tokens, NULL, + "token[,token...]"); +} |