VarHandle Class

Definition

Namespace:

Java.Lang.Invoke

Assembly:

Mono.Android.dll

A VarHandle is a dynamically strongly typed reference to a variable, or to a parametrically-defined family of variables, including static fields, non-static fields, array elements, or components of an off-heap data structure.

[Android.Runtime.Register("java/lang/invoke/VarHandle", ApiSince=33, DoNotGenerateAcw=true)]
public abstract class VarHandle : Java.Lang.Object

[<Android.Runtime.Register("java/lang/invoke/VarHandle", ApiSince=33, DoNotGenerateAcw=true)>]
type VarHandle = class
    inherit Object

Inheritance

Object

Object

VarHandle

Attributes

RegisterAttribute

Remarks

A VarHandle is a dynamically strongly typed reference to a variable, or to a parametrically-defined family of variables, including static fields, non-static fields, array elements, or components of an off-heap data structure. Access to such variables is supported under various <em>access modes</em>, including plain read/write access, volatile read/write access, and compare-and-set.

VarHandles are immutable and have no visible state. VarHandles cannot be subclassed by the user.

A VarHandle has: <ul> <li>a #varType variable type T, the type of every variable referenced by this VarHandle; and <li>a list of #coordinateTypes coordinate typesCT1, CT2, ..., CTn, the types of <em>coordinate expressions</em> that jointly locate a variable referenced by this VarHandle. </ul> Variable and coordinate types may be primitive or reference, and are represented by Class objects. The list of coordinate types may be empty.

Factory methods that produce or java.lang.invoke.MethodHandles.Lookup lookup VarHandle instances document the supported variable type and the list of coordinate types.

Each access mode is associated with one <em>access mode method</em>, a signature polymorphic method named for the access mode. When an access mode method is invoked on a VarHandle instance, the initial arguments to the invocation are coordinate expressions that indicate in precisely which object the variable is to be accessed. Trailing arguments to the invocation represent values of importance to the access mode. For example, the various compare-and-set or compare-and-exchange access modes require two trailing arguments for the variable's expected value and new value.

The arity and types of arguments to the invocation of an access mode method are not checked statically. Instead, each access mode method specifies an #accessModeType(AccessMode) access mode type, represented as an instance of MethodType, that serves as a kind of method signature against which the arguments are checked dynamically. An access mode type gives formal parameter types in terms of the coordinate types of a VarHandle instance and the types for values of importance to the access mode. An access mode type also gives a return type, often in terms of the variable type of a VarHandle instance. When an access mode method is invoked on a VarHandle instance, the symbolic type descriptor at the call site, the run time types of arguments to the invocation, and the run time type of the return value, must match the types given in the access mode type. A runtime exception will be thrown if the match fails.

For example, the access mode method #compareAndSet specifies that if its receiver is a VarHandle instance with coordinate types CT1, ..., CTn and variable type T, then its access mode type is (CT1 c1, ..., CTn cn, T expectedValue, T newValue)boolean. Suppose that a VarHandle instance can access array elements, and that its coordinate types are String[] and int while its variable type is String. The access mode type for compareAndSet on this VarHandle instance would be (String[] c1, int c2, String expectedValue, String newValue)boolean. Such a VarHandle instance may be produced by the MethodHandles#arrayElementVarHandle(Class) array factory method and access array elements as follows:

{@code
            String[] sa = ...
            VarHandle avh = MethodHandles.arrayElementVarHandle(String[].class);
            boolean r = avh.compareAndSet(sa, 10, "expected", "new");
            }

Access modes control atomicity and consistency properties. <em>Plain</em> read (get) and write (set) accesses are guaranteed to be bitwise atomic only for references and for primitive values of at most 32 bits, and impose no observable ordering constraints with respect to threads other than the executing thread. <em>Opaque</em> operations are bitwise atomic and coherently ordered with respect to accesses to the same variable. In addition to obeying Opaque properties, <em>Acquire</em> mode reads and their subsequent accesses are ordered after matching <em>Release</em> mode writes and their previous accesses. In addition to obeying Acquire and Release properties, all <em>Volatile</em> operations are totally ordered with respect to each other.

