/*
 * Copyright (c) 2016, Oracle and/or its affiliates.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided
 * with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
 * endorse or promote products derived from this software without specific prior written
 * permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.oracle.truffle.llvm.parser.model.enums;

public enum AtomicOrdering {
    NOT_ATOMIC(0L, ""),
    UNORDERED(1L, "unordered"),
    MONOTONIC(2L, "monotonic"),
    ACQUIRE(3L, "acquire"),
    RELEASE(4L, "release"),
    ACQUIRE_RELEASE(5L, "acq_rel"),
    SEQUENTIALLY_CONSISTENT(6L, "seq_cst");

    private final long encodedValue;
    private final String irString;

    AtomicOrdering(long encodeValue, String irString) {
        this.encodedValue = encodeValue;
        this.irString = irString;
    }

    public long getEncodedValue() {
        return encodedValue;
    }

    /**
     * Useful to get the llvm ir equivalent string of the enum.
     */
    public String getIrString() {
        return irString;
    }

    public static AtomicOrdering decode(long id) {
        for (AtomicOrdering atomicOrdering : values()) {
            if (atomicOrdering.getEncodedValue() == id) {
                return atomicOrdering;
            }
        }
        return SEQUENTIALLY_CONSISTENT;
    }

    public static AtomicOrdering getOrStrongestFailureOrdering(long id, AtomicOrdering successOrdering) {
        for (AtomicOrdering atomicOrdering : values()) {
            if (atomicOrdering.getEncodedValue() == id) {
                return atomicOrdering;
            }
        }
        switch (successOrdering) {
            case RELEASE:
            case MONOTONIC:
                return MONOTONIC;
            case ACQUIRE_RELEASE:
            case ACQUIRE:
                return ACQUIRE;
            case SEQUENTIALLY_CONSISTENT:
                return SEQUENTIALLY_CONSISTENT;
            default:
                throw new AssertionError("Invalid SuccessOrdering: " + successOrdering);
        }
    }
}