runtime.h File Reference

Go to the source code of this file.

Data Structures
struct	stats_view_t

Macros
#define	STATS_RUNTIME_MODE_BUFFER_SIZE   32
#define	STATS_VIEW_LINE_BUFFER_SIZE   160
#define	STATS_VIEW_LINES   128

Typedefs
typedef struct stats_peer	stats_peer_t
typedef void(*	stats_provider_fn) (stats_view_t *view, void *data)

Functions
asciichat_error_t	stats_runtime_start (const char *mode, unsigned interval_seconds)
void	stats_runtime_stop (void)
stats_scope_t *	stats_runtime_scope (void)
void	stats_runtime_set_provider (stats_provider_fn provider, void *data)
void	stats_view_add (stats_view_t *view, const char *format,...)
void	stats_view_add_header (stats_view_t *view, const char *format,...)
void	stats_runtime_toggle (void)
bool	stats_runtime_active (void)
stats_peer_t *	stats_runtime_peer_open (const char *transport)
void	stats_runtime_peer_close (stats_peer_t *peer)
stats_scope_t *	stats_runtime_peer_scope (stats_peer_t *peer)
void	stats_runtime_packet (stats_peer_t *peer, unsigned type, size_t payload_bytes, bool sent, bool success)
void	stats_runtime_connection_state (const char *state)
void	stats_runtime_media (unsigned width, unsigned height, double position, double duration)

Macro Definition Documentation

STATS_RUNTIME_MODE_BUFFER_SIZE

#define STATS_RUNTIME_MODE_BUFFER_SIZE   32

Definition at line 4 of file stats/runtime.h.

STATS_VIEW_LINE_BUFFER_SIZE

#define STATS_VIEW_LINE_BUFFER_SIZE   160

Definition at line 7 of file stats/runtime.h.

STATS_VIEW_LINES

#define STATS_VIEW_LINES   128

Definition at line 13 of file stats/runtime.h.

Typedef Documentation

stats_peer_t

typedef struct stats_peer stats_peer_t

Definition at line 12 of file stats/runtime.h.

stats_provider_fn

typedef void(* stats_provider_fn) (stats_view_t *view, void *data)

Provider runs on the stats worker; unregister before destroying its data. Never call stats_runtime_set_provider() from a provider.

Definition at line 30 of file stats/runtime.h.

Function Documentation

stats_runtime_active()

bool stats_runtime_active

(

void

)

Definition at line 86 of file runtime.c.

                                {
  return atomic_load_bool_impl(&g_active) && (ui_controller_interactive_screen() == UI_SCREEN_STATS ||
                                              (ui_controller_interactive_screen() == UI_SCREEN_HELP &&
                                               keyboard_help_previous_interactive() == UI_SCREEN_STATS));
}

References keyboard_help_previous_interactive(), ui_controller_interactive_screen(), UI_SCREEN_HELP, and UI_SCREEN_STATS.

Referenced by stats_runtime_toggle().

stats_runtime_connection_state()

void stats_runtime_connection_state

(

const char *

state

)

Definition at line 135 of file runtime.c.

                                                       {
  if (!g_scope)
    return;
  mutex_lock(&g_provider_mutex);
  snprintf(g_state, sizeof(g_state), "%s", state);
  mutex_unlock(&g_provider_mutex);
}

stats_runtime_media()

void stats_runtime_media	(	unsigned	width,
		unsigned	height,
		double	position,
		double	duration )

Definition at line 69 of file runtime.c.

                                                                                            {
  if (!g_scope)
    return;
  atomic_store_u64_impl(&g_media_width, width);
  atomic_store_u64_impl(&g_media_height, height);
  atomic_store_u64_impl(&g_media_position,
                        isfinite(position) && position >= 0 && position < 1e12 ? (uint64_t)(position * 1000) + 1 : 0);
  atomic_store_u64_impl(&g_media_duration,
                        isfinite(duration) && duration > 0 && duration < 1e12 ? (uint64_t)(duration * 1000) + 1 : 0);
}

