1 /* debug.h -- debug utilities
2 *
3 * Copyright (C) 2011--2012 Olaf Bergmann <bergmann@tzi.org>
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without
8 * restriction, including without limitation the rights to use, copy,
9 * modify, merge, publish, distribute, sublicense, and/or sell copies
10 * of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 #ifndef _DTLS_DEBUG_H_
27 #define _DTLS_DEBUG_H_
28
29 #include <stdlib.h>
30
31 #include "dtls_config.h"
32 #include "global.h"
33 #include "session.h"
34
35 #ifdef WITH_CONTIKI
36 # ifndef DEBUG
37 # define DEBUG DEBUG_PRINT
38 # endif /* DEBUG */
39 #include "net/ip/uip-debug.h"
40
41 #ifdef CONTIKI_TARGET_MBXXX
42 extern char __Stack_Init, _estack;
43
check_stack()44 static inline void check_stack() {
45 const char *p = &__Stack_Init;
46 while (p < &_estack && *p == 0x38) {
47 p++;
48 }
49
50 PRINTF("Stack: %d bytes used (%d free)\n", &_estack - p, p - &__Stack_Init);
51 }
52 #else /* CONTIKI_TARGET_MBXXX */
check_stack()53 static inline void check_stack() {
54 }
55 #endif /* CONTIKI_TARGET_MBXXX */
56 #else /* WITH_CONTKI */
57 #define PRINTF(...)
58
check_stack()59 static inline void check_stack() {
60 }
61 #endif
62
63 struct __session_t;
64
65 /** Pre-defined log levels akin to what is used in \b syslog. */
66 typedef enum { DTLS_LOG_EMERG=0, DTLS_LOG_ALERT, DTLS_LOG_CRIT, DTLS_LOG_WARN,
67 DTLS_LOG_NOTICE, DTLS_LOG_INFO, DTLS_LOG_DEBUG
68 } log_t;
69
70 /** Returns a zero-terminated string with the name of this library. */
71 const char *dtls_package_name();
72
73 /** Returns a zero-terminated string with the library version. */
74 const char *dtls_package_version();
75
76 #ifndef NDEBUG
77 /** Returns the current log level. */
78 log_t dtls_get_log_level();
79
80 /** Sets the log level to the specified value. */
81 void dtls_set_log_level(log_t level);
82
83 /**
84 * Writes the given text to \c stdout. The text is output only when \p
85 * level is below or equal to the log level that set by
86 * set_log_level(). */
87 #ifdef HAVE_VPRINTF
88 void dsrv_log(log_t level, char *format, ...);
89 #else
90 #define dsrv_log(level, format, ...) PRINTF(format, ##__VA_ARGS__)
91 #endif
92
93 /** dumps packets in usual hexdump format */
94 void hexdump(const unsigned char *packet, int length);
95
96 /** dump as narrow string of hex digits */
97 void dump(unsigned char *buf, size_t len);
98
99 void dtls_dsrv_hexdump_log(log_t level, const char *name, const unsigned char *buf, size_t length, int extend);
100
101 void dtls_dsrv_log_addr(log_t level, const char *name, const session_t *addr);
102
103 #else /* NDEBUG */
104
dtls_get_log_level()105 static inline log_t dtls_get_log_level()
106 {
107 return DTLS_LOG_EMERG;
108 }
109
dtls_set_log_level(log_t level)110 static inline void dtls_set_log_level(log_t level)
111 {}
112
dsrv_log(log_t level,char * format,...)113 static inline void dsrv_log(log_t level, char *format, ...)
114 {}
115
hexdump(const unsigned char * packet,int length)116 static inline void hexdump(const unsigned char *packet, int length)
117 {}
118
dump(unsigned char * buf,size_t len)119 static inline void dump(unsigned char *buf, size_t len)
120 {}
121
122 static inline void
dtls_dsrv_hexdump_log(log_t level,const char * name,const unsigned char * buf,size_t length,int extend)123 dtls_dsrv_hexdump_log(log_t level, const char *name, const unsigned char *buf, size_t length, int extend)
124 {}
125
126 static inline void
dtls_dsrv_log_addr(log_t level,const char * name,const struct __session_t * addr)127 dtls_dsrv_log_addr(log_t level, const char *name, const struct __session_t *addr)
128 {}
129
130 #endif /* NDEBUG */
131
132 /* A set of convenience macros for common log levels. */
133 #define dtls_emerg(...) dsrv_log(DTLS_LOG_EMERG, __VA_ARGS__)
134 #define dtls_alert(...) dsrv_log(DTLS_LOG_ALERT, __VA_ARGS__)
135 #define dtls_crit(...) dsrv_log(DTLS_LOG_CRIT, __VA_ARGS__)
136 #define dtls_warn(...) dsrv_log(DTLS_LOG_WARN, __VA_ARGS__)
137 #define dtls_notice(...) dsrv_log(DTLS_LOG_NOTICE, __VA_ARGS__)
138 #define dtls_info(...) dsrv_log(DTLS_LOG_INFO, __VA_ARGS__)
139 #define dtls_debug(...) dsrv_log(DTLS_LOG_DEBUG, __VA_ARGS__)
140 #define dtls_debug_hexdump(name, buf, length) dtls_dsrv_hexdump_log(DTLS_LOG_DEBUG, name, buf, length, 1)
141 #define dtls_debug_dump(name, buf, length) dtls_dsrv_hexdump_log(DTLS_LOG_DEBUG, name, buf, length, 0)
142
143 #endif /* _DTLS_DEBUG_H_ */
144
