xref: /gem5/src/mem/slicc/ast/ObjDeclAST.py

# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
# Copyright (c) 2009 The Hewlett-Packard Development Company
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: 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 holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# 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.

from slicc.ast.DeclAST import DeclAST
from slicc.symbols import Var

class ObjDeclAST(DeclAST):
    def __init__(self, slicc, type_ast, ident, pairs):
        super(ObjDeclAST, self).__init__(slicc, pairs)

        self.type_ast = type_ast
        self.ident = ident

    def __repr__(self):
        return "[ObjDecl: %r]" % self.ident

    def generate(self):
        machineComponentSym = False

        self["chip_object"] = "yes"

        if "hack" in self:
            warning("'hack=' is now deprecated")

        if "network" in self and "virtual_network" not in self:
            self.error("Network queues require a 'virtual_network' attribute")

        type = self.type_ast.type
        if type.isBuffer and "ordered" not in self:
            self.error("Buffer object decls require an 'ordered' attribute")

        if "ordered" in self:
            value = self["ordered"]

            if value not in ("true", "false"):
                self.error("The 'ordered' attribute is '%s' " + \
                           "must be 'true' or 'false'.", value)

        if "random" in self:
            value = self["random"]
            if value not in ("true", "false"):
                self.error("The 'random' attribute is '%s' " + \
                           "must be 'true' or 'false'.", value)

        machine = self.symtab.state_machine

        # FIXME : should all use accessors here to avoid public member
        # variables
        if self.ident == "id":
            c_code = "m_chip_ptr.getID()"
        elif self.ident == "version":
            c_code = "m_version"
        elif self.ident == "machineID":
            c_code = "m_machineID"
        elif machine:
            c_code = "(*m_%s_%s_ptr)" % (machine.ident, self.ident)
        else:
            c_code = "(*m_%s_ptr)" % (self.ident)

        v = Var(self.symtab, self.ident, self.location, type, c_code,
                self.pairs, machine)

        if machine:
            machine.addObject(v)

        self.symtab.newSymbol(v)

        # used to cheat-- that is, access components in other machines
        if machineComponentSym:
            self.symtab.newMachComponentSym(v)