1/*
2 * Copyright (c) 2015 RISC-V Foundation
3 * Copyright (c) 2016 The University of Virginia
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Maxwell Walter
30 *          Alec Roelke
31 */
32
33#ifndef __ARCH_RISCV_STATIC_INST_HH__
34#define __ARCH_RISCV_STATIC_INST_HH__
35
36#include <string>
37
38#include "arch/riscv/types.hh"
39#include "cpu/exec_context.hh"
40#include "cpu/static_inst.hh"
41#include "mem/packet.hh"
42
43namespace RiscvISA
44{
45
46/**
47 * Base class for all RISC-V static instructions.
48 */
49class RiscvStaticInst : public StaticInst
50{
51  protected:
52    using StaticInst::StaticInst;
53
54  public:
55    void advancePC(PCState &pc) const override { pc.advance(); }
56
57    size_t
58    asBytes(void *buf, size_t size) override
59    {
60        return simpleAsBytes(buf, size, machInst);
61    }
62};
63
64/**
65 * Base class for all RISC-V Macroops
66 */
67class RiscvMacroInst : public RiscvStaticInst
68{
69  protected:
70    std::vector<StaticInstPtr> microops;
71
72    RiscvMacroInst(const char *mnem, ExtMachInst _machInst,
73                   OpClass __opClass) :
74            RiscvStaticInst(mnem, _machInst, __opClass)
75    {
76        flags[IsMacroop] = true;
77    }
78
79    ~RiscvMacroInst() { microops.clear(); }
80
81    StaticInstPtr
82    fetchMicroop(MicroPC upc) const override
83    {
84        return microops[upc];
85    }
86
87    Fault
88    initiateAcc(ExecContext *xc, Trace::InstRecord *traceData) const override
89    {
90        panic("Tried to execute a macroop directly!\n");
91    }
92
93    Fault
94    completeAcc(PacketPtr pkt, ExecContext *xc,
95                Trace::InstRecord *traceData) const override
96    {
97        panic("Tried to execute a macroop directly!\n");
98    }
99
100    Fault
101    execute(ExecContext *xc, Trace::InstRecord *traceData) const override
102    {
103        panic("Tried to execute a macroop directly!\n");
104    }
105};
106
107/**
108 * Base class for all RISC-V Microops
109 */
110class RiscvMicroInst : public RiscvStaticInst
111{
112  protected:
113    RiscvMicroInst(const char *mnem, ExtMachInst _machInst,
114                   OpClass __opClass) :
115            RiscvStaticInst(mnem, _machInst, __opClass)
116    {
117        flags[IsMicroop] = true;
118    }
119
120    void advancePC(PCState &pcState) const override;
121};
122
123}
124
125#endif // __ARCH_RISCV_STATIC_INST_HH__
126