DMA: Split the DMA device and IO device into seperate files
[gem5.git] / src / arch / isa_parser.py
index 8e13b6a6a8879ece9473f3c05946f337ceff955a..c0cdebe11cc8802ed94f5328f1dbd4fe467db905 100755 (executable)
@@ -171,6 +171,8 @@ class Template(object):
             operands = SubOperandList(self.parser, compositeCode, d.operands)
 
             myDict['op_decl'] = operands.concatAttrStrings('op_decl')
+            if operands.readPC or operands.setPC:
+                myDict['op_decl'] += 'TheISA::PCState __parserAutoPCState;\n'
 
             is_src = lambda op: op.is_src
             is_dest = lambda op: op.is_dest
@@ -179,13 +181,33 @@ class Template(object):
                       operands.concatSomeAttrStrings(is_src, 'op_src_decl')
             myDict['op_dest_decl'] = \
                       operands.concatSomeAttrStrings(is_dest, 'op_dest_decl')
+            if operands.readPC:
+                myDict['op_src_decl'] += \
+                    'TheISA::PCState __parserAutoPCState;\n'
+            if operands.setPC:
+                myDict['op_dest_decl'] += \
+                    'TheISA::PCState __parserAutoPCState;\n'
 
             myDict['op_rd'] = operands.concatAttrStrings('op_rd')
-            myDict['op_wb'] = operands.concatAttrStrings('op_wb')
-
-            if d.operands.memOperand:
-                myDict['mem_acc_size'] = d.operands.memOperand.mem_acc_size
-                myDict['mem_acc_type'] = d.operands.memOperand.mem_acc_type
+            if operands.readPC:
+                myDict['op_rd'] = '__parserAutoPCState = xc->pcState();\n' + \
+                                  myDict['op_rd']
+
+            # Compose the op_wb string. If we're going to write back the
+            # PC state because we changed some of its elements, we'll need to
+            # do that as early as possible. That allows later uncoordinated
+            # modifications to the PC to layer appropriately.
+            reordered = list(operands.items)
+            reordered.reverse()
+            op_wb_str = ''
+            pcWbStr = 'xc->pcState(__parserAutoPCState);\n'
+            for op_desc in reordered:
+                if op_desc.isPCPart() and op_desc.is_dest:
+                    op_wb_str = op_desc.op_wb + pcWbStr + op_wb_str
+                    pcWbStr = ''
+                else:
+                    op_wb_str = op_desc.op_wb + op_wb_str
+            myDict['op_wb'] = op_wb_str
 
         elif isinstance(d, dict):
             # if the argument is a dictionary, we just use it.
@@ -391,29 +413,18 @@ class Operand(object):
         subst_dict = {"name": self.base_name,
                       "func": func,
                       "reg_idx": self.reg_spec,
-                      "size": self.size,
                       "ctype": self.ctype}
         if hasattr(self, 'src_reg_idx'):
             subst_dict['op_idx'] = self.src_reg_idx
         code = self.read_code % subst_dict
-        if self.size != self.dflt_size:
-            return '%s = bits(%s, %d, 0);\n' % \
-                   (self.base_name, code, self.size-1)
-        else:
-            return '%s = %s;\n' % \
-                   (self.base_name, code)
+        return '%s = %s;\n' % (self.base_name, code)
 
     def buildWriteCode(self, func = None):
-        if (self.size != self.dflt_size and self.is_signed):
-            final_val = 'sext<%d>(%s)' % (self.size, self.base_name)
-        else:
-            final_val = self.base_name
         subst_dict = {"name": self.base_name,
                       "func": func,
                       "reg_idx": self.reg_spec,
-                      "size": self.size,
                       "ctype": self.ctype,
-                      "final_val": final_val}
+                      "final_val": self.base_name}
         if hasattr(self, 'dest_reg_idx'):
             subst_dict['op_idx'] = self.dest_reg_idx
         code = self.write_code % subst_dict
@@ -422,7 +433,7 @@ class Operand(object):
             %s final_val = %s;
             %s;
             if (traceData) { traceData->setData(final_val); }
-        }''' % (self.dflt_ctype, final_val, code)
+        }''' % (self.dflt_ctype, self.base_name, code)
 
     def __init__(self, parser, full_name, ext, is_src, is_dest):
         self.full_name = full_name