Access modes are grouped into the following categories: <ul> <li>read access modes that get the value of a variable under specified memory ordering effects. The set of corresponding access mode methods belonging to this group consists of the methods #get get, #getVolatile getVolatile, #getAcquire getAcquire, #getOpaque getOpaque. <li>write access modes that set the value of a variable under specified memory ordering effects. The set of corresponding access mode methods belonging to this group consists of the methods #set set, #setVolatile setVolatile, #setRelease setRelease, #setOpaque setOpaque. <li>atomic update access modes that, for example, atomically compare and set the value of a variable under specified memory ordering effects. The set of corresponding access mode methods belonging to this group consists of the methods #compareAndSet compareAndSet, #weakCompareAndSetPlain weakCompareAndSetPlain, #weakCompareAndSet weakCompareAndSet, #weakCompareAndSetAcquire weakCompareAndSetAcquire, #weakCompareAndSetRelease weakCompareAndSetRelease, #compareAndExchangeAcquire compareAndExchangeAcquire, #compareAndExchange compareAndExchange, #compareAndExchangeRelease compareAndExchangeRelease, #getAndSet getAndSet, #getAndSetAcquire getAndSetAcquire, #getAndSetRelease getAndSetRelease. <li>numeric atomic update access modes that, for example, atomically get and set with addition the value of a variable under specified memory ordering effects. The set of corresponding access mode methods belonging to this group consists of the methods #getAndAdd getAndAdd, #getAndAddAcquire getAndAddAcquire, #getAndAddRelease getAndAddRelease, <li>bitwise atomic update access modes that, for example, atomically get and bitwise OR the value of a variable under specified memory ordering effects. The set of corresponding access mode methods belonging to this group consists of the methods #getAndBitwiseOr getAndBitwiseOr, #getAndBitwiseOrAcquire getAndBitwiseOrAcquire, #getAndBitwiseOrRelease getAndBitwiseOrRelease, #getAndBitwiseAnd getAndBitwiseAnd, #getAndBitwiseAndAcquire getAndBitwiseAndAcquire, #getAndBitwiseAndRelease getAndBitwiseAndRelease, #getAndBitwiseXor getAndBitwiseXor, #getAndBitwiseXorAcquire getAndBitwiseXorAcquire, #getAndBitwiseXorRelease getAndBitwiseXorRelease. </ul>

Factory methods that produce or java.lang.invoke.MethodHandles.Lookup lookup VarHandle instances document the set of access modes that are supported, which may also include documenting restrictions based on the variable type and whether a variable is read-only. If an access mode is not supported then the corresponding access mode method will on invocation throw an UnsupportedOperationException. Factory methods should document any additional undeclared exceptions that may be thrown by access mode methods. The #get get access mode is supported for all VarHandle instances and the corresponding method never throws UnsupportedOperationException. If a VarHandle references a read-only variable (for example a final field) then write, atomic update, numeric atomic update, and bitwise atomic update access modes are not supported and corresponding methods throw UnsupportedOperationException. Read/write access modes (if supported), with the exception of get and set, provide atomic access for reference types and all primitive types. Unless stated otherwise in the documentation of a factory method, the access modes get and set (if supported) provide atomic access for reference types and all primitives types, with the exception of long and double on 32-bit platforms.

Access modes will override any memory ordering effects specified at the declaration site of a variable. For example, a VarHandle accessing a field using the get access mode will access the field as specified <em>by its access mode</em> even if that field is declared volatile. When mixed access is performed extreme care should be taken since the Java Memory Model may permit surprising results.

In addition to supporting access to variables under various access modes, a set of static methods, referred to as memory fence methods, is also provided for fine-grained control of memory ordering.

The Java Language Specification permits other threads to observe operations as if they were executed in orders different than are apparent in program source code, subject to constraints arising, for example, from the use of locks, volatile fields or VarHandles. The static methods, #fullFence fullFence, #acquireFence acquireFence, #releaseFence releaseFence, #loadLoadFence loadLoadFence and #storeStoreFence storeStoreFence, can also be used to impose constraints. Their specifications, as is the case for certain access modes, are phrased in terms of the lack of "reorderings" -- observable ordering effects that might otherwise occur if the fence was not present. More precise phrasing of the specification of access mode methods and memory fence methods may accompany future updates of the Java Language Specification.

<h1>Compiling invocation of access mode methods</h1> A Java method call expression naming an access mode method can invoke a VarHandle from Java source code. From the viewpoint of source code, these methods can take any arguments and their polymorphic result (if expressed) can be cast to any return type. Formally this is accomplished by giving the access mode methods variable arity Object arguments and Object return types (if the return type is polymorphic), but they have an additional quality called <em>signature polymorphism</em> which connects this freedom of invocation directly to the JVM execution stack.

As is usual with virtual methods, source-level calls to access mode methods compile to an invokevirtual instruction. More unusually, the compiler must record the actual argument types, and may not perform method invocation conversions on the arguments. Instead, it must generate instructions to push them on the stack according to their own unconverted types. The VarHandle object itself will be pushed on the stack before the arguments. The compiler then generates an invokevirtual instruction that invokes the access mode method with a symbolic type descriptor which describes the argument and return types.

To issue a complete symbolic type descriptor, the compiler must also determine the return type (if polymorphic). This is based on a cast on the method invocation expression, if there is one, or else Object if the invocation is an expression, or else void if the invocation is a statement. The cast may be to a primitive type (but not void).