References height, and width.

Referenced by stats_runtime_start().

stats_runtime_packet()

void stats_runtime_packet	(	stats_peer_t *	peer,
		unsigned	type,
		size_t	payload_bytes,
		bool	sent,
		bool	success )

Application packet boundary, after decryption on receive. Header bytes are included internally.

Definition at line 196 of file runtime.c.

                                                                                                            {
  if (success) {
    ascii_otel_metric(sent ? ASCII_OTEL_METRIC_NET_TX_SIZE : ASCII_OTEL_METRIC_NET_RX_SIZE, (double)payload_bytes);
  }
  if (sent && type == PACKET_TYPE_ERROR_MESSAGE)
    stats_counter_add(g_scope, STATS_COUNTER_REQUEST_FAILURES, 1);
  stats_scope_t *scopes[] = {g_scope, peer ? peer->scope : NULL};
  for (unsigned i = 0; i < 2; ++i) {
    if (!success) {
      stats_counter_add(scopes[i], sent ? STATS_COUNTER_SEND_ERRORS : STATS_COUNTER_RECEIVE_ERRORS, 1);
      continue;
    }
    stats_counter_add(scopes[i], sent ? STATS_COUNTER_PACKETS_SENT : STATS_COUNTER_PACKETS_RECEIVED, 1);
    stats_counter_add(scopes[i], sent ? STATS_COUNTER_BYTES_SENT : STATS_COUNTER_BYTES_RECEIVED,
                      sizeof(packet_header_t) + payload_bytes);
    if (type == PACKET_TYPE_ASCII_FRAME || type == PACKET_TYPE_IMAGE_FRAME || type == PACKET_TYPE_IMAGE_FRAME_H265 ||
        type == PACKET_TYPE_IMAGE_FRAME_H264)
      stats_counter_add(scopes[i], sent ? STATS_COUNTER_FRAMES_SENT : STATS_COUNTER_FRAMES_RECEIVED, 1);
  }
}

References ascii_otel_metric(), PACKET_TYPE_ASCII_FRAME, PACKET_TYPE_ERROR_MESSAGE, PACKET_TYPE_IMAGE_FRAME, PACKET_TYPE_IMAGE_FRAME_H264, PACKET_TYPE_IMAGE_FRAME_H265, stats_peer::scope, stats_counter_add(), STATS_COUNTER_BYTES_RECEIVED, STATS_COUNTER_BYTES_SENT, STATS_COUNTER_FRAMES_RECEIVED, STATS_COUNTER_FRAMES_SENT, STATS_COUNTER_PACKETS_RECEIVED, STATS_COUNTER_PACKETS_SENT, STATS_COUNTER_RECEIVE_ERRORS, STATS_COUNTER_REQUEST_FAILURES, and STATS_COUNTER_SEND_ERRORS.

Referenced by acip_handle_acds_packet(), acip_handle_client_packet(), acip_handle_server_packet(), packet_receive_via_transport(), and packet_send_via_transportv().

stats_runtime_peer_close()

void stats_runtime_peer_close

(

stats_peer_t *

peer

)

Definition at line 181 of file runtime.c.

                                                  {
  if (!peer)
    return;
  mutex_lock(&g_peers_mutex);
  for (unsigned i = 0; i < STATS_PEER_CAPACITY; ++i)
    if (g_peers[i] == peer)
      g_peers[i] = NULL;
  --g_peer_count;
  stats_gauge_set(g_scope, STATS_GAUGE_CONNECTIONS_ACTIVE, g_peer_count);
  mutex_unlock(&g_peers_mutex);
  stats_sampler_destroy(peer->sampler);
  stats_scope_destroy(peer->scope);
  SAFE_FREE(peer);
}

References SAFE_FREE, stats_peer::sampler, stats_peer::scope, STATS_GAUGE_CONNECTIONS_ACTIVE, stats_gauge_set(), STATS_PEER_CAPACITY, stats_sampler_destroy(), and stats_scope_destroy().

