ascii-chat
Binary v0.16.50-198-g78f51665f
Library lib/v0.3.2-2240-g78f51665f
Video chat in your terminal
Loading...
Searching...
No Matches
metrics.c File Reference

Ring consensus metrics collection and wire protocol implementation. More...

Go to the source code of this file.

Data Structures

struct  consensus_metrics_collection
 Growable collection of participant-quality measurements. metrics, count, and capacity form the pointer/length/capacity trio; the consensus owner grows and frees the array, while readers use it only during its valid snapshot window. More...

Macros

#define CONSENSUS_METRICS_INITIAL_CAPACITY   10

Typedefs

typedef struct consensus_metrics_collection consensus_metrics_collection_t
 Growable collection of participant-quality measurements. metrics, count, and capacity form the pointer/length/capacity trio; the consensus owner grows and frees the array, while readers use it only during its valid snapshot window.

Functions

asciichat_error_t consensus_metrics_measure (const uint8_t my_id[SESSION_ID_SIZE], participant_metrics_t *out_metrics)
 Measure participant network quality metrics.
asciichat_error_t consensus_metrics_to_wire (const participant_metrics_t *metrics, participant_metrics_t *out_wire)
 Serialize metrics to wire format with network byte order.
asciichat_error_t consensus_metrics_from_wire (const participant_metrics_t *wire_metrics, participant_metrics_t *out_metrics)
 Deserialize metrics from wire format.
asciichat_error_t consensus_metrics_collection_create (consensus_metrics_collection_t **out_collection)
 Create empty metrics collection.
asciichat_error_t consensus_metrics_collection_add (consensus_metrics_collection_t *collection, const participant_metrics_t *metrics)
 Add metrics to collection.
asciichat_error_t consensus_metrics_collection_get (const consensus_metrics_collection_t *collection, const participant_metrics_t **out_metrics, int *out_count)
 Get all accumulated metrics.
void consensus_metrics_collection_destroy (consensus_metrics_collection_t *collection)
 Destroy metrics collection.

Detailed Description

Ring consensus metrics collection and wire protocol implementation.

Definition in file metrics.c.

Macro Definition Documentation

◆ CONSENSUS_METRICS_INITIAL_CAPACITY

#define CONSENSUS_METRICS_INITIAL_CAPACITY   10

Definition at line 7 of file metrics.c.

Referenced by consensus_metrics_collection_create().

Typedef Documentation

◆ consensus_metrics_collection_t

Growable collection of participant-quality measurements. metrics, count, and capacity form the pointer/length/capacity trio; the consensus owner grows and frees the array, while readers use it only during its valid snapshot window.

Opaque metrics collection handle.

Metrics collection structure for participant quality measurements

Dynamic array storing network quality metrics for all participants in a consensus session.

Function Documentation

◆ consensus_metrics_collection_add()

asciichat_error_t consensus_metrics_collection_add ( consensus_metrics_collection_t * collection,
const participant_metrics_t * metrics )

Add metrics to collection.

Accumulates metrics from a participant into the collection. Metrics are stored in dynamically-allocated array.

Parameters
collectionCollection to add to
metricsMetrics to add
Returns
ASCIICHAT_OK on success, error code on failure

Definition at line 94 of file metrics.c.

94 {
95 if (!collection || !metrics) {
96 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters to collection_add");
97 }
98
99 // Resize if needed
100 if (collection->count >= collection->capacity) {
101 int new_capacity = collection->capacity * 2;
102 participant_metrics_t *new_metrics = SAFE_MALLOC(new_capacity * sizeof(participant_metrics_t), participant_metrics_t *);
103
104 if (!new_metrics) {
105 return SET_ERRNO(ERROR_MEMORY, "Failed to allocate metrics array");
106 }
107
108 // Copy existing metrics
109 if (collection->count > 0 && collection->metrics) {
110 memcpy(new_metrics, collection->metrics, collection->count * sizeof(participant_metrics_t));
111 SAFE_FREE(collection->metrics);
112 }
113
114 collection->metrics = new_metrics;
115 collection->capacity = new_capacity;
116 }
117
118 // Add new metrics
119 if (!collection->metrics) {
120 return SET_ERRNO(ERROR_MEMORY, "Collection metrics array is NULL");
121 }
122
123 memcpy(&collection->metrics[collection->count], metrics, sizeof(*metrics));
124 collection->count++;
125
126 return ASCIICHAT_OK;
127}
#define SET_ERRNO(code,...)
#define SAFE_FREE(ptr)
#define SAFE_MALLOC(size, cast)
@ ERROR_MEMORY
Definition error_codes.h:55
@ ASCIICHAT_OK
Definition error_codes.h:50
@ ERROR_INVALID_PARAM
participant_metrics_t * metrics
Array of participant metrics.
Definition metrics.c:28
int count
Number of participants.
Definition metrics.c:29
int capacity
Allocated capacity.
Definition metrics.c:30

