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