Referenced by acip_transport_destroy(), and acip_websocket_client_transport_create().

stats_runtime_peer_open()

stats_peer_t * stats_runtime_peer_open

(

const char *

transport

)

Definition at line 152 of file runtime.c.

                                                             {
  if (!g_scope)
    return NULL;
  stats_peer_t *peer = SAFE_CALLOC(1, sizeof(*peer), stats_peer_t *);
  if (!peer)
    return NULL;
  stats_capabilities_t caps = network_capabilities();
  stats_sampler_config_t config = {NS_PER_SEC_INT, 250 * NS_PER_MS_INT};
  if (stats_scope_create(&caps, &peer->scope) != ASCIICHAT_OK ||
      stats_sampler_create(&config, &peer->sampler) != ASCIICHAT_OK) {
    stats_scope_destroy(peer->scope);
    SAFE_FREE(peer);
    return NULL;
  }
  snprintf(peer->transport, sizeof(peer->transport), "%s", transport);
  mutex_lock(&g_peers_mutex);
  peer->id = ++g_peer_id;
  ++g_peer_count;
  stats_gauge_set(g_scope, STATS_GAUGE_CONNECTIONS_ACTIVE, g_peer_count);
  for (unsigned i = 0; i < STATS_PEER_CAPACITY; ++i) {
    if (!g_peers[i]) {
      g_peers[i] = peer;
      break;
    }
  }
  mutex_unlock(&g_peers_mutex);
  return peer;
}

References ASCIICHAT_OK, stats_peer::id, NS_PER_MS_INT, NS_PER_SEC_INT, SAFE_CALLOC, SAFE_FREE, stats_peer::sampler, stats_peer::scope, STATS_GAUGE_CONNECTIONS_ACTIVE, stats_gauge_set(), STATS_PEER_CAPACITY, stats_sampler_create(), stats_scope_create(), stats_scope_destroy(), and stats_peer::transport.

Referenced by acip_async_tcp_transport_create(), acip_tcp_transport_create(), acip_websocket_client_transport_create(), and acip_websocket_server_transport_create().

stats_runtime_peer_scope()

stats_scope_t * stats_runtime_peer_scope

(

stats_peer_t *

peer

)

Definition at line 83 of file runtime.c.

                                                            {
  return peer ? peer->scope : NULL;
}

References stats_peer::scope.

stats_runtime_scope()

stats_scope_t * stats_runtime_scope

(

void

)

Definition at line 80 of file runtime.c.

                                         {
  return g_scope;
}

Referenced by acip_handle_acds_packet(), acip_send_session_joined(), client_audio_render_thread(), client_video_render_thread(), database_session_cleanup_expired(), database_session_update_host(), database_stats_snapshot(), h265_decode(), h265_encode(), h265_encoder_flush(), http_request_cancel(), http_response_finish(), http_server_authorize(), http_server_dispatch_http3(), mcp_dispatch(), mcp_error(), packet_decode_frame_data_malloc(), packet_decode_frame_data_workspace(), rate_limiter_check(), server_connection_pong_received(), session_display_encode_frame(), session_host_render_audio(), update_server_stats(), and video_frame_commit().

stats_runtime_set_provider()

void stats_runtime_set_provider	(	stats_provider_fn	provider,
		void *	data )

Definition at line 126 of file runtime.c.

                                                                        {
  if (!g_scope)
    return;
  mutex_lock(&g_provider_mutex);
  g_provider = provider;
  g_provider_data = data;
  mutex_unlock(&g_provider_mutex);
}

Referenced by mcp_server_main().

stats_runtime_start()

asciichat_error_t stats_runtime_start	(	const char *	mode,
		unsigned	interval_seconds )

