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