asciichat_errno.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
// Platform-specific includes
#ifndef _WIN32
#include <unistd.h>
#endif
 
// Platform-specific includes - must be first
#include "common.h"
// Include logging.h for log_error macro used in SET_ERRNO
#include "log/logging.h"
 
/* ============================================================================
 * ascii-chat Error Number System
 * ============================================================================
 * Thread-local error context that captures:
 * - Error code (asciichat_error_t)
 * - File, line, function where error occurred
 * - Stack trace at error site (debug builds)
 * - Optional custom context message
 * - Timestamp of error
 * - System error context (errno)
 */
 
typedef struct {
  asciichat_error_t code;   
  const char *file;         
  int line;                 
  const char *function;     
  char *context_message;    
  uint64_t timestamp;       
  int system_errno;         
  int wsa_error;            
  void *backtrace[32];      
  char **backtrace_symbols; 
  int stack_depth;          
  bool has_system_error;    
  bool has_wsa_error;       
} asciichat_error_context_t;
 
/* ============================================================================
 * Thread-Local Error Storage
 * ============================================================================
 */
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern __thread asciichat_error_context_t asciichat_errno_context;
 
extern __thread asciichat_error_t asciichat_errno;
 
/* ============================================================================
 * Library Error Setting Macros
 * ============================================================================
 * Use these in lib/ code to set error context
 */
 
