/*
 * Copyright (c) 2020 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * 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;
 * neither the name of the copyright holders 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
 * OWNER 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.
 */

#include "mem/htm.hh"

namespace gem5
{

std::string
htmFailureToStr(HtmFailureFaultCause cause)
{
    static const std::map<HtmFailureFaultCause, std::string> cause_to_str = {
        { HtmFailureFaultCause::EXPLICIT, "explicit" },
        { HtmFailureFaultCause::NEST, "nesting_limit" },
        { HtmFailureFaultCause::SIZE, "transaction_size" },
        { HtmFailureFaultCause::EXCEPTION, "exception" },
        { HtmFailureFaultCause::MEMORY, "memory_conflict" },
        { HtmFailureFaultCause::OTHER, "other" }
    };

    auto it = cause_to_str.find(cause);
    return it == cause_to_str.end() ? "Unrecognized Failure" : it->second;
}

std::string
htmFailureToStr(HtmCacheFailure rc)
{
    static const std::map<HtmCacheFailure, std::string> rc_to_str = {
        { HtmCacheFailure::NO_FAIL, "NO_FAIL" },
        { HtmCacheFailure::FAIL_SELF, "FAIL_SELF" },
        { HtmCacheFailure::FAIL_REMOTE, "FAIL_REMOTE" },
        { HtmCacheFailure::FAIL_OTHER, "FAIL_OTHER" }
    };

    auto it = rc_to_str.find(rc);
    return it == rc_to_str.end() ? "Unrecognized Failure" : it->second;
}

} // namespace gem5