sys/sys/_atomic_subword.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2019 Kyle Evans <kevans@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, 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.
  14  *
  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
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29 #ifndef _SYS__ATOMIC_SUBWORD_H_
  30 #define _SYS__ATOMIC_SUBWORD_H_
  31
  32 /*
  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
  37  * of the word.
  38  */
  39 #ifndef _MACHINE_ATOMIC_H_
  40 #error do not include this header, use machine/atomic.h
  41 #endif
  42
  43 #include <machine/endian.h>
  44
  45 #ifndef NBBY
  46 #define NBBY    8
  47 #endif
  48
  49 #define _ATOMIC_WORD_ALIGNED(p)         \
  50     (uint32_t *)((__uintptr_t)(p) - ((__uintptr_t)(p) % 4))
  51
  52 #if _BYTE_ORDER == _BIG_ENDIAN
  53 #define _ATOMIC_BYTE_SHIFT(p)           \
  54     ((3 - ((__uintptr_t)(p) % 4)) * NBBY)
  55
  56 #define _ATOMIC_HWORD_SHIFT(p)          \
  57     ((2 - ((__uintptr_t)(p) % 4)) * NBBY)
  58 #else
  59 #define _ATOMIC_BYTE_SHIFT(p)           \
  60     ((((__uintptr_t)(p) % 4)) * NBBY)
  61
  62 #define _ATOMIC_HWORD_SHIFT(p)          \
  63     ((((__uintptr_t)(p) % 4)) * NBBY)
  64 #endif
  65
  66 /*
  67  * Pass these bad boys a couple words and a mask of the bits you care about,
  68  * they'll loop until we either succeed or fail because of those bits rather
  69  * than the ones we're not masking.  old and val should already be preshifted to
  70  * the proper position.
  71  */
  72 static __inline int
  73 _atomic_cmpset_masked_word(uint32_t *addr, uint32_t old, uint32_t val,
  74     uint32_t mask)
  75 {
  76         int ret;
  77         uint32_t wcomp;
  78
  79         wcomp = old;
  80
  81         /*
  82          * We'll attempt the cmpset on the entire word.  Loop here in case the
  83          * operation fails due to the other half-word resident in that word,
  84          * rather than the half-word we're trying to operate on.  Ideally we
  85          * only take one trip through here.  We'll have to recalculate the old
  86          * value since it's the other part of the word changing.
  87          */
  88         do {
  89                 old = (*addr & ~mask) | wcomp;
  90                 ret = atomic_fcmpset_32(addr, &old, (old & ~mask) | val);
  91         } while (ret == 0 && (old & mask) == wcomp);
  92
  93         return (ret);
  94 }
  95
  96 static __inline int
  97 _atomic_fcmpset_masked_word(uint32_t *addr, uint32_t *old, uint32_t val,
  98     uint32_t mask)
  99 {
 100
 101         /*
 102          * fcmpset_* is documented in atomic(9) to allow spurious failures where
 103          * *old == val on ll/sc architectures because the sc may fail due to
 104          * parallel writes or other reasons.  We take advantage of that here
 105          * and only attempt once, because the caller should be compensating for
 106          * that possibility.
 107          */
 108         *old = (*addr & ~mask) | *old;
 109         return (atomic_fcmpset_32(addr, old, (*old & ~mask) | val));
 110 }
 111
 112 static __inline int
 113 atomic_cmpset_8(__volatile uint8_t *addr, uint8_t old, uint8_t val)
 114 {
 115         int shift;
 116
 117         shift = _ATOMIC_BYTE_SHIFT(addr);
 118
 119         return (_atomic_cmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
 120             old << shift, val << shift, 0xff << shift));
 121 }
 122
 123 static __inline int
 124 atomic_fcmpset_8(__volatile uint8_t *addr, uint8_t *old, uint8_t val)
 125 {
 126         int ret, shift;
 127         uint32_t wold;
 128
 129         shift = _ATOMIC_BYTE_SHIFT(addr);
 130         wold = *old << shift;
 131         ret = _atomic_fcmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
 132             &wold, val << shift, 0xff << shift);
 133         if (ret == 0)
 134                 *old = (wold >> shift) & 0xff;
 135         return (ret);
 136 }
 137
 138 static __inline int
 139 atomic_cmpset_16(__volatile uint16_t *addr, uint16_t old, uint16_t val)
 140 {
 141         int shift;
 142
 143         shift = _ATOMIC_HWORD_SHIFT(addr);
 144
 145         return (_atomic_cmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
 146             old << shift, val << shift, 0xffff << shift));
 147 }
 148
 149 static __inline int
 150 atomic_fcmpset_16(__volatile uint16_t *addr, uint16_t *old, uint16_t val)
 151 {
 152         int ret, shift;
 153         uint32_t wold;
 154
 155         shift = _ATOMIC_HWORD_SHIFT(addr);
 156         wold = *old << shift;
 157         ret = _atomic_fcmpset_masked_word(_ATOMIC_WORD_ALIGNED(addr),
 158             &wold, val << shift, 0xffff << shift);
 159         if (ret == 0)
 160                 *old = (wold >> shift) & 0xffff;
 161         return (ret);
 162 }
 163
 164 #undef _ATOMIC_WORD_ALIGNED
 165 #undef _ATOMIC_BYTE_SHIFT
 166 #undef _ATOMIC_HWORD_SHIFT
 167
 168 #endif  /* _SYS__ATOMIC_SUBWORD_H_ */