mipsy.py 8.98 KB
Newer Older
1
#!/usr/bin/env python
Benoit Perrot's avatar
Benoit Perrot committed
2
3
##
## This file is part of Mipsy, a tiny MIPS simulator
Benoit Perrot's avatar
Benoit Perrot committed
4
## Copyright (C) 2003, 2004 Benoit Perrot <benoit@lrde.epita.fr>
Benoit Perrot's avatar
Benoit Perrot committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
##
## Mipsy is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
## 
## Mipsy is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
## 
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##
20
21

import string
Benoit Perrot's avatar
Benoit Perrot committed
22
import sys, os.path, filecmp, shutil
23
24
25
26
from xml.sax import ContentHandler, make_parser

## ---------------------------------------------------------------------------

Benoit Perrot's avatar
Benoit Perrot committed
27
28
license = """//
// This file is part of Mipsy, a tiny MIPS simulator
Benoit Perrot's avatar
Benoit Perrot committed
29
// Copyright (C) 2003, 2004 Benoit Perrot <benoit@lrde.epita.fr>
Benoit Perrot's avatar
Benoit Perrot committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
//
// Mipsy is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
// 
// Mipsy is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//"""
45
46
47
48
49
50
51
52
53
54
55
56
57
58

## ---------------------------------------------------------------------------
def depth(root):
  if len(root) == 0:
    return []
  res = []
  children = [ [] ]
  if len(root) > 1:
    children = depth(root[1:])
  for e in root[0]:
    for child in children:
      res.append([e] + child)
  return res

Benoit Perrot's avatar
Benoit Perrot committed
59
60
61
62
63
64
65
66
## Overwrite file if different
def lazy_overwrite(ref, new):
  if not os.path.isfile(ref) or \
         not filecmp.cmp(ref, new):
    print "> Overwrite: " + ref
    shutil.copy(new, ref)

## Return a conventional macro identifier
67
68
def define_id(s):
  return string.upper(s)
Benoit Perrot's avatar
Benoit Perrot committed
69
70

## Return a conventional C++ class identifier
71
def class_id(s):
Benoit Perrot's avatar
Benoit Perrot committed
72
  # Rename j as jmp for convenience
73
74
75
76
77
  if s == "j":
    return "Jmp"
  res = ""
  non_ascii = True
  for i in range(0, len(s)):
Benoit Perrot's avatar
Benoit Perrot committed
78
    if s[i] in string.ascii_letters or s[i] in string.digits:
79
80
81
82
      if non_ascii:
        res = res + string.upper(s[i])
        non_ascii = False
      else:
Benoit Perrot's avatar
Benoit Perrot committed
83
        res = res + s[i]
84
85
86
87
    else:
      non_ascii = True
  return res

Benoit Perrot's avatar
Benoit Perrot committed
88
89
90
## Return a conventional file name
def file_id(s):
  return string.lower(s)
91

Benoit Perrot's avatar
Benoit Perrot committed
92
93
94
95
96
97
98
## Return a valid C++ variable name
def var_id(s):
  s = string.lower(s)
  if s in ["and", "or", "xor"]:
    s = s + "_";
  return s

99
## -------------------------------------
Benoit Perrot's avatar
Benoit Perrot committed
100
class Attribute:
Benoit Perrot's avatar
Benoit Perrot committed
101
  def __init__(self, type, restriction, name, value):
Benoit Perrot's avatar
Benoit Perrot committed
102
    self.type = type
Benoit Perrot's avatar
Benoit Perrot committed
103
    self.restriction = restriction
104
    self.name = name
Benoit Perrot's avatar
Benoit Perrot committed
105
106
    self.value = value # FIXME: useless
  def __str__(self):
Benoit Perrot's avatar
Benoit Perrot committed
107
108
109
    return "<attribute type=\"" + self.type + \
           "\" restriction=\"" + self.restriction + \
           "\" name=\"" + self.name +"\" />"
Benoit Perrot's avatar
Benoit Perrot committed
110
class AttributeBuilder:
111
  def reset(self):
Benoit Perrot's avatar
Benoit Perrot committed
112
    self.type = ""
Benoit Perrot's avatar
Benoit Perrot committed
113
    self.restriction = ""
114
    self.name = ""
Benoit Perrot's avatar
Benoit Perrot committed
115
    self.value = ""# FIXME: useless
116
117
118
  def __init__(self):
    self.reset()
  def get(self):
