/*
 * Copyright (c) 2012 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.
 *
 * Copyright (c) 2003-2006 The Regents of The University of Michigan
 * All rights reserved.
 *
 * 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.
 */

#ifndef __SIM_PSEUDO_INST_HH__
#define __SIM_PSEUDO_INST_HH__

#include <gem5/asm/generic/m5ops.h>

#include "base/bitfield.hh"
#include "base/compiler.hh"
#include "base/logging.hh"
#include "base/trace.hh"
#include "base/types.hh" // For Tick and Addr data types.
#include "cpu/thread_context.hh"
#include "debug/PseudoInst.hh"
#include "sim/guest_abi.hh"

namespace gem5
{

GEM5_DEPRECATED_NAMESPACE(PseudoInst, pseudo_inst);
namespace pseudo_inst
{

static inline void
decodeAddrOffset(Addr offset, uint8_t &func)
{
    func = bits(offset, 15, 8);
}

void arm(ThreadContext *tc);
void quiesce(ThreadContext *tc);
void quiesceSkip(ThreadContext *tc);
void quiesceNs(ThreadContext *tc, uint64_t ns);
void quiesceCycles(ThreadContext *tc, uint64_t cycles);
uint64_t quiesceTime(ThreadContext *tc);
uint64_t readfile(ThreadContext *tc, Addr vaddr, uint64_t len,
    uint64_t offset);
uint64_t writefile(ThreadContext *tc, Addr vaddr, uint64_t len,
    uint64_t offset, Addr filenameAddr);
void loadsymbol(ThreadContext *xc);
void addsymbol(ThreadContext *tc, Addr addr, Addr symbolAddr);
uint64_t initParam(ThreadContext *xc, uint64_t key_str1, uint64_t key_str2);
uint64_t rpns(ThreadContext *tc);
void wakeCPU(ThreadContext *tc, uint64_t cpuid);
void m5exit(ThreadContext *tc, Tick delay);
void m5fail(ThreadContext *tc, Tick delay, uint64_t code);
uint64_t m5sum(ThreadContext *tc, uint64_t a, uint64_t b, uint64_t c,
                                  uint64_t d, uint64_t e, uint64_t f);
void resetstats(ThreadContext *tc, Tick delay, Tick period);
void dumpstats(ThreadContext *tc, Tick delay, Tick period);
void dumpresetstats(ThreadContext *tc, Tick delay, Tick period);
void m5checkpoint(ThreadContext *tc, Tick delay, Tick period);
void debugbreak(ThreadContext *tc);
void switchcpu(ThreadContext *tc);
void workbegin(ThreadContext *tc, uint64_t workid, uint64_t threadid);
void workend(ThreadContext *tc, uint64_t workid, uint64_t threadid);
void m5Syscall(ThreadContext *tc);
void togglesync(ThreadContext *tc);
void triggerWorkloadEvent(ThreadContext *tc);

/**
 * Execute a decoded M5 pseudo instruction
 *
 * The ISA-specific code is responsible to decode the pseudo inst
 * function number and subfunction number. After that has been done,
 * the rest of the instruction can be implemented in an ISA-agnostic
 * manner using the ISA-specific getArguments functions.
 *
 * @param func M5 pseudo op major function number (see utility/m5/m5ops.h)
 * @param result A reference to a uint64_t to store a result in.
 * @return Whether the pseudo instruction was recognized/handled.
 */

template <typename ABI, bool store_ret>
bool
pseudoInstWork(ThreadContext *tc, uint8_t func, uint64_t &result)
{
    DPRINTF(PseudoInst, "pseudo_inst::pseudoInst(%i)\n", func);

    result = 0;

    switch (func) {
      case M5OP_ARM:
        invokeSimcall<ABI>(tc, arm);
        return true;

      case M5OP_QUIESCE:
        invokeSimcall<ABI>(tc, quiesce);
        return true;

      case M5OP_QUIESCE_NS:
        invokeSimcall<ABI>(tc, quiesceNs);
        return true;

      case M5OP_QUIESCE_CYCLE:
        invokeSimcall<ABI>(tc, quiesceCycles);
        return true;

      case M5OP_QUIESCE_TIME:
        result = invokeSimcall<ABI, store_ret>(tc, quiesceTime);
        return true;

      case M5OP_RPNS:
        result = invokeSimcall<ABI, store_ret>(tc, rpns);
        return true;

      case M5OP_WAKE_CPU:
        invokeSimcall<ABI>(tc, wakeCPU);
        return true;

      case M5OP_EXIT:
        invokeSimcall<ABI>(tc, m5exit);
        return true;

      case M5OP_FAIL:
        invokeSimcall<ABI>(tc, m5fail);
        return true;

      // M5OP_SUM is for sanity checking the gem5 op interface.
      case M5OP_SUM:
        result = invokeSimcall<ABI, store_ret>(tc, m5sum);
        return true;

      case M5OP_INIT_PARAM:
        result = invokeSimcall<ABI, store_ret>(tc, initParam);
        return true;

      case M5OP_LOAD_SYMBOL:
        invokeSimcall<ABI>(tc, loadsymbol);
        return true;

      case M5OP_RESET_STATS:
        invokeSimcall<ABI>(tc, resetstats);
        return true;

      case M5OP_DUMP_STATS:
        invokeSimcall<ABI>(tc, dumpstats);
        return true;

      case M5OP_DUMP_RESET_STATS:
        invokeSimcall<ABI>(tc, dumpresetstats);
        return true;

      case M5OP_CHECKPOINT:
        invokeSimcall<ABI>(tc, m5checkpoint);
        return true;

      case M5OP_WRITE_FILE:
        result = invokeSimcall<ABI, store_ret>(tc, writefile);
        return true;

      case M5OP_READ_FILE:
        result = invokeSimcall<ABI, store_ret>(tc, readfile);
        return true;

      case M5OP_DEBUG_BREAK:
        invokeSimcall<ABI>(tc, debugbreak);
        return true;

      case M5OP_SWITCH_CPU:
        invokeSimcall<ABI>(tc, switchcpu);
        return true;

      case M5OP_ADD_SYMBOL:
        invokeSimcall<ABI>(tc, addsymbol);
        return true;

      case M5OP_PANIC:
        panic("M5 panic instruction called at %s\n", tc->pcState());

      case M5OP_WORK_BEGIN:
        invokeSimcall<ABI>(tc, workbegin);
        return true;

      case M5OP_WORK_END:
        invokeSimcall<ABI>(tc, workend);
        return true;

      case M5OP_RESERVED1:
      case M5OP_RESERVED2:
      case M5OP_RESERVED3:
      case M5OP_RESERVED4:
      case M5OP_RESERVED5:
        warn("Unimplemented m5 op (%#x)\n", func);
        return false;

      /* dist-gem5 functions */
      case M5OP_DIST_TOGGLE_SYNC:
        invokeSimcall<ABI>(tc, togglesync);
        return true;

      case M5OP_WORKLOAD:
        invokeSimcall<ABI>(tc, triggerWorkloadEvent);
        return true;

      default:
        warn("Unhandled m5 op: %#x\n", func);
        return false;
    }
}

template <typename ABI, bool store_ret=false>
bool
pseudoInst(ThreadContext *tc, uint8_t func, uint64_t &result)
{
    return pseudoInstWork<ABI, store_ret>(tc, func, result);
}

template <typename ABI, bool store_ret=true>
bool
pseudoInst(ThreadContext *tc, uint8_t func)
{
    uint64_t result;
    return pseudoInstWork<ABI, store_ret>(tc, func, result);
}

} // namespace pseudo_inst
} // namespace gem5

#endif // __SIM_PSEUDO_INST_HH__