As a corner case, an uncasted null argument is given a symbolic type descriptor of java.lang.Void. The ambiguity with the type Void is harmless, since there are no references of type Void except the null reference.

<h1>"invoke">Performing invocation of access mode methods</h1> The first time an invokevirtual instruction is executed it is linked by symbolically resolving the names in the instruction and verifying that the method call is statically legal. This also holds for calls to access mode methods. In this case, the symbolic type descriptor emitted by the compiler is checked for correct syntax, and names it contains are resolved. Thus, an invokevirtual instruction which invokes an access mode method will always link, as long as the symbolic type descriptor is syntactically well-formed and the types exist.

When the invokevirtual is executed after linking, the receiving VarHandle's access mode type is first checked by the JVM to ensure that it matches the symbolic type descriptor. If the type match fails, it means that the access mode method which the caller is invoking is not present on the individual VarHandle being invoked.

Invocation of an access mode method behaves as if an invocation of MethodHandle#invoke, where the receiving method handle accepts the VarHandle instance as the leading argument. More specifically, the following, where {access-mode} corresponds to the access mode method name:

{@code
            VarHandle vh = ..
            R r = (R) vh.{access-mode}(p1, p2, ..., pN);
            }

behaves as if:

{@code
            VarHandle vh = ..
            VarHandle.AccessMode am = VarHandle.AccessMode.valueFromMethodName("{access-mode}");
            MethodHandle mh = MethodHandles.varHandleExactInvoker(
                                  am,
                                  vh.accessModeType(am));

            R r = (R) mh.invoke(vh, p1, p2, ..., pN)
            }

(modulo access mode methods do not declare throwing of Throwable). This is equivalent to:

{@code
            MethodHandle mh = MethodHandles.lookup().findVirtual(
                                  VarHandle.class,
                                  "{access-mode}",
                                  MethodType.methodType(R, p1, p2, ..., pN));

            R r = (R) mh.invokeExact(vh, p1, p2, ..., pN)
            }

where the desired method type is the symbolic type descriptor and a MethodHandle#invokeExact is performed, since before invocation of the target, the handle will apply reference casts as necessary and box, unbox, or widen primitive values, as if by MethodHandle#asType asType (see also MethodHandles#varHandleInvoker).

More concisely, such behaviour is equivalent to:

{@code
            VarHandle vh = ..
            VarHandle.AccessMode am = VarHandle.AccessMode.valueFromMethodName("{access-mode}");
            MethodHandle mh = vh.toMethodHandle(am);

            R r = (R) mh.invoke(p1, p2, ..., pN)
            }

Where, in this case, the method handle is bound to the VarHandle instance.

<h1>Invocation checking</h1> In typical programs, VarHandle access mode type matching will usually succeed. But if a match fails, the JVM will throw a WrongMethodTypeException.

Thus, an access mode type mismatch which might show up as a linkage error in a statically typed program can show up as a dynamic WrongMethodTypeException in a program which uses VarHandles.

Because access mode types contain "live" Class objects, method type matching takes into account both type names and class loaders. Thus, even if a VarHandle VH is created in one class loader L1 and used in another L2, VarHandle access mode method calls are type-safe, because the caller's symbolic type descriptor, as resolved in L2, is matched against the original callee method's symbolic type descriptor, as resolved in L1. The resolution in L1 happens when VH is created and its access mode types are assigned, while the resolution in L2 happens when the invokevirtual instruction is linked.

Apart from type descriptor checks, a VarHandles's capability to access it's variables is unrestricted. If a VarHandle is formed on a non-public variable by a class that has access to that variable, the resulting VarHandle can be used in any place by any caller who receives a reference to it.

Unlike with the Core Reflection API, where access is checked every time a reflective method is invoked, VarHandle access checking is performed when the VarHandle is created. Thus, VarHandles to non-public variables, or to variables in non-public classes, should generally be kept secret. They should not be passed to untrusted code unless their use from the untrusted code would be harmless.

<h1>VarHandle creation</h1> Java code can create a VarHandle that directly accesses any field that is accessible to that code. This is done via a reflective, capability-based API called java.lang.invoke.MethodHandles.Lookup MethodHandles.Lookup. For example, a VarHandle for a non-static field can be obtained from java.lang.invoke.MethodHandles.Lookup#findVarHandle Lookup.findVarHandle. There is also a conversion method from Core Reflection API objects, java.lang.invoke.MethodHandles.Lookup#unreflectVarHandle Lookup.unreflectVarHandle.

Access to protected field members is restricted to receivers only of the accessing class, or one of its subclasses, and the accessing class must in turn be a subclass (or package sibling) of the protected member's defining class. If a VarHandle refers to a protected non-static field of a declaring class outside the current package, the receiver argument will be narrowed to the type of the accessing class.

