[linux.git] / fs / jfs / jfs_dinode.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *   Copyright (C) International Business Machines Corp., 2000-2001
 */
#ifndef _H_JFS_DINODE
#define _H_JFS_DINODE

/*
 *	jfs_dinode.h: on-disk inode manager
 */

#define INODESLOTSIZE		128
#define L2INODESLOTSIZE		7
#define log2INODESIZE		9	/* log2(bytes per dinode) */


/*
 *	on-disk inode : 512 bytes
 *
 * note: align 64-bit fields on 8-byte boundary.
 */
struct dinode {
	/*
	 *	I. base area (128 bytes)
	 *	------------------------
	 *
	 * define generic/POSIX attributes
	 */
	__le32 di_inostamp;	/* 4: stamp to show inode belongs to fileset */
	__le32 di_fileset;	/* 4: fileset number */
	__le32 di_number;	/* 4: inode number, aka file serial number */
	__le32 di_gen;		/* 4: inode generation number */

	pxd_t di_ixpxd;		/* 8: inode extent descriptor */

	__le64 di_size;		/* 8: size */
	__le64 di_nblocks;	/* 8: number of blocks allocated */

	__le32 di_nlink;	/* 4: number of links to the object */

	__le32 di_uid;		/* 4: user id of owner */
	__le32 di_gid;		/* 4: group id of owner */

	__le32 di_mode;		/* 4: attribute, format and permission */

	struct timestruc_t di_atime;	/* 8: time last data accessed */
	struct timestruc_t di_ctime;	/* 8: time last status changed */
	struct timestruc_t di_mtime;	/* 8: time last data modified */
	struct timestruc_t di_otime;	/* 8: time created */

	dxd_t di_acl;		/* 16: acl descriptor */

	dxd_t di_ea;		/* 16: ea descriptor */

	__le32 di_next_index;	/* 4: Next available dir_table index */

	__le32 di_acltype;	/* 4: Type of ACL */

	/*
	 *	Extension Areas.
	 *
	 *	Historically, the inode was partitioned into 4 128-byte areas,
	 *	the last 3 being defined as unions which could have multiple
	 *	uses.  The first 96 bytes had been completely unused until
	 *	an index table was added to the directory.  It is now more
	 *	useful to describe the last 3/4 of the inode as a single
	 *	union.  We would probably be better off redesigning the
	 *	entire structure from scratch, but we don't want to break
	 *	commonality with OS/2's JFS at this time.
	 */
	union {
		struct {
			/*
			 * This table contains the information needed to
			 * find a directory entry from a 32-bit index.
			 * If the index is small enough, the table is inline,
			 * otherwise, an x-tree root overlays this table
			 */
			struct dir_table_slot _table[12]; /* 96: inline */

			dtroot_t _dtroot;		/* 288: dtree root */
		} _dir;					/* (384) */
#define di_dirtable	u._dir._table
#define di_dtroot	u._dir._dtroot
#define di_parent	di_dtroot.header.idotdot
#define di_DASD		di_dtroot.header.DASD

		struct {
			union {
				u8 _data[96];		/* 96: unused */
				struct {
					void *_imap;	/* 4: unused */
					__le32 _gengen;	/* 4: generator */
				} _imap;
			} _u1;				/* 96: */
#define di_gengen	u._file._u1._imap._gengen

			union {
				xtroot_t _xtroot;
				struct {
					u8 unused[16];	/* 16: */
					dxd_t _dxd;	/* 16: */
					union {
						/*
						 * The fast symlink area
						 * is expected to overflow
						 * into _inlineea when
						 * needed (which will clear
						 * INLINEEA).
						 */
						struct {
							union {
								__le32 _rdev;	/* 4: */
								u8 _fastsymlink[128];
							} _u;
							u8 _inlineea[128];
						};
						u8 _inline_all[256];
					};
				} _special;
			} _u2;
		} _file;
#define di_xtroot	u._file._u2._xtroot
#define di_dxd		u._file._u2._special._dxd
#define di_btroot	di_xtroot
#define di_inlinedata	u._file._u2._special._u
#define di_rdev		u._file._u2._special._u._rdev
#define di_fastsymlink	u._file._u2._special._u._fastsymlink
#define di_inlineea	u._file._u2._special._inlineea
#define di_inline_all	u._file._u2._special._inline_all
	} u;
};

/* extended mode bits (on-disk inode di_mode) */
#define IFJOURNAL	0x00010000	/* journalled file */
#define ISPARSE		0x00020000	/* sparse file enabled */
#define INLINEEA	0x00040000	/* inline EA area free */
#define ISWAPFILE	0x00800000	/* file open for pager swap space */

