linux/fs/bcachefs/bkey.h

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

#include <linux/bug.h>
#include "bcachefs_format.h"
#include "bkey_types.h"
#include "btree_types.h"
#include "util.h"
#include "vstructs.h"

enum bch_validate_flags { … };

#if 0

/*
 * compiled unpack functions are disabled, pending a new interface for
 * dynamically allocating executable memory:
 */

#ifdef CONFIG_X86_64
#define HAVE_BCACHEFS_COMPILED_UNPACK …
#endif
#endif

void bch2_bkey_packed_to_binary_text(struct printbuf *,
				     const struct bkey_format *,
				     const struct bkey_packed *);

enum bkey_lr_packed { … };

#define bkey_lr_packed(_l, _r) …

static inline void bkey_p_copy(struct bkey_packed *dst, const struct bkey_packed *src)
{ … }

static inline void bkey_copy(struct bkey_i *dst, const struct bkey_i *src)
{ … }

struct btree;

__pure
unsigned bch2_bkey_greatest_differing_bit(const struct btree *,
					  const struct bkey_packed *,
					  const struct bkey_packed *);
__pure
unsigned bch2_bkey_ffs(const struct btree *, const struct bkey_packed *);

__pure
int __bch2_bkey_cmp_packed_format_checked(const struct bkey_packed *,
				     const struct bkey_packed *,
				     const struct btree *);

__pure
int __bch2_bkey_cmp_left_packed_format_checked(const struct btree *,
					  const struct bkey_packed *,
					  const struct bpos *);

__pure
int bch2_bkey_cmp_packed(const struct btree *,
			 const struct bkey_packed *,
			 const struct bkey_packed *);

__pure
int __bch2_bkey_cmp_left_packed(const struct btree *,
				const struct bkey_packed *,
				const struct bpos *);

static inline __pure
int bkey_cmp_left_packed(const struct btree *b,
			 const struct bkey_packed *l, const struct bpos *r)
{ … }

/*
 * The compiler generates better code when we pass bpos by ref, but it's often
 * enough terribly convenient to pass it by val... as much as I hate c++, const
 * ref would be nice here:
 */
__pure __flatten
static inline int bkey_cmp_left_packed_byval(const struct btree *b,
					     const struct bkey_packed *l,
					     struct bpos r)
{ … }

