1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6 #ifndef __XFS_LOG_FORMAT_H__
7 #define __XFS_LOG_FORMAT_H__
8
9 struct xfs_mount;
10 struct xfs_trans_res;
11
12 /*
13 * On-disk Log Format definitions.
14 *
15 * This file contains all the on-disk format definitions used within the log. It
16 * includes the physical log structure itself, as well as all the log item
17 * format structures that are written into the log and intepreted by log
18 * recovery. We start with the physical log format definitions, and then work
19 * through all the log items definitions and everything they encode into the
20 * log.
21 */
22 typedef uint32_t xlog_tid_t;
23
24 #define XLOG_MIN_ICLOGS 2
25 #define XLOG_MAX_ICLOGS 8
26 #define XLOG_HEADER_MAGIC_NUM 0xFEEDbabe /* Invalid cycle number */
27 #define XLOG_VERSION_1 1
28 #define XLOG_VERSION_2 2 /* Large IClogs, Log sunit */
29 #define XLOG_VERSION_OKBITS (XLOG_VERSION_1 | XLOG_VERSION_2)
30 #define XLOG_MIN_RECORD_BSIZE (16*1024) /* eventually 32k */
31 #define XLOG_BIG_RECORD_BSIZE (32*1024) /* 32k buffers */
32 #define XLOG_MAX_RECORD_BSIZE (256*1024)
33 #define XLOG_HEADER_CYCLE_SIZE (32*1024) /* cycle data in header */
34 #define XLOG_MIN_RECORD_BSHIFT 14 /* 16384 == 1 << 14 */
35 #define XLOG_BIG_RECORD_BSHIFT 15 /* 32k == 1 << 15 */
36 #define XLOG_MAX_RECORD_BSHIFT 18 /* 256k == 1 << 18 */
37 #define XLOG_BTOLSUNIT(log, b) (((b)+(log)->l_mp->m_sb.sb_logsunit-1) / \
38 (log)->l_mp->m_sb.sb_logsunit)
39 #define XLOG_LSUNITTOB(log, su) ((su) * (log)->l_mp->m_sb.sb_logsunit)
40
41 #define XLOG_HEADER_SIZE 512
42
43 /* Minimum number of transactions that must fit in the log (defined by mkfs) */
44 #define XFS_MIN_LOG_FACTOR 3
45
46 #define XLOG_REC_SHIFT(log) \
47 BTOBB(1 << (xfs_sb_version_haslogv2(&log->l_mp->m_sb) ? \
48 XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
49 #define XLOG_TOTAL_REC_SHIFT(log) \
50 BTOBB(XLOG_MAX_ICLOGS << (xfs_sb_version_haslogv2(&log->l_mp->m_sb) ? \
51 XLOG_MAX_RECORD_BSHIFT : XLOG_BIG_RECORD_BSHIFT))
52
53 /* get lsn fields */
54 #define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
55 #define BLOCK_LSN(lsn) ((uint)(lsn))
56
57 /* this is used in a spot where we might otherwise double-endian-flip */
58 #define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])
59
xlog_assign_lsn(uint cycle,uint block)60 static inline xfs_lsn_t xlog_assign_lsn(uint cycle, uint block)
61 {
62 return ((xfs_lsn_t)cycle << 32) | block;
63 }
64
xlog_get_cycle(char * ptr)65 static inline uint xlog_get_cycle(char *ptr)
66 {
67 if (be32_to_cpu(*(__be32 *)ptr) == XLOG_HEADER_MAGIC_NUM)
68 return be32_to_cpu(*((__be32 *)ptr + 1));
69 else
70 return be32_to_cpu(*(__be32 *)ptr);
71 }
72
73 /* Log Clients */
74 #define XFS_TRANSACTION 0x69
75 #define XFS_VOLUME 0x2
76 #define XFS_LOG 0xaa
77
78 #define XLOG_UNMOUNT_TYPE 0x556e /* Un for Unmount */
79
80 /*
81 * Log item for unmount records.
82 *
83 * The unmount record used to have a string "Unmount filesystem--" in the
84 * data section where the "Un" was really a magic number (XLOG_UNMOUNT_TYPE).
85 * We just write the magic number now; see xfs_log_unmount_write.
86 */
87 struct xfs_unmount_log_format {
88 uint16_t magic; /* XLOG_UNMOUNT_TYPE */
89 uint16_t pad1;
90 uint32_t pad2; /* may as well make it 64 bits */
91 };
92
93 /* Region types for iovec's i_type */
94 #define XLOG_REG_TYPE_BFORMAT 1
95 #define XLOG_REG_TYPE_BCHUNK 2
96 #define XLOG_REG_TYPE_EFI_FORMAT 3
97 #define XLOG_REG_TYPE_EFD_FORMAT 4
98 #define XLOG_REG_TYPE_IFORMAT 5
99 #define XLOG_REG_TYPE_ICORE 6
100 #define XLOG_REG_TYPE_IEXT 7
101 #define XLOG_REG_TYPE_IBROOT 8
102 #define XLOG_REG_TYPE_ILOCAL 9
103 #define XLOG_REG_TYPE_IATTR_EXT 10
104 #define XLOG_REG_TYPE_IATTR_BROOT 11
105 #define XLOG_REG_TYPE_IATTR_LOCAL 12
106 #define XLOG_REG_TYPE_QFORMAT 13
107 #define XLOG_REG_TYPE_DQUOT 14
108 #define XLOG_REG_TYPE_QUOTAOFF 15
109 #define XLOG_REG_TYPE_LRHEADER 16
110 #define XLOG_REG_TYPE_UNMOUNT 17
111 #define XLOG_REG_TYPE_COMMIT 18
112 #define XLOG_REG_TYPE_TRANSHDR 19
113 #define XLOG_REG_TYPE_ICREATE 20
114 #define XLOG_REG_TYPE_RUI_FORMAT 21
115 #define XLOG_REG_TYPE_RUD_FORMAT 22
116 #define XLOG_REG_TYPE_CUI_FORMAT 23
117 #define XLOG_REG_TYPE_CUD_FORMAT 24
118 #define XLOG_REG_TYPE_BUI_FORMAT 25
119 #define XLOG_REG_TYPE_BUD_FORMAT 26
120 #define XLOG_REG_TYPE_MAX 26
121
122 /*
123 * Flags to log operation header
124 *
125 * The first write of a new transaction will be preceded with a start
126 * record, XLOG_START_TRANS. Once a transaction is committed, a commit
127 * record is written, XLOG_COMMIT_TRANS. If a single region can not fit into
128 * the remainder of the current active in-core log, it is split up into
129 * multiple regions. Each partial region will be marked with a
130 * XLOG_CONTINUE_TRANS until the last one, which gets marked with XLOG_END_TRANS.
131 *
132 */
133 #define XLOG_START_TRANS 0x01 /* Start a new transaction */
134 #define XLOG_COMMIT_TRANS 0x02 /* Commit this transaction */
135 #define XLOG_CONTINUE_TRANS 0x04 /* Cont this trans into new region */
136 #define XLOG_WAS_CONT_TRANS 0x08 /* Cont this trans into new region */
137 #define XLOG_END_TRANS 0x10 /* End a continued transaction */
138 #define XLOG_UNMOUNT_TRANS 0x20 /* Unmount a filesystem transaction */
139
140
141 typedef struct xlog_op_header {
142 __be32 oh_tid; /* transaction id of operation : 4 b */
143 __be32 oh_len; /* bytes in data region : 4 b */
144 __u8 oh_clientid; /* who sent me this : 1 b */
145 __u8 oh_flags; /* : 1 b */
146 __u16 oh_res2; /* 32 bit align : 2 b */
147 } xlog_op_header_t;
148
149 /* valid values for h_fmt */
150 #define XLOG_FMT_UNKNOWN 0
151 #define XLOG_FMT_LINUX_LE 1
152 #define XLOG_FMT_LINUX_BE 2
153 #define XLOG_FMT_IRIX_BE 3
154
155 /* our fmt */
156 #ifdef XFS_NATIVE_HOST
157 #define XLOG_FMT XLOG_FMT_LINUX_BE
158 #else
159 #define XLOG_FMT XLOG_FMT_LINUX_LE
160 #endif
161
162 typedef struct xlog_rec_header {
163 __be32 h_magicno; /* log record (LR) identifier : 4 */
164 __be32 h_cycle; /* write cycle of log : 4 */
165 __be32 h_version; /* LR version : 4 */
166 __be32 h_len; /* len in bytes; should be 64-bit aligned: 4 */
167 __be64 h_lsn; /* lsn of this LR : 8 */
168 __be64 h_tail_lsn; /* lsn of 1st LR w/ buffers not committed: 8 */
169 __le32 h_crc; /* crc of log record : 4 */
170 __be32 h_prev_block; /* block number to previous LR : 4 */
171 __be32 h_num_logops; /* number of log operations in this LR : 4 */
172 __be32 h_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE];
173 /* new fields */
174 __be32 h_fmt; /* format of log record : 4 */
175 uuid_t h_fs_uuid; /* uuid of FS : 16 */
176 __be32 h_size; /* iclog size : 4 */
177 } xlog_rec_header_t;
178
179 typedef struct xlog_rec_ext_header {
180 __be32 xh_cycle; /* write cycle of log : 4 */
181 __be32 xh_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE]; /* : 256 */
182 } xlog_rec_ext_header_t;
183
184 /*
185 * Quite misnamed, because this union lays out the actual on-disk log buffer.
186 */
187 typedef union xlog_in_core2 {
188 xlog_rec_header_t hic_header;
189 xlog_rec_ext_header_t hic_xheader;
190 char hic_sector[XLOG_HEADER_SIZE];
191 } xlog_in_core_2_t;
192
193 /* not an on-disk structure, but needed by log recovery in userspace */
194 typedef struct xfs_log_iovec {
195 void *i_addr; /* beginning address of region */
196 int i_len; /* length in bytes of region */
197 uint i_type; /* type of region */
198 } xfs_log_iovec_t;
199
200
201 /*
202 * Transaction Header definitions.
203 *
204 * This is the structure written in the log at the head of every transaction. It
205 * identifies the type and id of the transaction, and contains the number of
206 * items logged by the transaction so we know how many to expect during
207 * recovery.
208 *
209 * Do not change the below structure without redoing the code in
210 * xlog_recover_add_to_trans() and xlog_recover_add_to_cont_trans().
211 */
212 typedef struct xfs_trans_header {
213 uint th_magic; /* magic number */
214 uint th_type; /* transaction type */
215 int32_t th_tid; /* transaction id (unused) */
216 uint th_num_items; /* num items logged by trans */
217 } xfs_trans_header_t;
218
219 #define XFS_TRANS_HEADER_MAGIC 0x5452414e /* TRAN */
220
221 /*
222 * The only type valid for th_type in CIL-enabled file system logs:
223 */
224 #define XFS_TRANS_CHECKPOINT 40
225
226 /*
227 * Log item types.
228 */
229 #define XFS_LI_EFI 0x1236
230 #define XFS_LI_EFD 0x1237
231 #define XFS_LI_IUNLINK 0x1238
232 #define XFS_LI_INODE 0x123b /* aligned ino chunks, var-size ibufs */
233 #define XFS_LI_BUF 0x123c /* v2 bufs, variable sized inode bufs */
234 #define XFS_LI_DQUOT 0x123d
235 #define XFS_LI_QUOTAOFF 0x123e
236 #define XFS_LI_ICREATE 0x123f
237 #define XFS_LI_RUI 0x1240 /* rmap update intent */
238 #define XFS_LI_RUD 0x1241
239 #define XFS_LI_CUI 0x1242 /* refcount update intent */
240 #define XFS_LI_CUD 0x1243
241 #define XFS_LI_BUI 0x1244 /* bmbt update intent */
242 #define XFS_LI_BUD 0x1245
243
244 #define XFS_LI_TYPE_DESC \
245 { XFS_LI_EFI, "XFS_LI_EFI" }, \
246 { XFS_LI_EFD, "XFS_LI_EFD" }, \
247 { XFS_LI_IUNLINK, "XFS_LI_IUNLINK" }, \
248 { XFS_LI_INODE, "XFS_LI_INODE" }, \
249 { XFS_LI_BUF, "XFS_LI_BUF" }, \
250 { XFS_LI_DQUOT, "XFS_LI_DQUOT" }, \
251 { XFS_LI_QUOTAOFF, "XFS_LI_QUOTAOFF" }, \
252 { XFS_LI_ICREATE, "XFS_LI_ICREATE" }, \
253 { XFS_LI_RUI, "XFS_LI_RUI" }, \
254 { XFS_LI_RUD, "XFS_LI_RUD" }, \
255 { XFS_LI_CUI, "XFS_LI_CUI" }, \
256 { XFS_LI_CUD, "XFS_LI_CUD" }, \
257 { XFS_LI_BUI, "XFS_LI_BUI" }, \
258 { XFS_LI_BUD, "XFS_LI_BUD" }
259
260 /*
261 * Inode Log Item Format definitions.
262 *
263 * This is the structure used to lay out an inode log item in the
264 * log. The size of the inline data/extents/b-tree root to be logged
265 * (if any) is indicated in the ilf_dsize field. Changes to this structure
266 * must be added on to the end.
267 */
268 struct xfs_inode_log_format {
269 uint16_t ilf_type; /* inode log item type */
270 uint16_t ilf_size; /* size of this item */
271 uint32_t ilf_fields; /* flags for fields logged */
272 uint16_t ilf_asize; /* size of attr d/ext/root */
273 uint16_t ilf_dsize; /* size of data/ext/root */
274 uint32_t ilf_pad; /* pad for 64 bit boundary */
275 uint64_t ilf_ino; /* inode number */
276 union {
277 uint32_t ilfu_rdev; /* rdev value for dev inode*/
278 uint8_t __pad[16]; /* unused */
279 } ilf_u;
280 int64_t ilf_blkno; /* blkno of inode buffer */
281 int32_t ilf_len; /* len of inode buffer */
282 int32_t ilf_boffset; /* off of inode in buffer */
283 };
284
285 /*
286 * Old 32 bit systems will log in this format without the 64 bit
287 * alignment padding. Recovery will detect this and convert it to the
288 * correct format.
289 */
290 struct xfs_inode_log_format_32 {
291 uint16_t ilf_type; /* inode log item type */
292 uint16_t ilf_size; /* size of this item */
293 uint32_t ilf_fields; /* flags for fields logged */
294 uint16_t ilf_asize; /* size of attr d/ext/root */
295 uint16_t ilf_dsize; /* size of data/ext/root */
296 uint64_t ilf_ino; /* inode number */
297 union {
298 uint32_t ilfu_rdev; /* rdev value for dev inode*/
299 uint8_t __pad[16]; /* unused */
300 } ilf_u;
301 int64_t ilf_blkno; /* blkno of inode buffer */
302 int32_t ilf_len; /* len of inode buffer */
303 int32_t ilf_boffset; /* off of inode in buffer */
304 } __attribute__((packed));
305
306
307 /*
308 * Flags for xfs_trans_log_inode flags field.
309 */
310 #define XFS_ILOG_CORE 0x001 /* log standard inode fields */
311 #define XFS_ILOG_DDATA 0x002 /* log i_df.if_data */
312 #define XFS_ILOG_DEXT 0x004 /* log i_df.if_extents */
313 #define XFS_ILOG_DBROOT 0x008 /* log i_df.i_broot */
314 #define XFS_ILOG_DEV 0x010 /* log the dev field */
315 #define XFS_ILOG_UUID 0x020 /* added long ago, but never used */
316 #define XFS_ILOG_ADATA 0x040 /* log i_af.if_data */
317 #define XFS_ILOG_AEXT 0x080 /* log i_af.if_extents */
318 #define XFS_ILOG_ABROOT 0x100 /* log i_af.i_broot */
319 #define XFS_ILOG_DOWNER 0x200 /* change the data fork owner on replay */
320 #define XFS_ILOG_AOWNER 0x400 /* change the attr fork owner on replay */
321
322
323 /*
324 * The timestamps are dirty, but not necessarily anything else in the inode
325 * core. Unlike the other fields above this one must never make it to disk
326 * in the ilf_fields of the inode_log_format, but is purely store in-memory in
327 * ili_fields in the inode_log_item.
328 */
329 #define XFS_ILOG_TIMESTAMP 0x4000
330
331 #define XFS_ILOG_NONCORE (XFS_ILOG_DDATA | XFS_ILOG_DEXT | \
332 XFS_ILOG_DBROOT | XFS_ILOG_DEV | \
333 XFS_ILOG_ADATA | XFS_ILOG_AEXT | \
334 XFS_ILOG_ABROOT | XFS_ILOG_DOWNER | \
335 XFS_ILOG_AOWNER)
336
337 #define XFS_ILOG_DFORK (XFS_ILOG_DDATA | XFS_ILOG_DEXT | \
338 XFS_ILOG_DBROOT)
339
340 #define XFS_ILOG_AFORK (XFS_ILOG_ADATA | XFS_ILOG_AEXT | \
341 XFS_ILOG_ABROOT)
342
343 #define XFS_ILOG_ALL (XFS_ILOG_CORE | XFS_ILOG_DDATA | \
344 XFS_ILOG_DEXT | XFS_ILOG_DBROOT | \
345 XFS_ILOG_DEV | XFS_ILOG_ADATA | \
346 XFS_ILOG_AEXT | XFS_ILOG_ABROOT | \
347 XFS_ILOG_TIMESTAMP | XFS_ILOG_DOWNER | \
348 XFS_ILOG_AOWNER)
349
xfs_ilog_fbroot(int w)350 static inline int xfs_ilog_fbroot(int w)
351 {
352 return (w == XFS_DATA_FORK ? XFS_ILOG_DBROOT : XFS_ILOG_ABROOT);
353 }
354
xfs_ilog_fext(int w)355 static inline int xfs_ilog_fext(int w)
356 {
357 return (w == XFS_DATA_FORK ? XFS_ILOG_DEXT : XFS_ILOG_AEXT);
358 }
359
xfs_ilog_fdata(int w)360 static inline int xfs_ilog_fdata(int w)
361 {
362 return (w == XFS_DATA_FORK ? XFS_ILOG_DDATA : XFS_ILOG_ADATA);
363 }
364
365 /*
366 * Incore version of the on-disk inode core structures. We log this directly
367 * into the journal in host CPU format (for better or worse) and as such
368 * directly mirrors the xfs_dinode structure as it must contain all the same
369 * information.
370 */
371 typedef uint64_t xfs_ictimestamp_t;
372
373 /* Legacy timestamp encoding format. */
374 struct xfs_legacy_ictimestamp {
375 int32_t t_sec; /* timestamp seconds */
376 int32_t t_nsec; /* timestamp nanoseconds */
377 };
378
379 /*
380 * Define the format of the inode core that is logged. This structure must be
381 * kept identical to struct xfs_dinode except for the endianness annotations.
382 */
383 struct xfs_log_dinode {
384 uint16_t di_magic; /* inode magic # = XFS_DINODE_MAGIC */
385 uint16_t di_mode; /* mode and type of file */
386 int8_t di_version; /* inode version */
387 int8_t di_format; /* format of di_c data */
388 uint8_t di_pad3[2]; /* unused in v2/3 inodes */
389 uint32_t di_uid; /* owner's user id */
390 uint32_t di_gid; /* owner's group id */
391 uint32_t di_nlink; /* number of links to file */
392 uint16_t di_projid_lo; /* lower part of owner's project id */
393 uint16_t di_projid_hi; /* higher part of owner's project id */
394 uint8_t di_pad[6]; /* unused, zeroed space */
395 uint16_t di_flushiter; /* incremented on flush */
396 xfs_ictimestamp_t di_atime; /* time last accessed */
397 xfs_ictimestamp_t di_mtime; /* time last modified */
398 xfs_ictimestamp_t di_ctime; /* time created/inode modified */
399 xfs_fsize_t di_size; /* number of bytes in file */
400 xfs_rfsblock_t di_nblocks; /* # of direct & btree blocks used */
401 xfs_extlen_t di_extsize; /* basic/minimum extent size for file */
402 xfs_extnum_t di_nextents; /* number of extents in data fork */
403 xfs_aextnum_t di_anextents; /* number of extents in attribute fork*/
404 uint8_t di_forkoff; /* attr fork offs, <<3 for 64b align */
405 int8_t di_aformat; /* format of attr fork's data */
406 uint32_t di_dmevmask; /* DMIG event mask */
407 uint16_t di_dmstate; /* DMIG state info */
408 uint16_t di_flags; /* random flags, XFS_DIFLAG_... */
409 uint32_t di_gen; /* generation number */
410
411 /* di_next_unlinked is the only non-core field in the old dinode */
412 xfs_agino_t di_next_unlinked;/* agi unlinked list ptr */
413
414 /* start of the extended dinode, writable fields */
415 uint32_t di_crc; /* CRC of the inode */
416 uint64_t di_changecount; /* number of attribute changes */
417 xfs_lsn_t di_lsn; /* flush sequence */
418 uint64_t di_flags2; /* more random flags */
419 uint32_t di_cowextsize; /* basic cow extent size for file */
420 uint8_t di_pad2[12]; /* more padding for future expansion */
421
422 /* fields only written to during inode creation */
423 xfs_ictimestamp_t di_crtime; /* time created */
424 xfs_ino_t di_ino; /* inode number */
425 uuid_t di_uuid; /* UUID of the filesystem */
426
427 /* structure must be padded to 64 bit alignment */
428 };
429
430 #define xfs_log_dinode_size(mp) \
431 (xfs_sb_version_has_v3inode(&(mp)->m_sb) ? \
432 sizeof(struct xfs_log_dinode) : \
433 offsetof(struct xfs_log_dinode, di_next_unlinked))
434
435 /*
436 * Buffer Log Format definitions
437 *
438 * These are the physical dirty bitmap definitions for the log format structure.
439 */
440 #define XFS_BLF_CHUNK 128
441 #define XFS_BLF_SHIFT 7
442 #define BIT_TO_WORD_SHIFT 5
443 #define NBWORD (NBBY * sizeof(unsigned int))
444
445 /*
446 * This flag indicates that the buffer contains on disk inodes
447 * and requires special recovery handling.
448 */
449 #define XFS_BLF_INODE_BUF (1<<0)
450
451 /*
452 * This flag indicates that the buffer should not be replayed
453 * during recovery because its blocks are being freed.
454 */
455 #define XFS_BLF_CANCEL (1<<1)
456
457 /*
458 * This flag indicates that the buffer contains on disk
459 * user or group dquots and may require special recovery handling.
460 */
461 #define XFS_BLF_UDQUOT_BUF (1<<2)
462 #define XFS_BLF_PDQUOT_BUF (1<<3)
463 #define XFS_BLF_GDQUOT_BUF (1<<4)
464
465 /*
466 * This is the structure used to lay out a buf log item in the log. The data
467 * map describes which 128 byte chunks of the buffer have been logged.
468 *
469 * The placement of blf_map_size causes blf_data_map to start at an odd
470 * multiple of sizeof(unsigned int) offset within the struct. Because the data
471 * bitmap size will always be an even number, the end of the data_map (and
472 * therefore the structure) will also be at an odd multiple of sizeof(unsigned
473 * int). Some 64-bit compilers will insert padding at the end of the struct to
474 * ensure 64-bit alignment of blf_blkno, but 32-bit ones will not. Therefore,
475 * XFS_BLF_DATAMAP_SIZE must be an odd number to make the padding explicit and
476 * keep the structure size consistent between 32-bit and 64-bit platforms.
477 */
478 #define __XFS_BLF_DATAMAP_SIZE ((XFS_MAX_BLOCKSIZE / XFS_BLF_CHUNK) / NBWORD)
479 #define XFS_BLF_DATAMAP_SIZE (__XFS_BLF_DATAMAP_SIZE + 1)
480
481 typedef struct xfs_buf_log_format {
482 unsigned short blf_type; /* buf log item type indicator */
483 unsigned short blf_size; /* size of this item */
484 unsigned short blf_flags; /* misc state */
485 unsigned short blf_len; /* number of blocks in this buf */
486 int64_t blf_blkno; /* starting blkno of this buf */
487 unsigned int blf_map_size; /* used size of data bitmap in words */
488 unsigned int blf_data_map[XFS_BLF_DATAMAP_SIZE]; /* dirty bitmap */
489 } xfs_buf_log_format_t;
490
491 /*
492 * All buffers now need to tell recovery where the magic number
493 * is so that it can verify and calculate the CRCs on the buffer correctly
494 * once the changes have been replayed into the buffer.
495 *
496 * The type value is held in the upper 5 bits of the blf_flags field, which is
497 * an unsigned 16 bit field. Hence we need to shift it 11 bits up and down.
498 */
499 #define XFS_BLFT_BITS 5
500 #define XFS_BLFT_SHIFT 11
501 #define XFS_BLFT_MASK (((1 << XFS_BLFT_BITS) - 1) << XFS_BLFT_SHIFT)
502
503 enum xfs_blft {
504 XFS_BLFT_UNKNOWN_BUF = 0,
505 XFS_BLFT_UDQUOT_BUF,
506 XFS_BLFT_PDQUOT_BUF,
507 XFS_BLFT_GDQUOT_BUF,
508 XFS_BLFT_BTREE_BUF,
509 XFS_BLFT_AGF_BUF,
510 XFS_BLFT_AGFL_BUF,
511 XFS_BLFT_AGI_BUF,
512 XFS_BLFT_DINO_BUF,
513 XFS_BLFT_SYMLINK_BUF,
514 XFS_BLFT_DIR_BLOCK_BUF,
515 XFS_BLFT_DIR_DATA_BUF,
516 XFS_BLFT_DIR_FREE_BUF,
517 XFS_BLFT_DIR_LEAF1_BUF,
518 XFS_BLFT_DIR_LEAFN_BUF,
519 XFS_BLFT_DA_NODE_BUF,
520 XFS_BLFT_ATTR_LEAF_BUF,
521 XFS_BLFT_ATTR_RMT_BUF,
522 XFS_BLFT_SB_BUF,
523 XFS_BLFT_RTBITMAP_BUF,
524 XFS_BLFT_RTSUMMARY_BUF,
525 XFS_BLFT_MAX_BUF = (1 << XFS_BLFT_BITS),
526 };
527
528 static inline void
xfs_blft_to_flags(struct xfs_buf_log_format * blf,enum xfs_blft type)529 xfs_blft_to_flags(struct xfs_buf_log_format *blf, enum xfs_blft type)
530 {
531 ASSERT(type > XFS_BLFT_UNKNOWN_BUF && type < XFS_BLFT_MAX_BUF);
532 blf->blf_flags &= ~XFS_BLFT_MASK;
533 blf->blf_flags |= ((type << XFS_BLFT_SHIFT) & XFS_BLFT_MASK);
534 }
535
536 static inline uint16_t
xfs_blft_from_flags(struct xfs_buf_log_format * blf)537 xfs_blft_from_flags(struct xfs_buf_log_format *blf)
538 {
539 return (blf->blf_flags & XFS_BLFT_MASK) >> XFS_BLFT_SHIFT;
540 }
541
542 /*
543 * EFI/EFD log format definitions
544 */
545 typedef struct xfs_extent {
546 xfs_fsblock_t ext_start;
547 xfs_extlen_t ext_len;
548 } xfs_extent_t;
549
550 /*
551 * Since an xfs_extent_t has types (start:64, len: 32)
552 * there are different alignments on 32 bit and 64 bit kernels.
553 * So we provide the different variants for use by a
554 * conversion routine.
555 */
556 typedef struct xfs_extent_32 {
557 uint64_t ext_start;
558 uint32_t ext_len;
559 } __attribute__((packed)) xfs_extent_32_t;
560
561 typedef struct xfs_extent_64 {
562 uint64_t ext_start;
563 uint32_t ext_len;
564 uint32_t ext_pad;
565 } xfs_extent_64_t;
566
567 /*
568 * This is the structure used to lay out an efi log item in the
569 * log. The efi_extents field is a variable size array whose
570 * size is given by efi_nextents.
571 */
572 typedef struct xfs_efi_log_format {
573 uint16_t efi_type; /* efi log item type */
574 uint16_t efi_size; /* size of this item */
575 uint32_t efi_nextents; /* # extents to free */
576 uint64_t efi_id; /* efi identifier */
577 xfs_extent_t efi_extents[1]; /* array of extents to free */
578 } xfs_efi_log_format_t;
579
580 typedef struct xfs_efi_log_format_32 {
581 uint16_t efi_type; /* efi log item type */
582 uint16_t efi_size; /* size of this item */
583 uint32_t efi_nextents; /* # extents to free */
584 uint64_t efi_id; /* efi identifier */
585 xfs_extent_32_t efi_extents[1]; /* array of extents to free */
586 } __attribute__((packed)) xfs_efi_log_format_32_t;
587
588 typedef struct xfs_efi_log_format_64 {
589 uint16_t efi_type; /* efi log item type */
590 uint16_t efi_size; /* size of this item */
591 uint32_t efi_nextents; /* # extents to free */
592 uint64_t efi_id; /* efi identifier */
593 xfs_extent_64_t efi_extents[1]; /* array of extents to free */
594 } xfs_efi_log_format_64_t;
595
596 /*
597 * This is the structure used to lay out an efd log item in the
598 * log. The efd_extents array is a variable size array whose
599 * size is given by efd_nextents;
600 */
601 typedef struct xfs_efd_log_format {
602 uint16_t efd_type; /* efd log item type */
603 uint16_t efd_size; /* size of this item */
604 uint32_t efd_nextents; /* # of extents freed */
605 uint64_t efd_efi_id; /* id of corresponding efi */
606 xfs_extent_t efd_extents[1]; /* array of extents freed */
607 } xfs_efd_log_format_t;
608
609 typedef struct xfs_efd_log_format_32 {
610 uint16_t efd_type; /* efd log item type */
611 uint16_t efd_size; /* size of this item */
612 uint32_t efd_nextents; /* # of extents freed */
613 uint64_t efd_efi_id; /* id of corresponding efi */
614 xfs_extent_32_t efd_extents[1]; /* array of extents freed */
615 } __attribute__((packed)) xfs_efd_log_format_32_t;
616
617 typedef struct xfs_efd_log_format_64 {
618 uint16_t efd_type; /* efd log item type */
619 uint16_t efd_size; /* size of this item */
620 uint32_t efd_nextents; /* # of extents freed */
621 uint64_t efd_efi_id; /* id of corresponding efi */
622 xfs_extent_64_t efd_extents[1]; /* array of extents freed */
623 } xfs_efd_log_format_64_t;
624
625 /*
626 * RUI/RUD (reverse mapping) log format definitions
627 */
628 struct xfs_map_extent {
629 uint64_t me_owner;
630 uint64_t me_startblock;
631 uint64_t me_startoff;
632 uint32_t me_len;
633 uint32_t me_flags;
634 };
635
636 /* rmap me_flags: upper bits are flags, lower byte is type code */
637 #define XFS_RMAP_EXTENT_MAP 1
638 #define XFS_RMAP_EXTENT_MAP_SHARED 2
639 #define XFS_RMAP_EXTENT_UNMAP 3
640 #define XFS_RMAP_EXTENT_UNMAP_SHARED 4
641 #define XFS_RMAP_EXTENT_CONVERT 5
642 #define XFS_RMAP_EXTENT_CONVERT_SHARED 6
643 #define XFS_RMAP_EXTENT_ALLOC 7
644 #define XFS_RMAP_EXTENT_FREE 8
645 #define XFS_RMAP_EXTENT_TYPE_MASK 0xFF
646
647 #define XFS_RMAP_EXTENT_ATTR_FORK (1U << 31)
648 #define XFS_RMAP_EXTENT_BMBT_BLOCK (1U << 30)
649 #define XFS_RMAP_EXTENT_UNWRITTEN (1U << 29)
650
651 #define XFS_RMAP_EXTENT_FLAGS (XFS_RMAP_EXTENT_TYPE_MASK | \
652 XFS_RMAP_EXTENT_ATTR_FORK | \
653 XFS_RMAP_EXTENT_BMBT_BLOCK | \
654 XFS_RMAP_EXTENT_UNWRITTEN)
655
656 /*
657 * This is the structure used to lay out an rui log item in the
658 * log. The rui_extents field is a variable size array whose
659 * size is given by rui_nextents.
660 */
661 struct xfs_rui_log_format {
662 uint16_t rui_type; /* rui log item type */
663 uint16_t rui_size; /* size of this item */
664 uint32_t rui_nextents; /* # extents to free */
665 uint64_t rui_id; /* rui identifier */
666 struct xfs_map_extent rui_extents[]; /* array of extents to rmap */
667 };
668
669 static inline size_t
xfs_rui_log_format_sizeof(unsigned int nr)670 xfs_rui_log_format_sizeof(
671 unsigned int nr)
672 {
673 return sizeof(struct xfs_rui_log_format) +
674 nr * sizeof(struct xfs_map_extent);
675 }
676
677 /*
678 * This is the structure used to lay out an rud log item in the
679 * log. The rud_extents array is a variable size array whose
680 * size is given by rud_nextents;
681 */
682 struct xfs_rud_log_format {
683 uint16_t rud_type; /* rud log item type */
684 uint16_t rud_size; /* size of this item */
685 uint32_t __pad;
686 uint64_t rud_rui_id; /* id of corresponding rui */
687 };
688
689 /*
690 * CUI/CUD (refcount update) log format definitions
691 */
692 struct xfs_phys_extent {
693 uint64_t pe_startblock;
694 uint32_t pe_len;
695 uint32_t pe_flags;
696 };
697
698 /* refcount pe_flags: upper bits are flags, lower byte is type code */
699 /* Type codes are taken directly from enum xfs_refcount_intent_type. */
700 #define XFS_REFCOUNT_EXTENT_TYPE_MASK 0xFF
701
702 #define XFS_REFCOUNT_EXTENT_FLAGS (XFS_REFCOUNT_EXTENT_TYPE_MASK)
703
704 /*
705 * This is the structure used to lay out a cui log item in the
706 * log. The cui_extents field is a variable size array whose
707 * size is given by cui_nextents.
708 */
709 struct xfs_cui_log_format {
710 uint16_t cui_type; /* cui log item type */
711 uint16_t cui_size; /* size of this item */
712 uint32_t cui_nextents; /* # extents to free */
713 uint64_t cui_id; /* cui identifier */
714 struct xfs_phys_extent cui_extents[]; /* array of extents */
715 };
716
717 static inline size_t
xfs_cui_log_format_sizeof(unsigned int nr)718 xfs_cui_log_format_sizeof(
719 unsigned int nr)
720 {
721 return sizeof(struct xfs_cui_log_format) +
722 nr * sizeof(struct xfs_phys_extent);
723 }
724
725 /*
726 * This is the structure used to lay out a cud log item in the
727 * log. The cud_extents array is a variable size array whose
728 * size is given by cud_nextents;
729 */
730 struct xfs_cud_log_format {
731 uint16_t cud_type; /* cud log item type */
732 uint16_t cud_size; /* size of this item */
733 uint32_t __pad;
734 uint64_t cud_cui_id; /* id of corresponding cui */
735 };
736
737 /*
738 * BUI/BUD (inode block mapping) log format definitions
739 */
740
741 /* bmbt me_flags: upper bits are flags, lower byte is type code */
742 /* Type codes are taken directly from enum xfs_bmap_intent_type. */
743 #define XFS_BMAP_EXTENT_TYPE_MASK 0xFF
744
745 #define XFS_BMAP_EXTENT_ATTR_FORK (1U << 31)
746 #define XFS_BMAP_EXTENT_UNWRITTEN (1U << 30)
747
748 #define XFS_BMAP_EXTENT_FLAGS (XFS_BMAP_EXTENT_TYPE_MASK | \
749 XFS_BMAP_EXTENT_ATTR_FORK | \
750 XFS_BMAP_EXTENT_UNWRITTEN)
751
752 /*
753 * This is the structure used to lay out an bui log item in the
754 * log. The bui_extents field is a variable size array whose
755 * size is given by bui_nextents.
756 */
757 struct xfs_bui_log_format {
758 uint16_t bui_type; /* bui log item type */
759 uint16_t bui_size; /* size of this item */
760 uint32_t bui_nextents; /* # extents to free */
761 uint64_t bui_id; /* bui identifier */
762 struct xfs_map_extent bui_extents[]; /* array of extents to bmap */
763 };
764
765 static inline size_t
xfs_bui_log_format_sizeof(unsigned int nr)766 xfs_bui_log_format_sizeof(
767 unsigned int nr)
768 {
769 return sizeof(struct xfs_bui_log_format) +
770 nr * sizeof(struct xfs_map_extent);
771 }
772
773 /*
774 * This is the structure used to lay out an bud log item in the
775 * log. The bud_extents array is a variable size array whose
776 * size is given by bud_nextents;
777 */
778 struct xfs_bud_log_format {
779 uint16_t bud_type; /* bud log item type */
780 uint16_t bud_size; /* size of this item */
781 uint32_t __pad;
782 uint64_t bud_bui_id; /* id of corresponding bui */
783 };
784
785 /*
786 * Dquot Log format definitions.
787 *
788 * The first two fields must be the type and size fitting into
789 * 32 bits : log_recovery code assumes that.
790 */
791 typedef struct xfs_dq_logformat {
792 uint16_t qlf_type; /* dquot log item type */
793 uint16_t qlf_size; /* size of this item */
794 xfs_dqid_t qlf_id; /* usr/grp/proj id : 32 bits */
795 int64_t qlf_blkno; /* blkno of dquot buffer */
796 int32_t qlf_len; /* len of dquot buffer */
797 uint32_t qlf_boffset; /* off of dquot in buffer */
798 } xfs_dq_logformat_t;
799
800 /*
801 * log format struct for QUOTAOFF records.
802 * The first two fields must be the type and size fitting into
803 * 32 bits : log_recovery code assumes that.
804 * We write two LI_QUOTAOFF logitems per quotaoff, the last one keeps a pointer
805 * to the first and ensures that the first logitem is taken out of the AIL
806 * only when the last one is securely committed.
807 */
808 typedef struct xfs_qoff_logformat {
809 unsigned short qf_type; /* quotaoff log item type */
810 unsigned short qf_size; /* size of this item */
811 unsigned int qf_flags; /* USR and/or GRP */
812 char qf_pad[12]; /* padding for future */
813 } xfs_qoff_logformat_t;
814
815 /*
816 * Disk quotas status in m_qflags, and also sb_qflags. 16 bits.
817 */
818 #define XFS_UQUOTA_ACCT 0x0001 /* user quota accounting ON */
819 #define XFS_UQUOTA_ENFD 0x0002 /* user quota limits enforced */
820 #define XFS_UQUOTA_CHKD 0x0004 /* quotacheck run on usr quotas */
821 #define XFS_PQUOTA_ACCT 0x0008 /* project quota accounting ON */
822 #define XFS_OQUOTA_ENFD 0x0010 /* other (grp/prj) quota limits enforced */
823 #define XFS_OQUOTA_CHKD 0x0020 /* quotacheck run on other (grp/prj) quotas */
824 #define XFS_GQUOTA_ACCT 0x0040 /* group quota accounting ON */
825
826 /*
827 * Conversion to and from the combined OQUOTA flag (if necessary)
828 * is done only in xfs_sb_qflags_to_disk() and xfs_sb_qflags_from_disk()
829 */
830 #define XFS_GQUOTA_ENFD 0x0080 /* group quota limits enforced */
831 #define XFS_GQUOTA_CHKD 0x0100 /* quotacheck run on group quotas */
832 #define XFS_PQUOTA_ENFD 0x0200 /* project quota limits enforced */
833 #define XFS_PQUOTA_CHKD 0x0400 /* quotacheck run on project quotas */
834
835 #define XFS_ALL_QUOTA_ACCT \
836 (XFS_UQUOTA_ACCT | XFS_GQUOTA_ACCT | XFS_PQUOTA_ACCT)
837 #define XFS_ALL_QUOTA_ENFD \
838 (XFS_UQUOTA_ENFD | XFS_GQUOTA_ENFD | XFS_PQUOTA_ENFD)
839 #define XFS_ALL_QUOTA_CHKD \
840 (XFS_UQUOTA_CHKD | XFS_GQUOTA_CHKD | XFS_PQUOTA_CHKD)
841
842 #define XFS_MOUNT_QUOTA_ALL (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
843 XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\
844 XFS_GQUOTA_ENFD|XFS_GQUOTA_CHKD|\
845 XFS_PQUOTA_ACCT|XFS_PQUOTA_ENFD|\
846 XFS_PQUOTA_CHKD)
847
848 /*
849 * Inode create log item structure
850 *
851 * Log recovery assumes the first two entries are the type and size and they fit
852 * in 32 bits. Also in host order (ugh) so they have to be 32 bit aligned so
853 * decoding can be done correctly.
854 */
855 struct xfs_icreate_log {
856 uint16_t icl_type; /* type of log format structure */
857 uint16_t icl_size; /* size of log format structure */
858 __be32 icl_ag; /* ag being allocated in */
859 __be32 icl_agbno; /* start block of inode range */
860 __be32 icl_count; /* number of inodes to initialise */
861 __be32 icl_isize; /* size of inodes */
862 __be32 icl_length; /* length of extent to initialise */
863 __be32 icl_gen; /* inode generation number to use */
864 };
865
866 #endif /* __XFS_LOG_FORMAT_H__ */
867