/* more extended mode bits: attributes for OS/2 */
#define IREADONLY	0x02000000	/* no write access to file */
#define IHIDDEN		0x04000000	/* hidden file */
#define ISYSTEM		0x08000000	/* system file */

#define IDIRECTORY	0x20000000	/* directory (shadow of real bit) */
#define IARCHIVE	0x40000000	/* file archive bit */
#define INEWNAME	0x80000000	/* non-8.3 filename format */

#define IRASH		0x4E000000	/* mask for changeable attributes */
#define ATTRSHIFT	25	/* bits to shift to move attribute
				   specification to mode position */

/* extended attributes for Linux */

#define JFS_NOATIME_FL		0x00080000 /* do not update atime */

#define JFS_DIRSYNC_FL		0x00100000 /* dirsync behaviour */
#define JFS_SYNC_FL		0x00200000 /* Synchronous updates */
#define JFS_SECRM_FL		0x00400000 /* Secure deletion */
#define JFS_UNRM_FL		0x00800000 /* allow for undelete */

#define JFS_APPEND_FL		0x01000000 /* writes to file may only append */
#define JFS_IMMUTABLE_FL	0x02000000 /* Immutable file */

#define JFS_FL_USER_VISIBLE	0x03F80000
#define JFS_FL_USER_MODIFIABLE	0x03F80000
#define JFS_FL_INHERIT		0x03C80000

#endif /*_H_JFS_DINODE */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4	2	/*
63f83c9f	3	* Copyright (C) International Business Machines Corp., 2000-2001
1da177e4 LT	4	*/
	5	#ifndef _H_JFS_DINODE
	6	#define _H_JFS_DINODE
	7
	8	/*
f720e3ba	9	* jfs_dinode.h: on-disk inode manager
1da177e4 LT	10	*/
1da177e4 LT	11
f720e3ba DK	12	#define INODESLOTSIZE 128
	13	#define L2INODESLOTSIZE 7
	14	#define log2INODESIZE 9 /* log2(bytes per dinode) */
1da177e4 LT	15
	16
	17	/*
f720e3ba	18	* on-disk inode : 512 bytes
1da177e4 LT	19	*
	20	* note: align 64-bit fields on 8-byte boundary.
	21	*/
	22	struct dinode {
	23	/*
f720e3ba DK	24	* I. base area (128 bytes)
f720e3ba DK	25	* ------------------------
1da177e4 LT	26	*
	27	* define generic/POSIX attributes
	28	*/
	29	__le32 di_inostamp; /* 4: stamp to show inode belongs to fileset */
	30	__le32 di_fileset; /* 4: fileset number */
	31	__le32 di_number; /* 4: inode number, aka file serial number */
	32	__le32 di_gen; /* 4: inode generation number */
	33
	34	pxd_t di_ixpxd; /* 8: inode extent descriptor */
	35
	36	__le64 di_size; /* 8: size */
	37	__le64 di_nblocks; /* 8: number of blocks allocated */
	38
	39	__le32 di_nlink; /* 4: number of links to the object */
	40
	41	__le32 di_uid; /* 4: user id of owner */
	42	__le32 di_gid; /* 4: group id of owner */
	43
	44	__le32 di_mode; /* 4: attribute, format and permission */
	45
	46	struct timestruc_t di_atime; /* 8: time last data accessed */
	47	struct timestruc_t di_ctime; /* 8: time last status changed */
	48	struct timestruc_t di_mtime; /* 8: time last data modified */
	49	struct timestruc_t di_otime; /* 8: time created */
	50
	51	dxd_t di_acl; /* 16: acl descriptor */
	52
	53	dxd_t di_ea; /* 16: ea descriptor */
	54
	55	__le32 di_next_index; /* 4: Next available dir_table index */
	56
	57	__le32 di_acltype; /* 4: Type of ACL */
	58
	59	/*
f720e3ba	60	* Extension Areas.
1da177e4	61	*
f720e3ba DK	62	* Historically, the inode was partitioned into 4 128-byte areas,
	63	* the last 3 being defined as unions which could have multiple
	64	* uses. The first 96 bytes had been completely unused until
	65	* an index table was added to the directory. It is now more
	66	* useful to describe the last 3/4 of the inode as a single
	67	* union. We would probably be better off redesigning the
	68	* entire structure from scratch, but we don't want to break
	69	* commonality with OS/2's JFS at this time.
1da177e4 LT	70	*/
	71	union {
	72	struct {
	73	/*
	74	* This table contains the information needed to
	75	* find a directory entry from a 32-bit index.
	76	* If the index is small enough, the table is inline,
	77	* otherwise, an x-tree root overlays this table
	78	*/
	79	struct dir_table_slot _table[12]; /* 96: inline */
	80
	81	dtroot_t _dtroot; /* 288: dtree root */
	82	} _dir; /* (384) */
	83	#define di_dirtable u._dir._table
	84	#define di_dtroot u._dir._dtroot
f720e3ba	85	#define di_parent di_dtroot.header.idotdot
1da177e4 LT	86	#define di_DASD di_dtroot.header.DASD
	87
	88	struct {
	89	union {
	90	u8 _data[96]; /* 96: unused */
	91	struct {
	92	void _imap; / 4: unused */
	93	__le32 _gengen; /* 4: generator */
	94	} _imap;
	95	} _u1; /* 96: */
	96	#define di_gengen u._file._u1._imap._gengen
	97
	98	union {
a779ed75	99	xtroot_t _xtroot;
1da177e4 LT	100	struct {
	101	u8 unused[16]; /* 16: */
	102	dxd_t _dxd; /* 16: */
	103	union {
961b33c2 KC	104	/*
	105	* The fast symlink area
	106	* is expected to overflow
	107	* into _inlineea when
	108	* needed (which will clear
	109	* INLINEEA).
	110	*/
5d299f44 KC	111	struct {
	112	union {
	113	__le32 _rdev; /* 4: */
	114	u8 _fastsymlink[128];
	115	} _u;
	116	u8 _inlineea[128];
	117	};
	118	u8 _inline_all[256];
	119	};
1da177e4 LT	120	} _special;
	121	} _u2;
	122	} _file;
	123	#define di_xtroot u._file._u2._xtroot
	124	#define di_dxd u._file._u2._special._dxd
	125	#define di_btroot di_xtroot
	126	#define di_inlinedata u._file._u2._special._u
	127	#define di_rdev u._file._u2._special._u._rdev
	128	#define di_fastsymlink u._file._u2._special._u._fastsymlink
f720e3ba	129	#define di_inlineea u._file._u2._special._inlineea
5d299f44	130	#define di_inline_all u._file._u2._special._inline_all
1da177e4 LT	131	} u;
	132	};
	133
	134	/* extended mode bits (on-disk inode di_mode) */
