tree-log.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * Copyright (C) 2008 Oracle.  All rights reserved.
  4 */
  5
  6#ifndef BTRFS_TREE_LOG_H
  7#define BTRFS_TREE_LOG_H
  8
  9#include <linux/list.h>
 10#include <linux/fs.h>
 11#include <linux/fscrypt.h>
 12#include "transaction.h"
 13
 14struct inode;
 15struct dentry;
 16struct btrfs_ordered_extent;
 17struct btrfs_root;
 18struct btrfs_trans_handle;
 19
 20/* return value for btrfs_log_dentry_safe that means we don't need to log it at all */
 21#define BTRFS_NO_LOG_SYNC 256
 22
 23/*
 24 * We can't use the tree log for whatever reason, force a transaction commit.
 25 * We use a negative value because there are functions through the logging code
 26 * that need to return an error (< 0 value), false (0) or true (1). Any negative
 27 * value will do, as it will cause the log to be marked for a full sync.
 28 */
 29#define BTRFS_LOG_FORCE_COMMIT				(-(MAX_ERRNO + 1))
 30
 31struct btrfs_log_ctx {
 32	int log_ret;
 33	int log_transid;
 34	bool log_new_dentries;
 35	bool logging_new_name;
 36	bool logging_new_delayed_dentries;
 37	/* Indicate if the inode being logged was logged before. */
 38	bool logged_before;
 39	struct btrfs_inode *inode;
 40	struct list_head list;
 41	/* Only used for fast fsyncs. */
 42	struct list_head ordered_extents;
 43	struct list_head conflict_inodes;
 44	int num_conflict_inodes;
 45	bool logging_conflict_inodes;
 46	/*
 47	 * Used for fsyncs that need to copy items from the subvolume tree to
 48	 * the log tree (full sync flag set or copy everything flag set) to
 49	 * avoid allocating a temporary extent buffer while holding a lock on
 50	 * an extent buffer of the subvolume tree and under the log transaction.
 51	 * Also helps to avoid allocating and freeing a temporary extent buffer
 52	 * in case we need to process multiple leaves from the subvolume tree.
 53	 */
 54	struct extent_buffer *scratch_eb;
 55};
 56
 57void btrfs_init_log_ctx(struct btrfs_log_ctx *ctx, struct btrfs_inode *inode);
 58void btrfs_init_log_ctx_scratch_eb(struct btrfs_log_ctx *ctx);
 59void btrfs_release_log_ctx_extents(struct btrfs_log_ctx *ctx);
 60
 61static inline void btrfs_set_log_full_commit(struct btrfs_trans_handle *trans)
 62{
 63	WRITE_ONCE(trans->fs_info->last_trans_log_full_commit, trans->transid);
 64}
 65
 66static inline int btrfs_need_log_full_commit(struct btrfs_trans_handle *trans)
 67{
 68	return READ_ONCE(trans->fs_info->last_trans_log_full_commit) ==
 69		trans->transid;
 70}
 71
 72int btrfs_sync_log(struct btrfs_trans_handle *trans,
 73		   struct btrfs_root *root, struct btrfs_log_ctx *ctx);
 74int btrfs_free_log(struct btrfs_trans_handle *trans, struct btrfs_root *root);
 75int btrfs_free_log_root_tree(struct btrfs_trans_handle *trans,
 76			     struct btrfs_fs_info *fs_info);
 77int btrfs_recover_log_trees(struct btrfs_root *tree_root);
 78int btrfs_log_dentry_safe(struct btrfs_trans_handle *trans,
 79			  struct dentry *dentry,
 80			  struct btrfs_log_ctx *ctx);
 81void btrfs_del_dir_entries_in_log(struct btrfs_trans_handle *trans,
 82				  const struct fscrypt_str *name,
 83				  struct btrfs_inode *dir, u64 index);
 84void btrfs_del_inode_ref_in_log(struct btrfs_trans_handle *trans,
 85				const struct fscrypt_str *name,
 86				struct btrfs_inode *inode,
 87				struct btrfs_inode *dir);
 88void btrfs_end_log_trans(struct btrfs_root *root);
 89void btrfs_pin_log_trans(struct btrfs_root *root);
 90void btrfs_record_unlink_dir(struct btrfs_trans_handle *trans,
 91			     struct btrfs_inode *dir, struct btrfs_inode *inode,
 92			     bool for_rename);
 93void btrfs_record_snapshot_destroy(struct btrfs_trans_handle *trans,
 94				   struct btrfs_inode *dir);
 95void btrfs_record_new_subvolume(const struct btrfs_trans_handle *trans,
 96				struct btrfs_inode *dir);
 97void btrfs_log_new_name(struct btrfs_trans_handle *trans,
 98			struct dentry *old_dentry, struct btrfs_inode *old_dir,
 99			u64 old_dir_index, struct dentry *parent);
100
101#endif