[linux-block.git] / fs / bcachefs / bkey_methods.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _BCACHEFS_BKEY_METHODS_H
#define _BCACHEFS_BKEY_METHODS_H

#include "bkey.h"

struct bch_fs;
struct btree;
struct bkey;
enum btree_node_type;

extern const char * const bch_bkey_types[];

enum merge_result {
	BCH_MERGE_NOMERGE,

	/*
	 * The keys were mergeable, but would have overflowed size - so instead
	 * l was changed to the maximum size, and both keys were modified:
	 */
	BCH_MERGE_PARTIAL,
	BCH_MERGE_MERGE,
};

struct bkey_ops {
	/* Returns reason for being invalid if invalid, else NULL: */
	const char *	(*key_invalid)(const struct bch_fs *,
				       struct bkey_s_c);
	void		(*key_debugcheck)(struct bch_fs *, struct btree *,
					  struct bkey_s_c);
	void		(*val_to_text)(struct printbuf *, struct bch_fs *,
				       struct bkey_s_c);
	void		(*swab)(const struct bkey_format *, struct bkey_packed *);
	bool		(*key_normalize)(struct bch_fs *, struct bkey_s);
	enum merge_result (*key_merge)(struct bch_fs *,
				       struct bkey_i *, struct bkey_i *);
};

const char *bch2_bkey_val_invalid(struct bch_fs *, struct bkey_s_c);
const char *__bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
				enum btree_node_type);
const char *bch2_bkey_invalid(struct bch_fs *, struct bkey_s_c,
			      enum btree_node_type);
const char *bch2_bkey_in_btree_node(struct btree *, struct bkey_s_c);

void bch2_bkey_debugcheck(struct bch_fs *, struct btree *, struct bkey_s_c);

void bch2_bpos_to_text(struct printbuf *, struct bpos);
void bch2_bkey_to_text(struct printbuf *, const struct bkey *);
void bch2_val_to_text(struct printbuf *, struct bch_fs *,
		      struct bkey_s_c);
void bch2_bkey_val_to_text(struct printbuf *, struct bch_fs *,
			   struct bkey_s_c);

void bch2_bkey_swab(const struct bkey_format *, struct bkey_packed *);

bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s);

enum merge_result bch2_bkey_merge(struct bch_fs *,
				  struct bkey_i *, struct bkey_i *);

void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int);

#endif /* _BCACHEFS_BKEY_METHODS_H */
Commit	Line	Data
1c6fdbd8 KO	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	#ifndef _BCACHEFS_BKEY_METHODS_H
	3	#define _BCACHEFS_BKEY_METHODS_H
	4
	5	#include "bkey.h"
	6
1c6fdbd8 KO	7	struct bch_fs;
	8	struct btree;
	9	struct bkey;
26609b61 KO	10	enum btree_node_type;
	11
	12	extern const char * const bch_bkey_types[];
1c6fdbd8 KO	13
	14	enum merge_result {
	15	BCH_MERGE_NOMERGE,
	16
	17	/*
	18	* The keys were mergeable, but would have overflowed size - so instead
	19	* l was changed to the maximum size, and both keys were modified:
	20	*/
	21	BCH_MERGE_PARTIAL,
	22	BCH_MERGE_MERGE,
	23	};
	24
1c6fdbd8 KO	25	struct bkey_ops {
	26	/* Returns reason for being invalid if invalid, else NULL: */
	27	const char * (key_invalid)(const struct bch_fs ,
	28	struct bkey_s_c);
	29	void (key_debugcheck)(struct bch_fs , struct btree *,
	30	struct bkey_s_c);
319f9ac3 KO	31	void (val_to_text)(struct printbuf , struct bch_fs *,
319f9ac3 KO	32	struct bkey_s_c);
1c6fdbd8	33	void (swab)(const struct bkey_format , struct bkey_packed *);
26609b61 KO	34	bool (key_normalize)(struct bch_fs , struct bkey_s);
	35	enum merge_result (key_merge)(struct bch_fs ,
	36	struct bkey_i , struct bkey_i );
1c6fdbd8 KO	37	};
1c6fdbd8 KO	38
26609b61 KO	39	const char bch2_bkey_val_invalid(struct bch_fs , struct bkey_s_c);
	40	const char __bch2_bkey_invalid(struct bch_fs , struct bkey_s_c,
	41	enum btree_node_type);
	42	const char bch2_bkey_invalid(struct bch_fs , struct bkey_s_c,
	43	enum btree_node_type);
1c6fdbd8 KO	44	const char bch2_bkey_in_btree_node(struct btree , struct bkey_s_c);
	45
	46	void bch2_bkey_debugcheck(struct bch_fs , struct btree , struct bkey_s_c);
	47
319f9ac3 KO	48	void bch2_bpos_to_text(struct printbuf *, struct bpos);
319f9ac3 KO	49	void bch2_bkey_to_text(struct printbuf , const struct bkey );
26609b61	50	void bch2_val_to_text(struct printbuf , struct bch_fs ,
319f9ac3 KO	51	struct bkey_s_c);
319f9ac3 KO	52	void bch2_bkey_val_to_text(struct printbuf , struct bch_fs ,
26609b61 KO	53	struct bkey_s_c);
	54
	55	void bch2_bkey_swab(const struct bkey_format , struct bkey_packed );
	56
	57	bool bch2_bkey_normalize(struct bch_fs *, struct bkey_s);
1c6fdbd8	58
26609b61 KO	59	enum merge_result bch2_bkey_merge(struct bch_fs *,
26609b61 KO	60	struct bkey_i , struct bkey_i );
1c6fdbd8	61
26609b61	62	void bch2_bkey_renumber(enum btree_node_type, struct bkey_packed *, int);
1c6fdbd8 KO	63
1c6fdbd8 KO	64	#endif /* _BCACHEFS_BKEY_METHODS_H */