atomic.hpp revision 7051:0420e825bb3c
1115013Smarcel/* 2115013Smarcel * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved. 3115013Smarcel * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4115013Smarcel * 5115013Smarcel * This code is free software; you can redistribute it and/or modify it 6115013Smarcel * under the terms of the GNU General Public License version 2 only, as 7115013Smarcel * published by the Free Software Foundation. 8115013Smarcel * 9115013Smarcel * This code is distributed in the hope that it will be useful, but WITHOUT 10115013Smarcel * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11115013Smarcel * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12115013Smarcel * version 2 for more details (a copy is included in the LICENSE file that 13115013Smarcel * accompanied this code). 14115013Smarcel * 15115013Smarcel * You should have received a copy of the GNU General Public License version 16115013Smarcel * 2 along with this work; if not, write to the Free Software Foundation, 17115013Smarcel * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18115013Smarcel * 19115013Smarcel * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20115013Smarcel * or visit www.oracle.com if you need additional information or have any 21115013Smarcel * questions. 22115013Smarcel * 23115013Smarcel */ 24115013Smarcel 25115013Smarcel#ifndef SHARE_VM_RUNTIME_ATOMIC_HPP 26115013Smarcel#define SHARE_VM_RUNTIME_ATOMIC_HPP 27115013Smarcel 28115013Smarcel#include "memory/allocation.hpp" 29115013Smarcel 30115013Smarcelclass Atomic : AllStatic { 31115013Smarcel public: 32115013Smarcel // Atomic operations on jlong types are not available on all 32-bit 33115013Smarcel // platforms. If atomic ops on jlongs are defined here they must only 34115013Smarcel // be used from code that verifies they are available at runtime and 35115013Smarcel // can provide an alternative action if not - see supports_cx8() for 36115013Smarcel // a means to test availability. 37115013Smarcel 38115013Smarcel // The memory operations that are mentioned with each of the atomic 39115013Smarcel // function families come from src/share/vm/runtime/orderAccess.hpp, 40115013Smarcel // e.g., <fence> is described in that file and is implemented by the 41115013Smarcel // OrderAccess::fence() function. See that file for the gory details 42115013Smarcel // on the Memory Access Ordering Model. 43115013Smarcel 44115013Smarcel // All of the atomic operations that imply a read-modify-write action 45115013Smarcel // guarantee a two-way memory barrier across that operation. Historically 46115013Smarcel // these semantics reflect the strength of atomic operations that are 47115013Smarcel // provided on SPARC/X86. We assume that strength is necessary unless 48115013Smarcel // we can prove that a weaker form is sufficiently safe. 49115013Smarcel 50115013Smarcel // Atomically store to a location 51115013Smarcel inline static void store (jbyte store_value, jbyte* dest); 52115013Smarcel inline static void store (jshort store_value, jshort* dest); 53115013Smarcel inline static void store (jint store_value, jint* dest); 54115013Smarcel // See comment above about using jlong atomics on 32-bit platforms 55115013Smarcel inline static void store (jlong store_value, jlong* dest); 56115013Smarcel inline static void store_ptr(intptr_t store_value, intptr_t* dest); 57115013Smarcel inline static void store_ptr(void* store_value, void* dest); 58115013Smarcel 59115013Smarcel inline static void store (jbyte store_value, volatile jbyte* dest); 60115013Smarcel inline static void store (jshort store_value, volatile jshort* dest); 61115013Smarcel inline static void store (jint store_value, volatile jint* dest); 62115013Smarcel // See comment above about using jlong atomics on 32-bit platforms 63115013Smarcel inline static void store (jlong store_value, volatile jlong* dest); 64115013Smarcel inline static void store_ptr(intptr_t store_value, volatile intptr_t* dest); 65 inline static void store_ptr(void* store_value, volatile void* dest); 66 67 // See comment above about using jlong atomics on 32-bit platforms 68 inline static jlong load(volatile jlong* src); 69 70 // Atomically add to a location. Returns updated value. add*() provide: 71 // <fence> add-value-to-dest <membar StoreLoad|StoreStore> 72 inline static jint add (jint add_value, volatile jint* dest); 73 inline static size_t add (size_t add_value, volatile size_t* dest); 74 inline static intptr_t add_ptr(intptr_t add_value, volatile intptr_t* dest); 75 inline static void* add_ptr(intptr_t add_value, volatile void* dest); 76 // See comment above about using jlong atomics on 32-bit platforms 77 static jlong add (jlong add_value, volatile jlong* dest); 78 79 // Atomically increment location. inc*() provide: 80 // <fence> increment-dest <membar StoreLoad|StoreStore> 81 inline static void inc (volatile jint* dest); 82 static void inc (volatile jshort* dest); 83 inline static void inc (volatile size_t* dest); 84 inline static void inc_ptr(volatile intptr_t* dest); 85 inline static void inc_ptr(volatile void* dest); 86 87 // Atomically decrement a location. dec*() provide: 88 // <fence> decrement-dest <membar StoreLoad|StoreStore> 89 inline static void dec (volatile jint* dest); 90 static void dec (volatile jshort* dest); 91 inline static void dec (volatile size_t* dest); 92 inline static void dec_ptr(volatile intptr_t* dest); 93 inline static void dec_ptr(volatile void* dest); 94 95 // Performs atomic exchange of *dest with exchange_value. Returns old 96 // prior value of *dest. xchg*() provide: 97 // <fence> exchange-value-with-dest <membar StoreLoad|StoreStore> 98 inline static jint xchg (jint exchange_value, volatile jint* dest); 99 static unsigned int xchg (unsigned int exchange_value, volatile unsigned int* dest); 100 inline static intptr_t xchg_ptr(intptr_t exchange_value, volatile intptr_t* dest); 101 inline static void* xchg_ptr(void* exchange_value, volatile void* dest); 102 103 // Performs atomic compare of *dest and compare_value, and exchanges 104 // *dest with exchange_value if the comparison succeeded. Returns prior 105 // value of *dest. cmpxchg*() provide: 106 // <fence> compare-and-exchange <membar StoreLoad|StoreStore> 107 static jbyte cmpxchg (jbyte exchange_value, volatile jbyte* dest, jbyte compare_value); 108 inline static jint cmpxchg (jint exchange_value, volatile jint* dest, jint compare_value); 109 // See comment above about using jlong atomics on 32-bit platforms 110 inline static jlong cmpxchg (jlong exchange_value, volatile jlong* dest, jlong compare_value); 111 static unsigned int cmpxchg (unsigned int exchange_value, volatile unsigned int* dest, unsigned int compare_value); 112 inline static intptr_t cmpxchg_ptr(intptr_t exchange_value, volatile intptr_t* dest, intptr_t compare_value); 113 inline static void* cmpxchg_ptr(void* exchange_value, volatile void* dest, void* compare_value); 114}; 115 116// To use Atomic::inc(jshort* dest) and Atomic::dec(jshort* dest), the address must be specially 117// aligned, such that (*dest) occupies the upper 16 bits of an aligned 32-bit word. The best way to 118// achieve is to place your short value next to another short value, which doesn't need atomic ops. 119// 120// Example 121// ATOMIC_SHORT_PAIR( 122// volatile short _refcount, // needs atomic operation 123// unsigned short _length // number of UTF8 characters in the symbol (does not need atomic op) 124// ); 125 126#ifdef VM_LITTLE_ENDIAN 127 #define ATOMIC_SHORT_PAIR(atomic_decl, non_atomic_decl) \ 128 non_atomic_decl; \ 129 atomic_decl 130#else 131 #define ATOMIC_SHORT_PAIR(atomic_decl, non_atomic_decl) \ 132 atomic_decl; \ 133 non_atomic_decl 134#endif 135 136#endif // SHARE_VM_RUNTIME_ATOMIC_HPP 137