msg-decoder.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache 2.0
/*
 * msg-decoder.h - NexusRV Message decoder functions and declarations
 *
 *  Copyright (C) 2025, Bo Gan <ganboing@gmail.com>
 */
 
#ifndef LIBNEXUS_RV_MSG_DECODER_H
#define LIBNEXUS_RV_MSG_DECODER_H
 
#include "msg-types.h"
#include <stddef.h>
#include <stdio.h>
#include <stdbool.h>
#include <string.h>
#include <unistd.h>
typedef struct nexusrv_hw_cfg {
    unsigned src_bits;    
    unsigned ts_bits;     
    unsigned addr_bits;   
    unsigned max_stack;   
    uint64_t timer_freq;  
    bool HTM;             
    bool VAO;             
    bool quirk_sifive;    
} nexusrv_hw_cfg;
 
typedef struct nexusrv_msg_decoder {
    const nexusrv_hw_cfg *hw_cfg;
    int fd;             
    int16_t src_filter; 
    void *buffer;       
    size_t bufsz;       
    size_t nread;       
    size_t filled;      
    size_t pos;         
    size_t lastmsg_len; 
} nexusrv_msg_decoder;
 
int nexusrv_hwcfg_parse(nexusrv_hw_cfg *hwcfg,
                        const char *str);
 
#define NEXUS_RV_MSG_MAX_BYTES 38
 
ssize_t nexusrv_sync_forward(const uint8_t *buffer, size_t limit);
 
ssize_t nexusrv_sync_backward(const uint8_t *buffer, size_t pos);
 
ssize_t nexusrv_msg_decode(const nexusrv_hw_cfg *hwcfg,
                           const uint8_t *buffer, size_t limit,
                           nexusrv_msg *msg);
 
static inline void nexusrv_msg_decoder_init(nexusrv_msg_decoder *decoder,
                                            const nexusrv_hw_cfg *hwcfg,
                                            int fd, int16_t src_filter,
                                            uint8_t *buffer,
                                            size_t bufsz) {
    memset(decoder, 0, sizeof(*decoder));
    decoder->hw_cfg = hwcfg;
    decoder->fd = fd;
    decoder->src_filter = src_filter;
    decoder->buffer = buffer;
    decoder->bufsz = bufsz;
}
 
static inline size_t nexusrv_msg_decoder_offset(nexusrv_msg_decoder *decoder) {
    size_t offset = decoder->nread;
    if (decoder->pos != decoder->bufsz)
        offset += decoder->pos;
    return offset - decoder->lastmsg_len;
}
 
ssize_t nexusrv_msg_decoder_next(nexusrv_msg_decoder *decoder,
                                 nexusrv_msg *msg);
 
uint8_t *nexusrv_msg_decoder_lastmsg(nexusrv_msg_decoder *decoder);
 
void nexusrv_msg_decoder_rewind_last(nexusrv_msg_decoder *decoder);
 
int nexusrv_print_msg(FILE *fp, const nexusrv_msg *msg);
 
#endif