@@ -433,20 +444,11 @@ class Operand(object):
         # extension, if one was explicitly provided, or the default.
         if ext:
             self.eff_ext = ext
-        else:
+        elif hasattr(self, 'dflt_ext'):
             self.eff_ext = self.dflt_ext
 
-        self.size, self.ctype, self.is_signed = \
-                    parser.operandTypeMap[self.eff_ext]
-
-        # note that mem_acc_size is undefined for non-mem operands...
-        # template must be careful not to use it if it doesn't apply.
-        if self.isMem():
-            self.mem_acc_size = self.makeAccSize()
-            if self.ctype in ['Twin32_t', 'Twin64_t']:
-                self.mem_acc_type = 'Twin'
-            else:
-                self.mem_acc_type = 'uint'
+        if hasattr(self, 'eff_ext'):
+            self.ctype = parser.operandTypeMap[self.eff_ext]
 
     # Finalize additional fields (primarily code fields).  This step
     # is done separately since some of these fields may depend on the
@@ -486,6 +488,12 @@ class Operand(object):
     def isControlReg(self):
         return 0
 
+    def isPCState(self):
+        return 0
+
+    def isPCPart(self):
+        return self.isPCState() and self.reg_spec
+
     def getFlags(self):
         # note the empty slice '[:]' gives us a copy of self.flags[0]
         # instead of a reference to it
@@ -523,34 +531,20 @@ class IntRegOperand(Operand):
             error('Attempt to read integer register as FP')
         if self.read_code != None:
             return self.buildReadCode('readIntRegOperand')
-        if (self.size == self.dflt_size):
-            return '%s = xc->readIntRegOperand(this, %d);\n' % \
-                   (self.base_name, self.src_reg_idx)
-        elif (self.size > self.dflt_size):
-            int_reg_val = 'xc->readIntRegOperand(this, %d)' % \
-                          (self.src_reg_idx)
-            if (self.is_signed):
-                int_reg_val = 'sext<%d>(%s)' % (self.dflt_size, int_reg_val)
-            return '%s = %s;\n' % (self.base_name, int_reg_val)
-        else:
-            return '%s = bits(xc->readIntRegOperand(this, %d), %d, 0);\n' % \
-                   (self.base_name, self.src_reg_idx, self.size-1)
+        int_reg_val = 'xc->readIntRegOperand(this, %d)' % self.src_reg_idx
+        return '%s = %s;\n' % (self.base_name, int_reg_val)
 
     def makeWrite(self):
         if (self.ctype == 'float' or self.ctype == 'double'):
             error('Attempt to write integer register as FP')
         if self.write_code != None:
             return self.buildWriteCode('setIntRegOperand')
-        if (self.size != self.dflt_size and self.is_signed):
-            final_val = 'sext<%d>(%s)' % (self.size, self.base_name)
-        else:
-            final_val = self.base_name
         wb = '''
         {
             %s final_val = %s;
             xc->setIntRegOperand(this, %d, final_val);\n
             if (traceData) { traceData->setData(final_val); }
-        }''' % (self.dflt_ctype, final_val, self.dest_reg_idx)
+        }''' % (self.ctype, self.base_name, self.dest_reg_idx)
         return wb
 
 class FloatRegOperand(Operand):
@@ -576,29 +570,16 @@ class FloatRegOperand(Operand):
             func = 'readFloatRegOperand'
         else:
             func = 'readFloatRegOperandBits'
-            if (self.size != self.dflt_size):
-                bit_select = 1
-        base = 'xc->%s(this, %d)' % (func, self.src_reg_idx)
         if self.read_code != None:
             return self.buildReadCode(func)
-        if bit_select:
-            return '%s = bits(%s, %d, 0);\n' % \
-                   (self.base_name, base, self.size-1)
-        else:
-            return '%s = %s;\n' % (self.base_name, base)
+        return '%s = xc->%s(this, %d);\n' % \
+            (self.base_name, func, self.src_reg_idx)
 
     def makeWrite(self):
-        final_val = self.base_name
-        final_ctype = self.ctype
         if (self.ctype == 'float' or self.ctype == 'double'):
             func = 'setFloatRegOperand'
-        elif (self.ctype == 'uint32_t' or self.ctype == 'uint64_t'):
-            func = 'setFloatRegOperandBits'
         else:
             func = 'setFloatRegOperandBits'
-            final_ctype = 'uint%d_t' % self.dflt_size
-            if (self.size != self.dflt_size and self.is_signed):
-                final_val = 'sext<%d>(%s)' % (self.size, self.base_name)
         if self.write_code != None:
             return self.buildWriteCode(func)
         wb = '''
