doc/libext2fs.texinfo

   1 \input texinfo    @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename libext2fs.info
   4 @settitle The EXT2FS Library (version 1.26)
   5 @synindex tp fn
   6 @comment %**end of header
   7
   8 @ifinfo
   9 @dircategory Development
  10 @format
  11 START-INFO-DIR-ENTRY
  12 * libext2fs: (libext2fs.info).   The EXT2FS library.
  13 END-INFO-DIR-ENTRY
  14 @end format
  15 @end ifinfo
  16
  17 @c smallbook
  18
  19 @iftex
  20 @finalout
  21 @end iftex
  22
  23 @c Note: the edition number is listed in *three* places; please update
  24 @c all three.  Also, update the month and year where appropriate.
  25
  26 @c ==> Update edition number for settitle and subtitle, and in the
  27 @c ==> following paragraph; update date, too.
  28
  29
  30 @ifinfo
  31 This file documents the ext2fs library, a library for manipulating the
  32 ext2 filesystem.
  33
  34 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Theodore Ts'o
  35
  36 Permission is granted to make and distribute verbatim copies of
  37 this manual provided the copyright notice and this permission notice
  38 are preserved on all copies.
  39
  40 @ignore
  41 Permission is granted to process this file through TeX and print the
  42 results, provided the printed document carries copying permission
  43 notice identical to this one except for the removal of this paragraph
  44 (this paragraph not being relevant to the printed manual).
  45
  46 @end ignore
  47 Permission is granted to copy and distribute modified versions of this
  48 manual under the conditions for verbatim copying, provided that the entire
  49 resulting derived work is distributed under the terms of a permission
  50 notice identical to this one.
  51
  52 Permission is granted to copy and distribute translations of this manual
  53 into another language, under the above conditions for modified versions,
  54 except that this permission notice may be stated in a translation approved
  55 by the author.
  56 @end ifinfo
  57
  58 @setchapternewpage on
  59 @titlepage
  60 @c  use the new format for titles
  61
  62 @title The EXT2FS Library
  63 @subtitle The EXT2FS Library
  64 @subtitle Version 1.26
  65 @subtitle "February 2002
  66
  67 @author by Theodore Ts'o
  68
  69 @c Include the Distribution inside the titlepage so
  70 @c that headings are turned off.
  71
  72 @tex
  73 \global\parindent=0pt
  74 \global\parskip=8pt
  75 \global\baselineskip=13pt
  76 @end tex
  77
  78 @page
  79 @vskip 0pt plus 1filll
  80 Copyright @copyright{} 1997, 1998, 1999, 2000, 2001, 2002 Theodore Ts'o
  81
  82 @sp 2
  83
  84 Permission is granted to make and distribute verbatim copies of
  85 this manual provided the copyright notice and this permission notice
  86 are preserved on all copies.
  87
  88 Permission is granted to copy and distribute modified versions of this
  89 manual under the conditions for verbatim copying, provided that the entire
  90 resulting derived work is distributed under the terms of a permission
  91 notice identical to this one.
  92
  93 Permission is granted to copy and distribute translations of this manual
  94 into another language, under the above conditions for modified versions,
  95 except that this permission notice may be stated in a translation approved
  96 by the Foundation.
  97 @end titlepage
  98 @headings double
  99
 100 @ifinfo
 101 @node Top, Introduction to the EXT2FS Library, (dir), (dir)
 102
 103 @top The EXT2FS Library
 104
 105 This manual documents the EXT2FS Library, version 1.26.
 106
 107 @end ifinfo
 108
 109 @menu
 110 * Introduction to the EXT2FS Library::
 111 * EXT2FS Library Functions::
 112 * Concept Index::
 113 * Function Index::
 114 @end menu
 115
 116 @c ----------------------------------------------------------------------
 117
 118 @node Introduction to the EXT2FS Library, EXT2FS Library Functions, Top, Top
 119 @comment  node-name,  next,  previous,  up
 120 @chapter Introduction to the EXT2FS Library
 121
 122 The EXT2FS library is designed to allow user-level programs to
 123 manipulate an ext2 filesystem.
 124
 125 @node EXT2FS Library Functions, Concept Index, Introduction to the EXT2FS Library, Top
 126 @comment  node-name,  next,  previous,  up
 127 @chapter EXT2FS Library Functions
 128
 129 @menu
 130 * Filesystem-level functions::
 131 * Inode Functions::
 132 * Directory functions::
 133 * Bitmap Functions::
 134 * EXT2 data abstractions::
 135 * Byte-swapping functions::
 136 * Other functions::
 137 @end menu
 138
 139 @c ----------------------------------------------------------------------
 140
 141 @node Filesystem-level functions, Inode Functions, EXT2FS Library Functions, EXT2FS Library Functions
 142 @comment  node-name,  next,  previous,  up
 143 @section Filesystem-level functions
 144
 145 The following functions operate on a filesystem handle.  Most EXT2FS
 146 Library functions require a filesystem handle as their first argument.
 147 There are two functions which create a filesystem handle,
 148 @code{ext2fs_open} and @code{ext2fs_initialize}.
 149
 150 The filesystem can also be closed using @code{ext2fs_close}, and any
 151 changes to the superblock and group descripts can be written out to disk
 152 using @code{ext2fs_flush}.
 153
 154 @menu
 155 * Opening an ext2 filesystem::
 156 * Closing and flushing out changes::
 157 * Initializing a filesystem::
 158 * Filesystem flag functions::
 159 @end menu
 160
 161 @c ----------------------------------------------------------------------
 162
 163 @node Opening an ext2 filesystem, Closing and flushing out changes, Filesystem-level functions, Filesystem-level functions
 164 @comment  node-name,  next,  previous,  up
 165 @subsection Opening an ext2 filesystem
 166
 167 Most libext2fs functions take a filesystem handle of type
 168 @code{ext2_filsys}.  A filesystem handle is created either by opening
 169 an existing function using @code{ext2fs_open}, or by initializing a new
 170 filesystem using @code{ext2fs_initialize}.
 171
 172 @deftypefun errcode_t ext2fs_open (const char *@var{name}, int @var{flags}, int @var{superblock}, int @var{block_size}, io_manager @var{manager}, ext2_filsys *@var{ret_fs})
 173
 174 Opens a filesystem named @var{name}, using the the io_manager
 175 @var{manager} to define the input/output routines needed to read and
 176 write the filesystem.  In the case of the @code{unix_io} io_manager,
 177 @var{name} is interpreted as the Unix filename of the filesystem image.
 178 This is often a device file, such as @file{/dev/hda1}.
 179
 180 The @var{superblock} parameter specifies the block number of the
 181 superblock which should be used when opening the filesystem.
 182 If @var{superblock} is zero, @code{ext2fs_open} will use the primary
 183 superblock located at offset 1024 bytes from the start of the filesystem
 184 image.
 185
 186 The @var{block_size} parameter specifies the block size used by the
 187 filesystem.  Normally this is determined automatically from the
 188 filesystem uperblock.  If @var{block_size} is non-zero, it must match
 189 the block size found in the superblock, or the error
 190 @code{EXT2_ET_UNEXPECTED_BLOCK_SIZE} will be returned.  The
 191 @var{block_size} parameter is also used to help fund the superblock when
 192 @var{superblock} is non-zero.
 193
 194 The @var{flags} argument contains a bitmask of flags which control how
 195 the filesystem open should be handled.
 196
 197 @table @code
 198 @item EXT2_FLAG_RW
 199 Open the filesystem for reading and writing.  Without this flag, the
 200 filesystem is opened for reading only.
 201
 202 @item EXT2_FLAG_FORCE
 203 Open the filesystem regardless of the feature sets listed in the
 204 superblock.
 205
 206 @end table
 207 @end deftypefun
 208
 209 @c ----------------------------------------------------------------------
 210
 211 @node Closing and flushing out changes, Initializing a filesystem, Opening an ext2 filesystem, Filesystem-level functions
 212 @comment  node-name,  next,  previous,  up
 213 @subsection Closing and flushing out changes
 214
 215 @deftypefun errcode_t ext2fs_flush (ext2_filsys @var{fs})
 216
 217 Write any changes to the high-level filesystem data structures in the
 218 @var{fs} filesystem.  The following data structures will be written out:
 219
 220 @itemize @bullet
 221 @item The filesystem superblock
 222 @item The filesystem group descriptors
 223 @item The filesystem bitmaps, if read in via @code{ext2fs_read_bitmaps}.
 224 @end itemize
 225
 226 @end deftypefun
 227
 228 @deftypefun void ext2fs_free (ext2_filsys @var{fs})
 229
 230 Close the io_manager abstraction for @var{fs} and release all memory
 231 associated with the filesystem handle.
 232 @end deftypefun
 233
 234 @deftypefun errcode_t ext2fs_close (ext2_filsys @var{fs})
 235
 236 Flush out any changes to the high-level filesystem data structures using
 237 @code{ext2fs_flush} if the filesystem is marked dirty; then close and
 238 free the filesystem using @code{ext2fs_free}.
 239
 240 @end deftypefun
 241
 242 @c ----------------------------------------------------------------------
 243
 244 @node Initializing a filesystem, Filesystem flag functions, Closing and flushing out changes, Filesystem-level functions
 245 @comment  node-name,  next,  previous,  up
 246 @subsection Initializing a filesystem
 247
 248 An ext2 filesystem is initializing by the @code{mke2fs} program.  The
 249 two functions described here, @code{ext2fs_initialize} and
 250 @code{ext2fs_allocate_tables} do much of the initial work for setting up
 251 a filesystem.  However, they don't do the whole job.  @code{mke2fs}
 252 calls @code{ext2fs_initialize} to set up the filesystem superblock, and
 253 calls @code{ext2fs_allocate_tables} to allocate space for the inode
 254 table, and the inode and block bitmaps.  In addition, @code{mke2fs} must
 255 also initialize the inode tables by clearing them with zeros, create the
 256 root and lost+found directories, and reserve the reserved inodes.
 257
 258 @deftypefun errcode_t ext2fs_initialize (const char *@var{name}, int @var{flags}, struct ext2_super_block *@var{param}, io_manager @var{manager}, ext2_filsys *@var{ret_fs})
 259
 260 This function is used by the @code{mke2fs} program to initialize a
 261 filesystem.  The @code{ext2fs_initialize} function creates a filesystem
 262 handle which is returned in @var{ret_fs} that has been properly setup
 263 for a filesystem to be located in @var{name}, using the io_manager
 264 @var{manager}.  The prototype superblock in @var{param} is used to
 265 supply parameters such as the number of blocks in the filesystem, the
 266 block size, etc.
 267
 268 The @code{ext2fs_initialize} function does not actually do any I/O; that
 269 will be done when the application program calls @code{ext2fs_close} or
 270 @code{ext2fs_flush}.  Also, this function only initializes the
 271 superblock and group descriptor structures.  It does not create the
 272 inode table or the root directory.  This must be done by the calling
 273 application, such as @code{mke2fs}.
 274
 275 The following values may be set in the @var{param} prototype superblock;
 276 if a value of 0 is found in a field, @code{ext2fs_initialize} will use a
 277 default value.  The calling application should zero out the prototype
 278 entire superblock, and then fill in any appropriate values.
 279
 280 @table @code
 281
 282 @item s_blocks_count
 283 The number of blocks in the filesystem.  This parameter is mandatory and
 284 must be set by the calling application.
 285
 286 @item s_inodes_count
 287 The number of inodes in the filesystem.  The
 288 default value is determined by calculating the size of the filesystem,
 289 and creating one inode for every 4096 bytes.
 290
 291 @item s_r_blocks_count
 292 The number of blocks which should be reserved for the superuser.  The
 293 default value is zero blocks.
 294
 295 @item s_log_block_size
 296 The blocksize of the filesystem.  Valid values are 0 (1024 bytes), 1
 297 (2048 bytes), or 2 (4096 bytes).  The default blocksize is 1024 bytes.
 298
 299 @item s_log_frag_size
 300 The size of fragments.  The ext2 filesystem does not support fragments
 301 (and may never support fragments).  Currently this field must be the
 302 same as @code{s_log_block_size}.
 303
 304 @item s_first_data_block
 305 The first data block for the filesystem.  For filesystem with a
 306 blocksize of 1024 bytes, this value must be at least 1, since the
 307 superblock is located in block number 1.  For filesystems with larger
 308 blocksizes, the superblock is still located at an offset of 1024 bytes,
 309 so the superblock is located in block number 0.  By default, this value
 310 is set to 1 for filesystems with a block size of 1024 bytes, or 0 for
 311 filesystems with larger blocksizes.
 312
 313 @item s_max_mnt_count
 314 This field defines the number of times that the filesystem can be
 315 mounted before it should be checked using @code{e2fsck}.  When
 316 @code{e2fsck} is run without the @samp{-f} option, @code{e2fsck} will
 317 skip the filesystem check if the number of times that the filesystem has
 318 been mounted is less than @code{s_max_mnt_count} and if the interval
 319 between the last time a filesystem check was performed and the current
 320 time is less than @code{s_checkinterval} (see below).  The default value
 321 of @code{s_max_mnt_count} is 20.
 322
 323 @item s_checkinterval
 324 This field defines the minimal interval between filesystem checks.  See
 325 the previous entry for a discussion of how this field is used by
 326 @code{e2fsck}.  The default value of this field is 180 days (six
 327 months).
 328
 329 @item s_errors
 330 This field defines the behavior which should be used by the kernel of
 331 errors are detected in the filesystem.  Possible values include:
 332
 333 @table @samp
 334 @item EXT2_ERRORS_CONTINUE
 335 Continue execution when errors are detected.
 336
 337 @item EXT2_ERRORS_RO
 338 Remount the filesystem read-only.
 339
 340 @item EXT2_ERRORS_PANIC
 341 Panic.
 342
 343 @end table
 344
 345 The default behavior is @samp{EXT2_ERRORS_CONTINUE}.
 346
 347 @end table
 348
 349 @end deftypefun
 350
 351 @deftypefun errcode_t ext2fs_allocate_tables (ext2_filsys @var{fs})
 352 Allocate space for the inode table and the block and inode bitmaps.  The
 353 inode tables and block and inode bitmaps aren't actually initialized;
 354 this function just allocates the space for them.
 355 @end deftypefun
 356
 357 @c ----------------------------------------------------------------------
 358
 359 @node Filesystem flag functions,  , Initializing a filesystem, Filesystem-level functions
 360 @comment  node-name,  next,  previous,  up
 361 @subsection Filesystem flag functions
 362
 363 The filesystem handle has a number of flags which can be manipulated
 364 using the following function.  Some of these flags affect how the
 365 libext2fs filesystem behaves; others are provided solely for the
 366 application's convenience.
 367
 368 @deftypefun void ext2fs_mark_changed (ext2_filsys @var{fs})
 369 @deftypefunx int ext2fs_test_changed (ext2_filsys @var{fs})
 370 This flag indicates whether or not the filesystem has been changed.
 371 It is not used by the ext2fs library.
 372 @end deftypefun
 373
 374 @deftypefun void ext2fs_mark_super_dirty (ext2_filsys @var{fs})
 375 Mark the filesystem @var{fs} as being dirty; this will cause
 376 the superblock information to be flushed out when @code{ext2fs_close} is
 377 called.  @code{ext2fs_mark_super_dirty} will also set the filesystem
 378 changed flag.  The dirty flag is automatically cleared by
 379 @code{ext2fs_flush} when the superblock is written to disk.
 380 @end deftypefun
 381
 382 @deftypefun void ext2fs_mark_valid (ext2_filsys @var{fs})
 383 @deftypefunx void ext2fs_unmark_valid (ext2_filsys @var{fs})
 384 @deftypefunx int ext2fs_test_valid (ext2_filsys @var{fs})
 385 This flag indicates whether or not the filesystem is free of errors.
 386 It is not used by libext2fs, and is solely for the application's
 387 convenience.
 388 @end deftypefun
 389
 390 @deftypefun void ext2fs_mark_ib_dirty (ext2_filsys @var{fs})
 391 @deftypefunx void ext2fs_mark_bb_dirty (ext2_filsys @var{fs})
 392 @deftypefunx int ext2fs_test_ib_dirty (ext2_filsys @var{fs})
 393 @deftypefunx int ext2fs_test_bb_dirty (ext2_filsys @var{fs})
 394 These flags indicate whether or not the inode or block bitmaps have been
 395 modified.   If the flag is set, it will cause the appropriate bitmap
 396 to be written when the filesystem is closed or flushed.
 397 @end deftypefun
 398
 399
 400
 401 @c ----------------------------------------------------------------------
 402
 403 @node Inode Functions, Directory functions, Filesystem-level functions, EXT2FS Library Functions
 404 @comment  node-name,  next,  previous,  up
 405 @section Inode Functions
 406
 407 @menu
 408 * Reading and writing inodes::
 409 * Iterating over inodes in a filesystem::
 410 * Iterating over blocks in an inode::
 411 * Inode Convenience Functions::
 412 @end menu
 413
 414 @c ----------------------------------------------------------------------
 415
 416 @node Reading and writing inodes, Iterating over inodes in a filesystem, Inode Functions, Inode Functions
 417 @comment  node-name,  next,  previous,  up
 418 @subsection Reading and writing inodes
 419
 420 @deftypefun errcode_t ext2fs_read_inode (ext2_filsys @var{fs}, ext2_ino_t @var{ino}, struct ext2_inode *@var{inode})
 421 Read the inode number @var{ino} into @var{inode}.
 422 @end deftypefun
 423
 424 @deftypefun errcode_t ext2fs_write_inode (ext2_filsys @var{fs}, ext2_ino_t @var{ino}, struct ext2_inode *@var{inode})
 425 Write @var{inode} to inode @var{ino}.
 426 @end deftypefun
 427
 428
 429 @c ----------------------------------------------------------------------
 430
 431 @node Iterating over inodes in a filesystem, Iterating over blocks in an inode, Reading and writing inodes, Inode Functions
 432 @comment  node-name,  next,  previous,  up
 433 @subsection Iterating over inodes in a filesystem
 434
 435 The inode_scan abstraction is useful for iterating over all the inodes
 436 in a filesystem.
 437
 438 @deftypefun errcode_t ext2fs_open_inode_scan (ext2_filsys @var{fs}, int @var{buffer_blocks}, ext2_inode_scan *@var{scan})
 439 Initialize the iteration variable @var{scan}.  This variable is used by
 440 @code{ext2fs_get_next_inode}.  The @var{buffer_blocks} parameter
 441 controls how many blocks of the inode table are read in at a time.  A
 442 large number of blocks requires more memory, but reduces the overhead in
 443 seeking and reading from the disk.  If @var{buffer_blocks} is zero, a
 444 suitable default value will be used.
 445 @end deftypefun
 446
 447 @deftypefun void ext2fs_close_inode_scan (ext2_inode_scan @var{scan})
 448 Release the memory associated with @var{scan} and invalidate it.
 449 @end deftypefun
 450
 451 @deftypefun errcode_t ext2fs_get_next_inode (ext2_inode_scan @var{scan}, ext2_ino_t *@var{ino}, struct ext2_inode *@var{inode})
 452
 453 This function returns the next inode from the filesystem; the inode
 454 number of the inode is stored in @var{ino}, and the inode is stored in
 455 @var{inode}.
 456
 457 If the inode is located in a block that has been marked as bad,
 458 @code{ext2fs_get_next_inode} will return the error
 459 @code{EXT2_ET_BAD_BLOCK_IN_INODE_TABLE}.
 460 @end deftypefun
 461
 462 @deftypefun errcode_t ext2fs_inode_scan_goto_blockgroup (ext2_inode_scan @var{scan}, int @var{group})
 463 Start the inode scan at a particular ext2 blockgroup, @var{group}.
 464 This function may be safely called at any time while @var{scan} is valid.
 465 @end deftypefun
 466
 467 @deftypefun void ext2fs_set_inode_callback (ext2_inode_scan @var{scan}, errcode_t (*done_group)(ext2_filsys @var{fs}, ext2_inode_scan @var{scan}, dgrp_t @var{group}, void * @var{private}), void *@var{done_group_data})
 468 Register a callback function which will be called by
 469 @code{ext2_get_next_inode} when all of the inodes in a block group have
 470 been processed.
 471 @end deftypefun
 472
 473 @deftypefun int ext2fs_inode_scan_flags (ext2_inode_scan @var{scan}, int @var{set_flags}, int @var{clear_flags})
 474
 475 Set the scan_flags @var{set_flags} and clear the scan_flags @var{clear_flags}.
 476 The following flags can be set using this interface:
 477
 478 @table @samp
 479
 480 @item EXT2_SF_SKIP_MISSING_ITABLE
 481 When a block group is missing an inode table, skip it.  If this flag is
 482 not set @code{ext2fs_get_next_inode} will return the error
 483 EXT2_ET_MISSING_INODE_TABLE.
 484
 485 @end table
 486
 487 @end deftypefun
 488
 489 @c ----------------------------------------------------------------------
 490
 491 @node Iterating over blocks in an inode, Inode Convenience Functions, Iterating over inodes in a filesystem, Inode Functions
 492 @comment  node-name,  next,  previous,  up
 493 @subsection Iterating over blocks in an inode
 494
 495 @deftypefun errcode_t ext2fs_block_iterate (ext2_filsys @var{fs},
 496 ext2_ino_t @var{ino}, int @var{flags}, char *block_buf, int
 497 (*func)(ext2_filsys @var{fs}, blk_t *@var{blocknr}, int @var{blockcnt},
 498 void *@var{private}), void *@var{private})
 499
 500 Iterate over all of the blocks in inode number @var{ino} in filesystem
 501 @var{fs}, by calling the function @var{func} for each block in the
 502 inode.  The @var{block_buf} parameter should either be NULL, or if the
 503 @code{ext2fs_block_iterate} function is called repeatedly, the overhead
 504 of allocating and freeing scratch memory can be avoided by passing a
 505 pointer to a scratch buffer which must be at least as big as three times the
 506 filesystem's blocksize.
 507
 508 The @var{flags} parameter controls how the iterator will function:
 509
 510 @table @samp
 511
 512 @item BLOCK_FLAG_HOLE
 513 This flag indiciates that the interator function should be called on
 514 blocks where the block number is zero (also known as ``holes''.)  It is
 515 also known as BLOCK_FLAG_APPEND, since it is also used by functions
 516 such as ext2fs_expand_dir() to add a new block to an inode.
 517
 518 @item BLOCK_FLAG_TRAVERSE
 519 This flag indicates that the iterator function for the
 520 indirect, doubly indirect, etc. blocks should be called after all
 521 of the blocks containined in the indirect blocks are processed.
 522 This is useful if you are going to be deallocating blocks from an
 523 inode.
 524
 525 @item BLOCK_FLAG_DATA_ONLY
 526 This flag indicates that the iterator function should be
 527 called for data blocks only.
 528
 529 @end table
 530
 531 The callback function @var{func} is called with a number of parameters;
 532 the @var{fs} and @var{private} parameters are self-explanatory, and
 533 their values are taken from the parameters to
 534 @code{ext2fs_block_iterate}.  (The @var{private} data structure is
 535 generally used by callers to @code{ext2fs_block_iterate} so that some
 536 private data structure can be passed to the callback function.  The
 537 @var{blockcnt} parameter, if non-negative, indicates the logical block
 538 number of a data block in the inode.  If @var{blockcnt} is less than
 539 zero, then @var{func} was called on a metadata block, and @var{blockcnt}
 540 will be one of the following values:  BLOCK_COUNT_IND, BLOCK_COUNT_DIND,
 541 BLOCK_COUNT_TIND, or BLOCK_COUNT_TRANSLATOR.  The @var{blocknr} is a
 542 pointer to the inode or indirect block entry listing physical block
 543 number.  The callback function may modify the physical block number, if
 544 it returns the @var{BLOCK_CHANGED} flag.
 545
 546
 547 The callback function @var{func} returns a result code which is composed of
 548 the logical OR of the following flags:
 549
 550 @table @samp
 551
 552 @item BLOCK_CHANGED
 553
 554 This flag indicates that callback function has modified the physical
 555 block number pointed to by @var{blocknr}.
 556
 557 @item BLOCK_ABORT
 558
 559 This flag requests that @code{ext2fs_block_iterate} to stop immediately
 560 and return to the caller.
 561
 562 @end table
 563
 564 @end deftypefun
 565
 566 @deftypefun errcode_t ext2fs_block_iterate2 (ext2_filsys @var{fs}, ext2_ino_t @var{ino}, int @var{flags}, char *@var{block}_buf, int (*func)(ext2_filsys @var{fs}, blk_t *@var{blocknr}, e2_blkcnt_t @var{blockcnt}, blk_t @var{ref_blk}, int  @var{ref_offset}, void *@var{private}), void *@var{private})
 567
 568 This function is much like @code{ext2fs_block_iterate2}, except that the
 569 @var{blockcnt} type is a 64-bit signed quantity, to support larger
 570 files, and the addition of the @var{ref_blk} and @var{ref_offset}
 571 arguments passed to the callback function, which identify the location
 572 of the physical block pointed to by pointer @var{blocknr}.  If
 573 @var{ref_blk} is zero, then @var{ref_offset} contains the offset into
 574 the @code{i_blocks} array.  If @var{ref_blk} is non-zero, then the physical
 575 block location is contained inside an indirect block group, and
 576 @var{ref_offset} contains the offset into the indirect block.
 577
 578 @end deftypefun
 579
 580 @c ----------------------------------------------------------------------
 581
 582 @node Inode Convenience Functions,  , Iterating over blocks in an inode, Inode Functions
 583 @comment  node-name,  next,  previous,  up
 584 @subsection Convenience functions for Inodes
 585
 586 @deftypefun errcode_t ext2fs_get_blocks (ext2_filsys @var{fs}, ext2_ino_t @var{ino}, blk_t *@var{blocks})
 587
 588 Returns an array of blocks corresponding to the direct,
 589 indirect, doubly indirect, and triply indirect blocks as stored in the
 590 inode structure.
 591 @end deftypefun
 592
 593 @deftypefun errcode_t ext2fs_check_directory (ext2_filsys @var{fs}, ext2_ino_t @var{ino})
 594 Returns 0 if @var{ino} is a directory, and @code{ENOTDIR} if it is not.
 595 @end deftypefun
 596
 597 @deftypefun int ext2_inode_has_valid_blocks (struct ext2_inode *@var{inode})
 598
 599 Returns 1 if the inode's block entries actually valid block entries, and
 600 0 if not.  Inodes which represent devices and fast symbolic links do not
 601 contain valid block entries.
 602 @end deftypefun
 603
 604 @c ----------------------------------------------------------------------
 605
 606 @node Directory functions, Bitmap Functions, Inode Functions, EXT2FS Library Functions
 607 @comment  node-name,  next,  previous,  up
 608 @section Directory functions
 609
 610 @menu
 611 * Directory block functions::
 612 * Iterating over a directory::
 613 * Creating and expanding directories::
 614 * Creating and removing directory entries::
 615 * Looking up filenames::
 616 * Translating inode numbers to filenames::
 617 @end menu
 618
 619 @c ----------------------------------------------------------------------
 620
 621 @node Directory block functions, Iterating over a directory, Directory functions, Directory functions
 622 @comment  node-name,  next,  previous,  up
 623 @subsection Directory block functions
 624
 625 @deftypefun errcode_t ext2fs_read_dir_block (ext2_filsys @var{fs}, blk_t @var{block}, void *@var{buf})
 626
 627 This function reads a directory block, performing any necessary
 628 byte swapping if necessary.
 629 @end deftypefun
 630
 631 @deftypefun errcode_t ext2fs_write_dir_block (ext2_filsys @var{fs}, blk_t @var{block}, void *@var{buf})
 632
 633 This function writes a directory block, performing any necessary
 634 byte swapping if necessary.
 635 @end deftypefun
 636
 637 @deftypefun errcode_t ext2fs_new_dir_block (ext2_filsys @var{fs},
 638 ext2_ino_t @var{dir_ino}, ext2_ino_t @var{parent_ino}, char
 639 **@var{block})
 640
 641 This function creates a new directory block in @var{block}.  If
 642 @var{dir_ino} is non-zero, then @var{dir_info} and @var{parent_ino} is used
 643 to initialize directory entries for @file{.} and @file{..}, respectively.
 644 @end deftypefun
 645
 646 @c ----------------------------------------------------------------------
 647
 648 @node Iterating over a directory, Creating and expanding directories, Directory block functions, Directory functions
 649 @comment  node-name,  next,  previous,  up
 650 @subsection Iterating over a directory
 651
 652 @deftypefun errcode_t ext2fs_dir_iterate (ext2_filsys @var{fs}, ext2_ino_t @var{dir}, int @var{flags}, char *@var{block_buf}, int (*@var{func})(struct ext2_dir_entry *@var{dirent}, int @var{offset}, int @var{blocksize}, char *@var{buf}, void *@var{private}), void *@var{private})
 653
 654 This function interates over all of the directory entries in the
 655 directory @var{dir}, calling the callback function @var{func} for each
 656 directory entry in the directory.  The @var{block_buf} parameter should
 657 either be NULL, or if the @code{ext2fs_dir_iterate} function is
 658 called repeatedly, the overhead of allocating and freeing
 659 scratch memory can be avoided by passing a pointer to a scratch buffer
 660 which must be at least as big as the filesystem's blocksize.
 661
 662 The @var{flags} parameter controls how the iterator will function:
 663
 664 @table @samp
 665
 666 @item DIRENT_FLAG_INCLUDE_EMPTY
 667
 668 This flag indicates that the callback function should be called even
 669 for deleted or empty directory entries.
 670
 671 @end table
 672
 673 @end deftypefun
 674
 675 @c ----------------------------------------------------------------------
 676
 677 @node Creating and expanding directories, Creating and removing directory entries, Iterating over a directory, Directory functions
 678 @comment  node-name,  next,  previous,  up
 679 @subsection Creating and expanding directories
 680
 681 @deftypefun errcode_t ext2fs_mkdir (ext2_filsys @var{fs}, ext2_ino_t @var{parent}, ext2_ino_t @var{inum}, const char *@var{name})
 682
 683 This function creates a new directory.  If @var{inum} is zero, then a
 684 new inode will be allocated; otherwise, the directory will be created in
 685 the inode specified by @var{inum}.  If @var{name} specifies the name of
 686 the new directory; if it is non-NULL, then the new directory will be
 687 linked into the parent directory @var{parent}.
 688 @end deftypefun
 689
 690 @deftypefun errcode_t ext2fs_expand_dir (ext2_filsys @var{fs}, ext2_ino_t @var{dir})
 691
 692 This function adds a new empty directory block and appends it to
 693 the directory @var{dir}.  This allows functions such as
 694 @code{ext2fs_link} to add new directory entries to a directory which is full.
 695
 696 @end deftypefun
 697
 698 @c ----------------------------------------------------------------------
 699
 700 @node Creating and removing directory entries, Looking up filenames, Creating and expanding directories, Directory functions
 701 @comment  node-name,  next,  previous,  up
 702 @subsection Creating and removing directory entries
 703
 704 @deftypefun errcode_t ext2fs_link (ext2_filsys @var{fs}, ext2_ino_t @var{dir}, const char *@var{name}, ext2_ino_t @var{ino}, int flags)
 705
 706 This function adds a new directory entry to the directory @var{dir},
 707 with @var{name} and @var{ino} specifying the name and inode number in
 708 the directory entry, respectively.
 709
 710 The low 3 bits of the flags field is used to specify the file type of
 711 inode:   (No other flags are currently defined.)
 712
 713 @table @samp
 714
 715 @item EXT2_FT_UNKNOWN
 716
 717 The file type is unknown.
 718
 719 @item EXT2_FT_REG_FILE
 720
 721 The file type is a normal file.
 722
 723 @item EXT2_FT_DIR
 724
 725 The file type is a directory.
 726
 727 @item EXT2_FT_CHRDEV
 728
 729 The file type is a character device.
 730
 731 @item EXT2_FT_BLKDEV
 732
 733 The file type is a block device.
 734
 735 @item EXT2_FT_FIFO
 736
 737 The file type is a named pipe.
 738
 739 @item EXT2_FT_SOCK
 740
 741 The file type is a unix domain socket.
 742
 743 @item EXT2_FT_SYMLINK
 744
 745 The file type is a symbolic link.
 746 @end table
 747
 748 @end deftypefun
 749
 750 @deftypefun errcode_t ext2fs_unlink (ext2_filsys @var{fs}, ext2_ino_t @var{dir}, const char *@var{name}, ext2_ino_t @var{ino}, int @var{flags})
 751
 752 This function removes a directory entry from @var{dir}.
 753 The directory entry to be removed is the first one which is
 754 matched by @var{name} and @var{ino}.  If @var{name} is non-NULL,
 755 the directory entry's name must match @var{name}.  If @var{ino} is
 756 non-zero, the directory entry's inode number must match @var{ino}.
 757 No flags are currently defined for @code{ext2fs_unlink}; callers should
 758 pass in zero to this parameter.
 759
 760 @end deftypefun
 761
 762 @c ----------------------------------------------------------------------
 763
 764 @node Looking up filenames, Translating inode numbers to filenames, Creating and removing directory entries, Directory functions
 765 @comment  node-name,  next,  previous,  up
 766 @subsection Looking up filenames
 767
 768 @deftypefun errcode_t ext2fs_lookup (ext2_filsys @var{fs}, ext2_ino_t @var{dir}, const char *@var{name}, int @var{namelen}, char *@var{buf}, ext2_ino_t *@var{inode})
 769 @end deftypefun
 770
 771 @deftypefun errcode_t ext2fs_namei (ext2_filsys @var{fs}, ext2_ino_t @var{root}, ext2_ino_t @var{cwd}, const char *@var{name}, ext2_ino_t *@var{inode})
 772 @end deftypefun
 773
 774 @deftypefun errcode_t ext2fs_namei_follow (ext2_filsys @var{fs}, ext2_ino_t @var{root}, ext2_ino_t @var{cwd}, const char *@var{name}, ext2_ino_t *@var{inode})
 775 @end deftypefun
 776
 777 @deftypefun errcode_t ext2fs_follow_link (ext2_filsys @var{fs}, ext2_ino_t @var{root}, ext2_ino_t @var{cwd}, ext2_ino_t @var{inode}, ext2_ino_t *@var{res}_inode)
 778 @end deftypefun
 779
 780 @c ----------------------------------------------------------------------
 781
 782 @node Translating inode numbers to filenames,  , Looking up filenames, Directory functions
 783 @comment  node-name,  next,  previous,  up
 784 @subsection Translating inode numbers to filenames
 785
 786 @deftypefun errcode_t ext2fs_get_pathname (ext2_filsys @var{fs}, ext2_ino_t @var{dir}, ext2_ino_t @var{ino}, char **@var{name})
 787 @end deftypefun
 788
 789
 790 @c ----------------------------------------------------------------------
 791
 792 @node Bitmap Functions, EXT2 data abstractions, Directory functions, EXT2FS Library Functions
 793 @comment  node-name,  next,  previous,  up
 794 @section Bitmap Functions
 795
 796 @menu
 797 * Reading and Writing Bitmaps::
 798 * Allocating Bitmaps::
 799 * Free bitmaps::
 800 * Bitmap Operations::
 801 * Comparing bitmaps::
 802 * Modifying Bitmaps::
 803 * Resizing Bitmaps::
 804 * Clearing Bitmaps::
 805 @end menu
 806
 807 @c ----------------------------------------------------------------------
 808
 809 @node Reading and Writing Bitmaps, Allocating Bitmaps, Bitmap Functions, Bitmap Functions
 810 @comment  node-name,  next,  previous,  up
 811 @subsection Reading and Writing Bitmaps
 812
 813 @deftypefun errcode_t ext2fs_write_inode_bitmap (ext2_filsys @var{fs})
 814 @end deftypefun
 815
 816 @deftypefun errcode_t ext2fs_write_block_bitmap (ext2_filsys @var{fs})
 817 @end deftypefun
 818
 819 @deftypefun errcode_t ext2fs_read_inode_bitmap (ext2_filsys @var{fs})
 820 @end deftypefun
 821
 822 @deftypefun errcode_t ext2fs_read_block_bitmap (ext2_filsys @var{fs})
 823 @end deftypefun
 824
 825 @deftypefun errcode_t ext2fs_read_bitmaps (ext2_filsys @var{fs})
 826 @end deftypefun
 827
 828 @deftypefun errcode_t ext2fs_write_bitmaps (ext2_filsys @var{fs})
 829 @end deftypefun
 830
 831 @c ----------------------------------------------------------------------
 832
 833 @node Allocating Bitmaps, Free bitmaps, Reading and Writing Bitmaps, Bitmap Functions
 834 @comment  node-name,  next,  previous,  up
 835 @subsection Allocating Bitmaps
 836
 837 @deftypefun errcode_t ext2fs_allocate_generic_bitmap (__u32 @var{start}, __u32 @var{end}, _u32 @var{real_end}, const char *@var{descr}, ext2fs_generic_bitmap *@var{ret})
 838 @end deftypefun
 839
 840 @deftypefun errcode_t ext2fs_allocate_block_bitmap (ext2_filsys @var{fs}, const char *@var{descr}, ext2fs_block_bitmap *@var{ret})
 841 @end deftypefun
 842
 843 @deftypefun errcode_t ext2fs_allocate_inode_bitmap (ext2_filsys @var{fs}, const char *@var{descr}, ext2fs_inode_bitmap *@var{ret})
 844 @end deftypefun
 845
 846 @c ----------------------------------------------------------------------
 847
 848 @node Free bitmaps, Bitmap Operations, Allocating Bitmaps, Bitmap Functions
 849 @comment  node-name,  next,  previous,  up
 850 @subsection Freeing bitmaps
 851
 852
 853 @deftypefun void ext2fs_free_generic_bitmap (ext2fs_inode_bitmap @var{bitmap})
 854 @end deftypefun
 855
 856 @deftypefun void ext2fs_free_block_bitmap (ext2fs_block_bitmap @var{bitmap})
 857 @end deftypefun
 858
 859 @deftypefun void ext2fs_free_inode_bitmap (ext2fs_inode_bitmap @var{bitmap})
 860 @end deftypefun
 861
 862
 863 @c ----------------------------------------------------------------------
 864
 865 @node Bitmap Operations, Comparing bitmaps, Free bitmaps, Bitmap Functions
 866 @comment  node-name,  next,  previous,  up
 867 @subsection Bitmap Operations
 868
 869 @deftypefun void ext2fs_mark_block_bitmap (ext2fs_block_bitmap @var{bitmap}, blk_t @var{block})
 870
 871 @deftypefunx void ext2fs_unmark_block_bitmap (ext2fs_block_bitmap @var{bitmap}, blk_t @var{block})
 872
 873 @deftypefunx int ext2fs_test_block_bitmap (ext2fs_block_bitmap @var{bitmap}, blk_t @var{block})
 874
 875 These functions set, clear, and test bits in a block bitmap @var{bitmap}.
 876 @end deftypefun
 877
 878
 879 @deftypefun void ext2fs_mark_inode_bitmap (ext2fs_inode_bitmap @var{bitmap}, ext2_ino_t @var{inode})
 880
 881 @deftypefunx void ext2fs_unmark_inode_bitmap (ext2fs_inode_bitmap @var{bitmap}, ext2_ino_t @var{inode})
 882
 883 @deftypefunx int ext2fs_test_inode_bitmap (ext2fs_inode_bitmap @var{bitmap}, ext2_ino_t @var{inode})
 884
 885 These functions set, clear, and test bits in an inode bitmap @var{bitmap}.
 886 @end deftypefun
 887
 888 @deftypefun void ext2fs_fast_mark_block_bitmap (ext2fs_block_bitmap @var{bitmap}, blk_t @var{block})
 889
 890 @deftypefunx void ext2fs_fast_unmark_block_bitmap (ext2fs_block_bitmap @var{bitmap}, blk_t @var{block})
 891
 892 @deftypefunx int ext2fs_fast_test_block_bitmap (ext2fs_block_bitmap @var{bitmap}, blk_t @var{block})
 893
 894 @deftypefunx void ext2fs_fast_mark_inode_bitmap (ext2fs_inode_bitmap @var{bitmap}, ext2_ino_t @var{inode})
 895
 896 @deftypefunx void ext2fs_fast_unmark_inode_bitmap (ext2fs_inode_bitmap @var{bitmap}, ext2_ino_t @var{inode})
 897
 898 @deftypefunx int ext2fs_fast_test_inode_bitmap (ext2fs_inode_bitmap @var{bitmap}, ext2_ino_t @var{inode})
 899
 900 These ``fast'' functions are like their normal counterparts; however,
 901 they are implemented as inline functions and do not perform bounds
 902 checks on the inode number or block number; they are assumed to be
 903 correct.  They should only be used in speed-critical applications, where
 904 the inode or block number has already been validated by other means.
 905 @end deftypefun
 906
 907 @deftypefun blk_t ext2fs_get_block_bitmap_start (ext2fs_block_bitmap @var{bitmap})
 908 @deftypefunx ext2_ino_t ext2fs_get_inode_bitmap_start (ext2fs_inode_bitmap @var{bitmap})
 909 Return the first inode or block which is stored in the bitmap.
 910 @end deftypefun
 911
 912 @deftypefun blk_t ext2fs_get_block_bitmap_end (ext2fs_block_bitmap @var{bitmap})
 913 @deftypefunx ext2_ino_t ext2fs_get_inode_bitmap_end (ext2fs_inode_bitmap @var{bitmap})
 914
 915 Return the last inode or block which is stored in the bitmap.
 916 @end deftypefun
 917
 918
 919 @c ----------------------------------------------------------------------
 920
 921 @node Comparing bitmaps, Modifying Bitmaps, Bitmap Operations, Bitmap Functions
 922 @comment  node-name,  next,  previous,  up
 923 @subsection Comparing bitmaps
 924
 925 @deftypefun errcode_t ext2fs_compare_block_bitmap (ext2fs_block_bitmap @var{bm1}, ext2fs_block_bitmap @var{bm2})
 926 @end deftypefun
 927
 928 @deftypefun errcode_t ext2fs_compare_inode_bitmap (ext2fs_inode_bitmap @var{bm1}, ext2fs_inode_bitmap @var{bm2})
 929 @end deftypefun
 930
 931
 932 @c ----------------------------------------------------------------------
 933
 934 @node Modifying Bitmaps, Resizing Bitmaps, Comparing bitmaps, Bitmap Functions
 935 @comment  node-name,  next,  previous,  up
 936 @subsection Modifying Bitmaps
 937
 938 @deftypefun errcode_t ext2fs_fudge_inode_bitmap_end (ext2fs_inode_bitmap @var{bitmap}, ext2_ino_t @var{end}, ext2_ino_t *@var{oend})
 939 @end deftypefun
 940
 941 @deftypefun errcode_t ext2fs_fudge_block_bitmap_end (ext2fs_block_bitmap @var{bitmap}, blk_t @var{end}, blk_t *@var{oend})
 942 @end deftypefun
 943
 944 @c ----------------------------------------------------------------------
 945
 946 @node Resizing Bitmaps, Clearing Bitmaps, Modifying Bitmaps, Bitmap Functions
 947 @comment  node-name,  next,  previous,  up
 948 @subsection Resizing Bitmaps
 949
 950 @deftypefun errcode_t ext2fs_resize_generic_bitmap (__u32 @var{new_end}, __u32 @var{new_real_end}, ext2fs_generic_bitmap @var{bmap})
 951 @end deftypefun
 952
 953 @deftypefun errcode_t ext2fs_resize_inode_bitmap (__u32 @var{new_end}, __u32 @var{new_real_end}, ext2fs_inode_bitmap @var{bmap})
 954 @end deftypefun
 955
 956 @deftypefun errcode_t ext2fs_resize_block_bitmap (__u32 @var{new_end}, __u32 @var{new_real_end}, ext2fs_block_bitmap @var{bmap})
 957 @end deftypefun
 958
 959
 960 @c ----------------------------------------------------------------------
 961
 962 @node Clearing Bitmaps,  , Resizing Bitmaps, Bitmap Functions
 963 @comment  node-name,  next,  previous,  up
 964 @subsection Clearing Bitmaps
 965
 966 @deftypefun void ext2fs_clear_inode_bitmap (ext2fs_inode_bitmap @var{bitmap})
 967
 968 This function sets all of the bits in the inode bitmap @var{bitmap} to
 969 be zero.
 970
 971 @end deftypefun
 972
 973 @deftypefun void ext2fs_clear_block_bitmap (ext2fs_block_bitmap @var{bitmap})
 974
 975 This function sets all of the bits in the block bitmap @var{bitmap} to
 976 be zero.
 977 @end deftypefun
 978
 979
 980 @c ----------------------------------------------------------------------
 981
 982 @node EXT2 data abstractions, Byte-swapping functions, Bitmap Functions, EXT2FS Library Functions
 983 @comment  node-name,  next,  previous,  up
 984 @section EXT2 data abstractions
 985
 986 The ext2 library has a number of abstractions which are useful for ext2
 987 utility programs.
 988
 989 @menu
 990 * Badblocks list management::
 991 * Directory-block list management::
 992 * Inode count functions::
 993 @end menu
 994
 995 @c ----------------------------------------------------------------------
 996
 997 @node Badblocks list management, Directory-block list management, EXT2 data abstractions, EXT2 data abstractions
 998 @comment  node-name,  next,  previous,  up
 999 @subsection Badblocks list management
1000
1001
1002 @deftypefun errcode_t ext2fs_badblocks_list_create (ext2_badblocks_list *@var{ret}, int @var{size})
1003 @end deftypefun
1004
1005 @deftypefun void ext2fs_badblocks_list_free (ext2_badblocks_list @var{bb})
1006 @end deftypefun
1007
1008 @deftypefun errcode_t ext2fs_badblocks_list_add (ext2_badblocks_list @var{bb}, blk_t @var{blk})
1009 @end deftypefun
1010
1011 @deftypefun int ext2fs_badblocks_list_test (ext2_badblocks_list @var{bb}, blk_t @var{blk})
1012 @end deftypefun
1013
1014 @deftypefun errcode_t ext2fs_badblocks_list_iterate_begin (ext2_badblocks_list @var{bb}, ext2_badblocks_iterate *@var{ret})
1015 @end deftypefun
1016
1017 @deftypefun int ext2fs_badblocks_list_iterate (ext2_badblocks_iterate iter, blk_t *@var{blk})
1018 @end deftypefun
1019
1020 @deftypefun void ext2fs_badblocks_list_iterate_end (ext2_badblocks_iterate @var{iter})
1021 @end deftypefun
1022
1023 @deftypefun errcode_t ext2fs_update_bb_inode (ext2_filsys @var{fs}, ext2_badblocks_list @var{bb_list})
1024 @end deftypefun
1025
1026 @deftypefun errcode_t ext2fs_read_bb_inode (ext2_filsys @var{fs}, ext2_badblocks_list *@var{bb_list})
1027 @end deftypefun
1028
1029 @deftypefun errcode_t ext2fs_read_bb_FILE (ext2_filsys @var{fs}, FILE *f, ext2_badblocks_list *@var{bb_list}, void (*invalid)(ext2_filsys @var{fs}, blk_t @var{blk}))
1030 @end deftypefun
1031
1032
1033 @c ----------------------------------------------------------------------
1034
1035 @node Directory-block list management, Inode count functions, Badblocks list management, EXT2 data abstractions
1036 @comment  node-name,  next,  previous,  up
1037 @subsection Directory-block list management
1038
1039 The dblist abstraction stores a list of blocks belonging to
1040 directories.  This list can be useful when a program needs to interate
1041 over all directory entries in a filesystem; @code{e2fsck} does this in
1042 pass 2 of its operations, and @code{debugfs} needs to do this when it is
1043 trying to turn an inode number into a pathname.
1044
1045 @deftypefun errcode_t ext2fs_init_dblist (ext2_filsys @var{fs}, ext2_dblist *@var{ret_dblist})
1046
1047 Creates a dblist data structure and return it in @var{ret_dblist}.
1048 @end deftypefun
1049
1050 @deftypefun void ext2fs_free_dblist (ext2_dblist @var{dblist})
1051
1052 Free a dblist data structure.
1053 @end deftypefun
1054
1055 @deftypefun errcode_t ext2fs_add_dir_block (ext2_dblist @var{dblist}, ext2_ino_t @var{ino}, blk_t @var{blk}, int @var{blockcnt})
1056
1057 Add an entry to the dblist data structure.  This call records the fact
1058 that block number @var{blockcnt} of directory inode @var{ino} is stored
1059 in block @var{blk}.
1060 @end deftypefun
1061
1062 @deftypefun errcode_t ext2fs_set_dir_block (ext2_dblist @var{dblist}, ext2_ino_t @var{ino}, blk_t @var{blk}, int @var{blockcnt})
1063
1064 Change an entry in the dblist data structure; this changes the location
1065 of block number @var{blockcnt} of directory indoe @var{ino} to be block
1066 @var{blk}.
1067 @end deftypefun
1068
1069 @deftypefun errcode_t ext2fs_dblist_iterate (ext2_dblist @var{dblist}, int (*func)(ext2_filsys @var{fs}, struct ext2_db_entry *@var{db_info}, void *@var{private}), void *@var{private})
1070
1071 This iterator calls @var{func} for every entry in the dblist data structure.
1072 @end deftypefun
1073
1074 @deftypefun errcode_t ext2fs_dblist_dir_iterate (ext2_dblist @var{dblist}, int flags, char *@var{block_buf}, int (*func)(ext2_ino_t @var{dir}, int  @var{entry}, struct ext2_dir_entry *@var{dirent}, int @var{offset}, int @var{blocksize}, char *@var{buf}, void *@var{private}), void *@var{private})
1075
1076 This iterator takes reads in the directory block indicated in each
1077 dblist entry, and calls @var{func} for each directory entry in each
1078 directory block.  If @var{dblist} contains all the directory blocks in a
1079 filesystem, this function provides a convenient way to iterate over all
1080 directory entries for that filesystem.
1081 @end deftypefun
1082
1083 @c ----------------------------------------------------------------------
1084
1085 @node Inode count functions,  , Directory-block list management, EXT2 data abstractions
1086 @comment  node-name,  next,  previous,  up
1087 @subsection Inode count functions
1088
1089 The icount abstraction is a specialized data type used by @code{e2fsck}
1090 to store how many times a particular inode is referenced by the
1091 filesystem.  This is used twice; once to store the actual number of times
1092 that the inode is reference; and once to store the claimed number of times
1093 the inode is referenced according to the inode structure.
1094
1095 This abstraction is designed to be extremely efficient for storing this
1096 sort of information, by taking advantage of the following properties of
1097 inode counts, namely (1) inode counts are very often zero (because
1098 the inode is currrently not in use), and (2) many files have a inode
1099 count of 1 (because they are a file which has no additional hard links).
1100
1101 @deftypefun errcode_t ext2fs_create_icount2 (ext2_filsys @var{fs}, int @var{flags}, int @var{size}, ext2_icount_t @var{hint}, ext2_icount_t *@var{ret})
1102
1103 Creates an icount stucture for a filesystem @var{fs}, with initial space
1104 for @var{size} inodes whose count is greater than 1.  The @var{flags}
1105 parameter is either 0 or @code{EXT2_ICOUNT_OPT_INCREMENT}, which
1106 indicates that icount structure should be able to increment inode counts
1107 quickly.  The icount structure is returned in @var{ret}.  The returned
1108 icount structure initially has a count of zero for all inodes.
1109
1110 The @var{hint} parameter allows the caller to optionally pass in another
1111 icount structure which is used to initialize the array of inodes whose
1112 count is greater than 1.  It is used purely as a speed optimization so
1113 that the icount structure can determine in advance which inodes are
1114 likely to contain a count grater than 1.
1115 @end deftypefun
1116
1117 @deftypefun void ext2fs_free_icount (ext2_icount_t @var{icount})
1118
1119 Frees an icount structure.
1120 @end deftypefun
1121
1122 @deftypefun errcode_t ext2fs_icount_fetch (ext2_icount_t @var{icount}, ext2_ino_t @var{ino}, __u16 *@var{ret})
1123
1124 Returns in @var{ret} fetches the count for a particular inode @var{ino}.
1125 @end deftypefun
1126
1127 @deftypefun errcode_t ext2fs_icount_increment (ext2_icount_t @var{icount}, ext2_ino_t @var{ino}, __u16 *@var{ret})
1128
1129 Increments the ref count for inode @var{ino}.
1130 @end deftypefun
1131
1132 @deftypefun errcode_t ext2fs_icount_decrement (ext2_icount_t @var{icount}, ext2_ino_t @var{ino}, __u16 *@var{ret})
1133
1134 Decrements the ref count for inode @var{ino}.
1135 @end deftypefun
1136
1137 @deftypefun errcode_t ext2fs_icount_store (ext2_icount_t @var{icount}, ext2_ino_t @var{ino}, __u16 @var{count})
1138
1139 Sets the reference count for inode @var{ino} to be @var{count}.
1140 @end deftypefun
1141
1142 @deftypefun ext2_ino_t ext2fs_get_icount_size (ext2_icount_t @var{icount})
1143
1144 Returns the current number of inodes in @var{icount} which has a count
1145 greater than 1.
1146 @end deftypefun
1147
1148 @deftypefun errcode_t ext2fs_icount_validate (ext2_icount_t @var{icount}, FILE *@var{f})
1149
1150 Validates the internal rep invariant of @var{icount}; if there are any
1151 problems, print out debugging information to @var{f}.  This function is
1152 intended for debugging and testing use only.
1153 @end deftypefun
1154
1155
1156 @c ----------------------------------------------------------------------
1157
1158 @node Byte-swapping functions, Other functions, EXT2 data abstractions, EXT2FS Library Functions
1159 @comment  node-name,  next,  previous,  up
1160 @section Byte-swapping functions
1161
1162 @deftypefun void ext2fs_swap_super (struct ext2_super_block * @var{super})
1163 @end deftypefun
1164
1165 @deftypefun void ext2fs_swap_group_desc (struct ext2_group_desc *@var{gdp})
1166 @end deftypefun
1167
1168 @deftypefun void ext2fs_swap_inode (ext2_filsys @var{fs}, struct ext2_inode *@var{to}, struct ext2_inode *@var{from}, int @var{hostorder})
1169 @end deftypefun
1170
1171 @deftypefun int ext2fs_native_flag (void)
1172 @end deftypefun
1173
1174
1175 @c ----------------------------------------------------------------------
1176
1177 @node Other functions,  , Byte-swapping functions, EXT2FS Library Functions
1178 @comment  node-name,  next,  previous,  up
1179 @section Other functions
1180
1181 /* alloc.c */
1182 @deftypefun errcode_t ext2fs_new_inode (ext2_filsys @var{fs}, ext2_ino_t @var{dir}, int @var{mode}, ext2fs_inode_bitmap @var{map}, ext2_ino_t *@var{ret})
1183 @end deftypefun
1184
1185 @deftypefun errcode_t ext2fs_new_block (ext2_filsys @var{fs}, blk_t @var{goal}, ext2fs_block_bitmap @var{map}, blk_t *@var{ret})
1186 @end deftypefun
1187
1188 @deftypefun errcode_t ext2fs_get_free_blocks (ext2_filsys @var{fs}, blk_t @var{start}, blk_t @var{finish}, int @var{num}, ext2fs_block_bitmap @var{map}, blk_t *@var{ret})
1189 @end deftypefun
1190
1191 /* check_desc.c */
1192 @deftypefun errcode_t ext2fs_check_desc (ext2_filsys @var{fs})
1193 @end deftypefun
1194
1195 @deftypefun errcode_t ext2_get_num_dirs (ext2_filsys @var{fs}, ext2_ino_t *@var{ret_num_dirs})
1196 @end deftypefun
1197
1198
1199 /* getsize.c */
1200 @deftypefun errcode_t ext2fs_get_device_size (const char *@var{file}, int @var{blocksize}, blk_t *@var{retblocks})
1201 @end deftypefun
1202
1203
1204 /* ismounted.c */
1205 @deftypefun errcode_t ext2fs_check_if_mounted (const char *@var{file}, int *@var{mount_flags})
1206 @end deftypefun
1207
1208 /* version.c */
1209
1210 @deftypefun int ext2fs_get_library_version (const char **@var{ver_string}, const char **@var{date_string})
1211
1212 This function returns the current version of the ext2 library.  The
1213 return value contains an integer version code, which consists of the
1214 major version number of the library multiplied by 100, plus the minor
1215 version number of the library.  Hence, if the library version is 1.08,
1216 the returned value will be 108.
1217
1218 If @var{ver_string} and/or @var{date_string} are non-NULL, they will be
1219 set to point at a constant string containing the library version and/or
1220 release date, respectively.
1221 @end deftypefun
1222
1223 @deftypefun int ext2fs_parse_version_string (const char *@var{ver_string})
1224
1225 This function takes a version string which may included in an
1226 application and returns a version code using the same algorithm used by
1227 @code{ext2fs_get_library_version}.  It can be used by programs included
1228 in the @code{e2fsprogs} distribution to assure that they are using an
1229 up-to-date ext2 shared library.
1230 @end deftypefun
1231
1232 /* inline functions */
1233 @deftypefun int ext2fs_group_of_blk (ext2_filsys @var{fs}, blk_t @var{blk})
1234
1235 This function returns the block group which contains the block @var{blk}.
1236
1237 @end deftypefun
1238
1239 @deftypefun int ext2fs_group_of_ino (ext2_filsys @var{fs}, ext2_ino_t @var{ino})
1240
1241 This function returns the block group which contains the inode @var{ino}.
1242 @end deftypefun
1243
1244
1245 @c ----------------------------------------------------------------------
1246
1247 @node Concept Index, Function Index, EXT2FS Library Functions, Top
1248 @comment  node-name,  next,  previous,  up
1249 @unnumbered Concept Index
1250 @printindex cp
1251
1252 @c ----------------------------------------------------------------------
1253
1254 @node Function Index,  , Concept Index, Top
1255 @comment  node-name,  next,  previous,  up
1256 @unnumbered Function and Type Index
1257 @printindex fn
1258
1259
1260 @contents
1261 @bye