Dedicated worker for all pending errno stacks and handled history. Signal handlers may only request a report. More...

Functions
asciichat_error_t	debug_errno_init (void)
asciichat_error_t	debug_errno_start_thread (void)
void	debug_errno_cleanup_thread (void)
void	debug_errno_destroy (void)
bool	debug_errno_is_cleanup_in_progress (void)
void	debug_errno_trigger_print (void)
void	debug_errno_print_delayed (uint64_t delay_ns)
void	debug_errno_print (void)
void	debug_errno_poll (void)

Detailed Description

Dedicated worker for all pending errno stacks and handled history. Signal handlers may only request a report.

Definition in file debug/errno.h.

Function Documentation

◆ debug_errno_cleanup_thread()

void debug_errno_cleanup_thread ( void )

Definition at line 110 of file errno.c.

                                      {
  if (!g_debug_errno_started)
    return;
  atomic_store_bool_impl(&g_debug_errno_cleaning, true);
  mutex_lock(&g_debug_errno_mutex);
  atomic_store_bool_impl(&g_debug_errno_exiting, true);
  cond_signal(&g_debug_errno_condition);
  mutex_unlock(&g_debug_errno_mutex);
#ifndef EMSCRIPTEN_BUILD
  // Join fully: diagnostic data must not be destroyed while a reader is alive.
  if (thread_join(&g_debug_errno_thread, NULL) != 0)
    FATAL(ERROR_THREAD, "Cannot join diagnostics worker");
#endif
  g_debug_errno_started = false;
}

References ERROR_THREAD, and FATAL.

Referenced by asciichat_shared_destroy(), and debug_errno_destroy().

◆ debug_errno_destroy()

void debug_errno_destroy ( void )

Definition at line 125 of file errno.c.

                               {
  debug_errno_cleanup_thread();
  if (g_debug_errno_initialized) {
    cond_destroy(&g_debug_errno_condition);
    mutex_destroy(&g_debug_errno_mutex);
    g_debug_errno_initialized = false;
    atomic_store_bool_impl(&g_debug_errno_signal, false);
    g_debug_errno_errno_deadline = 0;
  }
}

References debug_errno_cleanup_thread().

Referenced by asciichat_shared_destroy().

◆ debug_errno_init()

asciichat_error_t debug_errno_init ( void )

Definition at line 20 of file errno.c.

                                         {
  if (g_debug_errno_initialized)
    return ASCIICHAT_OK;
  if (mutex_init(&g_debug_errno_mutex, "debug_errno") != 0)
    return SET_ERRNO(ERROR_THREAD, "Cannot initialize diagnostics mutex");
  if (cond_init(&g_debug_errno_condition, "debug_errno") != 0) {
    mutex_destroy(&g_debug_errno_mutex);
    return SET_ERRNO(ERROR_THREAD, "Cannot initialize diagnostics condition");
  }
  g_debug_errno_initialized = true;
  atomic_store_bool_impl(&g_debug_errno_cleaning, false);
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_THREAD, and SET_ERRNO.

Referenced by debug_errno_start_thread().

◆ debug_errno_is_cleanup_in_progress()

bool debug_errno_is_cleanup_in_progress ( void )

Definition at line 52 of file errno.c.

                                              {
  return atomic_load_bool_impl(&g_debug_errno_cleaning);
}

◆ debug_errno_poll()

void debug_errno_poll ( void )

Definition at line 55 of file errno.c.

                            {
  if (!g_debug_errno_initialized)
    return;
  uint64_t now = time_get_ns();
  bool all = atomic_exchange_bool_impl(&g_debug_errno_signal, false);
  mutex_lock(&g_debug_errno_mutex);
  bool errors = g_debug_errno_errno_deadline && now >= g_debug_errno_errno_deadline;
  if (errors)
    g_debug_errno_errno_deadline = 0;
  mutex_unlock(&g_debug_errno_mutex);
  if (all || errors)
    debug_errno_print_errno();
}

◆ debug_errno_print()

void debug_errno_print ( void )

Definition at line 39 of file errno.c.

                             {
  debug_errno_print_errno();
}

◆ debug_errno_print_delayed()

void debug_errno_print_delayed ( uint64_t delay_ns )

Definition at line 42 of file errno.c.

                                               {
  if (!g_debug_errno_initialized)
    return;
  debug_report_schedule(&g_debug_errno_mutex, &g_debug_errno_condition, &g_debug_errno_errno_deadline, delay);
}

References debug_report_schedule().

Referenced by debug_errno_start_thread().

◆ debug_errno_start_thread()

asciichat_error_t debug_errno_start_thread ( void )

Definition at line 90 of file errno.c.

                                                 {
  if (g_debug_errno_started)
    return ASCIICHAT_OK;
  asciichat_error_t result = debug_errno_init();
  if (result != ASCIICHAT_OK)
    return result;
  atomic_store_bool_impl(&g_debug_errno_exiting, false);
  atomic_store_bool_impl(&g_debug_errno_cleaning, false);
  options_t *opts = options_get();
  if (opts) {
    if (IS_OPTION_EXPLICIT(debug_errno_stacks_time, opts))
      debug_errno_print_delayed((uint64_t)(opts->debug_errno_stacks_time * NS_PER_SEC_INT));
  }
#ifndef EMSCRIPTEN_BUILD
  if (platform_thread_create(&g_debug_errno_thread, "debug_errno", debug_errno_worker, NULL) != 0)
    return SET_ERRNO(ERROR_THREAD, "Cannot start diagnostics worker");
#endif
  g_debug_errno_started = true;
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, debug_errno_init(), debug_errno_print_delayed(), options_state::debug_errno_stacks_time, ERROR_THREAD, IS_OPTION_EXPLICIT, NS_PER_SEC_INT, options_get(), and SET_ERRNO.

Referenced by main().

◆ debug_errno_trigger_print()

void debug_errno_trigger_print ( void )

Definition at line 47 of file errno.c.

                                     {
  // Do not signal a condition variable or invoke diagnostic hooks in a signal
  // handler. The worker checks this flag at most 100ms after its next wakeup.
  atomic_store_bool_impl(&g_debug_errno_signal, true);
}

Functions