fs/btrfs/btrfs_inode.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (C) 2007 Oracle.  All rights reserved.
   4  */
   5
   6 #ifndef BTRFS_INODE_H
   7 #define BTRFS_INODE_H
   8
   9 #include <linux/hash.h>
  10 #include <linux/refcount.h>
  11 #include "extent_map.h"
  12 #include "extent_io.h"
  13 #include "ordered-data.h"
  14 #include "delayed-inode.h"
  15
  16 /*
  17  * ordered_data_close is set by truncate when a file that used
  18  * to have good data has been truncated to zero.  When it is set
  19  * the btrfs file release call will add this inode to the
  20  * ordered operations list so that we make sure to flush out any
  21  * new data the application may have written before commit.
  22  */
  23 enum {
  24         BTRFS_INODE_FLUSH_ON_CLOSE,
  25         BTRFS_INODE_DUMMY,
  26         BTRFS_INODE_IN_DEFRAG,
  27         BTRFS_INODE_HAS_ASYNC_EXTENT,
  28          /*
  29           * Always set under the VFS' inode lock, otherwise it can cause races
  30           * during fsync (we start as a fast fsync and then end up in a full
  31           * fsync racing with ordered extent completion).
  32           */
  33         BTRFS_INODE_NEEDS_FULL_SYNC,
  34         BTRFS_INODE_COPY_EVERYTHING,
  35         BTRFS_INODE_IN_DELALLOC_LIST,
  36         BTRFS_INODE_HAS_PROPS,
  37         BTRFS_INODE_SNAPSHOT_FLUSH,
  38         /*
  39          * Set and used when logging an inode and it serves to signal that an
  40          * inode does not have xattrs, so subsequent fsyncs can avoid searching
  41          * for xattrs to log. This bit must be cleared whenever a xattr is added
  42          * to an inode.
  43          */
  44         BTRFS_INODE_NO_XATTRS,
  45         /*
  46          * Set when we are in a context where we need to start a transaction and
  47          * have dirty pages with the respective file range locked. This is to
  48          * ensure that when reserving space for the transaction, if we are low
  49          * on available space and need to flush delalloc, we will not flush
  50          * delalloc for this inode, because that could result in a deadlock (on
  51          * the file range, inode's io_tree).
  52          */
  53         BTRFS_INODE_NO_DELALLOC_FLUSH,
  54         /*
  55          * Set when we are working on enabling verity for a file. Computing and
  56          * writing the whole Merkle tree can take a while so we want to prevent
  57          * races where two separate tasks attempt to simultaneously start verity
  58          * on the same file.
  59          */
  60         BTRFS_INODE_VERITY_IN_PROGRESS,
  61 };
  62
  63 /* in memory btrfs inode */
  64 struct btrfs_inode {
  65         /* which subvolume this inode belongs to */
  66         struct btrfs_root *root;
  67
  68         /* key used to find this inode on disk.  This is used by the code
  69          * to read in roots of subvolumes
  70          */
  71         struct btrfs_key location;
  72
  73         /*
  74          * Lock for counters and all fields used to determine if the inode is in
  75          * the log or not (last_trans, last_sub_trans, last_log_commit,
  76          * logged_trans), to access/update new_delalloc_bytes and to update the
  77          * VFS' inode number of bytes used.
  78          */
  79         spinlock_t lock;
  80
  81         /* the extent_tree has caches of all the extent mappings to disk */
  82         struct extent_map_tree extent_tree;
  83
  84         /* the io_tree does range state (DIRTY, LOCKED etc) */
  85         struct extent_io_tree io_tree;
  86
  87         /* special utility tree used to record which mirrors have already been
  88          * tried when checksums fail for a given block
  89          */
  90         struct extent_io_tree io_failure_tree;
  91
  92         /*
  93          * Keep track of where the inode has extent items mapped in order to
  94          * make sure the i_size adjustments are accurate
  95          */
  96         struct extent_io_tree file_extent_tree;
  97
  98         /* held while logging the inode in tree-log.c */
  99         struct mutex log_mutex;
 100
 101         /* used to order data wrt metadata */
 102         struct btrfs_ordered_inode_tree ordered_tree;
 103
 104         /* list of all the delalloc inodes in the FS.  There are times we need
 105          * to write all the delalloc pages to disk, and this list is used
 106          * to walk them all.
 107          */
 108         struct list_head delalloc_inodes;
 109
 110         /* node for the red-black tree that links inodes in subvolume root */
 111         struct rb_node rb_node;
 112
 113         unsigned long runtime_flags;
 114
 115         /* Keep track of who's O_SYNC/fsyncing currently */
 116         atomic_t sync_writers;
 117
 118         /* full 64 bit generation number, struct vfs_inode doesn't have a big
 119          * enough field for this.
 120          */
 121         u64 generation;
 122
 123         /*
 124          * transid of the trans_handle that last modified this inode
 125          */
 126         u64 last_trans;
 127
 128         /*
 129          * transid that last logged this inode
 130          */
 131         u64 logged_trans;
 132
 133         /*
 134          * log transid when this inode was last modified
 135          */
 136         int last_sub_trans;
 137
 138         /* a local copy of root's last_log_commit */
 139         int last_log_commit;
 140
 141         /*
 142          * Total number of bytes pending delalloc, used by stat to calculate the
 143          * real block usage of the file. This is used only for files.
 144          */
 145         u64 delalloc_bytes;
 146
 147         union {
 148                 /*
 149                  * Total number of bytes pending delalloc that fall within a file
 150                  * range that is either a hole or beyond EOF (and no prealloc extent
 151                  * exists in the range). This is always <= delalloc_bytes and this
 152                  * is used only for files.
 153                  */
 154                 u64 new_delalloc_bytes;
 155                 /*
 156                  * The offset of the last dir index key that was logged.
 157                  * This is used only for directories.
 158                  */
 159                 u64 last_dir_index_offset;
 160         };
 161
 162         /*
 163          * total number of bytes pending defrag, used by stat to check whether
 164          * it needs COW.
 165          */
 166         u64 defrag_bytes;
 167
 168         /*
 169          * the size of the file stored in the metadata on disk.  data=ordered
 170          * means the in-memory i_size might be larger than the size on disk
 171          * because not all the blocks are written yet.
 172          */
 173         u64 disk_i_size;
 174
 175         /*
 176          * if this is a directory then index_cnt is the counter for the index
 177          * number for new files that are created
 178          */
 179         u64 index_cnt;
 180
 181         /* Cache the directory index number to speed the dir/file remove */
 182         u64 dir_index;
 183
 184         /* the fsync log has some corner cases that mean we have to check
 185          * directories to see if any unlinks have been done before
 186          * the directory was logged.  See tree-log.c for all the
 187          * details
 188          */
 189         u64 last_unlink_trans;
 190
 191         /*
 192          * The id/generation of the last transaction where this inode was
 193          * either the source or the destination of a clone/dedupe operation.
 194          * Used when logging an inode to know if there are shared extents that
 195          * need special care when logging checksum items, to avoid duplicate
 196          * checksum items in a log (which can lead to a corruption where we end
 197          * up with missing checksum ranges after log replay).
 198          * Protected by the vfs inode lock.
 199          */
 200         u64 last_reflink_trans;
 201
 202         /*
 203          * Number of bytes outstanding that are going to need csums.  This is
 204          * used in ENOSPC accounting.
 205          */
 206         u64 csum_bytes;
 207
 208         /* Backwards incompatible flags, lower half of inode_item::flags  */
 209         u32 flags;
 210         /* Read-only compatibility flags, upper half of inode_item::flags */
 211         u32 ro_flags;
 212
 213         /*
 214          * Counters to keep track of the number of extent item's we may use due
 215          * to delalloc and such.  outstanding_extents is the number of extent
 216          * items we think we'll end up using, and reserved_extents is the number
 217          * of extent items we've reserved metadata for.
 218          */
 219         unsigned outstanding_extents;
 220
 221         struct btrfs_block_rsv block_rsv;
 222
 223         /*
 224          * Cached values of inode properties
 225          */
 226         unsigned prop_compress;         /* per-file compression algorithm */
 227         /*
 228          * Force compression on the file using the defrag ioctl, could be
 229          * different from prop_compress and takes precedence if set
 230          */
 231         unsigned defrag_compress;
 232
 233         struct btrfs_delayed_node *delayed_node;
 234
 235         /* File creation time. */
 236         struct timespec64 i_otime;
 237
 238         /* Hook into fs_info->delayed_iputs */
 239         struct list_head delayed_iput;
 240
 241         struct rw_semaphore i_mmap_lock;
 242         struct inode vfs_inode;
 243 };
 244
 245 static inline u32 btrfs_inode_sectorsize(const struct btrfs_inode *inode)
 246 {
 247         return inode->root->fs_info->sectorsize;
 248 }
 249
 250 static inline struct btrfs_inode *BTRFS_I(const struct inode *inode)
 251 {
 252         return container_of(inode, struct btrfs_inode, vfs_inode);
 253 }
 254
 255 static inline unsigned long btrfs_inode_hash(u64 objectid,
 256                                              const struct btrfs_root *root)
 257 {
 258         u64 h = objectid ^ (root->root_key.objectid * GOLDEN_RATIO_PRIME);
 259
 260 #if BITS_PER_LONG == 32
 261         h = (h >> 32) ^ (h & 0xffffffff);
 262 #endif
 263
 264         return (unsigned long)h;
 265 }
 266
 267 static inline void btrfs_insert_inode_hash(struct inode *inode)
 268 {
 269         unsigned long h = btrfs_inode_hash(inode->i_ino, BTRFS_I(inode)->root);
 270
 271         __insert_inode_hash(inode, h);
 272 }
 273
 274 static inline u64 btrfs_ino(const struct btrfs_inode *inode)
 275 {
 276         u64 ino = inode->location.objectid;
 277
 278         /*
 279          * !ino: btree_inode
 280          * type == BTRFS_ROOT_ITEM_KEY: subvol dir
 281          */
 282         if (!ino || inode->location.type == BTRFS_ROOT_ITEM_KEY)
 283                 ino = inode->vfs_inode.i_ino;
 284         return ino;
 285 }
 286
 287 static inline void btrfs_i_size_write(struct btrfs_inode *inode, u64 size)
 288 {
 289         i_size_write(&inode->vfs_inode, size);
 290         inode->disk_i_size = size;
 291 }
 292
 293 static inline bool btrfs_is_free_space_inode(struct btrfs_inode *inode)
 294 {
 295         struct btrfs_root *root = inode->root;
 296
 297         if (root == root->fs_info->tree_root &&
 298             btrfs_ino(inode) != BTRFS_BTREE_INODE_OBJECTID)
 299                 return true;
 300         if (inode->location.objectid == BTRFS_FREE_INO_OBJECTID)
 301                 return true;
 302         return false;
 303 }
 304
 305 static inline bool is_data_inode(struct inode *inode)
 306 {
 307         return btrfs_ino(BTRFS_I(inode)) != BTRFS_BTREE_INODE_OBJECTID;
 308 }
 309
 310 static inline void btrfs_mod_outstanding_extents(struct btrfs_inode *inode,
 311                                                  int mod)
 312 {
 313         lockdep_assert_held(&inode->lock);
 314         inode->outstanding_extents += mod;
 315         if (btrfs_is_free_space_inode(inode))
 316                 return;
 317         trace_btrfs_inode_mod_outstanding_extents(inode->root, btrfs_ino(inode),
 318                                                   mod);
 319 }
 320
 321 /*
 322  * Called every time after doing a buffered, direct IO or memory mapped write.
 323  *
 324  * This is to ensure that if we write to a file that was previously fsynced in
 325  * the current transaction, then try to fsync it again in the same transaction,
 326  * we will know that there were changes in the file and that it needs to be
 327  * logged.
 328  */
 329 static inline void btrfs_set_inode_last_sub_trans(struct btrfs_inode *inode)
 330 {
 331         spin_lock(&inode->lock);
 332         inode->last_sub_trans = inode->root->log_transid;
 333         spin_unlock(&inode->lock);
 334 }
 335
 336 static inline bool btrfs_inode_in_log(struct btrfs_inode *inode, u64 generation)
 337 {
 338         bool ret = false;
 339
 340         spin_lock(&inode->lock);
 341         if (inode->logged_trans == generation &&
 342             inode->last_sub_trans <= inode->last_log_commit &&
 343             inode->last_sub_trans <= inode->root->last_log_commit)
 344                 ret = true;
 345         spin_unlock(&inode->lock);
 346         return ret;
 347 }
 348
 349 struct btrfs_dio_private {
 350         struct inode *inode;
 351
 352         /*
 353          * Since DIO can use anonymous page, we cannot use page_offset() to
 354          * grab the file offset, thus need a dedicated member for file offset.
 355          */
 356         u64 file_offset;
 357         u64 disk_bytenr;
 358         /* Used for bio::bi_size */
 359         u32 bytes;
 360
 361         /*
 362          * References to this structure. There is one reference per in-flight
 363          * bio plus one while we're still setting up.
 364          */
 365         refcount_t refs;
 366
 367         /* dio_bio came from fs/direct-io.c */
 368         struct bio *dio_bio;
 369
 370         /* Array of checksums */
 371         u8 csums[];
 372 };
 373
 374 /*
 375  * btrfs_inode_item stores flags in a u64, btrfs_inode stores them in two
 376  * separate u32s. These two functions convert between the two representations.
 377  */
 378 static inline u64 btrfs_inode_combine_flags(u32 flags, u32 ro_flags)
 379 {
 380         return (flags | ((u64)ro_flags << 32));
 381 }
 382
 383 static inline void btrfs_inode_split_flags(u64 inode_item_flags,
 384                                            u32 *flags, u32 *ro_flags)
 385 {
 386         *flags = (u32)inode_item_flags;
 387         *ro_flags = (u32)(inode_item_flags >> 32);
 388 }
 389
 390 /* Array of bytes with variable length, hexadecimal format 0x1234 */
 391 #define CSUM_FMT                                "0x%*phN"
 392 #define CSUM_FMT_VALUE(size, bytes)             size, bytes
 393
 394 static inline void btrfs_print_data_csum_error(struct btrfs_inode *inode,
 395                 u64 logical_start, u8 *csum, u8 *csum_expected, int mirror_num)
 396 {
 397         struct btrfs_root *root = inode->root;
 398         const u32 csum_size = root->fs_info->csum_size;
 399
 400         /* Output minus objectid, which is more meaningful */
 401         if (root->root_key.objectid >= BTRFS_LAST_FREE_OBJECTID)
 402                 btrfs_warn_rl(root->fs_info,
 403 "csum failed root %lld ino %lld off %llu csum " CSUM_FMT " expected csum " CSUM_FMT " mirror %d",
 404                         root->root_key.objectid, btrfs_ino(inode),
 405                         logical_start,
 406                         CSUM_FMT_VALUE(csum_size, csum),
 407                         CSUM_FMT_VALUE(csum_size, csum_expected),
 408                         mirror_num);
 409         else
 410                 btrfs_warn_rl(root->fs_info,
 411 "csum failed root %llu ino %llu off %llu csum " CSUM_FMT " expected csum " CSUM_FMT " mirror %d",
 412                         root->root_key.objectid, btrfs_ino(inode),
 413                         logical_start,
 414                         CSUM_FMT_VALUE(csum_size, csum),
 415                         CSUM_FMT_VALUE(csum_size, csum_expected),
 416                         mirror_num);
 417 }
 418
 419 #endif