1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
3 * All rights reserved.
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Gabe Black
38 */
39
40#ifndef __ARCH_X86_INSTS_MACROOP_HH__
41#define __ARCH_X86_INSTS_MACROOP_HH__
42
43#include "arch/x86/insts/badmicroop.hh"
44#include "arch/x86/insts/static_inst.hh"
45#include "arch/x86/emulenv.hh"
46#include "arch/x86/types.hh"
47
48namespace X86ISA
49{
50// Base class for combinationally generated macroops
51class MacroopBase : public X86StaticInst
52{
53  protected:
54    const char *macrocodeBlock;
55
56    const uint32_t numMicroops;
57    X86ISA::EmulEnv env;
58
59    //Constructor.
60    MacroopBase(const char *mnem, ExtMachInst _machInst,
61            uint32_t _numMicroops, X86ISA::EmulEnv _env) :
62                X86StaticInst(mnem, _machInst, No_OpClass),
63                numMicroops(_numMicroops), env(_env)
64    {
65        assert(numMicroops);
66        microops = new StaticInstPtr[numMicroops];
67        flags[IsMacroop] = true;
68    }
69
70    ~MacroopBase()
71    {
72        delete [] microops;
73    }
74
75    StaticInstPtr * microops;
76
77    StaticInstPtr
78    fetchMicroop(MicroPC microPC) const
79    {
80        if (microPC >= numMicroops)
81            return badMicroop;
82        else
83            return microops[microPC];
84    }
85
86    std::string
87    generateDisassembly(Addr pc, const SymbolTable *symtab) const
88    {
89        return mnemonic;
90    }
91
92  public:
93    ExtMachInst
94    getExtMachInst()
95    {
96        return machInst;
97    }
98
99    X86ISA::EmulEnv
100    getEmulEnv()
101    {
102        return env;
103    }
104};
105}
106
107#endif //__ARCH_X86_INSTS_MACROOP_HH__
108