static __always_inline bool bpos_eq(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bpos_lt(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bpos_le(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bpos_gt(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bpos_ge(struct bpos l, struct bpos r)
{ … }

static __always_inline int bpos_cmp(struct bpos l, struct bpos r)
{ … }

static inline struct bpos bpos_min(struct bpos l, struct bpos r)
{ … }

static inline struct bpos bpos_max(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bkey_eq(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bkey_lt(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bkey_le(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bkey_gt(struct bpos l, struct bpos r)
{ … }

static __always_inline bool bkey_ge(struct bpos l, struct bpos r)
{ … }

static __always_inline int bkey_cmp(struct bpos l, struct bpos r)
{ … }

static inline struct bpos bkey_min(struct bpos l, struct bpos r)
{ … }

static inline struct bpos bkey_max(struct bpos l, struct bpos r)
{ … }

static inline bool bkey_and_val_eq(struct bkey_s_c l, struct bkey_s_c r)
{ … }

void bch2_bpos_swab(struct bpos *);
void bch2_bkey_swab_key(const struct bkey_format *, struct bkey_packed *);

static __always_inline int bversion_cmp(struct bversion l, struct bversion r)
{ … }

#define ZERO_VERSION …
#define MAX_VERSION …

static __always_inline int bversion_zero(struct bversion v)
{ … }

#ifdef CONFIG_BCACHEFS_DEBUG
/* statement expressions confusing unlikely()? */
#define bkey_packed(_k) …
#else
#define bkey_packed …
#endif

/*
 * It's safe to treat an unpacked bkey as a packed one, but not the reverse
 */
static inline struct bkey_packed *bkey_to_packed(struct bkey_i *k)
{ … }

static inline const struct bkey_packed *bkey_to_packed_c(const struct bkey_i *k)
{ … }

static inline struct bkey_i *packed_to_bkey(struct bkey_packed *k)
{ … }

static inline const struct bkey *packed_to_bkey_c(const struct bkey_packed *k)
{ … }

static inline unsigned bkey_format_key_bits(const struct bkey_format *format)
{ … }

static inline struct bpos bpos_successor(struct bpos p)
{ … }

static inline struct bpos bpos_predecessor(struct bpos p)
{ … }

static inline struct bpos bpos_nosnap_successor(struct bpos p)
{ … }

static inline struct bpos bpos_nosnap_predecessor(struct bpos p)
{ … }

static inline u64 bkey_start_offset(const struct bkey *k)
{ … }

static inline struct bpos bkey_start_pos(const struct bkey *k)
{ … }

/* Packed helpers */

static inline unsigned bkeyp_key_u64s(const struct bkey_format *format,
				      const struct bkey_packed *k)
{ … }

static inline bool bkeyp_u64s_valid(const struct bkey_format *f,
				    const struct bkey_packed *k)
{ … }

static inline unsigned bkeyp_key_bytes(const struct bkey_format *format,
				       const struct bkey_packed *k)
{ … }

static inline unsigned bkeyp_val_u64s(const struct bkey_format *format,
				      const struct bkey_packed *k)
{ … }

static inline size_t bkeyp_val_bytes(const struct bkey_format *format,
				     const struct bkey_packed *k)
{ … }

static inline void set_bkeyp_val_u64s(const struct bkey_format *format,
				      struct bkey_packed *k, unsigned val_u64s)
{ … }

#define bkeyp_val(_format, _k) …

extern const struct bkey_format bch2_bkey_format_current;

bool bch2_bkey_transform(const struct bkey_format *,
			 struct bkey_packed *,
			 const struct bkey_format *,
			 const struct bkey_packed *);

struct bkey __bch2_bkey_unpack_key(const struct bkey_format *,
				   const struct bkey_packed *);

#ifndef HAVE_BCACHEFS_COMPILED_UNPACK
struct bpos __bkey_unpack_pos(const struct bkey_format *,
			      const struct bkey_packed *);
#endif

bool bch2_bkey_pack_key(struct bkey_packed *, const struct bkey *,
		   const struct bkey_format *);

enum bkey_pack_pos_ret { … };

enum bkey_pack_pos_ret bch2_bkey_pack_pos_lossy(struct bkey_packed *, struct bpos,
					   const struct btree *);

static inline bool bkey_pack_pos(struct bkey_packed *out, struct bpos in,
				 const struct btree *b)
{ … }

void bch2_bkey_unpack(const struct btree *, struct bkey_i *,
		 const struct bkey_packed *);
bool bch2_bkey_pack(struct bkey_packed *, const struct bkey_i *,
	       const struct bkey_format *);

compiled_unpack_fn;

static inline void
__bkey_unpack_key_format_checked(const struct btree *b,
			       struct bkey *dst,
			       const struct bkey_packed *src)
{ … }

static inline struct bkey
bkey_unpack_key_format_checked(const struct btree *b,
			       const struct bkey_packed *src)
{ … }

static inline void __bkey_unpack_key(const struct btree *b,
				     struct bkey *dst,
				     const struct bkey_packed *src)
{ … }

/**
 * bkey_unpack_key -- unpack just the key, not the value
 */
static inline struct bkey bkey_unpack_key(const struct btree *b,
					  const struct bkey_packed *src)
{ … }

static inline struct bpos
bkey_unpack_pos_format_checked(const struct btree *b,
			       const struct bkey_packed *src)
{ … }

static inline struct bpos bkey_unpack_pos(const struct btree *b,
					  const struct bkey_packed *src)
{ … }

/* Disassembled bkeys */

static inline struct bkey_s_c bkey_disassemble(const struct btree *b,
					       const struct bkey_packed *k,
					       struct bkey *u)
{ … }

/* non const version: */
static inline struct bkey_s __bkey_disassemble(const struct btree *b,
					       struct bkey_packed *k,
					       struct bkey *u)
{ … }

static inline u64 bkey_field_max(const struct bkey_format *f,
				 enum bch_bkey_fields nr)
{ … }

#ifdef HAVE_BCACHEFS_COMPILED_UNPACK

int bch2_compile_bkey_format(const struct bkey_format *, void *);

#else

static inline int bch2_compile_bkey_format(const struct bkey_format *format,
					  void *out) { … }

#endif

static inline void bkey_reassemble(struct bkey_i *dst,
				   struct bkey_s_c src)
{ … }

/* byte order helpers */

#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__

static inline unsigned high_word_offset(const struct bkey_format *f)
{ … }

#define high_bit_offset …
#define nth_word(p, n) …

#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__

static inline unsigned high_word_offset(const struct bkey_format *f)
{
	return 0;
}

#define high_bit_offset …
#define nth_word …

#else
#error edit for your odd byteorder.
#endif

#define high_word(f, k) …
#define next_word(p) …
#define prev_word(p) …

#ifdef CONFIG_BCACHEFS_DEBUG
void bch2_bkey_pack_test(void);
#else
static inline void bch2_bkey_pack_test(void) {}
#endif

#define bkey_fields() …

struct bkey_format_state { … };

void bch2_bkey_format_init(struct bkey_format_state *);

static inline void __bkey_format_add(struct bkey_format_state *s, unsigned field, u64 v)
{ … }

/*
 * Changes @format so that @k can be successfully packed with @format
 */
static inline void bch2_bkey_format_add_key(struct bkey_format_state *s, const struct bkey *k)
{ … }

void bch2_bkey_format_add_pos(struct bkey_format_state *, struct bpos);
struct bkey_format bch2_bkey_format_done(struct bkey_format_state *);

static inline bool bch2_bkey_format_field_overflows(struct bkey_format *f, unsigned i)
{ … }

int bch2_bkey_format_invalid(struct bch_fs *, struct bkey_format *,
			     enum bch_validate_flags, struct printbuf *);
void bch2_bkey_format_to_text(struct printbuf *, const struct bkey_format *);

#endif /* _BCACHEFS_BKEY_H */