sys/sys/smr.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2019, 2020 Jeffrey Roberson <jeff@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice unmodified, this list of conditions, and the following
  11  *    disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  *
  29  */
  30
  31 #ifndef _SYS_SMR_H_
  32 #define _SYS_SMR_H_
  33
  34 #include <sys/_smr.h>
  35
  36 /*
  37  * Safe memory reclamation.  See subr_smr.c for a description of the
  38  * algorithm.
  39  *
  40  * Readers synchronize with smr_enter()/exit() and writers may either
  41  * free directly to a SMR UMA zone or use smr_synchronize or wait.
  42  */
  43
  44 /*
  45  * Modular arithmetic for comparing sequence numbers that have
  46  * potentially wrapped.  Copied from tcp_seq.h.
  47  */
  48 #define SMR_SEQ_LT(a, b)        ((int32_t)((a)-(b)) < 0)
  49 #define SMR_SEQ_LEQ(a, b)       ((int32_t)((a)-(b)) <= 0)
  50 #define SMR_SEQ_GT(a, b)        ((int32_t)((a)-(b)) > 0)
  51 #define SMR_SEQ_GEQ(a, b)       ((int32_t)((a)-(b)) >= 0)
  52 #define SMR_SEQ_DELTA(a, b)     ((int32_t)((a)-(b)))
  53
  54 #define SMR_SEQ_INVALID         0
  55
  56 /* Shared SMR state. */
  57 struct smr_shared {
  58         const char      *s_name;        /* Name for debugging/reporting. */
  59         smr_seq_t       s_wr_seq;       /* Current write sequence #. */
  60         smr_seq_t       s_rd_seq;       /* Minimum observed read sequence. */
  61 };
  62 typedef struct smr_shared *smr_shared_t;
  63
  64 /* Per-cpu SMR state. */
  65 struct smr {
  66         smr_seq_t       c_seq;          /* Current observed sequence. */
  67         smr_shared_t    c_shared;       /* Shared SMR state. */
  68         int             c_deferred;     /* Deferred advance counter. */
  69 };
  70
  71 /*
  72  * Return the current write sequence number.
  73  */
  74 static inline smr_seq_t
  75 smr_shared_current(smr_shared_t s)
  76 {
  77
  78         return (atomic_load_int(&s->s_wr_seq));
  79 }
  80
  81 static inline smr_seq_t
  82 smr_current(smr_t smr)
  83 {
  84
  85         return (smr_shared_current(zpcpu_get(smr)->c_shared));
  86 }
  87
  88 /*
  89  * Enter a read section.
  90  */
  91 static inline void
  92 smr_enter(smr_t smr)
  93 {
  94
  95         critical_enter();
  96         smr = zpcpu_get(smr);
  97         KASSERT(smr->c_seq == 0,
  98             ("smr_enter(%s) does not support recursion.",
  99             smr->c_shared->s_name));
 100
 101         /*
 102          * Store the current observed write sequence number in our
 103          * per-cpu state so that it can be queried via smr_poll().
 104          * Frees that are newer than this stored value will be
 105          * deferred until we call smr_exit().
 106          *
 107          * An acquire barrier is used to synchronize with smr_exit()
 108          * and smr_poll().
 109          *
 110          * It is possible that a long delay between loading the wr_seq
 111          * and storing the c_seq could create a situation where the
 112          * rd_seq advances beyond our stored c_seq.  In this situation
 113          * only the observed wr_seq is stale, the fence still orders
 114          * the load.  See smr_poll() for details on how this condition
 115          * is detected and handled there.
 116          */
 117         /* This is an add because we do not have atomic_store_acq_int */
 118         atomic_add_acq_int(&smr->c_seq, smr_shared_current(smr->c_shared));
 119 }
 120
 121 /*
 122  * Exit a read section.
 123  */
 124 static inline void
 125 smr_exit(smr_t smr)
 126 {
 127
 128         smr = zpcpu_get(smr);
 129         CRITICAL_ASSERT(curthread);
 130         KASSERT(smr->c_seq != SMR_SEQ_INVALID,
 131             ("smr_exit(%s) not in a smr section.", smr->c_shared->s_name));
 132
 133         /*
 134          * Clear the recorded sequence number.  This allows poll() to
 135          * detect CPUs not in read sections.
 136          *
 137          * Use release semantics to retire any stores before the sequence
 138          * number is cleared.
 139          */
 140         atomic_store_rel_int(&smr->c_seq, SMR_SEQ_INVALID);
 141         critical_exit();
 142 }
 143
 144 /*
 145  * Advances the write sequence number.  Returns the sequence number
 146  * required to ensure that all modifications are visible to readers.
 147  */
 148 smr_seq_t smr_advance(smr_t smr);
 149
 150 /*
 151  * Advances the write sequence number only after N calls.  Returns
 152  * the correct goal for a wr_seq that has not yet occurred.  Used to
 153  * minimize shared cacheline invalidations for frequent writers.
 154  */
 155 smr_seq_t smr_advance_deferred(smr_t smr, int limit);
 156
 157 /*
 158  * Returns true if a goal sequence has been reached.  If
 159  * wait is true this will busy loop until success.
 160  */
 161 bool smr_poll(smr_t smr, smr_seq_t goal, bool wait);
 162
 163 /* Create a new SMR context. */
 164 smr_t smr_create(const char *name);
 165 void smr_destroy(smr_t smr);
 166
 167 /*
 168  * Blocking wait for all readers to observe 'goal'.
 169  */
 170 static inline bool
 171 smr_wait(smr_t smr, smr_seq_t goal)
 172 {
 173
 174         return (smr_poll(smr, goal, true));
 175 }
 176
 177 /*
 178  * Synchronize advances the write sequence and returns when all
 179  * readers have observed it.
 180  *
 181  * If your application can cache a sequence number returned from
 182  * smr_advance() and poll or wait at a later time there will
 183  * be less chance of busy looping while waiting for readers.
 184  */
 185 static inline void
 186 smr_synchronize(smr_t smr)
 187 {
 188
 189         smr_wait(smr, smr_advance(smr));
 190 }
 191
 192 /* Only at startup. */
 193 void smr_init(void);
 194
 195 #endif  /* _SYS_SMR_H_ */