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