Benoit Perrot's avatar
Benoit Perrot committed
119
    assert(self.type != "" and self.name != "")
Benoit Perrot's avatar
Benoit Perrot committed
120
    return Attribute(self.type, self.restriction, self.name, self.value)
121
122

class Format:
Benoit Perrot's avatar
Benoit Perrot committed
123
124
125
126
127
128
129
  def __init__(self, attributes):
    self.attributes = attributes
  def __str__(self):
    res = "  <format>"
    for p in self.attributes:
      res = res + "\n    " + str(p)
    return res + "\n  </format>"
130
131
class FormatBuilder:
  def reset(self):
Benoit Perrot's avatar
Benoit Perrot committed
132
    self.attributes = []
133
134
  def __init__(self):
    self.reset()
Benoit Perrot's avatar
Benoit Perrot committed
135
136
137
  def get(self):
    return Format(self.attributes)

138

Benoit Perrot's avatar
Benoit Perrot committed
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
## -------------------------------------
class Token:
  def __init__(self, kind, name, value, default):
    self.kind = kind
    self.name = name
    self.value = value
    self.default = default
  def __str__(self):
    res = "<token kind=\"" + self.kind + "\" "
    if self.name != "":
      res = res + "name=\"" + self.name + "\" "
    if self.value != "":
      res = res + "value=\"" + self.value + "\" "
    if self.default != "":
      res = res + "default=\"" + self.default + "\" "
    return res + "/>"
class TokenBuilder:
  def reset(self):
    self.kind = ""
    self.name = ""
    self.value = "" 
    self.default = ""
  def __init__(self):
    self.reset()
163
  def get(self):
Benoit Perrot's avatar
Benoit Perrot committed
164
165
    assert(self.kind != "")
    return Token(self.kind, self.name, self.value, self.default)
166
167

class Syntax:
Benoit Perrot's avatar
Benoit Perrot committed
168
169
  def __init__(self, tokens, alias, level):
    self.tokens = tokens
170
    self.alias = alias
Benoit Perrot's avatar
Benoit Perrot committed
171
    self.level = level
Benoit Perrot's avatar
Benoit Perrot committed
172
173
  def __str__(self):
    res = "  <syntax"
174
    if self.alias != "":
Benoit Perrot's avatar
Benoit Perrot committed
175
176
177
178
179
      res = res + " alias=\"" + self.alias + "\""
    res = res + ">"
    for t in self.tokens:
      res = res + "\n    " + str(t)
    return res + "\n  </syntax>"
180
181
class SyntaxBuilder:
  def reset(self):
Benoit Perrot's avatar
Benoit Perrot committed
182
    self.tokens = []
183
184
185
186
    self.alias = ""
  def __init__(self):
    self.reset()
  def get(self):
Benoit Perrot's avatar
Benoit Perrot committed
187
    return Syntax(self.tokens, self.alias, self.level)
188
189
190
191


## -------------------------------------
class Instruction:
Benoit Perrot's avatar
Benoit Perrot committed
192
  def __init__(self, opcode, level, kind, desc, format, syntaxes):
193
194
    self.opcode = opcode
    self.level = level
Benoit Perrot's avatar
Benoit Perrot committed
195
    self.kind = kind
Benoit Perrot's avatar
Benoit Perrot committed
196
    self.desc = desc
197
198
    self.format = format
    self.syntaxes = syntaxes
Benoit Perrot's avatar
Benoit Perrot committed
199
200
201
202
203
204
  def __str__(self):
    res = "<instruction opcode=\"" + self.opcode + \
          "\" level=\"" + self.level + \
          "\" kind=\"" + self.kind + ">\n" + \
          "  <description>" + self.desc + "</description>\n" + \
          str(self.format) + "\n"
205
    for s in self.syntaxes:
Benoit Perrot's avatar
Benoit Perrot committed
206
207
      res = res + str(s) + "\n"
    return res + "</instruction>"
208
209
210
211
212

class InstructionBuilder:
  def reset(self):
    self.opcode = ""
    self.level = ""
Benoit Perrot's avatar
Benoit Perrot committed
213
    self.kind = ""
Benoit Perrot's avatar
Benoit Perrot committed
214
    self.desc = ""
215
216
217
218
219
    self.format = Format("")
    self.syntaxes = []
  def __init__(self):
    self.reset()
  def get(self):
