[linux-2.6-block.git] / fs / btrfs / inode-item.h

/* SPDX-License-Identifier: GPL-2.0 */

#ifndef BTRFS_INODE_ITEM_H
#define BTRFS_INODE_ITEM_H

#include <linux/types.h>
#include <linux/crc32c.h>

struct fscrypt_str;
struct extent_buffer;
struct btrfs_trans_handle;
struct btrfs_root;
struct btrfs_path;
struct btrfs_key;
struct btrfs_inode_extref;
struct btrfs_inode;
struct btrfs_truncate_control;

/*
 * Return this if we need to call truncate_block for the last bit of the
 * truncate.
 */
#define BTRFS_NEED_TRUNCATE_BLOCK		1

struct btrfs_truncate_control {
	/*
	 * IN: the inode we're operating on, this can be NULL if
	 * ->clear_extent_range is false.
	 */
	struct btrfs_inode *inode;

	/* IN: the size we're truncating to. */
	u64 new_size;

	/* OUT: the number of extents truncated. */
	u64 extents_found;

	/* OUT: the last size we truncated this inode to. */
	u64 last_size;

	/* OUT: the number of bytes to sub from this inode. */
	u64 sub_bytes;

	/* IN: the ino we are truncating. */
	u64 ino;

	/*
	 * IN: minimum key type to remove.  All key types with this type are
	 * removed only if their offset >= new_size.
	 */
	u32 min_type;

	/*
	 * IN: true if we don't want to do extent reference updates for any file
	 * extents we drop.
	 */
	bool skip_ref_updates;

	/*
	 * IN: true if we need to clear the file extent range for the inode as
	 * we drop the file extent items.
	 */
	bool clear_extent_range;
};

/*
 * btrfs_inode_item stores flags in a u64, btrfs_inode stores them in two
 * separate u32s. These two functions convert between the two representations.
 */
static inline u64 btrfs_inode_combine_flags(u32 flags, u32 ro_flags)
{
	return (flags | ((u64)ro_flags << 32));
}

static inline void btrfs_inode_split_flags(u64 inode_item_flags,
					   u32 *flags, u32 *ro_flags)
{
	*flags = (u32)inode_item_flags;
	*ro_flags = (u32)(inode_item_flags >> 32);
}

/* Figure the key offset of an extended inode ref. */
static inline u64 btrfs_extref_hash(u64 parent_objectid, const char *name, int len)
{
       return (u64)crc32c(parent_objectid, name, len);
}

int btrfs_truncate_inode_items(struct btrfs_trans_handle *trans,
			       struct btrfs_root *root,
			       struct btrfs_truncate_control *control);
int btrfs_insert_inode_ref(struct btrfs_trans_handle *trans,
			   struct btrfs_root *root, const struct fscrypt_str *name,
			   u64 inode_objectid, u64 ref_objectid, u64 index);
int btrfs_del_inode_ref(struct btrfs_trans_handle *trans,
			struct btrfs_root *root, const struct fscrypt_str *name,
			u64 inode_objectid, u64 ref_objectid, u64 *index);
int btrfs_insert_empty_inode(struct btrfs_trans_handle *trans,
			     struct btrfs_root *root,
			     struct btrfs_path *path, u64 objectid);
int btrfs_lookup_inode(struct btrfs_trans_handle *trans,
		       struct btrfs_root *root, struct btrfs_path *path,
		       struct btrfs_key *location, int mod);

struct btrfs_inode_extref *btrfs_lookup_inode_extref(
			  struct btrfs_trans_handle *trans,
			  struct btrfs_root *root,
			  struct btrfs_path *path,
			  const struct fscrypt_str *name,
			  u64 inode_objectid, u64 ref_objectid, int ins_len,
			  int cow);

struct btrfs_inode_ref *btrfs_find_name_in_backref(struct extent_buffer *leaf,
						   int slot,
						   const struct fscrypt_str *name);
struct btrfs_inode_extref *btrfs_find_name_in_ext_backref(
		struct extent_buffer *leaf, int slot, u64 ref_objectid,
		const struct fscrypt_str *name);

#endif
Commit	Line	Data
26c2c454 JB	1	/* SPDX-License-Identifier: GPL-2.0 */
	2
	3	#ifndef BTRFS_INODE_ITEM_H
	4	#define BTRFS_INODE_ITEM_H
	5
	6	#include <linux/types.h>
98e4f060	7	#include <linux/crc32c.h>
26c2c454	8
602035d7 DS	9	struct fscrypt_str;
602035d7 DS	10	struct extent_buffer;
26c2c454 JB	11	struct btrfs_trans_handle;
	12	struct btrfs_root;
	13	struct btrfs_path;
	14	struct btrfs_key;
	15	struct btrfs_inode_extref;