<h1>Interoperation between VarHandles and the Core Reflection API</h1> Using factory methods in the java.lang.invoke.MethodHandles.Lookup Lookup API, any field represented by a Core Reflection API object can be converted to a behaviorally equivalent VarHandle. For example, a reflective java.lang.reflect.Field Field can be converted to a VarHandle using java.lang.invoke.MethodHandles.Lookup#unreflectVarHandle Lookup.unreflectVarHandle. The resulting VarHandles generally provide more direct and efficient access to the underlying fields.

As a special case, when the Core Reflection API is used to view the signature polymorphic access mode methods in this class, they appear as ordinary non-polymorphic methods. Their reflective appearance, as viewed by java.lang.Class#getDeclaredMethod Class.getDeclaredMethod, is unaffected by their special status in this API. For example, java.lang.reflect.Method#getModifiers Method.getModifiers will report exactly those modifier bits required for any similarly declared method, including in this case native and varargs bits.

As with any reflected method, these methods (when reflected) may be invoked directly via java.lang.reflect.Method#invoke java.lang.reflect.Method.invoke, via JNI, or indirectly via java.lang.invoke.MethodHandles.Lookup#unreflect Lookup.unreflect. However, such reflective calls do not result in access mode method invocations. Such a call, if passed the required argument (a single one, of type Object[]), will ignore the argument and will throw an UnsupportedOperationException.

Since invokevirtual instructions can natively invoke VarHandle access mode methods under any symbolic type descriptor, this reflective view conflicts with the normal presentation of these methods via bytecodes. Thus, these native methods, when reflectively viewed by Class.getDeclaredMethod, may be regarded as placeholders only.

In order to obtain an invoker method for a particular access mode type, use java.lang.invoke.MethodHandles#varHandleExactInvoker or java.lang.invoke.MethodHandles#varHandleInvoker. The java.lang.invoke.MethodHandles.Lookup#findVirtual Lookup.findVirtual API is also able to return a method handle to call an access mode method for any specified access mode type and is equivalent in behaviour to java.lang.invoke.MethodHandles#varHandleInvoker.

<h1>Interoperation between VarHandles and Java generics</h1> A VarHandle can be obtained for a variable, such as a field, which is declared with Java generic types. As with the Core Reflection API, the VarHandle's variable type will be constructed from the erasure of the source-level type. When a VarHandle access mode method is invoked, the types of its arguments or the return value cast type may be generic types or type instances. If this occurs, the compiler will replace those types by their erasures when it constructs the symbolic type descriptor for the invokevirtual instruction.

Added in 9.

Java documentation for java.lang.invoke.VarHandle.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

VarHandle(IntPtr, JniHandleOwnership)

Properties

Class	Returns the runtime class of this Object. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass
ThresholdType

Methods

AccessModeType(VarHandle+AccessMode)
AcquireFence()	Ensures that loads before the fence will not be reordered with loads and stores after the fence.
Clone()	Creates and returns a copy of this object. (Inherited from Object)
CompareAndExchange(Object[])
CompareAndExchangeAcquire(Object[])
CompareAndExchangeRelease(Object[])
CompareAndSet(Object[])
CoordinateTypes()	Returns the coordinate types for this VarHandle.
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
FullFence()	Ensures that loads and stores before the fence will not be reordered with loads and stores after the fence.
Get(Object[])
GetAcquire(Object[])
GetAndAdd(Object[])
GetAndAddAcquire(Object[])
GetAndAddRelease(Object[])
GetAndBitwiseAnd(Object[])
GetAndBitwiseAndAcquire(Object[])
GetAndBitwiseAndRelease(Object[])
GetAndBitwiseOr(Object[])
GetAndBitwiseOrAcquire(Object[])
GetAndBitwiseOrRelease(Object[])
GetAndBitwiseXor(Object[])
GetAndBitwiseXorAcquire(Object[])
GetAndBitwiseXorRelease(Object[])
GetAndSet(Object[])
GetAndSetAcquire(Object[])
GetAndSetRelease(Object[])
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetOpaque(Object[])
GetVolatile(Object[])
IsAccessModeSupported(VarHandle+AccessMode)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
LoadLoadFence()	Ensures that loads before the fence will not be reordered with loads after the fence.
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
ReleaseFence()	Ensures that loads and stores before the fence will not be reordered with stores after the fence.
Set(Object[])
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetOpaque(Object[])
SetRelease(Object[])
SetVolatile(Object[])
StoreStoreFence()	Ensures that stores before the fence will not be reordered with stores after the fence.
ToArray<T>()	(Inherited from Object)
ToMethodHandle(VarHandle+AccessMode)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
VarType()	Returns the variable type of variables referenced by this VarHandle.
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
WeakCompareAndSet(Object[])
WeakCompareAndSetAcquire(Object[])
WeakCompareAndSetPlain(Object[])
WeakCompareAndSetRelease(Object[])

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)