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