extents.h 15.7 KB
Newer Older
1 2 3 4 5 6 7 8 9
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _BCACHEFS_EXTENTS_H
#define _BCACHEFS_EXTENTS_H

#include "bcachefs.h"
#include "bkey.h"
#include "extents_types.h"

struct bch_fs;
10
struct btree_trans;
11 12
struct btree_insert_entry;

13
/* extent entries: */
14

15 16
#define extent_entry_last(_e)						\
	((typeof(&(_e).v->start[0])) bkey_val_end(_e))
17

18 19 20 21 22 23 24 25 26
#define entry_to_ptr(_entry)						\
({									\
	EBUG_ON((_entry) && !extent_entry_is_ptr(_entry));		\
									\
	__builtin_choose_expr(						\
		type_is_exact(_entry, const union bch_extent_entry *),	\
		(const struct bch_extent_ptr *) (_entry),		\
		(struct bch_extent_ptr *) (_entry));			\
})
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41
/* downcast, preserves const */
#define to_entry(_entry)						\
({									\
	BUILD_BUG_ON(!type_is(_entry, union bch_extent_crc *) &&	\
		     !type_is(_entry, struct bch_extent_ptr *) &&	\
		     !type_is(_entry, struct bch_extent_stripe_ptr *));	\
									\
	__builtin_choose_expr(						\
		(type_is_exact(_entry, const union bch_extent_crc *) ||	\
		 type_is_exact(_entry, const struct bch_extent_ptr *) ||\
		 type_is_exact(_entry, const struct bch_extent_stripe_ptr *)),\
		(const union bch_extent_entry *) (_entry),		\
		(union bch_extent_entry *) (_entry));			\
})
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

static inline unsigned
__extent_entry_type(const union bch_extent_entry *e)
{
	return e->type ? __ffs(e->type) : BCH_EXTENT_ENTRY_MAX;
}

static inline enum bch_extent_entry_type
extent_entry_type(const union bch_extent_entry *e)
{
	int ret = __ffs(e->type);

	EBUG_ON(ret < 0 || ret >= BCH_EXTENT_ENTRY_MAX);

	return ret;
}

