Whamcloud - gitweb
libext2fs: support allocating uninit blocks in bmap2()
[tools/e2fsprogs.git] / lib / ext2fs / ext2fs.h
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 Library
8  * General Public License, version 2.
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
22 extern "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  * Where the master copy of the superblock is located, and how big
34  * superblocks are supposed to be.  We define SUPERBLOCK_SIZE because
35  * the size of the superblock structure is not necessarily trustworthy
36  * (some versions have the padding set up so that the superblock is
37  * 1032 bytes long).
38  */
39 #define SUPERBLOCK_OFFSET       1024
40 #define SUPERBLOCK_SIZE         1024
41
42 #define UUID_STR_SIZE 37
43
44 /*
45  * The last ext2fs revision level that this version of the library is
46  * able to support.
47  */
48 #define EXT2_LIB_CURRENT_REV    EXT2_DYNAMIC_REV
49
50 #ifdef HAVE_SYS_TYPES_H
51 #include <sys/types.h>
52 #endif
53
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include <errno.h>
58
59 #if EXT2_FLAT_INCLUDES
60 #include "e2_types.h"
61 #include "ext2_fs.h"
62 #include "ext3_extents.h"
63 #else
64 #include <ext2fs/ext2_types.h>
65 #include <ext2fs/ext2_fs.h>
66 #include <ext2fs/ext3_extents.h>
67 #endif /* EXT2_FLAT_INCLUDES */
68
69 typedef __u32 __bitwise         ext2_ino_t;
70 typedef __u32 __bitwise         blk_t;
71 typedef __u64 __bitwise         blk64_t;
72 typedef __u32 __bitwise         dgrp_t;
73 typedef __u32 __bitwise         ext2_off_t;
74 typedef __u64 __bitwise         ext2_off64_t;
75 typedef __s64 __bitwise         e2_blkcnt_t;
76 typedef __u32 __bitwise         ext2_dirhash_t;
77
78 #if EXT2_FLAT_INCLUDES
79 #include "com_err.h"
80 #include "ext2_io.h"
81 #include "ext2_err.h"
82 #include "ext2_ext_attr.h"
83 #else
84 #include <et/com_err.h>
85 #include <ext2fs/ext2_io.h>
86 #include <ext2fs/ext2_err.h>
87 #include <ext2fs/ext2_ext_attr.h>
88 #endif
89
90 /*
91  * Portability help for Microsoft Visual C++
92  */
93 #ifdef _MSC_VER
94 #define EXT2_QSORT_TYPE int __cdecl
95 #else
96 #define EXT2_QSORT_TYPE int
97 #endif
98
99 typedef struct struct_ext2_filsys *ext2_filsys;
100
101 #define EXT2FS_MARK_ERROR       0
102 #define EXT2FS_UNMARK_ERROR     1
103 #define EXT2FS_TEST_ERROR       2
104
105 typedef struct ext2fs_struct_generic_bitmap *ext2fs_generic_bitmap;
106 typedef struct ext2fs_struct_generic_bitmap *ext2fs_inode_bitmap;
107 typedef struct ext2fs_struct_generic_bitmap *ext2fs_block_bitmap;
108
109 #define EXT2_FIRST_INODE(s)     EXT2_FIRST_INO(s)
110
111
112 /*
113  * Badblocks list definitions
114  */
115
116 typedef struct ext2_struct_u32_list *ext2_badblocks_list;
117 typedef struct ext2_struct_u32_iterate *ext2_badblocks_iterate;
118
119 typedef struct ext2_struct_u32_list *ext2_u32_list;
120 typedef struct ext2_struct_u32_iterate *ext2_u32_iterate;
121
122 /* old */
123 typedef struct ext2_struct_u32_list *badblocks_list;
124 typedef struct ext2_struct_u32_iterate *badblocks_iterate;
125
126 #define BADBLOCKS_FLAG_DIRTY    1
127
128 /*
129  * ext2_dblist structure and abstractions (see dblist.c)
130  */
131 struct ext2_db_entry2 {
132         ext2_ino_t      ino;
133         blk64_t blk;
134         e2_blkcnt_t     blockcnt;
135 };
136
137 /* Ye Olde 32-bit version */
138 struct ext2_db_entry {
139         ext2_ino_t      ino;
140         blk_t   blk;
141         int     blockcnt;
142 };
143
144 typedef struct ext2_struct_dblist *ext2_dblist;
145
146 #define DBLIST_ABORT    1
147
148 /*
149  * ext2_fileio definitions
150  */
151
152 #define EXT2_FILE_WRITE         0x0001
153 #define EXT2_FILE_CREATE        0x0002
154
155 #define EXT2_FILE_MASK          0x00FF
156
157 #define EXT2_FILE_BUF_DIRTY     0x4000
158 #define EXT2_FILE_BUF_VALID     0x2000
159
160 typedef struct ext2_file *ext2_file_t;
161
162 #define EXT2_SEEK_SET   0
163 #define EXT2_SEEK_CUR   1
164 #define EXT2_SEEK_END   2
165
166 /*
167  * Flags for the ext2_filsys structure and for ext2fs_open()
168  */
169 #define EXT2_FLAG_RW                    0x01
170 #define EXT2_FLAG_CHANGED               0x02
171 #define EXT2_FLAG_DIRTY                 0x04
172 #define EXT2_FLAG_VALID                 0x08
173 #define EXT2_FLAG_IB_DIRTY              0x10
174 #define EXT2_FLAG_BB_DIRTY              0x20
175 #define EXT2_FLAG_SWAP_BYTES            0x40
176 #define EXT2_FLAG_SWAP_BYTES_READ       0x80
177 #define EXT2_FLAG_SWAP_BYTES_WRITE      0x100
178 #define EXT2_FLAG_MASTER_SB_ONLY        0x200
179 #define EXT2_FLAG_FORCE                 0x400
180 #define EXT2_FLAG_SUPER_ONLY            0x800
181 #define EXT2_FLAG_JOURNAL_DEV_OK        0x1000
182 #define EXT2_FLAG_IMAGE_FILE            0x2000
183 #define EXT2_FLAG_EXCLUSIVE             0x4000
184 #define EXT2_FLAG_SOFTSUPP_FEATURES     0x8000
185 #define EXT2_FLAG_NOFREE_ON_ERROR       0x10000
186 #define EXT2_FLAG_64BITS                0x20000
187 #define EXT2_FLAG_PRINT_PROGRESS        0x40000
188 #define EXT2_FLAG_DIRECT_IO             0x80000
189 #define EXT2_FLAG_SKIP_MMP              0x100000
190 #define EXT2_FLAG_IGNORE_CSUM_ERRORS    0x200000
191
192 /*
193  * Special flag in the ext2 inode i_flag field that means that this is
194  * a new inode.  (So that ext2_write_inode() can clear extra fields.)
195  */
196 #define EXT2_NEW_INODE_FL       0x80000000
197
198 /*
199  * Flags for mkjournal
200  */
201 #define EXT2_MKJOURNAL_V1_SUPER 0x0000001 /* create V1 superblock (deprecated) */
202 #define EXT2_MKJOURNAL_LAZYINIT 0x0000002 /* don't zero journal inode before use*/
203 #define EXT2_MKJOURNAL_NO_MNT_CHECK 0x0000004 /* don't check mount status */
204
205 struct opaque_ext2_group_desc;
206
207 struct struct_ext2_filsys {
208         errcode_t                       magic;
209         io_channel                      io;
210         int                             flags;
211         char *                          device_name;
212         struct ext2_super_block *       super;
213         unsigned int                    blocksize;
214         int                             fragsize;
215         dgrp_t                          group_desc_count;
216         unsigned long                   desc_blocks;
217         struct opaque_ext2_group_desc * group_desc;
218         unsigned int                    inode_blocks_per_group;
219         ext2fs_inode_bitmap             inode_map;
220         ext2fs_block_bitmap             block_map;
221         /* XXX FIXME-64: not 64-bit safe, but not used? */
222         errcode_t (*get_blocks)(ext2_filsys fs, ext2_ino_t ino, blk_t *blocks);
223         errcode_t (*check_directory)(ext2_filsys fs, ext2_ino_t ino);
224         errcode_t (*write_bitmaps)(ext2_filsys fs);
225         errcode_t (*read_inode)(ext2_filsys fs, ext2_ino_t ino,
226                                 struct ext2_inode *inode);
227         errcode_t (*write_inode)(ext2_filsys fs, ext2_ino_t ino,
228                                 struct ext2_inode *inode);
229         ext2_badblocks_list             badblocks;
230         ext2_dblist                     dblist;
231         __u32                           stride; /* for mke2fs */
232         struct ext2_super_block *       orig_super;
233         struct ext2_image_hdr *         image_header;
234         __u32                           umask;
235         time_t                          now;
236         int                             cluster_ratio_bits;
237         __u16                           default_bitmap_type;
238         __u16                           pad;
239         /*
240          * Reserved for future expansion
241          */
242         __u32                           reserved[5];
243
244         /*
245          * Reserved for the use of the calling application.
246          */
247         void *                          priv_data;
248
249         /*
250          * Inode cache
251          */
252         struct ext2_inode_cache         *icache;
253         io_channel                      image_io;
254
255         /*
256          * More callback functions
257          */
258         errcode_t (*get_alloc_block)(ext2_filsys fs, blk64_t goal,
259                                      blk64_t *ret);
260         void (*block_alloc_stats)(ext2_filsys fs, blk64_t blk, int inuse);
261
262         /*
263          * Buffers for Multiple mount protection(MMP) block.
264          */
265         void *mmp_buf;
266         void *mmp_cmp;
267         int mmp_fd;
268
269         /*
270          * Time at which e2fsck last updated the MMP block.
271          */
272         long mmp_last_written;
273
274         /* progress operation functions */
275         struct ext2fs_progress_ops *progress_ops;
276
277         /* Precomputed FS UUID checksum for seeding other checksums */
278         __u32 csum_seed;
279
280         io_channel                      journal_io;
281         char                            *journal_name;
282 };
283
284 #if EXT2_FLAT_INCLUDES
285 #include "e2_bitops.h"
286 #else
287 #include <ext2fs/bitops.h>
288 #endif
289
290 /*
291  * 64-bit bitmap backend types
292  */
293 #define EXT2FS_BMAP64_BITARRAY  1
294 #define EXT2FS_BMAP64_RBTREE    2
295 #define EXT2FS_BMAP64_AUTODIR   3
296
297 /*
298  * Return flags for the block iterator functions
299  */
300 #define BLOCK_CHANGED                   1
301 #define BLOCK_ABORT                     2
302 #define BLOCK_ERROR                     4
303 #define BLOCK_INLINE_DATA_CHANGED       8
304
305 /*
306  * Block interate flags
307  *
308  * BLOCK_FLAG_APPEND, or BLOCK_FLAG_HOLE, indicates that the interator
309  * function should be called on blocks where the block number is zero.
310  * This is used by ext2fs_expand_dir() to be able to add a new block
311  * to an inode.  It can also be used for programs that want to be able
312  * to deal with files that contain "holes".
313  *
314  * BLOCK_FLAG_DEPTH_TRAVERSE indicates that the iterator function for
315  * the indirect, doubly indirect, etc. blocks should be called after
316  * all of the blocks containined in the indirect blocks are processed.
317  * This is useful if you are going to be deallocating blocks from an
318  * inode.
319  *
320  * BLOCK_FLAG_DATA_ONLY indicates that the iterator function should be
321  * called for data blocks only.
322  *
323  * BLOCK_FLAG_READ_ONLY is a promise by the caller that it will not
324  * modify returned block number.
325  *
326  * BLOCK_FLAG_NO_LARGE is for internal use only.  It informs
327  * ext2fs_block_iterate2 that large files won't be accepted.
328  */
329 #define BLOCK_FLAG_APPEND       1
330 #define BLOCK_FLAG_HOLE         1
331 #define BLOCK_FLAG_DEPTH_TRAVERSE       2
332 #define BLOCK_FLAG_DATA_ONLY    4
333 #define BLOCK_FLAG_READ_ONLY    8
334
335 #define BLOCK_FLAG_NO_LARGE     0x1000
336
337 /*
338  * Magic "block count" return values for the block iterator function.
339  */
340 #define BLOCK_COUNT_IND         (-1)
341 #define BLOCK_COUNT_DIND        (-2)
342 #define BLOCK_COUNT_TIND        (-3)
343 #define BLOCK_COUNT_TRANSLATOR  (-4)
344
345 #if 0
346 /*
347  * Flags for ext2fs_move_blocks
348  */
349 #define EXT2_BMOVE_GET_DBLIST   0x0001
350 #define EXT2_BMOVE_DEBUG        0x0002
351 #endif
352
353 /*
354  * Generic (non-filesystem layout specific) extents structure
355  */
356
357 #define EXT2_EXTENT_FLAGS_LEAF          0x0001
358 #define EXT2_EXTENT_FLAGS_UNINIT        0x0002
359 #define EXT2_EXTENT_FLAGS_SECOND_VISIT  0x0004
360
361 struct ext2fs_extent {
362         blk64_t e_pblk;         /* first physical block */
363         blk64_t e_lblk;         /* first logical block extent covers */
364         __u32   e_len;          /* number of blocks covered by extent */
365         __u32   e_flags;        /* extent flags */
366 };
367
368 typedef struct ext2_extent_handle *ext2_extent_handle_t;
369 typedef struct ext2_extent_path *ext2_extent_path_t;
370
371 /*
372  * Flags used by ext2fs_extent_get()
373  */
374 #define EXT2_EXTENT_CURRENT     0x0000
375 #define EXT2_EXTENT_MOVE_MASK   0x000F
376 #define EXT2_EXTENT_ROOT        0x0001
377 #define EXT2_EXTENT_LAST_LEAF   0x0002
378 #define EXT2_EXTENT_FIRST_SIB   0x0003
379 #define EXT2_EXTENT_LAST_SIB    0x0004
380 #define EXT2_EXTENT_NEXT_SIB    0x0005
381 #define EXT2_EXTENT_PREV_SIB    0x0006
382 #define EXT2_EXTENT_NEXT_LEAF   0x0007
383 #define EXT2_EXTENT_PREV_LEAF   0x0008
384 #define EXT2_EXTENT_NEXT        0x0009
385 #define EXT2_EXTENT_PREV        0x000A
386 #define EXT2_EXTENT_UP          0x000B
387 #define EXT2_EXTENT_DOWN        0x000C
388 #define EXT2_EXTENT_DOWN_AND_LAST 0x000D
389
390 /*
391  * Flags used by ext2fs_extent_insert()
392  */
393 #define EXT2_EXTENT_INSERT_AFTER        0x0001 /* insert after handle loc'n */
394 #define EXT2_EXTENT_INSERT_NOSPLIT      0x0002 /* insert may not cause split */
395
396 /*
397  * Flags used by ext2fs_extent_delete()
398  */
399 #define EXT2_EXTENT_DELETE_KEEP_EMPTY   0x001 /* keep node if last extnt gone */
400
401 /*
402  * Flags used by ext2fs_extent_set_bmap()
403  */
404 #define EXT2_EXTENT_SET_BMAP_UNINIT     0x0001
405
406 /*
407  * Data structure returned by ext2fs_extent_get_info()
408  */
409 struct ext2_extent_info {
410         int             curr_entry;
411         int             curr_level;
412         int             num_entries;
413         int             max_entries;
414         int             max_depth;
415         int             bytes_avail;
416         blk64_t         max_lblk;
417         blk64_t         max_pblk;
418         __u32           max_len;
419         __u32           max_uninit_len;
420 };
421
422 /*
423  * Flags for directory block reading and writing functions
424  */
425 #define EXT2_DIRBLOCK_V2_STRUCT 0x0001
426
427 /*
428  * Return flags for the directory iterator functions
429  */
430 #define DIRENT_CHANGED  1
431 #define DIRENT_ABORT    2
432 #define DIRENT_ERROR    3
433
434 /*
435  * Directory iterator flags
436  */
437
438 #define DIRENT_FLAG_INCLUDE_EMPTY       1
439 #define DIRENT_FLAG_INCLUDE_REMOVED     2
440 #define DIRENT_FLAG_INCLUDE_CSUM        4
441 #define DIRENT_FLAG_INCLUDE_INLINE_DATA 8
442
443 #define DIRENT_DOT_FILE         1
444 #define DIRENT_DOT_DOT_FILE     2
445 #define DIRENT_OTHER_FILE       3
446 #define DIRENT_DELETED_FILE     4
447 #define DIRENT_CHECKSUM         5
448
449 /*
450  * Inode scan definitions
451  */
452 typedef struct ext2_struct_inode_scan *ext2_inode_scan;
453
454 /*
455  * ext2fs_scan flags
456  */
457 #define EXT2_SF_CHK_BADBLOCKS   0x0001
458 #define EXT2_SF_BAD_INODE_BLK   0x0002
459 #define EXT2_SF_BAD_EXTRA_BYTES 0x0004
460 #define EXT2_SF_SKIP_MISSING_ITABLE     0x0008
461 #define EXT2_SF_DO_LAZY         0x0010
462 #define EXT2_SF_WARN_GARBAGE_INODES     0x0020
463
464 /*
465  * ext2fs_check_if_mounted flags
466  */
467 #define EXT2_MF_MOUNTED         1
468 #define EXT2_MF_ISROOT          2
469 #define EXT2_MF_READONLY        4
470 #define EXT2_MF_SWAP            8
471 #define EXT2_MF_BUSY            16
472
473 /*
474  * Ext2/linux mode flags.  We define them here so that we don't need
475  * to depend on the OS's sys/stat.h, since we may be compiling on a
476  * non-Linux system.
477  */
478 #define LINUX_S_IFMT  00170000
479 #define LINUX_S_IFSOCK 0140000
480 #define LINUX_S_IFLNK    0120000
481 #define LINUX_S_IFREG  0100000
482 #define LINUX_S_IFBLK  0060000
483 #define LINUX_S_IFDIR  0040000
484 #define LINUX_S_IFCHR  0020000
485 #define LINUX_S_IFIFO  0010000
486 #define LINUX_S_ISUID  0004000
487 #define LINUX_S_ISGID  0002000
488 #define LINUX_S_ISVTX  0001000
489
490 #define LINUX_S_IRWXU 00700
491 #define LINUX_S_IRUSR 00400
492 #define LINUX_S_IWUSR 00200
493 #define LINUX_S_IXUSR 00100
494
495 #define LINUX_S_IRWXG 00070
496 #define LINUX_S_IRGRP 00040
497 #define LINUX_S_IWGRP 00020
498 #define LINUX_S_IXGRP 00010
499
500 #define LINUX_S_IRWXO 00007
501 #define LINUX_S_IROTH 00004
502 #define LINUX_S_IWOTH 00002
503 #define LINUX_S_IXOTH 00001
504
505 #define LINUX_S_ISLNK(m)        (((m) & LINUX_S_IFMT) == LINUX_S_IFLNK)
506 #define LINUX_S_ISREG(m)        (((m) & LINUX_S_IFMT) == LINUX_S_IFREG)
507 #define LINUX_S_ISDIR(m)        (((m) & LINUX_S_IFMT) == LINUX_S_IFDIR)
508 #define LINUX_S_ISCHR(m)        (((m) & LINUX_S_IFMT) == LINUX_S_IFCHR)
509 #define LINUX_S_ISBLK(m)        (((m) & LINUX_S_IFMT) == LINUX_S_IFBLK)
510 #define LINUX_S_ISFIFO(m)       (((m) & LINUX_S_IFMT) == LINUX_S_IFIFO)
511 #define LINUX_S_ISSOCK(m)       (((m) & LINUX_S_IFMT) == LINUX_S_IFSOCK)
512
513 /*
514  * ext2 size of an inode
515  */
516 #define EXT2_I_SIZE(i)  ((i)->i_size | ((__u64) (i)->i_size_high << 32))
517
518 /*
519  * ext2_icount_t abstraction
520  */
521 #define EXT2_ICOUNT_OPT_INCREMENT       0x01
522
523 typedef struct ext2_icount *ext2_icount_t;
524
525 /*
526  * Flags for ext2fs_bmap
527  */
528 #define BMAP_ALLOC      0x0001
529 #define BMAP_SET        0x0002
530 #define BMAP_UNINIT     0x0004
531 #define BMAP_ZERO       0x0008
532
533 /*
534  * Returned flags from ext2fs_bmap
535  */
536 #define BMAP_RET_UNINIT 0x0001
537
538 /*
539  * Flags for imager.c functions
540  */
541 #define IMAGER_FLAG_INODEMAP    1
542 #define IMAGER_FLAG_SPARSEWRITE 2
543
544 /*
545  * For checking structure magic numbers...
546  */
547
548 #define EXT2_CHECK_MAGIC(struct, code) \
549           if ((struct)->magic != (code)) return (code)
550
551 /*
552  * Features supported by this version of the library
553  */
554 #define EXT2_LIB_FEATURE_COMPAT_SUPP    (EXT2_FEATURE_COMPAT_DIR_PREALLOC|\
555                                          EXT2_FEATURE_COMPAT_IMAGIC_INODES|\
556                                          EXT3_FEATURE_COMPAT_HAS_JOURNAL|\
557                                          EXT2_FEATURE_COMPAT_RESIZE_INODE|\
558                                          EXT2_FEATURE_COMPAT_DIR_INDEX|\
559                                          EXT2_FEATURE_COMPAT_EXT_ATTR|\
560                                          EXT4_FEATURE_COMPAT_SPARSE_SUPER2)
561
562 #ifdef CONFIG_MMP
563 #define EXT4_LIB_INCOMPAT_MMP           EXT4_FEATURE_INCOMPAT_MMP
564 #else
565 #define EXT4_LIB_INCOMPAT_MMP           (0)
566 #endif
567
568 #ifdef CONFIG_QUOTA
569 #define EXT4_LIB_RO_COMPAT_QUOTA        EXT4_FEATURE_RO_COMPAT_QUOTA
570 #else
571 #define EXT4_LIB_RO_COMPAT_QUOTA        (0)
572 #endif
573
574 #define EXT2_LIB_FEATURE_INCOMPAT_SUPP  (EXT2_FEATURE_INCOMPAT_FILETYPE|\
575                                          EXT3_FEATURE_INCOMPAT_JOURNAL_DEV|\
576                                          EXT2_FEATURE_INCOMPAT_META_BG|\
577                                          EXT3_FEATURE_INCOMPAT_RECOVER|\
578                                          EXT3_FEATURE_INCOMPAT_EXTENTS|\
579                                          EXT4_FEATURE_INCOMPAT_FLEX_BG|\
580                                          EXT4_LIB_INCOMPAT_MMP|\
581                                          EXT4_FEATURE_INCOMPAT_64BIT|\
582                                          EXT4_FEATURE_INCOMPAT_INLINE_DATA|\
583                                          EXT4_FEATURE_INCOMPAT_ENCRYPT)
584
585 #define EXT2_LIB_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER|\
586                                          EXT4_FEATURE_RO_COMPAT_HUGE_FILE|\
587                                          EXT2_FEATURE_RO_COMPAT_LARGE_FILE|\
588                                          EXT4_FEATURE_RO_COMPAT_DIR_NLINK|\
589                                          EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE|\
590                                          EXT4_FEATURE_RO_COMPAT_GDT_CSUM|\
591                                          EXT4_FEATURE_RO_COMPAT_BIGALLOC|\
592                                          EXT4_LIB_RO_COMPAT_QUOTA|\
593                                          EXT4_FEATURE_RO_COMPAT_METADATA_CSUM|\
594                                          EXT4_FEATURE_RO_COMPAT_READONLY)
595
596 /*
597  * These features are only allowed if EXT2_FLAG_SOFTSUPP_FEATURES is passed
598  * to ext2fs_openfs()
599  */
600 #define EXT2_LIB_SOFTSUPP_INCOMPAT      (0)
601 #define EXT2_LIB_SOFTSUPP_RO_COMPAT     (EXT4_FEATURE_RO_COMPAT_REPLICA)
602
603
604 /* Translate a block number to a cluster number */
605 #define EXT2FS_CLUSTER_RATIO(fs)        (1 << (fs)->cluster_ratio_bits)
606 #define EXT2FS_CLUSTER_MASK(fs)         (EXT2FS_CLUSTER_RATIO(fs) - 1)
607 #define EXT2FS_B2C(fs, blk)             ((blk) >> (fs)->cluster_ratio_bits)
608 /* Translate a cluster number to a block number */
609 #define EXT2FS_C2B(fs, cluster)         ((cluster) << (fs)->cluster_ratio_bits)
610 /* Translate # of blks to # of clusters */
611 #define EXT2FS_NUM_B2C(fs, blks)        (((blks) + EXT2FS_CLUSTER_MASK(fs)) >> \
612                                          (fs)->cluster_ratio_bits)
613
614 #if defined(HAVE_FSTAT64) && !defined(__OSX_AVAILABLE_BUT_DEPRECATED)
615 typedef struct stat64 ext2fs_struct_stat;
616 #else
617 typedef struct stat ext2fs_struct_stat;
618 #endif
619
620 /*
621  * For ext2fs_close2() and ext2fs_flush2(), this flag allows you to
622  * avoid the fsync call.
623  */
624 #define EXT2_FLAG_FLUSH_NO_SYNC          1
625
626 /*
627  * Modify and iterate extended attributes
628  */
629 struct ext2_xattr_handle;
630 #define XATTR_ABORT     1
631 #define XATTR_CHANGED   2
632
633 /*
634  * function prototypes
635  */
636 static inline int ext2fs_has_group_desc_csum(ext2_filsys fs)
637 {
638         return EXT2_HAS_RO_COMPAT_FEATURE(fs->super,
639                         EXT4_FEATURE_RO_COMPAT_GDT_CSUM |
640                         EXT4_FEATURE_RO_COMPAT_METADATA_CSUM);
641 }
642
643 /* The LARGE_FILE feature should be set if we have stored files 2GB+ in size */
644 static inline int ext2fs_needs_large_file_feature(unsigned long long file_size)
645 {
646         return file_size >= 0x80000000ULL;
647 }
648
649 /* alloc.c */
650 extern errcode_t ext2fs_new_inode(ext2_filsys fs, ext2_ino_t dir, int mode,
651                                   ext2fs_inode_bitmap map, ext2_ino_t *ret);
652 extern errcode_t ext2fs_new_block(ext2_filsys fs, blk_t goal,
653                                   ext2fs_block_bitmap map, blk_t *ret);
654 extern errcode_t ext2fs_new_block2(ext2_filsys fs, blk64_t goal,
655                                    ext2fs_block_bitmap map, blk64_t *ret);
656 extern errcode_t ext2fs_get_free_blocks(ext2_filsys fs, blk_t start,
657                                         blk_t finish, int num,
658                                         ext2fs_block_bitmap map,
659                                         blk_t *ret);
660 extern errcode_t ext2fs_get_free_blocks2(ext2_filsys fs, blk64_t start,
661                                          blk64_t finish, int num,
662                                          ext2fs_block_bitmap map,
663                                          blk64_t *ret);
664 extern errcode_t ext2fs_alloc_block(ext2_filsys fs, blk_t goal,
665                                     char *block_buf, blk_t *ret);
666 extern errcode_t ext2fs_alloc_block2(ext2_filsys fs, blk64_t goal,
667                                      char *block_buf, blk64_t *ret);
668 extern void ext2fs_set_alloc_block_callback(ext2_filsys fs,
669                                             errcode_t (*func)(ext2_filsys fs,
670                                                               blk64_t goal,
671                                                               blk64_t *ret),
672                                             errcode_t (**old)(ext2_filsys fs,
673                                                               blk64_t goal,
674                                                               blk64_t *ret));
675 blk64_t ext2fs_find_inode_goal(ext2_filsys fs, ext2_ino_t ino,
676                                struct ext2_inode *inode, blk64_t lblk);
677
678 /* alloc_sb.c */
679 extern int ext2fs_reserve_super_and_bgd(ext2_filsys fs,
680                                         dgrp_t group,
681                                         ext2fs_block_bitmap bmap);
682 extern void ext2fs_set_block_alloc_stats_callback(ext2_filsys fs,
683                                                   void (*func)(ext2_filsys fs,
684                                                                blk64_t blk,
685                                                                int inuse),
686                                                   void (**old)(ext2_filsys fs,
687                                                                blk64_t blk,
688                                                                int inuse));
689
690 /* alloc_stats.c */
691 void ext2fs_inode_alloc_stats(ext2_filsys fs, ext2_ino_t ino, int inuse);
692 void ext2fs_inode_alloc_stats2(ext2_filsys fs, ext2_ino_t ino,
693                                int inuse, int isdir);
694 void ext2fs_block_alloc_stats(ext2_filsys fs, blk_t blk, int inuse);
695 void ext2fs_block_alloc_stats2(ext2_filsys fs, blk64_t blk, int inuse);
696 void ext2fs_block_alloc_stats_range(ext2_filsys fs, blk64_t blk,
697                                     blk_t num, int inuse);
698
699 /* alloc_tables.c */
700 extern errcode_t ext2fs_allocate_tables(ext2_filsys fs);
701 extern errcode_t ext2fs_allocate_group_table(ext2_filsys fs, dgrp_t group,
702                                              ext2fs_block_bitmap bmap);
703
704 /* badblocks.c */
705 extern errcode_t ext2fs_u32_list_create(ext2_u32_list *ret, int size);
706 extern errcode_t ext2fs_u32_list_add(ext2_u32_list bb, __u32 blk);
707 extern int ext2fs_u32_list_find(ext2_u32_list bb, __u32 blk);
708 extern int ext2fs_u32_list_test(ext2_u32_list bb, blk_t blk);
709 extern errcode_t ext2fs_u32_list_iterate_begin(ext2_u32_list bb,
710                                                ext2_u32_iterate *ret);
711 extern int ext2fs_u32_list_iterate(ext2_u32_iterate iter, blk_t *blk);
712 extern void ext2fs_u32_list_iterate_end(ext2_u32_iterate iter);
713 extern errcode_t ext2fs_u32_copy(ext2_u32_list src, ext2_u32_list *dest);
714 extern int ext2fs_u32_list_equal(ext2_u32_list bb1, ext2_u32_list bb2);
715
716 extern errcode_t ext2fs_badblocks_list_create(ext2_badblocks_list *ret,
717                                             int size);
718 extern errcode_t ext2fs_badblocks_list_add(ext2_badblocks_list bb,
719                                            blk_t blk);
720 extern int ext2fs_badblocks_list_test(ext2_badblocks_list bb,
721                                     blk_t blk);
722 extern int ext2fs_u32_list_del(ext2_u32_list bb, __u32 blk);
723 extern void ext2fs_badblocks_list_del(ext2_u32_list bb, __u32 blk);
724 extern errcode_t
725         ext2fs_badblocks_list_iterate_begin(ext2_badblocks_list bb,
726                                             ext2_badblocks_iterate *ret);
727 extern int ext2fs_badblocks_list_iterate(ext2_badblocks_iterate iter,
728                                          blk_t *blk);
729 extern void ext2fs_badblocks_list_iterate_end(ext2_badblocks_iterate iter);
730 extern errcode_t ext2fs_badblocks_copy(ext2_badblocks_list src,
731                                        ext2_badblocks_list *dest);
732 extern int ext2fs_badblocks_equal(ext2_badblocks_list bb1,
733                                   ext2_badblocks_list bb2);
734 extern int ext2fs_u32_list_count(ext2_u32_list bb);
735
736 /* bb_compat */
737 extern errcode_t badblocks_list_create(badblocks_list *ret, int size);
738 extern errcode_t badblocks_list_add(badblocks_list bb, blk_t blk);
739 extern int badblocks_list_test(badblocks_list bb, blk_t blk);
740 extern errcode_t badblocks_list_iterate_begin(badblocks_list bb,
741                                               badblocks_iterate *ret);
742 extern int badblocks_list_iterate(badblocks_iterate iter, blk_t *blk);
743 extern void badblocks_list_iterate_end(badblocks_iterate iter);
744 extern void badblocks_list_free(badblocks_list bb);
745
746 /* bb_inode.c */
747 extern errcode_t ext2fs_update_bb_inode(ext2_filsys fs,
748                                         ext2_badblocks_list bb_list);
749
750 /* bitmaps.c */
751 extern void ext2fs_free_block_bitmap(ext2fs_block_bitmap bitmap);
752 extern void ext2fs_free_inode_bitmap(ext2fs_inode_bitmap bitmap);
753 extern errcode_t ext2fs_copy_bitmap(ext2fs_generic_bitmap src,
754                                     ext2fs_generic_bitmap *dest);
755 extern errcode_t ext2fs_write_inode_bitmap(ext2_filsys fs);
756 extern errcode_t ext2fs_write_block_bitmap (ext2_filsys fs);
757 extern errcode_t ext2fs_read_inode_bitmap (ext2_filsys fs);
758 extern errcode_t ext2fs_read_block_bitmap(ext2_filsys fs);
759 extern errcode_t ext2fs_allocate_block_bitmap(ext2_filsys fs,
760                                               const char *descr,
761                                               ext2fs_block_bitmap *ret);
762 extern errcode_t ext2fs_allocate_subcluster_bitmap(ext2_filsys fs,
763                                                    const char *descr,
764                                                    ext2fs_block_bitmap *ret);
765 extern int ext2fs_get_bitmap_granularity(ext2fs_block_bitmap bitmap);
766 extern errcode_t ext2fs_allocate_inode_bitmap(ext2_filsys fs,
767                                               const char *descr,
768                                               ext2fs_inode_bitmap *ret);
769 extern errcode_t ext2fs_fudge_inode_bitmap_end(ext2fs_inode_bitmap bitmap,
770                                                ext2_ino_t end, ext2_ino_t *oend);
771 extern errcode_t ext2fs_fudge_block_bitmap_end(ext2fs_block_bitmap bitmap,
772                                                blk_t end, blk_t *oend);
773 extern errcode_t ext2fs_fudge_block_bitmap_end2(ext2fs_block_bitmap bitmap,
774                                          blk64_t end, blk64_t *oend);
775 extern void ext2fs_clear_inode_bitmap(ext2fs_inode_bitmap bitmap);
776 extern void ext2fs_clear_block_bitmap(ext2fs_block_bitmap bitmap);
777 extern errcode_t ext2fs_read_bitmaps(ext2_filsys fs);
778 extern errcode_t ext2fs_write_bitmaps(ext2_filsys fs);
779 extern errcode_t ext2fs_resize_inode_bitmap(__u32 new_end, __u32 new_real_end,
780                                             ext2fs_inode_bitmap bmap);
781 extern errcode_t ext2fs_resize_inode_bitmap2(__u64 new_end,
782                                              __u64 new_real_end,
783                                              ext2fs_inode_bitmap bmap);
784 extern errcode_t ext2fs_resize_block_bitmap(__u32 new_end, __u32 new_real_end,
785                                             ext2fs_block_bitmap bmap);
786 extern errcode_t ext2fs_resize_block_bitmap2(__u64 new_end,
787                                              __u64 new_real_end,
788                                              ext2fs_block_bitmap bmap);
789 extern errcode_t ext2fs_compare_block_bitmap(ext2fs_block_bitmap bm1,
790                                              ext2fs_block_bitmap bm2);
791 extern errcode_t ext2fs_compare_inode_bitmap(ext2fs_inode_bitmap bm1,
792                                              ext2fs_inode_bitmap bm2);
793 extern errcode_t ext2fs_set_inode_bitmap_range(ext2fs_inode_bitmap bmap,
794                                         ext2_ino_t start, unsigned int num,
795                                         void *in);
796 extern errcode_t ext2fs_set_inode_bitmap_range2(ext2fs_inode_bitmap bmap,
797                                          __u64 start, size_t num,
798                                          void *in);
799 extern errcode_t ext2fs_get_inode_bitmap_range(ext2fs_inode_bitmap bmap,
800                                         ext2_ino_t start, unsigned int num,
801                                         void *out);
802 extern errcode_t ext2fs_get_inode_bitmap_range2(ext2fs_inode_bitmap bmap,
803                                          __u64 start, size_t num,
804                                          void *out);
805 extern errcode_t ext2fs_set_block_bitmap_range(ext2fs_block_bitmap bmap,
806                                         blk_t start, unsigned int num,
807                                         void *in);
808 extern errcode_t ext2fs_set_block_bitmap_range2(ext2fs_block_bitmap bmap,
809                                          blk64_t start, size_t num,
810                                          void *in);
811 extern errcode_t ext2fs_get_block_bitmap_range(ext2fs_block_bitmap bmap,
812                                         blk_t start, unsigned int num,
813                                         void *out);
814 extern errcode_t ext2fs_get_block_bitmap_range2(ext2fs_block_bitmap bmap,
815                                          blk64_t start, size_t num,
816                                          void *out);
817
818 /* blknum.c */
819 extern __u32 ext2fs_inode_bitmap_checksum(ext2_filsys fs, dgrp_t group);
820 extern __u32 ext2fs_block_bitmap_checksum(ext2_filsys fs, dgrp_t group);
821 extern dgrp_t ext2fs_group_of_blk2(ext2_filsys fs, blk64_t);
822 extern blk64_t ext2fs_group_first_block2(ext2_filsys fs, dgrp_t group);
823 extern blk64_t ext2fs_group_last_block2(ext2_filsys fs, dgrp_t group);
824 extern int ext2fs_group_blocks_count(ext2_filsys fs, dgrp_t group);
825 extern blk64_t ext2fs_inode_data_blocks2(ext2_filsys fs,
826                                          struct ext2_inode *inode);
827 extern blk64_t ext2fs_inode_i_blocks(ext2_filsys fs,
828                                          struct ext2_inode *inode);
829 extern blk64_t ext2fs_blocks_count(struct ext2_super_block *super);
830 extern void ext2fs_blocks_count_set(struct ext2_super_block *super,
831                                     blk64_t blk);
832 extern void ext2fs_blocks_count_add(struct ext2_super_block *super,
833                                     blk64_t blk);
834 extern blk64_t ext2fs_r_blocks_count(struct ext2_super_block *super);
835 extern void ext2fs_r_blocks_count_set(struct ext2_super_block *super,
836                                       blk64_t blk);
837 extern void ext2fs_r_blocks_count_add(struct ext2_super_block *super,
838                                       blk64_t blk);
839 extern blk64_t ext2fs_free_blocks_count(struct ext2_super_block *super);
840 extern void ext2fs_free_blocks_count_set(struct ext2_super_block *super,
841                                          blk64_t blk);
842 extern void ext2fs_free_blocks_count_add(struct ext2_super_block *super,
843                                          blk64_t blk);
844 /* Block group descriptor accessor functions */
845 extern struct ext2_group_desc *ext2fs_group_desc(ext2_filsys fs,
846                                           struct opaque_ext2_group_desc *gdp,
847                                           dgrp_t group);
848 extern blk64_t ext2fs_block_bitmap_csum(ext2_filsys fs, dgrp_t group);
849 extern blk64_t ext2fs_block_bitmap_loc(ext2_filsys fs, dgrp_t group);
850 extern void ext2fs_block_bitmap_loc_set(ext2_filsys fs, dgrp_t group,
851                                         blk64_t blk);
852 extern __u32 ext2fs_inode_bitmap_csum(ext2_filsys fs, dgrp_t group);
853 extern blk64_t ext2fs_inode_bitmap_loc(ext2_filsys fs, dgrp_t group);
854 extern void ext2fs_inode_bitmap_loc_set(ext2_filsys fs, dgrp_t group,
855                                         blk64_t blk);
856 extern blk64_t ext2fs_inode_table_loc(ext2_filsys fs, dgrp_t group);
857 extern void ext2fs_inode_table_loc_set(ext2_filsys fs, dgrp_t group,
858                                        blk64_t blk);
859 extern __u32 ext2fs_bg_free_blocks_count(ext2_filsys fs, dgrp_t group);
860 extern void ext2fs_bg_free_blocks_count_set(ext2_filsys fs, dgrp_t group,
861                                          __u32 n);
862 extern __u32 ext2fs_bg_free_inodes_count(ext2_filsys fs, dgrp_t group);
863 extern void ext2fs_bg_free_inodes_count_set(ext2_filsys fs, dgrp_t group,
864                                          __u32 n);
865 extern __u32 ext2fs_bg_used_dirs_count(ext2_filsys fs, dgrp_t group);
866 extern void ext2fs_bg_used_dirs_count_set(ext2_filsys fs, dgrp_t group,
867                                        __u32 n);
868 extern __u32 ext2fs_bg_itable_unused(ext2_filsys fs, dgrp_t group);
869 extern void ext2fs_bg_itable_unused_set(ext2_filsys fs, dgrp_t group,
870                                      __u32 n);
871 extern __u16 ext2fs_bg_flags(ext2_filsys fs, dgrp_t group);
872 extern void ext2fs_bg_flags_zap(ext2_filsys fs, dgrp_t group);
873 extern int ext2fs_bg_flags_test(ext2_filsys fs, dgrp_t group, __u16 bg_flag);
874 extern void ext2fs_bg_flags_set(ext2_filsys fs, dgrp_t group, __u16 bg_flags);
875 extern void ext2fs_bg_flags_clear(ext2_filsys fs, dgrp_t group, __u16 bg_flags);
876 extern __u16 ext2fs_bg_checksum(ext2_filsys fs, dgrp_t group);
877 extern void ext2fs_bg_checksum_set(ext2_filsys fs, dgrp_t group, __u16 checksum);
878 extern blk64_t ext2fs_file_acl_block(ext2_filsys fs,
879                                      const struct ext2_inode *inode);
880 extern void ext2fs_file_acl_block_set(ext2_filsys fs,
881                                       struct ext2_inode *inode, blk64_t blk);
882 extern errcode_t ext2fs_inode_size_set(ext2_filsys fs, struct ext2_inode *inode,
883                                        ext2_off64_t size);
884
885 /* block.c */
886 extern errcode_t ext2fs_block_iterate(ext2_filsys fs,
887                                       ext2_ino_t        ino,
888                                       int       flags,
889                                       char *block_buf,
890                                       int (*func)(ext2_filsys fs,
891                                                   blk_t *blocknr,
892                                                   int   blockcnt,
893                                                   void  *priv_data),
894                                       void *priv_data);
895 errcode_t ext2fs_block_iterate2(ext2_filsys fs,
896                                 ext2_ino_t      ino,
897                                 int     flags,
898                                 char *block_buf,
899                                 int (*func)(ext2_filsys fs,
900                                             blk_t       *blocknr,
901                                             e2_blkcnt_t blockcnt,
902                                             blk_t       ref_blk,
903                                             int         ref_offset,
904                                             void        *priv_data),
905                                 void *priv_data);
906 errcode_t ext2fs_block_iterate3(ext2_filsys fs,
907                                 ext2_ino_t ino,
908                                 int     flags,
909                                 char *block_buf,
910                                 int (*func)(ext2_filsys fs,
911                                             blk64_t     *blocknr,
912                                             e2_blkcnt_t blockcnt,
913                                             blk64_t     ref_blk,
914                                             int         ref_offset,
915                                             void        *priv_data),
916                                 void *priv_data);
917
918 /* bmap.c */
919 extern errcode_t ext2fs_bmap(ext2_filsys fs, ext2_ino_t ino,
920                              struct ext2_inode *inode,
921                              char *block_buf, int bmap_flags,
922                              blk_t block, blk_t *phys_blk);
923 extern errcode_t ext2fs_bmap2(ext2_filsys fs, ext2_ino_t ino,
924                               struct ext2_inode *inode,
925                               char *block_buf, int bmap_flags, blk64_t block,
926                               int *ret_flags, blk64_t *phys_blk);
927 errcode_t ext2fs_map_cluster_block(ext2_filsys fs, ext2_ino_t ino,
928                                    struct ext2_inode *inode, blk64_t lblk,
929                                    blk64_t *pblk);
930
931 #if 0
932 /* bmove.c */
933 extern errcode_t ext2fs_move_blocks(ext2_filsys fs,
934                                     ext2fs_block_bitmap reserve,
935                                     ext2fs_block_bitmap alloc_map,
936                                     int flags);
937 #endif
938
939 /* check_desc.c */
940 extern errcode_t ext2fs_check_desc(ext2_filsys fs);
941
942 /* closefs.c */
943 extern errcode_t ext2fs_close(ext2_filsys fs);
944 extern errcode_t ext2fs_close2(ext2_filsys fs, int flags);
945 extern errcode_t ext2fs_close_free(ext2_filsys *fs);
946 extern errcode_t ext2fs_flush(ext2_filsys fs);
947 extern errcode_t ext2fs_flush2(ext2_filsys fs, int flags);
948 extern int ext2fs_bg_has_super(ext2_filsys fs, dgrp_t group_block);
949 extern errcode_t ext2fs_super_and_bgd_loc2(ext2_filsys fs,
950                                     dgrp_t group,
951                                     blk64_t *ret_super_blk,
952                                     blk64_t *ret_old_desc_blk,
953                                     blk64_t *ret_new_desc_blk,
954                                     blk_t *ret_used_blks);
955 extern int ext2fs_super_and_bgd_loc(ext2_filsys fs,
956                                     dgrp_t group,
957                                     blk_t *ret_super_blk,
958                                     blk_t *ret_old_desc_blk,
959                                     blk_t *ret_new_desc_blk,
960                                     int *ret_meta_bg);
961 extern void ext2fs_update_dynamic_rev(ext2_filsys fs);
962
963 /* crc32c.c */
964 extern __u32 ext2fs_crc32_be(__u32 crc, unsigned char const *p, size_t len);
965 extern __u32 ext2fs_crc32c_le(__u32 crc, unsigned char const *p, size_t len);
966
967 /* csum.c */
968 extern errcode_t ext2fs_mmp_csum_set(ext2_filsys fs, struct mmp_struct *mmp);
969 extern int ext2fs_mmp_csum_verify(ext2_filsys, struct mmp_struct *mmp);
970 extern int ext2fs_verify_csum_type(ext2_filsys fs, struct ext2_super_block *sb);
971 extern errcode_t ext2fs_superblock_csum_set(ext2_filsys fs,
972                                             struct ext2_super_block *sb);
973 extern int ext2fs_superblock_csum_verify(ext2_filsys fs,
974                                          struct ext2_super_block *sb);
975 extern errcode_t ext2fs_ext_attr_block_csum_set(ext2_filsys fs,
976                                         ext2_ino_t inum, blk64_t block,
977                                         struct ext2_ext_attr_header *hdr);
978 extern int ext2fs_ext_attr_block_csum_verify(ext2_filsys fs, ext2_ino_t inum,
979                                              blk64_t block,
980                                              struct ext2_ext_attr_header *hdr);
981 #define EXT2_DIRENT_TAIL(block, blocksize) \
982         ((struct ext2_dir_entry_tail *)(((char *)(block)) + \
983         (blocksize) - sizeof(struct ext2_dir_entry_tail)))
984
985 extern void ext2fs_initialize_dirent_tail(ext2_filsys fs,
986                                           struct ext2_dir_entry_tail *t);
987 extern int ext2fs_dirent_has_tail(ext2_filsys fs,
988                                   struct ext2_dir_entry *dirent);
989 extern int ext2fs_dirent_csum_verify(ext2_filsys fs, ext2_ino_t inum,
990                                      struct ext2_dir_entry *dirent);
991 extern int ext2fs_dir_block_csum_verify(ext2_filsys fs, ext2_ino_t inum,
992                                         struct ext2_dir_entry *dirent);
993 extern errcode_t ext2fs_dir_block_csum_set(ext2_filsys fs, ext2_ino_t inum,
994                                            struct ext2_dir_entry *dirent);
995 extern errcode_t ext2fs_get_dx_countlimit(ext2_filsys fs,
996                                           struct ext2_dir_entry *dirent,
997                                           struct ext2_dx_countlimit **cc,
998                                           int *offset);
999 extern errcode_t ext2fs_extent_block_csum_set(ext2_filsys fs,
1000                                               ext2_ino_t inum,
1001                                               struct ext3_extent_header *eh);
1002 extern int ext2fs_extent_block_csum_verify(ext2_filsys fs,
1003                                            ext2_ino_t inum,
1004                                            struct ext3_extent_header *eh);
1005 extern errcode_t ext2fs_block_bitmap_csum_set(ext2_filsys fs, dgrp_t group,
1006                                               char *bitmap, int size);
1007 extern int ext2fs_block_bitmap_csum_verify(ext2_filsys fs, dgrp_t group,
1008                                            char *bitmap, int size);
1009 extern errcode_t ext2fs_inode_bitmap_csum_set(ext2_filsys fs, dgrp_t group,
1010                                               char *bitmap, int size);
1011 extern int ext2fs_inode_bitmap_csum_verify(ext2_filsys fs, dgrp_t group,
1012                                            char *bitmap, int size);
1013 extern errcode_t ext2fs_inode_csum_set(ext2_filsys fs, ext2_ino_t inum,
1014                                        struct ext2_inode_large *inode);
1015 extern int ext2fs_inode_csum_verify(ext2_filsys fs, ext2_ino_t inum,
1016                                     struct ext2_inode_large *inode);
1017 extern void ext2fs_group_desc_csum_set(ext2_filsys fs, dgrp_t group);
1018 extern int ext2fs_group_desc_csum_verify(ext2_filsys fs, dgrp_t group);
1019 extern errcode_t ext2fs_set_gdt_csum(ext2_filsys fs);
1020 extern __u16 ext2fs_group_desc_csum(ext2_filsys fs, dgrp_t group);
1021
1022 /* dblist.c */
1023 extern errcode_t ext2fs_init_dblist(ext2_filsys fs, ext2_dblist *ret_dblist);
1024 extern errcode_t ext2fs_add_dir_block(ext2_dblist dblist, ext2_ino_t ino,
1025                                       blk_t blk, int blockcnt);
1026 extern errcode_t ext2fs_add_dir_block2(ext2_dblist dblist, ext2_ino_t ino,
1027                                        blk64_t blk, e2_blkcnt_t blockcnt);
1028 extern void ext2fs_dblist_sort(ext2_dblist dblist,
1029                                EXT2_QSORT_TYPE (*sortfunc)(const void *,
1030                                                            const void *));
1031 extern void ext2fs_dblist_sort2(ext2_dblist dblist,
1032                                 EXT2_QSORT_TYPE (*sortfunc)(const void *,
1033                                                             const void *));
1034 extern errcode_t ext2fs_dblist_iterate(ext2_dblist dblist,
1035         int (*func)(ext2_filsys fs, struct ext2_db_entry *db_info,
1036                     void        *priv_data),
1037         void *priv_data);
1038 extern errcode_t ext2fs_dblist_iterate2(ext2_dblist dblist,
1039         int (*func)(ext2_filsys fs, struct ext2_db_entry2 *db_info,
1040                     void        *priv_data),
1041         void *priv_data);
1042 extern errcode_t ext2fs_dblist_iterate3(ext2_dblist dblist,
1043         int (*func)(ext2_filsys fs, struct ext2_db_entry2 *db_info,
1044                     void        *priv_data),
1045         unsigned long long start,
1046         unsigned long long count,
1047         void *priv_data);
1048 extern errcode_t ext2fs_set_dir_block(ext2_dblist dblist, ext2_ino_t ino,
1049                                       blk_t blk, int blockcnt);
1050 extern errcode_t ext2fs_set_dir_block2(ext2_dblist dblist, ext2_ino_t ino,
1051                                        blk64_t blk, e2_blkcnt_t blockcnt);
1052 extern errcode_t ext2fs_copy_dblist(ext2_dblist src,
1053                                     ext2_dblist *dest);
1054 extern int ext2fs_dblist_count(ext2_dblist dblist);
1055 extern blk64_t ext2fs_dblist_count2(ext2_dblist dblist);
1056 extern errcode_t ext2fs_dblist_get_last(ext2_dblist dblist,
1057                                         struct ext2_db_entry **entry);
1058 extern errcode_t ext2fs_dblist_get_last2(ext2_dblist dblist,
1059                                         struct ext2_db_entry2 **entry);
1060 extern errcode_t ext2fs_dblist_drop_last(ext2_dblist dblist);
1061
1062 /* dblist_dir.c */
1063 extern errcode_t
1064         ext2fs_dblist_dir_iterate(ext2_dblist dblist,
1065                                   int   flags,
1066                                   char  *block_buf,
1067                                   int (*func)(ext2_ino_t        dir,
1068                                               int               entry,
1069                                               struct ext2_dir_entry *dirent,
1070                                               int       offset,
1071                                               int       blocksize,
1072                                               char      *buf,
1073                                               void      *priv_data),
1074                                   void *priv_data);
1075
1076 #if 0
1077 /* digest_encode.c */
1078 #define EXT2FS_DIGEST_SIZE EXT2FS_SHA256_LENGTH
1079 extern int ext2fs_digest_encode(const char *src, int len, char *dst);
1080 extern int ext2fs_digest_decode(const char *src, int len, char *dst);
1081 #endif
1082
1083 /* dirblock.c */
1084 extern errcode_t ext2fs_read_dir_block(ext2_filsys fs, blk_t block,
1085                                        void *buf);
1086 extern errcode_t ext2fs_read_dir_block2(ext2_filsys fs, blk_t block,
1087                                         void *buf, int flags);
1088 extern errcode_t ext2fs_read_dir_block3(ext2_filsys fs, blk64_t block,
1089                                         void *buf, int flags);
1090 extern errcode_t ext2fs_read_dir_block4(ext2_filsys fs, blk64_t block,
1091                                         void *buf, int flags, ext2_ino_t ino);
1092 extern errcode_t ext2fs_write_dir_block(ext2_filsys fs, blk_t block,
1093                                         void *buf);
1094 extern errcode_t ext2fs_write_dir_block2(ext2_filsys fs, blk_t block,
1095                                          void *buf, int flags);
1096 extern errcode_t ext2fs_write_dir_block3(ext2_filsys fs, blk64_t block,
1097                                          void *buf, int flags);
1098 extern errcode_t ext2fs_write_dir_block4(ext2_filsys fs, blk64_t block,
1099                                          void *buf, int flags, ext2_ino_t ino);
1100
1101 /* dirhash.c */
1102 extern errcode_t ext2fs_dirhash(int version, const char *name, int len,
1103                                 const __u32 *seed,
1104                                 ext2_dirhash_t *ret_hash,
1105                                 ext2_dirhash_t *ret_minor_hash);
1106
1107
1108 /* dir_iterate.c */
1109 extern errcode_t ext2fs_get_rec_len(ext2_filsys fs,
1110                                     struct ext2_dir_entry *dirent,
1111                                     unsigned int *rec_len);
1112 extern errcode_t ext2fs_set_rec_len(ext2_filsys fs,
1113                                     unsigned int len,
1114                                     struct ext2_dir_entry *dirent);
1115 extern errcode_t ext2fs_dir_iterate(ext2_filsys fs,
1116                               ext2_ino_t dir,
1117                               int flags,
1118                               char *block_buf,
1119                               int (*func)(struct ext2_dir_entry *dirent,
1120                                           int   offset,
1121                                           int   blocksize,
1122                                           char  *buf,
1123                                           void  *priv_data),
1124                               void *priv_data);
1125 extern errcode_t ext2fs_dir_iterate2(ext2_filsys fs,
1126                               ext2_ino_t dir,
1127                               int flags,
1128                               char *block_buf,
1129                               int (*func)(ext2_ino_t    dir,
1130                                           int   entry,
1131                                           struct ext2_dir_entry *dirent,
1132                                           int   offset,
1133                                           int   blocksize,
1134                                           char  *buf,
1135                                           void  *priv_data),
1136                               void *priv_data);
1137
1138 /* dupfs.c */
1139 extern errcode_t ext2fs_dup_handle(ext2_filsys src, ext2_filsys *dest);
1140
1141 /* expanddir.c */
1142 extern errcode_t ext2fs_expand_dir(ext2_filsys fs, ext2_ino_t dir);
1143
1144 /* ext_attr.c */
1145 extern __u32 ext2fs_ext_attr_hash_entry(struct ext2_ext_attr_entry *entry,
1146                                         void *data);
1147 extern errcode_t ext2fs_read_ext_attr(ext2_filsys fs, blk_t block, void *buf);
1148 extern errcode_t ext2fs_read_ext_attr2(ext2_filsys fs, blk64_t block,
1149                                        void *buf);
1150 extern errcode_t ext2fs_read_ext_attr3(ext2_filsys fs, blk64_t block,
1151                                        void *buf, ext2_ino_t inum);
1152 extern errcode_t ext2fs_write_ext_attr(ext2_filsys fs, blk_t block,
1153                                        void *buf);
1154 extern errcode_t ext2fs_write_ext_attr2(ext2_filsys fs, blk64_t block,
1155                                        void *buf);
1156 extern errcode_t ext2fs_write_ext_attr3(ext2_filsys fs, blk64_t block,
1157                                        void *buf, ext2_ino_t inum);
1158 extern errcode_t ext2fs_adjust_ea_refcount(ext2_filsys fs, blk_t blk,
1159                                            char *block_buf,
1160                                            int adjust, __u32 *newcount);
1161 extern errcode_t ext2fs_adjust_ea_refcount2(ext2_filsys fs, blk64_t blk,
1162                                            char *block_buf,
1163                                            int adjust, __u32 *newcount);
1164 extern errcode_t ext2fs_adjust_ea_refcount3(ext2_filsys fs, blk64_t blk,
1165                                            char *block_buf,
1166                                            int adjust, __u32 *newcount,
1167                                            ext2_ino_t inum);
1168 errcode_t ext2fs_xattrs_write(struct ext2_xattr_handle *handle);
1169 errcode_t ext2fs_xattrs_read(struct ext2_xattr_handle *handle);
1170 errcode_t ext2fs_xattrs_iterate(struct ext2_xattr_handle *h,
1171                                 int (*func)(char *name, char *value,
1172                                             size_t value_len, void *data),
1173                                 void *data);
1174 errcode_t ext2fs_xattr_get(struct ext2_xattr_handle *h, const char *key,
1175                            void **value, size_t *value_len);
1176 errcode_t ext2fs_xattr_set(struct ext2_xattr_handle *handle,
1177                            const char *key,
1178                            const void *value,
1179                            size_t value_len);
1180 errcode_t ext2fs_xattr_remove(struct ext2_xattr_handle *handle,
1181                               const char *key);
1182 errcode_t ext2fs_xattrs_open(ext2_filsys fs, ext2_ino_t ino,
1183                              struct ext2_xattr_handle **handle);
1184 errcode_t ext2fs_xattrs_close(struct ext2_xattr_handle **handle);
1185 errcode_t ext2fs_free_ext_attr(ext2_filsys fs, ext2_ino_t ino,
1186                                struct ext2_inode_large *inode);
1187 errcode_t ext2fs_xattrs_count(struct ext2_xattr_handle *handle, size_t *count);
1188 errcode_t ext2fs_xattr_inode_max_size(ext2_filsys fs, ext2_ino_t ino,
1189                                       size_t *size);
1190
1191 /* extent.c */
1192 extern errcode_t ext2fs_extent_header_verify(void *ptr, int size);
1193 extern errcode_t ext2fs_extent_open(ext2_filsys fs, ext2_ino_t ino,
1194                                     ext2_extent_handle_t *handle);
1195 extern errcode_t ext2fs_extent_open2(ext2_filsys fs, ext2_ino_t ino,
1196                                         struct ext2_inode *inode,
1197                                         ext2_extent_handle_t *ret_handle);
1198 extern void ext2fs_extent_free(ext2_extent_handle_t handle);
1199 extern errcode_t ext2fs_extent_get(ext2_extent_handle_t handle,
1200                                    int flags, struct ext2fs_extent *extent);
1201 extern errcode_t ext2fs_extent_node_split(ext2_extent_handle_t handle);
1202 extern errcode_t ext2fs_extent_replace(ext2_extent_handle_t handle, int flags,
1203                                        struct ext2fs_extent *extent);
1204 extern errcode_t ext2fs_extent_insert(ext2_extent_handle_t handle, int flags,
1205                                       struct ext2fs_extent *extent);
1206 extern errcode_t ext2fs_extent_set_bmap(ext2_extent_handle_t handle,
1207                                         blk64_t logical, blk64_t physical,
1208                                         int flags);
1209 extern errcode_t ext2fs_extent_delete(ext2_extent_handle_t handle, int flags);
1210 extern errcode_t ext2fs_extent_get_info(ext2_extent_handle_t handle,
1211                                         struct ext2_extent_info *info);
1212 extern errcode_t ext2fs_extent_goto(ext2_extent_handle_t handle,
1213                                     blk64_t blk);
1214 extern errcode_t ext2fs_extent_goto2(ext2_extent_handle_t handle,
1215                                      int leaf_level, blk64_t blk);
1216 extern errcode_t ext2fs_extent_fix_parents(ext2_extent_handle_t handle);
1217 size_t ext2fs_max_extent_depth(ext2_extent_handle_t handle);
1218
1219 /* fileio.c */
1220 extern errcode_t ext2fs_file_open2(ext2_filsys fs, ext2_ino_t ino,
1221                                    struct ext2_inode *inode,
1222                                    int flags, ext2_file_t *ret);
1223 extern errcode_t ext2fs_file_open(ext2_filsys fs, ext2_ino_t ino,
1224                                   int flags, ext2_file_t *ret);
1225 extern ext2_filsys ext2fs_file_get_fs(ext2_file_t file);
1226 struct ext2_inode *ext2fs_file_get_inode(ext2_file_t file);
1227 extern ext2_ino_t ext2fs_file_get_inode_num(ext2_file_t file);
1228 extern errcode_t ext2fs_file_close(ext2_file_t file);
1229 extern errcode_t ext2fs_file_flush(ext2_file_t file);
1230 extern errcode_t ext2fs_file_read(ext2_file_t file, void *buf,
1231                                   unsigned int wanted, unsigned int *got);
1232 extern errcode_t ext2fs_file_write(ext2_file_t file, const void *buf,
1233                                    unsigned int nbytes, unsigned int *written);
1234 extern errcode_t ext2fs_file_llseek(ext2_file_t file, __u64 offset,
1235                                    int whence, __u64 *ret_pos);
1236 extern errcode_t ext2fs_file_lseek(ext2_file_t file, ext2_off_t offset,
1237                                    int whence, ext2_off_t *ret_pos);
1238 errcode_t ext2fs_file_get_lsize(ext2_file_t file, __u64 *ret_size);
1239 extern ext2_off_t ext2fs_file_get_size(ext2_file_t file);
1240 extern errcode_t ext2fs_file_set_size(ext2_file_t file, ext2_off_t size);
1241 extern errcode_t ext2fs_file_set_size2(ext2_file_t file, ext2_off64_t size);
1242
1243 /* finddev.c */
1244 extern char *ext2fs_find_block_device(dev_t device);
1245
1246 /* flushb.c */
1247 extern errcode_t ext2fs_sync_device(int fd, int flushb);
1248
1249 /* freefs.c */
1250 extern void ext2fs_free(ext2_filsys fs);
1251 extern void ext2fs_free_dblist(ext2_dblist dblist);
1252 extern void ext2fs_badblocks_list_free(ext2_badblocks_list bb);
1253 extern void ext2fs_u32_list_free(ext2_u32_list bb);
1254
1255 /* gen_bitmap.c */
1256 extern void ext2fs_free_generic_bitmap(ext2fs_inode_bitmap bitmap);
1257 extern errcode_t ext2fs_make_generic_bitmap(errcode_t magic, ext2_filsys fs,
1258                                             __u32 start, __u32 end,
1259                                             __u32 real_end,
1260                                             const char *descr, char *init_map,
1261                                             ext2fs_generic_bitmap *ret);
1262 extern errcode_t ext2fs_allocate_generic_bitmap(__u32 start,
1263                                                 __u32 end,
1264                                                 __u32 real_end,
1265                                                 const char *descr,
1266                                                 ext2fs_generic_bitmap *ret);
1267 extern errcode_t ext2fs_copy_generic_bitmap(ext2fs_generic_bitmap src,
1268                                             ext2fs_generic_bitmap *dest);
1269 extern void ext2fs_clear_generic_bitmap(ext2fs_generic_bitmap bitmap);
1270 extern errcode_t ext2fs_fudge_generic_bitmap_end(ext2fs_inode_bitmap bitmap,
1271                                                  errcode_t magic,
1272                                                  errcode_t neq,
1273                                                  ext2_ino_t end,
1274                                                  ext2_ino_t *oend);
1275 extern void ext2fs_set_generic_bitmap_padding(ext2fs_generic_bitmap map);
1276 extern errcode_t ext2fs_resize_generic_bitmap(errcode_t magic,
1277                                               __u32 new_end,
1278                                               __u32 new_real_end,
1279                                               ext2fs_generic_bitmap bmap);
1280 extern errcode_t ext2fs_compare_generic_bitmap(errcode_t magic, errcode_t neq,
1281                                                ext2fs_generic_bitmap bm1,
1282                                                ext2fs_generic_bitmap bm2);
1283 extern errcode_t ext2fs_get_generic_bitmap_range(ext2fs_generic_bitmap bmap,
1284                                                  errcode_t magic,
1285                                                  __u32 start, __u32 num,
1286                                                  void *out);
1287 extern errcode_t ext2fs_set_generic_bitmap_range(ext2fs_generic_bitmap bmap,
1288                                                  errcode_t magic,
1289                                                  __u32 start, __u32 num,
1290                                                  void *in);
1291 extern errcode_t ext2fs_find_first_zero_generic_bitmap(ext2fs_generic_bitmap bitmap,
1292                                                        __u32 start, __u32 end,
1293                                                        __u32 *out);
1294 extern errcode_t ext2fs_find_first_set_generic_bitmap(ext2fs_generic_bitmap bitmap,
1295                                                        __u32 start, __u32 end,
1296                                                        __u32 *out);
1297
1298 /* gen_bitmap64.c */
1299 void ext2fs_free_generic_bmap(ext2fs_generic_bitmap bmap);
1300 errcode_t ext2fs_alloc_generic_bmap(ext2_filsys fs, errcode_t magic,
1301                                     int type, __u64 start, __u64 end,
1302                                     __u64 real_end,
1303                                     const char *descr,
1304                                     ext2fs_generic_bitmap *ret);
1305 errcode_t ext2fs_copy_generic_bmap(ext2fs_generic_bitmap src,
1306                                    ext2fs_generic_bitmap *dest);
1307 void ext2fs_clear_generic_bmap(ext2fs_generic_bitmap bitmap);
1308 errcode_t ext2fs_fudge_generic_bmap_end(ext2fs_generic_bitmap bitmap,
1309                                         errcode_t neq,
1310                                         __u64 end, __u64 *oend);
1311 void ext2fs_set_generic_bmap_padding(ext2fs_generic_bitmap bmap);
1312 errcode_t ext2fs_resize_generic_bmap(ext2fs_generic_bitmap bmap,
1313                                      __u64 new_end,
1314                                      __u64 new_real_end);
1315 errcode_t ext2fs_compare_generic_bmap(errcode_t neq,
1316                                       ext2fs_generic_bitmap bm1,
1317                                       ext2fs_generic_bitmap bm2);
1318 errcode_t ext2fs_get_generic_bmap_range(ext2fs_generic_bitmap bmap,
1319                                         __u64 start, unsigned int num,
1320                                         void *out);
1321 errcode_t ext2fs_set_generic_bmap_range(ext2fs_generic_bitmap bmap,
1322                                         __u64 start, unsigned int num,
1323                                         void *in);
1324 errcode_t ext2fs_convert_subcluster_bitmap(ext2_filsys fs,
1325                                            ext2fs_block_bitmap *bitmap);
1326
1327 /* get_num_dirs.c */
1328 extern errcode_t ext2fs_get_num_dirs(ext2_filsys fs, ext2_ino_t *ret_num_dirs);
1329
1330 /* getsize.c */
1331 extern errcode_t ext2fs_get_device_size(const char *file, int blocksize,
1332                                         blk_t *retblocks);
1333 extern errcode_t ext2fs_get_device_size2(const char *file, int blocksize,
1334                                         blk64_t *retblocks);
1335
1336 /* getsectsize.c */
1337 extern int ext2fs_get_dio_alignment(int fd);
1338 errcode_t ext2fs_get_device_sectsize(const char *file, int *sectsize);
1339 errcode_t ext2fs_get_device_phys_sectsize(const char *file, int *sectsize);
1340
1341 /* i_block.c */
1342 errcode_t ext2fs_iblk_add_blocks(ext2_filsys fs, struct ext2_inode *inode,
1343                                  blk64_t num_blocks);
1344 errcode_t ext2fs_iblk_sub_blocks(ext2_filsys fs, struct ext2_inode *inode,
1345                                  blk64_t num_blocks);
1346 errcode_t ext2fs_iblk_set(ext2_filsys fs, struct ext2_inode *inode, blk64_t b);
1347
1348 /* imager.c */
1349 extern errcode_t ext2fs_image_inode_write(ext2_filsys fs, int fd, int flags);
1350 extern errcode_t ext2fs_image_inode_read(ext2_filsys fs, int fd, int flags);
1351 extern errcode_t ext2fs_image_super_write(ext2_filsys fs, int fd, int flags);
1352 extern errcode_t ext2fs_image_super_read(ext2_filsys fs, int fd, int flags);
1353 extern errcode_t ext2fs_image_bitmap_write(ext2_filsys fs, int fd, int flags);
1354 extern errcode_t ext2fs_image_bitmap_read(ext2_filsys fs, int fd, int flags);
1355
1356 /* ind_block.c */
1357 errcode_t ext2fs_read_ind_block(ext2_filsys fs, blk_t blk, void *buf);
1358 errcode_t ext2fs_write_ind_block(ext2_filsys fs, blk_t blk, void *buf);
1359
1360 /* initialize.c */
1361 extern errcode_t ext2fs_initialize(const char *name, int flags,
1362                                    struct ext2_super_block *param,
1363                                    io_manager manager, ext2_filsys *ret_fs);
1364
1365 /* icount.c */
1366 extern void ext2fs_free_icount(ext2_icount_t icount);
1367 extern errcode_t ext2fs_create_icount_tdb(ext2_filsys fs, char *tdb_dir,
1368                                           int flags, ext2_icount_t *ret);
1369 extern errcode_t ext2fs_create_icount2(ext2_filsys fs, int flags,
1370                                        unsigned int size,
1371                                        ext2_icount_t hint, ext2_icount_t *ret);
1372 extern errcode_t ext2fs_create_icount(ext2_filsys fs, int flags,
1373                                       unsigned int size,
1374                                       ext2_icount_t *ret);
1375 extern errcode_t ext2fs_icount_fetch(ext2_icount_t icount, ext2_ino_t ino,
1376                                      __u16 *ret);
1377 extern errcode_t ext2fs_icount_increment(ext2_icount_t icount, ext2_ino_t ino,
1378                                          __u16 *ret);
1379 extern errcode_t ext2fs_icount_decrement(ext2_icount_t icount, ext2_ino_t ino,
1380                                          __u16 *ret);
1381 extern errcode_t ext2fs_icount_store(ext2_icount_t icount, ext2_ino_t ino,
1382                                      __u16 count);
1383 extern ext2_ino_t ext2fs_get_icount_size(ext2_icount_t icount);
1384 errcode_t ext2fs_icount_validate(ext2_icount_t icount, FILE *);
1385
1386 /* inline.c */
1387
1388 extern errcode_t ext2fs_get_memalign(unsigned long size,
1389                                      unsigned long align, void *ptr);
1390
1391 /* inline_data.c */
1392 extern errcode_t ext2fs_inline_data_init(ext2_filsys fs, ext2_ino_t ino);
1393 extern errcode_t ext2fs_inline_data_size(ext2_filsys fs, ext2_ino_t ino,
1394                                          size_t *size);
1395 extern errcode_t ext2fs_inline_data_get(ext2_filsys fs, ext2_ino_t ino,
1396                                         struct ext2_inode *inode,
1397                                         void *buf, size_t *size);
1398 extern errcode_t ext2fs_inline_data_set(ext2_filsys fs, ext2_ino_t ino,
1399                                         struct ext2_inode *inode,
1400                                         void *buf, size_t size);
1401
1402 /* inode.c */
1403 extern errcode_t ext2fs_create_inode_cache(ext2_filsys fs,
1404                                            unsigned int cache_size);
1405 extern void ext2fs_free_inode_cache(struct ext2_inode_cache *icache);
1406 extern errcode_t ext2fs_flush_icache(ext2_filsys fs);
1407 extern errcode_t ext2fs_get_next_inode_full(ext2_inode_scan scan,
1408                                             ext2_ino_t *ino,
1409                                             struct ext2_inode *inode,
1410                                             int bufsize);
1411 #define EXT2_INODE_SCAN_DEFAULT_BUFFER_BLOCKS   8
1412 extern errcode_t ext2fs_open_inode_scan(ext2_filsys fs, int buffer_blocks,
1413                                   ext2_inode_scan *ret_scan);
1414 extern void ext2fs_close_inode_scan(ext2_inode_scan scan);
1415 extern errcode_t ext2fs_get_next_inode(ext2_inode_scan scan, ext2_ino_t *ino,
1416                                struct ext2_inode *inode);
1417 extern errcode_t ext2fs_inode_scan_goto_blockgroup(ext2_inode_scan scan,
1418                                                    int  group);
1419 extern void ext2fs_set_inode_callback
1420         (ext2_inode_scan scan,
1421          errcode_t (*done_group)(ext2_filsys fs,
1422                                  ext2_inode_scan scan,
1423                                  dgrp_t group,
1424                                  void * priv_data),
1425          void *done_group_data);
1426 extern int ext2fs_inode_scan_flags(ext2_inode_scan scan, int set_flags,
1427                                    int clear_flags);
1428 extern errcode_t ext2fs_read_inode_full(ext2_filsys fs, ext2_ino_t ino,
1429                                         struct ext2_inode * inode,
1430                                         int bufsize);
1431 extern errcode_t ext2fs_read_inode (ext2_filsys fs, ext2_ino_t ino,
1432                             struct ext2_inode * inode);
1433 extern errcode_t ext2fs_write_inode_full(ext2_filsys fs, ext2_ino_t ino,
1434                                          struct ext2_inode * inode,
1435                                          int bufsize);
1436 extern errcode_t ext2fs_write_inode(ext2_filsys fs, ext2_ino_t ino,
1437                             struct ext2_inode * inode);
1438 extern errcode_t ext2fs_write_new_inode(ext2_filsys fs, ext2_ino_t ino,
1439                             struct ext2_inode * inode);
1440 extern errcode_t ext2fs_get_blocks(ext2_filsys fs, ext2_ino_t ino, blk_t *blocks);
1441 extern errcode_t ext2fs_check_directory(ext2_filsys fs, ext2_ino_t ino);
1442
1443 /* inode_io.c */
1444 extern io_manager inode_io_manager;
1445 extern errcode_t ext2fs_inode_io_intern(ext2_filsys fs, ext2_ino_t ino,
1446                                         char **name);
1447 extern errcode_t ext2fs_inode_io_intern2(ext2_filsys fs, ext2_ino_t ino,
1448                                          struct ext2_inode *inode,
1449                                          char **name);
1450
1451 /* ismounted.c */
1452 extern errcode_t ext2fs_check_if_mounted(const char *file, int *mount_flags);
1453 extern errcode_t ext2fs_check_mount_point(const char *device, int *mount_flags,
1454                                           char *mtpt, int mtlen);
1455
1456 /* punch.c */
1457 /*
1458  * NOTE: This function removes from an inode the blocks "start", "end", and
1459  * every block in between.
1460  */
1461 extern errcode_t ext2fs_punch(ext2_filsys fs, ext2_ino_t ino,
1462                               struct ext2_inode *inode,
1463                               char *block_buf, blk64_t start,
1464                               blk64_t end);
1465
1466 /* namei.c */
1467 extern errcode_t ext2fs_lookup(ext2_filsys fs, ext2_ino_t dir, const char *name,
1468                          int namelen, char *buf, ext2_ino_t *inode);
1469 extern errcode_t ext2fs_namei(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
1470                         const char *name, ext2_ino_t *inode);
1471 errcode_t ext2fs_namei_follow(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
1472                               const char *name, ext2_ino_t *inode);
1473 extern errcode_t ext2fs_follow_link(ext2_filsys fs, ext2_ino_t root, ext2_ino_t cwd,
1474                         ext2_ino_t inode, ext2_ino_t *res_inode);
1475
1476 /* native.c */
1477 int ext2fs_native_flag(void);
1478
1479 /* newdir.c */
1480 extern errcode_t ext2fs_new_dir_block(ext2_filsys fs, ext2_ino_t dir_ino,
1481                                 ext2_ino_t parent_ino, char **block);
1482 extern errcode_t ext2fs_new_dir_inline_data(ext2_filsys fs, ext2_ino_t dir_ino,
1483                                 ext2_ino_t parent_ino, __u32 *iblock);
1484
1485 /* mkdir.c */
1486 extern errcode_t ext2fs_mkdir(ext2_filsys fs, ext2_ino_t parent, ext2_ino_t inum,
1487                               const char *name);
1488
1489 /* mkjournal.c */
1490 extern errcode_t ext2fs_zero_blocks(ext2_filsys fs, blk_t blk, int num,
1491                                     blk_t *ret_blk, int *ret_count);
1492 extern errcode_t ext2fs_zero_blocks2(ext2_filsys fs, blk64_t blk, int num,
1493                                      blk64_t *ret_blk, int *ret_count);
1494 extern errcode_t ext2fs_create_journal_superblock(ext2_filsys fs,
1495                                                   __u32 num_blocks, int flags,
1496                                                   char  **ret_jsb);
1497 extern errcode_t ext2fs_add_journal_device(ext2_filsys fs,
1498                                            ext2_filsys journal_dev);
1499 extern errcode_t ext2fs_add_journal_inode(ext2_filsys fs, blk_t num_blocks,
1500                                           int flags);
1501 extern errcode_t ext2fs_add_journal_inode2(ext2_filsys fs, blk_t num_blocks,
1502                                            blk64_t goal, int flags);
1503 extern int ext2fs_default_journal_size(__u64 num_blocks);
1504 extern int ext2fs_journal_sb_start(int blocksize);
1505
1506 /* openfs.c */
1507 extern errcode_t ext2fs_open(const char *name, int flags, int superblock,
1508                              unsigned int block_size, io_manager manager,
1509                              ext2_filsys *ret_fs);
1510 extern errcode_t ext2fs_open2(const char *name, const char *io_options,
1511                               int flags, int superblock,
1512                               unsigned int block_size, io_manager manager,
1513                               ext2_filsys *ret_fs);
1514 /*
1515  * The dgrp_t argument to these two functions is not actually a group number
1516  * but a block number offset within a group table!  Convert with the formula
1517  * (group_number / groups_per_block).
1518  */
1519 extern blk64_t ext2fs_descriptor_block_loc2(ext2_filsys fs,
1520                                         blk64_t group_block, dgrp_t i);
1521 extern blk_t ext2fs_descriptor_block_loc(ext2_filsys fs, blk_t group_block,
1522                                          dgrp_t i);
1523 errcode_t ext2fs_get_data_io(ext2_filsys fs, io_channel *old_io);
1524 errcode_t ext2fs_set_data_io(ext2_filsys fs, io_channel new_io);
1525 errcode_t ext2fs_rewrite_to_io(ext2_filsys fs, io_channel new_io);
1526
1527 /* get_pathname.c */
1528 extern errcode_t ext2fs_get_pathname(ext2_filsys fs, ext2_ino_t dir, ext2_ino_t ino,
1529                                char **name);
1530
1531 /* link.c */
1532 errcode_t ext2fs_link(ext2_filsys fs, ext2_ino_t dir, const char *name,
1533                       ext2_ino_t ino, int flags);
1534 errcode_t ext2fs_unlink(ext2_filsys fs, ext2_ino_t dir, const char *name,
1535                         ext2_ino_t ino, int flags);
1536
1537 /* symlink.c */
1538 errcode_t ext2fs_symlink(ext2_filsys fs, ext2_ino_t parent, ext2_ino_t ino,
1539                          const char *name, char *target);
1540
1541 /* mmp.c */
1542 errcode_t ext2fs_mmp_read(ext2_filsys fs, blk64_t mmp_blk, void *buf);
1543 errcode_t ext2fs_mmp_write(ext2_filsys fs, blk64_t mmp_blk, void *buf);
1544 errcode_t ext2fs_mmp_clear(ext2_filsys fs);
1545 errcode_t ext2fs_mmp_init(ext2_filsys fs);
1546 errcode_t ext2fs_mmp_start(ext2_filsys fs);
1547 errcode_t ext2fs_mmp_update(ext2_filsys fs);
1548 errcode_t ext2fs_mmp_update2(ext2_filsys fs, int immediately);
1549 errcode_t ext2fs_mmp_stop(ext2_filsys fs);
1550 unsigned ext2fs_mmp_new_seq(void);
1551
1552 /* read_bb.c */
1553 extern errcode_t ext2fs_read_bb_inode(ext2_filsys fs,
1554                                       ext2_badblocks_list *bb_list);
1555
1556 /* read_bb_file.c */
1557 extern errcode_t ext2fs_read_bb_FILE2(ext2_filsys fs, FILE *f,
1558                                       ext2_badblocks_list *bb_list,
1559                                       void *priv_data,
1560                                       void (*invalid)(ext2_filsys fs,
1561                                                       blk_t blk,
1562                                                       char *badstr,
1563                                                       void *priv_data));
1564 extern errcode_t ext2fs_read_bb_FILE(ext2_filsys fs, FILE *f,
1565                                      ext2_badblocks_list *bb_list,
1566                                      void (*invalid)(ext2_filsys fs,
1567                                                      blk_t blk));
1568
1569 /* res_gdt.c */
1570 extern errcode_t ext2fs_create_resize_inode(ext2_filsys fs);
1571
1572 /*sha256.c */
1573 #define EXT2FS_SHA256_LENGTH 32
1574 #if 0
1575 extern void ext2fs_sha256(const unsigned char *in, unsigned long in_size,
1576                    unsigned char out[EXT2FS_SHA256_LENGTH]);
1577 #endif
1578
1579 /* sha512.c */
1580 #define EXT2FS_SHA512_LENGTH 64
1581 extern void ext2fs_sha512(const unsigned char *in, unsigned long in_size,
1582                           unsigned char out[EXT2FS_SHA512_LENGTH]);
1583
1584 /* swapfs.c */
1585 extern errcode_t ext2fs_dirent_swab_in2(ext2_filsys fs, char *buf, size_t size,
1586                                         int flags);
1587 extern errcode_t ext2fs_dirent_swab_in(ext2_filsys fs, char *buf, int flags);
1588 extern errcode_t ext2fs_dirent_swab_out2(ext2_filsys fs, char *buf, size_t size,
1589                                          int flags);
1590 extern errcode_t ext2fs_dirent_swab_out(ext2_filsys fs, char *buf, int flags);
1591 extern void ext2fs_swap_ext_attr(char *to, char *from, int bufsize,
1592                                  int has_header);
1593 extern void ext2fs_swap_ext_attr_header(struct ext2_ext_attr_header *to_header,
1594                                         struct ext2_ext_attr_header *from_hdr);
1595 extern void ext2fs_swap_ext_attr_entry(struct ext2_ext_attr_entry *to_entry,
1596                                        struct ext2_ext_attr_entry *from_entry);
1597 extern void ext2fs_swap_super(struct ext2_super_block * super);
1598 extern void ext2fs_swap_group_desc(struct ext2_group_desc *gdp);
1599 extern void ext2fs_swap_group_desc2(ext2_filsys, struct ext2_group_desc *gdp);
1600 extern void ext2fs_swap_inode_full(ext2_filsys fs, struct ext2_inode_large *t,
1601                                    struct ext2_inode_large *f, int hostorder,
1602                                    int bufsize);
1603 extern void ext2fs_swap_inode(ext2_filsys fs,struct ext2_inode *t,
1604                               struct ext2_inode *f, int hostorder);
1605 extern void ext2fs_swap_mmp(struct mmp_struct *mmp);
1606
1607 /* unix_io.c */
1608 extern int ext2fs_open_file(const char *pathname, int flags, mode_t mode);
1609 extern int ext2fs_stat(const char *path, ext2fs_struct_stat *buf);
1610 extern int ext2fs_fstat(int fd, ext2fs_struct_stat *buf);
1611
1612 /* valid_blk.c */
1613 extern int ext2fs_inode_has_valid_blocks(struct ext2_inode *inode);
1614 extern int ext2fs_inode_has_valid_blocks2(ext2_filsys fs,
1615                                           struct ext2_inode *inode);
1616
1617 /* version.c */
1618 extern int ext2fs_parse_version_string(const char *ver_string);
1619 extern int ext2fs_get_library_version(const char **ver_string,
1620                                       const char **date_string);
1621
1622 /* write_bb_file.c */
1623 extern errcode_t ext2fs_write_bb_FILE(ext2_badblocks_list bb_list,
1624                                       unsigned int flags,
1625                                       FILE *f);
1626
1627
1628 /* inline functions */
1629 #ifdef NO_INLINE_FUNCS
1630 extern void ext2fs_init_csum_seed(ext2_filsys fs);
1631 extern errcode_t ext2fs_get_mem(unsigned long size, void *ptr);
1632 extern errcode_t ext2fs_get_memzero(unsigned long size, void *ptr);
1633 extern errcode_t ext2fs_get_array(unsigned long count,
1634                                   unsigned long size, void *ptr);
1635 extern errcode_t ext2fs_get_arrayzero(unsigned long count,
1636                                       unsigned long size, void *ptr);
1637 extern errcode_t ext2fs_free_mem(void *ptr);
1638 extern errcode_t ext2fs_resize_mem(unsigned long old_size,
1639                                    unsigned long size, void *ptr);
1640 extern void ext2fs_mark_super_dirty(ext2_filsys fs);
1641 extern void ext2fs_mark_changed(ext2_filsys fs);
1642 extern int ext2fs_test_changed(ext2_filsys fs);
1643 extern void ext2fs_mark_valid(ext2_filsys fs);
1644 extern void ext2fs_unmark_valid(ext2_filsys fs);
1645 extern int ext2fs_test_valid(ext2_filsys fs);
1646 extern void ext2fs_mark_ib_dirty(ext2_filsys fs);
1647 extern void ext2fs_mark_bb_dirty(ext2_filsys fs);
1648 extern int ext2fs_test_ib_dirty(ext2_filsys fs);
1649 extern int ext2fs_test_bb_dirty(ext2_filsys fs);
1650 extern dgrp_t ext2fs_group_of_blk(ext2_filsys fs, blk_t blk);
1651 extern dgrp_t ext2fs_group_of_ino(ext2_filsys fs, ext2_ino_t ino);
1652 extern blk_t ext2fs_group_first_block(ext2_filsys fs, dgrp_t group);
1653 extern blk_t ext2fs_group_last_block(ext2_filsys fs, dgrp_t group);
1654 extern blk_t ext2fs_inode_data_blocks(ext2_filsys fs,
1655                                       struct ext2_inode *inode);
1656 extern unsigned int ext2fs_div_ceil(unsigned int a, unsigned int b);
1657 extern __u64 ext2fs_div64_ceil(__u64 a, __u64 b);
1658 extern int ext2fs_dirent_name_len(const struct ext2_dir_entry *entry);
1659 extern void ext2fs_dirent_set_name_len(struct ext2_dir_entry *entry, int len);
1660 extern int ext2fs_dirent_file_type(const struct ext2_dir_entry *entry);
1661 extern void ext2fs_dirent_set_file_type(struct ext2_dir_entry *entry, int type);
1662
1663 #endif
1664
1665 /*
1666  * The actual inlined functions definitions themselves...
1667  *
1668  * If NO_INLINE_FUNCS is defined, then we won't try to do inline
1669  * functions at all!
1670  */
1671 #if (defined(INCLUDE_INLINE_FUNCS) || !defined(NO_INLINE_FUNCS))
1672 #ifdef INCLUDE_INLINE_FUNCS
1673 #define _INLINE_ extern
1674 #else
1675 #if (__STDC_VERSION__ >= 199901L)
1676 #define _INLINE_ inline
1677 #else
1678 #ifdef __GNUC__
1679 #define _INLINE_ extern __inline__
1680 #else                           /* For Watcom C */
1681 #define _INLINE_ extern inline
1682 #endif /* __GNUC__ */
1683 #endif /* __STDC_VERSION__ >= 199901L */
1684 #endif
1685
1686 _INLINE_ void ext2fs_init_csum_seed(ext2_filsys fs)
1687 {
1688         if (!EXT2_HAS_RO_COMPAT_FEATURE(fs->super,
1689                                         EXT4_FEATURE_RO_COMPAT_METADATA_CSUM))
1690                 return;
1691
1692         fs->csum_seed = ext2fs_crc32c_le(~0, fs->super->s_uuid,
1693                                          sizeof(fs->super->s_uuid));
1694 }
1695
1696 #ifndef EXT2_CUSTOM_MEMORY_ROUTINES
1697 #include <string.h>
1698 /*
1699  *  Allocate memory.  The 'ptr' arg must point to a pointer.
1700  */
1701 _INLINE_ errcode_t ext2fs_get_mem(unsigned long size, void *ptr)
1702 {
1703         void *pp;
1704
1705         pp = malloc(size);
1706         if (!pp)
1707                 return EXT2_ET_NO_MEMORY;
1708         memcpy(ptr, &pp, sizeof (pp));
1709         return 0;
1710 }
1711
1712 _INLINE_ errcode_t ext2fs_get_memzero(unsigned long size, void *ptr)
1713 {
1714         void *pp;
1715
1716         pp = malloc(size);
1717         if (!pp)
1718                 return EXT2_ET_NO_MEMORY;
1719         memset(pp, 0, size);
1720         memcpy(ptr, &pp, sizeof(pp));
1721         return 0;
1722 }
1723
1724 _INLINE_ errcode_t ext2fs_get_array(unsigned long count, unsigned long size, void *ptr)
1725 {
1726         if (count && (~0UL)/count < size)
1727                 return EXT2_ET_NO_MEMORY;
1728         return ext2fs_get_mem(count*size, ptr);
1729 }
1730
1731 _INLINE_ errcode_t ext2fs_get_arrayzero(unsigned long count,
1732                                         unsigned long size, void *ptr)
1733 {
1734         void *pp;
1735
1736         if (count && (~0UL)/count < size)
1737                 return EXT2_ET_NO_MEMORY;
1738         pp = calloc(count, size);
1739         if (!pp)
1740                 return EXT2_ET_NO_MEMORY;
1741         memcpy(ptr, &pp, sizeof(pp));
1742         return 0;
1743 }
1744
1745 /*
1746  * Free memory.  The 'ptr' arg must point to a pointer.
1747  */
1748 _INLINE_ errcode_t ext2fs_free_mem(void *ptr)
1749 {
1750         void *p;
1751
1752         memcpy(&p, ptr, sizeof(p));
1753         free(p);
1754         p = 0;
1755         memcpy(ptr, &p, sizeof(p));
1756         return 0;
1757 }
1758
1759 /*
1760  *  Resize memory.  The 'ptr' arg must point to a pointer.
1761  */
1762 _INLINE_ errcode_t ext2fs_resize_mem(unsigned long EXT2FS_ATTR((unused)) old_size,
1763                                      unsigned long size, void *ptr)
1764 {
1765         void *p;
1766
1767         /* Use "memcpy" for pointer assignments here to avoid problems
1768          * with C99 strict type aliasing rules. */
1769         memcpy(&p, ptr, sizeof(p));
1770         p = realloc(p, size);
1771         if (!p)
1772                 return EXT2_ET_NO_MEMORY;
1773         memcpy(ptr, &p, sizeof(p));
1774         return 0;
1775 }
1776 #endif  /* Custom memory routines */
1777
1778 /*
1779  * Mark a filesystem superblock as dirty
1780  */
1781 _INLINE_ void ext2fs_mark_super_dirty(ext2_filsys fs)
1782 {
1783         fs->flags |= EXT2_FLAG_DIRTY | EXT2_FLAG_CHANGED;
1784 }
1785
1786 /*
1787  * Mark a filesystem as changed
1788  */
1789 _INLINE_ void ext2fs_mark_changed(ext2_filsys fs)
1790 {
1791         fs->flags |= EXT2_FLAG_CHANGED;
1792 }
1793
1794 /*
1795  * Check to see if a filesystem has changed
1796  */
1797 _INLINE_ int ext2fs_test_changed(ext2_filsys fs)
1798 {
1799         return (fs->flags & EXT2_FLAG_CHANGED);
1800 }
1801
1802 /*
1803  * Mark a filesystem as valid
1804  */
1805 _INLINE_ void ext2fs_mark_valid(ext2_filsys fs)
1806 {
1807         fs->flags |= EXT2_FLAG_VALID;
1808 }
1809
1810 /*
1811  * Mark a filesystem as NOT valid
1812  */
1813 _INLINE_ void ext2fs_unmark_valid(ext2_filsys fs)
1814 {
1815         fs->flags &= ~EXT2_FLAG_VALID;
1816 }
1817
1818 /*
1819  * Check to see if a filesystem is valid
1820  */
1821 _INLINE_ int ext2fs_test_valid(ext2_filsys fs)
1822 {
1823         return (fs->flags & EXT2_FLAG_VALID);
1824 }
1825
1826 /*
1827  * Mark the inode bitmap as dirty
1828  */
1829 _INLINE_ void ext2fs_mark_ib_dirty(ext2_filsys fs)
1830 {
1831         fs->flags |= EXT2_FLAG_IB_DIRTY | EXT2_FLAG_CHANGED;
1832 }
1833
1834 /*
1835  * Mark the block bitmap as dirty
1836  */
1837 _INLINE_ void ext2fs_mark_bb_dirty(ext2_filsys fs)
1838 {
1839         fs->flags |= EXT2_FLAG_BB_DIRTY | EXT2_FLAG_CHANGED;
1840 }
1841
1842 /*
1843  * Check to see if a filesystem's inode bitmap is dirty
1844  */
1845 _INLINE_ int ext2fs_test_ib_dirty(ext2_filsys fs)
1846 {
1847         return (fs->flags & EXT2_FLAG_IB_DIRTY);
1848 }
1849
1850 /*
1851  * Check to see if a filesystem's block bitmap is dirty
1852  */
1853 _INLINE_ int ext2fs_test_bb_dirty(ext2_filsys fs)
1854 {
1855         return (fs->flags & EXT2_FLAG_BB_DIRTY);
1856 }
1857
1858 /*
1859  * Return the group # of a block
1860  */
1861 _INLINE_ dgrp_t ext2fs_group_of_blk(ext2_filsys fs, blk_t blk)
1862 {
1863         return ext2fs_group_of_blk2(fs, blk);
1864 }
1865 /*
1866  * Return the group # of an inode number
1867  */
1868 _INLINE_ dgrp_t ext2fs_group_of_ino(ext2_filsys fs, ext2_ino_t ino)
1869 {
1870         return (ino - 1) / fs->super->s_inodes_per_group;
1871 }
1872
1873 /*
1874  * Return the first block (inclusive) in a group
1875  */
1876 _INLINE_ blk_t ext2fs_group_first_block(ext2_filsys fs, dgrp_t group)
1877 {
1878         return (blk_t) ext2fs_group_first_block2(fs, group);
1879 }
1880
1881 /*
1882  * Return the last block (inclusive) in a group
1883  */
1884 _INLINE_ blk_t ext2fs_group_last_block(ext2_filsys fs, dgrp_t group)
1885 {
1886         return (blk_t) ext2fs_group_last_block2(fs, group);
1887 }
1888
1889 _INLINE_ blk_t ext2fs_inode_data_blocks(ext2_filsys fs,
1890                                         struct ext2_inode *inode)
1891 {
1892         return (blk_t) ext2fs_inode_data_blocks2(fs, inode);
1893 }
1894
1895 /*
1896  * This is an efficient, overflow safe way of calculating ceil((1.0 * a) / b)
1897  */
1898 _INLINE_ unsigned int ext2fs_div_ceil(unsigned int a, unsigned int b)
1899 {
1900         if (!a)
1901                 return 0;
1902         return ((a - 1) / b) + 1;
1903 }
1904
1905 _INLINE_ __u64 ext2fs_div64_ceil(__u64 a, __u64 b)
1906 {
1907         if (!a)
1908                 return 0;
1909         return ((a - 1) / b) + 1;
1910 }
1911
1912 _INLINE_ int ext2fs_dirent_name_len(const struct ext2_dir_entry *entry)
1913 {
1914         return entry->name_len & 0xff;
1915 }
1916
1917 _INLINE_ void ext2fs_dirent_set_name_len(struct ext2_dir_entry *entry, int len)
1918 {
1919         entry->name_len = (entry->name_len & 0xff00) | (len & 0xff);
1920 }
1921
1922 _INLINE_ int ext2fs_dirent_file_type(const struct ext2_dir_entry *entry)
1923 {
1924         return entry->name_len >> 8;
1925 }
1926
1927 _INLINE_ void ext2fs_dirent_set_file_type(struct ext2_dir_entry *entry, int type)
1928 {
1929         entry->name_len = (entry->name_len & 0xff) | (type << 8);
1930 }
1931
1932 #undef _INLINE_
1933 #endif
1934
1935 #ifdef __cplusplus
1936 }
1937 #endif
1938
1939 #endif /* _EXT2FS_EXT2FS_H */