summaryrefslogtreecommitdiff
path: root/src/arch/x86/isa/microops/base.isa
blob: 4254994f3a82290919a2ec7a97c89e9a6d23df52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
// -*- mode:c++ -*-

// Copyright (c) 2007 The Hewlett-Packard Development Company
// All rights reserved.
//
// Redistribution and use of this software in source and binary forms,
// with or without modification, are permitted provided that the
// following conditions are met:
//
// The software must be used only for Non-Commercial Use which means any
// use which is NOT directed to receiving any direct monetary
// compensation for, or commercial advantage from such use.  Illustrative
// examples of non-commercial use are academic research, personal study,
// teaching, education and corporate research & development.
// Illustrative examples of commercial use are distributing products for
// commercial advantage and providing services using the software for
// commercial advantage.
//
// If you wish to use this software or functionality therein that may be
// covered by patents for commercial use, please contact:
//     Director of Intellectual Property Licensing
//     Office of Strategy and Technology
//     Hewlett-Packard Company
//     1501 Page Mill Road
//     Palo Alto, California  94304
//
// 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 HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.  No right of
// sublicense is granted herewith.  Derivatives of the software and
// output created using the software may be prepared, but only for
// Non-Commercial Uses.  Derivatives of the software may be shared with
// others provided: (i) the others agree to abide by the list of
// conditions herein which includes the Non-Commercial Use restrictions;
// and (ii) such Derivatives of the software include the above copyright
// notice to acknowledge the contribution from this software where
// applicable, this list of conditions and the disclaimer below.
//
// 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.
//
// Authors: Gabe Black

//The operand types a microop template can be specialized with
output header {{
    enum OperandType {
        RegisterOperand,
        ImmediateOperand
    };
}};

//A class which is the base of all x86 micro ops. It provides a function to
//set necessary flags appropriately.
output header {{
    class X86MicroOpBase : public X86StaticInst
    {
      protected:
        uint8_t opSize;
        uint8_t addrSize;

        X86MicroOpBase(bool isMicro, bool isDelayed,
                bool isFirst, bool isLast,
                const char *mnem, ExtMachInst _machInst,
                OpClass __opClass) :
            X86StaticInst(mnem, _machInst, __opClass)
        {
            flags[IsMicroOp] = isMicro;
            flags[IsDelayedCommit] = isDelayed;
            flags[IsFirstMicroOp] = isFirst;
            flags[IsLastMicroOp] = isLast;
        }
    };
}};

// This sets up a class which is templated on the type of
// arguments a particular flavor of a microcode instruction
// can accept. It's parameters are specialized to create polymorphic
// behavior in microops.
def template BaseMicroOpTemplateDeclare {{
    template%(signature)s
    class %(class_name)s;
}};

let {{
    def buildBaseMicroOpTemplate(Name, numParams):
        assert(numParams > 0)
        signature = "<"
        signature += "int SignatureOperandTypeSpecifier0"
        for count in xrange(1,numParams):
            signature += \
                ", int SingatureOperandTypeSpecifier%d" % count
        signature += ">"
        subs = {"signature" : signature, "class_name" : Name}
        return BaseMicroOpTemplateDeclare.subst(subs)
}};

let {{
    def buildMicroOpTemplateDict(*params):
        signature = "<"
        if len(params):
            signature += params[0]
            if len(params) > 1:
                for param in params[1:]:
                    signature += ", %s" % param
        signature += ">"
        subs = {"param_dec" : "", "param_arg_dec" : "",
                "param_init" : "", "signature" : signature}
        for count in xrange(len(params)):
            subs["param_dec"] += "uint64_t param%d;\n" % count
            subs["param_arg_dec"] += ", uint64_t _param%d" % count
            subs["param_init"] += ", param%d(_param%d)" % (count, count)
        return subs
}};

// A tmeplate for building a specialized version of the microcode
// instruction which knows specifies which arguments it wants
def template MicroOpDeclare {{
    template<>
    class %(class_name)s%(signature)s : public X86MicroOpBase
    {
      protected:
        %(param_dec)s
        void buildMe();

      public:
        %(class_name)s(bool isMicro, bool isDelayed,
                bool isFirst, bool isLast,
                ExtMachInst _machInst %(param_arg_dec)s);

        %(class_name)s(ExtMachInst _machInst %(param_arg_dec)s);

        %(BasicExecDeclare)s
    };
}};

def template MicroOpConstructor {{

    inline void %(class_name)s%(signature)s::buildMe()
    {
        %(constructor)s;
    }

    inline %(class_name)s%(signature)s::%(class_name)s(
            ExtMachInst machInst %(param_arg_dec)s) :
        %(base_class)s(false, false, false, false,
                "%(mnemonic)s", machInst, %(op_class)s)
                %(param_init)s
    {
        buildMe();
    }

    inline %(class_name)s%(signature)s::%(class_name)s(
            bool isMicro, bool isDelayed, bool isFirst, bool isLast,
            ExtMachInst machInst %(param_arg_dec)s)
        : %(base_class)s(isMicro, isDelayed, isFirst, isLast,
                "%(mnemonic)s", machInst, %(op_class)s)
                %(param_init)s
    {
        buildMe();
    }
}};