static inline size_t extent_entry_bytes(const union bch_extent_entry *entry)
{
	switch (extent_entry_type(entry)) {
62 63 64 65 66
#define x(f, n)						\
	case BCH_EXTENT_ENTRY_##f:			\
		return sizeof(struct bch_extent_##f);
	BCH_EXTENT_ENTRY_TYPES()
#undef x
67 68 69 70 71 72 73 74 75 76 77 78
	default:
		BUG();
	}
}

static inline size_t extent_entry_u64s(const union bch_extent_entry *entry)
{
	return extent_entry_bytes(entry) / sizeof(u64);
}

static inline bool extent_entry_is_ptr(const union bch_extent_entry *e)
{
79 80 81 82 83 84
	switch (extent_entry_type(e)) {
	case BCH_EXTENT_ENTRY_ptr:
		return true;
	default:
		return false;
	}
85 86 87 88
}

static inline bool extent_entry_is_crc(const union bch_extent_entry *e)
{
89 90 91 92 93 94 95 96
	switch (extent_entry_type(e)) {
	case BCH_EXTENT_ENTRY_crc32:
	case BCH_EXTENT_ENTRY_crc64:
	case BCH_EXTENT_ENTRY_crc128:
		return true;
	default:
		return false;
	}
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
}

union bch_extent_crc {
	u8				type;
	struct bch_extent_crc32		crc32;
	struct bch_extent_crc64		crc64;
	struct bch_extent_crc128	crc128;
};

#define __entry_to_crc(_entry)						\
	__builtin_choose_expr(						\
		type_is_exact(_entry, const union bch_extent_entry *),	\
		(const union bch_extent_crc *) (_entry),		\
		(union bch_extent_crc *) (_entry))

#define entry_to_crc(_entry)						\
({									\
	EBUG_ON((_entry) && !extent_entry_is_crc(_entry));		\
									\
	__entry_to_crc(_entry);						\
})

static inline struct bch_extent_crc_unpacked
bch2_extent_crc_unpack(const struct bkey *k, const union bch_extent_crc *crc)
{
#define common_fields(_crc)						\
		.csum_type		= _crc.csum_type,		\
		.compression_type	= _crc.compression_type,	\
		.compressed_size	= _crc._compressed_size + 1,	\
		.uncompressed_size	= _crc._uncompressed_size + 1,	\
		.offset			= _crc.offset,			\
		.live_size		= k->size

130
	if (!crc)
131 132 133 134 135
		return (struct bch_extent_crc_unpacked) {
			.compressed_size	= k->size,
			.uncompressed_size	= k->size,
			.live_size		= k->size,
		};
136 137 138

	switch (extent_entry_type(to_entry(crc))) {
	case BCH_EXTENT_ENTRY_crc32: {
139 140 141 142 143 144 145 146 147 148 149
		struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
			common_fields(crc->crc32),
		};

		*((__le32 *) &ret.csum.lo) = crc->crc32.csum;

		memcpy(&ret.csum.lo, &crc->crc32.csum,
		       sizeof(crc->crc32.csum));

		return ret;
	}
150
	case BCH_EXTENT_ENTRY_crc64: {
151 152 153 154 155 156 157 158 159 160
		struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
			common_fields(crc->crc64),
			.nonce			= crc->crc64.nonce,
			.csum.lo		= (__force __le64) crc->crc64.csum_lo,
		};

		*((__le16 *) &ret.csum.hi) = crc->crc64.csum_hi;

		return ret;
	}
161
	case BCH_EXTENT_ENTRY_crc128: {
162 163 164 165 166 167 168 169 170 171 172 173 174 175
		struct bch_extent_crc_unpacked ret = (struct bch_extent_crc_unpacked) {
			common_fields(crc->crc128),
			.nonce			= crc->crc128.nonce,
			.csum			= crc->crc128.csum,
		};

		return ret;
	}
	default:
		BUG();
	}
#undef common_fields
}

176
/* bkey_ptrs: generically over any key type that has ptrs */
177

178 179 180 181
struct bkey_ptrs_c {
	const union bch_extent_entry	*start;
	const union bch_extent_entry	*end;
};
182

183 184 185 186
struct bkey_ptrs {
	union bch_extent_entry	*start;
	union bch_extent_entry	*end;
};
187

188
/* iterate over bkey ptrs */
189

190 191
#define extent_entry_next(_entry)					\
	((typeof(_entry)) ((void *) (_entry) + extent_entry_bytes(_entry)))
192

193 194 195 196
#define __bkey_extent_entry_for_each_from(_start, _end, _entry)		\
	for ((_entry) = (_start);					\
	     (_entry) < (_end);						\
	     (_entry) = extent_entry_next(_entry))
197

198
#define __bkey_ptr_next(_ptr, _end)					\
199
({									\
200
	typeof(_end) _entry;						\
201
									\
202
	__bkey_extent_entry_for_each_from(to_entry(_ptr), _end, _entry)	\
203 204
		if (extent_entry_is_ptr(_entry))			\
			break;						\
205
									\
206
	_entry < (_end) ? entry_to_ptr(_entry) : NULL;			\
207 208
})

209 210
#define bkey_extent_entry_for_each_from(_p, _entry, _start)		\
	__bkey_extent_entry_for_each_from(_start, (_p).end, _entry)
211

212 213
#define bkey_extent_entry_for_each(_p, _entry)				\
	bkey_extent_entry_for_each_from(_p, _entry, _p.start)
214

215 216 217 218
#define __bkey_for_each_ptr(_start, _end, _ptr)				\
	for ((_ptr) = (_start);						\
	     ((_ptr) = __bkey_ptr_next(_ptr, _end));			\
	     (_ptr)++)
219

