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