54f03ab1	16	struct btrfs_inode;
602035d7	17	struct btrfs_truncate_control;
26c2c454	18
54f03ab1 JB	19	/*
	20	* Return this if we need to call truncate_block for the last bit of the
	21	* truncate.
	22	*/
	23	#define BTRFS_NEED_TRUNCATE_BLOCK 1
	24
d9ac19c3	25	struct btrfs_truncate_control {
71d18b53 JB	26	/*
	27	* IN: the inode we're operating on, this can be NULL if
	28	* ->clear_extent_range is false.
	29	*/
	30	struct btrfs_inode *inode;
	31
d9ac19c3 JB	32	/* IN: the size we're truncating to. */
	33	u64 new_size;
	34
	35	/* OUT: the number of extents truncated. */
	36	u64 extents_found;
	37
c2ddb612 JB	38	/* OUT: the last size we truncated this inode to. */
	39	u64 last_size;
	40
462b728e JB	41	/* OUT: the number of bytes to sub from this inode. */
	42	u64 sub_bytes;
	43
487e81d2 JB	44	/* IN: the ino we are truncating. */
	45	u64 ino;
	46
d9ac19c3 JB	47	/*
	48	* IN: minimum key type to remove. All key types with this type are
	49	* removed only if their offset >= new_size.
	50	*/
	51	u32 min_type;
5caa490e JB	52
	53	/*
	54	* IN: true if we don't want to do extent reference updates for any file
	55	* extents we drop.
	56	*/
	57	bool skip_ref_updates;
655807b8 JB	58
	59	/*
	60	* IN: true if we need to clear the file extent range for the inode as
	61	* we drop the file extent items.
	62	*/
	63	bool clear_extent_range;
d9ac19c3 JB	64	};
d9ac19c3 JB	65
f541833c JB	66	/*
	67	* btrfs_inode_item stores flags in a u64, btrfs_inode stores them in two
	68	* separate u32s. These two functions convert between the two representations.
	69	*/
	70	static inline u64 btrfs_inode_combine_flags(u32 flags, u32 ro_flags)
	71	{
	72	return (flags \| ((u64)ro_flags << 32));
	73	}
	74
	75	static inline void btrfs_inode_split_flags(u64 inode_item_flags,
	76	u32 flags, u32 ro_flags)
	77	{
	78	*flags = (u32)inode_item_flags;
	79	*ro_flags = (u32)(inode_item_flags >> 32);
	80	}
	81
98e4f060 JB	82	/* Figure the key offset of an extended inode ref. */
	83	static inline u64 btrfs_extref_hash(u64 parent_objectid, const char *name, int len)
	84	{
	85	return (u64)crc32c(parent_objectid, name, len);
	86	}
	87
54f03ab1 JB	88	int btrfs_truncate_inode_items(struct btrfs_trans_handle *trans,
54f03ab1 JB	89	struct btrfs_root *root,
d9ac19c3	90	struct btrfs_truncate_control *control);
26c2c454	91	int btrfs_insert_inode_ref(struct btrfs_trans_handle *trans,
6db75318	92	struct btrfs_root root, const struct fscrypt_str name,
26c2c454 JB	93	u64 inode_objectid, u64 ref_objectid, u64 index);
26c2c454 JB	94	int btrfs_del_inode_ref(struct btrfs_trans_handle *trans,
6db75318	95	struct btrfs_root root, const struct fscrypt_str name,
e43eec81	96	u64 inode_objectid, u64 ref_objectid, u64 *index);
26c2c454 JB	97	int btrfs_insert_empty_inode(struct btrfs_trans_handle *trans,
	98	struct btrfs_root *root,
	99	struct btrfs_path *path, u64 objectid);
e43eec81 STD	100	int btrfs_lookup_inode(struct btrfs_trans_handle *trans,
e43eec81 STD	101	struct btrfs_root root, struct btrfs_path path,
26c2c454 JB	102	struct btrfs_key *location, int mod);
	103
	104	struct btrfs_inode_extref *btrfs_lookup_inode_extref(
	105	struct btrfs_trans_handle *trans,
	106	struct btrfs_root *root,
	107	struct btrfs_path *path,
6db75318	108	const struct fscrypt_str *name,
26c2c454 JB	109	u64 inode_objectid, u64 ref_objectid, int ins_len,
	110	int cow);
	111
	112	struct btrfs_inode_ref btrfs_find_name_in_backref(struct extent_buffer leaf,
e43eec81	113	int slot,
6db75318	114	const struct fscrypt_str *name);
26c2c454 JB	115	struct btrfs_inode_extref *btrfs_find_name_in_ext_backref(
26c2c454 JB	116	struct extent_buffer *leaf, int slot, u64 ref_objectid,
6db75318	117	const struct fscrypt_str *name);
26c2c454 JB	118
26c2c454 JB	119	#endif