220 221
#define bkey_ptr_next(_p, _ptr)						\
	__bkey_ptr_next(_ptr, (_p).end)
222

223 224
#define bkey_for_each_ptr(_p, _ptr)					\
	__bkey_for_each_ptr(&(_p).start->ptr, (_p).end, _ptr)
225

226
#define __bkey_ptr_next_decode(_k, _end, _ptr, _entry)			\
227 228 229
({									\
	__label__ out;							\
									\
230 231 232
	(_ptr).idx	= 0;						\
	(_ptr).ec_nr	= 0;						\
									\
233
	__bkey_extent_entry_for_each_from(_entry, _end, _entry)		\
234 235 236
		switch (extent_entry_type(_entry)) {			\
		case BCH_EXTENT_ENTRY_ptr:				\
			(_ptr).ptr		= _entry->ptr;		\
237
			goto out;					\
238 239 240
		case BCH_EXTENT_ENTRY_crc32:				\
		case BCH_EXTENT_ENTRY_crc64:				\
		case BCH_EXTENT_ENTRY_crc128:				\
241
			(_ptr).crc = bch2_extent_crc_unpack(_k,		\
242 243
					entry_to_crc(_entry));		\
			break;						\
244 245 246
		case BCH_EXTENT_ENTRY_stripe_ptr:			\
			(_ptr).ec[(_ptr).ec_nr++] = _entry->stripe_ptr;	\
			break;						\
247 248
		}							\
out:									\
249
	_entry < (_end);						\
250 251
})

252 253 254 255
#define __bkey_for_each_ptr_decode(_k, _start, _end, _ptr, _entry)	\
	for ((_ptr).crc = bch2_extent_crc_unpack(_k, NULL),		\
	     (_entry) = _start;						\
	     __bkey_ptr_next_decode(_k, _end, _ptr, _entry);		\
256
	     (_entry) = extent_entry_next(_entry))
257

258 259 260
#define bkey_for_each_ptr_decode(_k, _p, _ptr, _entry)			\
	__bkey_for_each_ptr_decode(_k, (_p).start, (_p).end,		\
				   _ptr, _entry)
261

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
#define bkey_crc_next(_k, _start, _end, _crc, _iter)			\
({									\
	__bkey_extent_entry_for_each_from(_iter, _end, _iter)		\
		if (extent_entry_is_crc(_iter)) {			\
			(_crc) = bch2_extent_crc_unpack(_k,		\
						entry_to_crc(_iter));	\
			break;						\
		}							\
									\
	(_iter) < (_end);						\
})

#define __bkey_for_each_crc(_k, _start, _end, _crc, _iter)		\
	for ((_crc) = bch2_extent_crc_unpack(_k, NULL),			\
	     (_iter) = (_start);					\
	     bkey_crc_next(_k, _start, _end, _crc, _iter);		\
	     (_iter) = extent_entry_next(_iter))

#define bkey_for_each_crc(_k, _p, _crc, _iter)				\
	__bkey_for_each_crc(_k, (_p).start, (_p).end, _crc, _iter)

283
/* utility code common to all keys with pointers: */
284

285
static inline struct bkey_ptrs_c bch2_bkey_ptrs_c(struct bkey_s_c k)
286
{
287 288 289 290 291
	switch (k.k->type) {
	case KEY_TYPE_btree_ptr: {
		struct bkey_s_c_btree_ptr e = bkey_s_c_to_btree_ptr(k);
		return (struct bkey_ptrs_c) {
			to_entry(&e.v->start[0]),
292
			to_entry(extent_entry_last(e))
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
		};
	}
	case KEY_TYPE_extent: {
		struct bkey_s_c_extent e = bkey_s_c_to_extent(k);
		return (struct bkey_ptrs_c) {
			e.v->start,
			extent_entry_last(e)
		};
	}
	case KEY_TYPE_stripe: {
		struct bkey_s_c_stripe s = bkey_s_c_to_stripe(k);
		return (struct bkey_ptrs_c) {
			to_entry(&s.v->ptrs[0]),
			to_entry(&s.v->ptrs[s.v->nr_blocks]),
		};
	}
Kent Overstreet's avatar
Kent Overstreet committed
309 310 311 312 313 314 315 316
	case KEY_TYPE_reflink_v: {
		struct bkey_s_c_reflink_v r = bkey_s_c_to_reflink_v(k);

		return (struct bkey_ptrs_c) {
			r.v->start,
			bkey_val_end(r),
		};
	}
317 318 319
	default:
		return (struct bkey_ptrs_c) { NULL, NULL };
	}
320 321
}

