1// -*- mode:c++ -*-
2
3// Copyright (c) 2007 The Hewlett-Packard Development Company
4// All rights reserved.
5//
6// The license below extends only to copyright in the software and shall
7// not be construed as granting a license to any other intellectual
8// property including but not limited to intellectual property relating
9// to a hardware implementation of the functionality of the software
10// licensed hereunder.  You may use the software subject to the license
11// terms below provided that you ensure that this notice is replicated
12// unmodified and in its entirety in all distributions of the software,
13// modified or unmodified, in source code or in binary form.
14//
15// Redistribution and use in source and binary forms, with or without
16// modification, are permitted provided that the following conditions are
17// met: redistributions of source code must retain the above copyright
18// notice, this list of conditions and the following disclaimer;
19// redistributions in binary form must reproduce the above copyright
20// notice, this list of conditions and the following disclaimer in the
21// documentation and/or other materials provided with the distribution;
22// neither the name of the copyright holders nor the names of its
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Authors: Gabe Black
39
40let {{
41    # This will be populated with mappings between microop mnemonics and
42    # the classes that represent them.
43    microopClasses = {}
44}};
45
46//////////////////////////////////////////////////////////////////////////
47//
48// Base class for the python representation of x86 microops
49//
50//////////////////////////////////////////////////////////////////////////
51
52let {{
53    class X86Microop(object):
54
55        generatorNameTemplate = "generate_%s_%d"
56
57        generatorTemplate = '''
58            StaticInstPtr
59            ''' + generatorNameTemplate + '''(StaticInstPtr curMacroop)
60            {
61                static const char *macrocodeBlock = romMnemonic;
62                static ExtMachInst dummyExtMachInst;
63                static const EmulEnv dummyEmulEnv(0, 0, 1, 1, 1);
64
65                Macroop * macroop = dynamic_cast<Macroop *>(curMacroop.get());
66                const ExtMachInst &machInst =
67                    macroop ? macroop->getExtMachInst() : dummyExtMachInst;
68                const EmulEnv &env =
69                    macroop ? macroop->getEmulEnv() : dummyEmulEnv;
70                // env may not be used in the microop's constructor.
71                InstRegIndex reg(env.reg);
72                reg = reg;
73                using namespace RomLabels;
74                return %s;
75            }
76        '''
77
78        def __init__(self, name):
79            self.name = name
80
81        def microFlagsText(self, flags):
82            wrapped = ("(1ULL << StaticInst::%s)" % flag for flag in flags)
83            return " | ".join(wrapped)
84
85        def getGeneratorDef(self, micropc):
86            return self.generatorTemplate % \
87                (self.className, micropc, \
88                 self.getAllocator(["IsMicroop", "IsDelayedCommit"]))
89
90        def getGenerator(self, micropc):
91            return self.generatorNameTemplate % (self.className, micropc)
92}};
93