@@ -606,7 +587,7 @@ class FloatRegOperand(Operand):
             %s final_val = %s;
             xc->%s(this, %d, final_val);\n
             if (traceData) { traceData->setData(final_val); }
-        }''' % (final_ctype, final_val, func, self.dest_reg_idx)
+        }''' % (self.ctype, self.base_name, func, self.dest_reg_idx)
         return wb
 
 class ControlRegOperand(Operand):
@@ -632,12 +613,8 @@ class ControlRegOperand(Operand):
             error('Attempt to read control register as FP')
         if self.read_code != None:
             return self.buildReadCode('readMiscRegOperand')
-        base = 'xc->readMiscRegOperand(this, %s)' % self.src_reg_idx
-        if self.size == self.dflt_size:
-            return '%s = %s;\n' % (self.base_name, base)
-        else:
-            return '%s = bits(%s, %d, 0);\n' % \
-                   (self.base_name, base, self.size-1)
+        return '%s = xc->readMiscRegOperand(this, %s);\n' % \
+            (self.base_name, self.src_reg_idx)
 
     def makeWrite(self):
         if (self.ctype == 'float' or self.ctype == 'double'):
@@ -661,9 +638,6 @@ class MemOperand(Operand):
         # Note that initializations in the declarations are solely
         # to avoid 'uninitialized variable' errors from the compiler.
         # Declare memory data variable.
-        if self.ctype in ['Twin32_t','Twin64_t']:
-            return "%s %s; %s.a = 0; %s.b = 0;\n" % \
-                   (self.ctype, self.base_name, self.base_name, self.base_name)
         return '%s %s = 0;\n' % (self.ctype, self.base_name)
 
     def makeRead(self):
@@ -676,48 +650,36 @@ class MemOperand(Operand):
             return self.buildWriteCode()
         return ''
 
-    # Return the memory access size *in bits*, suitable for
-    # forming a type via "uint%d_t".  Divide by 8 if you want bytes.
-    def makeAccSize(self):
-        return self.size
-
 class PCStateOperand(Operand):
     def makeConstructor(self):
         return ''
 
     def makeRead(self):
-        return '%s = xc->pcState();\n' % self.base_name
+        if self.reg_spec:
+            # A component of the PC state.
+            return '%s = __parserAutoPCState.%s();\n' % \
+                (self.base_name, self.reg_spec)
+        else:
+            # The whole PC state itself.
+            return '%s = xc->pcState();\n' % self.base_name
 
     def makeWrite(self):
-        return 'xc->pcState(%s);\n' % self.base_name
+        if self.reg_spec:
+            # A component of the PC state.
+            return '__parserAutoPCState.%s(%s);\n' % \
+                (self.reg_spec, self.base_name)
+        else:
+            # The whole PC state itself.
+            return 'xc->pcState(%s);\n' % self.base_name
 
     def makeDecl(self):
-        return 'TheISA::PCState ' + self.base_name + ' M5_VAR_USED;\n';
+        ctype = 'TheISA::PCState'
+        if self.isPCPart():
+            ctype = self.ctype
+        return "%s %s;\n" % (ctype, self.base_name)
 