322
static inline struct bkey_ptrs bch2_bkey_ptrs(struct bkey_s k)
323
{
324 325 326 327 328 329
	struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k.s_c);

	return (struct bkey_ptrs) {
		(void *) p.start,
		(void *) p.end
	};
330 331
}

332
static inline struct bch_devs_list bch2_bkey_devs(struct bkey_s_c k)
333 334
{
	struct bch_devs_list ret = (struct bch_devs_list) { 0 };
335
	struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
336 337
	const struct bch_extent_ptr *ptr;

338
	bkey_for_each_ptr(p, ptr)
339 340 341 342 343
		ret.devs[ret.nr++] = ptr->dev;

	return ret;
}

344
static inline struct bch_devs_list bch2_bkey_dirty_devs(struct bkey_s_c k)
345 346
{
	struct bch_devs_list ret = (struct bch_devs_list) { 0 };
347
	struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
348 349
	const struct bch_extent_ptr *ptr;

350
	bkey_for_each_ptr(p, ptr)
351 352 353 354 355 356
		if (!ptr->cached)
			ret.devs[ret.nr++] = ptr->dev;

	return ret;
}

357
static inline struct bch_devs_list bch2_bkey_cached_devs(struct bkey_s_c k)
358 359
{
	struct bch_devs_list ret = (struct bch_devs_list) { 0 };
360
	struct bkey_ptrs_c p = bch2_bkey_ptrs_c(k);
361 362
	const struct bch_extent_ptr *ptr;

363
	bkey_for_each_ptr(p, ptr)
364 365 366 367 368 369
		if (ptr->cached)
			ret.devs[ret.nr++] = ptr->dev;

	return ret;
}

370 371 372 373 374 375 376 377 378 379
unsigned bch2_bkey_nr_ptrs(struct bkey_s_c);
unsigned bch2_bkey_nr_dirty_ptrs(struct bkey_s_c);
unsigned bch2_bkey_durability(struct bch_fs *, struct bkey_s_c);

void bch2_mark_io_failure(struct bch_io_failures *,
			  struct extent_ptr_decoded *);
int bch2_bkey_pick_read_device(struct bch_fs *, struct bkey_s_c,
			       struct bch_io_failures *,
			       struct extent_ptr_decoded *);

380 381 382 383 384
void bch2_bkey_append_ptr(struct bkey_i *, struct bch_extent_ptr);
void bch2_bkey_drop_device(struct bkey_s, unsigned);
const struct bch_extent_ptr *bch2_bkey_has_device(struct bkey_s_c, unsigned);
bool bch2_bkey_has_target(struct bch_fs *, struct bkey_s_c, unsigned);

385 386 387 388
void bch2_bkey_ptrs_to_text(struct printbuf *, struct bch_fs *,
			    struct bkey_s_c);
const char *bch2_bkey_ptrs_invalid(const struct bch_fs *, struct bkey_s_c);

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
/* bch_btree_ptr: */

const char *bch2_btree_ptr_invalid(const struct bch_fs *, struct bkey_s_c);
void bch2_btree_ptr_debugcheck(struct bch_fs *, struct btree *,
			       struct bkey_s_c);
void bch2_btree_ptr_to_text(struct printbuf *, struct bch_fs *,
			    struct bkey_s_c);
void bch2_ptr_swab(const struct bkey_format *, struct bkey_packed *);

