drivers/md/bcache/closure.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_CLOSURE_H
   3 #define _LINUX_CLOSURE_H
   4
   5 #include <linux/llist.h>
   6 #include <linux/sched.h>
   7 #include <linux/sched/task_stack.h>
   8 #include <linux/workqueue.h>
   9
  10 /*
  11  * Closure is perhaps the most overused and abused term in computer science, but
  12  * since I've been unable to come up with anything better you're stuck with it
  13  * again.
  14  *
  15  * What are closures?
  16  *
  17  * They embed a refcount. The basic idea is they count "things that are in
  18  * progress" - in flight bios, some other thread that's doing something else -
  19  * anything you might want to wait on.
  20  *
  21  * The refcount may be manipulated with closure_get() and closure_put().
  22  * closure_put() is where many of the interesting things happen, when it causes
  23  * the refcount to go to 0.
  24  *
  25  * Closures can be used to wait on things both synchronously and asynchronously,
  26  * and synchronous and asynchronous use can be mixed without restriction. To
  27  * wait synchronously, use closure_sync() - you will sleep until your closure's
  28  * refcount hits 1.
  29  *
  30  * To wait asynchronously, use
  31  *   continue_at(cl, next_function, workqueue);
  32  *
  33  * passing it, as you might expect, the function to run when nothing is pending
  34  * and the workqueue to run that function out of.
  35  *
  36  * continue_at() also, critically, requires a 'return' immediately following the
  37  * location where this macro is referenced, to return to the calling function.
  38  * There's good reason for this.
  39  *
  40  * To use safely closures asynchronously, they must always have a refcount while
  41  * they are running owned by the thread that is running them. Otherwise, suppose
  42  * you submit some bios and wish to have a function run when they all complete:
  43  *
  44  * foo_endio(struct bio *bio)
  45  * {
  46  *      closure_put(cl);
  47  * }
  48  *
  49  * closure_init(cl);
  50  *
  51  * do_stuff();
  52  * closure_get(cl);
  53  * bio1->bi_endio = foo_endio;
  54  * bio_submit(bio1);
  55  *
  56  * do_more_stuff();
  57  * closure_get(cl);
  58  * bio2->bi_endio = foo_endio;
  59  * bio_submit(bio2);
  60  *
  61  * continue_at(cl, complete_some_read, system_wq);
  62  *
  63  * If closure's refcount started at 0, complete_some_read() could run before the
  64  * second bio was submitted - which is almost always not what you want! More
  65  * importantly, it wouldn't be possible to say whether the original thread or
  66  * complete_some_read()'s thread owned the closure - and whatever state it was
  67  * associated with!
  68  *
  69  * So, closure_init() initializes a closure's refcount to 1 - and when a
  70  * closure_fn is run, the refcount will be reset to 1 first.
  71  *
  72  * Then, the rule is - if you got the refcount with closure_get(), release it
  73  * with closure_put() (i.e, in a bio->bi_endio function). If you have a refcount
  74  * on a closure because you called closure_init() or you were run out of a
  75  * closure - _always_ use continue_at(). Doing so consistently will help
  76  * eliminate an entire class of particularly pernicious races.
  77  *
  78  * Lastly, you might have a wait list dedicated to a specific event, and have no
  79  * need for specifying the condition - you just want to wait until someone runs
  80  * closure_wake_up() on the appropriate wait list. In that case, just use
  81  * closure_wait(). It will return either true or false, depending on whether the
  82  * closure was already on a wait list or not - a closure can only be on one wait
  83  * list at a time.
  84  *
  85  * Parents:
  86  *
  87  * closure_init() takes two arguments - it takes the closure to initialize, and
  88  * a (possibly null) parent.
  89  *
  90  * If parent is non null, the new closure will have a refcount for its lifetime;
  91  * a closure is considered to be "finished" when its refcount hits 0 and the
  92  * function to run is null. Hence
  93  *
  94  * continue_at(cl, NULL, NULL);
  95  *
  96  * returns up the (spaghetti) stack of closures, precisely like normal return
  97  * returns up the C stack. continue_at() with non null fn is better thought of
  98  * as doing a tail call.
  99  *
 100  * All this implies that a closure should typically be embedded in a particular
 101  * struct (which its refcount will normally control the lifetime of), and that
 102  * struct can very much be thought of as a stack frame.
 103  */
 104
 105 struct closure;
 106 struct closure_syncer;
 107 typedef void (closure_fn) (struct closure *);
 108
 109 struct closure_waitlist {
 110         struct llist_head       list;
 111 };
 112
 113 enum closure_state {
 114         /*
 115          * CLOSURE_WAITING: Set iff the closure is on a waitlist. Must be set by
 116          * the thread that owns the closure, and cleared by the thread that's
 117          * waking up the closure.
 118          *
 119          * The rest are for debugging and don't affect behaviour:
 120          *
 121          * CLOSURE_RUNNING: Set when a closure is running (i.e. by
 122          * closure_init() and when closure_put() runs then next function), and
 123          * must be cleared before remaining hits 0. Primarily to help guard
 124          * against incorrect usage and accidentally transferring references.
 125          * continue_at() and closure_return() clear it for you, if you're doing
 126          * something unusual you can use closure_set_dead() which also helps
 127          * annotate where references are being transferred.
 128          */
 129
 130         CLOSURE_BITS_START      = (1U << 26),
 131         CLOSURE_DESTRUCTOR      = (1U << 26),
 132         CLOSURE_WAITING         = (1U << 28),
 133         CLOSURE_RUNNING         = (1U << 30),
 134 };
 135
 136 #define CLOSURE_GUARD_MASK                                      \
 137         ((CLOSURE_DESTRUCTOR|CLOSURE_WAITING|CLOSURE_RUNNING) << 1)
 138
 139 #define CLOSURE_REMAINING_MASK          (CLOSURE_BITS_START - 1)
 140 #define CLOSURE_REMAINING_INITIALIZER   (1|CLOSURE_RUNNING)
 141
 142 struct closure {
 143         union {
 144                 struct {
 145                         struct workqueue_struct *wq;
 146                         struct closure_syncer   *s;
 147                         struct llist_node       list;
 148                         closure_fn              *fn;
 149                 };
 150                 struct work_struct      work;
 151         };
 152
 153         struct closure          *parent;
 154
 155         atomic_t                remaining;
 156
 157 #ifdef CONFIG_BCACHE_CLOSURES_DEBUG
 158 #define CLOSURE_MAGIC_DEAD      0xc054dead
 159 #define CLOSURE_MAGIC_ALIVE     0xc054a11e
 160
 161         unsigned                magic;
 162         struct list_head        all;
 163         unsigned long           ip;
 164         unsigned long           waiting_on;
 165 #endif
 166 };
 167
 168 void closure_sub(struct closure *cl, int v);
 169 void closure_put(struct closure *cl);
 170 void __closure_wake_up(struct closure_waitlist *list);
 171 bool closure_wait(struct closure_waitlist *list, struct closure *cl);
 172 void __closure_sync(struct closure *cl);
 173
 174 /**
 175  * closure_sync - sleep until a closure a closure has nothing left to wait on
 176  *
 177  * Sleeps until the refcount hits 1 - the thread that's running the closure owns
 178  * the last refcount.
 179  */
 180 static inline void closure_sync(struct closure *cl)
 181 {
 182         if ((atomic_read(&cl->remaining) & CLOSURE_REMAINING_MASK) != 1)
 183                 __closure_sync(cl);
 184 }
 185
 186 #ifdef CONFIG_BCACHE_CLOSURES_DEBUG
 187
 188 void closure_debug_init(void);
 189 void closure_debug_create(struct closure *cl);
 190 void closure_debug_destroy(struct closure *cl);
 191
 192 #else
 193
 194 static inline void closure_debug_init(void) {}
 195 static inline void closure_debug_create(struct closure *cl) {}
 196 static inline void closure_debug_destroy(struct closure *cl) {}
 197
 198 #endif
 199
 200 static inline void closure_set_ip(struct closure *cl)
 201 {
 202 #ifdef CONFIG_BCACHE_CLOSURES_DEBUG
 203         cl->ip = _THIS_IP_;
 204 #endif
 205 }
 206
 207 static inline void closure_set_ret_ip(struct closure *cl)
 208 {
 209 #ifdef CONFIG_BCACHE_CLOSURES_DEBUG
 210         cl->ip = _RET_IP_;
 211 #endif
 212 }
 213
 214 static inline void closure_set_waiting(struct closure *cl, unsigned long f)
 215 {
 216 #ifdef CONFIG_BCACHE_CLOSURES_DEBUG
 217         cl->waiting_on = f;
 218 #endif
 219 }
 220
 221 static inline void closure_set_stopped(struct closure *cl)
 222 {
 223         atomic_sub(CLOSURE_RUNNING, &cl->remaining);
 224 }
 225
 226 static inline void set_closure_fn(struct closure *cl, closure_fn *fn,
 227                                   struct workqueue_struct *wq)
 228 {
 229         closure_set_ip(cl);
 230         cl->fn = fn;
 231         cl->wq = wq;
 232         /* between atomic_dec() in closure_put() */
 233         smp_mb__before_atomic();
 234 }
 235
 236 static inline void closure_queue(struct closure *cl)
 237 {
 238         struct workqueue_struct *wq = cl->wq;
 239         /**
 240          * Changes made to closure, work_struct, or a couple of other structs
 241          * may cause work.func not pointing to the right location.
 242          */
 243         BUILD_BUG_ON(offsetof(struct closure, fn)
 244                      != offsetof(struct work_struct, func));
 245         if (wq) {
 246                 INIT_WORK(&cl->work, cl->work.func);
 247                 BUG_ON(!queue_work(wq, &cl->work));
 248         } else
 249                 cl->fn(cl);
 250 }
 251
 252 /**
 253  * closure_get - increment a closure's refcount
 254  */
 255 static inline void closure_get(struct closure *cl)
 256 {
 257 #ifdef CONFIG_BCACHE_CLOSURES_DEBUG
 258         BUG_ON((atomic_inc_return(&cl->remaining) &
 259                 CLOSURE_REMAINING_MASK) <= 1);
 260 #else
 261         atomic_inc(&cl->remaining);
 262 #endif
 263 }
 264
 265 /**
 266  * closure_init - Initialize a closure, setting the refcount to 1
 267  * @cl:         closure to initialize
 268  * @parent:     parent of the new closure. cl will take a refcount on it for its
 269  *              lifetime; may be NULL.
 270  */
 271 static inline void closure_init(struct closure *cl, struct closure *parent)
 272 {
 273         memset(cl, 0, sizeof(struct closure));
 274         cl->parent = parent;
 275         if (parent)
 276                 closure_get(parent);
 277
 278         atomic_set(&cl->remaining, CLOSURE_REMAINING_INITIALIZER);
 279
 280         closure_debug_create(cl);
 281         closure_set_ip(cl);
 282 }
 283
 284 static inline void closure_init_stack(struct closure *cl)
 285 {
 286         memset(cl, 0, sizeof(struct closure));
 287         atomic_set(&cl->remaining, CLOSURE_REMAINING_INITIALIZER);
 288 }
 289
 290 /**
 291  * closure_wake_up - wake up all closures on a wait list.
 292  */
 293 static inline void closure_wake_up(struct closure_waitlist *list)
 294 {
 295         smp_mb();
 296         __closure_wake_up(list);
 297 }
 298
 299 /**
 300  * continue_at - jump to another function with barrier
 301  *
 302  * After @cl is no longer waiting on anything (i.e. all outstanding refs have
 303  * been dropped with closure_put()), it will resume execution at @fn running out
 304  * of @wq (or, if @wq is NULL, @fn will be called by closure_put() directly).
 305  *
 306  * This is because after calling continue_at() you no longer have a ref on @cl,
 307  * and whatever @cl owns may be freed out from under you - a running closure fn
 308  * has a ref on its own closure which continue_at() drops.
 309  *
 310  * Note you are expected to immediately return after using this macro.
 311  */
 312 #define continue_at(_cl, _fn, _wq)                                      \
 313 do {                                                                    \
 314         set_closure_fn(_cl, _fn, _wq);                                  \
 315         closure_sub(_cl, CLOSURE_RUNNING + 1);                          \
 316 } while (0)
 317
 318 /**
 319  * closure_return - finish execution of a closure
 320  *
 321  * This is used to indicate that @cl is finished: when all outstanding refs on
 322  * @cl have been dropped @cl's ref on its parent closure (as passed to
 323  * closure_init()) will be dropped, if one was specified - thus this can be
 324  * thought of as returning to the parent closure.
 325  */
 326 #define closure_return(_cl)     continue_at((_cl), NULL, NULL)
 327
 328 /**
 329  * continue_at_nobarrier - jump to another function without barrier
 330  *
 331  * Causes @fn to be executed out of @cl, in @wq context (or called directly if
 332  * @wq is NULL).
 333  *
 334  * The ref the caller of continue_at_nobarrier() had on @cl is now owned by @fn,
 335  * thus it's not safe to touch anything protected by @cl after a
 336  * continue_at_nobarrier().
 337  */
 338 #define continue_at_nobarrier(_cl, _fn, _wq)                            \
 339 do {                                                                    \
 340         set_closure_fn(_cl, _fn, _wq);                                  \
 341         closure_queue(_cl);                                             \
 342 } while (0)
 343
 344 /**
 345  * closure_return - finish execution of a closure, with destructor
 346  *
 347  * Works like closure_return(), except @destructor will be called when all
 348  * outstanding refs on @cl have been dropped; @destructor may be used to safely
 349  * free the memory occupied by @cl, and it is called with the ref on the parent
 350  * closure still held - so @destructor could safely return an item to a
 351  * freelist protected by @cl's parent.
 352  */
 353 #define closure_return_with_destructor(_cl, _destructor)                \
 354 do {                                                                    \
 355         set_closure_fn(_cl, _destructor, NULL);                         \
 356         closure_sub(_cl, CLOSURE_RUNNING - CLOSURE_DESTRUCTOR + 1);     \
 357 } while (0)
 358
 359 /**
 360  * closure_call - execute @fn out of a new, uninitialized closure
 361  *
 362  * Typically used when running out of one closure, and we want to run @fn
 363  * asynchronously out of a new closure - @parent will then wait for @cl to
 364  * finish.
 365  */
 366 static inline void closure_call(struct closure *cl, closure_fn fn,
 367                                 struct workqueue_struct *wq,
 368                                 struct closure *parent)
 369 {
 370         closure_init(cl, parent);
 371         continue_at_nobarrier(cl, fn, wq);
 372 }
 373
 374 #endif /* _LINUX_CLOSURE_H */