Definition at line 520 of file runtime.c.

                                                                                   {
  if (!mode)
    return SET_ERRNO(ERROR_INVALID_PARAM, "Missing statistics mode");
  if (g_started)
    return ASCIICHAT_OK;
  bool mcp = strcmp(mode, "mcp-server") == 0;
  stats_capabilities_t caps = network_capabilities();
  bool mirror = strcmp(mode, "mirror") == 0, acds = strcmp(mode, "discovery-service") == 0;
  if (mirror)
    memset(&caps, 0, sizeof(caps));
  if (!acds) {
    for (int i = 0; i <= STATS_COUNTER_FRAMES_DROPPED; ++i)
      caps.counters[i] = true;
    caps.counters[STATS_COUNTER_FRAMES_ENQUEUED] = caps.counters[STATS_COUNTER_QUEUE_DROPS] = true;
    caps.counters[STATS_COUNTER_AUDIO_UNDERRUNS] = caps.counters[STATS_COUNTER_AUDIO_OVERRUNS] =
        GET_OPTION(audio_enabled);
    for (int i = 0; i <= STATS_DURATION_TERMINAL_WRITE; ++i)
      caps.durations[i] = true;
    caps.gauges[STATS_GAUGE_AUDIO_BUFFERED_SAMPLES] = GET_OPTION(audio_enabled);
    caps.durations[STATS_DURATION_AUDIO_MIX] = GET_OPTION(audio_enabled) && !mirror;
    if (mirror) {
      caps.counters[STATS_COUNTER_FRAMES_ENCODED] = caps.counters[STATS_COUNTER_FRAMES_DECODED] = false;
      caps.durations[STATS_DURATION_ENCODE] = caps.durations[STATS_DURATION_DECODE] = false;
    }
  } else {
    caps.counters[STATS_COUNTER_FRAMES_SENT] = caps.counters[STATS_COUNTER_FRAMES_RECEIVED] = false;
    for (int i = STATS_COUNTER_SESSION_CREATES; i <= STATS_COUNTER_HOST_MIGRATIONS; ++i)
      caps.counters[i] = true;
    caps.counters[STATS_COUNTER_MIGRATION_FAILURES] = true;
    caps.durations[STATS_DURATION_REQUEST] = true;
    caps.gauges[STATS_GAUGE_SESSIONS_ACTIVE] = caps.gauges[STATS_GAUGE_PARTICIPANTS_ACTIVE] = true;
  }
  if (strcmp(mode, "discovery") == 0)
    caps.counters[STATS_COUNTER_MIGRATION_FAILURES] = true;
  caps.gauges[STATS_GAUGE_VIDEO_QUEUE_DEPTH] = strcmp(mode, "server") == 0;
  if (GET_OPTION(render_file)[0]) {
    caps.counters[STATS_COUNTER_RECORDING_FRAMES] = true;
    caps.durations[STATS_DURATION_RECORDING] = true;
  }
  if (!mirror) {
    caps.counters[STATS_COUNTER_RATE_LIMIT_REJECTIONS] = true;
    caps.durations[STATS_DURATION_RTT] = !acds;
    caps.counters[STATS_COUNTER_RECONNECTS] = !acds;
    caps.counters[STATS_COUNTER_HOST_MIGRATIONS] = true;
    caps.gauges[STATS_GAUGE_CONNECTIONS_ACTIVE] = true;
    caps.durations[STATS_DURATION_CONNECTION_SETUP] = !acds;
  }
  if (mcp) {
    memset(&caps, 0, sizeof(caps));
    for (unsigned i = STATS_COUNTER_MCP_REQUESTS; i <= STATS_COUNTER_MCP_HTTP_RESPONSES; i++)
      caps.counters[i] = true;
    for (unsigned i = STATS_COUNTER_HTTP_REQUESTS; i <= STATS_COUNTER_HTTP_BYTES_SENT; i++)
      caps.counters[i] = true;
    caps.gauges[STATS_GAUGE_HTTP_CONNECTIONS_ACTIVE] = true;
    caps.gauges[STATS_GAUGE_HTTP_STREAMS_ACTIVE] = true;
    caps.durations[STATS_DURATION_MCP_RENDER] = true;
    caps.durations[STATS_DURATION_HTTP_REQUEST] = true;
  }
  asciichat_error_t result = stats_scope_create(&caps, &g_scope);
  if (result != ASCIICHAT_OK)
    return result;
  ascii_otel_stats_attach(g_scope);
  stats_sampler_config_t config = {NS_PER_SEC_INT, 250 * NS_PER_MS_INT};
  result = stats_sampler_create(&config, &g_sampler);
  if (result != ASCIICHAT_OK)
    goto fail_scope;
  if (mutex_init(&g_peers_mutex, "stats_peers") != 0) {
    result = SET_ERRNO(ERROR_THREAD, "Cannot initialize stats peer mutex");
    goto fail_sampler;
  }
  if (mutex_init(&g_provider_mutex, "stats_provider") != 0) {
    result = SET_ERRNO(ERROR_THREAD, "Cannot initialize stats provider mutex");
    goto fail_peers;
  }
  g_peer_count = g_peer_id = 0;
  memset(g_peers, 0, sizeof(g_peers));
  g_state[0] = 0;
  stats_runtime_media(0, 0, -1, -1);
  snprintf(g_mode, sizeof(g_mode), "%s", mode);
  g_interval = interval_seconds;
  g_fd = platform_isatty(STDOUT_FILENO) ? STDOUT_FILENO : STDERR_FILENO;
  g_keyboard = (!mcp || !strcmp(GET_OPTION(mcp_transport), "http")) && platform_isatty(STDIN_FILENO) &&
               platform_isatty(g_fd) && keyboard_init() == ASCIICHAT_OK;
  atomic_store_bool_impl(&g_stop, false);
  atomic_store_bool_impl(&g_active, false);
  atomic_store_bool_impl(&g_onboarding_wait, false);
  g_started = true;
  bool server_like = strcmp(mode, "server") == 0 || strcmp(mode, "discovery-service") == 0 ||
                     (mcp && !strcmp(GET_OPTION(mcp_transport), "http"));
  if (g_keyboard && server_like && ui_controller_start_terminal(g_fd) != ASCIICHAT_OK)
    LOG_ERRNO_IF_SET("Cannot start terminal presentation");
  if (platform_thread_create(&g_worker, "stats", stats_worker, NULL) == 0) {
    atomic_store_bool_impl(&g_onboarding_wait, true);
    bool shown = show_first_use_instructions();
    while (shown && ui_controller_screen_live(UI_SCREEN_NOTICE) && !shutdown_is_requested()) {
      ui_presentation_state_t state = ui_controller_state();
      if (state.screen == UI_SCREEN_NOTICE && state.covered)
        break;
      platform_sleep_ms(10);
    }
    atomic_store_bool_impl(&g_onboarding_wait, false);
    return ASCIICHAT_OK;
  }
  result = SET_ERRNO(ERROR_THREAD, "Cannot start stats worker");
  g_started = false;
  if (g_keyboard)
    keyboard_destroy();
  mutex_destroy(&g_provider_mutex);
fail_peers:
  mutex_destroy(&g_peers_mutex);
fail_sampler:
  stats_sampler_destroy(g_sampler);
  g_sampler = NULL;
fail_scope:
  stats_scope_destroy(g_scope);
  g_scope = NULL;
  return result;
}