#define bch2_bkey_ops_btree_ptr (struct bkey_ops) {		\
	.key_invalid	= bch2_btree_ptr_invalid,		\
	.key_debugcheck	= bch2_btree_ptr_debugcheck,		\
	.val_to_text	= bch2_btree_ptr_to_text,		\
	.swab		= bch2_ptr_swab,			\
}

/* bch_extent: */

const char *bch2_extent_invalid(const struct bch_fs *, struct bkey_s_c);
void bch2_extent_debugcheck(struct bch_fs *, struct btree *, struct bkey_s_c);
void bch2_extent_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
bool bch2_extent_normalize(struct bch_fs *, struct bkey_s);
enum merge_result bch2_extent_merge(struct bch_fs *,
412
				    struct bkey_s, struct bkey_s);
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

#define bch2_bkey_ops_extent (struct bkey_ops) {		\
	.key_invalid	= bch2_extent_invalid,			\
	.key_debugcheck	= bch2_extent_debugcheck,		\
	.val_to_text	= bch2_extent_to_text,			\
	.swab		= bch2_ptr_swab,			\
	.key_normalize	= bch2_extent_normalize,		\
	.key_merge	= bch2_extent_merge,			\
}

/* bch_reservation: */

const char *bch2_reservation_invalid(const struct bch_fs *, struct bkey_s_c);
void bch2_reservation_to_text(struct printbuf *, struct bch_fs *, struct bkey_s_c);
enum merge_result bch2_reservation_merge(struct bch_fs *,
428
					 struct bkey_s, struct bkey_s);
429 430 431 432 433 434 435

#define bch2_bkey_ops_reservation (struct bkey_ops) {		\
	.key_invalid	= bch2_reservation_invalid,		\
	.val_to_text	= bch2_reservation_to_text,		\
	.key_merge	= bch2_reservation_merge,		\
}

436 437 438 439
int bch2_extent_atomic_end(struct btree_trans *, struct btree_iter *,
			   struct bkey_i *, struct bpos *);
int bch2_extent_trim_atomic(struct bkey_i *, struct btree_iter *);
int bch2_extent_is_atomic(struct bkey_i *, struct btree_iter *);
440 441

enum btree_insert_ret
442
bch2_extent_can_insert(struct btree_trans *, struct btree_insert_entry *,
443
		       unsigned *);
444
void bch2_insert_fixup_extent(struct btree_trans *,
445
			      struct btree_insert_entry *);
446

Kent Overstreet's avatar
Kent Overstreet committed
447 448
void bch2_bkey_mark_replicas_cached(struct bch_fs *, struct bkey_s,
				    unsigned, unsigned);
449 450 451 452 453 454

const struct bch_extent_ptr *
bch2_extent_has_device(struct bkey_s_c_extent, unsigned);

unsigned bch2_extent_is_compressed(struct bkey_s_c);

455 456
bool bch2_bkey_matches_ptr(struct bch_fs *, struct bkey_s_c,
			   struct bch_extent_ptr, u64);
457 458 459 460 461 462

static inline bool bkey_extent_is_data(const struct bkey *k)
{
	switch (k->type) {
	case KEY_TYPE_btree_ptr:
	case KEY_TYPE_extent:
Kent Overstreet's avatar
Kent Overstreet committed
463 464
	case KEY_TYPE_reflink_p:
	case KEY_TYPE_reflink_v:
465
		return true;
466
	default:
467
		return false;
468 469 470
	}
}

Kent Overstreet's avatar
Kent Overstreet committed
471 472 473
/*
 * Should extent be counted under inode->i_sectors?
 */
474
static inline bool bkey_extent_is_allocation(const struct bkey *k)
475
{
476 477 478
	switch (k->type) {
	case KEY_TYPE_extent:
	case KEY_TYPE_reservation:
Kent Overstreet's avatar
Kent Overstreet committed
479 480
	case KEY_TYPE_reflink_p:
	case KEY_TYPE_reflink_v:
481
		return true;
482
	default:
483
		return false;
484 485 486
	}
}

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
/* Extent entry iteration: */

