ext2fs.h revision 7d7bdd578b307cad1dc248310eb279c6fb73b682
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 int ext2fs_u32_list_del(ext2_u32_list bb, __u32 blk);
495extern void ext2fs_badblocks_list_del(ext2_u32_list bb, __u32 blk);
496extern errcode_t
497	ext2fs_badblocks_list_iterate_begin(ext2_badblocks_list bb,
498					    ext2_badblocks_iterate *ret);
499extern int ext2fs_badblocks_list_iterate(ext2_badblocks_iterate iter,
500					 blk_t *blk);
501extern void ext2fs_badblocks_list_iterate_end(ext2_badblocks_iterate iter);
502extern errcode_t ext2fs_badblocks_copy(ext2_badblocks_list src,
503				       ext2_badblocks_list *dest);
504extern int ext2fs_badblocks_equal(ext2_badblocks_list bb1,
505				  ext2_badblocks_list bb2);
506extern int ext2fs_u32_list_count(ext2_u32_list bb);
507
508/* bb_compat */
509extern errcode_t badblocks_list_create(badblocks_list *ret, int size);
510extern errcode_t badblocks_list_add(badblocks_list bb, blk_t blk);
511extern int badblocks_list_test(badblocks_list bb, blk_t blk);
512extern errcode_t badblocks_list_iterate_begin(badblocks_list bb,
513					      badblocks_iterate *ret);
514extern int badblocks_list_iterate(badblocks_iterate iter, blk_t *blk);
515extern void badblocks_list_iterate_end(badblocks_iterate iter);
516extern void badblocks_list_free(badblocks_list bb);
517
518/* bb_inode.c */
519extern errcode_t ext2fs_update_bb_inode(ext2_filsys fs,
520					ext2_badblocks_list bb_list);
521
522/* bitmaps.c */
523extern errcode_t ext2fs_write_inode_bitmap(ext2_filsys fs);
524extern errcode_t ext2fs_write_block_bitmap (ext2_filsys fs);
525extern errcode_t ext2fs_read_inode_bitmap (ext2_filsys fs);
526extern errcode_t ext2fs_read_block_bitmap(ext2_filsys fs);
527extern errcode_t ext2fs_allocate_generic_bitmap(__u32 start,
528						__u32 end,
529						__u32 real_end,
530						const char *descr,
531						ext2fs_generic_bitmap *ret);
532extern errcode_t ext2fs_allocate_block_bitmap(ext2_filsys fs,
533					      const char *descr,
534					      ext2fs_block_bitmap *ret);
535extern errcode_t ext2fs_allocate_inode_bitmap(ext2_filsys fs,
536					      const char *descr,
537					      ext2fs_inode_bitmap *ret);
538extern errcode_t ext2fs_fudge_inode_bitmap_end(ext2fs_inode_bitmap bitmap,
539					       ext2_ino_t end, ext2_ino_t *oend);
540extern errcode_t ext2fs_fudge_block_bitmap_end(ext2fs_block_bitmap bitmap,
541					       blk_t end, blk_t *oend);
542extern void ext2fs_clear_inode_bitmap(ext2fs_inode_bitmap bitmap);
543extern void ext2fs_clear_block_bitmap(ext2fs_block_bitmap bitmap);
544extern errcode_t ext2fs_read_bitmaps(ext2_filsys fs);
545extern errcode_t ext2fs_write_bitmaps(ext2_filsys fs);
546
547/* block.c */
548extern errcode_t ext2fs_block_iterate(ext2_filsys fs,
549				      ext2_ino_t	ino,
550				      int	flags,
551				      char *block_buf,
552				      int (*func)(ext2_filsys fs,
553						  blk_t	*blocknr,
554						  int	blockcnt,
555						  void	*priv_data),
556				      void *priv_data);
557errcode_t ext2fs_block_iterate2(ext2_filsys fs,
558				ext2_ino_t	ino,
559				int	flags,
560				char *block_buf,
561				int (*func)(ext2_filsys fs,
562					    blk_t	*blocknr,
563					    e2_blkcnt_t	blockcnt,
564					    blk_t	ref_blk,
565					    int		ref_offset,
566					    void	*priv_data),
567				void *priv_data);
568
569/* bmap.c */
570extern errcode_t ext2fs_bmap(ext2_filsys fs, ext2_ino_t ino,
571			     struct ext2_inode *inode,
572			     char *block_buf, int bmap_flags,
573			     blk_t block, blk_t *phys_blk);
574
575
576#if 0
577/* bmove.c */
578extern errcode_t ext2fs_move_blocks(ext2_filsys fs,
579				    ext2fs_block_bitmap reserve,
580				    ext2fs_block_bitmap alloc_map,
581				    int flags);
582#endif
583
584/* check_desc.c */
585extern errcode_t ext2fs_check_desc(ext2_filsys fs);
586
587/* closefs.c */
588extern errcode_t ext2fs_close(ext2_filsys fs);
589extern errcode_t ext2fs_flush(ext2_filsys fs);
590extern int ext2fs_bg_has_super(ext2_filsys fs, int group_block);
591extern void ext2fs_update_dynamic_rev(ext2_filsys fs);
592
593/* cmp_bitmaps.c */
594extern errcode_t ext2fs_compare_block_bitmap(ext2fs_block_bitmap bm1,
595					     ext2fs_block_bitmap bm2);
596extern errcode_t ext2fs_compare_inode_bitmap(ext2fs_inode_bitmap bm1,
597					     ext2fs_inode_bitmap bm2);
598
599/* dblist.c */
600
601extern errcode_t ext2fs_get_num_dirs(ext2_filsys fs, ext2_ino_t *ret_num_dirs);
602extern errcode_t ext2fs_init_dblist(ext2_filsys fs, ext2_dblist *ret_dblist);
603extern errcode_t ext2fs_add_dir_block(ext2_dblist dblist, ext2_ino_t ino,
604				      blk_t blk, int blockcnt);
605extern void ext2fs_dblist_sort(ext2_dblist dblist,
606			       EXT2_QSORT_TYPE (*sortfunc)(const void *,
607							   const void *));
608extern errcode_t ext2fs_dblist_iterate(ext2_dblist dblist,
609	int (*func)(ext2_filsys fs, struct ext2_db_entry *db_info,
610		    void	*priv_data),
611       void *priv_data);
612extern errcode_t ext2fs_set_dir_block(ext2_dblist dblist, ext2_ino_t ino,
613				      blk_t blk, int blockcnt);
614extern errcode_t ext2fs_copy_dblist(ext2_dblist src,
615				    ext2_dblist *dest);
616extern int ext2fs_dblist_count(ext2_dblist dblist);
617
618/* dblist_dir.c */
619extern errcode_t
620	ext2fs_dblist_dir_iterate(ext2_dblist dblist,
621				  int	flags,
622				  char	*block_buf,
623				  int (*func)(ext2_ino_t	dir,
624					      int		entry,
625					      struct ext2_dir_entry *dirent,
626					      int	offset,
627					      int	blocksize,
628					      char	*buf,
629					      void	*priv_data),
630				  void *priv_data);
631
632/* dirblock.c */
633extern errcode_t ext2fs_read_dir_block(ext2_filsys fs, blk_t block,
634				       void *buf);
635extern errcode_t ext2fs_read_dir_block2(ext2_filsys fs, blk_t block,
636					void *buf, int flags);
637extern errcode_t ext2fs_write_dir_block(ext2_filsys fs, blk_t block,
638					void *buf);
639extern errcode_t ext2fs_write_dir_block2(ext2_filsys fs, blk_t block,
640					 void *buf, int flags);
641
642/* dirhash.c */
643extern errcode_t ext2fs_dirhash(int version, const char *name, int len,
644				const __u32 *seed,
645				ext2_dirhash_t *ret_hash,
646				ext2_dirhash_t *ret_minor_hash);
647
648
649/* dir_iterate.c */
650extern errcode_t ext2fs_dir_iterate(ext2_filsys fs,
651			      ext2_ino_t dir,
652			      int flags,
653			      char *block_buf,
654			      int (*func)(struct ext2_dir_entry *dirent,
655					  int	offset,
656					  int	blocksize,
657					  char	*buf,
658					  void	*priv_data),
659			      void *priv_data);
660extern errcode_t ext2fs_dir_iterate2(ext2_filsys fs,
661			      ext2_ino_t dir,
662			      int flags,
663			      char *block_buf,
664			      int (*func)(ext2_ino_t	dir,
665					  int	entry,
666					  struct ext2_dir_entry *dirent,
667					  int	offset,
668					  int	blocksize,
669					  char	*buf,
670					  void	*priv_data),
671			      void *priv_data);
672
673/* dupfs.c */
674extern errcode_t ext2fs_dup_handle(ext2_filsys src, ext2_filsys *dest);
675
676/* expanddir.c */
677extern errcode_t ext2fs_expand_dir(ext2_filsys fs, ext2_ino_t dir);
678
679/* ext_attr.c */
680void ext2fs_swap_ext_attr(ext2_filsys fs, char *to, char *from);
681extern errcode_t ext2fs_read_ext_attr(ext2_filsys fs, blk_t block, void *buf);
682extern errcode_t ext2fs_write_ext_attr(ext2_filsys fs, blk_t block,
683				       void *buf);
684extern errcode_t ext2fs_adjust_ea_refcount(ext2_filsys fs, blk_t blk,
685					   char *block_buf,
686					   int adjust, __u32 *newcount);
687
688/* fileio.c */
689extern errcode_t ext2fs_file_open(ext2_filsys fs, ext2_ino_t ino,
690				  int flags, ext2_file_t *ret);
691extern ext2_filsys ext2fs_file_get_fs(ext2_file_t file);
692extern errcode_t ext2fs_file_close(ext2_file_t file);
693extern errcode_t ext2fs_file_flush(ext2_file_t file);
694extern errcode_t ext2fs_file_read(ext2_file_t file, void *buf,
695				  unsigned int wanted, unsigned int *got);
696extern errcode_t ext2fs_file_write(ext2_file_t file, const void *buf,
697				   unsigned int nbytes, unsigned int *written);
698extern errcode_t ext2fs_file_llseek(ext2_file_t file, __u64 offset,
699				   int whence, __u64 *ret_pos);
700extern errcode_t ext2fs_file_lseek(ext2_file_t file, ext2_off_t offset,
701				   int whence, ext2_off_t *ret_pos);
702errcode_t ext2fs_file_get_lsize(ext2_file_t file, __u64 *ret_size);
703extern ext2_off_t ext2fs_file_get_size(ext2_file_t file);
704extern errcode_t ext2fs_file_set_size(ext2_file_t file, ext2_off_t size);
705
706/* finddev.c */
707extern char *ext2fs_find_block_device(dev_t device);
708
709/* flushb.c */
710extern errcode_t ext2fs_sync_device(int fd, int flushb);
711
712/* freefs.c */
713extern void ext2fs_free(ext2_filsys fs);
714extern void ext2fs_free_generic_bitmap(ext2fs_inode_bitmap bitmap);
715extern void ext2fs_free_block_bitmap(ext2fs_block_bitmap bitmap);
716extern void ext2fs_free_inode_bitmap(ext2fs_inode_bitmap bitmap);
717extern void ext2fs_free_dblist(ext2_dblist dblist);
718extern void ext2fs_badblocks_list_free(ext2_badblocks_list bb);
719extern void ext2fs_u32_list_free(ext2_u32_list bb);
720
721/* getsize.c */
722extern errcode_t ext2fs_get_device_size(const char *file, int blocksize,
723					blk_t *retblocks);
724
725/* getsectsize.c */
726errcode_t ext2fs_get_device_sectsize(const char *file, int *sectsize);
727
728/* imager.c */
729extern errcode_t ext2fs_image_inode_write(ext2_filsys fs, int fd, int flags);
730extern errcode_t ext2fs_image_inode_read(ext2_filsys fs, int fd, int flags);
731extern errcode_t ext2fs_image_super_write(ext2_filsys fs, int fd, int flags);
732extern errcode_t ext2fs_image_super_read(ext2_filsys fs, int fd, int flags);
733extern errcode_t ext2fs_image_bitmap_write(ext2_filsys fs, int fd, int flags);
734extern errcode_t ext2fs_image_bitmap_read(ext2_filsys fs, int fd, int flags);
735
736/* initialize.c */
737extern errcode_t ext2fs_initialize(const char *name, int flags,
738				   struct ext2_super_block *param,
739				   io_manager manager, ext2_filsys *ret_fs);
740
741/* icount.c */
742extern void ext2fs_free_icount(ext2_icount_t icount);
743extern errcode_t ext2fs_create_icount2(ext2_filsys fs, int flags, int size,
744				       ext2_icount_t hint, ext2_icount_t *ret);
745extern errcode_t ext2fs_create_icount(ext2_filsys fs, int flags, int size,
746				      ext2_icount_t *ret);
747extern errcode_t ext2fs_icount_fetch(ext2_icount_t icount, ext2_ino_t ino,
748				     __u16 *ret);
749extern errcode_t ext2fs_icount_increment(ext2_icount_t icount, ext2_ino_t ino,
750					 __u16 *ret);
751extern errcode_t ext2fs_icount_decrement(ext2_icount_t icount, ext2_ino_t ino,
752					 __u16 *ret);
753extern errcode_t ext2fs_icount_store(ext2_icount_t icount, ext2_ino_t ino,
754				     __u16 count);
755extern ext2_ino_t ext2fs_get_icount_size(ext2_icount_t icount);
756errcode_t ext2fs_icount_validate(ext2_icount_t icount, FILE *);
757
758/* inode.c */
759extern errcode_t ext2fs_flush_icache(ext2_filsys fs);
760extern errcode_t ext2fs_open_inode_scan(ext2_filsys fs, int buffer_blocks,
761				  ext2_inode_scan *ret_scan);
762extern void ext2fs_close_inode_scan(ext2_inode_scan scan);
763extern errcode_t ext2fs_get_next_inode(ext2_inode_scan scan, ext2_ino_t *ino,
764			       struct ext2_inode *inode);
765extern errcode_t ext2fs_inode_scan_goto_blockgroup(ext2_inode_scan scan,
766						   int	group);
767extern void ext2fs_set_inode_callback
768	(ext2_inode_scan scan,
769	 errcode_t (*done_group)(ext2_filsys fs,
770				 ext2_inode_scan scan,
771				 dgrp_t group,
772				 void * priv_data),
773	 void *done_group_data);
774extern int ext2fs_inode_scan_flags(ext2_inode_scan scan, int set_flags,
775				   int clear_flags);
776extern errcode_t ext2fs_read_inode (ext2_filsys fs, ext2_ino_t ino,
777			    struct ext2_inode * inode);
778extern errcode_t ext2fs_write_inode(ext2_filsys fs, ext2_ino_t ino,
779			    struct ext2_inode * inode);
780extern errcode_t ext2fs_get_blocks(ext2_filsys fs, ext2_ino_t ino, blk_t *blocks);
781extern errcode_t ext2fs_check_directory(ext2_filsys fs, ext2_ino_t ino);
782
783/* inode_io.c */
784extern io_manager inode_io_manager;
785extern errcode_t ext2fs_inode_io_intern(ext2_filsys fs, ext2_ino_t ino,
786					char **name);
787
788/* ismounted.c */
789extern errcode_t ext2fs_check_if_mounted(const char *file, int *mount_flags);
790extern errcode_t ext2fs_check_mount_point(const char *device, int *mount_flags,
791					  char *mtpt, int mtlen);
792
793/* namei.c */
794extern errcode_t ext2fs_lookup(ext2_filsys fs, ext2_ino_t dir, const char *name,
795			 int namelen, char *buf, ext2_ino_t *inode);
796extern errcode_t ext2fs_namei(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
797			const char *name, ext2_ino_t *inode);
798errcode_t ext2fs_namei_follow(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
799			      const char *name, ext2_ino_t *inode);
800extern errcode_t ext2fs_follow_link(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
801			ext2_ino_t inode, ext2_ino_t *res_inode);
802
803/* native.c */
804int ext2fs_native_flag(void);
805
806/* newdir.c */
807extern errcode_t ext2fs_new_dir_block(ext2_filsys fs, ext2_ino_t dir_ino,
808				ext2_ino_t parent_ino, char **block);
809
810/* mkdir.c */
811extern errcode_t ext2fs_mkdir(ext2_filsys fs, ext2_ino_t parent, ext2_ino_t inum,
812			      const char *name);
813
814/* mkjournal.c */
815extern errcode_t ext2fs_create_journal_superblock(ext2_filsys fs,
816						  __u32 size, int flags,
817						  char  **ret_jsb);
818extern errcode_t ext2fs_add_journal_device(ext2_filsys fs,
819					   ext2_filsys journal_dev);
820extern errcode_t ext2fs_add_journal_inode(ext2_filsys fs, blk_t size,
821					  int flags);
822
823/* openfs.c */
824extern errcode_t ext2fs_open(const char *name, int flags, int superblock,
825			     int block_size, io_manager manager,
826			     ext2_filsys *ret_fs);
827extern blk_t ext2fs_descriptor_block_loc(ext2_filsys fs, blk_t group_block,
828					 dgrp_t i);
829
830/* get_pathname.c */
831extern errcode_t ext2fs_get_pathname(ext2_filsys fs, ext2_ino_t dir, ext2_ino_t ino,
832			       char **name);
833
834/* link.c */
835errcode_t ext2fs_link(ext2_filsys fs, ext2_ino_t dir, const char *name,
836		      ext2_ino_t ino, int flags);
837errcode_t ext2fs_unlink(ext2_filsys fs, ext2_ino_t dir, const char *name,
838			ext2_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 *priv_data,
848				      void (*invalid)(ext2_filsys fs,
849						      blk_t blk,
850						      char *badstr,
851						      void *priv_data));
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/* write_bb_file.c */
883extern errcode_t ext2fs_write_bb_FILE(ext2_badblocks_list bb_list,
884				      unsigned int flags,
885				      FILE *f);
886
887
888/* inline functions */
889extern errcode_t ext2fs_get_mem(unsigned long size, void **ptr);
890extern errcode_t ext2fs_free_mem(void **ptr);
891extern errcode_t ext2fs_resize_mem(unsigned long old_size,
892				   unsigned long size, void **ptr);
893extern void ext2fs_mark_super_dirty(ext2_filsys fs);
894extern void ext2fs_mark_changed(ext2_filsys fs);
895extern int ext2fs_test_changed(ext2_filsys fs);
896extern void ext2fs_mark_valid(ext2_filsys fs);
897extern void ext2fs_unmark_valid(ext2_filsys fs);
898extern int ext2fs_test_valid(ext2_filsys fs);
899extern void ext2fs_mark_ib_dirty(ext2_filsys fs);
900extern void ext2fs_mark_bb_dirty(ext2_filsys fs);
901extern int ext2fs_test_ib_dirty(ext2_filsys fs);
902extern int ext2fs_test_bb_dirty(ext2_filsys fs);
903extern int ext2fs_group_of_blk(ext2_filsys fs, blk_t blk);
904extern int ext2fs_group_of_ino(ext2_filsys fs, ext2_ino_t ino);
905extern blk_t ext2fs_inode_data_blocks(ext2_filsys fs,
906				      struct ext2_inode *inode);
907
908/*
909 * The actual inlined functions definitions themselves...
910 *
911 * If NO_INLINE_FUNCS is defined, then we won't try to do inline
912 * functions at all!
913 */
914#if (defined(INCLUDE_INLINE_FUNCS) || !defined(NO_INLINE_FUNCS))
915#ifdef INCLUDE_INLINE_FUNCS
916#define _INLINE_ extern
917#else
918#ifdef __GNUC__
919#define _INLINE_ extern __inline__
920#else				/* For Watcom C */
921#define _INLINE_ extern inline
922#endif
923#endif
924
925#ifndef EXT2_CUSTOM_MEMORY_ROUTINES
926/*
927 *  Allocate memory
928 */
929_INLINE_ errcode_t ext2fs_get_mem(unsigned long size, void **ptr)
930{
931	*ptr = malloc(size);
932	if (!*ptr)
933		return EXT2_ET_NO_MEMORY;
934	return 0;
935}
936
937/*
938 * Free memory
939 */
940_INLINE_ errcode_t ext2fs_free_mem(void **ptr)
941{
942	free(*ptr);
943	*ptr = 0;
944	return 0;
945}
946
947/*
948 *  Resize memory
949 */
950_INLINE_ errcode_t ext2fs_resize_mem(unsigned long old_size,
951				     unsigned long size, void **ptr)
952{
953	void *p;
954
955	p = realloc(*ptr, size);
956	if (!p)
957		return EXT2_ET_NO_MEMORY;
958	*ptr = p;
959	return 0;
960}
961#endif	/* Custom memory routines */
962
963/*
964 * Mark a filesystem superblock as dirty
965 */
966_INLINE_ void ext2fs_mark_super_dirty(ext2_filsys fs)
967{
968	fs->flags |= EXT2_FLAG_DIRTY | EXT2_FLAG_CHANGED;
969}
970
971/*
972 * Mark a filesystem as changed
973 */
974_INLINE_ void ext2fs_mark_changed(ext2_filsys fs)
975{
976	fs->flags |= EXT2_FLAG_CHANGED;
977}
978
979/*
980 * Check to see if a filesystem has changed
981 */
982_INLINE_ int ext2fs_test_changed(ext2_filsys fs)
983{
984	return (fs->flags & EXT2_FLAG_CHANGED);
985}
986
987/*
988 * Mark a filesystem as valid
989 */
990_INLINE_ void ext2fs_mark_valid(ext2_filsys fs)
991{
992	fs->flags |= EXT2_FLAG_VALID;
993}
994
995/*
996 * Mark a filesystem as NOT valid
997 */
998_INLINE_ void ext2fs_unmark_valid(ext2_filsys fs)
999{
1000	fs->flags &= ~EXT2_FLAG_VALID;
1001}
1002
1003/*
1004 * Check to see if a filesystem is valid
1005 */
1006_INLINE_ int ext2fs_test_valid(ext2_filsys fs)
1007{
1008	return (fs->flags & EXT2_FLAG_VALID);
1009}
1010
1011/*
1012 * Mark the inode bitmap as dirty
1013 */
1014_INLINE_ void ext2fs_mark_ib_dirty(ext2_filsys fs)
1015{
1016	fs->flags |= EXT2_FLAG_IB_DIRTY | EXT2_FLAG_CHANGED;
1017}
1018
1019/*
1020 * Mark the block bitmap as dirty
1021 */
1022_INLINE_ void ext2fs_mark_bb_dirty(ext2_filsys fs)
1023{
1024	fs->flags |= EXT2_FLAG_BB_DIRTY | EXT2_FLAG_CHANGED;
1025}
1026
1027/*
1028 * Check to see if a filesystem's inode bitmap is dirty
1029 */
1030_INLINE_ int ext2fs_test_ib_dirty(ext2_filsys fs)
1031{
1032	return (fs->flags & EXT2_FLAG_IB_DIRTY);
1033}
1034
1035/*
1036 * Check to see if a filesystem's block bitmap is dirty
1037 */
1038_INLINE_ int ext2fs_test_bb_dirty(ext2_filsys fs)
1039{
1040	return (fs->flags & EXT2_FLAG_BB_DIRTY);
1041}
1042
1043/*
1044 * Return the group # of a block
1045 */
1046_INLINE_ int ext2fs_group_of_blk(ext2_filsys fs, blk_t blk)
1047{
1048	return (blk - fs->super->s_first_data_block) /
1049		fs->super->s_blocks_per_group;
1050}
1051
1052/*
1053 * Return the group # of an inode number
1054 */
1055_INLINE_ int ext2fs_group_of_ino(ext2_filsys fs, ext2_ino_t ino)
1056{
1057	return (ino - 1) / fs->super->s_inodes_per_group;
1058}
1059
1060_INLINE_ blk_t ext2fs_inode_data_blocks(ext2_filsys fs,
1061					struct ext2_inode *inode)
1062{
1063       return inode->i_blocks -
1064              (inode->i_file_acl ? fs->blocksize >> 9 : 0);
1065}
1066#undef _INLINE_
1067#endif
1068
1069#ifdef __cplusplus
1070}
1071#endif
1072
1073#endif /* _EXT2FS_EXT2FS_H */
1074