ext2fs.h revision a917d1ccf49605b3009f4e7225f00b81fc16100b
1/*
2 * ext2fs.h --- ext2fs
3 *
4 * Copyright (C) 1993, 1994, 1995, 1996 Theodore Ts'o.
5 *
6 * %Begin-Header%
7 * This file may be redistributed under the terms of the GNU Public
8 * License.
9 * %End-Header%
10 */
11
12#ifndef _EXT2FS_EXT2FS_H
13#define _EXT2FS_EXT2FS_H
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
19/*
20 * Non-GNU C compilers won't necessarily understand inline
21 */
22#if (!defined(__GNUC__) && !defined(__WATCOMC__))
23#define NO_INLINE_FUNCS
24#endif
25
26/*
27 * Where the master copy of the superblock is located, and how big
28 * superblocks are supposed to be.  We define SUPERBLOCK_SIZE because
29 * the size of the superblock structure is not necessarily trustworthy
30 * (some versions have the padding set up so that the superblock is
31 * 1032 bytes long).
32 */
33#define SUPERBLOCK_OFFSET	1024
34#define SUPERBLOCK_SIZE 	1024
35
36/*
37 * The last ext2fs revision level that this version of the library is
38 * able to support.
39 */
40#define EXT2_LIB_CURRENT_REV	0
41
42#ifdef HAVE_SYS_TYPES_H
43#include <sys/types.h>
44#endif
45
46#include <stdlib.h>
47
48#if EXT2_FLAT_INCLUDES
49#include "e2_types.h"
50#else
51#include <asm/types.h>
52#if !defined(__GNUC__) || defined(__STRICT_ANSI__)  /* asm/types.h already defines __s64 and __u64 otherwise */
53#if SIZEOF_LONG == 8
54typedef __signed__ long __s64;
55typedef unsigned long __u64;
56#elif SIZEOF_LONG_LONG == 8 || \
57  defined(__GNUC__) && (((~0UL) == 0xffffffff) || defined(__i386__))
58typedef __signed__ long long __s64;
59typedef unsigned long long __u64;
60#endif /* SIZEOF_LONG == 8 */
61#endif
62#endif /* EXT2_FLAT_INCLUDES */
63
64typedef __u32		blk_t;
65typedef __u32		dgrp_t;
66typedef __u32		ext2_off_t;
67typedef __s64		e2_blkcnt_t;
68
69#if EXT2_FLAT_INCLUDES
70#include "com_err.h"
71#include "ext2_io.h"
72#include "ext2_err.h"
73#else
74#include "et/com_err.h"
75#include "ext2fs/ext2_io.h"
76#include "ext2fs/ext2_err.h"
77#endif
78
79/*
80 * Portability help for Microsoft Visual C++
81 */
82#ifdef _MSC_VER
83#define EXT2_QSORT_TYPE int __cdecl
84#else
85#define EXT2_QSORT_TYPE int
86#endif
87
88typedef struct struct_ext2_filsys *ext2_filsys;
89
90struct ext2fs_struct_generic_bitmap {
91	errcode_t	magic;
92	ext2_filsys 	fs;
93	__u32		start, end;
94	__u32		real_end;
95	char	*	description;
96	char	*	bitmap;
97	errcode_t	base_error_code;
98	__u32		reserved[7];
99};
100
101#define EXT2FS_MARK_ERROR 	0
102#define EXT2FS_UNMARK_ERROR 	1
103#define EXT2FS_TEST_ERROR	2
104
105typedef struct ext2fs_struct_generic_bitmap *ext2fs_generic_bitmap;
106typedef struct ext2fs_struct_generic_bitmap *ext2fs_inode_bitmap;
107typedef struct ext2fs_struct_generic_bitmap *ext2fs_block_bitmap;
108
109#ifdef EXT2_DYNAMIC_REV
110#define EXT2_FIRST_INODE(s)	EXT2_FIRST_INO(s)
111#else
112#define EXT2_FIRST_INODE(s)	EXT2_FIRST_INO
113#define EXT2_INODE_SIZE(s)	sizeof(struct ext2_inode)
114#endif
115
116/*
117 * badblocks list definitions
118 */
119
120typedef struct ext2_struct_badblocks_list *ext2_badblocks_list;
121typedef struct ext2_struct_badblocks_iterate *ext2_badblocks_iterate;
122
123/* old */
124typedef struct ext2_struct_badblocks_list *badblocks_list;
125typedef struct ext2_struct_badblocks_iterate *badblocks_iterate;
126
127#define BADBLOCKS_FLAG_DIRTY	1
128
129/*
130 * ext2_dblist structure and abstractions (see dblist.c)
131 */
132struct ext2_db_entry {
133	ino_t	ino;
134	blk_t	blk;
135	int	blockcnt;
136};
137
138typedef struct ext2_struct_dblist *ext2_dblist;
139
140#define DBLIST_ABORT	1
141
142/*
143 * ext2_fileio definitions
144 */
145
146#define EXT2_FILE_WRITE		0x0001
147#define EXT2_FILE_CREATE	0x0002
148
149#define EXT2_FILE_MASK		0x00FF
150
151#define EXT2_FILE_BUF_DIRTY	0x4000
152#define EXT2_FILE_BUF_VALID	0x2000
153
154typedef struct ext2_file *ext2_file_t;
155
156#define EXT2_SEEK_SET	0
157#define EXT2_SEEK_CUR	1
158#define EXT2_SEEK_END	2
159
160/*
161 * Flags for the ext2_filsys structure
162 */
163#define EXT2_FLAG_RW			0x01
164#define EXT2_FLAG_CHANGED		0x02
165#define EXT2_FLAG_DIRTY			0x04
166#define EXT2_FLAG_VALID			0x08
167#define EXT2_FLAG_IB_DIRTY		0x10
168#define EXT2_FLAG_BB_DIRTY		0x20
169#define EXT2_FLAG_SWAP_BYTES		0x40
170#define EXT2_FLAG_SWAP_BYTES_READ	0x80
171#define EXT2_FLAG_SWAP_BYTES_WRITE	0x100
172#define EXT2_FLAG_MASTER_SB_ONLY	0x200
173#define EXT2_FLAG_FORCE			0x400
174
175/*
176 * Special flag in the ext2 inode i_flag field that means that this is
177 * a new inode.  (So that ext2_write_inode() can clear extra fields.)
178 */
179#define EXT2_NEW_INODE_FL	0x80000000
180
181/*
182 * Flags for mkjournal
183 *
184 * EXT2_MKJOURNAL_V1_SUPER	Make a (deprecated) V1 journal superblock
185 */
186#define EXT2_MKJOURNAL_V1_SUPER	0x0000001
187
188struct struct_ext2_filsys {
189	errcode_t			magic;
190	io_channel			io;
191	int				flags;
192	char *				device_name;
193	struct ext2_super_block	* 	super;
194	int				blocksize;
195	int				fragsize;
196	dgrp_t				group_desc_count;
197	unsigned long			desc_blocks;
198	struct ext2_group_desc *	group_desc;
199	int				inode_blocks_per_group;
200	ext2fs_inode_bitmap		inode_map;
201	ext2fs_block_bitmap		block_map;
202	errcode_t (*get_blocks)(ext2_filsys fs, ino_t ino, blk_t *blocks);
203	errcode_t (*check_directory)(ext2_filsys fs, ino_t ino);
204	errcode_t (*write_bitmaps)(ext2_filsys fs);
205	errcode_t (*read_inode)(ext2_filsys fs, ino_t ino,
206				struct ext2_inode *inode);
207	errcode_t (*write_inode)(ext2_filsys fs, ino_t ino,
208				struct ext2_inode *inode);
209	badblocks_list			badblocks;
210	ext2_dblist			dblist;
211	__u32				stride;	/* for mke2fs */
212	struct ext2_super_block *	orig_super;
213	/*
214	 * Reserved for future expansion
215	 */
216	__u32				reserved[10];
217
218	/*
219	 * Reserved for the use of the calling application.
220	 */
221	void *				priv_data;
222
223	/*
224	 * Inode cache
225	 */
226	struct ext2_inode_cache		*icache;
227};
228
229#if EXT2_FLAT_INCLUDES
230#include "e2_bitops.h"
231#else
232#include "ext2fs/bitops.h"
233#endif
234
235/*
236 * Return flags for the block iterator functions
237 */
238#define BLOCK_CHANGED	1
239#define BLOCK_ABORT	2
240#define BLOCK_ERROR	4
241
242/*
243 * Block interate flags
244 *
245 * BLOCK_FLAG_APPEND, or BLOCK_FLAG_HOLE, indicates that the interator
246 * function should be called on blocks where the block number is zero.
247 * This is used by ext2fs_expand_dir() to be able to add a new block
248 * to an inode.  It can also be used for programs that want to be able
249 * to deal with files that contain "holes".
250 *
251 * BLOCK_FLAG_TRAVERSE indicates that the iterator function for the
252 * indirect, doubly indirect, etc. blocks should be called after all
253 * of the blocks containined in the indirect blocks are processed.
254 * This is useful if you are going to be deallocating blocks from an
255 * inode.
256 *
257 * BLOCK_FLAG_DATA_ONLY indicates that the iterator function should be
258 * called for data blocks only.
259 *
260 * BLOCK_FLAG_NO_LARGE is for internal use only.  It informs
261 * ext2fs_block_iterate2 that large files won't be accepted.
262 */
263#define BLOCK_FLAG_APPEND	1
264#define BLOCK_FLAG_HOLE		1
265#define BLOCK_FLAG_DEPTH_TRAVERSE	2
266#define BLOCK_FLAG_DATA_ONLY	4
267
268#define BLOCK_FLAG_NO_LARGE	0x1000
269
270/*
271 * Magic "block count" return values for the block iterator function.
272 */
273#define BLOCK_COUNT_IND		(-1)
274#define BLOCK_COUNT_DIND	(-2)
275#define BLOCK_COUNT_TIND	(-3)
276#define BLOCK_COUNT_TRANSLATOR	(-4)
277
278#if 0
279/*
280 * Flags for ext2fs_move_blocks
281 */
282#define EXT2_BMOVE_GET_DBLIST	0x0001
283#define EXT2_BMOVE_DEBUG	0x0002
284#endif
285
286/*
287 * Return flags for the directory iterator functions
288 */
289#define DIRENT_CHANGED	1
290#define DIRENT_ABORT	2
291#define DIRENT_ERROR	3
292
293/*
294 * Directory iterator flags
295 */
296
297#define DIRENT_FLAG_INCLUDE_EMPTY	1
298
299
300#define DIRENT_DOT_FILE		1
301#define DIRENT_DOT_DOT_FILE	2
302#define DIRENT_OTHER_FILE	3
303
304/*
305 * Inode scan definitions
306 */
307typedef struct ext2_struct_inode_scan *ext2_inode_scan;
308
309/*
310 * ext2fs_scan flags
311 */
312#define EXT2_SF_CHK_BADBLOCKS	0x0001
313#define EXT2_SF_BAD_INODE_BLK	0x0002
314#define EXT2_SF_BAD_EXTRA_BYTES	0x0004
315#define EXT2_SF_SKIP_MISSING_ITABLE	0x0008
316
317/*
318 * ext2fs_check_if_mounted flags
319 */
320#define EXT2_MF_MOUNTED		1
321#define EXT2_MF_ISROOT		2
322#define EXT2_MF_READONLY	4
323
324/*
325 * Ext2/linux mode flags.  We define them here so that we don't need
326 * to depend on the OS's sys/stat.h, since we may be compiling on a
327 * non-Linux system.
328 */
329#define LINUX_S_IFMT  00170000
330#define LINUX_S_IFSOCK 0140000
331#define LINUX_S_IFLNK	 0120000
332#define LINUX_S_IFREG  0100000
333#define LINUX_S_IFBLK  0060000
334#define LINUX_S_IFDIR  0040000
335#define LINUX_S_IFCHR  0020000
336#define LINUX_S_IFIFO  0010000
337#define LINUX_S_ISUID  0004000
338#define LINUX_S_ISGID  0002000
339#define LINUX_S_ISVTX  0001000
340
341#define LINUX_S_IRWXU 00700
342#define LINUX_S_IRUSR 00400
343#define LINUX_S_IWUSR 00200
344#define LINUX_S_IXUSR 00100
345
346#define LINUX_S_IRWXG 00070
347#define LINUX_S_IRGRP 00040
348#define LINUX_S_IWGRP 00020
349#define LINUX_S_IXGRP 00010
350
351#define LINUX_S_IRWXO 00007
352#define LINUX_S_IROTH 00004
353#define LINUX_S_IWOTH 00002
354#define LINUX_S_IXOTH 00001
355
356#define LINUX_S_ISLNK(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFLNK)
357#define LINUX_S_ISREG(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFREG)
358#define LINUX_S_ISDIR(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFDIR)
359#define LINUX_S_ISCHR(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFCHR)
360#define LINUX_S_ISBLK(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFBLK)
361#define LINUX_S_ISFIFO(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFIFO)
362#define LINUX_S_ISSOCK(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFSOCK)
363
364/*
365 * ext2_icount_t abstraction
366 */
367#define EXT2_ICOUNT_OPT_INCREMENT	0x01
368
369typedef struct ext2_icount *ext2_icount_t;
370
371/*
372 * Flags for ext2fs_bmap
373 */
374#define BMAP_ALLOC	1
375
376/*
377 * Flags for imager.c functions
378 */
379#define IMAGER_FLAG_INODEMAP	1
380#define IMAGER_FLAG_SPARSEWRITE	2
381
382/*
383 * For checking structure magic numbers...
384 */
385
386#define EXT2_CHECK_MAGIC(struct, code) \
387	  if ((struct)->magic != (code)) return (code)
388
389
390/*
391 * The ext2fs library private definition of the ext2 superblock, so we
392 * don't have to depend on the kernel's definition of the superblock,
393 * which might not have the latest features.
394 */
395struct ext2fs_sb {
396	__u32	s_inodes_count;		/* Inodes count */
397	__u32	s_blocks_count;		/* Blocks count */
398	__u32	s_r_blocks_count;	/* Reserved blocks count */
399	__u32	s_free_blocks_count;	/* Free blocks count */
400	__u32	s_free_inodes_count;	/* Free inodes count */
401	__u32	s_first_data_block;	/* First Data Block */
402	__u32	s_log_block_size;	/* Block size */
403	__s32	s_log_frag_size;	/* Fragment size */
404	__u32	s_blocks_per_group;	/* # Blocks per group */
405	__u32	s_frags_per_group;	/* # Fragments per group */
406	__u32	s_inodes_per_group;	/* # Inodes per group */
407	__u32	s_mtime;		/* Mount time */
408	__u32	s_wtime;		/* Write time */
409	__u16	s_mnt_count;		/* Mount count */
410	__s16	s_max_mnt_count;	/* Maximal mount count */
411	__u16	s_magic;		/* Magic signature */
412	__u16	s_state;		/* File system state */
413	__u16	s_errors;		/* Behaviour when detecting errors */
414	__u16	s_minor_rev_level; 	/* minor revision level */
415	__u32	s_lastcheck;		/* time of last check */
416	__u32	s_checkinterval;	/* max. time between checks */
417	__u32	s_creator_os;		/* OS */
418	__u32	s_rev_level;		/* Revision level */
419	__u16	s_def_resuid;		/* Default uid for reserved blocks */
420	__u16	s_def_resgid;		/* Default gid for reserved blocks */
421	/*
422	 * These fields are for EXT2_DYNAMIC_REV superblocks only.
423	 *
424	 * Note: the difference between the compatible feature set and
425	 * the incompatible feature set is that if there is a bit set
426	 * in the incompatible feature set that the kernel doesn't
427	 * know about, it should refuse to mount the filesystem.
428	 *
429	 * e2fsck's requirements are more strict; if it doesn't know
430	 * about a feature in either the compatible or incompatible
431	 * feature set, it must abort and not try to meddle with
432	 * things it doesn't understand...
433	 */
434	__u32	s_first_ino; 		/* First non-reserved inode */
435	__u16   s_inode_size; 		/* size of inode structure */
436	__u16	s_block_group_nr; 	/* block group # of this superblock */
437	__u32	s_feature_compat; 	/* compatible feature set */
438	__u32	s_feature_incompat; 	/* incompatible feature set */
439	__u32	s_feature_ro_compat; 	/* readonly-compatible feature set */
440	__u8	s_uuid[16];		/* 128-bit uuid for volume */
441	char	s_volume_name[16]; 	/* volume name */
442	char	s_last_mounted[64]; 	/* directory where last mounted */
443	__u32	s_algorithm_usage_bitmap; /* For compression */
444	/*
445	 * Performance hints.  Directory preallocation should only
446	 * happen if the EXT2_FEATURE_COMPAT_DIR_PREALLOC flag is on.
447	 */
448	__u8	s_prealloc_blocks;	/* Nr of blocks to try to preallocate*/
449	__u8	s_prealloc_dir_blocks;	/* Nr to preallocate for dirs */
450	__u16	s_padding1;
451	/*
452	 * Journaling support.
453	 */
454	__u8	s_journal_uuid[16];	/* uuid of journal superblock */
455	__u32	s_journal_inum;		/* inode number of journal file */
456	__u32	s_journal_dev;		/* device number of journal file */
457	__u32	s_last_orphan;		/* start of list of inodes to delete */
458
459	__u32	s_reserved[197];	/* Padding to the end of the block */
460};
461
462#define EXT2FS_COMPRESSED_BLKADDR ((blk_t) 0xffffffff)
463#define HOLE_BLKADDR(_b) ((_b) == 0 || (_b) == EXT2FS_COMPRESSED_BLKADDR)
464
465/*
466 * Feature set definitions (that might not be in ext2_fs.h
467 */
468
469#ifndef EXT2_FEATURE_COMPAT_DIR_PREALLOC
470#define EXT2_FEATURE_COMPAT_DIR_PREALLOC	0x0001
471#endif
472
473#ifndef EXT2_FEATURE_COMPAT_IMAGIC_INODES /* for AFS, etc. */
474#define EXT2_FEATURE_COMPAT_IMAGIC_INODES		0x0002
475#define EXT2_IMAGIC_FL		0x00002000
476#endif
477
478#ifndef EXT3_FEATURE_COMPAT_HAS_JOURNAL
479#define EXT3_FEATURE_COMPAT_HAS_JOURNAL		0x0004
480#endif
481
482#ifndef EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER
483#define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER	0x0001
484#endif
485
486#ifndef EXT2_FEATURE_RO_COMPAT_LARGE_FILE
487#define EXT2_FEATURE_RO_COMPAT_LARGE_FILE	0x0002
488#define i_size_high i_dir_acl
489#endif
490
491#ifndef EXT2_FEATURE_RO_COMPAT_BTREE_DIR
492#define EXT2_FEATURE_RO_COMPAT_BTREE_DIR	0x0004
493#endif
494
495#ifndef EXT2_FEATURE_INCOMPAT_COMPRESSION
496#define EXT2_FEATURE_INCOMPAT_COMPRESSION	0x0001
497#endif
498
499#ifndef EXT2_FEATURE_INCOMPAT_FILETYPE
500#define EXT2_FEATURE_INCOMPAT_FILETYPE	0x0002
501#endif
502
503#ifndef EXT3_FEATURE_INCOMPAT_RECOVER
504#define EXT3_FEATURE_INCOMPAT_RECOVER	0x0004 /* Needs recovery */
505#endif
506
507#define EXT2_LIB_FEATURE_COMPAT_SUPP	(EXT2_FEATURE_COMPAT_DIR_PREALLOC|\
508					 EXT2_FEATURE_COMPAT_IMAGIC_INODES|\
509					 EXT3_FEATURE_COMPAT_HAS_JOURNAL)
510/* This #ifdef is temporary until compression is fully supported */
511#ifdef ENABLE_COMPRESSION
512#ifndef I_KNOW_THAT_COMPRESSION_IS_EXPERIMENTAL
513/* If the below warning bugs you, then have
514   `CPPFLAGS=-DI_KNOW_THAT_COMPRESSION_IS_EXPERIMENTAL' in your
515   environment at configure time. */
516#warning "Compression support is experimental"
517#endif
518#define EXT2_LIB_FEATURE_INCOMPAT_SUPP	(EXT2_FEATURE_INCOMPAT_FILETYPE|\
519					 EXT2_FEATURE_INCOMPAT_COMPRESSION|\
520					 EXT3_FEATURE_INCOMPAT_RECOVER)
521#else
522#define EXT2_LIB_FEATURE_INCOMPAT_SUPP	(EXT2_FEATURE_INCOMPAT_FILETYPE|\
523					 EXT3_FEATURE_INCOMPAT_RECOVER)
524#endif
525#define EXT2_LIB_FEATURE_RO_COMPAT_SUPP	(EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER|\
526					 EXT2_FEATURE_RO_COMPAT_LARGE_FILE)
527/*
528 * function prototypes
529 */
530
531/* alloc.c */
532extern errcode_t ext2fs_new_inode(ext2_filsys fs, ino_t dir, int mode,
533				  ext2fs_inode_bitmap map, ino_t *ret);
534extern errcode_t ext2fs_new_block(ext2_filsys fs, blk_t goal,
535				  ext2fs_block_bitmap map, blk_t *ret);
536extern errcode_t ext2fs_get_free_blocks(ext2_filsys fs, blk_t start,
537					blk_t finish, int num,
538					ext2fs_block_bitmap map,
539					blk_t *ret);
540extern errcode_t ext2fs_alloc_block(ext2_filsys fs, blk_t goal,
541				    char *block_buf, blk_t *ret);
542
543/* alloc_tables.c */
544extern errcode_t ext2fs_allocate_tables(ext2_filsys fs);
545extern errcode_t ext2fs_allocate_group_table(ext2_filsys fs, dgrp_t group,
546					     ext2fs_block_bitmap bmap);
547
548/* badblocks.c */
549extern errcode_t ext2fs_badblocks_list_create(ext2_badblocks_list *ret,
550					    int size);
551extern errcode_t ext2fs_badblocks_list_add(ext2_badblocks_list bb,
552					   blk_t blk);
553extern int ext2fs_badblocks_list_test(ext2_badblocks_list bb,
554				    blk_t blk);
555extern errcode_t
556	ext2fs_badblocks_list_iterate_begin(ext2_badblocks_list bb,
557					    ext2_badblocks_iterate *ret);
558extern int ext2fs_badblocks_list_iterate(ext2_badblocks_iterate iter,
559					 blk_t *blk);
560extern void ext2fs_badblocks_list_iterate_end(ext2_badblocks_iterate iter);
561extern errcode_t ext2fs_badblocks_copy(ext2_badblocks_list src,
562				       ext2_badblocks_list *dest);
563extern int ext2fs_badblocks_equal(ext2_badblocks_list bb1,
564				  ext2_badblocks_list bb2);
565
566/* bb_compat */
567extern errcode_t badblocks_list_create(badblocks_list *ret, int size);
568extern errcode_t badblocks_list_add(badblocks_list bb, blk_t blk);
569extern int badblocks_list_test(badblocks_list bb, blk_t blk);
570extern errcode_t badblocks_list_iterate_begin(badblocks_list bb,
571					      badblocks_iterate *ret);
572extern int badblocks_list_iterate(badblocks_iterate iter, blk_t *blk);
573extern void badblocks_list_iterate_end(badblocks_iterate iter);
574extern void badblocks_list_free(badblocks_list bb);
575
576/* bb_inode.c */
577extern errcode_t ext2fs_update_bb_inode(ext2_filsys fs,
578					ext2_badblocks_list bb_list);
579
580/* bitmaps.c */
581extern errcode_t ext2fs_write_inode_bitmap(ext2_filsys fs);
582extern errcode_t ext2fs_write_block_bitmap (ext2_filsys fs);
583extern errcode_t ext2fs_read_inode_bitmap (ext2_filsys fs);
584extern errcode_t ext2fs_read_block_bitmap(ext2_filsys fs);
585extern errcode_t ext2fs_allocate_generic_bitmap(__u32 start,
586						__u32 end,
587						__u32 real_end,
588						const char *descr,
589						ext2fs_generic_bitmap *ret);
590extern errcode_t ext2fs_allocate_block_bitmap(ext2_filsys fs,
591					      const char *descr,
592					      ext2fs_block_bitmap *ret);
593extern errcode_t ext2fs_allocate_inode_bitmap(ext2_filsys fs,
594					      const char *descr,
595					      ext2fs_inode_bitmap *ret);
596extern errcode_t ext2fs_fudge_inode_bitmap_end(ext2fs_inode_bitmap bitmap,
597					       ino_t end, ino_t *oend);
598extern errcode_t ext2fs_fudge_block_bitmap_end(ext2fs_block_bitmap bitmap,
599					       blk_t end, blk_t *oend);
600extern void ext2fs_clear_inode_bitmap(ext2fs_inode_bitmap bitmap);
601extern void ext2fs_clear_block_bitmap(ext2fs_block_bitmap bitmap);
602extern errcode_t ext2fs_read_bitmaps(ext2_filsys fs);
603extern errcode_t ext2fs_write_bitmaps(ext2_filsys fs);
604
605/* block.c */
606extern errcode_t ext2fs_block_iterate(ext2_filsys fs,
607				      ino_t	ino,
608				      int	flags,
609				      char *block_buf,
610				      int (*func)(ext2_filsys fs,
611						  blk_t	*blocknr,
612						  int	blockcnt,
613						  void	*priv_data),
614				      void *priv_data);
615errcode_t ext2fs_block_iterate2(ext2_filsys fs,
616				ino_t	ino,
617				int	flags,
618				char *block_buf,
619				int (*func)(ext2_filsys fs,
620					    blk_t	*blocknr,
621					    e2_blkcnt_t	blockcnt,
622					    blk_t	ref_blk,
623					    int		ref_offset,
624					    void	*priv_data),
625				void *priv_data);
626
627/* bmap.c */
628extern errcode_t ext2fs_bmap(ext2_filsys fs, ino_t ino,
629			     struct ext2_inode *inode,
630			     char *block_buf, int bmap_flags,
631			     blk_t block, blk_t *phys_blk);
632
633
634#if 0
635/* bmove.c */
636extern errcode_t ext2fs_move_blocks(ext2_filsys fs,
637				    ext2fs_block_bitmap reserve,
638				    ext2fs_block_bitmap alloc_map,
639				    int flags);
640#endif
641
642/* check_desc.c */
643extern errcode_t ext2fs_check_desc(ext2_filsys fs);
644
645/* closefs.c */
646extern errcode_t ext2fs_close(ext2_filsys fs);
647extern errcode_t ext2fs_flush(ext2_filsys fs);
648extern int ext2fs_bg_has_super(ext2_filsys fs, int group_block);
649extern void ext2fs_update_dynamic_rev(ext2_filsys fs);
650
651/* cmp_bitmaps.c */
652extern errcode_t ext2fs_compare_block_bitmap(ext2fs_block_bitmap bm1,
653					     ext2fs_block_bitmap bm2);
654extern errcode_t ext2fs_compare_inode_bitmap(ext2fs_inode_bitmap bm1,
655					     ext2fs_inode_bitmap bm2);
656
657/* dblist.c */
658
659extern errcode_t ext2fs_get_num_dirs(ext2_filsys fs, ino_t *ret_num_dirs);
660extern errcode_t ext2fs_init_dblist(ext2_filsys fs, ext2_dblist *ret_dblist);
661extern errcode_t ext2fs_add_dir_block(ext2_dblist dblist, ino_t ino,
662				      blk_t blk, int blockcnt);
663extern errcode_t ext2fs_dblist_iterate(ext2_dblist dblist,
664	int (*func)(ext2_filsys fs, struct ext2_db_entry *db_info,
665		    void	*priv_data),
666       void *priv_data);
667extern errcode_t ext2fs_set_dir_block(ext2_dblist dblist, ino_t ino,
668				      blk_t blk, int blockcnt);
669extern errcode_t ext2fs_copy_dblist(ext2_dblist src,
670				    ext2_dblist *dest);
671extern int ext2fs_dblist_count(ext2_dblist dblist);
672
673/* dblist_dir.c */
674extern errcode_t
675	ext2fs_dblist_dir_iterate(ext2_dblist dblist,
676				  int	flags,
677				  char	*block_buf,
678				  int (*func)(ino_t	dir,
679					      int		entry,
680					      struct ext2_dir_entry *dirent,
681					      int	offset,
682					      int	blocksize,
683					      char	*buf,
684					      void	*priv_data),
685				  void *priv_data);
686
687/* dirblock.c */
688extern errcode_t ext2fs_read_dir_block(ext2_filsys fs, blk_t block,
689				       void *buf);
690extern errcode_t ext2fs_write_dir_block(ext2_filsys fs, blk_t block,
691					void *buf);
692
693/* dir_iterate.c */
694extern errcode_t ext2fs_dir_iterate(ext2_filsys fs,
695			      ino_t dir,
696			      int flags,
697			      char *block_buf,
698			      int (*func)(struct ext2_dir_entry *dirent,
699					  int	offset,
700					  int	blocksize,
701					  char	*buf,
702					  void	*priv_data),
703			      void *priv_data);
704
705/* dupfs.c */
706extern errcode_t ext2fs_dup_handle(ext2_filsys src, ext2_filsys *dest);
707
708/* expanddir.c */
709extern errcode_t ext2fs_expand_dir(ext2_filsys fs, ino_t dir);
710
711/* fileio.c */
712extern errcode_t ext2fs_file_open(ext2_filsys fs, ino_t ino,
713				  int flags, ext2_file_t *ret);
714extern ext2_filsys ext2fs_file_get_fs(ext2_file_t file);
715extern errcode_t ext2fs_file_close(ext2_file_t file);
716extern errcode_t ext2fs_file_read(ext2_file_t file, void *buf,
717				  unsigned int wanted, unsigned int *got);
718extern errcode_t ext2fs_file_write(ext2_file_t file, void *buf,
719				   unsigned int nbytes, unsigned int *written);
720extern errcode_t ext2fs_file_lseek(ext2_file_t file, ext2_off_t offset,
721				   int whence, ext2_off_t *ret_pos);
722extern ext2_off_t ext2fs_file_get_size(ext2_file_t file);
723extern errcode_t ext2fs_file_set_size(ext2_file_t file, ext2_off_t size);
724
725/* finddev.c */
726extern char *ext2fs_find_block_device(dev_t device);
727
728/* freefs.c */
729extern void ext2fs_free(ext2_filsys fs);
730extern void ext2fs_free_generic_bitmap(ext2fs_inode_bitmap bitmap);
731extern void ext2fs_free_block_bitmap(ext2fs_block_bitmap bitmap);
732extern void ext2fs_free_inode_bitmap(ext2fs_inode_bitmap bitmap);
733extern void ext2fs_free_dblist(ext2_dblist dblist);
734extern void ext2fs_badblocks_list_free(badblocks_list bb);
735
736/* getsize.c */
737extern errcode_t ext2fs_get_device_size(const char *file, int blocksize,
738					blk_t *retblocks);
739
740/* imager.c */
741extern errcode_t ext2fs_image_inode_write(ext2_filsys fs, int fd, int flags);
742extern errcode_t ext2fs_image_inode_read(ext2_filsys fs, int fd, int flags);
743extern errcode_t ext2fs_image_super_write(ext2_filsys fs, int fd, int flags);
744extern errcode_t ext2fs_image_super_read(ext2_filsys fs, int fd, int flags);
745extern errcode_t ext2fs_image_bitmap_write(ext2_filsys fs, int fd, int flags);
746extern errcode_t ext2fs_image_bitmap_read(ext2_filsys fs, int fd, int flags);
747
748/* initialize.c */
749extern errcode_t ext2fs_initialize(const char *name, int flags,
750				   struct ext2_super_block *param,
751				   io_manager manager, ext2_filsys *ret_fs);
752
753/* inode.c */
754extern errcode_t ext2fs_flush_icache(ext2_filsys fs);
755extern errcode_t ext2fs_open_inode_scan(ext2_filsys fs, int buffer_blocks,
756				  ext2_inode_scan *ret_scan);
757extern void ext2fs_close_inode_scan(ext2_inode_scan scan);
758extern errcode_t ext2fs_get_next_inode(ext2_inode_scan scan, ino_t *ino,
759			       struct ext2_inode *inode);
760extern errcode_t ext2fs_inode_scan_goto_blockgroup(ext2_inode_scan scan,
761						   int	group);
762extern void ext2fs_set_inode_callback
763	(ext2_inode_scan scan,
764	 errcode_t (*done_group)(ext2_filsys fs,
765				 ext2_inode_scan scan,
766				 dgrp_t group,
767				 void * priv_data),
768	 void *done_group_data);
769extern int ext2fs_inode_scan_flags(ext2_inode_scan scan, int set_flags,
770				   int clear_flags);
771extern errcode_t ext2fs_read_inode (ext2_filsys fs, ino_t ino,
772			    struct ext2_inode * inode);
773extern errcode_t ext2fs_write_inode(ext2_filsys fs, ino_t ino,
774			    struct ext2_inode * inode);
775extern errcode_t ext2fs_get_blocks(ext2_filsys fs, ino_t ino, blk_t *blocks);
776extern errcode_t ext2fs_check_directory(ext2_filsys fs, ino_t ino);
777
778/* icount.c */
779extern void ext2fs_free_icount(ext2_icount_t icount);
780extern errcode_t ext2fs_create_icount2(ext2_filsys fs, int flags, int size,
781				       ext2_icount_t hint, ext2_icount_t *ret);
782extern errcode_t ext2fs_create_icount(ext2_filsys fs, int flags, int size,
783				      ext2_icount_t *ret);
784extern errcode_t ext2fs_icount_fetch(ext2_icount_t icount, ino_t ino,
785				     __u16 *ret);
786extern errcode_t ext2fs_icount_increment(ext2_icount_t icount, ino_t ino,
787					 __u16 *ret);
788extern errcode_t ext2fs_icount_decrement(ext2_icount_t icount, ino_t ino,
789					 __u16 *ret);
790extern errcode_t ext2fs_icount_store(ext2_icount_t icount, ino_t ino,
791				     __u16 count);
792extern ino_t ext2fs_get_icount_size(ext2_icount_t icount);
793errcode_t ext2fs_icount_validate(ext2_icount_t icount, FILE *);
794
795/* ismounted.c */
796extern errcode_t ext2fs_check_if_mounted(const char *file, int *mount_flags);
797
798/* namei.c */
799extern errcode_t ext2fs_lookup(ext2_filsys fs, ino_t dir, const char *name,
800			 int namelen, char *buf, ino_t *inode);
801extern errcode_t ext2fs_namei(ext2_filsys fs, ino_t root, ino_t cwd,
802			const char *name, ino_t *inode);
803errcode_t ext2fs_namei_follow(ext2_filsys fs, ino_t root, ino_t cwd,
804			      const char *name, ino_t *inode);
805extern errcode_t ext2fs_follow_link(ext2_filsys fs, ino_t root, ino_t cwd,
806			ino_t inode, ino_t *res_inode);
807
808/* native.c */
809int ext2fs_native_flag(void);
810
811/* newdir.c */
812extern errcode_t ext2fs_new_dir_block(ext2_filsys fs, ino_t dir_ino,
813				ino_t parent_ino, char **block);
814
815/* mkdir.c */
816extern errcode_t ext2fs_mkdir(ext2_filsys fs, ino_t parent, ino_t inum,
817			      const char *name);
818
819/* mkjournal.c */
820extern errcode_t ext2fs_add_journal_device(ext2_filsys fs, char *device,
821					   blk_t size, int flags);
822extern errcode_t ext2fs_add_journal_fs(ext2_filsys fs, blk_t size,
823				       int flags);
824
825/* openfs.c */
826extern errcode_t ext2fs_open(const char *name, int flags, int superblock,
827			     int block_size, io_manager manager,
828			     ext2_filsys *ret_fs);
829
830/* get_pathname.c */
831extern errcode_t ext2fs_get_pathname(ext2_filsys fs, ino_t dir, ino_t ino,
832			       char **name);
833
834/* link.c */
835errcode_t ext2fs_link(ext2_filsys fs, ino_t dir, const char *name,
836		      ino_t ino, int flags);
837errcode_t ext2fs_unlink(ext2_filsys fs, ino_t dir, const char *name,
838			ino_t ino, int flags);
839
840/* read_bb.c */
841extern errcode_t ext2fs_read_bb_inode(ext2_filsys fs,
842				      ext2_badblocks_list *bb_list);
843
844/* read_bb_file.c */
845extern errcode_t ext2fs_read_bb_FILE2(ext2_filsys fs, FILE *f,
846				      ext2_badblocks_list *bb_list,
847				      void *private,
848				      void (*invalid)(ext2_filsys fs,
849						      blk_t blk,
850						      char *badstr,
851						      void *private));
852extern errcode_t ext2fs_read_bb_FILE(ext2_filsys fs, FILE *f,
853				     ext2_badblocks_list *bb_list,
854				     void (*invalid)(ext2_filsys fs,
855						     blk_t blk));
856
857/* rs_bitmap.c */
858extern errcode_t ext2fs_resize_generic_bitmap(__u32 new_end,
859					      __u32 new_real_end,
860					      ext2fs_generic_bitmap bmap);
861extern errcode_t ext2fs_resize_inode_bitmap(__u32 new_end, __u32 new_real_end,
862					    ext2fs_inode_bitmap bmap);
863extern errcode_t ext2fs_resize_block_bitmap(__u32 new_end, __u32 new_real_end,
864					    ext2fs_block_bitmap bmap);
865extern errcode_t ext2fs_copy_bitmap(ext2fs_generic_bitmap src,
866				    ext2fs_generic_bitmap *dest);
867
868/* swapfs.c */
869extern void ext2fs_swap_super(struct ext2_super_block * super);
870extern void ext2fs_swap_group_desc(struct ext2_group_desc *gdp);
871extern void ext2fs_swap_inode(ext2_filsys fs,struct ext2_inode *t,
872			      struct ext2_inode *f, int hostorder);
873
874/* valid_blk.c */
875extern int ext2fs_inode_has_valid_blocks(struct ext2_inode *inode);
876
877/* version.c */
878extern int ext2fs_parse_version_string(const char *ver_string);
879extern int ext2fs_get_library_version(const char **ver_string,
880				      const char **date_string);
881
882/* inline functions */
883extern errcode_t ext2fs_get_mem(unsigned long size, void **ptr);
884extern errcode_t ext2fs_free_mem(void **ptr);
885extern errcode_t ext2fs_resize_mem(unsigned long old_size,
886				   unsigned long size, void **ptr);
887extern void ext2fs_mark_super_dirty(ext2_filsys fs);
888extern void ext2fs_mark_changed(ext2_filsys fs);
889extern int ext2fs_test_changed(ext2_filsys fs);
890extern void ext2fs_mark_valid(ext2_filsys fs);
891extern void ext2fs_unmark_valid(ext2_filsys fs);
892extern int ext2fs_test_valid(ext2_filsys fs);
893extern void ext2fs_mark_ib_dirty(ext2_filsys fs);
894extern void ext2fs_mark_bb_dirty(ext2_filsys fs);
895extern int ext2fs_test_ib_dirty(ext2_filsys fs);
896extern int ext2fs_test_bb_dirty(ext2_filsys fs);
897extern int ext2fs_group_of_blk(ext2_filsys fs, blk_t blk);
898extern int ext2fs_group_of_ino(ext2_filsys fs, ino_t ino);
899
900/*
901 * The actual inlined functions definitions themselves...
902 *
903 * If NO_INLINE_FUNCS is defined, then we won't try to do inline
904 * functions at all!
905 */
906#if (defined(INCLUDE_INLINE_FUNCS) || !defined(NO_INLINE_FUNCS))
907#ifdef INCLUDE_INLINE_FUNCS
908#define _INLINE_ extern
909#else
910#ifdef __GNUC__
911#define _INLINE_ extern __inline__
912#else				/* For Watcom C */
913#define _INLINE_ extern inline
914#endif
915#endif
916
917#ifndef EXT2_CUSTOM_MEMORY_ROUTINES
918/*
919 *  Allocate memory
920 */
921_INLINE_ errcode_t ext2fs_get_mem(unsigned long size, void **ptr)
922{
923	*ptr = malloc(size);
924	if (!*ptr)
925		return EXT2_ET_NO_MEMORY;
926	return 0;
927}
928
929/*
930 * Free memory
931 */
932_INLINE_ errcode_t ext2fs_free_mem(void **ptr)
933{
934	free(*ptr);
935	*ptr = 0;
936	return 0;
937}
938
939/*
940 *  Resize memory
941 */
942_INLINE_ errcode_t ext2fs_resize_mem(unsigned long old_size,
943				     unsigned long size, void **ptr)
944{
945	void *p;
946
947	p = realloc(*ptr, size);
948	if (!p)
949		return EXT2_ET_NO_MEMORY;
950	*ptr = p;
951	return 0;
952}
953#endif	/* Custom memory routines */
954
955/*
956 * Mark a filesystem superblock as dirty
957 */
958_INLINE_ void ext2fs_mark_super_dirty(ext2_filsys fs)
959{
960	fs->flags |= EXT2_FLAG_DIRTY | EXT2_FLAG_CHANGED;
961}
962
963/*
964 * Mark a filesystem as changed
965 */
966_INLINE_ void ext2fs_mark_changed(ext2_filsys fs)
967{
968	fs->flags |= EXT2_FLAG_CHANGED;
969}
970
971/*
972 * Check to see if a filesystem has changed
973 */
974_INLINE_ int ext2fs_test_changed(ext2_filsys fs)
975{
976	return (fs->flags & EXT2_FLAG_CHANGED);
977}
978
979/*
980 * Mark a filesystem as valid
981 */
982_INLINE_ void ext2fs_mark_valid(ext2_filsys fs)
983{
984	fs->flags |= EXT2_FLAG_VALID;
985}
986
987/*
988 * Mark a filesystem as NOT valid
989 */
990_INLINE_ void ext2fs_unmark_valid(ext2_filsys fs)
991{
992	fs->flags &= ~EXT2_FLAG_VALID;
993}
994
995/*
996 * Check to see if a filesystem is valid
997 */
998_INLINE_ int ext2fs_test_valid(ext2_filsys fs)
999{
1000	return (fs->flags & EXT2_FLAG_VALID);
1001}
1002
1003/*
1004 * Mark the inode bitmap as dirty
1005 */
1006_INLINE_ void ext2fs_mark_ib_dirty(ext2_filsys fs)
1007{
1008	fs->flags |= EXT2_FLAG_IB_DIRTY | EXT2_FLAG_CHANGED;
1009}
1010
1011/*
1012 * Mark the block bitmap as dirty
1013 */
1014_INLINE_ void ext2fs_mark_bb_dirty(ext2_filsys fs)
1015{
1016	fs->flags |= EXT2_FLAG_BB_DIRTY | EXT2_FLAG_CHANGED;
1017}
1018
1019/*
1020 * Check to see if a filesystem's inode bitmap is dirty
1021 */
1022_INLINE_ int ext2fs_test_ib_dirty(ext2_filsys fs)
1023{
1024	return (fs->flags & EXT2_FLAG_IB_DIRTY);
1025}
1026
1027/*
1028 * Check to see if a filesystem's block bitmap is dirty
1029 */
1030_INLINE_ int ext2fs_test_bb_dirty(ext2_filsys fs)
1031{
1032	return (fs->flags & EXT2_FLAG_BB_DIRTY);
1033}
1034
1035/*
1036 * Return the group # of a block
1037 */
1038_INLINE_ int ext2fs_group_of_blk(ext2_filsys fs, blk_t blk)
1039{
1040	return (blk - fs->super->s_first_data_block) /
1041		fs->super->s_blocks_per_group;
1042}
1043
1044/*
1045 * Return the group # of an inode number
1046 */
1047_INLINE_ int ext2fs_group_of_ino(ext2_filsys fs, ino_t ino)
1048{
1049	return (ino - 1) / fs->super->s_inodes_per_group;
1050}
1051#undef _INLINE_
1052#endif
1053
1054#ifdef __cplusplus
1055}
1056#endif
1057
1058#endif /* _EXT2FS_EXT2FS_H */
1059