release/src/router/snmp/snmplib/snmp_debug.c

   1 #include <net-snmp/net-snmp-config.h>
   2
   3 #include <stdio.h>
   4 #if HAVE_STDLIB_H
   5 #include <stdlib.h>
   6 #endif
   7 #if HAVE_STRING_H
   8 #include <string.h>
   9 #else
  10 #include <strings.h>
  11 #endif
  12 #include <sys/types.h>
  13 #if HAVE_NETINET_IN_H
  14 #include <netinet/in.h>
  15 #endif
  16 #if HAVE_STDARG_H
  17 #include <stdarg.h>
  18 #else
  19 #include <varargs.h>
  20 #endif
  21 #if HAVE_WINSOCK_H
  22 #include <winsock.h>
  23 #endif
  24
  25 #if HAVE_DMALLOC_H
  26 #include <dmalloc.h>
  27 #endif
  28
  29 #include <net-snmp/types.h>
  30 #include <net-snmp/output_api.h>
  31 #include <net-snmp/library/snmp_debug.h>        /* For this file's "internal" definitions */
  32 #include <net-snmp/config_api.h>
  33 #include <net-snmp/utilities.h>
  34
  35 #include <net-snmp/library/mib.h>
  36 #include <net-snmp/library/snmp_api.h>
  37
  38 static int      dodebug = SNMP_ALWAYS_DEBUG;
  39 static int      debug_num_tokens = 0;
  40 static char    *debug_tokens[MAX_DEBUG_TOKENS];
  41 static int      debug_print_everything = 0;
  42
  43 /*
  44  * indent debugging:  provide a space padded section to return an indent for
  45  */
  46 static int      debugindent = 0;
  47 #define INDENTMAX 80
  48 static char     debugindentchars[] =
  49     "                                                                                ";
  50
  51 /*
  52  * Prototype definitions
  53  */
  54 void            debug_config_register_tokens(const char *configtoken,
  55                                              char *tokens);
  56 void            debug_config_turn_on_debugging(const char *configtoken,
  57                                                char *line);
  58
  59 char           *
  60 debug_indent(void)
  61 {
  62     return debugindentchars;
  63 }
  64
  65 void
  66 debug_indent_add(int amount)
  67 {
  68     if (debugindent + amount >= 0 && debugindent + amount < 80) {
  69         debugindentchars[debugindent] = ' ';
  70         debugindent += amount;
  71         debugindentchars[debugindent] = '\0';
  72     }
  73 }
  74
  75 void
  76 debug_config_register_tokens(const char *configtoken, char *tokens)
  77 {
  78     debug_register_tokens(tokens);
  79 }
  80
  81 void
  82 debug_config_turn_on_debugging(const char *configtoken, char *line)
  83 {
  84     snmp_set_do_debugging(atoi(line));
  85 }
  86
  87 void
  88 snmp_debug_init(void)
  89 {
  90     debugindentchars[0] = '\0'; /* zero out the debugging indent array. */
  91     register_prenetsnmp_mib_handler("snmp", "doDebugging",
  92                                     debug_config_turn_on_debugging, NULL,
  93                                     "(1|0)");
  94     register_prenetsnmp_mib_handler("snmp", "debugTokens",
  95                                     debug_config_register_tokens, NULL,
  96                                     "token[,token...]");
  97 }
  98
  99 void
 100 debug_register_tokens(char *tokens)
 101 {
 102     char           *newp, *cp;
 103
 104     if (tokens == 0 || *tokens == 0)
 105         return;
 106
 107     newp = strdup(tokens);      /* strtok messes it up */
 108     cp = strtok(newp, DEBUG_TOKEN_DELIMITER);
 109     while (cp) {
 110         if (strlen(cp) < MAX_DEBUG_TOKEN_LEN) {
 111             if (strcasecmp(cp, DEBUG_ALWAYS_TOKEN) == 0)
 112                 debug_print_everything = 1;
 113             else if (debug_num_tokens < MAX_DEBUG_TOKENS)
 114                 debug_tokens[debug_num_tokens++] = strdup(cp);
 115         }
 116         cp = strtok(NULL, DEBUG_TOKEN_DELIMITER);
 117     }
 118     free(newp);
 119 }
 120
 121
 122 /*
 123  * debug_is_token_registered(char *TOKEN):
 124  *
 125  * returns SNMPERR_SUCCESS
 126  * or SNMPERR_GENERR
 127  *
 128  * if TOKEN has been registered and debugging support is turned on.
 129  */
 130 int
 131 debug_is_token_registered(const char *token)
 132 {
 133     int             i;
 134
 135     /*
 136      * debugging flag is on or off
 137      */
 138     if (!dodebug)
 139         return SNMPERR_GENERR;
 140
 141     if (debug_num_tokens == 0 || debug_print_everything) {
 142         /*
 143          * no tokens specified, print everything
 144          */
 145         return SNMPERR_SUCCESS;
 146     } else {
 147         for (i = 0; i < debug_num_tokens; i++) {
 148             if (strncmp(debug_tokens[i], token, strlen(debug_tokens[i])) ==
 149                 0) {
 150                 return SNMPERR_SUCCESS;
 151             }
 152         }
 153     }
 154     return SNMPERR_GENERR;
 155 }
 156
 157 void
 158 #if HAVE_STDARG_H
 159 debugmsg(const char *token, const char *format, ...)
 160 #else
 161 debugmsg(va_alist)
 162      va_dcl
 163 #endif
 164 {
 165     va_list         debugargs;
 166
 167 #if HAVE_STDARG_H
 168     va_start(debugargs, format);
 169 #else
 170     const char     *format;
 171     const char     *token;
 172
 173     va_start(debugargs);
 174     token = va_arg(debugargs, const char *);
 175     format = va_arg(debugargs, const char *);   /* ??? */
 176 #endif
 177
 178     if (debug_is_token_registered(token) == SNMPERR_SUCCESS) {
 179         snmp_vlog(LOG_DEBUG, format, debugargs);
 180     }
 181     va_end(debugargs);
 182 }
 183
 184 void
 185 debugmsg_oid(const char *token, const oid * theoid, size_t len)
 186 {
 187     u_char         *buf = NULL;
 188     size_t          buf_len = 0, out_len = 0;
 189
 190     if (sprint_realloc_objid(&buf, &buf_len, &out_len, 1, theoid, len)) {
 191         if (buf != NULL) {
 192             debugmsg(token, "%s", buf);
 193         }
 194     } else {
 195         if (buf != NULL) {
 196             debugmsg(token, "%s [TRUNCATED]", buf);
 197         }
 198     }
 199
 200     if (buf != NULL) {
 201         free(buf);
 202     }
 203 }
 204
 205 void
 206 debugmsg_var(const char *token, netsnmp_variable_list * var)
 207 {
 208     u_char         *buf = NULL;
 209     size_t          buf_len = 0, out_len = 0;
 210
 211     if (var == NULL || token == NULL) {
 212         return;
 213     }
 214
 215     if (sprint_realloc_variable(&buf, &buf_len, &out_len, 1,
 216                                 var->name, var->name_length, var)) {
 217         if (buf != NULL) {
 218             debugmsg(token, "%s", buf);
 219         }
 220     } else {
 221         if (buf != NULL) {
 222             debugmsg(token, "%s [TRUNCATED]", buf);
 223         }
 224     }
 225
 226     if (buf != NULL) {
 227         free(buf);
 228     }
 229 }
 230
 231 void
 232 debugmsg_oidrange(const char *token, const oid * theoid, size_t len,
 233                   size_t var_subid, oid range_ubound)
 234 {
 235     u_char         *buf = NULL;
 236     size_t          buf_len = 0, out_len = 0, i = 0;
 237     int             rc = 0;
 238
 239     if (var_subid == 0) {
 240         rc = sprint_realloc_objid(&buf, &buf_len, &out_len, 1, theoid,
 241                                   len);
 242     } else {
 243         char            tmpbuf[128];
 244         rc = sprint_realloc_objid(&buf, &buf_len, &out_len, 1, theoid,
 245                                   var_subid);
 246         if (rc) {
 247             sprintf(tmpbuf, ".%lu--%lu", theoid[var_subid - 1],
 248                     range_ubound);
 249             rc = snmp_strcat(&buf, &buf_len, &out_len, 1, tmpbuf);
 250             if (rc) {
 251                 for (i = var_subid; i < len; i++) {
 252                     sprintf(tmpbuf, ".%lu", theoid[i]);
 253                     if (!snmp_strcat(&buf, &buf_len, &out_len, 1, tmpbuf)) {
 254                         break;
 255                     }
 256                 }
 257             }
 258         }
 259     }
 260
 261
 262     if (buf != NULL) {
 263         debugmsg(token, "%s%s", buf, rc ? "" : " [TRUNCATED]");
 264         free(buf);
 265     }
 266 }
 267
 268 void
 269 debugmsg_hex(const char *token, u_char * thedata, size_t len)
 270 {
 271     u_char         *buf = NULL;
 272     size_t          buf_len = 0, out_len = 0;
 273
 274     if (sprint_realloc_hexstring
 275         (&buf, &buf_len, &out_len, 1, thedata, len)) {
 276         if (buf != NULL) {
 277             debugmsg(token, "%s", buf);
 278         }
 279     } else {
 280         if (buf != NULL) {
 281             debugmsg(token, "%s [TRUNCATED]", buf);
 282         }
 283     }
 284
 285     if (buf != NULL) {
 286         free(buf);
 287     }
 288 }
 289
 290 void
 291 debugmsg_hextli(const char *token, u_char * thedata, size_t len)
 292 {
 293     char            buf[SPRINT_MAX_LEN], token2[SPRINT_MAX_LEN];
 294     u_char         *b3 = NULL;
 295     size_t          b3_len = 0, o3_len = 0;
 296     int             incr;
 297     sprintf(token2, "dumpx_%s", token);
 298
 299     /*
 300      * XX tracing lines removed from this function DEBUGTRACE;
 301      */
 302     DEBUGIF(token2) {
 303         for (incr = 16; len > 0; len -= incr, thedata += incr) {
 304             if ((int) len < incr) {
 305                 incr = len;
 306             }
 307             /*
 308              * XXnext two lines were DEBUGPRINTINDENT(token);
 309              */
 310             sprintf(buf, "dumpx%s", token);
 311             debugmsg(buf, "%s: %s", token2, debug_indent());
 312             if (sprint_realloc_hexstring
 313                 (&b3, &b3_len, &o3_len, 1, thedata, incr)) {
 314                 if (b3 != NULL) {
 315                     debugmsg(token2, "%s", b3);
 316                 }
 317             } else {
 318                 if (b3 != NULL) {
 319                     debugmsg(token2, "%s [TRUNCATED]", b3);
 320                 }
 321             }
 322             o3_len = 0;
 323         }
 324     }
 325     if (b3 != NULL) {
 326         free(b3);
 327     }
 328 }
 329
 330 void
 331 #if HAVE_STDARG_H
 332 debugmsgtoken(const char *token, const char *format, ...)
 333 #else
 334 debugmsgtoken(va_alist)
 335      va_dcl
 336 #endif
 337 {
 338     va_list         debugargs;
 339
 340 #if HAVE_STDARG_H
 341     va_start(debugargs, format);
 342 #else
 343     const char     *token;
 344
 345     va_start(debugargs);
 346     token = va_arg(debugargs, const char *);
 347 #endif
 348
 349     debugmsg(token, "%s: ", token);
 350
 351     va_end(debugargs);
 352 }
 353
 354 /*
 355  * for speed, these shouldn't be in default_storage space
 356  */
 357 void
 358 snmp_set_do_debugging(int val)
 359 {
 360     dodebug = val;
 361 }
 362
 363 int
 364 snmp_get_do_debugging(void)
 365 {
 366     return dodebug;
 367 }