xref: /freebsd/sbin/fsck_msdosfs/ext.h (revision b9f654b163bce26de79705e77b872427c9f2afa1)
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 "dosfs.h"
36 
37 #define	LOSTDIR	"LOST.DIR"
38 
39 /*
40  * Options:
41  */
42 extern int alwaysno;	/* assume "no" for all questions */
43 extern int alwaysyes;	/* assume "yes" for all questions */
44 extern int preen;	/* we are preening */
45 extern int rdonly;	/* device is opened read only (supersedes above) */
46 extern int skipclean;	/* skip clean file systems if preening */
47 
48 /*
49  * function declarations
50  */
51 int ask(int, const char *, ...) __printflike(2, 3);
52 
53 /*
54  * Check the dirty flag.  If the file system is clean, then return 1.
55  * Otherwise, return 0 (this includes the case of FAT12 file systems --
56  * they have no dirty flag, so they must be assumed to be unclean).
57  */
58 int checkdirty(int, struct bootblock *);
59 
60 /*
61  * Check file system given as arg
62  */
63 int checkfilesys(const char *);
64 
65 /*
66  * Return values of various functions
67  */
68 #define	FSOK		0		/* Check was OK */
69 #define	FSBOOTMOD	1		/* Boot block was modified */
70 #define	FSDIRMOD	2		/* Some directory was modified */
71 #define	FSFATMOD	4		/* The FAT was modified */
72 #define	FSERROR		8		/* Some unrecovered error remains */
73 #define	FSFATAL		16		/* Some unrecoverable error occurred */
74 #define	FSDIRTY		32		/* File system is dirty */
75 #define	FSFIXFAT	64		/* Fix file system FAT */
76 
77 /*
78  * read a boot block in a machine independent fashion and translate
79  * it into our struct bootblock.
80  */
81 int readboot(int, struct bootblock *);
82 
83 /*
84  * Correct the FSInfo block.
85  */
86 int writefsinfo(int, struct bootblock *);
87 
88 /*
89  * Read one of the FAT copies and return a pointer to the new
90  * allocated array holding our description of it.
91  */
92 int readfat(int, struct bootblock *, u_int, struct fatEntry **);
93 
94 /*
95  * Check two FAT copies for consistency and merge changes into the
96  * first if necessary.
97  */
98 int comparefat(struct bootblock *, struct fatEntry *, struct fatEntry *, u_int);
99 
100 /*
101  * Check a FAT
102  */
103 int checkfat(struct bootblock *, struct fatEntry *);
104 
105 /*
106  * Write back FAT entries
107  */
108 int writefat(int, struct bootblock *, struct fatEntry *, int);
109 
110 /*
111  * Read a directory
112  */
113 int resetDosDirSection(struct bootblock *, struct fatEntry *);
114 void finishDosDirSection(void);
115 int handleDirTree(int, struct bootblock *, struct fatEntry *);
116 
117 /*
118  * Cross-check routines run after everything is completely in memory
119  */
120 /*
121  * Check for lost cluster chains
122  */
123 int checklost(int, struct bootblock *, struct fatEntry *);
124 /*
125  * Try to reconnect a lost cluster chain
126  */
127 int reconnect(int, struct bootblock *, struct fatEntry *, cl_t);
128 void finishlf(void);
129 
130 /*
131  * Small helper functions
132  */
133 /*
134  * Return the type of a reserved cluster as text
135  */
136 const char *rsrvdcltype(cl_t);
137 
138 /*
139  * Clear a cluster chain in a FAT
140  */
141 void clearchain(struct bootblock *, struct fatEntry *, cl_t);
142 
143 #endif
144