-class PCOperand(Operand):
-    def makeConstructor(self):
-        return ''
-
-    def makeRead(self):
-        return '%s = xc->instAddr();\n' % self.base_name
-
-class UPCOperand(Operand):
-    def makeConstructor(self):
-        return ''
-
-    def makeRead(self):
-        if self.read_code != None:
-            return self.buildReadCode('microPC')
-        return '%s = xc->microPC();\n' % self.base_name
-
-class NPCOperand(Operand):
-    def makeConstructor(self):
-        return ''
-
-    def makeRead(self):
-        if self.read_code != None:
-            return self.buildReadCode('nextInstAddr')
-        return '%s = xc->nextInstAddr();\n' % self.base_name
+    def isPCState(self):
+        return 1
 
 class OperandList(object):
     '''Find all the operands in the given code block.  Returns an operand
@@ -725,8 +687,9 @@ class OperandList(object):
     def __init__(self, parser, code):
         self.items = []
         self.bases = {}
-        # delete comments so we don't match on reg specifiers inside
-        code = commentRE.sub('', code)
+        # delete strings and comments so we don't match on operands inside
+        for regEx in (stringRE, commentRE):
+            code = regEx.sub('', code)
         # search for operands
         next_pos = 0
         while 1:
@@ -840,8 +803,9 @@ class SubOperandList(OperandList):
     def __init__(self, parser, code, master_list):
         self.items = []
         self.bases = {}
-        # delete comments so we don't match on reg specifiers inside
-        code = commentRE.sub('', code)
+        # delete strings and comments so we don't match on operands inside
+        for regEx in (stringRE, commentRE):
+            code = regEx.sub('', code)
         # search for operands
         next_pos = 0
         while 1:
@@ -868,15 +832,37 @@ class SubOperandList(OperandList):
             next_pos = match.end()
         self.sort()
         self.memOperand = None
+        # Whether the whole PC needs to be read so parts of it can be accessed
+        self.readPC = False
+        # Whether the whole PC needs to be written after parts of it were
+        # changed
+        self.setPC = False
+        # Whether this instruction manipulates the whole PC or parts of it.
+        # Mixing the two is a bad idea and flagged as an error.
+        self.pcPart = None
         for op_desc in self.items:
+            if op_desc.isPCPart():
+                self.readPC = True
+                if op_desc.is_dest:
+                    self.setPC = True
+            if op_desc.isPCState():
+                if self.pcPart is not None:
+                    if self.pcPart and not op_desc.isPCPart() or \
+                            not self.pcPart and op_desc.isPCPart():
+                        error("Mixed whole and partial PC state operands.")
+                self.pcPart = op_desc.isPCPart()
             if op_desc.isMem():
                 if self.memOperand:
                     error("Code block has more than one memory operand.")
                 self.memOperand = op_desc
 
+# Regular expression object to match C++ strings
+stringRE = re.compile(r'"([^"\\]|\\.)*"')
+
 # Regular expression object to match C++ comments
 # (used in findOperands())
-commentRE = re.compile(r'//.*\n')
+commentRE = re.compile(r'(^)?[^\S\n]*/(?:\*(.*?)\*/[^\S\n]*|/[^\n]*)($)?',
+        re.DOTALL | re.MULTILINE)
 
 # Regular expression object to match assignment statements
 # (used in findOperands())
@@ -1171,7 +1157,7 @@ class ISAParser(Grammar):
         return t
 
     def t_NEWFILE(self, t):
-        r'^\#\#newfile\s+"[\w/.-]*"'
+        r'^\#\#newfile\s+"[^"]*"'
         self.fileNameStack.push((t.value[11:-1], t.lexer.lineno))
         t.lexer.lineno = 0
 
@@ -1333,13 +1319,12 @@ StaticInstPtr
     def p_def_operand_types(self, t):
         'def_operand_types : DEF OPERAND_TYPES CODELIT SEMI'
         try:
-            user_dict = eval('{' + t[3] + '}')
+            self.operandTypeMap = eval('{' + t[3] + '}')
         except Exception, exc:
             if debug:
                 raise
             error(t,
                   'error: %s in def operand_types block "%s".' % (exc, t[3]))
-        self.buildOperandTypeMap(user_dict, t.lexer.lineno)
         t[0] = GenCode(self) # contributes nothing to the output C++ file
 
     # Define the mapping from operand names to operand classes and
@@ -1800,36 +1785,6 @@ StaticInstPtr
 
         return re.sub(r'%(?!\()', '%%', s)
 
-    def buildOperandTypeMap(self, user_dict, lineno):
-        """Generate operandTypeMap from the user's 'def operand_types'
-        statement."""
-        operand_type = {}
-        for (ext, (desc, size)) in user_dict.iteritems():
-            if desc == 'signed int':
-                ctype = 'int%d_t' % size
-                is_signed = 1
-            elif desc == 'unsigned int':
-                ctype = 'uint%d_t' % size
-                is_signed = 0
-            elif desc == 'float':
-                is_signed = 1       # shouldn't really matter
-                if size == 32:
-                    ctype = 'float'
-                elif size == 64:
-                    ctype = 'double'
-            elif desc == 'twin64 int':
-                is_signed = 0
-                ctype = 'Twin64_t'
-            elif desc == 'twin32 int':
-                is_signed = 0
-                ctype = 'Twin32_t'
-            if ctype == '':
-                error(parser, lineno,
-                      'Unrecognized type description "%s" in user_dict')
-            operand_type[ext] = (size, ctype, is_signed)
-
-        self.operandTypeMap = operand_type
-
     def buildOperandNameMap(self, user_dict, lineno):
         operand_name = {}
         for op_name, val in user_dict.iteritems():
@@ -1847,8 +1802,6 @@ StaticInstPtr
                       'error: too many attributes for operand "%s"' %
                       base_cls_name)
 
-            (dflt_size, dflt_ctype, dflt_is_signed) = \
-                        self.operandTypeMap[dflt_ext]
             # Canonical flag structure is a triple of lists, where each list
             # indicates the set of flags implied by this operand always, when
             # used as a source, and when used as a dest, respectively.
@@ -1871,9 +1824,12 @@ StaticInstPtr
                          makeList(src_flags), makeList(dest_flags))
             # Accumulate attributes of new operand class in tmp_dict
             tmp_dict = {}
-            for attr in ('dflt_ext', 'reg_spec', 'flags', 'sort_pri',
-                         'dflt_size', 'dflt_ctype', 'dflt_is_signed',
-                         'read_code', 'write_code'):
+            attrList = ['reg_spec', 'flags', 'sort_pri',
+                        'read_code', 'write_code']
+            if dflt_ext:
+                dflt_ctype = self.operandTypeMap[dflt_ext]
+                attrList.extend(['dflt_ctype', 'dflt_ext'])
+            for attr in attrList:
                 tmp_dict[attr] = eval(attr)
             tmp_dict['base_name'] = op_name
             # New class name will be e.g. "IntReg_Ra"
@@ -1895,21 +1851,21 @@ StaticInstPtr
 
         # Define operand variables.
         operands = user_dict.keys()
+        extensions = self.operandTypeMap.keys()
 
-        operandsREString = (r'''
-        (?<![\w\.])      # neg. lookbehind assertion: prevent partial matches
-        ((%s)(?:\.(\w+))?)   # match: operand with optional '.' then suffix
-        (?![\w\.])       # neg. lookahead assertion: prevent partial matches
-        '''
-                            % string.join(operands, '|'))
+        operandsREString = r'''
+        (?<!\w)      # neg. lookbehind assertion: prevent partial matches
+        ((%s)(?:_(%s))?)   # match: operand with optional '_' then suffix
+        (?!\w)       # neg. lookahead assertion: prevent partial matches
+        ''' % (string.join(operands, '|'), string.join(extensions, '|'))
 
         self.operandsRE = re.compile(operandsREString, re.MULTILINE|re.VERBOSE)
 
         # Same as operandsREString, but extension is mandatory, and only two
         # groups are returned (base and ext, not full name as above).
         # Used for subtituting '_' for '.' to make C++ identifiers.
-        operandsWithExtREString = (r'(?<![\w\.])(%s)\.(\w+)(?![\w\.])'
-                                   % string.join(operands, '|'))
+        operandsWithExtREString = r'(?<!\w)(%s)_(%s)(?!\w)' \
+            % (string.join(operands, '|'), string.join(extensions, '|'))
 
         self.operandsWithExtRE = \
             re.compile(operandsWithExtREString, re.MULTILINE)
@@ -1939,13 +1895,11 @@ StaticInstPtr
             old_contents = f.read()
             f.close()
             if contents != old_contents:
-                print 'Updating', file
                 os.remove(file) # in case it's write-protected
                 update = True
             else:
                 print 'File', file, 'is unchanged'
         else:
-            print 'Generating', file
             update = True
         if update:
             f = open(file, 'w')
@@ -1953,7 +1907,7 @@ StaticInstPtr
             f.close()
 
     # This regular expression matches '##include' directives
-    includeRE = re.compile(r'^\s*##include\s+"(?P<filename>[\w/.-]*)".*$',
+    includeRE = re.compile(r'^\s*##include\s+"(?P<filename>[^"]*)".*$',
                            re.MULTILINE)
 
     def replace_include(self, matchobj, dirname):
@@ -2001,7 +1955,7 @@ StaticInstPtr
 
         # Parse it.
         (isa_name, namespace, global_code, namespace_code) = \
-                   self.parse(isa_desc)
+                   self.parse_string(isa_desc)
 
         # grab the last three path components of isa_desc_file to put in
         # the output