References ascii_otel_stats_attach(), ASCIICHAT_OK, stats_capabilities_t::counters, stats_capabilities_t::durations, ERROR_INVALID_PARAM, ERROR_THREAD, stats_capabilities_t::gauges, GET_OPTION, keyboard_destroy(), keyboard_init(), LOG_ERRNO_IF_SET, NS_PER_MS_INT, NS_PER_SEC_INT, platform_sleep_ms(), SET_ERRNO, shutdown_is_requested(), STATS_COUNTER_AUDIO_OVERRUNS, STATS_COUNTER_AUDIO_UNDERRUNS, STATS_COUNTER_FRAMES_DECODED, STATS_COUNTER_FRAMES_DROPPED, STATS_COUNTER_FRAMES_ENCODED, STATS_COUNTER_FRAMES_ENQUEUED, STATS_COUNTER_FRAMES_RECEIVED, STATS_COUNTER_FRAMES_SENT, STATS_COUNTER_HOST_MIGRATIONS, STATS_COUNTER_HTTP_BYTES_SENT, STATS_COUNTER_HTTP_REQUESTS, STATS_COUNTER_MCP_HTTP_RESPONSES, STATS_COUNTER_MCP_REQUESTS, STATS_COUNTER_MIGRATION_FAILURES, STATS_COUNTER_QUEUE_DROPS, STATS_COUNTER_RATE_LIMIT_REJECTIONS, STATS_COUNTER_RECONNECTS, STATS_COUNTER_RECORDING_FRAMES, STATS_COUNTER_SESSION_CREATES, STATS_DURATION_AUDIO_MIX, STATS_DURATION_CONNECTION_SETUP, STATS_DURATION_DECODE, STATS_DURATION_ENCODE, STATS_DURATION_HTTP_REQUEST, STATS_DURATION_MCP_RENDER, STATS_DURATION_RECORDING, STATS_DURATION_REQUEST, STATS_DURATION_RTT, STATS_DURATION_TERMINAL_WRITE, STATS_GAUGE_AUDIO_BUFFERED_SAMPLES, STATS_GAUGE_CONNECTIONS_ACTIVE, STATS_GAUGE_HTTP_CONNECTIONS_ACTIVE, STATS_GAUGE_HTTP_STREAMS_ACTIVE, STATS_GAUGE_PARTICIPANTS_ACTIVE, STATS_GAUGE_SESSIONS_ACTIVE, STATS_GAUGE_VIDEO_QUEUE_DEPTH, stats_runtime_media(), stats_sampler_create(), stats_sampler_destroy(), stats_scope_create(), stats_scope_destroy(), ui_controller_screen_live(), ui_controller_start_terminal(), ui_controller_state(), and UI_SCREEN_NOTICE.

