ra8_fs_check.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_fs.h"
 
/* =============================================================================
 * Sentinels
 * =============================================================================
 */

typedef enum : uint32_t {
  k_ra8_fs_check_unknown =
    0xFFFFFFFFU, 
} ra8_fs_check_const_t;
 
/* =============================================================================
 * Fault categories
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_fs_check_fault_none             = 0,  
  k_ra8_fs_check_fault_bad_fat_value    = 1,  
  k_ra8_fs_check_fault_crosslink        = 2,  
  k_ra8_fs_check_fault_lost_cluster     = 3,  
  k_ra8_fs_check_fault_bad_chain        = 4,  
  k_ra8_fs_check_fault_bad_dir_entry    = 5,  
  k_ra8_fs_check_fault_bad_set_checksum = 6,  
  k_ra8_fs_check_fault_bad_name_hash    = 7,  
  k_ra8_fs_check_fault_bitmap_ref_unset = 8,  
  k_ra8_fs_check_fault_free_count_bad   = 9,  
  k_ra8_fs_check_fault_scan_truncated   = 10, 
} ra8_fs_check_fault_kind_t;

typedef struct {
  ra8_fs_check_fault_kind_t kind;      
  uint32_t                  cluster;   
  uint64_t                  lba;       
  uint32_t                  entry_off; 
} ra8_fs_check_fault_t;
 
/* =============================================================================
 * Report
 * =============================================================================
 */

typedef struct {
  ra8_fs_type_t type;            
  bool          referenced_scan; 
  uint32_t      clusters_total;  
  uint32_t      clusters_free;   
  uint32_t      clusters_used;   
  uint32_t      clusters_bad;    
  uint32_t      clusters_lost;   
  uint32_t      chains_crosslinked; 
  uint32_t      bitmap_mismatches;  
  uint32_t      entries_bad;        
  uint32_t      dirs_visited;       
  uint32_t      files_visited;      
  uint32_t      faults_total;       
  ra8_fs_check_fault_t first_fault; 
} ra8_fs_check_report_t;
 
/* =============================================================================
 * Public API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_fs_check(ra8_fs_mount_t*        handle,
                                     uint8_t*               bitmap,
                                     uint32_t               bitmap_bytes,
                                     ra8_fs_check_report_t* report);
 
#ifdef __cplusplus
}
#endif