Benoit Perrot's avatar
Benoit Perrot committed
220
221
    assert(self.opcode != "" and self.level != "" and self.kind != "")
    return Instruction(self.opcode, self.level, self.kind, self.desc,
Benoit Perrot's avatar
Benoit Perrot committed
222
                       self.format, self.syntaxes)
223
224


Benoit Perrot's avatar
Benoit Perrot committed
225
## -------------------------------------
226
class InstructionSetHandler(ContentHandler):
Benoit Perrot's avatar
Benoit Perrot committed
227
228
229
230
231
232
233
234
235
236
  def reset(self):
    self.attr_b = AttributeBuilder()
    self.format_b = None
    self.token_b = TokenBuilder()
    self.syntax_b = SyntaxBuilder()
    self.inst_b = InstructionBuilder()
    self.instructions = []
    self.content = ""
  def __init__(self):
    self.reset()
237
238
239
  
  def startElement(self, name, attrs):
    if name == "instruction":
Benoit Perrot's avatar
Benoit Perrot committed
240
241
242
243
244
245
      self.inst_b.reset()
      self.inst_b.opcode = attrs["opcode"]
      self.inst_b.level = attrs["level"]
      self.inst_b.kind = attrs["kind"]
    elif name == "description":
      self.content = ""
246
    elif name == "format":
Benoit Perrot's avatar
Benoit Perrot committed
247
248
249
250
      self.format_b = FormatBuilder()
    elif name == "attribute":
      self.attr_b.reset()
      self.attr_b.type = attrs["type"]
Benoit Perrot's avatar
Benoit Perrot committed
251
252
      if attrs.has_key("restriction"):
        self.attr_b.restriction = attrs["restriction"]
Benoit Perrot's avatar
Benoit Perrot committed
253
254
255
256
257
      self.attr_b.name = attrs["name"]
#       if attrs.has_key("default"):
#         self.attr_b.default = attrs["default"]
#       if attrs.has_key("value"):
#         self.attr_b.value = attrs["value"]
258
    elif name == "syntax":
Benoit Perrot's avatar
Benoit Perrot committed
259
      self.syntax_b.reset()
260
      if attrs.has_key("alias"):
Benoit Perrot's avatar
Benoit Perrot committed
261
        self.syntax_b.alias = attrs["alias"]
Benoit Perrot's avatar
Benoit Perrot committed
262
      if attrs.has_key("level"):
Benoit Perrot's avatar
Benoit Perrot committed
263
        self.syntax_b.level = attrs["level"]
Benoit Perrot's avatar
Benoit Perrot committed
264
      else:
Benoit Perrot's avatar
Benoit Perrot committed
265
266
267
268
        self.syntax_b.level = self.inst_b.level
    elif name == "token":
      self.token_b.reset()
      self.token_b.kind = attrs["kind"]
269
      if attrs.has_key("name"):
Benoit Perrot's avatar
Benoit Perrot committed
270
        self.token_b.name = attrs["name"]
271
      if attrs.has_key("default"):
Benoit Perrot's avatar
Benoit Perrot committed
272
        self.token_b.default = attrs["default"]
273
      if attrs.has_key("value"):
Benoit Perrot's avatar
Benoit Perrot committed
274
        self.token_b.value = attrs["value"]
275
276

  def endElement(self, name):
Benoit Perrot's avatar
Benoit Perrot committed
277
278
    if name == "token":
      self.syntax_b.tokens.append(self.token_b.get())
279
    elif name == "syntax":
Benoit Perrot's avatar
Benoit Perrot committed
280
281
282
      self.inst_b.syntaxes.append(self.syntax_b.get())
    if name == "attribute":
      self.format_b.attributes.append(self.attr_b.get())
283
    elif name == "format":
Benoit Perrot's avatar
Benoit Perrot committed
284
285
286
      self.inst_b.format = self.format_b.get()
    elif name == "description":
      self.inst_b.desc = self.content
287
    elif name == "instruction":
Benoit Perrot's avatar
Benoit Perrot committed
288
289
290
291
      self.instructions.append(self.inst_b.get())

  def characters (self, content):
    self.content = self.content + content
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307

class InstructionSetParser:

  def parse(self, file):
    # Create a parser
    parser = make_parser()
    # Create the handler
    h = InstructionSetHandler()
    # Tell the parser to use our handler
    parser.setContentHandler(h)
    
    # Parse the input
    parser.parse(file)

    # Return Instruction set
    return h.instructions