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