mirror of
https://github.com/obgm/libcoap.git
synced 2026-10-29 22:15:49 +03:00
Jon Shallow
21b7a9a0eb
This is similar to coap_debug_set_packet_loss() which drops packets that are to be sent, but emulates network reported errors by reporting ECONNREFUSED.
431 lines
11 KiB
C
431 lines
11 KiB
C
/*
|
|
* coap_debug.h -- debug utilities
|
|
*
|
|
* Copyright (C) 2010-2011,2014-2026 Olaf Bergmann <bergmann@tzi.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*
|
|
* This file is part of the CoAP library libcoap. Please see README for terms
|
|
* of use.
|
|
*/
|
|
|
|
/**
|
|
* @file coap_debug.h
|
|
* @brief CoAP Logging support
|
|
*/
|
|
|
|
#ifndef COAP_DEBUG_H_
|
|
#define COAP_DEBUG_H_
|
|
|
|
/**
|
|
* @ingroup application_api
|
|
* @defgroup logging Logging Support
|
|
* API for logging support
|
|
* @{
|
|
*/
|
|
|
|
#include "coap_pdu.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef COAP_DEBUG_FD
|
|
/**
|
|
* Used for output for @c COAP_LOG_OSCORE to @c COAP_LOG_ERR.
|
|
*/
|
|
#define COAP_DEBUG_FD stdout
|
|
#endif
|
|
|
|
#ifndef COAP_ERR_FD
|
|
/**
|
|
* Used for output for @c COAP_LOG_CRIT to @c COAP_LOG_EMERG.
|
|
*/
|
|
#define COAP_ERR_FD stderr
|
|
#endif
|
|
|
|
#ifndef COAP_MAX_LOGGING_LEVEL
|
|
#define COAP_MAX_LOGGING_LEVEL 8
|
|
#endif /* ! COAP_MAX_LOGGING_LEVEL */
|
|
|
|
/**
|
|
* Logging type. These should be used where possible in the code instead
|
|
* of the syslog definitions, or alternatively use the coap_log_*() functions
|
|
* to reduce line length.
|
|
*/
|
|
typedef enum {
|
|
COAP_LOG_EMERG = 0, /* 0 */
|
|
COAP_LOG_ALERT, /* 1 */
|
|
COAP_LOG_CRIT, /* 2 */
|
|
COAP_LOG_ERR, /* 3 */
|
|
COAP_LOG_WARN, /* 4 */
|
|
COAP_LOG_NOTICE, /* 5 */
|
|
COAP_LOG_INFO, /* 6 */
|
|
COAP_LOG_DEBUG, /* 7 */
|
|
COAP_LOG_OSCORE, /* 8 */
|
|
COAP_LOG_DTLS_BASE,
|
|
#define COAP_LOG_CIPHERS COAP_LOG_DTLS_BASE /* For backward compatability */
|
|
} coap_log_t;
|
|
|
|
/*
|
|
* These have the same values, but can be used in #if tests for better
|
|
* readability
|
|
*/
|
|
#define _COAP_LOG_EMERG 0
|
|
#define _COAP_LOG_ALERT 1
|
|
#define _COAP_LOG_CRIT 2
|
|
#define _COAP_LOG_ERR 3
|
|
#define _COAP_LOG_WARN 4
|
|
#define _COAP_LOG_NOTICE 5
|
|
#define _COAP_LOG_INFO 6
|
|
#define _COAP_LOG_DEBUG 7
|
|
#define _COAP_LOG_OSCORE 8
|
|
|
|
COAP_STATIC_INLINE void
|
|
coap_no_log(void) { }
|
|
|
|
#define coap_log_emerg(...) coap_log(COAP_LOG_EMERG, __VA_ARGS__)
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_ALERT)
|
|
#define coap_log_alert(...) coap_log(COAP_LOG_ALERT, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_alert(...) coap_no_log()
|
|
#endif
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_CRIT)
|
|
#define coap_log_crit(...) coap_log(COAP_LOG_CRIT, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_crit(...) coap_no_log()
|
|
#endif
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_ERR)
|
|
#define coap_log_err(...) coap_log(COAP_LOG_ERR, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_err(...) coap_no_log()
|
|
#endif
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_WARN)
|
|
#define coap_log_warn(...) coap_log(COAP_LOG_WARN, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_warn(...) coap_no_log()
|
|
#endif
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_INFO)
|
|
#define coap_log_info(...) coap_log(COAP_LOG_INFO, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_info(...) coap_no_log()
|
|
#endif
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_NOTICE)
|
|
#define coap_log_notice(...) coap_log(COAP_LOG_NOTICE, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_notice(...) coap_no_log()
|
|
#endif
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG)
|
|
#define coap_log_debug(...) coap_log(COAP_LOG_DEBUG, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_debug(...) coap_no_log()
|
|
#endif
|
|
|
|
#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_OSCORE)
|
|
#define coap_log_oscore(...) coap_log(COAP_LOG_OSCORE, __VA_ARGS__)
|
|
#else
|
|
#define coap_log_oscore(...) coap_no_log()
|
|
#endif
|
|
|
|
/*
|
|
* These entries are left here for backward compatability in applications
|
|
* (which should really "#include <syslog.h>").
|
|
* and MUST NOT be used anywhere within the libcoap code.
|
|
*
|
|
* If clashes occur during a particilar OS port, they can be safely deleted.
|
|
*
|
|
* In a future update, they will get removed.
|
|
*/
|
|
#if !defined(RIOT_VERSION) && !defined(WITH_LWIP) && !defined(WITH_CONTIKI)
|
|
#ifndef LOG_EMERG
|
|
# define LOG_EMERG COAP_LOG_EMERG
|
|
#endif
|
|
#ifndef LOG_ALERT
|
|
# define LOG_ALERT COAP_LOG_ALERT
|
|
#endif
|
|
#ifndef LOG_CRIT
|
|
# define LOG_CRIT COAP_LOG_CRIT
|
|
#endif
|
|
#ifndef LOG_ERR
|
|
# define LOG_ERR COAP_LOG_ERR
|
|
#endif
|
|
#ifndef LOG_WARNING
|
|
# define LOG_WARNING COAP_LOG_WARN
|
|
#endif
|
|
#ifndef LOG_NOTICE
|
|
# define LOG_NOTICE COAP_LOG_NOTICE
|
|
#endif
|
|
#ifndef LOG_INFO
|
|
# define LOG_INFO COAP_LOG_INFO
|
|
#endif
|
|
#ifndef LOG_DEBUG
|
|
# define LOG_DEBUG COAP_LOG_DEBUG
|
|
#endif
|
|
#endif /* ! RIOT_VERSION && ! WITH_LWIP && ! WITH_CONTIKI */
|
|
|
|
/**
|
|
* Get the current logging level.
|
|
*
|
|
* @return One of the COAP_LOG_* values.
|
|
*/
|
|
coap_log_t coap_get_log_level(void);
|
|
|
|
/**
|
|
* Sets the log level to the specified value.
|
|
*
|
|
* @param level One of the COAP_LOG_* values.
|
|
*/
|
|
void coap_set_log_level(coap_log_t level);
|
|
|
|
/**
|
|
* Sets the (D)TLS logging level to the specified @p level.
|
|
*
|
|
* @param level One of the COAP_LOG_* values.
|
|
*/
|
|
void coap_dtls_set_log_level(coap_log_t level);
|
|
|
|
/**
|
|
* Get the current (D)TLS logging.
|
|
*
|
|
* @return One of the COAP_LOG_* values.
|
|
*/
|
|
coap_log_t coap_dtls_get_log_level(void);
|
|
|
|
/**
|
|
* Get the current logging description.
|
|
*
|
|
* @return Ascii representation of logging level.
|
|
*/
|
|
const char *coap_log_level_desc(coap_log_t level);
|
|
|
|
/**
|
|
* Logging callback handler definition.
|
|
*
|
|
* @param level One of the COAP_LOG_* values, or if used for (D)TLS logging,
|
|
* COAP_LOG_DTLS_BASE + one of the COAP_LOG_* values.
|
|
* @param message Zero-terminated string message to log.
|
|
*/
|
|
typedef void (*coap_log_handler_t)(coap_log_t level, const char *message);
|
|
|
|
/**
|
|
* Add a custom log callback handler.
|
|
*
|
|
* @param handler The logging handler to use or @p NULL to use default handler.
|
|
* This handler will be used for both CoAP and (D)TLS logging.
|
|
*/
|
|
void coap_set_log_handler(coap_log_handler_t handler);
|
|
|
|
/**
|
|
* Get the library package name.
|
|
*
|
|
* @return Zero-terminated string with the name of this library.
|
|
*/
|
|
const char *coap_package_name(void);
|
|
|
|
/**
|
|
* Get the library package version.
|
|
*
|
|
* @return Zero-terminated string with the library version.
|
|
*/
|
|
const char *coap_package_version(void);
|
|
|
|
/**
|
|
* Get the library package build.
|
|
*
|
|
* @return Zero-terminated string with the library build.
|
|
*/
|
|
const char *coap_package_build(void);
|
|
|
|
/**
|
|
* Writes the given text to @c COAP_ERR_FD (for @p level <= @c COAP_LOG_CRIT) or
|
|
* @c COAP_DEBUG_FD (for @p level >= @c COAP_LOG_ERR). The text is output only
|
|
* when @p level is below or equal to the log level that set by
|
|
* coap_set_log_level().
|
|
*
|
|
* Internal function.
|
|
*
|
|
* @param level One of the COAP_LOG_* values.
|
|
& @param format The format string to use.
|
|
*/
|
|
#if (defined(__GNUC__))
|
|
void coap_log_impl(coap_log_t level,
|
|
const char *format, ...) __attribute__((format(printf, 2, 3)));
|
|
#else
|
|
void coap_log_impl(coap_log_t level, const char *format, ...);
|
|
#endif
|
|
|
|
#ifndef coap_log
|
|
#ifdef WITH_CONTIKI
|
|
#include <stdio.h>
|
|
|
|
#ifndef LOG_CONF_LEVEL_COAP
|
|
#define LOG_CONF_LEVEL_COAP 0 /* = LOG_LEVEL_NONE */
|
|
#endif
|
|
|
|
void coap_print_contiki_prefix(coap_log_t level);
|
|
|
|
#define coap_log(level, ...) do { \
|
|
if (LOG_CONF_LEVEL_COAP && \
|
|
((int)((level)) <= (int)coap_get_log_level())) { \
|
|
coap_print_contiki_prefix(level); \
|
|
printf(__VA_ARGS__); \
|
|
} \
|
|
} while(0)
|
|
#else /* !WITH_CONTIKI */
|
|
/**
|
|
* Logging function.
|
|
* Writes the given text to @c COAP_ERR_FD (for @p level <= @c COAP_LOG_CRIT) or @c
|
|
* COAP_DEBUG_FD (for @p level >= @c COAP_LOG_ERR). The text is output only when
|
|
* @p level is below or equal to the log level that set by coap_set_log_level().
|
|
*
|
|
* @param level One of the COAP_LOG_* values.
|
|
*/
|
|
#define coap_log(level, ...) do { \
|
|
if ((level) < (coap_get_log_level() + 1)) \
|
|
coap_log_impl((level), __VA_ARGS__); \
|
|
} while(0)
|
|
#endif /* !WITH_CONTIKI */
|
|
#endif
|
|
|
|
#ifndef coap_dtls_log
|
|
/**
|
|
* Logging function.
|
|
* Writes the given text to @c COAP_ERR_FD (for @p level <= @c COAP_LOG_CRIT) or @c
|
|
* COAP_DEBUG_FD (for @p level >= @c COAP_LOG_ERR). The text is output only when
|
|
* @p level is below or equal to the log level that set by coap_dtls_set_log_level().
|
|
*
|
|
* @param level One of the COAP_LOG_* values.
|
|
*/
|
|
#define coap_dtls_log(level, ...) do { \
|
|
if ((int)((level))<=(int)coap_dtls_get_log_level()) \
|
|
coap_log_impl((level)+COAP_LOG_DTLS_BASE, __VA_ARGS__); \
|
|
} while(0)
|
|
#endif
|
|
|
|
/**
|
|
* Defines the output mode for the coap_show_pdu() function.
|
|
*
|
|
* @param use_fprintf @p 1 if the output is to use fprintf() (the default)
|
|
* @p 0 if the output is to use coap_log().
|
|
*/
|
|
void coap_set_show_pdu_output(int use_fprintf);
|
|
|
|
/**
|
|
* Defines whether the data is to be output or not for the
|
|
* coap_show_pdu() function.
|
|
*
|
|
* @param enable_data @p 1 if the data is to be output (the default)
|
|
* @p 0 if the data detail is not to be output.
|
|
*/
|
|
void coap_enable_pdu_data_output(int enable_data);
|
|
|
|
/**
|
|
* Display the contents of the specified @p pdu.
|
|
* Note: The output method of coap_show_pdu() is dependent on the setting of
|
|
* coap_set_show_pdu_output().
|
|
* Note: Data may, or may not be output depending on the setting of
|
|
* coap_enable_pdu_data_output().
|
|
*
|
|
* @param level The required minimum logging level.
|
|
* @param pdu The PDU to decode.
|
|
*/
|
|
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu);
|
|
|
|
/**
|
|
* Display the current (D)TLS library linked with and built for version.
|
|
*
|
|
* @param level The required minimum logging level.
|
|
*/
|
|
void coap_show_tls_version(coap_log_t level);
|
|
|
|
/**
|
|
* Build a string containing the current (D)TLS library linked with and
|
|
* built for version.
|
|
*
|
|
* @param buffer The buffer to put the string into.
|
|
* @param bufsize The size of the buffer to put the string into.
|
|
*
|
|
* @return A pointer to the provided buffer.
|
|
*/
|
|
char *coap_string_tls_version(char *buffer, size_t bufsize);
|
|
|
|
/**
|
|
* Build a string containing the current (D)TLS library support
|
|
*
|
|
* @param buffer The buffer to put the string into.
|
|
* @param bufsize The size of the buffer to put the string into.
|
|
*
|
|
* @return A pointer to the provided buffer.
|
|
*/
|
|
char *coap_string_tls_support(char *buffer, size_t bufsize);
|
|
|
|
/**
|
|
* Print the address into the defined buffer.
|
|
*
|
|
* @param address The address to print.
|
|
* @param buffer The buffer to print into.
|
|
* @param size The size of the buffer to print into.
|
|
*
|
|
* @return The amount written into the buffer.
|
|
*/
|
|
size_t coap_print_addr(const coap_address_t *address,
|
|
unsigned char *buffer, size_t size);
|
|
|
|
/**
|
|
* Print the IP address into the defined buffer.
|
|
*
|
|
* @param address The address to print.
|
|
* @param buffer The buffer to print into.
|
|
* @param size The size of the buffer to print into.
|
|
*
|
|
* @return The pointer to provided buffer with as much of the IP address added
|
|
* as possible.
|
|
*/
|
|
const char *coap_print_ip_addr(const coap_address_t *address,
|
|
char *buffer, size_t size);
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* Set the packet loss level for testing. This can be in one of two forms.
|
|
*
|
|
* Percentage : 0% to 100%. Use the specified probability.
|
|
* 0% is send all packets, 100% is drop all packets.
|
|
*
|
|
* List: A comma separated list of numbers or number ranges that are the
|
|
* packets to drop.
|
|
*
|
|
* @param loss_level The defined loss level (percentage or list).
|
|
*
|
|
* @return @c 1 If loss level set, @c 0 if there is an error.
|
|
*/
|
|
int coap_debug_set_packet_loss(const char *loss_level);
|
|
|
|
/**
|
|
* Set the packet transmit fail level for testing. This can be in one of two forms.
|
|
*
|
|
* Percentage : 0% to 100%. Use the specified probability.
|
|
* 0% is send all packets, 100% is fail all packets.
|
|
*
|
|
* List: A comma separated list of numbers or number ranges that are the
|
|
* packets to fail.
|
|
*
|
|
* @param fail_level The defined fail level (percentage or list).
|
|
*
|
|
* @return @c 1 If fail level set, @c 0 if there is an error.
|
|
*/
|
|
int coap_debug_set_packet_fail(const char *fail_level);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* COAP_DEBUG_H_ */
|