io.github.thepun.unsafe.MemoryFence Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unsafe-utils Show documentation

Utility library for easier access to sun.misc.Unsafe class

The newest version!

/**
 * Copyright (C)2011 - Marat Gariev 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.github.thepun.unsafe;

import sun.misc.Unsafe;

/**
 * Utility class for placing memory barriers
 */
public final class MemoryFence {

    private static final Unsafe UNSAFE_INSTANCE = UnsafeLocator.getUnsafe();

    /**
     * LoadLoad/LoadStore memory barrier
     *
     * Ensures lack of reordering of loads before the fence
     * with loads or stores after the fence
     */
    public static void load() {
        UNSAFE_INSTANCE.loadFence();
    }

    /**
     * LoadStore/StoreStore memory barrier
     *
     * Ensures lack of reordering of stores before the fence
     * with loads or stores after the fence.
     */
    public static void store() {
        UNSAFE_INSTANCE.storeFence();
    }

    /**
     * Full memory barrier
     *
     * Ensures lack of reordering of loads or stores before the fence
     * with loads or stores after the fence.
     */
    public static void full() {
        UNSAFE_INSTANCE.fullFence();
    }


    private MemoryFence() {
    }
}