trace.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2015-2025 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit.
 */
 
#ifndef MICRO_OS_PLUS_DIAG_TRACE_H_
#define MICRO_OS_PLUS_DIAG_TRACE_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
#include <cstdint>
#include <cstddef>
#include <cstdarg>
#include <cstdlib>
#else
#include <stdint.h>
#include <stdarg.h>
#include <stdlib.h>
#endif // __cplusplus
 
#include <sys/types.h>
 
#if defined(__cplusplus)
 
// To be effective, <stdio.h> must be included *before* this patch.
#include <stdio.h>
 
// This is a very annoying issue, some very old libraries still
// define putchar() as a macro. This is abusive, since it prevents
// the use of putchar() in other name spaces.
#if defined(putchar)
#undef putchar
#endif // defined(putchar)
 
#endif // __cplusplus
 
// ----------------------------------------------------------------------------
 
#if defined(MICRO_OS_PLUS_TRACE) || defined(MICRO_OS_PLUS_TRACE_TESTING)
 
#if defined(MICRO_OS_PLUS_TRACE_TESTING)
#define MICRO_OS_PLUS_TRACE_NAME_TESTING(name) name##_testing
#else
#define MICRO_OS_PLUS_TRACE_NAME_TESTING(name) name
#endif
 
#if defined(__cplusplus)

#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpre-c++17-compat"
#endif
 
// For separation, use a separate naming space while testing.
namespace micro_os_plus::MICRO_OS_PLUS_TRACE_NAME_TESTING(trace)
 
#if defined(__clang__)
#pragma clang diagnostic pop
#endif
{
  // --------------------------------------------------------------------------

  void
  initialize (void);

  ssize_t
  write (const void* buf, std::size_t nbyte);

  void
  flush (void);
 
  // ------------------------------------------------------------------------

  int
  printf (const char* format, ...);

  int
  vprintf (const char* format, std::va_list arguments);

  int
  puts (const char* s = "");

  int
  putchar (int c);

  void
  dump_args (int argc, char* argv[], const char* name = "main");
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::trace
 
#endif // defined(__cplusplus)
 
#if defined(__cplusplus)
extern "C"
{
#endif // defined(__cplusplus)
 
  /*
   * Called from startup.
   */
  void
      MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_initialize) (void);

  ssize_t MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_write) (
      const void* buf, size_t nbyte);

  void MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_flush) (void);

  int MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_printf) (
      const char* format, ...);

  int MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_vprintf) (
      const char* format, va_list arguments);

  int MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_puts) (
      const char* s);

  int MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_putchar) (int c);

  void MICRO_OS_PLUS_TRACE_NAME_TESTING (micro_os_plus_trace_dump_args) (
      int argc, char* argv[]);
 
#if defined(__cplusplus)
}
#endif // defined(__cplusplus)
 
#endif /* defined(MICRO_OS_PLUS_TRACE) */
 
// When TRACE is not enabled, define empty definitions.
#if !defined(MICRO_OS_PLUS_TRACE)
 
#if defined(__cplusplus)
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wc++98-c++11-c++14-compat"
#endif
 
// The void definitions are always in the regular namespace.
namespace micro_os_plus::trace
{
  // ------------------------------------------------------------------------
 
  inline void
  initialize (void);
 
  inline ssize_t
  write (const void* buf, std::size_t nbyte);
 
  // ------------------------------------------------------------------------
 
  inline int
  printf (const char* format, ...);
 
  inline int
  vprintf (const char* format, std::va_list arguments);
 
  inline int
  puts (const char* s = "");
 
  inline int
  putchar (int c);
 
  inline void
  dump_args (int argc, char* argv[], const char* name = "main");
 
  // ------------------------------------------------------------------------
 
  inline __attribute__ ((always_inline)) void
  initialize (void)
  {
  }
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
 
  inline __attribute__ ((always_inline)) ssize_t
  write (const void* buf, std::size_t nbyte)
  {
    return static_cast<ssize_t> (nbyte);
  }
 
  inline __attribute__ ((always_inline)) void
  flush (void)
  {
  }
 
  inline __attribute__ ((always_inline)) int
  printf (const char* format, ...)
  {
    return 0;
  }
 
  inline __attribute__ ((always_inline)) int
  vprintf (const char* format, std::va_list arguments)
  {
    return 0;
  }
 
  inline __attribute__ ((always_inline)) int
  puts (const char* s)
  {
    return 0;
  }
 
  inline __attribute__ ((always_inline)) int
  putchar (int c)
  {
    return c;
  }
 
  inline __attribute__ ((always_inline)) void
  dump_args (int argc, char* argv[], const char* name)
  {
  }
 
#pragma GCC diagnostic pop
 
} // namespace micro_os_plus::trace
 
#pragma GCC diagnostic pop
 
#endif // defined(__cplusplus)
 
#if defined(__cplusplus)
extern "C"
{
#endif // defined(__cplusplus)
 
  // The void definitions are always in the regular namespace.
 
  inline void
  micro_os_plus_trace_initialize (void);
 
  // Implementation dependent
  inline ssize_t
  micro_os_plus_trace_write (const void* buf, size_t nbyte);
 
  inline void
  micro_os_plus_trace_flush (void);
 
  inline int
  micro_os_plus_trace_printf (const char* format, ...);
 
  inline int
  micro_os_plus_trace_vprintf (const char* format, va_list arguments);
 
  inline int
  micro_os_plus_trace_puts (const char* s);
 
  inline int
  micro_os_plus_trace_putchar (int c);
 
  inline void
  micro_os_plus_trace_dump_args (int argc, char* argv[]);
 
#if defined(__cplusplus)
}
#endif // defined(__cplusplus)
 
inline __attribute__ ((always_inline)) void
micro_os_plus_trace_initialize (void)
{
}
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
 
#pragma GCC diagnostic push
#if defined(__cplusplus)
#pragma GCC diagnostic ignored "-Wold-style-cast"
#endif // defined(__cplusplus)
 
inline __attribute__ ((always_inline)) ssize_t
micro_os_plus_trace_write (const void* buf, size_t nbyte)
{
  return (ssize_t)(nbyte);
}
 
inline __attribute__ ((always_inline)) void
micro_os_plus_trace_flush (void)
{
}
 
#pragma GCC diagnostic pop
 
inline __attribute__ ((always_inline)) int
micro_os_plus_trace_printf (const char* format, ...)
{
  return 0;
}
 
inline __attribute__ ((always_inline)) int
micro_os_plus_trace_vprintf (const char* format, va_list arguments)
{
  return 0;
}
 
inline __attribute__ ((always_inline)) int
micro_os_plus_trace_puts (const char* s)
{
  return 0;
}
 
inline __attribute__ ((always_inline)) int
micro_os_plus_trace_putchar (int c)
{
  return c;
}
 
inline __attribute__ ((always_inline)) void
micro_os_plus_trace_dump_args (int argc, char* argv[])
{
}
 
#pragma GCC diagnostic pop
 
#endif // defined(MICRO_OS_PLUS_TRACE)
 
// ----------------------------------------------------------------------------
// Compatibility definitions.
 
#define trace_initialize micro_os_plus_trace_initialize
#define trace_write micro_os_plus_trace_write
#define trace_flush micro_os_plus_trace_flush
 
#define trace_printf micro_os_plus_trace_printf
#define trace_vprintf micro_os_plus_trace_vprintf
#define trace_puts micro_os_plus_trace_puts
#define trace_putchar micro_os_plus_trace_putchar
#define trace_dump_args micro_os_plus_trace_dump_args
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_DIAG_TRACE_H_
 
// ----------------------------------------------------------------------------