xref: /dragonfly/sbin/fsck_msdosfs/ext.h (revision 1a05b9d1)
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 allow_mmap;  /* allow the use of mmap() */
49 
50 /*
51  * function declarations
52  */
53 int ask(int, const char *, ...) __printflike(2, 3);
54 
55 /*
56  * Check file system given as arg
57  */
58 int checkfilesys(const char *);
59 
60 /*
61  * Return values of various functions
62  */
63 #define	FSOK		0		/* Check was OK */
64 #define	FSBOOTMOD	1		/* Boot block was modified */
65 #define	FSDIRMOD	2		/* Some directory was modified */
66 #define	FSFATMOD	4		/* The FAT was modified */
67 #define	FSERROR		8		/* Some unrecovered error remains */
68 #define	FSFATAL		16		/* Some unrecoverable error occurred */
69 #define	FSDIRTY		32		/* File system is dirty */
70 
71 /*
72  * read a boot block in a machine independent fashion and translate
73  * it into our struct bootblock.
74  */
75 int readboot(int, struct bootblock *);
76 
77 /*
78  * Correct the FSInfo block.
79  */
80 int writefsinfo(int, struct bootblock *);
81 
82 /* Opaque type */
83 struct fat_descriptor;
84 
85 void fat_clear_cl_head(struct fat_descriptor *, cl_t);
86 bool fat_is_cl_head(struct fat_descriptor *, cl_t);
87 
88 cl_t fat_get_cl_next(struct fat_descriptor *, cl_t);
89 
90 int fat_set_cl_next(struct fat_descriptor *, cl_t, cl_t);
91 
92 cl_t fat_allocate_cluster(struct fat_descriptor *fat);
93 
94 struct bootblock* fat_get_boot(struct fat_descriptor *);
95 int fat_get_fd(struct fat_descriptor *);
96 bool fat_is_valid_cl(struct fat_descriptor *, cl_t);
97 
98 /*
99  * Read the FAT 0 and return a pointer to the newly allocated
100  * descriptor of it.
101  */
102 int readfat(int, struct bootblock *, struct fat_descriptor **);
103 
104 /*
105  * Write back FAT entries
106  */
107 int writefat(struct fat_descriptor *);
108 
109 /*
110  * Read a directory
111  */
112 int resetDosDirSection(struct fat_descriptor *);
113 void finishDosDirSection(void);
114 int handleDirTree(struct fat_descriptor *);
115 
116 /*
117  * Cross-check routines run after everything is completely in memory
118  */
119 int checkchain(struct fat_descriptor *, cl_t, size_t *);
120 
121 /*
122  * Check for lost cluster chains
123  */
124 int checklost(struct fat_descriptor *);
125 /*
126  * Try to reconnect a lost cluster chain
127  */
128 int reconnect(struct fat_descriptor *, cl_t, size_t);
129 void finishlf(void);
130 
131 /*
132  * Small helper functions
133  */
134 /*
135  * Return the type of a reserved cluster as text
136  */
137 const char *rsrvdcltype(cl_t);
138 
139 /*
140  * Clear a cluster chain in a FAT
141  */
142 void clearchain(struct fat_descriptor *, cl_t);
143 
144 #endif
145