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_MICROOP_HH__
41#define __ARCH_X86_INSTS_MICROOP_HH__
42
43#include "arch/x86/insts/static_inst.hh"
44
45namespace X86ISA
46{
47    namespace ConditionTests
48    {
49        enum CondTest {
50            True,
51            NotFalse = True,
52            ECF,
53            EZF,
54            SZnZF,
55            MSTRZ,
56            STRZ,
57            MSTRC,
58            STRZnEZF,
59            OF,
60            CF,
61            ZF,
62            CvZF,
63            SF,
64            PF,
65            SxOF,
66            SxOvZF,
67
68            False,
69            NotTrue = False,
70            NotECF,
71            NotEZF,
72            NotSZnZF,
73            NotMSTRZ,
74            NotSTRZ,
75            NotMSTRC,
76            STRnZnEZF,
77            NotOF,
78            NotCF,
79            NotZF,
80            NotCvZF,
81            NotSF,
82            NotPF,
83            NotSxOF,
84            NotSxOvZF
85        };
86    }
87
88    //A class which is the base of all x86 micro ops. It provides a function to
89    //set necessary flags appropriately.
90    class X86MicroopBase : public X86StaticInst
91    {
92      protected:
93        const char * instMnem;
94        uint8_t opSize;
95        uint8_t addrSize;
96
97        X86MicroopBase(ExtMachInst _machInst,
98                const char *mnem, const char *_instMnem,
99                uint64_t setFlags, OpClass __opClass) :
100            X86ISA::X86StaticInst(mnem, _machInst, __opClass),
101            instMnem(_instMnem)
102        {
103            const int ChunkSize = sizeof(unsigned long);
104            const int Chunks = sizeof(setFlags) / ChunkSize;
105
106            // Since the bitset constructor can only handle unsigned long
107            // sized chunks, feed it those one at a time while oring them in.
108            for (int i = 0; i < Chunks; i++) {
109                unsigned shift = i * ChunkSize * 8;
110                flags |= (std::bitset<Num_Flags>(setFlags >> shift) << shift);
111            }
112        }
113
114        std::string generateDisassembly(Addr pc,
115                const SymbolTable *symtab) const
116        {
117            std::stringstream ss;
118
119            ccprintf(ss, "\t%s.%s", instMnem, mnemonic);
120
121            return ss.str();
122        }
123
124        bool checkCondition(uint64_t flags, int condition) const;
125
126        void
127        advancePC(PCState &pcState) const
128        {
129            if (flags[IsLastMicroop])
130                pcState.uEnd();
131            else
132                pcState.uAdvance();
133        }
134    };
135}
136
137#endif //__ARCH_X86_INSTS_MICROOP_HH__
138