Blame view
lib/errseq.c
6.6 KB
b24413180 License cleanup: ... |
1 |
// SPDX-License-Identifier: GPL-2.0 |
84cbadadc lib: add errseq_t... |
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
#include <linux/err.h> #include <linux/bug.h> #include <linux/atomic.h> #include <linux/errseq.h> /* * An errseq_t is a way of recording errors in one place, and allowing any * number of "subscribers" to tell whether it has changed since a previous * point where it was sampled. * * It's implemented as an unsigned 32-bit value. The low order bits are * designated to hold an error code (between 0 and -MAX_ERRNO). The upper bits * are used as a counter. This is done with atomics instead of locking so that * these functions can be called from any context. * * The general idea is for consumers to sample an errseq_t value. That value * can later be used to tell whether any new errors have occurred since that * sampling was done. * * Note that there is a risk of collisions if new errors are being recorded * frequently, since we have so few bits to use as a counter. * * To mitigate this, one bit is used as a flag to tell whether the value has * been sampled since a new value was recorded. That allows us to avoid bumping * the counter if no one has sampled it since the last time an error was * recorded. * * A new errseq_t should always be zeroed out. A errseq_t value of all zeroes * is the special (but common) case where there has never been an error. An all * zero value thus serves as the "epoch" if one wishes to know whether there * has ever been an error set since it was first initialized. */ /* The low bits are designated for error code (max of MAX_ERRNO) */ #define ERRSEQ_SHIFT ilog2(MAX_ERRNO + 1) /* This bit is used as a flag to indicate whether the value has been seen */ #define ERRSEQ_SEEN (1 << ERRSEQ_SHIFT) /* The lowest bit of the counter */ #define ERRSEQ_CTR_INC (1 << (ERRSEQ_SHIFT + 1)) /** |
3acdfd280 errseq: rename __... |
45 |
* errseq_set - set a errseq_t for later reporting |
84cbadadc lib: add errseq_t... |
46 |
* @eseq: errseq_t field that should be set |
3acdfd280 errseq: rename __... |
47 |
* @err: error to set (must be between -1 and -MAX_ERRNO) |
84cbadadc lib: add errseq_t... |
48 |
* |
14ebc28e0 errseq: Add to do... |
49 |
* This function sets the error in @eseq, and increments the sequence counter |
84cbadadc lib: add errseq_t... |
50 51 52 53 |
* if the last sequence was sampled at some point in the past. * * Any error set will always overwrite an existing error. * |
14ebc28e0 errseq: Add to do... |
54 55 56 |
* Return: The previous value, primarily for debugging purposes. The * return value should not be used as a previously sampled value in later * calls as it will not have the SEEN flag set. |
84cbadadc lib: add errseq_t... |
57 |
*/ |
3acdfd280 errseq: rename __... |
58 |
errseq_t errseq_set(errseq_t *eseq, int err) |
84cbadadc lib: add errseq_t... |
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
{ errseq_t cur, old; /* MAX_ERRNO must be able to serve as a mask */ BUILD_BUG_ON_NOT_POWER_OF_2(MAX_ERRNO + 1); /* * Ensure the error code actually fits where we want it to go. If it * doesn't then just throw a warning and don't record anything. We * also don't accept zero here as that would effectively clear a * previous error. */ old = READ_ONCE(*eseq); if (WARN(unlikely(err == 0 || (unsigned int)-err > MAX_ERRNO), "err = %d ", err)) return old; for (;;) { errseq_t new; /* Clear out error bits and set new error */ new = (old & ~(MAX_ERRNO|ERRSEQ_SEEN)) | -err; /* Only increment if someone has looked at it */ if (old & ERRSEQ_SEEN) new += ERRSEQ_CTR_INC; /* If there would be no change, then call it done */ if (new == old) { cur = new; break; } /* Try to swap the new value into place */ cur = cmpxchg(eseq, old, new); /* * Call it success if we did the swap or someone else beat us * to it for the same value. */ if (likely(cur == old || cur == new)) break; /* Raced with an update, try again */ old = cur; } return cur; } |
3acdfd280 errseq: rename __... |
109 |
EXPORT_SYMBOL(errseq_set); |
84cbadadc lib: add errseq_t... |
110 111 |
/** |
14ebc28e0 errseq: Add to do... |
112 113 |
* errseq_sample() - Grab current errseq_t value. * @eseq: Pointer to errseq_t to be sampled. |
84cbadadc lib: add errseq_t... |
114 |
* |
b4678df18 errseq: Always re... |
115 116 117 118 |
* This function allows callers to initialise their errseq_t variable. * If the error has been "seen", new callers will not see an old error. * If there is an unseen error in @eseq, the caller of this function will * see it the next time it checks for an error. |
14ebc28e0 errseq: Add to do... |
119 |
* |
b4678df18 errseq: Always re... |
120 |
* Context: Any context. |
14ebc28e0 errseq: Add to do... |
121 |
* Return: The current errseq value. |
84cbadadc lib: add errseq_t... |
122 123 124 125 |
*/ errseq_t errseq_sample(errseq_t *eseq) { errseq_t old = READ_ONCE(*eseq); |
84cbadadc lib: add errseq_t... |
126 |
|
b4678df18 errseq: Always re... |
127 128 129 130 |
/* If nobody has seen this error yet, then we can be the first. */ if (!(old & ERRSEQ_SEEN)) old = 0; return old; |
84cbadadc lib: add errseq_t... |
131 132 133 134 |
} EXPORT_SYMBOL(errseq_sample); /** |
14ebc28e0 errseq: Add to do... |
135 136 137 |
* errseq_check() - Has an error occurred since a particular sample point? * @eseq: Pointer to errseq_t value to be checked. * @since: Previously-sampled errseq_t from which to check. |
84cbadadc lib: add errseq_t... |
138 |
* |
14ebc28e0 errseq: Add to do... |
139 140 |
* Grab the value that eseq points to, and see if it has changed @since * the given value was sampled. The @since value is not advanced, so there |
84cbadadc lib: add errseq_t... |
141 142 |
* is no need to mark the value as seen. * |
14ebc28e0 errseq: Add to do... |
143 |
* Return: The latest error set in the errseq_t or 0 if it hasn't changed. |
84cbadadc lib: add errseq_t... |
144 145 146 147 148 149 150 151 152 153 154 155 |
*/ int errseq_check(errseq_t *eseq, errseq_t since) { errseq_t cur = READ_ONCE(*eseq); if (likely(cur == since)) return 0; return -(cur & MAX_ERRNO); } EXPORT_SYMBOL(errseq_check); /** |
14ebc28e0 errseq: Add to do... |
156 157 158 |
* errseq_check_and_advance() - Check an errseq_t and advance to current value. * @eseq: Pointer to value being checked and reported. * @since: Pointer to previously-sampled errseq_t to check against and advance. |
84cbadadc lib: add errseq_t... |
159 |
* |
14ebc28e0 errseq: Add to do... |
160 |
* Grab the eseq value, and see whether it matches the value that @since |
84cbadadc lib: add errseq_t... |
161 162 163 164 165 166 167 168 169 170 |
* points to. If it does, then just return 0. * * If it doesn't, then the value has changed. Set the "seen" flag, and try to * swap it into place as the new eseq value. Then, set that value as the new * "since" value, and return whatever the error portion is set to. * * Note that no locking is provided here for concurrent updates to the "since" * value. The caller must provide that if necessary. Because of this, callers * may want to do a lockless errseq_check before taking the lock and calling * this. |
14ebc28e0 errseq: Add to do... |
171 172 173 |
* * Return: Negative errno if one has been stored, or 0 if no new error has * occurred. |
84cbadadc lib: add errseq_t... |
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
*/ int errseq_check_and_advance(errseq_t *eseq, errseq_t *since) { int err = 0; errseq_t old, new; /* * Most callers will want to use the inline wrapper to check this, * so that the common case of no error is handled without needing * to take the lock that protects the "since" value. */ old = READ_ONCE(*eseq); if (old != *since) { /* * Set the flag and try to swap it into place if it has * changed. * * We don't care about the outcome of the swap here. If the * swap doesn't occur, then it has either been updated by a * writer who is altering the value in some way (updating * counter or resetting the error), or another reader who is * just setting the "seen" flag. Either outcome is OK, and we * can advance "since" and return an error based on what we * have. */ new = old | ERRSEQ_SEEN; if (new != old) cmpxchg(eseq, old, new); *since = new; err = -(new & MAX_ERRNO); } return err; } EXPORT_SYMBOL(errseq_check_and_advance); |