1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Copyright (C) International Business Machines Corp., 2000-2003
4 */
5#ifndef _H_JFS_FILSYS
6#define _H_JFS_FILSYS
7
8/*
9 * jfs_filsys.h
10 *
11 * file system (implementation-dependent) constants
12 *
13 * refer to <limits.h> for system wide implementation-dependent constants
14 */
15
16/*
17 * file system option (superblock flag)
18 */
19
20/* directory option */
21#define JFS_UNICODE 0x00000001 /* unicode name */
22
23/* mount time flags for error handling */
24#define JFS_ERR_REMOUNT_RO 0x00000002 /* remount read-only */
25#define JFS_ERR_CONTINUE 0x00000004 /* continue */
26#define JFS_ERR_PANIC 0x00000008 /* panic */
27
28/* Quota support */
29#define JFS_USRQUOTA 0x00000010
30#define JFS_GRPQUOTA 0x00000020
31
32/* mount time flag to disable journaling to disk */
33#define JFS_NOINTEGRITY 0x00000040
34
35/* mount time flag to enable TRIM to ssd disks */
36#define JFS_DISCARD 0x00000080
37
38/* commit option */
39#define JFS_COMMIT 0x00000f00 /* commit option mask */
40#define JFS_GROUPCOMMIT 0x00000100 /* group (of 1) commit */
41#define JFS_LAZYCOMMIT 0x00000200 /* lazy commit */
42#define JFS_TMPFS 0x00000400 /* temporary file system -
43 * do not log/commit:
44 * Never implemented
45 */
46
47/* log logical volume option */
48#define JFS_INLINELOG 0x00000800 /* inline log within file system */
49#define JFS_INLINEMOVE 0x00001000 /* inline log being moved */
50
51/* Secondary aggregate inode table */
52#define JFS_BAD_SAIT 0x00010000 /* current secondary ait is bad */
53
54/* sparse regular file support */
55#define JFS_SPARSE 0x00020000 /* sparse regular file */
56
57/* DASD Limits F226941 */
58#define JFS_DASD_ENABLED 0x00040000 /* DASD limits enabled */
59#define JFS_DASD_PRIME 0x00080000 /* Prime DASD usage on boot */
60
61/* big endian flag */
62#define JFS_SWAP_BYTES 0x00100000 /* running on big endian computer */
63
64/* Directory index */
65#define JFS_DIR_INDEX 0x00200000 /* Persistent index for */
66
67/* platform options */
68#define JFS_LINUX 0x10000000 /* Linux support */
69#define JFS_DFS 0x20000000 /* DCE DFS LFS support */
70/* Never implemented */
71
72#define JFS_OS2 0x40000000 /* OS/2 support */
73/* case-insensitive name/directory support */
74
75#define JFS_AIX 0x80000000 /* AIX support */
76
77/*
78 * buffer cache configuration
79 */
80/* page size */
81#ifdef PSIZE
82#undef PSIZE
83#endif
84#define PSIZE 4096 /* page size (in byte) */
85#define L2PSIZE 12 /* log2(PSIZE) */
86#define POFFSET 4095 /* offset within page */
87
88/* buffer page size */
89#define BPSIZE PSIZE
90
91/*
92 * fs fundamental size
93 *
94 * PSIZE >= file system block size >= PBSIZE >= DISIZE
95 */
96#define PBSIZE 512 /* physical block size (in byte) */
97#define L2PBSIZE 9 /* log2(PBSIZE) */
98
99#define DISIZE 512 /* on-disk inode size (in byte) */
100#define L2DISIZE 9 /* log2(DISIZE) */
101
102#define IDATASIZE 256 /* inode inline data size */
103#define IXATTRSIZE 128 /* inode inline extended attribute size */
104
105#define XTPAGE_SIZE 4096
106#define log2_PAGESIZE 12
107
108#define IAG_SIZE 4096
109#define IAG_EXTENT_SIZE 4096
110#define INOSPERIAG 4096 /* number of disk inodes per iag */
111#define L2INOSPERIAG 12 /* l2 number of disk inodes per iag */
112#define INOSPEREXT 32 /* number of disk inode per extent */
113#define L2INOSPEREXT 5 /* l2 number of disk inode per extent */
114#define IXSIZE (DISIZE * INOSPEREXT) /* inode extent size */
115#define INOSPERPAGE 8 /* number of disk inodes per 4K page */
116#define L2INOSPERPAGE 3 /* log2(INOSPERPAGE) */
117
118#define IAGFREELIST_LWM 64
119
120#define INODE_EXTENT_SIZE IXSIZE /* inode extent size */
121#define NUM_INODE_PER_EXTENT INOSPEREXT
122#define NUM_INODE_PER_IAG INOSPERIAG
123
124#define MINBLOCKSIZE 512
125#define L2MINBLOCKSIZE 9
126#define MAXBLOCKSIZE 4096
127#define L2MAXBLOCKSIZE 12
128#define MAXFILESIZE ((s64)1 << 52)
129
130#define JFS_LINK_MAX 0xffffffff
131
132/* Minimum number of bytes supported for a JFS partition */
133#define MINJFS (0x1000000)
134#define MINJFSTEXT "16"
135
136/*
137 * file system block size -> physical block size
138 */
139#define LBOFFSET(x) ((x) & (PBSIZE - 1))
140#define LBNUMBER(x) ((x) >> L2PBSIZE)
141#define LBLK2PBLK(sb,b) ((b) << (sb->s_blocksize_bits - L2PBSIZE))
142#define PBLK2LBLK(sb,b) ((b) >> (sb->s_blocksize_bits - L2PBSIZE))
143/* size in byte -> last page number */
144#define SIZE2PN(size) ( ((s64)((size) - 1)) >> (L2PSIZE) )
145/* size in byte -> last file system block number */
146#define SIZE2BN(size, l2bsize) ( ((s64)((size) - 1)) >> (l2bsize) )
147
148/*
149 * fixed physical block address (physical block size = 512 byte)
150 *
151 * NOTE: since we can't guarantee a physical block size of 512 bytes the use of
152 * these macros should be removed and the byte offset macros used instead.
153 */
154#define SUPER1_B 64 /* primary superblock */
155#define AIMAP_B (SUPER1_B + 8) /* 1st extent of aggregate inode map */
156#define AITBL_B (AIMAP_B + 16) /*
157 * 1st extent of aggregate inode table
158 */
159#define SUPER2_B (AITBL_B + 32) /* 2ndary superblock pbn */
160#define BMAP_B (SUPER2_B + 8) /* block allocation map */
161
162/*
163 * SIZE_OF_SUPER defines the total amount of space reserved on disk for the
164 * superblock. This is not the same as the superblock structure, since all of
165 * this space is not currently being used.
166 */
167#define SIZE_OF_SUPER PSIZE
168
169/*
170 * SIZE_OF_AG_TABLE defines the amount of space reserved to hold the AG table
171 */
172#define SIZE_OF_AG_TABLE PSIZE
173
174/*
175 * SIZE_OF_MAP_PAGE defines the amount of disk space reserved for each page of
176 * the inode allocation map (to hold iag)
177 */
178#define SIZE_OF_MAP_PAGE PSIZE
179
180/*
181 * fixed byte offset address
182 */
183#define SUPER1_OFF 0x8000 /* primary superblock */
184#define AIMAP_OFF (SUPER1_OFF + SIZE_OF_SUPER)
185 /*
186 * Control page of aggregate inode map
187 * followed by 1st extent of map
188 */
189#define AITBL_OFF (AIMAP_OFF + (SIZE_OF_MAP_PAGE << 1))
190 /*
191 * 1st extent of aggregate inode table
192 */
193#define SUPER2_OFF (AITBL_OFF + INODE_EXTENT_SIZE)
194 /*
195 * secondary superblock
196 */
197#define BMAP_OFF (SUPER2_OFF + SIZE_OF_SUPER)
198 /*
199 * block allocation map
200 */
201
202/*
203 * The following macro is used to indicate the number of reserved disk blocks at
204 * the front of an aggregate, in terms of physical blocks. This value is
205 * currently defined to be 32K. This turns out to be the same as the primary
206 * superblock's address, since it directly follows the reserved blocks.
207 */
208#define AGGR_RSVD_BLOCKS SUPER1_B
209
210/*
211 * The following macro is used to indicate the number of reserved bytes at the
212 * front of an aggregate. This value is currently defined to be 32K. This
213 * turns out to be the same as the primary superblock's byte offset, since it
214 * directly follows the reserved blocks.
215 */
216#define AGGR_RSVD_BYTES SUPER1_OFF
217
218/*
219 * The following macro defines the byte offset for the first inode extent in
220 * the aggregate inode table. This allows us to find the self inode to find the
221 * rest of the table. Currently this value is 44K.
222 */
223#define AGGR_INODE_TABLE_START AITBL_OFF
224
225/*
226 * fixed reserved inode number
227 */
228/* aggregate inode */
229#define AGGR_RESERVED_I 0 /* aggregate inode (reserved) */
230#define AGGREGATE_I 1 /* aggregate inode map inode */
231#define BMAP_I 2 /* aggregate block allocation map inode */
232#define LOG_I 3 /* aggregate inline log inode */
233#define BADBLOCK_I 4 /* aggregate bad block inode */
234#define FILESYSTEM_I 16 /* 1st/only fileset inode in ait:
235 * fileset inode map inode
236 */
237
238/* per fileset inode */
239#define FILESET_RSVD_I 0 /* fileset inode (reserved) */
240#define FILESET_EXT_I 1 /* fileset inode extension */
241#define ROOT_I 2 /* fileset root inode */
242#define ACL_I 3 /* fileset ACL inode */
243
244#define FILESET_OBJECT_I 4 /* the first fileset inode available for a file
245 * or directory or link...
246 */
247#define FIRST_FILESET_INO 16 /* the first aggregate inode which describes
248 * an inode. (To fsck this is also the first
249 * inode in part 2 of the agg inode table.)
250 */
251
252/*
253 * directory configuration
254 */
255#define JFS_NAME_MAX 255
256#define JFS_PATH_MAX BPSIZE
257
258
259/*
260 * file system state (superblock state)
261 */
262#define FM_CLEAN 0x00000000 /* file system is unmounted and clean */
263#define FM_MOUNT 0x00000001 /* file system is mounted cleanly */
264#define FM_DIRTY 0x00000002 /* file system was not unmounted and clean
265 * when mounted or
266 * commit failure occurred while being mounted:
267 * fsck() must be run to repair
268 */
269#define FM_LOGREDO 0x00000004 /* log based recovery (logredo()) failed:
270 * fsck() must be run to repair
271 */
272#define FM_EXTENDFS 0x00000008 /* file system extendfs() in progress */
273#define FM_STATE_MAX 0x0000000f /* max value of s_state */
274
275#endif /* _H_JFS_FILSYS */
276

source code of linux/fs/jfs/jfs_filsys.h