ext2fs.h revision f12e285ffd9ff0b37c4f91d5ab2b021ed1eb43be
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 <stdlib.h>
56
57#if EXT2_FLAT_INCLUDES
58#include "e2_types.h"
59#else
60#include <ext2fs/ext2_types.h>
61#endif /* EXT2_FLAT_INCLUDES */
62
63typedef __u32		ext2_ino_t;
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	ext2_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 and for ext2fs_open()
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#define EXT2_FLAG_SUPER_ONLY		0x800
175#define EXT2_FLAG_JOURNAL_DEV_OK	0x1000
176#define EXT2_FLAG_IMAGE_FILE		0x2000
177
178/*
179 * Special flag in the ext2 inode i_flag field that means that this is
180 * a new inode.  (So that ext2_write_inode() can clear extra fields.)
181 */
182#define EXT2_NEW_INODE_FL	0x80000000
183
184/*
185 * Flags for mkjournal
186 *
187 * EXT2_MKJOURNAL_V1_SUPER	Make a (deprecated) V1 journal superblock
188 */
189#define EXT2_MKJOURNAL_V1_SUPER	0x0000001
190
191struct struct_ext2_filsys {
192	errcode_t			magic;
193	io_channel			io;
194	int				flags;
195	char *				device_name;
196	struct ext2_super_block	* 	super;
197	int				blocksize;
198	int				fragsize;
199	dgrp_t				group_desc_count;
200	unsigned long			desc_blocks;
201	struct ext2_group_desc *	group_desc;
202	int				inode_blocks_per_group;
203	ext2fs_inode_bitmap		inode_map;
204	ext2fs_block_bitmap		block_map;
205	errcode_t (*get_blocks)(ext2_filsys fs, ext2_ino_t ino, blk_t *blocks);
206	errcode_t (*check_directory)(ext2_filsys fs, ext2_ino_t ino);
207	errcode_t (*write_bitmaps)(ext2_filsys fs);
208	errcode_t (*read_inode)(ext2_filsys fs, ext2_ino_t ino,
209				struct ext2_inode *inode);
210	errcode_t (*write_inode)(ext2_filsys fs, ext2_ino_t ino,
211				struct ext2_inode *inode);
212	badblocks_list			badblocks;
213	ext2_dblist			dblist;
214	__u32				stride;	/* for mke2fs */
215	struct ext2_super_block *	orig_super;
216	struct ext2_image_hdr *		image_header;
217	__u32				umask;
218	/*
219	 * Reserved for future expansion
220	 */
221	__u32				reserved[8];
222
223	/*
224	 * Reserved for the use of the calling application.
225	 */
226	void *				priv_data;
227
228	/*
229	 * Inode cache
230	 */
231	struct ext2_inode_cache		*icache;
232};
233
234#if EXT2_FLAT_INCLUDES
235#include "e2_bitops.h"
236#else
237#include <ext2fs/bitops.h>
238#endif
239
240/*
241 * Return flags for the block iterator functions
242 */
243#define BLOCK_CHANGED	1
244#define BLOCK_ABORT	2
245#define BLOCK_ERROR	4
246
247/*
248 * Block interate flags
249 *
250 * BLOCK_FLAG_APPEND, or BLOCK_FLAG_HOLE, indicates that the interator
251 * function should be called on blocks where the block number is zero.
252 * This is used by ext2fs_expand_dir() to be able to add a new block
253 * to an inode.  It can also be used for programs that want to be able
254 * to deal with files that contain "holes".
255 *
256 * BLOCK_FLAG_TRAVERSE indicates that the iterator function for the
257 * indirect, doubly indirect, etc. blocks should be called after all
258 * of the blocks containined in the indirect blocks are processed.
259 * This is useful if you are going to be deallocating blocks from an
260 * inode.
261 *
262 * BLOCK_FLAG_DATA_ONLY indicates that the iterator function should be
263 * called for data blocks only.
264 *
265 * BLOCK_FLAG_NO_LARGE is for internal use only.  It informs
266 * ext2fs_block_iterate2 that large files won't be accepted.
267 */
268#define BLOCK_FLAG_APPEND	1
269#define BLOCK_FLAG_HOLE		1
270#define BLOCK_FLAG_DEPTH_TRAVERSE	2
271#define BLOCK_FLAG_DATA_ONLY	4
272
273#define BLOCK_FLAG_NO_LARGE	0x1000
274
275/*
276 * Magic "block count" return values for the block iterator function.
277 */
278#define BLOCK_COUNT_IND		(-1)
279#define BLOCK_COUNT_DIND	(-2)
280#define BLOCK_COUNT_TIND	(-3)
281#define BLOCK_COUNT_TRANSLATOR	(-4)
282
283#if 0
284/*
285 * Flags for ext2fs_move_blocks
286 */
287#define EXT2_BMOVE_GET_DBLIST	0x0001
288#define EXT2_BMOVE_DEBUG	0x0002
289#endif
290
291/*
292 * Return flags for the directory iterator functions
293 */
294#define DIRENT_CHANGED	1
295#define DIRENT_ABORT	2
296#define DIRENT_ERROR	3
297
298/*
299 * Directory iterator flags
300 */
301
302#define DIRENT_FLAG_INCLUDE_EMPTY	1
303#define DIRENT_FLAG_INCLUDE_REMOVED	2
304
305#define DIRENT_DOT_FILE		1
306#define DIRENT_DOT_DOT_FILE	2
307#define DIRENT_OTHER_FILE	3
308#define DIRENT_DELETED_FILE	4
309
310/*
311 * Inode scan definitions
312 */
313typedef struct ext2_struct_inode_scan *ext2_inode_scan;
314
315/*
316 * ext2fs_scan flags
317 */
318#define EXT2_SF_CHK_BADBLOCKS	0x0001
319#define EXT2_SF_BAD_INODE_BLK	0x0002
320#define EXT2_SF_BAD_EXTRA_BYTES	0x0004
321#define EXT2_SF_SKIP_MISSING_ITABLE	0x0008
322
323/*
324 * ext2fs_check_if_mounted flags
325 */
326#define EXT2_MF_MOUNTED		1
327#define EXT2_MF_ISROOT		2
328#define EXT2_MF_READONLY	4
329#define EXT2_MF_SWAP		8
330
331/*
332 * Ext2/linux mode flags.  We define them here so that we don't need
333 * to depend on the OS's sys/stat.h, since we may be compiling on a
334 * non-Linux system.
335 */
336#define LINUX_S_IFMT  00170000
337#define LINUX_S_IFSOCK 0140000
338#define LINUX_S_IFLNK	 0120000
339#define LINUX_S_IFREG  0100000
340#define LINUX_S_IFBLK  0060000
341#define LINUX_S_IFDIR  0040000
342#define LINUX_S_IFCHR  0020000
343#define LINUX_S_IFIFO  0010000
344#define LINUX_S_ISUID  0004000
345#define LINUX_S_ISGID  0002000
346#define LINUX_S_ISVTX  0001000
347
348#define LINUX_S_IRWXU 00700
349#define LINUX_S_IRUSR 00400
350#define LINUX_S_IWUSR 00200
351#define LINUX_S_IXUSR 00100
352
353#define LINUX_S_IRWXG 00070
354#define LINUX_S_IRGRP 00040
355#define LINUX_S_IWGRP 00020
356#define LINUX_S_IXGRP 00010
357
358#define LINUX_S_IRWXO 00007
359#define LINUX_S_IROTH 00004
360#define LINUX_S_IWOTH 00002
361#define LINUX_S_IXOTH 00001
362
363#define LINUX_S_ISLNK(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFLNK)
364#define LINUX_S_ISREG(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFREG)
365#define LINUX_S_ISDIR(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFDIR)
366#define LINUX_S_ISCHR(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFCHR)
367#define LINUX_S_ISBLK(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFBLK)
368#define LINUX_S_ISFIFO(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFIFO)
369#define LINUX_S_ISSOCK(m)	(((m) & LINUX_S_IFMT) == LINUX_S_IFSOCK)
370
371/*
372 * ext2_icount_t abstraction
373 */
374#define EXT2_ICOUNT_OPT_INCREMENT	0x01
375
376typedef struct ext2_icount *ext2_icount_t;
377
378/*
379 * Flags for ext2fs_bmap
380 */
381#define BMAP_ALLOC	1
382
383/*
384 * Flags for imager.c functions
385 */
386#define IMAGER_FLAG_INODEMAP	1
387#define IMAGER_FLAG_SPARSEWRITE	2
388
389/*
390 * For checking structure magic numbers...
391 */
392
393#define EXT2_CHECK_MAGIC(struct, code) \
394	  if ((struct)->magic != (code)) return (code)
395
396
397/*
398 * For ext2 compression support
399 */
400#define EXT2FS_COMPRESSED_BLKADDR ((blk_t) 0xffffffff)
401#define HOLE_BLKADDR(_b) ((_b) == 0 || (_b) == EXT2FS_COMPRESSED_BLKADDR)
402
403/*
404 * Features supported by this version of the library
405 */
406#define EXT2_LIB_FEATURE_COMPAT_SUPP	(EXT2_FEATURE_COMPAT_DIR_PREALLOC|\
407					 EXT2_FEATURE_COMPAT_IMAGIC_INODES|\
408					 EXT3_FEATURE_COMPAT_HAS_JOURNAL|\
409					 EXT2_FEATURE_COMPAT_EXT_ATTR)
410
411/* This #ifdef is temporary until compression is fully supported */
412#ifdef ENABLE_COMPRESSION
413#ifndef I_KNOW_THAT_COMPRESSION_IS_EXPERIMENTAL
414/* If the below warning bugs you, then have
415   `CPPFLAGS=-DI_KNOW_THAT_COMPRESSION_IS_EXPERIMENTAL' in your
416   environment at configure time. */
417 #warning "Compression support is experimental"
418#endif
419#define EXT2_LIB_FEATURE_INCOMPAT_SUPP	(EXT2_FEATURE_INCOMPAT_FILETYPE|\
420					 EXT2_FEATURE_INCOMPAT_COMPRESSION|\
421					 EXT3_FEATURE_INCOMPAT_JOURNAL_DEV|\
422					 EXT3_FEATURE_INCOMPAT_RECOVER)
423#else
424#define EXT2_LIB_FEATURE_INCOMPAT_SUPP	(EXT2_FEATURE_INCOMPAT_FILETYPE|\
425					 EXT3_FEATURE_INCOMPAT_JOURNAL_DEV|\
426					 EXT3_FEATURE_INCOMPAT_RECOVER)
427#endif
428#define EXT2_LIB_FEATURE_RO_COMPAT_SUPP	(EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER|\
429					 EXT2_FEATURE_RO_COMPAT_LARGE_FILE)
430/*
431 * function prototypes
432 */
433
434/* alloc.c */
435extern errcode_t ext2fs_new_inode(ext2_filsys fs, ext2_ino_t dir, int mode,
436				  ext2fs_inode_bitmap map, ext2_ino_t *ret);
437extern errcode_t ext2fs_new_block(ext2_filsys fs, blk_t goal,
438				  ext2fs_block_bitmap map, blk_t *ret);
439extern errcode_t ext2fs_get_free_blocks(ext2_filsys fs, blk_t start,
440					blk_t finish, int num,
441					ext2fs_block_bitmap map,
442					blk_t *ret);
443extern errcode_t ext2fs_alloc_block(ext2_filsys fs, blk_t goal,
444				    char *block_buf, blk_t *ret);
445
446/* alloc_stats.c */
447void ext2fs_inode_alloc_stats(ext2_filsys fs, ext2_ino_t ino, int inuse);
448void ext2fs_inode_alloc_stats2(ext2_filsys fs, ext2_ino_t ino,
449			       int inuse, int isdir);
450void ext2fs_block_alloc_stats(ext2_filsys fs, blk_t blk, int inuse);
451
452/* alloc_tables.c */
453extern errcode_t ext2fs_allocate_tables(ext2_filsys fs);
454extern errcode_t ext2fs_allocate_group_table(ext2_filsys fs, dgrp_t group,
455					     ext2fs_block_bitmap bmap);
456
457/* badblocks.c */
458extern errcode_t ext2fs_badblocks_list_create(ext2_badblocks_list *ret,
459					    int size);
460extern errcode_t ext2fs_badblocks_list_add(ext2_badblocks_list bb,
461					   blk_t blk);
462extern int ext2fs_badblocks_list_test(ext2_badblocks_list bb,
463				    blk_t blk);
464extern errcode_t
465	ext2fs_badblocks_list_iterate_begin(ext2_badblocks_list bb,
466					    ext2_badblocks_iterate *ret);
467extern int ext2fs_badblocks_list_iterate(ext2_badblocks_iterate iter,
468					 blk_t *blk);
469extern void ext2fs_badblocks_list_iterate_end(ext2_badblocks_iterate iter);
470extern errcode_t ext2fs_badblocks_copy(ext2_badblocks_list src,
471				       ext2_badblocks_list *dest);
472extern int ext2fs_badblocks_equal(ext2_badblocks_list bb1,
473				  ext2_badblocks_list bb2);
474
475/* bb_compat */
476extern errcode_t badblocks_list_create(badblocks_list *ret, int size);
477extern errcode_t badblocks_list_add(badblocks_list bb, blk_t blk);
478extern int badblocks_list_test(badblocks_list bb, blk_t blk);
479extern errcode_t badblocks_list_iterate_begin(badblocks_list bb,
480					      badblocks_iterate *ret);
481extern int badblocks_list_iterate(badblocks_iterate iter, blk_t *blk);
482extern void badblocks_list_iterate_end(badblocks_iterate iter);
483extern void badblocks_list_free(badblocks_list bb);
484
485/* bb_inode.c */
486extern errcode_t ext2fs_update_bb_inode(ext2_filsys fs,
487					ext2_badblocks_list bb_list);
488
489/* bitmaps.c */
490extern errcode_t ext2fs_write_inode_bitmap(ext2_filsys fs);
491extern errcode_t ext2fs_write_block_bitmap (ext2_filsys fs);
492extern errcode_t ext2fs_read_inode_bitmap (ext2_filsys fs);
493extern errcode_t ext2fs_read_block_bitmap(ext2_filsys fs);
494extern errcode_t ext2fs_allocate_generic_bitmap(__u32 start,
495						__u32 end,
496						__u32 real_end,
497						const char *descr,
498						ext2fs_generic_bitmap *ret);
499extern errcode_t ext2fs_allocate_block_bitmap(ext2_filsys fs,
500					      const char *descr,
501					      ext2fs_block_bitmap *ret);
502extern errcode_t ext2fs_allocate_inode_bitmap(ext2_filsys fs,
503					      const char *descr,
504					      ext2fs_inode_bitmap *ret);
505extern errcode_t ext2fs_fudge_inode_bitmap_end(ext2fs_inode_bitmap bitmap,
506					       ext2_ino_t end, ext2_ino_t *oend);
507extern errcode_t ext2fs_fudge_block_bitmap_end(ext2fs_block_bitmap bitmap,
508					       blk_t end, blk_t *oend);
509extern void ext2fs_clear_inode_bitmap(ext2fs_inode_bitmap bitmap);
510extern void ext2fs_clear_block_bitmap(ext2fs_block_bitmap bitmap);
511extern errcode_t ext2fs_read_bitmaps(ext2_filsys fs);
512extern errcode_t ext2fs_write_bitmaps(ext2_filsys fs);
513
514/* block.c */
515extern errcode_t ext2fs_block_iterate(ext2_filsys fs,
516				      ext2_ino_t	ino,
517				      int	flags,
518				      char *block_buf,
519				      int (*func)(ext2_filsys fs,
520						  blk_t	*blocknr,
521						  int	blockcnt,
522						  void	*priv_data),
523				      void *priv_data);
524errcode_t ext2fs_block_iterate2(ext2_filsys fs,
525				ext2_ino_t	ino,
526				int	flags,
527				char *block_buf,
528				int (*func)(ext2_filsys fs,
529					    blk_t	*blocknr,
530					    e2_blkcnt_t	blockcnt,
531					    blk_t	ref_blk,
532					    int		ref_offset,
533					    void	*priv_data),
534				void *priv_data);
535
536/* bmap.c */
537extern errcode_t ext2fs_bmap(ext2_filsys fs, ext2_ino_t ino,
538			     struct ext2_inode *inode,
539			     char *block_buf, int bmap_flags,
540			     blk_t block, blk_t *phys_blk);
541
542
543#if 0
544/* bmove.c */
545extern errcode_t ext2fs_move_blocks(ext2_filsys fs,
546				    ext2fs_block_bitmap reserve,
547				    ext2fs_block_bitmap alloc_map,
548				    int flags);
549#endif
550
551/* check_desc.c */
552extern errcode_t ext2fs_check_desc(ext2_filsys fs);
553
554/* closefs.c */
555extern errcode_t ext2fs_close(ext2_filsys fs);
556extern errcode_t ext2fs_flush(ext2_filsys fs);
557extern int ext2fs_bg_has_super(ext2_filsys fs, int group_block);
558extern void ext2fs_update_dynamic_rev(ext2_filsys fs);
559
560/* cmp_bitmaps.c */
561extern errcode_t ext2fs_compare_block_bitmap(ext2fs_block_bitmap bm1,
562					     ext2fs_block_bitmap bm2);
563extern errcode_t ext2fs_compare_inode_bitmap(ext2fs_inode_bitmap bm1,
564					     ext2fs_inode_bitmap bm2);
565
566/* dblist.c */
567
568extern errcode_t ext2fs_get_num_dirs(ext2_filsys fs, ext2_ino_t *ret_num_dirs);
569extern errcode_t ext2fs_init_dblist(ext2_filsys fs, ext2_dblist *ret_dblist);
570extern errcode_t ext2fs_add_dir_block(ext2_dblist dblist, ext2_ino_t ino,
571				      blk_t blk, int blockcnt);
572extern errcode_t ext2fs_dblist_iterate(ext2_dblist dblist,
573	int (*func)(ext2_filsys fs, struct ext2_db_entry *db_info,
574		    void	*priv_data),
575       void *priv_data);
576extern errcode_t ext2fs_set_dir_block(ext2_dblist dblist, ext2_ino_t ino,
577				      blk_t blk, int blockcnt);
578extern errcode_t ext2fs_copy_dblist(ext2_dblist src,
579				    ext2_dblist *dest);
580extern int ext2fs_dblist_count(ext2_dblist dblist);
581
582/* dblist_dir.c */
583extern errcode_t
584	ext2fs_dblist_dir_iterate(ext2_dblist dblist,
585				  int	flags,
586				  char	*block_buf,
587				  int (*func)(ext2_ino_t	dir,
588					      int		entry,
589					      struct ext2_dir_entry *dirent,
590					      int	offset,
591					      int	blocksize,
592					      char	*buf,
593					      void	*priv_data),
594				  void *priv_data);
595
596/* dirblock.c */
597extern errcode_t ext2fs_read_dir_block(ext2_filsys fs, blk_t block,
598				       void *buf);
599extern errcode_t ext2fs_write_dir_block(ext2_filsys fs, blk_t block,
600					void *buf);
601
602/* dir_iterate.c */
603extern errcode_t ext2fs_dir_iterate(ext2_filsys fs,
604			      ext2_ino_t dir,
605			      int flags,
606			      char *block_buf,
607			      int (*func)(struct ext2_dir_entry *dirent,
608					  int	offset,
609					  int	blocksize,
610					  char	*buf,
611					  void	*priv_data),
612			      void *priv_data);
613extern errcode_t ext2fs_dir_iterate2(ext2_filsys fs,
614			      ext2_ino_t dir,
615			      int flags,
616			      char *block_buf,
617			      int (*func)(ext2_ino_t	dir,
618					  int	entry,
619					  struct ext2_dir_entry *dirent,
620					  int	offset,
621					  int	blocksize,
622					  char	*buf,
623					  void	*priv_data),
624			      void *priv_data);
625
626/* dupfs.c */
627extern errcode_t ext2fs_dup_handle(ext2_filsys src, ext2_filsys *dest);
628
629/* expanddir.c */
630extern errcode_t ext2fs_expand_dir(ext2_filsys fs, ext2_ino_t dir);
631
632/* ext_attr.c */
633void ext2fs_swap_ext_attr(ext2_filsys fs, char *to, char *from);
634extern errcode_t ext2fs_read_ext_attr(ext2_filsys fs, blk_t block, void *buf);
635extern errcode_t ext2fs_write_ext_attr(ext2_filsys fs, blk_t block, void *buf);
636/* fileio.c */
637extern errcode_t ext2fs_file_open(ext2_filsys fs, ext2_ino_t ino,
638				  int flags, ext2_file_t *ret);
639extern ext2_filsys ext2fs_file_get_fs(ext2_file_t file);
640extern errcode_t ext2fs_file_close(ext2_file_t file);
641extern errcode_t ext2fs_file_flush(ext2_file_t file);
642extern errcode_t ext2fs_file_read(ext2_file_t file, void *buf,
643				  unsigned int wanted, unsigned int *got);
644extern errcode_t ext2fs_file_write(ext2_file_t file, const void *buf,
645				   unsigned int nbytes, unsigned int *written);
646extern errcode_t ext2fs_file_lseek(ext2_file_t file, ext2_off_t offset,
647				   int whence, ext2_off_t *ret_pos);
648extern ext2_off_t ext2fs_file_get_size(ext2_file_t file);
649extern errcode_t ext2fs_file_set_size(ext2_file_t file, ext2_off_t size);
650
651/* finddev.c */
652extern char *ext2fs_find_block_device(dev_t device);
653
654/* flushb.c */
655extern errcode_t ext2fs_sync_device(int fd, int flushb);
656
657/* freefs.c */
658extern void ext2fs_free(ext2_filsys fs);
659extern void ext2fs_free_generic_bitmap(ext2fs_inode_bitmap bitmap);
660extern void ext2fs_free_block_bitmap(ext2fs_block_bitmap bitmap);
661extern void ext2fs_free_inode_bitmap(ext2fs_inode_bitmap bitmap);
662extern void ext2fs_free_dblist(ext2_dblist dblist);
663extern void ext2fs_badblocks_list_free(badblocks_list bb);
664
665/* getsize.c */
666extern errcode_t ext2fs_get_device_size(const char *file, int blocksize,
667					blk_t *retblocks);
668
669/* imager.c */
670extern errcode_t ext2fs_image_inode_write(ext2_filsys fs, int fd, int flags);
671extern errcode_t ext2fs_image_inode_read(ext2_filsys fs, int fd, int flags);
672extern errcode_t ext2fs_image_super_write(ext2_filsys fs, int fd, int flags);
673extern errcode_t ext2fs_image_super_read(ext2_filsys fs, int fd, int flags);
674extern errcode_t ext2fs_image_bitmap_write(ext2_filsys fs, int fd, int flags);
675extern errcode_t ext2fs_image_bitmap_read(ext2_filsys fs, int fd, int flags);
676
677/* initialize.c */
678extern errcode_t ext2fs_initialize(const char *name, int flags,
679				   struct ext2_super_block *param,
680				   io_manager manager, ext2_filsys *ret_fs);
681
682/* icount.c */
683extern void ext2fs_free_icount(ext2_icount_t icount);
684extern errcode_t ext2fs_create_icount2(ext2_filsys fs, int flags, int size,
685				       ext2_icount_t hint, ext2_icount_t *ret);
686extern errcode_t ext2fs_create_icount(ext2_filsys fs, int flags, int size,
687				      ext2_icount_t *ret);
688extern errcode_t ext2fs_icount_fetch(ext2_icount_t icount, ext2_ino_t ino,
689				     __u16 *ret);
690extern errcode_t ext2fs_icount_increment(ext2_icount_t icount, ext2_ino_t ino,
691					 __u16 *ret);
692extern errcode_t ext2fs_icount_decrement(ext2_icount_t icount, ext2_ino_t ino,
693					 __u16 *ret);
694extern errcode_t ext2fs_icount_store(ext2_icount_t icount, ext2_ino_t ino,
695				     __u16 count);
696extern ext2_ino_t ext2fs_get_icount_size(ext2_icount_t icount);
697errcode_t ext2fs_icount_validate(ext2_icount_t icount, FILE *);
698
699/* inode.c */
700extern errcode_t ext2fs_flush_icache(ext2_filsys fs);
701extern errcode_t ext2fs_open_inode_scan(ext2_filsys fs, int buffer_blocks,
702				  ext2_inode_scan *ret_scan);
703extern void ext2fs_close_inode_scan(ext2_inode_scan scan);
704extern errcode_t ext2fs_get_next_inode(ext2_inode_scan scan, ext2_ino_t *ino,
705			       struct ext2_inode *inode);
706extern errcode_t ext2fs_inode_scan_goto_blockgroup(ext2_inode_scan scan,
707						   int	group);
708extern void ext2fs_set_inode_callback
709	(ext2_inode_scan scan,
710	 errcode_t (*done_group)(ext2_filsys fs,
711				 ext2_inode_scan scan,
712				 dgrp_t group,
713				 void * priv_data),
714	 void *done_group_data);
715extern int ext2fs_inode_scan_flags(ext2_inode_scan scan, int set_flags,
716				   int clear_flags);
717extern errcode_t ext2fs_read_inode (ext2_filsys fs, ext2_ino_t ino,
718			    struct ext2_inode * inode);
719extern errcode_t ext2fs_write_inode(ext2_filsys fs, ext2_ino_t ino,
720			    struct ext2_inode * inode);
721extern errcode_t ext2fs_get_blocks(ext2_filsys fs, ext2_ino_t ino, blk_t *blocks);
722extern errcode_t ext2fs_check_directory(ext2_filsys fs, ext2_ino_t ino);
723
724/* inode_io.c */
725extern io_manager inode_io_manager;
726
727/* ismounted.c */
728extern errcode_t ext2fs_check_if_mounted(const char *file, int *mount_flags);
729extern errcode_t ext2fs_check_mount_point(const char *device, int *mount_flags,
730					  char *mtpt, int mtlen);
731
732/* namei.c */
733extern errcode_t ext2fs_lookup(ext2_filsys fs, ext2_ino_t dir, const char *name,
734			 int namelen, char *buf, ext2_ino_t *inode);
735extern errcode_t ext2fs_namei(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
736			const char *name, ext2_ino_t *inode);
737errcode_t ext2fs_namei_follow(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
738			      const char *name, ext2_ino_t *inode);
739extern errcode_t ext2fs_follow_link(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
740			ext2_ino_t inode, ext2_ino_t *res_inode);
741
742/* native.c */
743int ext2fs_native_flag(void);
744
745/* newdir.c */
746extern errcode_t ext2fs_new_dir_block(ext2_filsys fs, ext2_ino_t dir_ino,
747				ext2_ino_t parent_ino, char **block);
748
749/* mkdir.c */
750extern errcode_t ext2fs_mkdir(ext2_filsys fs, ext2_ino_t parent, ext2_ino_t inum,
751			      const char *name);
752
753/* mkjournal.c */
754extern errcode_t ext2fs_create_journal_superblock(ext2_filsys fs,
755						  __u32 size, int flags,
756						  char  **ret_jsb);
757extern errcode_t ext2fs_add_journal_device(ext2_filsys fs,
758					   ext2_filsys journal_dev);
759extern errcode_t ext2fs_add_journal_inode(ext2_filsys fs, blk_t size,
760					  int flags);
761
762/* openfs.c */
763extern errcode_t ext2fs_open(const char *name, int flags, int superblock,
764			     int block_size, io_manager manager,
765			     ext2_filsys *ret_fs);
766
767/* get_pathname.c */
768extern errcode_t ext2fs_get_pathname(ext2_filsys fs, ext2_ino_t dir, ext2_ino_t ino,
769			       char **name);
770
771/* link.c */
772errcode_t ext2fs_link(ext2_filsys fs, ext2_ino_t dir, const char *name,
773		      ext2_ino_t ino, int flags);
774errcode_t ext2fs_unlink(ext2_filsys fs, ext2_ino_t dir, const char *name,
775			ext2_ino_t ino, int flags);
776
777/* read_bb.c */
778extern errcode_t ext2fs_read_bb_inode(ext2_filsys fs,
779				      ext2_badblocks_list *bb_list);
780
781/* read_bb_file.c */
782extern errcode_t ext2fs_read_bb_FILE2(ext2_filsys fs, FILE *f,
783				      ext2_badblocks_list *bb_list,
784				      void *private,
785				      void (*invalid)(ext2_filsys fs,
786						      blk_t blk,
787						      char *badstr,
788						      void *private));
789extern errcode_t ext2fs_read_bb_FILE(ext2_filsys fs, FILE *f,
790				     ext2_badblocks_list *bb_list,
791				     void (*invalid)(ext2_filsys fs,
792						     blk_t blk));
793
794/* rs_bitmap.c */
795extern errcode_t ext2fs_resize_generic_bitmap(__u32 new_end,
796					      __u32 new_real_end,
797					      ext2fs_generic_bitmap bmap);
798extern errcode_t ext2fs_resize_inode_bitmap(__u32 new_end, __u32 new_real_end,
799					    ext2fs_inode_bitmap bmap);
800extern errcode_t ext2fs_resize_block_bitmap(__u32 new_end, __u32 new_real_end,
801					    ext2fs_block_bitmap bmap);
802extern errcode_t ext2fs_copy_bitmap(ext2fs_generic_bitmap src,
803				    ext2fs_generic_bitmap *dest);
804
805/* swapfs.c */
806extern void ext2fs_swap_super(struct ext2_super_block * super);
807extern void ext2fs_swap_group_desc(struct ext2_group_desc *gdp);
808extern void ext2fs_swap_inode(ext2_filsys fs,struct ext2_inode *t,
809			      struct ext2_inode *f, int hostorder);
810
811/* valid_blk.c */
812extern int ext2fs_inode_has_valid_blocks(struct ext2_inode *inode);
813
814/* version.c */
815extern int ext2fs_parse_version_string(const char *ver_string);
816extern int ext2fs_get_library_version(const char **ver_string,
817				      const char **date_string);
818
819/* write_bb_file.c */
820extern errcode_t ext2fs_write_bb_FILE(ext2_badblocks_list bb_list,
821				      unsigned int flags,
822				      FILE *f);
823
824
825/* inline functions */
826extern errcode_t ext2fs_get_mem(unsigned long size, void **ptr);
827extern errcode_t ext2fs_free_mem(void **ptr);
828extern errcode_t ext2fs_resize_mem(unsigned long old_size,
829				   unsigned long size, void **ptr);
830extern void ext2fs_mark_super_dirty(ext2_filsys fs);
831extern void ext2fs_mark_changed(ext2_filsys fs);
832extern int ext2fs_test_changed(ext2_filsys fs);
833extern void ext2fs_mark_valid(ext2_filsys fs);
834extern void ext2fs_unmark_valid(ext2_filsys fs);
835extern int ext2fs_test_valid(ext2_filsys fs);
836extern void ext2fs_mark_ib_dirty(ext2_filsys fs);
837extern void ext2fs_mark_bb_dirty(ext2_filsys fs);
838extern int ext2fs_test_ib_dirty(ext2_filsys fs);
839extern int ext2fs_test_bb_dirty(ext2_filsys fs);
840extern int ext2fs_group_of_blk(ext2_filsys fs, blk_t blk);
841extern int ext2fs_group_of_ino(ext2_filsys fs, ext2_ino_t ino);
842
843/*
844 * The actual inlined functions definitions themselves...
845 *
846 * If NO_INLINE_FUNCS is defined, then we won't try to do inline
847 * functions at all!
848 */
849#if (defined(INCLUDE_INLINE_FUNCS) || !defined(NO_INLINE_FUNCS))
850#ifdef INCLUDE_INLINE_FUNCS
851#define _INLINE_ extern
852#else
853#ifdef __GNUC__
854#define _INLINE_ extern __inline__
855#else				/* For Watcom C */
856#define _INLINE_ extern inline
857#endif
858#endif
859
860#ifndef EXT2_CUSTOM_MEMORY_ROUTINES
861/*
862 *  Allocate memory
863 */
864_INLINE_ errcode_t ext2fs_get_mem(unsigned long size, void **ptr)
865{
866	*ptr = malloc(size);
867	if (!*ptr)
868		return EXT2_ET_NO_MEMORY;
869	return 0;
870}
871
872/*
873 * Free memory
874 */
875_INLINE_ errcode_t ext2fs_free_mem(void **ptr)
876{
877	free(*ptr);
878	*ptr = 0;
879	return 0;
880}
881
882/*
883 *  Resize memory
884 */
885_INLINE_ errcode_t ext2fs_resize_mem(unsigned long old_size,
886				     unsigned long size, void **ptr)
887{
888	void *p;
889
890	p = realloc(*ptr, size);
891	if (!p)
892		return EXT2_ET_NO_MEMORY;
893	*ptr = p;
894	return 0;
895}
896#endif	/* Custom memory routines */
897
898/*
899 * Mark a filesystem superblock as dirty
900 */
901_INLINE_ void ext2fs_mark_super_dirty(ext2_filsys fs)
902{
903	fs->flags |= EXT2_FLAG_DIRTY | EXT2_FLAG_CHANGED;
904}
905
906/*
907 * Mark a filesystem as changed
908 */
909_INLINE_ void ext2fs_mark_changed(ext2_filsys fs)
910{
911	fs->flags |= EXT2_FLAG_CHANGED;
912}
913
914/*
915 * Check to see if a filesystem has changed
916 */
917_INLINE_ int ext2fs_test_changed(ext2_filsys fs)
918{
919	return (fs->flags & EXT2_FLAG_CHANGED);
920}
921
922/*
923 * Mark a filesystem as valid
924 */
925_INLINE_ void ext2fs_mark_valid(ext2_filsys fs)
926{
927	fs->flags |= EXT2_FLAG_VALID;
928}
929
930/*
931 * Mark a filesystem as NOT valid
932 */
933_INLINE_ void ext2fs_unmark_valid(ext2_filsys fs)
934{
935	fs->flags &= ~EXT2_FLAG_VALID;
936}
937
938/*
939 * Check to see if a filesystem is valid
940 */
941_INLINE_ int ext2fs_test_valid(ext2_filsys fs)
942{
943	return (fs->flags & EXT2_FLAG_VALID);
944}
945
946/*
947 * Mark the inode bitmap as dirty
948 */
949_INLINE_ void ext2fs_mark_ib_dirty(ext2_filsys fs)
950{
951	fs->flags |= EXT2_FLAG_IB_DIRTY | EXT2_FLAG_CHANGED;
952}
953
954/*
955 * Mark the block bitmap as dirty
956 */
957_INLINE_ void ext2fs_mark_bb_dirty(ext2_filsys fs)
958{
959	fs->flags |= EXT2_FLAG_BB_DIRTY | EXT2_FLAG_CHANGED;
960}
961
962/*
963 * Check to see if a filesystem's inode bitmap is dirty
964 */
965_INLINE_ int ext2fs_test_ib_dirty(ext2_filsys fs)
966{
967	return (fs->flags & EXT2_FLAG_IB_DIRTY);
968}
969
970/*
971 * Check to see if a filesystem's block bitmap is dirty
972 */
973_INLINE_ int ext2fs_test_bb_dirty(ext2_filsys fs)
974{
975	return (fs->flags & EXT2_FLAG_BB_DIRTY);
976}
977
978/*
979 * Return the group # of a block
980 */
981_INLINE_ int ext2fs_group_of_blk(ext2_filsys fs, blk_t blk)
982{
983	return (blk - fs->super->s_first_data_block) /
984		fs->super->s_blocks_per_group;
985}
986
987/*
988 * Return the group # of an inode number
989 */
990_INLINE_ int ext2fs_group_of_ino(ext2_filsys fs, ext2_ino_t ino)
991{
992	return (ino - 1) / fs->super->s_inodes_per_group;
993}
994#undef _INLINE_
995#endif
996
997#ifdef __cplusplus
998}
999#endif
1000
1001#endif /* _EXT2FS_EXT2FS_H */
1002