Pull some hard coded base classes out of the isa description.
[gem5.git] / src / arch / x86 / isa / microops / base.isa
1 // -*- mode:c++ -*-
2
3 // Copyright (c) 2007 The Hewlett-Packard Development Company
4 // All rights reserved.
5 //
6 // Redistribution and use of this software in source and binary forms,
7 // with or without modification, are permitted provided that the
8 // following conditions are met:
9 //
10 // The software must be used only for Non-Commercial Use which means any
11 // use which is NOT directed to receiving any direct monetary
12 // compensation for, or commercial advantage from such use. Illustrative
13 // examples of non-commercial use are academic research, personal study,
14 // teaching, education and corporate research & development.
15 // Illustrative examples of commercial use are distributing products for
16 // commercial advantage and providing services using the software for
17 // commercial advantage.
18 //
19 // If you wish to use this software or functionality therein that may be
20 // covered by patents for commercial use, please contact:
21 // Director of Intellectual Property Licensing
22 // Office of Strategy and Technology
23 // Hewlett-Packard Company
24 // 1501 Page Mill Road
25 // Palo Alto, California 94304
26 //
27 // Redistributions of source code must retain the above copyright notice,
28 // this list of conditions and the following disclaimer. Redistributions
29 // in binary form must reproduce the above copyright notice, this list of
30 // conditions and the following disclaimer in the documentation and/or
31 // other materials provided with the distribution. Neither the name of
32 // the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
33 // contributors may be used to endorse or promote products derived from
34 // this software without specific prior written permission. No right of
35 // sublicense is granted herewith. Derivatives of the software and
36 // output created using the software may be prepared, but only for
37 // Non-Commercial Uses. Derivatives of the software may be shared with
38 // others provided: (i) the others agree to abide by the list of
39 // conditions herein which includes the Non-Commercial Use restrictions;
40 // and (ii) such Derivatives of the software include the above copyright
41 // notice to acknowledge the contribution from this software where
42 // applicable, this list of conditions and the disclaimer below.
43 //
44 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
45 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
46 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
47 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
48 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
54 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 //
56 // Authors: Gabe Black
57
58 let {{
59 # This will be populated with mappings between microop mnemonics and
60 # the classes that represent them.
61 microopClasses = {}
62 }};
63
64 //////////////////////////////////////////////////////////////////////////
65 //
66 // Base class for the python representation of x86 microops
67 //
68 //////////////////////////////////////////////////////////////////////////
69
70 let {{
71 class X86Microop(object):
72 def __init__(self, name):
73 self.name = name
74
75 # This converts a python bool into a C++ bool
76 def cppBool(self, val):
77 if val:
78 return "true"
79 else:
80 return "false"
81
82 # This converts a list of python bools into
83 # a comma seperated list of C++ bools.
84 def microFlagsText(self, vals):
85 text = ""
86 for val in vals:
87 text += ", %s" % self.cppBool(val)
88 return text
89
90 def getAllocator(self, mnemonic, *microFlags):
91 return 'new %s(machInst, %s)' % (self.className, mnemonic, self.microFlagsText(microFlags))
92 }};
93
94 //////////////////////////////////////////////////////////////////////////
95 //
96 // FpOp Microop templates
97 //
98 //////////////////////////////////////////////////////////////////////////
99
100 //TODO Actually write an fp microop base class.