References ASCIICHAT_OK, consensus_metrics_collection::capacity, consensus_metrics_collection::count, ERROR_INVALID_PARAM, ERROR_MEMORY, consensus_metrics_collection::metrics, SAFE_FREE, SAFE_MALLOC, and SET_ERRNO.

◆ consensus_metrics_collection_create()

asciichat_error_t consensus_metrics_collection_create ( consensus_metrics_collection_t ** out_collection)

Create empty metrics collection.

Allocates a collection structure for accumulating metrics from multiple participants during a collection round.

Parameters
out_collectionOutput collection handle
Returns
ASCIICHAT_OK on success, error code on failure
Note
Must be freed with consensus_metrics_destroy()

Definition at line 78 of file metrics.c.

78 {
79 if (!out_collection) {
80 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid output parameter");
81 }
82
84 memset(collection, 0, sizeof(*collection));
85
86 collection->capacity = CONSENSUS_METRICS_INITIAL_CAPACITY; // Start with capacity for 10 participants
87 collection->metrics = SAFE_MALLOC(collection->capacity * sizeof(participant_metrics_t), participant_metrics_t *);
88 collection->count = 0;
89
90 *out_collection = collection;
91 return ASCIICHAT_OK;
92}
struct consensus_metrics_collection consensus_metrics_collection_t
Growable collection of participant-quality measurements. metrics, count, and capacity form the pointe...
#define CONSENSUS_METRICS_INITIAL_CAPACITY
Definition metrics.c:7

References ASCIICHAT_OK, consensus_metrics_collection::capacity, CONSENSUS_METRICS_INITIAL_CAPACITY, consensus_metrics_collection::count, ERROR_INVALID_PARAM, consensus_metrics_collection::metrics, SAFE_MALLOC, and SET_ERRNO.

◆ consensus_metrics_collection_destroy()

void consensus_metrics_collection_destroy ( consensus_metrics_collection_t * collection)

Destroy metrics collection.

Frees all allocated memory in the collection, including the metrics array.

Parameters
collectionCollection to destroy (can be NULL)

Definition at line 140 of file metrics.c.

140 {
141 if (!collection) {
142 return;
143 }
144
145 if (collection->metrics) {
146 SAFE_FREE(collection->metrics);
147 }
148
149 SAFE_FREE(collection);
150}

References consensus_metrics_collection::metrics, and SAFE_FREE.

◆ consensus_metrics_collection_get()

asciichat_error_t consensus_metrics_collection_get ( const consensus_metrics_collection_t * collection,
const participant_metrics_t ** out_metrics,
int * out_count )

Get all accumulated metrics.

Retrieves the accumulated metrics array from collection.

Parameters
collectionCollection to query
out_metricsPointer to receive metrics array (not copied, owned by collection)
out_countPointer to receive number of metrics
Returns
ASCIICHAT_OK on success, error code on failure
Note
out_metrics points to internal collection storage - do not modify or free
Valid only until collection is destroyed

Definition at line 129 of file metrics.c.

129 {
130 if (!collection || !out_metrics || !out_count) {
131 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters to collection_get");
132 }
133
134 *out_metrics = collection->metrics;
135 *out_count = collection->count;
136
137 return ASCIICHAT_OK;
138}

References ASCIICHAT_OK, consensus_metrics_collection::count, ERROR_INVALID_PARAM, consensus_metrics_collection::metrics, and SET_ERRNO.

◆ consensus_metrics_from_wire()