#ifdef NDEBUG
#define SET_ERRNO(code, context_msg, ...)                                                                              \
  ({                                                                                                                   \
    asciichat_set_errno_with_message(code, NULL, 0, NULL, context_msg, ##__VA_ARGS__);                                 \
    log_error("SET_ERRNO: " context_msg " (code: %d, meaning: %s)", ##__VA_ARGS__, code,                               \
              asciichat_error_string(code));                                                                           \
    (code);                                                                                                            \
  })
#else
#define SET_ERRNO(code, context_msg, ...)                                                                              \
  ({                                                                                                                   \
    asciichat_set_errno_with_message(code, __FILE__, __LINE__, __func__, context_msg, ##__VA_ARGS__);                  \
    log_error("SET_ERRNO: " context_msg " (code: %d, meaning: %s)", ##__VA_ARGS__, code,                               \
              asciichat_error_string(code));                                                                           \
    (code);                                                                                                            \
  })
#endif
 
#ifdef NDEBUG
#define SET_ERRNO_SYS(code, context_msg, ...)                                                                          \
  ({                                                                                                                   \
    int captured_errno = platform_get_last_error();                                                                    \
    asciichat_set_errno_with_system_error_and_message(code, NULL, 0, NULL, captured_errno, context_msg,                \
                                                      ##__VA_ARGS__);                                                  \
    log_error("SETERRNO_SYS: " context_msg " (code: %d - %s, system error: %d - %s)", ##__VA_ARGS__, code,             \
              asciichat_error_string(code), captured_errno, platform_strerror(captured_errno));                        \
    (code);                                                                                                            \
  })
#else
#define SET_ERRNO_SYS(code, context_msg, ...)                                                                          \
  ({                                                                                                                   \
    int captured_errno = platform_get_last_error();                                                                    \
    asciichat_set_errno_with_system_error_and_message(code, __FILE__, __LINE__, __func__, captured_errno, context_msg, \
                                                      ##__VA_ARGS__);                                                  \
    log_error("SETERRNO_SYS: " context_msg " (code: %d - %s, system error: %d - %s)", ##__VA_ARGS__, code,             \
              asciichat_error_string(code), captured_errno, platform_strerror(captured_errno));                        \
    (code);                                                                                                            \
  })
#endif
 
/* ============================================================================
 * Error Logging Integration Macros
 * ============================================================================
 * These macros combine error setting with automatic logging
 */
 
/* ============================================================================
 * Application Error Checking Macros
 * ============================================================================
 * Use these in src/ code to check and handle errors
 */
 
#define HAS_ERRNO(var) asciichat_has_errno(var)
 
#define CLEAR_ERRNO() asciichat_clear_errno()
 
#define GET_ERRNO() asciichat_get_errno()
 
/* ============================================================================
 * Implementation Functions
 * @{
 */
 
void asciichat_set_errno(asciichat_error_t code, const char *file, int line, const char *function,
                         const char *context_message);
 
void asciichat_set_errno_with_message(asciichat_error_t code, const char *file, int line, const char *function,
                                      const char *format, ...);
 
void asciichat_set_errno_with_system_error(asciichat_error_t code, const char *file, int line, const char *function,
                                           int sys_errno);
 
void asciichat_set_errno_with_system_error_and_message(asciichat_error_t code, const char *file, int line,
                                                       const char *function, int sys_errno, const char *format, ...);
 
void asciichat_set_errno_with_wsa_error(asciichat_error_t code, const char *file, int line, const char *function,
                                        int wsa_error);
 
bool asciichat_has_errno(asciichat_error_context_t *context);
 
bool asciichat_has_wsa_error(void);
 
void asciichat_clear_errno(void);
 
asciichat_error_t asciichat_get_errno(void);
 
void asciichat_fatal_with_context(asciichat_error_t code, const char *file, int line, const char *function,
                                  const char *format, ...);
 
void asciichat_print_error_context(const asciichat_error_context_t *context);
 
/* ============================================================================
 * Debug/Development Utilities
 * ============================================================================
 */
 
#if defined(DEBUG) || defined(ENABLE_ERRNO_BACKTRACES)
#define PRINT_ERRNO_CONTEXT(context) asciichat_print_error_context(context)
 
#define ASSERT_NO_ERRNO()                                                                                              \
  do {                                                                                                                 \
    asciichat_error_t err = asciichat_get_errno();                                                                     \
    if (err != ASCIICHAT_OK) {                                                                                         \
      asciichat_error_context_t ctx;                                                                                   \
      asciichat_has_errno(&ctx);                                                                                       \
      asciichat_print_error_context(&ctx);                                                                             \
      abort();                                                                                                         \
    }                                                                                                                  \
  } while (0)
 
#define PRINT_ERRNO_IF_ERROR()                                                                                         \
  do {                                                                                                                 \
    asciichat_error_context_t ctx;                                                                                     \
    if (HAS_ERRNO(&ctx)) {                                                                                             \
      asciichat_print_error_context(&ctx);                                                                             \
    }                                                                                                                  \
  } while (0)
 
#else
// No-op versions for Release builds
#define PRINT_ERRNO_CONTEXT(context) ((void)(context))
#define ASSERT_NO_ERRNO() ((void)0)
#define PRINT_ERRNO_IF_ERROR() ((void)0)
#endif
 
/* ============================================================================
 * Error Statistics and Monitoring
 * @{
 */
 
typedef struct {
  uint64_t error_counts[256];
  uint64_t total_errors;
  uint64_t last_error_time;
  asciichat_error_t last_error_code;
} asciichat_error_stats_t;
 
void asciichat_error_stats_init(void);
 
void asciichat_error_stats_record(asciichat_error_t code);
 
void asciichat_error_stats_print(void);
 
void asciichat_error_stats_reset(void);
 
asciichat_error_stats_t asciichat_error_stats_get(void);
 
/* ============================================================================
 * Thread-Safe Error Propagation
 * @{
 *
 * For multi-threaded scenarios where errors need to be propagated across
 * thread boundaries. These functions allow storing error codes per-thread
 * for later retrieval.
 */
 
asciichat_error_t asciichat_get_thread_error(int thread_id);
 
void asciichat_set_thread_error(int thread_id, asciichat_error_t code);
 
void asciichat_clear_thread_error(int thread_id);
 
/* ============================================================================
 * Error System Control Functions
 * @{
 */
 
void asciichat_errno_suppress(bool suppress);
 
void asciichat_errno_cleanup(void);
 
/* ============================================================================
 * Application Error Checking Macros
 * ============================================================================
 * Use these in src/ code to check and log errors
 */
 
#define LOG_ERRNO_IF_SET(message)                                                                                      \
  do {                                                                                                                 \
    if (asciichat_errno != ASCIICHAT_OK) {                                                                             \
      asciichat_print_error_context(&asciichat_errno_context);                                                         \
    }                                                                                                                  \
  } while (0)
 
#define LOG_ERRNO_IF_CODE(code, message)                                                                               \
  do {                                                                                                                 \
    if (asciichat_errno == (code)) {                                                                                   \
      asciichat_print_error_context(&asciichat_errno_context);                                                         \
    }                                                                                                                  \
  } while (0)
 
#ifdef __cplusplus
}
#endif