workbench/devs/afs/validator.h

   1 /*
   2          Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3          $Id: validator.h 25683 2007-04-09 05:45:37Z sonic $
   4 */
   5
   6 /*
   7  * -date------ -name------------------- -description-----------------------------
   8  * 02-jan-2008 [Tomasz Wiszkowski]      created disk validation procedures
   9  * 04-jan-2008 [Tomasz Wiszkowski]      corrected tabulation
  10  * 07-jan-2008 [Tomasz Wiszkowski]      partitioned procedures to prepare non-recursive scan
  11  */
  12
  13 #ifndef VALIDATOR_H
  14 #define VALIDATOR_H
  15
  16 #include "os.h"
  17
  18 /*
  19  * call this function to initiate validation
  20  */
  21 LONG launchValidator(struct AFSBase *afsbase, struct Volume *volume);
  22 LONG checkValid(struct AFSBase *afs, struct Volume *vol);
  23
  24 #ifdef __AROS__
  25
  26 /********************************************************
  27  * structures
  28  ********************************************************/
  29 typedef struct
  30 {
  31         struct AFSBase            *afs;
  32         struct Volume             *vol;
  33         void*                      bitmap;
  34         LONG                       flags;
  35         ULONG                     *bm_blocks;
  36         LONG                       bm_lastblk;
  37         ULONG                     *bme_blocks;
  38         LONG                       bme_lastblk;
  39
  40         /* elements regarding to currently validated file */
  41         ULONG                      max_file_len;
  42    ULONG                      file_blocks;
  43 } DiskStructure;
  44
  45
  46 /********************************************************
  47  * enums
  48  ********************************************************/
  49 typedef enum
  50 {
  51         vr_OK,
  52         vr_NoAccess,
  53         vr_ReadError,
  54         vr_UnknownDiskType,
  55         vr_InvalidChksum,
  56         vr_StructureDamaged,
  57         vr_OutOfMemory,
  58         vr_BlockUsedTwice,
  59         vr_Aborted,
  60         vr_BlockOutsideDisk,
  61 } ValidationResult;
  62
  63 typedef enum
  64 {
  65         st_OK,
  66         st_AlreadyInUse,
  67         st_OutOfRange
  68 } BitmapResult;
  69
  70 typedef enum
  71 {
  72         ValFlg_DisableReq_MaybeNotAFS      = 1,  /* consider these FLAGS */
  73         ValFlg_DisableReq_DataLossImminent = 2,  /* next value = 4       */
  74 } ValidationFlags;
  75
  76 /*
  77  * validation entry point for new process
  78  */
  79 LONG validate(struct AFSBase*, struct Volume*);
  80
  81 /*
  82  * initiate validation once structures are initially ready.
  83  * walks through all structures and collects used blocks
  84  */
  85 ValidationResult start_superblock(DiskStructure *ds);
  86
  87 /*
  88  * verifies checksum.
  89  * returns 0 if checksum is ok, otherwise a new checksum.
  90  * a new checksum is recorded to the structure automatically,
  91  * just not recorded
  92  */
  93 ULONG verify_checksum(DiskStructure *ds, ULONG* block);
  94 ULONG verify_bm_checksum(DiskStructure *ds, ULONG* block);
  95
  96 /*
  97  * various per-block operations:
  98  * - check_block does the most generic checks (checksum, block type, range and stuff like that)
  99  * - collect_bitmap is called with root block where we begin root block acquisition - nonrecursive
 100  */
 101 ValidationResult check_block(DiskStructure* ds, struct BlockCache* block);
 102 ValidationResult collect_bitmap(DiskStructure* ds, struct BlockCache* block);
 103 ValidationResult collect_file_extensions(DiskStructure* ds, struct BlockCache* block);
 104
 105 /*
 106  * collect all bitmap blocks, starting with first extension block
 107  * all root blocks are already collected
 108  */
 109 ValidationResult collect_directory_blocks(DiskStructure *ds, ULONG ext);
 110
 111 /*
 112  * record bitmap back to disk
 113  */
 114 void record_bitmap(DiskStructure* ds);
 115
 116 /*
 117  * call to allocate bitmap in disk structure.
 118  * returns 0 if all went ok, otherwise other value
 119  * (just in case someone needed error handling here)
 120  */
 121 LONG bm_allocate_bitmap(DiskStructure *ds);
 122 void bm_free_bitmap(DiskStructure *ds);
 123
 124 /*
 125  * bitmap operations ;]
 126  */
 127 BitmapResult bm_mark_block(DiskStructure *ds, ULONG block);
 128
 129 /*
 130  *
 131  */
 132 void bm_add_bitmap_block(DiskStructure *ds, ULONG blk);
 133 void bm_add_bitmap_extension_block(DiskStructure *ds, ULONG blk);
 134
 135 #endif /* __AROS__ */
 136 #endif /* VALIDATOR_H */