include/linux/ext2

/* */
   1 /*
   2  *  linux/include/linux/ext2_fs.h
   3  *
   4  * Copyright (C) 1992, 1993, 1994, 1995
   5  * Remy Card (card@masi.ibp.fr)
   6  * Laboratoire MASI - Institut Blaise Pascal
   7  * Universite Pierre et Marie Curie (Paris VI)
   8  *
   9  *  from
  10  *
  11  *  linux/include/linux/minix_fs.h
  12  *
  13  *  Copyright (C) 1991, 1992  Linus Torvalds
  14  */
  15 
  16 #ifndef _LINUX_EXT2_FS_H
  17 #define _LINUX_EXT2_FS_H
  18 
  19 #include <linux/types.h>
  20 
  21 /*
  22  * The second extended filesystem constants/structures
  23  */
  24 
  25 /*
  26  * Define EXT2FS_DEBUG to produce debug messages
  27  */
  28 #undef EXT2FS_DEBUG
  29 
  30 /*
  31  * Define EXT2FS_DEBUG_CACHE to produce cache debug messages
  32  */
  33 #undef EXT2FS_DEBUG_CACHE
  34 
  35 /*
  36  * Define EXT2FS_CHECK_CACHE to add some checks to the name cache code
  37  */
  38 #undef EXT2FS_CHECK_CACHE
  39 
  40 /*
  41  * Define EXT2FS_PRE_02B_COMPAT to convert ext 2 fs prior to 0.2b
  42  */
  43 #undef EXT2FS_PRE_02B_COMPAT
  44 
  45 /*
  46  * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
  47  */
  48 #define EXT2_PREALLOCATE
  49 
  50 /*
  51  * The second extended file system version
  52  */
  53 #define EXT2FS_DATE             "95/03/19"
  54 #define EXT2FS_VERSION          "0.5a"
  55 
  56 /*
  57  * Debug code
  58  */
  59 #ifdef EXT2FS_DEBUG
  60 #       define ext2_debug(f, a...)      { \
  61                                         printk ("EXT2-fs DEBUG (%s, %d): %s:", \
  62                                                 __FILE__, __LINE__, __FUNCTION__); \
  63                                         printk (f, ## a); \
  64                                         }
  65 #else
  66 #       define ext2_debug(f, a...)      /**/
  67 #endif
  68 
  69 /*
  70  * Special inodes numbers
  71  */
  72 #define EXT2_BAD_INO             1      /* Bad blocks inode */
  73 #define EXT2_ROOT_INO            2      /* Root inode */
  74 #define EXT2_ACL_IDX_INO         3      /* ACL inode */
  75 #define EXT2_ACL_DATA_INO        4      /* ACL inode */
  76 #define EXT2_BOOT_LOADER_INO     5      /* Boot loader inode */
  77 #define EXT2_UNDEL_DIR_INO       6      /* Undelete directory inode */
  78 #define EXT2_FIRST_INO          11      /* First non reserved inode */
  79 
  80 /*
  81  * The second extended file system magic number
  82  */
  83 #define EXT2_PRE_02B_MAGIC      0xEF51
  84 #define EXT2_SUPER_MAGIC        0xEF53
  85 
  86 /*
  87  * Maximal count of links to a file
  88  */
  89 #define EXT2_LINK_MAX           32000
  90 
  91 /*
  92  * Macro-instructions used to manage several block sizes
  93  */
  94 #define EXT2_MIN_BLOCK_SIZE             1024
  95 #define EXT2_MAX_BLOCK_SIZE             4096
  96 #define EXT2_MIN_BLOCK_LOG_SIZE           10
  97 #ifdef __KERNEL__
  98 # define EXT2_BLOCK_SIZE(s)             ((s)->s_blocksize)
  99 #else
 100 # define EXT2_BLOCK_SIZE(s)             (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
 101 #endif
 102 #define EXT2_ACLE_PER_BLOCK(s)          (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_acl_entry))
 103 #define EXT2_ADDR_PER_BLOCK(s)          (EXT2_BLOCK_SIZE(s) / sizeof (__u32))
 104 #ifdef __KERNEL__
 105 # define EXT2_BLOCK_SIZE_BITS(s)        ((s)->u.ext2_sb.s_es->s_log_block_size + 10)
 106 #else
 107 # define EXT2_BLOCK_SIZE_BITS(s)        ((s)->s_log_block_size + 10)
 108 #endif
 109 #define EXT2_INODES_PER_BLOCK(s)        (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_inode))
 110 
 111 /*
 112  * Macro-instructions used to manage fragments
 113  */
 114 #define EXT2_MIN_FRAG_SIZE              1024
 115 #define EXT2_MAX_FRAG_SIZE              4096
 116 #define EXT2_MIN_FRAG_LOG_SIZE            10
 117 #ifdef __KERNEL__
 118 # define EXT2_FRAG_SIZE(s)              ((s)->u.ext2_sb.s_frag_size)
 119 # define EXT2_FRAGS_PER_BLOCK(s)        ((s)->u.ext2_sb.s_frags_per_block)
 120 #else
 121 # define EXT2_FRAG_SIZE(s)              (EXT2_MIN_FRAG_SIZE << (s)->s_log_frag_size)
 122 # define EXT2_FRAGS_PER_BLOCK(s)        (EXT2_BLOCK_SIZE(s) / EXT2_FRAG_SIZE(s))
 123 #endif
 124 
 125 /*
 126  * ACL structures
 127  */
 128 struct ext2_acl_header  /* Header of Access Control Lists */
 129 {
 130         __u32   aclh_size;
 131         __u32   aclh_file_count;
 132         __u32   aclh_acle_count;
 133         __u32   aclh_first_acle;
 134 };
 135 
 136 struct ext2_acl_entry   /* Access Control List Entry */
 137 {
 138         __u32   acle_size;
 139         __u16   acle_perms;     /* Access permissions */
 140         __u16   acle_type;      /* Type of entry */
 141         __u16   acle_tag;       /* User or group identity */
 142         __u16   acle_pad1;
 143         __u32   acle_next;      /* Pointer on next entry for the */
 144                                         /* same inode or on next free entry */
 145 };
 146 
 147 /*
 148  * Structure of a blocks group descriptor
 149  */
 150 struct ext2_old_group_desc
 151 {
 152         __u32   bg_block_bitmap;                /* Blocks bitmap block */
 153         __u32   bg_inode_bitmap;                /* Inodes bitmap block */
 154         __u32   bg_inode_table;         /* Inodes table block */
 155         __u16   bg_free_blocks_count;   /* Free blocks count */
 156         __u16   bg_free_inodes_count;   /* Free inodes count */
 157 };
 158 
 159 struct ext2_group_desc
 160 {
 161         __u32   bg_block_bitmap;                /* Blocks bitmap block */
 162         __u32   bg_inode_bitmap;                /* Inodes bitmap block */
 163         __u32   bg_inode_table;         /* Inodes table block */
 164         __u16   bg_free_blocks_count;   /* Free blocks count */
 165         __u16   bg_free_inodes_count;   /* Free inodes count */
 166         __u16   bg_used_dirs_count;     /* Directories count */
 167         __u16   bg_pad;
 168         __u32   bg_reserved[3];
 169 };
 170 
 171 /*
 172  * Macro-instructions used to manage group descriptors
 173  */
 174 #ifdef __KERNEL__
 175 # define EXT2_BLOCKS_PER_GROUP(s)       ((s)->u.ext2_sb.s_blocks_per_group)
 176 # define EXT2_DESC_PER_BLOCK(s)         ((s)->u.ext2_sb.s_desc_per_block)
 177 # define EXT2_INODES_PER_GROUP(s)       ((s)->u.ext2_sb.s_inodes_per_group)
 178 #else
 179 # define EXT2_BLOCKS_PER_GROUP(s)       ((s)->s_blocks_per_group)
 180 # define EXT2_DESC_PER_BLOCK(s)         (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_group_desc))
 181 # define EXT2_INODES_PER_GROUP(s)       ((s)->s_inodes_per_group)
 182 #endif
 183 
 184 /*
 185  * Constants relative to the data blocks
 186  */
 187 #define EXT2_NDIR_BLOCKS                12
 188 #define EXT2_IND_BLOCK                  EXT2_NDIR_BLOCKS
 189 #define EXT2_DIND_BLOCK                 (EXT2_IND_BLOCK + 1)
 190 #define EXT2_TIND_BLOCK                 (EXT2_DIND_BLOCK + 1)
 191 #define EXT2_N_BLOCKS                   (EXT2_TIND_BLOCK + 1)
 192 
 193 /*
 194  * Inode flags
 195  */
 196 #define EXT2_SECRM_FL                   0x00000001 /* Secure deletion */
 197 #define EXT2_UNRM_FL                    0x00000002 /* Undelete */
 198 #define EXT2_COMPR_FL                   0x00000004 /* Compress file */
 199 #define EXT2_SYNC_FL                    0x00000008 /* Synchronous updates */
 200 #define EXT2_IMMUTABLE_FL               0x00000010 /* Immutable file */
 201 #define EXT2_APPEND_FL                  0x00000020 /* writes to file may only append */
 202 #define EXT2_NODUMP_FL                  0x00000040 /* do not dump file */
 203 
 204 /*
 205  * ioctl commands
 206  */
 207 #define EXT2_IOC_GETFLAGS               _IOR('f', 1, long)
 208 #define EXT2_IOC_SETFLAGS               _IOW('f', 2, long)
 209 #define EXT2_IOC_GETVERSION             _IOR('v', 1, long)
 210 #define EXT2_IOC_SETVERSION             _IOW('v', 2, long)
 211 
 212 /*
 213  * Structure of an inode on the disk
 214  */
 215 struct ext2_inode {
 216         __u16 i_mode;           /* File mode */
 217         __u16 i_uid;            /* Owner Uid */
 218         __u32  i_size;          /* Size in bytes */
 219         __u32  i_atime;         /* Access time */
 220         __u32  i_ctime;         /* Creation time */
 221         __u32  i_mtime;         /* Modification time */
 222         __u32  i_dtime;         /* Deletion Time */
 223         __u16 i_gid;            /* Group Id */
 224         __u16 i_links_count;    /* Links count */
 225         __u32  i_blocks;        /* Blocks count */
 226         __u32  i_flags;         /* File flags */
 227         union {
 228                 struct {
 229                         __u32  l_i_reserved1;
 230                 } linux1;
 231                 struct {
 232                         __u32  h_i_translator;
 233                 } hurd1;
 234                 struct {
 235                         __u32  m_i_reserved1;
 236                 } masix1;
 237         } osd1;                         /* OS dependent 1 */
 238         __u32   i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
 239         __u32   i_version;      /* File version (for NFS) */
 240         __u32   i_file_acl;     /* File ACL */
 241         __u32   i_dir_acl;      /* Directory ACL */
 242         __u32   i_faddr;                /* Fragment address */
 243         union {
 244                 struct {
 245                         __u8    l_i_frag;       /* Fragment number */
 246                         __u8    l_i_fsize;      /* Fragment size */
 247                         __u16   i_pad1;
 248                         __u32   l_i_reserved2[2];
 249                 } linux2;
 250                 struct {
 251                         __u8    h_i_frag;       /* Fragment number */
 252                         __u8    h_i_fsize;      /* Fragment size */
 253                         __u16   h_i_mode_high;
 254                         __u16   h_i_uid_high;
 255                         __u16   h_i_gid_high;
 256                         __u32   h_i_author;
 257                 } hurd2;
 258                 struct {
 259                         __u8    m_i_frag;       /* Fragment number */
 260                         __u8    m_i_fsize;      /* Fragment size */
 261                         __u16   m_pad1;
 262                         __u32   m_i_reserved2[2];
 263                 } masix2;
 264         } osd2;                         /* OS dependent 2 */
 265 };
 266 
 267 #if defined(__KERNEL__) || defined(__linux__)
 268 #define i_reserved1     osd1.linux1.l_i_reserved1
 269 #define i_frag          osd2.linux2.l_i_frag
 270 #define i_fsize         osd2.linux2.l_i_fsize
 271 #define i_reserved2     osd2.linux2.l_i_reserved2
 272 #endif
 273 
 274 #ifdef  __hurd__
 275 #define i_translator    osd1.hurd1.h_i_translator
 276 #define i_frag          osd2.hurd2.h_i_frag;
 277 #define i_fsize         osd2.hurd2.h_i_fsize;
 278 #define i_uid_high      osd2.hurd2.h_i_uid_high
 279 #define i_gid_high      osd2.hurd2.h_i_gid_high
 280 #define i_author        osd2.hurd2.h_i_author
 281 #endif
 282 
 283 #ifdef  __masix__
 284 #define i_reserved1     osd1.masix1.m_i_reserved1
 285 #define i_frag          osd2.masix2.m_i_frag
 286 #define i_fsize         osd2.masix2.m_i_fsize
 287 #define i_reserved2     osd2.masix2.m_i_reserved2
 288 #endif
 289 
 290 /*
 291  * File system states
 292  */
 293 #define EXT2_VALID_FS                   0x0001  /* Unmounted cleanly */
 294 #define EXT2_ERROR_FS                   0x0002  /* Errors detected */
 295 
 296 /*
 297  * Mount flags
 298  */
 299 #define EXT2_MOUNT_CHECK_NORMAL         0x0001  /* Do some more checks */
 300 #define EXT2_MOUNT_CHECK_STRICT         0x0002  /* Do again more checks */
 301 #define EXT2_MOUNT_CHECK                (EXT2_MOUNT_CHECK_NORMAL | \
 302                                          EXT2_MOUNT_CHECK_STRICT)
 303 #define EXT2_MOUNT_GRPID                0x0004  /* Create files with directory's group */
 304 #define EXT2_MOUNT_DEBUG                0x0008  /* Some debugging messages */
 305 #define EXT2_MOUNT_ERRORS_CONT          0x0010  /* Continue on errors */
 306 #define EXT2_MOUNT_ERRORS_RO            0x0020  /* Remount fs ro on errors */
 307 #define EXT2_MOUNT_ERRORS_PANIC         0x0040  /* Panic on errors */
 308 #define EXT2_MOUNT_MINIX_DF             0x0080  /* Mimics the Minix statfs */
 309 
 310 #define clear_opt(o, opt)               o &= ~EXT2_MOUNT_##opt
 311 #define set_opt(o, opt)                 o |= EXT2_MOUNT_##opt
 312 #define test_opt(sb, opt)               ((sb)->u.ext2_sb.s_mount_opt & \
 313                                          EXT2_MOUNT_##opt)
 314 /*
 315  * Maximal mount counts between two filesystem checks
 316  */
 317 #define EXT2_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
 318 #define EXT2_DFL_CHECKINTERVAL          0       /* Don't use interval check */
 319 
 320 /*
 321  * Behaviour when detecting errors
 322  */
 323 #define EXT2_ERRORS_CONTINUE            1       /* Continue execution */
 324 #define EXT2_ERRORS_RO                  2       /* Remount fs read-only */
 325 #define EXT2_ERRORS_PANIC               3       /* Panic */
 326 #define EXT2_ERRORS_DEFAULT             EXT2_ERRORS_CONTINUE
 327 
 328 /*
 329  * Structure of the super block
 330  */
 331 struct ext2_super_block {
 332         __u32   s_inodes_count;         /* Inodes count */
 333         __u32   s_blocks_count;         /* Blocks count */
 334         __u32   s_r_blocks_count;       /* Reserved blocks count */
 335         __u32   s_free_blocks_count;    /* Free blocks count */
 336         __u32   s_free_inodes_count;    /* Free inodes count */
 337         __u32   s_first_data_block;     /* First Data Block */
 338         __u32   s_log_block_size;       /* Block size */
 339         __s32   s_log_frag_size;        /* Fragment size */
 340         __u32   s_blocks_per_group;     /* # Blocks per group */
 341         __u32   s_frags_per_group;      /* # Fragments per group */
 342         __u32   s_inodes_per_group;     /* # Inodes per group */
 343         __u32   s_mtime;                /* Mount time */
 344         __u32   s_wtime;                /* Write time */
 345         __u16   s_mnt_count;            /* Mount count */
 346         __s16   s_max_mnt_count;        /* Maximal mount count */
 347         __u16   s_magic;                /* Magic signature */
 348         __u16   s_state;                /* File system state */
 349         __u16   s_errors;               /* Behaviour when detecting errors */
 350         __u16   s_pad;
 351         __u32   s_lastcheck;            /* time of last check */
 352         __u32   s_checkinterval;        /* max. time between checks */
 353         __u32   s_creator_os;           /* OS */
 354         __u32   s_rev_level;            /* Revision level */
 355         __u16   s_def_resuid;           /* Default uid for reserved blocks */
 356         __u16   s_def_resgid;           /* Default gid for reserved blocks */
 357         __u32   s_reserved[235];        /* Padding to the end of the block */
 358 };
 359 
 360 #define EXT2_OS_LINUX           0
 361 #define EXT2_OS_HURD            1
 362 #define EXT2_OS_MASIX           2
 363 
 364 #define EXT2_CURRENT_REV        0
 365 
 366 #define EXT2_DEF_RESUID         0
 367 #define EXT2_DEF_RESGID         0
 368 
 369 /*
 370  * Structure of a directory entry
 371  */
 372 #define EXT2_NAME_LEN 255
 373 
 374 struct ext2_dir_entry {
 375         __u32   inode;                  /* Inode number */
 376         __u16   rec_len;                /* Directory entry length */
 377         __u16   name_len;               /* Name length */
 378         char    name[EXT2_NAME_LEN];    /* File name */
 379 };
 380 
 381 /*
 382  * EXT2_DIR_PAD defines the directory entries boundaries
 383  *
 384  * NOTE: It must be a multiple of 4
 385  */
 386 #define EXT2_DIR_PAD                    4
 387 #define EXT2_DIR_ROUND                  (EXT2_DIR_PAD - 1)
 388 #define EXT2_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT2_DIR_ROUND) & \
 389                                          ~EXT2_DIR_ROUND)
 390 
 391 #ifdef __KERNEL__
 392 /*
 393  * Function prototypes
 394  */
 395 
 396 /*
 397  * Ok, these declarations are also in <linux/kernel.h> but none of the
 398  * ext2 source programs needs to include it so they are duplicated here.
 399  */
 400 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
 401 # define NORET_TYPE    __volatile__
 402 # define ATTRIB_NORET  /**/
 403 # define NORET_AND     /**/
 404 #else
 405 # define NORET_TYPE    /**/
 406 # define ATTRIB_NORET  __attribute__((noreturn))
 407 # define NORET_AND     noreturn,
 408 #endif
 409 
 410 /* acl.c */
 411 extern int ext2_permission (struct inode *, int);
 412 
 413 /* balloc.c */
 414 extern int ext2_new_block (struct super_block *, unsigned long,
 415                            __u32 *, __u32 *);
 416 extern void ext2_free_blocks (struct super_block *, unsigned long,
 417                               unsigned long);
 418 extern unsigned long ext2_count_free_blocks (struct super_block *);
 419 extern void ext2_check_blocks_bitmap (struct super_block *);
 420 
 421 /* bitmap.c */
 422 extern unsigned long ext2_count_free (struct buffer_head *, unsigned);
 423 
 424 /* dir.c */
 425 extern int ext2_check_dir_entry (char *, struct inode *,
 426                                  struct ext2_dir_entry *, struct buffer_head *,
 427                                  unsigned long);
 428 
 429 /* file.c */
 430 extern int ext2_read (struct inode *, struct file *, char *, int);
 431 extern int ext2_write (struct inode *, struct file *, char *, int);
 432 
 433 /* fsync.c */
 434 extern int ext2_sync_file (struct inode *, struct file *);
 435 
 436 /* ialloc.c */
 437 extern struct inode * ext2_new_inode (const struct inode *, int);
 438 extern void ext2_free_inode (struct inode *);
 439 extern unsigned long ext2_count_free_inodes (struct super_block *);
 440 extern void ext2_check_inodes_bitmap (struct super_block *);
 441 
 442 /* inode.c */
 443 extern int ext2_bmap (struct inode *, int);
 444 
 445 extern struct buffer_head * ext2_getblk (struct inode *, long, int, int *);
 446 extern struct buffer_head * ext2_bread (struct inode *, int, int, int *);
 447 
 448 extern int ext2_getcluster (struct inode * inode, long block);
 449 extern void ext2_read_inode (struct inode *);
 450 extern void ext2_write_inode (struct inode *);
 451 extern void ext2_put_inode (struct inode *);
 452 extern int ext2_sync_inode (struct inode *);
 453 extern void ext2_discard_prealloc (struct inode *);
 454 
 455 /* ioctl.c */
 456 extern int ext2_ioctl (struct inode *, struct file *, unsigned int,
 457                        unsigned long);
 458 
 459 /* namei.c */
 460 extern void ext2_release (struct inode *, struct file *);
 461 extern int ext2_lookup (struct inode *,const char *, int, struct inode **);
 462 extern int ext2_create (struct inode *,const char *, int, int,
 463                         struct inode **);
 464 extern int ext2_mkdir (struct inode *, const char *, int, int);
 465 extern int ext2_rmdir (struct inode *, const char *, int);
 466 extern int ext2_unlink (struct inode *, const char *, int);
 467 extern int ext2_symlink (struct inode *, const char *, int, const char *);
 468 extern int ext2_link (struct inode *, struct inode *, const char *, int);
 469 extern int ext2_mknod (struct inode *, const char *, int, int, int);
 470 extern int ext2_rename (struct inode *, const char *, int,
 471                         struct inode *, const char *, int);
 472 
 473 /* super.c */
 474 extern void ext2_error (struct super_block *, const char *, const char *, ...)
 475         __attribute__ ((format (printf, 3, 4)));
 476 extern NORET_TYPE void ext2_panic (struct super_block *, const char *,
 477                                    const char *, ...)
 478         __attribute__ ((NORET_AND format (printf, 3, 4)));
 479 extern void ext2_warning (struct super_block *, const char *, const char *, ...)
 480         __attribute__ ((format (printf, 3, 4)));
 481 extern void ext2_put_super (struct super_block *);
 482 extern void ext2_write_super (struct super_block *);
 483 extern int ext2_remount (struct super_block *, int *, char *);
 484 extern struct super_block * ext2_read_super (struct super_block *,void *,int);
 485 extern void ext2_statfs (struct super_block *, struct statfs *);
 486 
 487 /* truncate.c */
 488 extern void ext2_truncate (struct inode *);
 489 
 490 /*
 491  * Inodes and files operations
 492  */
 493 
 494 /* dir.c */
 495 extern struct inode_operations ext2_dir_inode_operations;
 496 
 497 /* file.c */
 498 extern struct inode_operations ext2_file_inode_operations;
 499 
 500 /* symlink.c */
 501 extern struct inode_operations ext2_symlink_inode_operations;
 502 
 503 #endif  /* __KERNEL__ */
 504 
 505 #endif  /* _LINUX_EXT2_FS_H */
/* */
root/include/linux/ext2_fs.h

INCLUDED FROM
