mdl_storage.h

Go to the documentation of this file.

#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "fw_if_fs.h"
#include "ra8_err.h"

typedef enum : uint16_t {
  k_mdl_storage_io_bytes = 8192U, 
} mdl_storage_limit_t;

typedef struct {
  const fw_fs_t* fs;                          
  void*          file_workspace;              
  void*          transaction_workspace;       
  uint8_t*       io_buffer;                   
  uint32_t       file_workspace_bytes;        
  uint32_t       transaction_workspace_bytes; 
  uint32_t       io_buffer_bytes;             
} mdl_storage_t;

typedef struct {
  mdl_storage_t*      storage;     
  fw_fs_transaction_t transaction; 
  uint64_t            size_bytes;  
  uint64_t            hash;        
  uint32_t            write_calls; 
} mdl_storage_txn_t;

[[nodiscard]] ra8_err_t mdl_storage_init(mdl_storage_t* storage,
                                         const fw_fs_t* fs,
                                         void*          file_workspace,
                                         uint32_t       file_workspace_bytes,
                                         void*          transaction_workspace,
                                         uint32_t       transaction_workspace_bytes,
                                         uint8_t*       io_buffer,
                                         uint32_t       io_buffer_bytes);

[[nodiscard]] ra8_err_t
mdl_storage_copy_atomic(mdl_storage_t* storage, const char* source, const char* destination);

[[nodiscard]] ra8_err_t
mdl_storage_txn_begin(mdl_storage_txn_t* writer, mdl_storage_t* storage, const char* destination);

[[nodiscard]] ra8_err_t mdl_storage_txn_begin_new(mdl_storage_txn_t* writer,
                                                  mdl_storage_t*     storage,
                                                  const char*        destination);

[[nodiscard]] ra8_err_t
mdl_storage_txn_write(mdl_storage_txn_t* writer, const uint8_t* bytes, uint32_t length);

[[nodiscard]] ra8_err_t mdl_storage_txn_commit(mdl_storage_txn_t* writer);

[[nodiscard]] ra8_err_t mdl_storage_txn_abort(mdl_storage_txn_t* writer);