sense_trace.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdatomic.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "sense_sched.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SENSE_TRACE_FORMAT       3u
#define SENSE_TRACE_LINE_MAX    64u
#define SENSE_TRACE_PRE         64u
#define SENSE_TRACE_EDGE_MS   4000u
#define SENSE_TRACE_KEY_MS   10000u
#define SENSE_TRACE_HOLD_MS     50u
#define SENSE_TRACE_STALL_MS   100u
#define SENSE_TRACE_SLOTS        8u
#define SENSE_TRACE_MARKS        8u
#define SENSE_TRACE_T_PER_MS    10u
#define SENSE_TRACE_PERIOD_US 1000u
#define SENSE_TRACE_LOST_MAX  0xFFFFFFu
#define SENSE_TRACE_OWED_MAX_T (1u << 30)

typedef enum {
    SENSE_TRACE_CURRENT = 0,  
    SENSE_TRACE_BUS,          
    SENSE_TRACE_CLIP_HI,      
    SENSE_TRACE_CLIP_LO,      
    SENSE_TRACE_CFG,          
    SENSE_TRACE_SHUNT,        
} sense_trace_kind_t;

typedef enum {
    SENSE_TRACE_TRIG_CMD = 0,
    SENSE_TRACE_TRIG_EDGE,
    SENSE_TRACE_TRIG_KEY,
    SENSE_TRACE_MARK_DEST,    
    SENSE_TRACE_MARK_STEP,    
} sense_trace_trig_t;

typedef enum {
    SENSE_TRACE_END_NONE = 0,
    SENSE_TRACE_END_TIME,
    SENSE_TRACE_END_SETUP,
    SENSE_TRACE_END_KEY,
} sense_trace_end_t;

typedef struct {
    uint32_t t;      
    int32_t  v;      
    uint32_t meta;   
} sense_trace_rec_t;

typedef struct {
    bool     have;        
    uint8_t  head;        
    uint32_t t;           
    uint64_t win;         
    uint32_t gen;         
    uint16_t n_v;         
    uint16_t n_hi,                          
             n_lo;                          
    int64_t  v_sum;       
    uint32_t lost;        
    uint32_t dropped;     
    uint32_t lost_after;  
    uint32_t cfg,                           
             shunt;                         
    bool     cfg_owed;    
    bool     shunt_owed;                
    uint32_t cfg_t,                         
             shunt_t;                       
    bool cfg_newer,                         
         shunt_newer;                       
    uint32_t kept_t;      
} sense_trace_src_t;

typedef struct {
    uint8_t  kind;        
    uint32_t t;                         
    uint64_t at_us;       
    uint16_t ch,                            
             us;                            
    uint32_t cmd_t;       
} sense_trace_mark_t;

typedef struct {
    bool     have;        
    uint16_t ch;          
    bool     changed;     
    bool     slewed;      
    bool     orphan;      
    uint16_t pulse;                     
    uint32_t changed_t;   
    uint32_t cmd_t;       
} sense_trace_watch_t;

typedef enum {
    SENSE_TRACE_IDLE = 0,
    SENSE_TRACE_HEAD_T,   
    SENSE_TRACE_HEAD_H,   
    SENSE_TRACE_BODY,
} sense_trace_stage_t;

typedef struct {
    sense_trace_stage_t stage;
    uint16_t id;          
    uint8_t  trig;        
    uint32_t t0,                            
             ms0,                           
             len_ms;                        
    uint32_t end_t;       
    uint32_t last_t;      
    bool     stopped;     
    bool     stalled;     
    uint32_t cfg,                           
             shunt;                         
    bool     lost_shown;  
    uint32_t drops_seen;  
    uint32_t ahead;       
    uint32_t n_s,                           
             n_v,                           
             n_m,                           
             n_lost,                        
             n_mlost;                       
    uint32_t mlost_t[2];  
    sense_trace_mark_t q[SENSE_TRACE_MARKS];  
    uint8_t q_n,                            
            q_head;                         
    /* Triggers at or past the end of a trace still being written, and
     * behind a slewed command among them its last change or its end. */
    sense_trace_mark_t wait[SENSE_TRACE_MARKS];
    uint8_t  wait_n;
    uint32_t wait_lost;   
    uint32_t wait_lost_t[2]; 
    uint32_t abandoned;   
    uint32_t scanned;     
    sense_trace_watch_t watch[SENSE_TRACE_SLOTS];
} sense_trace_out_t;

typedef struct {
    sense_trace_rec_t *buf;
    uint32_t          mask;       
    atomic_uint_fast32_t head;    
    atomic_uint_fast32_t tail;    
    atomic_uint_fast32_t drops;   
    atomic_uint_fast32_t fed;     
    sense_trace_src_t src;        
    sense_trace_out_t out;        
} sense_trace_t;

bool sense_trace_init(sense_trace_t *tr, sense_trace_rec_t *buf,
                      uint32_t size);

void sense_trace_feed(sense_trace_t *tr, const sense_sched_t *s,
                      uint64_t tick_us);

void sense_trace_trigger(sense_trace_t *tr, sense_trace_trig_t kind,
                         uint64_t at_us, uint16_t ch, uint16_t us);

uint16_t sense_trace_rendered(uint16_t pulse_us, uint32_t top);

bool sense_trace_pulse(sense_trace_t *tr, unsigned slot, uint16_t ch,
                       uint16_t pulse_us, uint64_t now_us);

void sense_trace_unwatch(sense_trace_t *tr, unsigned slot);

void sense_trace_key(sense_trace_t *tr, int c, uint64_t now_us);

size_t sense_trace_pump(sense_trace_t *tr, uint64_t now_us, bool connected,
                        char *out, size_t room);

bool sense_trace_active(const sense_trace_t *tr);

uint32_t sense_trace_held(const sense_trace_t *tr);

int32_t sense_trace_code(int32_t ua, uint32_t shunt_uohm);
 
#ifdef __cplusplus
}
#endif