2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 Kyle Evans <kevans@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifndef _SYS__ATOMIC_SUBWORD_H_
30 #define _SYS__ATOMIC_SUBWORD_H_
33 * This header is specifically for platforms that either do not have ways to or
34 * simply do not do sub-word atomic operations. These are not ideal as they
35 * require a little more effort to make sure our atomic operations are failing
36 * because of the bits of the word we're trying to write rather than the rest
39 #ifndef _MACHINE_ATOMIC_H_
40 #error do not include this header, use machine/atomic.h
43 #include <machine/endian.h>
49 #define _ATOMIC_WORD_ALIGNED(p) \
50 (uint32_t *)((__uintptr_t)(p) - ((__uintptr_t)(p) % 4))
52 #if _BYTE_ORDER == _BIG_ENDIAN
53 #define _ATOMIC_BYTE_SHIFT(p) \
54 ((3 - ((__uintptr_t)(p) % 4)) * NBBY)
56 #define _ATOMIC_HWORD_SHIFT(p) \
57 ((2 - ((__uintptr_t)(p) % 4)) * NBBY)
59 #define _ATOMIC_BYTE_SHIFT(p) \
60 ((((__uintptr_t)(p) % 4)) * NBBY)
62 #define _ATOMIC_HWORD_SHIFT(p) \
63 ((((__uintptr_t)(p) % 4)) * NBBY)
66 #ifndef _atomic_cmpset_masked_word
68 * Pass these bad boys a couple words and a mask of the bits you care about,
69 * they'll loop until we either succeed or fail because of those bits rather
70 * than the ones we're not masking. old and val should already be preshifted to
71 * the proper position.
74 _atomic_cmpset_masked_word(uint32_t *addr, uint32_t old, uint32_t val,
83 * We'll attempt the cmpset on the entire word. Loop here in case the
84 * operation fails due to the other half-word resident in that word,
85 * rather than the half-word we're trying to operate on. Ideally we
86 * only take one trip through here. We'll have to recalculate the old
87 * value since it's the other part of the word changing.
90 old = (*addr & ~mask) | wcomp;
91 ret = atomic_fcmpset_32(addr, &old, (old & ~mask) | val);
92 } while (ret == 0 && (old & mask) == wcomp);
98 #ifndef _atomic_fcmpset_masked_word
100 _atomic_fcmpset_masked_word(uint32_t *addr, uint32_t *old, uint32_t val,
105 * fcmpset_* is documented in atomic(9) to allow spurious failures where
106 * *old == val on ll/sc architectures because the sc may fail due to
107 * parallel writes or other reasons. We take advantage of that here
108 * and only attempt once, because the caller should be compensating for
111 *old = (*addr & ~mask) | *old;
112 return (atomic_fcmpset_32(addr, old, (*old & ~mask) | val));
117 atomic_cmpset_8(__volatile uint8_t *addr, uint8_t old, uint8_t val)
121 shift = _ATOMIC_BYTE_SHIFT(addr);
123 return (_atomic_cmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
124 old << shift, val << shift, 0xff << shift));
128 atomic_fcmpset_8(__volatile uint8_t *addr, uint8_t *old, uint8_t val)
133 shift = _ATOMIC_BYTE_SHIFT(addr);
134 wold = *old << shift;
135 ret = _atomic_fcmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
136 &wold, val << shift, 0xff << shift);
138 *old = (wold >> shift) & 0xff;
143 atomic_cmpset_16(__volatile uint16_t *addr, uint16_t old, uint16_t val)
147 shift = _ATOMIC_HWORD_SHIFT(addr);
149 return (_atomic_cmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
150 old << shift, val << shift, 0xffff << shift));
154 atomic_fcmpset_16(__volatile uint16_t *addr, uint16_t *old, uint16_t val)
159 shift = _ATOMIC_HWORD_SHIFT(addr);
160 wold = *old << shift;
161 ret = _atomic_fcmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
162 &wold, val << shift, 0xffff << shift);
164 *old = (wold >> shift) & 0xffff;
168 #undef _ATOMIC_WORD_ALIGNED
169 #undef _ATOMIC_BYTE_SHIFT
170 #undef _ATOMIC_HWORD_SHIFT
172 #endif /* _SYS__ATOMIC_SUBWORD_H_ */