vud.h

Go to the documentation of this file.

/* vud.h - vpim userspace driver */
 
#ifndef ROUTER_VUD_H
#define ROUTER_VUD_H
 
#include "vud_pool.h"
 
#include <stddef.h>
#include <stdint.h>
 
#define VUD_ALLOC_ANY -1
 
typedef enum vud_error {
    VUD_OK,
    VUD_RANK_BUSY,
    VUD_NOT_FOUND,
    VUD_MEMORY_ERR,
    VUD_SYSTEM_ERR,
    VUD_CI_TIMEOUT,
    VUD_INVALID_RES,
    VUD_EXPECTED_FAULT,
    VUD_SK_NOT_FOUND,
    VUD_SK_TAG,
    VUD_NOT_WAITING,
    VUD_SYMBOL_NOT_FOUND,
    VUD_SYMBOL_NOT_MRAM,
    VUD_SYSTEM_THREAD,
    VUD_KEY_XCHG,
} vud_error;
 
typedef struct vud_rank {
    volatile void* base;
    int fd;
    vud_error err;
    uint8_t key[32];
    const char* next_sk;
    vud_pool* pool;
} vud_rank;
 
vud_rank vud_rank_alloc(int rank_nr);
 
void vud_rank_free(vud_rank* rank);
 
void vud_rank_nr_workers(vud_rank* rank, unsigned n);
 
uint8_t vud_rank_qry_mux(vud_rank* rank);
 
void vud_rank_rel_mux(vud_rank* rank);
 
static inline const char* vud_error_str(vud_error err) {
    static const char* table[VUD_KEY_XCHG + 1] = {
        [VUD_OK] = "success",
        [VUD_RANK_BUSY] = "rank is busy",
        [VUD_NOT_FOUND] = "rank not found",
        [VUD_MEMORY_ERR] = "memory error (mmap)",
        [VUD_SYSTEM_ERR] = "system error (open)",
        [VUD_CI_TIMEOUT] = "ci access timed out",
        [VUD_INVALID_RES] = "invalid VCI response",
        [VUD_EXPECTED_FAULT] = "DPUs are not all in fault",
        [VUD_SK_NOT_FOUND] = "could not find requested subkernel",
        [VUD_SK_TAG] = "cannot encrypt and tag subkernel",
        [VUD_NOT_WAITING] = "DPU is not waiting for guest",
        [VUD_SYMBOL_NOT_FOUND] = "symbol could not be found",
        [VUD_SYMBOL_NOT_MRAM] = "symbol points to a non-MRAM region",
        [VUD_SYSTEM_THREAD] = "system error (threading)",
        [VUD_KEY_XCHG] = "key exchange failed",
    };
 
    if (err >= VUD_OK && err <= VUD_KEY_XCHG) {
        return table[err];
    }
 
    return "unknown error";
}
 
 
#endif