coap_debug.h

Go to the documentation of this file.

/*
 * coap_debug.h -- debug utilities
 *
 * Copyright (C) 2010-2011,2014-2025 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.
 */
 
#ifndef COAP_DEBUG_H_
#define COAP_DEBUG_H_
 
#include "coap_pdu.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef COAP_DEBUG_FD
#define COAP_DEBUG_FD stdout
#endif
 
#ifndef COAP_ERR_FD
#define COAP_ERR_FD stderr
#endif
 
#ifndef COAP_MAX_LOGGING_LEVEL
#define COAP_MAX_LOGGING_LEVEL 8
#endif /* ! COAP_MAX_LOGGING_LEVEL */
 
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 */
 
coap_log_t coap_get_log_level(void);
 
void coap_set_log_level(coap_log_t level);
 
void coap_dtls_set_log_level(coap_log_t level);
 
coap_log_t coap_dtls_get_log_level(void);
 
const char *coap_log_level_desc(coap_log_t level);
 
typedef void (*coap_log_handler_t)(coap_log_t level, const char *message);
 
void coap_set_log_handler(coap_log_handler_t handler);
 
const char *coap_package_name(void);
 
const char *coap_package_version(void);
 
const char *coap_package_build(void);
 
#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 */
#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
#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
 
void coap_set_show_pdu_output(int use_fprintf);
 
void coap_enable_pdu_data_output(int enable_data);
 
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu);
 
void coap_show_tls_version(coap_log_t level);
 
char *coap_string_tls_version(char *buffer, size_t bufsize);
 
char *coap_string_tls_support(char *buffer, size_t bufsize);
 
size_t coap_print_addr(const coap_address_t *address,
                       unsigned char *buffer, size_t size);
 
const char *coap_print_ip_addr(const coap_address_t *address,
                               char *buffer, size_t size);
 
int coap_debug_set_packet_loss(const char *loss_level);
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_DEBUG_H_ */