git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/journal.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_JOURNAL_H
   3 #define _BCACHEFS_JOURNAL_H
   4
   5 /*
   6  * THE JOURNAL:
   7  *
   8  * The primary purpose of the journal is to log updates (insertions) to the
   9  * b-tree, to avoid having to do synchronous updates to the b-tree on disk.
  10  *
  11  * Without the journal, the b-tree is always internally consistent on
  12  * disk - and in fact, in the earliest incarnations bcache didn't have a journal
  13  * but did handle unclean shutdowns by doing all index updates synchronously
  14  * (with coalescing).
  15  *
  16  * Updates to interior nodes still happen synchronously and without the journal
  17  * (for simplicity) - this may change eventually but updates to interior nodes
  18  * are rare enough it's not a huge priority.
  19  *
  20  * This means the journal is relatively separate from the b-tree; it consists of
  21  * just a list of keys and journal replay consists of just redoing those
  22  * insertions in same order that they appear in the journal.
  23  *
  24  * PERSISTENCE:
  25  *
  26  * For synchronous updates (where we're waiting on the index update to hit
  27  * disk), the journal entry will be written out immediately (or as soon as
  28  * possible, if the write for the previous journal entry was still in flight).
  29  *
  30  * Synchronous updates are specified by passing a closure (@flush_cl) to
  31  * bch2_btree_insert() or bch_btree_insert_node(), which then pass that parameter
  32  * down to the journalling code. That closure will will wait on the journal
  33  * write to complete (via closure_wait()).
  34  *
  35  * If the index update wasn't synchronous, the journal entry will be
  36  * written out after 10 ms have elapsed, by default (the delay_ms field
  37  * in struct journal).
  38  *
  39  * JOURNAL ENTRIES:
  40  *
  41  * A journal entry is variable size (struct jset), it's got a fixed length
  42  * header and then a variable number of struct jset_entry entries.
  43  *
  44  * Journal entries are identified by monotonically increasing 64 bit sequence
  45  * numbers - jset->seq; other places in the code refer to this sequence number.
  46  *
  47  * A jset_entry entry contains one or more bkeys (which is what gets inserted
  48  * into the b-tree). We need a container to indicate which b-tree the key is
  49  * for; also, the roots of the various b-trees are stored in jset_entry entries
  50  * (one for each b-tree) - this lets us add new b-tree types without changing
  51  * the on disk format.
  52  *
  53  * We also keep some things in the journal header that are logically part of the
  54  * superblock - all the things that are frequently updated. This is for future
  55  * bcache on raw flash support; the superblock (which will become another
  56  * journal) can't be moved or wear leveled, so it contains just enough
  57  * information to find the main journal, and the superblock only has to be
  58  * rewritten when we want to move/wear level the main journal.
  59  *
  60  * JOURNAL LAYOUT ON DISK:
  61  *
  62  * The journal is written to a ringbuffer of buckets (which is kept in the
  63  * superblock); the individual buckets are not necessarily contiguous on disk
  64  * which means that journal entries are not allowed to span buckets, but also
  65  * that we can resize the journal at runtime if desired (unimplemented).
  66  *
  67  * The journal buckets exist in the same pool as all the other buckets that are
  68  * managed by the allocator and garbage collection - garbage collection marks
  69  * the journal buckets as metadata buckets.
  70  *
  71  * OPEN/DIRTY JOURNAL ENTRIES:
  72  *
  73  * Open/dirty journal entries are journal entries that contain b-tree updates
  74  * that have not yet been written out to the b-tree on disk. We have to track
  75  * which journal entries are dirty, and we also have to avoid wrapping around
  76  * the journal and overwriting old but still dirty journal entries with new
  77  * journal entries.
  78  *
  79  * On disk, this is represented with the "last_seq" field of struct jset;
  80  * last_seq is the first sequence number that journal replay has to replay.
  81  *
  82  * To avoid overwriting dirty journal entries on disk, we keep a mapping (in
  83  * journal_device->seq) of for each journal bucket, the highest sequence number
  84  * any journal entry it contains. Then, by comparing that against last_seq we
  85  * can determine whether that journal bucket contains dirty journal entries or
  86  * not.
  87  *
  88  * To track which journal entries are dirty, we maintain a fifo of refcounts
  89  * (where each entry corresponds to a specific sequence number) - when a ref
  90  * goes to 0, that journal entry is no longer dirty.
  91  *
  92  * Journalling of index updates is done at the same time as the b-tree itself is
  93  * being modified (see btree_insert_key()); when we add the key to the journal
  94  * the pending b-tree write takes a ref on the journal entry the key was added
  95  * to. If a pending b-tree write would need to take refs on multiple dirty
  96  * journal entries, it only keeps the ref on the oldest one (since a newer
  97  * journal entry will still be replayed if an older entry was dirty).
  98  *
  99  * JOURNAL FILLING UP:
 100  *
 101  * There are two ways the journal could fill up; either we could run out of
 102  * space to write to, or we could have too many open journal entries and run out
 103  * of room in the fifo of refcounts. Since those refcounts are decremented
 104  * without any locking we can't safely resize that fifo, so we handle it the
 105  * same way.
 106  *
 107  * If the journal fills up, we start flushing dirty btree nodes until we can
 108  * allocate space for a journal write again - preferentially flushing btree
 109  * nodes that are pinning the oldest journal entries first.
 110  */
 111
 112 #include <linux/hash.h>
 113
 114 #include "journal_types.h"
 115
 116 struct bch_fs;
 117
 118 static inline void journal_wake(struct journal *j)
 119 {
 120         wake_up(&j->wait);
 121         closure_wake_up(&j->async_wait);
 122         closure_wake_up(&j->preres_wait);
 123 }
 124
 125 static inline struct journal_buf *journal_cur_buf(struct journal *j)
 126 {
 127         return j->buf + j->reservations.idx;
 128 }
 129
 130 /* Sequence number of oldest dirty journal entry */
 131
 132 static inline u64 journal_last_seq(struct journal *j)
 133 {
 134         return j->pin.front;
 135 }
 136
 137 static inline u64 journal_cur_seq(struct journal *j)
 138 {
 139         EBUG_ON(j->pin.back - 1 != atomic64_read(&j->seq));
 140
 141         return j->pin.back - 1;
 142 }
 143
 144 u64 bch2_inode_journal_seq(struct journal *, u64);
 145 void bch2_journal_set_has_inum(struct journal *, u64, u64);
 146
 147 static inline int journal_state_count(union journal_res_state s, int idx)
 148 {
 149         switch (idx) {
 150         case 0: return s.buf0_count;
 151         case 1: return s.buf1_count;
 152         case 2: return s.buf2_count;
 153         case 3: return s.buf3_count;
 154         }
 155         BUG();
 156 }
 157
 158 static inline void journal_state_inc(union journal_res_state *s)
 159 {
 160         s->buf0_count += s->idx == 0;
 161         s->buf1_count += s->idx == 1;
 162         s->buf2_count += s->idx == 2;
 163         s->buf3_count += s->idx == 3;
 164 }
 165
 166 static inline void bch2_journal_set_has_inode(struct journal *j,
 167                                               struct journal_res *res,
 168                                               u64 inum)
 169 {
 170         struct journal_buf *buf = &j->buf[res->idx];
 171         unsigned long bit = hash_64(inum, ilog2(sizeof(buf->has_inode) * 8));
 172
 173         /* avoid atomic op if possible */
 174         if (unlikely(!test_bit(bit, buf->has_inode)))
 175                 set_bit(bit, buf->has_inode);
 176 }
 177
 178 /*
 179  * Amount of space that will be taken up by some keys in the journal (i.e.
 180  * including the jset header)
 181  */
 182 static inline unsigned jset_u64s(unsigned u64s)
 183 {
 184         return u64s + sizeof(struct jset_entry) / sizeof(u64);
 185 }
 186
 187 static inline int journal_entry_overhead(struct journal *j)
 188 {
 189         return sizeof(struct jset) / sizeof(u64) + j->entry_u64s_reserved;
 190 }
 191
 192 static inline struct jset_entry *
 193 bch2_journal_add_entry_noreservation(struct journal_buf *buf, size_t u64s)
 194 {
 195         struct jset *jset = buf->data;
 196         struct jset_entry *entry = vstruct_idx(jset, le32_to_cpu(jset->u64s));
 197
 198         memset(entry, 0, sizeof(*entry));
 199         entry->u64s = cpu_to_le16(u64s);
 200
 201         le32_add_cpu(&jset->u64s, jset_u64s(u64s));
 202
 203         return entry;
 204 }
 205
 206 static inline struct jset_entry *
 207 journal_res_entry(struct journal *j, struct journal_res *res)
 208 {
 209         return vstruct_idx(j->buf[res->idx].data, res->offset);
 210 }
 211
 212 static inline unsigned journal_entry_set(struct jset_entry *entry, unsigned type,
 213                                           enum btree_id id, unsigned level,
 214                                           const void *data, unsigned u64s)
 215 {
 216         entry->u64s     = cpu_to_le16(u64s);
 217         entry->btree_id = id;
 218         entry->level    = level;
 219         entry->type     = type;
 220         entry->pad[0]   = 0;
 221         entry->pad[1]   = 0;
 222         entry->pad[2]   = 0;
 223         memcpy_u64s_small(entry->_data, data, u64s);
 224
 225         return jset_u64s(u64s);
 226 }
 227
 228 static inline void bch2_journal_add_entry(struct journal *j, struct journal_res *res,
 229                                           unsigned type, enum btree_id id,
 230                                           unsigned level,
 231                                           const void *data, unsigned u64s)
 232 {
 233         unsigned actual = journal_entry_set(journal_res_entry(j, res),
 234                                type, id, level, data, u64s);
 235
 236         EBUG_ON(!res->ref);
 237         EBUG_ON(actual > res->u64s);
 238
 239         res->offset     += actual;
 240         res->u64s       -= actual;
 241 }
 242
 243 static inline void bch2_journal_add_keys(struct journal *j, struct journal_res *res,
 244                                         enum btree_id id, unsigned level,
 245                                         const struct bkey_i *k)
 246 {
 247         bch2_journal_add_entry(j, res, BCH_JSET_ENTRY_btree_keys,
 248                                id, level, k, k->k.u64s);
 249 }
 250
 251 static inline bool journal_entry_empty(struct jset *j)
 252 {
 253         struct jset_entry *i;
 254
 255         if (j->seq != j->last_seq)
 256                 return false;
 257
 258         vstruct_for_each(j, i)
 259                 if (i->type == BCH_JSET_ENTRY_btree_keys && i->u64s)
 260                         return false;
 261         return true;
 262 }
 263
 264 void __bch2_journal_buf_put(struct journal *);
 265
 266 static inline void bch2_journal_buf_put(struct journal *j, unsigned idx)
 267 {
 268         union journal_res_state s;
 269
 270         s.v = atomic64_sub_return(((union journal_res_state) {
 271                                     .buf0_count = idx == 0,
 272                                     .buf1_count = idx == 1,
 273                                     .buf2_count = idx == 2,
 274                                     .buf3_count = idx == 3,
 275                                     }).v, &j->reservations.counter);
 276
 277         EBUG_ON(((s.idx - idx) & 3) >
 278                 ((s.idx - s.unwritten_idx) & 3));
 279
 280         if (!journal_state_count(s, idx) && idx == s.unwritten_idx)
 281                 __bch2_journal_buf_put(j);
 282 }
 283
 284 /*
 285  * This function releases the journal write structure so other threads can
 286  * then proceed to add their keys as well.
 287  */
 288 static inline void bch2_journal_res_put(struct journal *j,
 289                                        struct journal_res *res)
 290 {
 291         if (!res->ref)
 292                 return;
 293
 294         lock_release(&j->res_map, _THIS_IP_);
 295
 296         while (res->u64s)
 297                 bch2_journal_add_entry(j, res,
 298                                        BCH_JSET_ENTRY_btree_keys,
 299                                        0, 0, NULL, 0);
 300
 301         bch2_journal_buf_put(j, res->idx);
 302
 303         res->ref = 0;
 304 }
 305
 306 int bch2_journal_res_get_slowpath(struct journal *, struct journal_res *,
 307                                   unsigned);
 308
 309 #define JOURNAL_RES_GET_NONBLOCK        (1 << 0)
 310 #define JOURNAL_RES_GET_CHECK           (1 << 1)
 311 #define JOURNAL_RES_GET_RESERVED        (1 << 2)
 312
 313 static inline int journal_res_get_fast(struct journal *j,
 314                                        struct journal_res *res,
 315                                        unsigned flags)
 316 {
 317         union journal_res_state old, new;
 318         u64 v = atomic64_read(&j->reservations.counter);
 319
 320         do {
 321                 old.v = new.v = v;
 322
 323                 /*
 324                  * Check if there is still room in the current journal
 325                  * entry:
 326                  */
 327                 if (new.cur_entry_offset + res->u64s > j->cur_entry_u64s)
 328                         return 0;
 329
 330                 EBUG_ON(!journal_state_count(new, new.idx));
 331
 332                 if (!(flags & JOURNAL_RES_GET_RESERVED) &&
 333                     !test_bit(JOURNAL_MAY_GET_UNRESERVED, &j->flags))
 334                         return 0;
 335
 336                 new.cur_entry_offset += res->u64s;
 337                 journal_state_inc(&new);
 338
 339                 /*
 340                  * If the refcount would overflow, we have to wait:
 341                  * XXX - tracepoint this:
 342                  */
 343                 if (!journal_state_count(new, new.idx))
 344                         return 0;
 345
 346                 if (flags & JOURNAL_RES_GET_CHECK)
 347                         return 1;
 348         } while ((v = atomic64_cmpxchg(&j->reservations.counter,
 349                                        old.v, new.v)) != old.v);
 350
 351         res->ref        = true;
 352         res->idx        = old.idx;
 353         res->offset     = old.cur_entry_offset;
 354         res->seq        = le64_to_cpu(j->buf[old.idx].data->seq);
 355         return 1;
 356 }
 357
 358 static inline int bch2_journal_res_get(struct journal *j, struct journal_res *res,
 359                                        unsigned u64s, unsigned flags)
 360 {
 361         int ret;
 362
 363         EBUG_ON(res->ref);
 364         EBUG_ON(!test_bit(JOURNAL_STARTED, &j->flags));
 365
 366         res->u64s = u64s;
 367
 368         if (journal_res_get_fast(j, res, flags))
 369                 goto out;
 370
 371         ret = bch2_journal_res_get_slowpath(j, res, flags);
 372         if (ret)
 373                 return ret;
 374 out:
 375         if (!(flags & JOURNAL_RES_GET_CHECK)) {
 376                 lock_acquire_shared(&j->res_map, 0,
 377                                     (flags & JOURNAL_RES_GET_NONBLOCK) != 0,
 378                                     NULL, _THIS_IP_);
 379                 EBUG_ON(!res->ref);
 380         }
 381         return 0;
 382 }
 383
 384 /* journal_preres: */
 385
 386 static inline bool journal_check_may_get_unreserved(struct journal *j)
 387 {
 388         union journal_preres_state s = READ_ONCE(j->prereserved);
 389         bool ret = s.reserved < s.remaining &&
 390                 fifo_free(&j->pin) > 8;
 391
 392         lockdep_assert_held(&j->lock);
 393
 394         if (ret != test_bit(JOURNAL_MAY_GET_UNRESERVED, &j->flags)) {
 395                 if (ret) {
 396                         set_bit(JOURNAL_MAY_GET_UNRESERVED, &j->flags);
 397                         journal_wake(j);
 398                 } else {
 399                         clear_bit(JOURNAL_MAY_GET_UNRESERVED, &j->flags);
 400                 }
 401         }
 402         return ret;
 403 }
 404
 405 static inline void bch2_journal_preres_put(struct journal *j,
 406                                            struct journal_preres *res)
 407 {
 408         union journal_preres_state s = { .reserved = res->u64s };
 409
 410         if (!res->u64s)
 411                 return;
 412
 413         s.v = atomic64_sub_return(s.v, &j->prereserved.counter);
 414         res->u64s = 0;
 415
 416         if (unlikely(s.waiting)) {
 417                 clear_bit(ilog2((((union journal_preres_state) { .waiting = 1 }).v)),
 418                           (unsigned long *) &j->prereserved.v);
 419                 closure_wake_up(&j->preres_wait);
 420         }
 421
 422         if (s.reserved <= s.remaining &&
 423             !test_bit(JOURNAL_MAY_GET_UNRESERVED, &j->flags)) {
 424                 spin_lock(&j->lock);
 425                 journal_check_may_get_unreserved(j);
 426                 spin_unlock(&j->lock);
 427         }
 428 }
 429
 430 int __bch2_journal_preres_get(struct journal *,
 431                         struct journal_preres *, unsigned, unsigned);
 432
 433 static inline int bch2_journal_preres_get_fast(struct journal *j,
 434                                                struct journal_preres *res,
 435                                                unsigned new_u64s,
 436                                                unsigned flags,
 437                                                bool set_waiting)
 438 {
 439         int d = new_u64s - res->u64s;
 440         union journal_preres_state old, new;
 441         u64 v = atomic64_read(&j->prereserved.counter);
 442         int ret;
 443
 444         do {
 445                 old.v = new.v = v;
 446                 ret = 0;
 447
 448                 if ((flags & JOURNAL_RES_GET_RESERVED) ||
 449                     new.reserved + d < new.remaining) {
 450                         new.reserved += d;
 451                         ret = 1;
 452                 } else if (set_waiting && !new.waiting)
 453                         new.waiting = true;
 454                 else
 455                         return 0;
 456         } while ((v = atomic64_cmpxchg(&j->prereserved.counter,
 457                                        old.v, new.v)) != old.v);
 458
 459         if (ret)
 460                 res->u64s += d;
 461         return ret;
 462 }
 463
 464 static inline int bch2_journal_preres_get(struct journal *j,
 465                                           struct journal_preres *res,
 466                                           unsigned new_u64s,
 467                                           unsigned flags)
 468 {
 469         if (new_u64s <= res->u64s)
 470                 return 0;
 471
 472         if (bch2_journal_preres_get_fast(j, res, new_u64s, flags, false))
 473                 return 0;
 474
 475         if (flags & JOURNAL_RES_GET_NONBLOCK)
 476                 return -EAGAIN;
 477
 478         return __bch2_journal_preres_get(j, res, new_u64s, flags);
 479 }
 480
 481 /* journal_entry_res: */
 482
 483 void bch2_journal_entry_res_resize(struct journal *,
 484                                    struct journal_entry_res *,
 485                                    unsigned);
 486
 487 int bch2_journal_flush_seq_async(struct journal *, u64, struct closure *);
 488 void bch2_journal_flush_async(struct journal *, struct closure *);
 489
 490 int bch2_journal_flush_seq(struct journal *, u64);
 491 int bch2_journal_flush(struct journal *);
 492 int bch2_journal_meta(struct journal *);
 493
 494 void bch2_journal_halt(struct journal *);
 495
 496 static inline int bch2_journal_error(struct journal *j)
 497 {
 498         return j->reservations.cur_entry_offset == JOURNAL_ENTRY_ERROR_VAL
 499                 ? -EIO : 0;
 500 }
 501
 502 struct bch_dev;
 503
 504 static inline void bch2_journal_set_replay_done(struct journal *j)
 505 {
 506         BUG_ON(!test_bit(JOURNAL_STARTED, &j->flags));
 507         set_bit(JOURNAL_REPLAY_DONE, &j->flags);
 508 }
 509
 510 void bch2_journal_unblock(struct journal *);
 511 void bch2_journal_block(struct journal *);
 512
 513 void __bch2_journal_debug_to_text(struct printbuf *, struct journal *);
 514 void bch2_journal_debug_to_text(struct printbuf *, struct journal *);
 515 void bch2_journal_pins_to_text(struct printbuf *, struct journal *);
 516
 517 int bch2_set_nr_journal_buckets(struct bch_fs *, struct bch_dev *,
 518                                 unsigned nr);
 519 int bch2_dev_journal_alloc(struct bch_dev *);
 520
 521 void bch2_dev_journal_stop(struct journal *, struct bch_dev *);
 522
 523 void bch2_fs_journal_stop(struct journal *);
 524 int bch2_fs_journal_start(struct journal *, u64, struct list_head *);
 525
 526 void bch2_dev_journal_exit(struct bch_dev *);
 527 int bch2_dev_journal_init(struct bch_dev *, struct bch_sb *);
 528 void bch2_fs_journal_exit(struct journal *);
 529 int bch2_fs_journal_init(struct journal *);
 530
 531 #endif /* _BCACHEFS_JOURNAL_H */