asciichat_error_t consensus_metrics_from_wire ( const participant_metrics_t * wire_metrics,
participant_metrics_t * out_metrics )

Deserialize metrics from wire format.

Converts network byte order values back to host byte order. Inverse operation of consensus_metrics_to_wire().

Parameters
wire_metricsInput metrics in network byte order
out_metricsOutput metrics in host byte order
Returns
ASCIICHAT_OK on success, error code on failure
Note
out_metrics must point to valid participant_metrics_t allocated by caller

Definition at line 60 of file metrics.c.

60 {
61 if (!wire_metrics || !out_metrics) {
62 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters");
63 }
64
65 // Copy entire structure first
66 memcpy(out_metrics, wire_metrics, sizeof(*out_metrics));
67
68 // Convert multi-byte fields from network byte order
69 out_metrics->upload_kbps = endian_unpack_u32(wire_metrics->upload_kbps);
70 out_metrics->rtt_ns = endian_unpack_u32(wire_metrics->rtt_ns);
71 out_metrics->public_port = endian_unpack_u16(wire_metrics->public_port);
72 out_metrics->measurement_time_ns = endian_unpack_u64(wire_metrics->measurement_time_ns);
73 out_metrics->measurement_window_ns = endian_unpack_u64(wire_metrics->measurement_window_ns);
74
75 return ASCIICHAT_OK;
76}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, and SET_ERRNO.

◆ consensus_metrics_measure()

asciichat_error_t consensus_metrics_measure ( const uint8_t my_id[SESSION_ID_SIZE],
participant_metrics_t * out_metrics )

Measure participant network quality metrics.

Collects all metrics needed for host selection:

  • NAT tier from detected NAT type (0-4)
  • Session-supplied measured bandwidth
  • Matched-probe RTT when available
  • STUN probe success rate by sending 10 probes

Without a session provider this returns ERROR_INVALID_STATE with an empty observation. Missing data must not be scored as a favorable default.

Parameters
my_idParticipant UUID (16 bytes)
out_metricsOutput metrics structure (caller-allocated)
Returns
ASCIICHAT_OK on success, error code on failure
Note
out_metrics must point to valid participant_metrics_t allocated by caller
Measurement window and timestamp are set automatically

Definition at line 33 of file metrics.c.

33 {
34 if (!my_id || !out_metrics)
35 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid measurement parameters");
36 memset(out_metrics, 0, sizeof(*out_metrics));
37 memcpy(out_metrics->participant_id, my_id, SESSION_ID_SIZE);
38 out_metrics->nat_tier = 4;
39 return SET_ERRNO(ERROR_INVALID_STATE, "Network measurements require a session measurement provider");
40}
@ ERROR_INVALID_STATE
#define SESSION_ID_SIZE

References ERROR_INVALID_PARAM, ERROR_INVALID_STATE, SESSION_ID_SIZE, and SET_ERRNO.

◆ consensus_metrics_to_wire()

asciichat_error_t consensus_metrics_to_wire ( const participant_metrics_t * metrics,
participant_metrics_t * out_wire )

Serialize metrics to wire format with network byte order.

Converts host-order values to network byte order (big-endian) for transmission over the network. Multi-byte fields are converted:

Parameters
metricsInput metrics in host byte order
out_wireOutput metrics in network byte order
Returns
ASCIICHAT_OK on success, error code on failure
Note
out_wire must point to valid participant_metrics_t allocated by caller

Definition at line 42 of file metrics.c.

42 {
43 if (!metrics || !out_wire) {
44 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid parameters");
45 }
46
47 // Copy entire structure first
48 memcpy(out_wire, metrics, sizeof(*out_wire));
49
50 // Convert multi-byte fields to network byte order
51 out_wire->upload_kbps = endian_pack_u32(metrics->upload_kbps);
52 out_wire->rtt_ns = endian_pack_u32(metrics->rtt_ns);
53 out_wire->public_port = endian_pack_u16(metrics->public_port);
54 out_wire->measurement_time_ns = endian_pack_u64(metrics->measurement_time_ns);
55 out_wire->measurement_window_ns = endian_pack_u64(metrics->measurement_window_ns);
56
57 return ASCIICHAT_OK;
58}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, and SET_ERRNO.