doc/libext2fs.texinfo

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