Dave Chinner | fc06c6d | 2013-08-12 20:49:22 +1000 | [diff] [blame] | 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 | |
Jie Liu | e773fc9 | 2013-08-12 20:50:01 +1000 | [diff] [blame] | 21 | struct xfs_mount; |
Jie Liu | 5a96a94 | 2013-08-12 20:50:02 +1000 | [diff] [blame] | 22 | struct xfs_trans_res; |
Jie Liu | e773fc9 | 2013-08-12 20:50:01 +1000 | [diff] [blame] | 23 | |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 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 | */ |
Dave Chinner | fc06c6d | 2013-08-12 20:49:22 +1000 | [diff] [blame] | 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 | |
Jie Liu | 5a96a94 | 2013-08-12 20:50:02 +1000 | [diff] [blame] | 55 | /* Minimum number of transactions that must fit in the log (defined by mkfs) */ |
| 56 | #define XFS_MIN_LOG_FACTOR 3 |
| 57 | |
Dave Chinner | fc06c6d | 2013-08-12 20:49:22 +1000 | [diff] [blame] | 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 | |
| 72 | static inline xfs_lsn_t xlog_assign_lsn(uint cycle, uint block) |
| 73 | { |
| 74 | return ((xfs_lsn_t)cycle << 32) | block; |
| 75 | } |
| 76 | |
| 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_MAX 20 |
| 114 | |
| 115 | /* |
| 116 | * Flags to log operation header |
| 117 | * |
| 118 | * The first write of a new transaction will be preceded with a start |
| 119 | * record, XLOG_START_TRANS. Once a transaction is committed, a commit |
| 120 | * record is written, XLOG_COMMIT_TRANS. If a single region can not fit into |
| 121 | * the remainder of the current active in-core log, it is split up into |
| 122 | * multiple regions. Each partial region will be marked with a |
| 123 | * XLOG_CONTINUE_TRANS until the last one, which gets marked with XLOG_END_TRANS. |
| 124 | * |
| 125 | */ |
| 126 | #define XLOG_START_TRANS 0x01 /* Start a new transaction */ |
| 127 | #define XLOG_COMMIT_TRANS 0x02 /* Commit this transaction */ |
| 128 | #define XLOG_CONTINUE_TRANS 0x04 /* Cont this trans into new region */ |
| 129 | #define XLOG_WAS_CONT_TRANS 0x08 /* Cont this trans into new region */ |
| 130 | #define XLOG_END_TRANS 0x10 /* End a continued transaction */ |
| 131 | #define XLOG_UNMOUNT_TRANS 0x20 /* Unmount a filesystem transaction */ |
| 132 | |
| 133 | |
| 134 | typedef struct xlog_op_header { |
| 135 | __be32 oh_tid; /* transaction id of operation : 4 b */ |
| 136 | __be32 oh_len; /* bytes in data region : 4 b */ |
| 137 | __u8 oh_clientid; /* who sent me this : 1 b */ |
| 138 | __u8 oh_flags; /* : 1 b */ |
| 139 | __u16 oh_res2; /* 32 bit align : 2 b */ |
| 140 | } xlog_op_header_t; |
| 141 | |
Dave Chinner | fc06c6d | 2013-08-12 20:49:22 +1000 | [diff] [blame] | 142 | /* valid values for h_fmt */ |
| 143 | #define XLOG_FMT_UNKNOWN 0 |
| 144 | #define XLOG_FMT_LINUX_LE 1 |
| 145 | #define XLOG_FMT_LINUX_BE 2 |
| 146 | #define XLOG_FMT_IRIX_BE 3 |
| 147 | |
| 148 | /* our fmt */ |
| 149 | #ifdef XFS_NATIVE_HOST |
| 150 | #define XLOG_FMT XLOG_FMT_LINUX_BE |
| 151 | #else |
| 152 | #define XLOG_FMT XLOG_FMT_LINUX_LE |
| 153 | #endif |
| 154 | |
| 155 | typedef struct xlog_rec_header { |
| 156 | __be32 h_magicno; /* log record (LR) identifier : 4 */ |
| 157 | __be32 h_cycle; /* write cycle of log : 4 */ |
| 158 | __be32 h_version; /* LR version : 4 */ |
| 159 | __be32 h_len; /* len in bytes; should be 64-bit aligned: 4 */ |
| 160 | __be64 h_lsn; /* lsn of this LR : 8 */ |
| 161 | __be64 h_tail_lsn; /* lsn of 1st LR w/ buffers not committed: 8 */ |
| 162 | __le32 h_crc; /* crc of log record : 4 */ |
| 163 | __be32 h_prev_block; /* block number to previous LR : 4 */ |
| 164 | __be32 h_num_logops; /* number of log operations in this LR : 4 */ |
| 165 | __be32 h_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE]; |
| 166 | /* new fields */ |
| 167 | __be32 h_fmt; /* format of log record : 4 */ |
| 168 | uuid_t h_fs_uuid; /* uuid of FS : 16 */ |
| 169 | __be32 h_size; /* iclog size : 4 */ |
| 170 | } xlog_rec_header_t; |
| 171 | |
| 172 | typedef struct xlog_rec_ext_header { |
| 173 | __be32 xh_cycle; /* write cycle of log : 4 */ |
| 174 | __be32 xh_cycle_data[XLOG_HEADER_CYCLE_SIZE / BBSIZE]; /* : 256 */ |
| 175 | } xlog_rec_ext_header_t; |
| 176 | |
| 177 | /* |
| 178 | * Quite misnamed, because this union lays out the actual on-disk log buffer. |
| 179 | */ |
| 180 | typedef union xlog_in_core2 { |
| 181 | xlog_rec_header_t hic_header; |
| 182 | xlog_rec_ext_header_t hic_xheader; |
| 183 | char hic_sector[XLOG_HEADER_SIZE]; |
| 184 | } xlog_in_core_2_t; |
| 185 | |
| 186 | /* not an on-disk structure, but needed by log recovery in userspace */ |
| 187 | typedef struct xfs_log_iovec { |
| 188 | void *i_addr; /* beginning address of region */ |
| 189 | int i_len; /* length in bytes of region */ |
| 190 | uint i_type; /* type of region */ |
| 191 | } xfs_log_iovec_t; |
| 192 | |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 193 | |
| 194 | /* |
Dave Chinner | 2a3c0ac | 2013-08-12 20:49:28 +1000 | [diff] [blame] | 195 | * Transaction Header definitions. |
| 196 | * |
| 197 | * This is the structure written in the log at the head of every transaction. It |
| 198 | * identifies the type and id of the transaction, and contains the number of |
| 199 | * items logged by the transaction so we know how many to expect during |
| 200 | * recovery. |
| 201 | * |
| 202 | * Do not change the below structure without redoing the code in |
| 203 | * xlog_recover_add_to_trans() and xlog_recover_add_to_cont_trans(). |
| 204 | */ |
| 205 | typedef struct xfs_trans_header { |
| 206 | uint th_magic; /* magic number */ |
| 207 | uint th_type; /* transaction type */ |
| 208 | __int32_t th_tid; /* transaction id (unused) */ |
| 209 | uint th_num_items; /* num items logged by trans */ |
| 210 | } xfs_trans_header_t; |
| 211 | |
| 212 | #define XFS_TRANS_HEADER_MAGIC 0x5452414e /* TRAN */ |
| 213 | |
| 214 | /* |
| 215 | * Log item types. |
| 216 | */ |
| 217 | #define XFS_LI_EFI 0x1236 |
| 218 | #define XFS_LI_EFD 0x1237 |
| 219 | #define XFS_LI_IUNLINK 0x1238 |
| 220 | #define XFS_LI_INODE 0x123b /* aligned ino chunks, var-size ibufs */ |
| 221 | #define XFS_LI_BUF 0x123c /* v2 bufs, variable sized inode bufs */ |
| 222 | #define XFS_LI_DQUOT 0x123d |
| 223 | #define XFS_LI_QUOTAOFF 0x123e |
| 224 | #define XFS_LI_ICREATE 0x123f |
| 225 | |
| 226 | #define XFS_LI_TYPE_DESC \ |
| 227 | { XFS_LI_EFI, "XFS_LI_EFI" }, \ |
| 228 | { XFS_LI_EFD, "XFS_LI_EFD" }, \ |
| 229 | { XFS_LI_IUNLINK, "XFS_LI_IUNLINK" }, \ |
| 230 | { XFS_LI_INODE, "XFS_LI_INODE" }, \ |
| 231 | { XFS_LI_BUF, "XFS_LI_BUF" }, \ |
| 232 | { XFS_LI_DQUOT, "XFS_LI_DQUOT" }, \ |
| 233 | { XFS_LI_QUOTAOFF, "XFS_LI_QUOTAOFF" }, \ |
| 234 | { XFS_LI_ICREATE, "XFS_LI_ICREATE" } |
| 235 | |
| 236 | /* |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 237 | * Inode Log Item Format definitions. |
| 238 | * |
| 239 | * This is the structure used to lay out an inode log item in the |
| 240 | * log. The size of the inline data/extents/b-tree root to be logged |
| 241 | * (if any) is indicated in the ilf_dsize field. Changes to this structure |
| 242 | * must be added on to the end. |
| 243 | */ |
| 244 | typedef struct xfs_inode_log_format { |
| 245 | __uint16_t ilf_type; /* inode log item type */ |
| 246 | __uint16_t ilf_size; /* size of this item */ |
| 247 | __uint32_t ilf_fields; /* flags for fields logged */ |
| 248 | __uint16_t ilf_asize; /* size of attr d/ext/root */ |
| 249 | __uint16_t ilf_dsize; /* size of data/ext/root */ |
| 250 | __uint64_t ilf_ino; /* inode number */ |
| 251 | union { |
| 252 | __uint32_t ilfu_rdev; /* rdev value for dev inode*/ |
| 253 | uuid_t ilfu_uuid; /* mount point value */ |
| 254 | } ilf_u; |
| 255 | __int64_t ilf_blkno; /* blkno of inode buffer */ |
| 256 | __int32_t ilf_len; /* len of inode buffer */ |
| 257 | __int32_t ilf_boffset; /* off of inode in buffer */ |
| 258 | } xfs_inode_log_format_t; |
| 259 | |
| 260 | typedef struct xfs_inode_log_format_32 { |
| 261 | __uint16_t ilf_type; /* inode log item type */ |
| 262 | __uint16_t ilf_size; /* size of this item */ |
| 263 | __uint32_t ilf_fields; /* flags for fields logged */ |
| 264 | __uint16_t ilf_asize; /* size of attr d/ext/root */ |
| 265 | __uint16_t ilf_dsize; /* size of data/ext/root */ |
| 266 | __uint64_t ilf_ino; /* inode number */ |
| 267 | union { |
| 268 | __uint32_t ilfu_rdev; /* rdev value for dev inode*/ |
| 269 | uuid_t ilfu_uuid; /* mount point value */ |
| 270 | } ilf_u; |
| 271 | __int64_t ilf_blkno; /* blkno of inode buffer */ |
| 272 | __int32_t ilf_len; /* len of inode buffer */ |
| 273 | __int32_t ilf_boffset; /* off of inode in buffer */ |
| 274 | } __attribute__((packed)) xfs_inode_log_format_32_t; |
| 275 | |
| 276 | typedef struct xfs_inode_log_format_64 { |
| 277 | __uint16_t ilf_type; /* inode log item type */ |
| 278 | __uint16_t ilf_size; /* size of this item */ |
| 279 | __uint32_t ilf_fields; /* flags for fields logged */ |
| 280 | __uint16_t ilf_asize; /* size of attr d/ext/root */ |
| 281 | __uint16_t ilf_dsize; /* size of data/ext/root */ |
| 282 | __uint32_t ilf_pad; /* pad for 64 bit boundary */ |
| 283 | __uint64_t ilf_ino; /* inode number */ |
| 284 | union { |
| 285 | __uint32_t ilfu_rdev; /* rdev value for dev inode*/ |
| 286 | uuid_t ilfu_uuid; /* mount point value */ |
| 287 | } ilf_u; |
| 288 | __int64_t ilf_blkno; /* blkno of inode buffer */ |
| 289 | __int32_t ilf_len; /* len of inode buffer */ |
| 290 | __int32_t ilf_boffset; /* off of inode in buffer */ |
| 291 | } xfs_inode_log_format_64_t; |
| 292 | |
Dave Chinner | f8d55aa052 | 2016-02-09 16:54:58 +1100 | [diff] [blame] | 293 | |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 294 | /* |
| 295 | * Flags for xfs_trans_log_inode flags field. |
| 296 | */ |
| 297 | #define XFS_ILOG_CORE 0x001 /* log standard inode fields */ |
| 298 | #define XFS_ILOG_DDATA 0x002 /* log i_df.if_data */ |
| 299 | #define XFS_ILOG_DEXT 0x004 /* log i_df.if_extents */ |
| 300 | #define XFS_ILOG_DBROOT 0x008 /* log i_df.i_broot */ |
| 301 | #define XFS_ILOG_DEV 0x010 /* log the dev field */ |
| 302 | #define XFS_ILOG_UUID 0x020 /* log the uuid field */ |
| 303 | #define XFS_ILOG_ADATA 0x040 /* log i_af.if_data */ |
| 304 | #define XFS_ILOG_AEXT 0x080 /* log i_af.if_extents */ |
| 305 | #define XFS_ILOG_ABROOT 0x100 /* log i_af.i_broot */ |
Dave Chinner | 638f4416 | 2013-08-30 10:23:45 +1000 | [diff] [blame] | 306 | #define XFS_ILOG_DOWNER 0x200 /* change the data fork owner on replay */ |
| 307 | #define XFS_ILOG_AOWNER 0x400 /* change the attr fork owner on replay */ |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 308 | |
| 309 | |
| 310 | /* |
| 311 | * The timestamps are dirty, but not necessarily anything else in the inode |
| 312 | * core. Unlike the other fields above this one must never make it to disk |
| 313 | * in the ilf_fields of the inode_log_format, but is purely store in-memory in |
| 314 | * ili_fields in the inode_log_item. |
| 315 | */ |
| 316 | #define XFS_ILOG_TIMESTAMP 0x4000 |
| 317 | |
| 318 | #define XFS_ILOG_NONCORE (XFS_ILOG_DDATA | XFS_ILOG_DEXT | \ |
| 319 | XFS_ILOG_DBROOT | XFS_ILOG_DEV | \ |
| 320 | XFS_ILOG_UUID | XFS_ILOG_ADATA | \ |
Dave Chinner | 638f4416 | 2013-08-30 10:23:45 +1000 | [diff] [blame] | 321 | XFS_ILOG_AEXT | XFS_ILOG_ABROOT | \ |
| 322 | XFS_ILOG_DOWNER | XFS_ILOG_AOWNER) |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 323 | |
| 324 | #define XFS_ILOG_DFORK (XFS_ILOG_DDATA | XFS_ILOG_DEXT | \ |
| 325 | XFS_ILOG_DBROOT) |
| 326 | |
| 327 | #define XFS_ILOG_AFORK (XFS_ILOG_ADATA | XFS_ILOG_AEXT | \ |
| 328 | XFS_ILOG_ABROOT) |
| 329 | |
| 330 | #define XFS_ILOG_ALL (XFS_ILOG_CORE | XFS_ILOG_DDATA | \ |
| 331 | XFS_ILOG_DEXT | XFS_ILOG_DBROOT | \ |
| 332 | XFS_ILOG_DEV | XFS_ILOG_UUID | \ |
| 333 | XFS_ILOG_ADATA | XFS_ILOG_AEXT | \ |
Dave Chinner | 638f4416 | 2013-08-30 10:23:45 +1000 | [diff] [blame] | 334 | XFS_ILOG_ABROOT | XFS_ILOG_TIMESTAMP | \ |
| 335 | XFS_ILOG_DOWNER | XFS_ILOG_AOWNER) |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 336 | |
| 337 | static inline int xfs_ilog_fbroot(int w) |
| 338 | { |
| 339 | return (w == XFS_DATA_FORK ? XFS_ILOG_DBROOT : XFS_ILOG_ABROOT); |
| 340 | } |
| 341 | |
| 342 | static inline int xfs_ilog_fext(int w) |
| 343 | { |
| 344 | return (w == XFS_DATA_FORK ? XFS_ILOG_DEXT : XFS_ILOG_AEXT); |
| 345 | } |
| 346 | |
| 347 | static inline int xfs_ilog_fdata(int w) |
| 348 | { |
| 349 | return (w == XFS_DATA_FORK ? XFS_ILOG_DDATA : XFS_ILOG_ADATA); |
| 350 | } |
| 351 | |
| 352 | /* |
| 353 | * Incore version of the on-disk inode core structures. We log this directly |
| 354 | * into the journal in host CPU format (for better or worse) and as such |
| 355 | * directly mirrors the xfs_dinode structure as it must contain all the same |
| 356 | * information. |
| 357 | */ |
| 358 | typedef struct xfs_ictimestamp { |
| 359 | __int32_t t_sec; /* timestamp seconds */ |
| 360 | __int32_t t_nsec; /* timestamp nanoseconds */ |
| 361 | } xfs_ictimestamp_t; |
| 362 | |
| 363 | /* |
Dave Chinner | f8d55aa052 | 2016-02-09 16:54:58 +1100 | [diff] [blame] | 364 | * Define the format of the inode core that is logged. This structure must be |
| 365 | * kept identical to struct xfs_dinode except for the endianness annotations. |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 366 | */ |
Dave Chinner | f8d55aa052 | 2016-02-09 16:54:58 +1100 | [diff] [blame] | 367 | struct xfs_log_dinode { |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 368 | __uint16_t di_magic; /* inode magic # = XFS_DINODE_MAGIC */ |
| 369 | __uint16_t di_mode; /* mode and type of file */ |
| 370 | __int8_t di_version; /* inode version */ |
| 371 | __int8_t di_format; /* format of di_c data */ |
Dave Chinner | faeb4e4 | 2016-02-09 16:54:58 +1100 | [diff] [blame] | 372 | __uint8_t di_pad3[2]; /* unused in v2/3 inodes */ |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 373 | __uint32_t di_uid; /* owner's user id */ |
| 374 | __uint32_t di_gid; /* owner's group id */ |
| 375 | __uint32_t di_nlink; /* number of links to file */ |
| 376 | __uint16_t di_projid_lo; /* lower part of owner's project id */ |
| 377 | __uint16_t di_projid_hi; /* higher part of owner's project id */ |
| 378 | __uint8_t di_pad[6]; /* unused, zeroed space */ |
| 379 | __uint16_t di_flushiter; /* incremented on flush */ |
| 380 | xfs_ictimestamp_t di_atime; /* time last accessed */ |
| 381 | xfs_ictimestamp_t di_mtime; /* time last modified */ |
| 382 | xfs_ictimestamp_t di_ctime; /* time created/inode modified */ |
| 383 | xfs_fsize_t di_size; /* number of bytes in file */ |
Christoph Hellwig | d5cf09b | 2014-07-30 09:12:05 +1000 | [diff] [blame] | 384 | xfs_rfsblock_t di_nblocks; /* # of direct & btree blocks used */ |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 385 | xfs_extlen_t di_extsize; /* basic/minimum extent size for file */ |
| 386 | xfs_extnum_t di_nextents; /* number of extents in data fork */ |
| 387 | xfs_aextnum_t di_anextents; /* number of extents in attribute fork*/ |
| 388 | __uint8_t di_forkoff; /* attr fork offs, <<3 for 64b align */ |
| 389 | __int8_t di_aformat; /* format of attr fork's data */ |
| 390 | __uint32_t di_dmevmask; /* DMIG event mask */ |
| 391 | __uint16_t di_dmstate; /* DMIG state info */ |
| 392 | __uint16_t di_flags; /* random flags, XFS_DIFLAG_... */ |
| 393 | __uint32_t di_gen; /* generation number */ |
| 394 | |
| 395 | /* di_next_unlinked is the only non-core field in the old dinode */ |
| 396 | xfs_agino_t di_next_unlinked;/* agi unlinked list ptr */ |
| 397 | |
| 398 | /* start of the extended dinode, writable fields */ |
| 399 | __uint32_t di_crc; /* CRC of the inode */ |
| 400 | __uint64_t di_changecount; /* number of attribute changes */ |
| 401 | xfs_lsn_t di_lsn; /* flush sequence */ |
| 402 | __uint64_t di_flags2; /* more random flags */ |
| 403 | __uint8_t di_pad2[16]; /* more padding for future expansion */ |
| 404 | |
| 405 | /* fields only written to during inode creation */ |
| 406 | xfs_ictimestamp_t di_crtime; /* time created */ |
| 407 | xfs_ino_t di_ino; /* inode number */ |
| 408 | uuid_t di_uuid; /* UUID of the filesystem */ |
| 409 | |
| 410 | /* structure must be padded to 64 bit alignment */ |
Dave Chinner | f8d55aa052 | 2016-02-09 16:54:58 +1100 | [diff] [blame] | 411 | }; |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 412 | |
Dave Chinner | f8d55aa052 | 2016-02-09 16:54:58 +1100 | [diff] [blame] | 413 | static inline uint xfs_log_dinode_size(int version) |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 414 | { |
| 415 | if (version == 3) |
Dave Chinner | f8d55aa052 | 2016-02-09 16:54:58 +1100 | [diff] [blame] | 416 | return sizeof(struct xfs_log_dinode); |
| 417 | return offsetof(struct xfs_log_dinode, di_next_unlinked); |
Dave Chinner | 6943283 | 2013-08-12 20:49:23 +1000 | [diff] [blame] | 418 | } |
Dave Chinner | a8da0da | 2013-08-12 20:49:24 +1000 | [diff] [blame] | 419 | |
| 420 | /* |
| 421 | * Buffer Log Format defintions |
| 422 | * |
| 423 | * These are the physical dirty bitmap defintions for the log format structure. |
| 424 | */ |
| 425 | #define XFS_BLF_CHUNK 128 |
| 426 | #define XFS_BLF_SHIFT 7 |
| 427 | #define BIT_TO_WORD_SHIFT 5 |
| 428 | #define NBWORD (NBBY * sizeof(unsigned int)) |
| 429 | |
| 430 | /* |
| 431 | * This flag indicates that the buffer contains on disk inodes |
| 432 | * and requires special recovery handling. |
| 433 | */ |
| 434 | #define XFS_BLF_INODE_BUF (1<<0) |
| 435 | |
| 436 | /* |
| 437 | * This flag indicates that the buffer should not be replayed |
| 438 | * during recovery because its blocks are being freed. |
| 439 | */ |
| 440 | #define XFS_BLF_CANCEL (1<<1) |
| 441 | |
| 442 | /* |
| 443 | * This flag indicates that the buffer contains on disk |
| 444 | * user or group dquots and may require special recovery handling. |
| 445 | */ |
| 446 | #define XFS_BLF_UDQUOT_BUF (1<<2) |
| 447 | #define XFS_BLF_PDQUOT_BUF (1<<3) |
| 448 | #define XFS_BLF_GDQUOT_BUF (1<<4) |
| 449 | |
| 450 | /* |
| 451 | * This is the structure used to lay out a buf log item in the |
| 452 | * log. The data map describes which 128 byte chunks of the buffer |
| 453 | * have been logged. |
| 454 | */ |
| 455 | #define XFS_BLF_DATAMAP_SIZE ((XFS_MAX_BLOCKSIZE / XFS_BLF_CHUNK) / NBWORD) |
| 456 | |
| 457 | typedef struct xfs_buf_log_format { |
| 458 | unsigned short blf_type; /* buf log item type indicator */ |
| 459 | unsigned short blf_size; /* size of this item */ |
| 460 | ushort blf_flags; /* misc state */ |
| 461 | ushort blf_len; /* number of blocks in this buf */ |
| 462 | __int64_t blf_blkno; /* starting blkno of this buf */ |
| 463 | unsigned int blf_map_size; /* used size of data bitmap in words */ |
| 464 | unsigned int blf_data_map[XFS_BLF_DATAMAP_SIZE]; /* dirty bitmap */ |
| 465 | } xfs_buf_log_format_t; |
| 466 | |
| 467 | /* |
| 468 | * All buffers now need to tell recovery where the magic number |
| 469 | * is so that it can verify and calculate the CRCs on the buffer correctly |
| 470 | * once the changes have been replayed into the buffer. |
| 471 | * |
| 472 | * The type value is held in the upper 5 bits of the blf_flags field, which is |
| 473 | * an unsigned 16 bit field. Hence we need to shift it 11 bits up and down. |
| 474 | */ |
| 475 | #define XFS_BLFT_BITS 5 |
| 476 | #define XFS_BLFT_SHIFT 11 |
| 477 | #define XFS_BLFT_MASK (((1 << XFS_BLFT_BITS) - 1) << XFS_BLFT_SHIFT) |
| 478 | |
| 479 | enum xfs_blft { |
| 480 | XFS_BLFT_UNKNOWN_BUF = 0, |
| 481 | XFS_BLFT_UDQUOT_BUF, |
| 482 | XFS_BLFT_PDQUOT_BUF, |
| 483 | XFS_BLFT_GDQUOT_BUF, |
| 484 | XFS_BLFT_BTREE_BUF, |
| 485 | XFS_BLFT_AGF_BUF, |
| 486 | XFS_BLFT_AGFL_BUF, |
| 487 | XFS_BLFT_AGI_BUF, |
| 488 | XFS_BLFT_DINO_BUF, |
| 489 | XFS_BLFT_SYMLINK_BUF, |
| 490 | XFS_BLFT_DIR_BLOCK_BUF, |
| 491 | XFS_BLFT_DIR_DATA_BUF, |
| 492 | XFS_BLFT_DIR_FREE_BUF, |
| 493 | XFS_BLFT_DIR_LEAF1_BUF, |
| 494 | XFS_BLFT_DIR_LEAFN_BUF, |
| 495 | XFS_BLFT_DA_NODE_BUF, |
| 496 | XFS_BLFT_ATTR_LEAF_BUF, |
| 497 | XFS_BLFT_ATTR_RMT_BUF, |
| 498 | XFS_BLFT_SB_BUF, |
Dave Chinner | f67ca6e | 2016-02-09 16:41:31 +1100 | [diff] [blame] | 499 | XFS_BLFT_RTBITMAP_BUF, |
| 500 | XFS_BLFT_RTSUMMARY_BUF, |
Dave Chinner | a8da0da | 2013-08-12 20:49:24 +1000 | [diff] [blame] | 501 | XFS_BLFT_MAX_BUF = (1 << XFS_BLFT_BITS), |
| 502 | }; |
| 503 | |
| 504 | static inline void |
| 505 | xfs_blft_to_flags(struct xfs_buf_log_format *blf, enum xfs_blft type) |
| 506 | { |
| 507 | ASSERT(type > XFS_BLFT_UNKNOWN_BUF && type < XFS_BLFT_MAX_BUF); |
| 508 | blf->blf_flags &= ~XFS_BLFT_MASK; |
| 509 | blf->blf_flags |= ((type << XFS_BLFT_SHIFT) & XFS_BLFT_MASK); |
| 510 | } |
| 511 | |
| 512 | static inline __uint16_t |
| 513 | xfs_blft_from_flags(struct xfs_buf_log_format *blf) |
| 514 | { |
| 515 | return (blf->blf_flags & XFS_BLFT_MASK) >> XFS_BLFT_SHIFT; |
| 516 | } |
| 517 | |
Dave Chinner | 9fbe24d | 2013-08-12 20:49:25 +1000 | [diff] [blame] | 518 | /* |
| 519 | * EFI/EFD log format definitions |
| 520 | */ |
| 521 | typedef struct xfs_extent { |
Christoph Hellwig | d5cf09b | 2014-07-30 09:12:05 +1000 | [diff] [blame] | 522 | xfs_fsblock_t ext_start; |
Dave Chinner | 9fbe24d | 2013-08-12 20:49:25 +1000 | [diff] [blame] | 523 | xfs_extlen_t ext_len; |
| 524 | } xfs_extent_t; |
| 525 | |
| 526 | /* |
| 527 | * Since an xfs_extent_t has types (start:64, len: 32) |
| 528 | * there are different alignments on 32 bit and 64 bit kernels. |
| 529 | * So we provide the different variants for use by a |
| 530 | * conversion routine. |
| 531 | */ |
| 532 | typedef struct xfs_extent_32 { |
| 533 | __uint64_t ext_start; |
| 534 | __uint32_t ext_len; |
| 535 | } __attribute__((packed)) xfs_extent_32_t; |
| 536 | |
| 537 | typedef struct xfs_extent_64 { |
| 538 | __uint64_t ext_start; |
| 539 | __uint32_t ext_len; |
| 540 | __uint32_t ext_pad; |
| 541 | } xfs_extent_64_t; |
| 542 | |
| 543 | /* |
| 544 | * This is the structure used to lay out an efi log item in the |
| 545 | * log. The efi_extents field is a variable size array whose |
| 546 | * size is given by efi_nextents. |
| 547 | */ |
| 548 | typedef struct xfs_efi_log_format { |
| 549 | __uint16_t efi_type; /* efi log item type */ |
| 550 | __uint16_t efi_size; /* size of this item */ |
| 551 | __uint32_t efi_nextents; /* # extents to free */ |
| 552 | __uint64_t efi_id; /* efi identifier */ |
| 553 | xfs_extent_t efi_extents[1]; /* array of extents to free */ |
| 554 | } xfs_efi_log_format_t; |
| 555 | |
| 556 | typedef struct xfs_efi_log_format_32 { |
| 557 | __uint16_t efi_type; /* efi log item type */ |
| 558 | __uint16_t efi_size; /* size of this item */ |
| 559 | __uint32_t efi_nextents; /* # extents to free */ |
| 560 | __uint64_t efi_id; /* efi identifier */ |
| 561 | xfs_extent_32_t efi_extents[1]; /* array of extents to free */ |
| 562 | } __attribute__((packed)) xfs_efi_log_format_32_t; |
| 563 | |
| 564 | typedef struct xfs_efi_log_format_64 { |
| 565 | __uint16_t efi_type; /* efi log item type */ |
| 566 | __uint16_t efi_size; /* size of this item */ |
| 567 | __uint32_t efi_nextents; /* # extents to free */ |
| 568 | __uint64_t efi_id; /* efi identifier */ |
| 569 | xfs_extent_64_t efi_extents[1]; /* array of extents to free */ |
| 570 | } xfs_efi_log_format_64_t; |
| 571 | |
| 572 | /* |
| 573 | * This is the structure used to lay out an efd log item in the |
| 574 | * log. The efd_extents array is a variable size array whose |
| 575 | * size is given by efd_nextents; |
| 576 | */ |
| 577 | typedef struct xfs_efd_log_format { |
| 578 | __uint16_t efd_type; /* efd log item type */ |
| 579 | __uint16_t efd_size; /* size of this item */ |
| 580 | __uint32_t efd_nextents; /* # of extents freed */ |
| 581 | __uint64_t efd_efi_id; /* id of corresponding efi */ |
| 582 | xfs_extent_t efd_extents[1]; /* array of extents freed */ |
| 583 | } xfs_efd_log_format_t; |
| 584 | |
| 585 | typedef struct xfs_efd_log_format_32 { |
| 586 | __uint16_t efd_type; /* efd log item type */ |
| 587 | __uint16_t efd_size; /* size of this item */ |
| 588 | __uint32_t efd_nextents; /* # of extents freed */ |
| 589 | __uint64_t efd_efi_id; /* id of corresponding efi */ |
| 590 | xfs_extent_32_t efd_extents[1]; /* array of extents freed */ |
| 591 | } __attribute__((packed)) xfs_efd_log_format_32_t; |
| 592 | |
| 593 | typedef struct xfs_efd_log_format_64 { |
| 594 | __uint16_t efd_type; /* efd log item type */ |
| 595 | __uint16_t efd_size; /* size of this item */ |
| 596 | __uint32_t efd_nextents; /* # of extents freed */ |
| 597 | __uint64_t efd_efi_id; /* id of corresponding efi */ |
| 598 | xfs_extent_64_t efd_extents[1]; /* array of extents freed */ |
| 599 | } xfs_efd_log_format_64_t; |
| 600 | |
Dave Chinner | 6ca1c90 | 2013-08-12 20:49:26 +1000 | [diff] [blame] | 601 | /* |
| 602 | * Dquot Log format definitions. |
| 603 | * |
| 604 | * The first two fields must be the type and size fitting into |
| 605 | * 32 bits : log_recovery code assumes that. |
| 606 | */ |
| 607 | typedef struct xfs_dq_logformat { |
| 608 | __uint16_t qlf_type; /* dquot log item type */ |
| 609 | __uint16_t qlf_size; /* size of this item */ |
| 610 | xfs_dqid_t qlf_id; /* usr/grp/proj id : 32 bits */ |
| 611 | __int64_t qlf_blkno; /* blkno of dquot buffer */ |
| 612 | __int32_t qlf_len; /* len of dquot buffer */ |
| 613 | __uint32_t qlf_boffset; /* off of dquot in buffer */ |
| 614 | } xfs_dq_logformat_t; |
| 615 | |
| 616 | /* |
| 617 | * log format struct for QUOTAOFF records. |
| 618 | * The first two fields must be the type and size fitting into |
| 619 | * 32 bits : log_recovery code assumes that. |
| 620 | * We write two LI_QUOTAOFF logitems per quotaoff, the last one keeps a pointer |
| 621 | * to the first and ensures that the first logitem is taken out of the AIL |
| 622 | * only when the last one is securely committed. |
| 623 | */ |
| 624 | typedef struct xfs_qoff_logformat { |
| 625 | unsigned short qf_type; /* quotaoff log item type */ |
| 626 | unsigned short qf_size; /* size of this item */ |
| 627 | unsigned int qf_flags; /* USR and/or GRP */ |
| 628 | char qf_pad[12]; /* padding for future */ |
| 629 | } xfs_qoff_logformat_t; |
| 630 | |
Dave Chinner | 6ca1c90 | 2013-08-12 20:49:26 +1000 | [diff] [blame] | 631 | /* |
| 632 | * Disk quotas status in m_qflags, and also sb_qflags. 16 bits. |
| 633 | */ |
| 634 | #define XFS_UQUOTA_ACCT 0x0001 /* user quota accounting ON */ |
| 635 | #define XFS_UQUOTA_ENFD 0x0002 /* user quota limits enforced */ |
| 636 | #define XFS_UQUOTA_CHKD 0x0004 /* quotacheck run on usr quotas */ |
| 637 | #define XFS_PQUOTA_ACCT 0x0008 /* project quota accounting ON */ |
| 638 | #define XFS_OQUOTA_ENFD 0x0010 /* other (grp/prj) quota limits enforced */ |
| 639 | #define XFS_OQUOTA_CHKD 0x0020 /* quotacheck run on other (grp/prj) quotas */ |
| 640 | #define XFS_GQUOTA_ACCT 0x0040 /* group quota accounting ON */ |
| 641 | |
| 642 | /* |
| 643 | * Conversion to and from the combined OQUOTA flag (if necessary) |
| 644 | * is done only in xfs_sb_qflags_to_disk() and xfs_sb_qflags_from_disk() |
| 645 | */ |
| 646 | #define XFS_GQUOTA_ENFD 0x0080 /* group quota limits enforced */ |
| 647 | #define XFS_GQUOTA_CHKD 0x0100 /* quotacheck run on group quotas */ |
| 648 | #define XFS_PQUOTA_ENFD 0x0200 /* project quota limits enforced */ |
| 649 | #define XFS_PQUOTA_CHKD 0x0400 /* quotacheck run on project quotas */ |
| 650 | |
| 651 | #define XFS_ALL_QUOTA_ACCT \ |
| 652 | (XFS_UQUOTA_ACCT | XFS_GQUOTA_ACCT | XFS_PQUOTA_ACCT) |
| 653 | #define XFS_ALL_QUOTA_ENFD \ |
| 654 | (XFS_UQUOTA_ENFD | XFS_GQUOTA_ENFD | XFS_PQUOTA_ENFD) |
| 655 | #define XFS_ALL_QUOTA_CHKD \ |
| 656 | (XFS_UQUOTA_CHKD | XFS_GQUOTA_CHKD | XFS_PQUOTA_CHKD) |
| 657 | |
Dave Chinner | 1d03c6f | 2013-08-30 16:21:21 +1000 | [diff] [blame] | 658 | #define XFS_MOUNT_QUOTA_ALL (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\ |
| 659 | XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\ |
| 660 | XFS_GQUOTA_ENFD|XFS_GQUOTA_CHKD|\ |
| 661 | XFS_PQUOTA_ACCT|XFS_PQUOTA_ENFD|\ |
| 662 | XFS_PQUOTA_CHKD) |
| 663 | |
Dave Chinner | 9cd047f | 2013-08-12 20:49:27 +1000 | [diff] [blame] | 664 | /* |
| 665 | * Inode create log item structure |
| 666 | * |
| 667 | * Log recovery assumes the first two entries are the type and size and they fit |
| 668 | * in 32 bits. Also in host order (ugh) so they have to be 32 bit aligned so |
| 669 | * decoding can be done correctly. |
| 670 | */ |
| 671 | struct xfs_icreate_log { |
| 672 | __uint16_t icl_type; /* type of log format structure */ |
| 673 | __uint16_t icl_size; /* size of log format structure */ |
| 674 | __be32 icl_ag; /* ag being allocated in */ |
| 675 | __be32 icl_agbno; /* start block of inode range */ |
| 676 | __be32 icl_count; /* number of inodes to initialise */ |
| 677 | __be32 icl_isize; /* size of inodes */ |
| 678 | __be32 icl_length; /* length of extent to initialise */ |
| 679 | __be32 icl_gen; /* inode generation number to use */ |
| 680 | }; |
| 681 | |
Dave Chinner | fc06c6d | 2013-08-12 20:49:22 +1000 | [diff] [blame] | 682 | #endif /* __XFS_LOG_FORMAT_H__ */ |