Referenced by main().

stats_runtime_stop()

void stats_runtime_stop

(

void

)

Definition at line 639 of file runtime.c.

                              {
  if (!g_started)
    return;
  atomic_store_bool_impl(&g_stop, true);
  thread_join(&g_worker, NULL);
  ui_controller_shutdown();
  if (g_keyboard)
    keyboard_destroy();
  g_provider = NULL;
  g_provider_data = NULL;
  stats_sampler_destroy(g_sampler);
  stats_scope_destroy(g_scope);
  g_sampler = NULL;
  g_scope = NULL;
  mutex_destroy(&g_provider_mutex);
  mutex_destroy(&g_peers_mutex);
  g_started = false;
}

References keyboard_destroy(), stats_sampler_destroy(), stats_scope_destroy(), and ui_controller_shutdown().

Referenced by asciichat_shared_destroy(), and main().

stats_runtime_toggle()

void stats_runtime_toggle

(

void

)

Definition at line 92 of file runtime.c.

                                {
  if (g_started && g_keyboard) {
    bool active = !stats_runtime_active();
    atomic_store_bool_impl(&g_active, active);
    ui_controller_select_interactive(active ? UI_SCREEN_STATS : -1);
    log_debug("Statistics TUI requested: %s", active ? "open" : "closed");
  }
}

References log_debug, stats_runtime_active(), ui_controller_select_interactive(), and UI_SCREEN_STATS.

stats_view_add()

void stats_view_add	(	stats_view_t *	view,
		const char *	format,
			... )

Definition at line 112 of file runtime.c.

                                                                 {
  va_list args;
  va_start(args, format);
  stats_view_vadd(view, false, format, args);
  va_end(args);
}

References args.

stats_view_add_header()

void stats_view_add_header	(	stats_view_t *	view,
		const char *	format,
			... )

Definition at line 119 of file runtime.c.

                                                                        {
  va_list args;
  va_start(args, format);
  stats_view_vadd(view, true, format, args);
  va_end(args);
}

References args.