#define extent_for_each_entry_from(_e, _entry, _start)			\
	__bkey_extent_entry_for_each_from(_start,			\
				extent_entry_last(_e),_entry)

#define extent_for_each_entry(_e, _entry)				\
	extent_for_each_entry_from(_e, _entry, (_e).v->start)

#define extent_ptr_next(_e, _ptr)					\
	__bkey_ptr_next(_ptr, extent_entry_last(_e))

#define extent_for_each_ptr(_e, _ptr)					\
	__bkey_for_each_ptr(&(_e).v->start->ptr, extent_entry_last(_e), _ptr)

#define extent_for_each_ptr_decode(_e, _ptr, _entry)			\
	__bkey_for_each_ptr_decode((_e).k, (_e).v->start,		\
				   extent_entry_last(_e), _ptr, _entry)

506
void bch2_extent_crc_append(struct bkey_i *,
507
			    struct bch_extent_crc_unpacked);
508
void bch2_extent_ptr_decoded_append(struct bkey_i *,
509 510
				    struct extent_ptr_decoded *);

511
bool bch2_can_narrow_extent_crcs(struct bkey_s_c,
512
				 struct bch_extent_crc_unpacked);
513
bool bch2_bkey_narrow_crcs(struct bkey_i *, struct bch_extent_crc_unpacked);
514

515 516
union bch_extent_entry *bch2_bkey_drop_ptr(struct bkey_s,
					   struct bch_extent_ptr *);
517

518
#define bch2_bkey_drop_ptrs(_k, _ptr, _cond)				\
519
do {									\
520 521 522
	struct bkey_ptrs _ptrs = bch2_bkey_ptrs(_k);			\
									\
	_ptr = &_ptrs.start->ptr;					\
523
									\
524
	while ((_ptr = bkey_ptr_next(_ptrs, _ptr))) {			\
525
		if (_cond) {						\
526 527
			_ptr = (void *) bch2_bkey_drop_ptr(_k, _ptr);	\
			_ptrs = bch2_bkey_ptrs(_k);			\
528 529 530 531 532 533
			continue;					\
		}							\
									\
		(_ptr)++;						\
	}								\
} while (0)
534

535
void __bch2_cut_front(struct bpos, struct bkey_s);
536

537
static inline void bch2_cut_front(struct bpos where, struct bkey_i *k)
538
{
539
	__bch2_cut_front(where, bkey_i_to_s(k));
540 541
}

542
bool bch2_cut_back(struct bpos, struct bkey *);
543 544 545 546 547 548 549 550 551 552 553 554

/**
 * bch_key_resize - adjust size of @k
 *
 * bkey_start_offset(k) will be preserved, modifies where the extent ends
 */
static inline void bch2_key_resize(struct bkey *k, unsigned new_size)
{
	k->p.offset -= k->size;
	k->p.offset += new_size;
	k->size = new_size;
}
555

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
/*
 * In extent_sort_fix_overlapping(), insert_fixup_extent(),
 * extent_merge_inline() - we're modifying keys in place that are packed. To do
 * that we have to unpack the key, modify the unpacked key - then this
 * copies/repacks the unpacked to the original as necessary.
 */
static inline void extent_save(struct btree *b, struct bkey_packed *dst,
			       struct bkey *src)
{
	struct bkey_format *f = &b->format;
	struct bkey_i *dst_unpacked;

	if ((dst_unpacked = packed_to_bkey(dst)))
		dst_unpacked->k = *src;
	else
		BUG_ON(!bch2_bkey_pack_key(dst, src, f));
}

574 575
bool bch2_check_range_allocated(struct bch_fs *, struct bpos, u64, unsigned);
unsigned bch2_bkey_nr_ptrs_allocated(struct bkey_s_c);
576 577

#endif /* _BCACHEFS_EXTENTS_H */