intern/atomic/atomic_ops.h

   1 /*
   2  * Original code from jemalloc with this license:
   3  *
   4  * Copyright (C) 2002-2013 Jason Evans <jasone@canonware.com>.
   5  * All rights reserved.
   6  * Copyright (C) 2007-2012 Mozilla Foundation.  All rights reserved.
   7  * Copyright (C) 2009-2013 Facebook, Inc.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  * 1. Redistributions of source code must retain the above copyright notice(s),
  12  *    this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright notice(s),
  14  *    this list of conditions and the following disclaimer in the documentation
  15  *    and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
  20  * EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  26  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * ***** BEGIN GPL LICENSE BLOCK *****
  29  *
  30  * This program is free software; you can redistribute it and/or
  31  * modify it under the terms of the GNU General Public License
  32  * as published by the Free Software Foundation; either version 2
  33  * of the License, or (at your option) any later version.
  34  *
  35  * This program is distributed in the hope that it will be useful,
  36  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  37  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  38  * GNU General Public License for more details.
  39  *
  40  * You should have received a copy of the GNU General Public License
  41  * along with this program; if not, write to the Free Software Foundation,
  42  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  43  *
  44  * The Original Code is Copyright (C) 2016 Blender Foundation.
  45  * All rights reserved.
  46  *
  47  * The Original Code is: adapted from jemalloc.
  48  *
  49  * ***** END GPL LICENSE BLOCK *****
  50  */
  51
  52 /**
  53  * \file atomic_ops.h
  54  * \ingroup Atomic
  55  *
  56  * \author Copyright (C) 2016 Blender Foundation, adapted from jemalloc.
  57  * \brief Provides wrapper around system-specific atomic primitives, and some extensions (faked-atomic operations
  58  *        over float numbers).
  59  */
  60
  61 #ifndef __ATOMIC_OPS_H__
  62 #define __ATOMIC_OPS_H__
  63
  64 #if defined(__arm__)
  65 /* Attempt to fix compilation error on Debian armel kernel.
  66  * arm7 architecture does have both 32 and 64bit atomics, however
  67  * it's gcc doesn't have __GCC_HAVE_SYNC_COMPARE_AND_SWAP_n defined.
  68  */
  69 #  define JE_FORCE_SYNC_COMPARE_AND_SWAP_1
  70 #  define JE_FORCE_SYNC_COMPARE_AND_SWAP_4
  71 #  define JE_FORCE_SYNC_COMPARE_AND_SWAP_8
  72 #endif
  73
  74 #include "intern/atomic_ops_utils.h"
  75
  76 /******************************************************************************/
  77 /* Function prototypes. */
  78
  79 #if (LG_SIZEOF_PTR == 8 || LG_SIZEOF_INT == 8)
  80 ATOMIC_INLINE uint64_t atomic_add_and_fetch_uint64(uint64_t *p, uint64_t x);
  81 ATOMIC_INLINE uint64_t atomic_sub_and_fetch_uint64(uint64_t *p, uint64_t x);
  82 ATOMIC_INLINE uint64_t atomic_fetch_and_add_uint64(uint64_t *p, uint64_t x);
  83 ATOMIC_INLINE uint64_t atomic_fetch_and_sub_uint64(uint64_t *p, uint64_t x);
  84 ATOMIC_INLINE uint64_t atomic_cas_uint64(uint64_t *v, uint64_t old, uint64_t _new);
  85
  86 ATOMIC_INLINE int64_t atomic_add_and_fetch_int64(int64_t *p, int64_t x);
  87 ATOMIC_INLINE int64_t atomic_sub_and_fetch_int64(int64_t *p, int64_t x);
  88 ATOMIC_INLINE int64_t atomic_fetch_and_add_int64(int64_t *p, int64_t x);
  89 ATOMIC_INLINE int64_t atomic_fetch_and_sub_int64(int64_t *p, int64_t x);
  90 ATOMIC_INLINE int64_t atomic_cas_int64(int64_t *v, int64_t old, int64_t _new);
  91 #endif
  92
  93 ATOMIC_INLINE uint32_t atomic_add_and_fetch_uint32(uint32_t *p, uint32_t x);
  94 ATOMIC_INLINE uint32_t atomic_sub_and_fetch_uint32(uint32_t *p, uint32_t x);
  95 ATOMIC_INLINE uint32_t atomic_cas_uint32(uint32_t *v, uint32_t old, uint32_t _new);
  96
  97 ATOMIC_INLINE uint32_t atomic_fetch_and_add_uint32(uint32_t *p, uint32_t x);
  98 ATOMIC_INLINE uint32_t atomic_fetch_and_or_uint32(uint32_t *p, uint32_t x);
  99 ATOMIC_INLINE uint32_t atomic_fetch_and_and_uint32(uint32_t *p, uint32_t x);
 100
 101 ATOMIC_INLINE int32_t atomic_add_and_fetch_int32(int32_t *p, int32_t x);
 102 ATOMIC_INLINE int32_t atomic_sub_and_fetch_int32(int32_t *p, int32_t x);
 103 ATOMIC_INLINE int32_t atomic_cas_int32(int32_t *v, int32_t old, int32_t _new);
 104
 105 ATOMIC_INLINE int32_t atomic_fetch_and_add_int32(int32_t *p, int32_t x);
 106 ATOMIC_INLINE int32_t atomic_fetch_and_or_int32(int32_t *p, int32_t x);
 107 ATOMIC_INLINE int32_t atomic_fetch_and_and_int32(int32_t *p, int32_t x);
 108
 109 ATOMIC_INLINE uint8_t atomic_fetch_and_or_uint8(uint8_t *p, uint8_t b);
 110 ATOMIC_INLINE uint8_t atomic_fetch_and_and_uint8(uint8_t *p, uint8_t b);
 111
 112 ATOMIC_INLINE int8_t atomic_fetch_and_or_int8(int8_t *p, int8_t b);
 113 ATOMIC_INLINE int8_t atomic_fetch_and_and_int8(int8_t *p, int8_t b);
 114
 115 ATOMIC_INLINE char atomic_fetch_and_or_char(char *p, char b);
 116 ATOMIC_INLINE char atomic_fetch_and_and_char(char *p, char b);
 117
 118 ATOMIC_INLINE size_t atomic_add_and_fetch_z(size_t *p, size_t x);
 119 ATOMIC_INLINE size_t atomic_sub_and_fetch_z(size_t *p, size_t x);
 120 ATOMIC_INLINE size_t atomic_fetch_and_add_z(size_t *p, size_t x);
 121 ATOMIC_INLINE size_t atomic_fetch_and_sub_z(size_t *p, size_t x);
 122 ATOMIC_INLINE size_t atomic_cas_z(size_t *v, size_t old, size_t _new);
 123 ATOMIC_INLINE size_t atomic_fetch_and_update_max_z(size_t *p, size_t x); /* Uses CAS loop, see warning below. */
 124
 125 ATOMIC_INLINE unsigned int atomic_add_and_fetch_u(unsigned int *p, unsigned int x);
 126 ATOMIC_INLINE unsigned int atomic_sub_and_fetch_u(unsigned int *p, unsigned int x);
 127 ATOMIC_INLINE unsigned int atomic_fetch_and_add_u(unsigned int *p, unsigned int x);
 128 ATOMIC_INLINE unsigned int atomic_fetch_and_sub_u(unsigned int *p, unsigned int x);
 129 ATOMIC_INLINE unsigned int atomic_cas_u(unsigned int *v, unsigned int old, unsigned int _new);
 130
 131 ATOMIC_INLINE void *atomic_cas_ptr(void **v, void *old, void *_new);
 132
 133
 134 ATOMIC_INLINE float atomic_cas_float(float *v, float old, float _new);
 135
 136 /* WARNING! Float 'atomics' are really faked ones, those are actually closer to some kind of spinlock-sync'ed operation,
 137  *          which means they are only efficient if collisions are highly unlikely (i.e. if probability of two threads
 138  *          working on the same pointer at the same time is very low). */
 139 ATOMIC_INLINE float atomic_add_and_fetch_fl(float *p, const float x);
 140
 141 /******************************************************************************/
 142 /* Include system-dependent implementations. */
 143
 144 /* Note that we are using _unix flavor as fallback here (it will raise precompiler errors as needed). */
 145 #if defined(_MSC_VER)
 146 #  include "intern/atomic_ops_msvc.h"
 147 #else
 148 #  include "intern/atomic_ops_unix.h"
 149 #endif
 150
 151 /* Include 'fake' atomic extensions, built over real atomic primitives. */
 152 #include "intern/atomic_ops_ext.h"
 153
 154 #endif /* __ATOMIC_OPS_H__ */