f720e3ba DK	135	#define IFJOURNAL 0x00010000 /* journalled file */
	136	#define ISPARSE 0x00020000 /* sparse file enabled */
	137	#define INLINEEA 0x00040000 /* inline EA area free */
1da177e4 LT	138	#define ISWAPFILE 0x00800000 /* file open for pager swap space */
	139
	140	/* more extended mode bits: attributes for OS/2 */
	141	#define IREADONLY 0x02000000 /* no write access to file */
1da177e4	142	#define IHIDDEN 0x04000000 /* hidden file */
fa3241d2 HP	143	#define ISYSTEM 0x08000000 /* system file */
fa3241d2 HP	144
1da177e4	145	#define IDIRECTORY 0x20000000 /* directory (shadow of real bit) */
fa3241d2 HP	146	#define IARCHIVE 0x40000000 /* file archive bit */
	147	#define INEWNAME 0x80000000 /* non-8.3 filename format */
	148
	149	#define IRASH 0x4E000000 /* mask for changeable attributes */
1da177e4 LT	150	#define ATTRSHIFT 25 /* bits to shift to move attribute
	151	specification to mode position */
	152
fa3241d2 HP	153	/* extended attributes for Linux */
	154
	155	#define JFS_NOATIME_FL 0x00080000 /* do not update atime */
	156
	157	#define JFS_DIRSYNC_FL 0x00100000 /* dirsync behaviour */
	158	#define JFS_SYNC_FL 0x00200000 /* Synchronous updates */
	159	#define JFS_SECRM_FL 0x00400000 /* Secure deletion */
	160	#define JFS_UNRM_FL 0x00800000 /* allow for undelete */
	161
	162	#define JFS_APPEND_FL 0x01000000 /* writes to file may only append */
	163	#define JFS_IMMUTABLE_FL 0x02000000 /* Immutable file */
	164
	165	#define JFS_FL_USER_VISIBLE 0x03F80000
	166	#define JFS_FL_USER_MODIFIABLE 0x03F80000
	167	#define JFS_FL_INHERIT 0x03C80000
	168
1da177e4	169	#endif /_H_JFS_DINODE /