sbin/fsck_msdosfs/ext.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (C) 1995, 1996, 1997 Wolfgang Solfrank
   5  * Copyright (c) 1995 Martin Husemann
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *      $NetBSD: ext.h,v 1.6 2000/04/25 23:02:51 jdolecek Exp $
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef EXT_H
  31 #define EXT_H
  32
  33 #include <sys/types.h>
  34
  35 #include <stdbool.h>
  36
  37 #include "dosfs.h"
  38
  39 #define LOSTDIR "LOST.DIR"
  40
  41 /*
  42  * Options:
  43  */
  44 extern int alwaysno;    /* assume "no" for all questions */
  45 extern int alwaysyes;   /* assume "yes" for all questions */
  46 extern int preen;       /* we are preening */
  47 extern int rdonly;      /* device is opened read only (supersedes above) */
  48 extern int skipclean;   /* skip clean file systems if preening */
  49 extern int allow_mmap;  /* allow the use of mmap() */
  50
  51 /*
  52  * function declarations
  53  */
  54 int ask(int, const char *, ...) __printflike(2, 3);
  55
  56 /*
  57  * Check the dirty flag.  If the file system is clean, then return 1.
  58  * Otherwise, return 0 (this includes the case of FAT12 file systems --
  59  * they have no dirty flag, so they must be assumed to be unclean).
  60  */
  61 int checkdirty(int, struct bootblock *);
  62
  63 /*
  64  * Check file system given as arg
  65  */
  66 int checkfilesys(const char *);
  67
  68 /*
  69  * Return values of various functions
  70  */
  71 #define FSOK            0               /* Check was OK */
  72 #define FSBOOTMOD       1               /* Boot block was modified */
  73 #define FSDIRMOD        2               /* Some directory was modified */
  74 #define FSFATMOD        4               /* The FAT was modified */
  75 #define FSERROR         8               /* Some unrecovered error remains */
  76 #define FSFATAL         16              /* Some unrecoverable error occurred */
  77 #define FSDIRTY         32              /* File system is dirty */
  78
  79 /*
  80  * read a boot block in a machine independent fashion and translate
  81  * it into our struct bootblock.
  82  */
  83 int readboot(int, struct bootblock *);
  84
  85 /*
  86  * Correct the FSInfo block.
  87  */
  88 int writefsinfo(int, struct bootblock *);
  89
  90 /* Opaque type */
  91 struct fat_descriptor;
  92
  93 void fat_clear_cl_head(struct fat_descriptor *, cl_t);
  94 bool fat_is_cl_head(struct fat_descriptor *, cl_t);
  95
  96 cl_t fat_get_cl_next(struct fat_descriptor *, cl_t);
  97
  98 int fat_set_cl_next(struct fat_descriptor *, cl_t, cl_t);
  99
 100 cl_t fat_allocate_cluster(struct fat_descriptor *fat);
 101
 102 struct bootblock* fat_get_boot(struct fat_descriptor *);
 103 int fat_get_fd(struct fat_descriptor *);
 104 bool fat_is_valid_cl(struct fat_descriptor *, cl_t);
 105
 106 /*
 107  * Read the FAT 0 and return a pointer to the newly allocated
 108  * descriptor of it.
 109  */
 110 int readfat(int, struct bootblock *, struct fat_descriptor **);
 111
 112 /*
 113  * Write back FAT entries
 114  */
 115 int writefat(struct fat_descriptor *);
 116
 117 /*
 118  * Read a directory
 119  */
 120 int resetDosDirSection(struct fat_descriptor *);
 121 void finishDosDirSection(void);
 122 int handleDirTree(struct fat_descriptor *);
 123
 124 /*
 125  * Cross-check routines run after everything is completely in memory
 126  */
 127 int checkchain(struct fat_descriptor *, cl_t, size_t *);
 128
 129 /*
 130  * Check for lost cluster chains
 131  */
 132 int checklost(struct fat_descriptor *);
 133 /*
 134  * Try to reconnect a lost cluster chain
 135  */
 136 int reconnect(struct fat_descriptor *, cl_t, size_t);
 137 void finishlf(void);
 138
 139 /*
 140  * Small helper functions
 141  */
 142 /*
 143  * Return the type of a reserved cluster as text
 144  */
 145 const char *rsrvdcltype(cl_t);
 146
 147 /*
 148  * Clear a cluster chain in a FAT
 149  */
 150 void clearchain(struct fat_descriptor *, cl_t);
 151
 152 #endif