fw_if_fs_types.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint16_t {
  k_fw_fs_path_cap = 512U, 
} fw_fs_limits_t;

typedef enum : uint8_t {
  k_fw_fs_node_none      = 0U, 
  k_fw_fs_node_file      = 1U, 
  k_fw_fs_node_directory = 2U, 
  k_fw_fs_node_symlink   = 3U, 
  k_fw_fs_node_other     = 4U, 
} fw_fs_node_type_t;

typedef enum : uint8_t {
  k_fw_fs_open_read           = 0U, 
  k_fw_fs_open_write_truncate = 1U, 
  k_fw_fs_open_append         = 2U, 
  k_fw_fs_open_create_new     = 3U, 
} fw_fs_open_mode_t;

typedef enum : uint8_t {
  k_fw_fs_txn_create_new     = 0U, 
  k_fw_fs_txn_replace_atomic = 1U, 
} fw_fs_transaction_policy_t;

typedef enum : uint32_t {
  k_fw_fs_cap_namespace = 1UL << 0U,
  k_fw_fs_cap_stream = 1UL << 1U,
  k_fw_fs_cap_space_query = 1UL << 2U,
  k_fw_fs_cap_same_volume_rename = 1UL << 3U,
  k_fw_fs_cap_atomic_replace = 1UL << 4U,
  k_fw_fs_cap_atomic_noreplace = 1UL << 5U,
  k_fw_fs_cap_create_exclusive = 1UL << 6U,
  k_fw_fs_cap_file_sync = 1UL << 7U,
  k_fw_fs_cap_durable_file_sync = 1UL << 8U,
  k_fw_fs_cap_durable_directory_sync = 1UL << 9U,
  k_fw_fs_cap_transactions = 1UL << 10U,
  k_fw_fs_cap_symlinks = 1UL << 11U,
  k_fw_fs_cap_rejects_symlink_walk = 1UL << 12U,
  k_fw_fs_cap_case_sensitive = 1UL << 13U,
  k_fw_fs_cap_removable_media = 1UL << 14U,
  k_fw_fs_cap_thread_safe = 1UL << 15U,
  k_fw_fs_cap_created_time = 1UL << 16U,
  k_fw_fs_cap_modified_time = 1UL << 17U,
  k_fw_fs_cap_accessed_time = 1UL << 18U,
} fw_fs_capability_t;

typedef struct {
  uint64_t max_file_bytes;              
  uint32_t flags;                       
  uint32_t file_workspace_bytes;        
  uint32_t directory_workspace_bytes;   
  uint32_t transaction_workspace_bytes; 
  uint16_t path_max_bytes;              
  uint16_t name_max_bytes;              
  uint16_t max_open_files;              
  uint16_t max_open_directories;        
  uint8_t  file_workspace_align;        
  uint8_t  directory_workspace_align;   
  uint8_t  transaction_workspace_align; 
} fw_fs_caps_t;

typedef struct {
  uint32_t nanosecond;     
  uint16_t year;           
  int16_t  utc_offset_min; 
  uint8_t  month;          
  uint8_t  day;            
  uint8_t  hour;           
  uint8_t  minute;         
  uint8_t  second;         
} fw_fs_datetime_t;

typedef struct {
  fw_fs_datetime_t value;            
  bool             valid;            
  bool             utc_offset_valid; 
} fw_fs_timestamp_t;

typedef struct {
  uint64_t          size_bytes; 
  fw_fs_timestamp_t created;    
  fw_fs_timestamp_t modified;   
  fw_fs_timestamp_t accessed;   
  fw_fs_node_type_t type;       
  bool              exists;     
} fw_fs_stat_t;

typedef struct {
  const char*       name;       
  uint64_t          size_bytes; 
  uint16_t          name_bytes; 
  fw_fs_node_type_t type;       
} fw_fs_dirent_t;

typedef struct {
  char              name[k_fw_fs_path_cap]; 
  uint64_t          size_bytes;             
  uint16_t          name_bytes;             
  fw_fs_node_type_t type;                   
} fw_fs_dirent_value_t;

typedef struct {
  uint64_t total_bytes; 
  uint64_t free_bytes;  
  uint64_t used_bytes;  
} fw_fs_space_t;

typedef ra8_err_t (*fw_fs_list_fn_t)(void* ctx, const fw_fs_dirent_t* entry, bool* out_continue);
 
typedef struct fw_fs_namespace_iface   fw_fs_namespace_iface_t;
typedef struct fw_fs_stream_iface      fw_fs_stream_iface_t;
typedef struct fw_fs_transaction_iface fw_fs_transaction_iface_t;

typedef struct {
  const fw_fs_namespace_iface_t* iface; 
  void*                          ctx;   
  fw_fs_caps_t                   caps;  
} fw_fs_namespace_t;

typedef struct {
  const fw_fs_stream_iface_t* iface; 
  void*                       ctx;   
  fw_fs_caps_t                caps;  
} fw_fs_stream_port_t;

typedef struct {
  const fw_fs_transaction_iface_t* iface; 
  void*                            ctx;   
  fw_fs_caps_t                     caps;  
} fw_fs_transaction_port_t;

typedef struct {
  fw_fs_namespace_t        names;        
  fw_fs_stream_port_t      streams;      
  fw_fs_transaction_port_t transactions; 
  fw_fs_caps_t             caps;         
} fw_fs_t;

typedef struct {
  const fw_fs_stream_iface_t* iface;       
  void*                       ctx;         
  void*                       state;       
  uint32_t                    state_bytes; 
  bool                        is_open;     
} fw_fs_file_t;

typedef struct {
  const fw_fs_namespace_iface_t* iface;       
  void*                          ctx;         
  void*                          state;       
  uint32_t                       state_bytes; 
  fw_fs_caps_t                   caps;        
  bool                           is_open;     
} fw_fs_dir_t;

typedef struct {
  const fw_fs_transaction_iface_t* iface;       
  void*                            ctx;         
  void*                            state;       
  uint32_t                         state_bytes; 
  bool                             active;      
  bool                             validated;   
} fw_fs_transaction_t;

typedef ra8_err_t (*fw_fs_validate_fn_t)(void* ctx, fw_fs_file_t* staged);
 
#ifdef __cplusplus
}
#endif