1# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
2# Copyright (c) 2009 The Hewlett-Packard Development Company
3# Copyright (c) 2013 Advanced Micro Devices, Inc.
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions are
8# met: redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer;
10# redistributions in binary form must reproduce the above copyright
11# notice, this list of conditions and the following disclaimer in the
12# documentation and/or other materials provided with the distribution;
13# neither the name of the copyright holders nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29from slicc.ast.ExprAST import ExprAST
30from slicc.symbols import Func, Type
31
32class FuncCallExprAST(ExprAST):
33    def __init__(self, slicc, proc_name, exprs):
34        super(FuncCallExprAST, self).__init__(slicc)
35        self.proc_name = proc_name
36        self.exprs = exprs
37
38    def __repr__(self):
39        return "[FuncCallExpr: %s %s]" % (self.proc_name, self.exprs)
40
41    def generate(self, code):
42        machine = self.state_machine
43
44        if self.proc_name == "DPRINTF":
45            # Code for inserting the location of the DPRINTF()
46            # statement in the .sm file in the statement it self.
47            # 'self.exprs[0].location' represents the location.
48            # 'format' represents the second argument of the
49            # original DPRINTF() call. It is left unmodified.
50            # str_list is used for concatenating the argument
51            # list following the format specifier. A DPRINTF()
52            # call may or may not contain any arguments following
53            # the format specifier. These two cases need to be
54            # handled differently. Hence the check whether or not
55            # the str_list is empty.
56
57            dflag = "%s" % (self.exprs[0].name)
58            machine.addDebugFlag(dflag)
59            format = "%s" % (self.exprs[1].inline())
60            format_length = len(format)
61            str_list = []
62
63            for i in range(2, len(self.exprs)):
64                str_list.append("%s" % self.exprs[i].inline())
65
66            if len(str_list) == 0:
67                code('DPRINTF($0, "$1: $2")',
68                     dflag, self.exprs[0].location, format[2:format_length-2])
69            else:
70                code('DPRINTF($0, "$1: $2", $3)',
71                     dflag,
72                     self.exprs[0].location, format[2:format_length-2],
73                     ', '.join(str_list))
74
75            return self.symtab.find("void", Type)
76
77        if self.proc_name == "DPRINTFN":
78            format = "%s" % (self.exprs[0].inline())
79            format_length = len(format)
80            str_list = []
81
82            for i in range(1, len(self.exprs)):
83                str_list.append("%s" % self.exprs[i].inline())
84
85            if len(str_list) == 0:
86                code('DPRINTFN("$0: $1")',
87                     self.exprs[0].location, format[2:format_length-2])
88            else:
89                code('DPRINTFN("$0: $1", $2)',
90                     self.exprs[0].location, format[2:format_length-2],
91                     ', '.join(str_list))
92
93            return self.symtab.find("void", Type)
94
95        # hack for adding comments to profileTransition
96        if self.proc_name == "APPEND_TRANSITION_COMMENT":
97            # FIXME - check for number of parameters
98            code("APPEND_TRANSITION_COMMENT($0)", self.exprs[0].inline())
99            return self.symtab.find("void", Type)
100
101        func_name_args = self.proc_name
102
103        for expr in self.exprs:
104            actual_type,param_code = expr.inline(True)
105            func_name_args += "_" + str(actual_type.ident)
106
107        # Look up the function in the symbol table
108        func = self.symtab.find(func_name_args, Func)
109
110        # Check the types and get the code for the parameters
111        if func is None:
112            self.error("Unrecognized function name: '%s'", func_name_args)
113
114        cvec, type_vec = func.checkArguments(self.exprs)
115
116        # OK, the semantics of "trigger" here is that, ports in the
117        # machine have different priorities. We always check the first
118        # port for doable transitions. If nothing/stalled, we pick one
119        # from the next port.
120        #
121        # One thing we have to be careful as the SLICC protocol
122        # writter is : If a port have two or more transitions can be
123        # picked from in one cycle, they must be independent.
124        # Otherwise, if transition A and B mean to be executed in
125        # sequential, and A get stalled, transition B can be issued
126        # erroneously. In practice, in most case, there is only one
127        # transition should be executed in one cycle for a given
128        # port. So as most of current protocols.
129
130        if self.proc_name == "trigger":
131            code('''
132{
133''')
134            if machine.TBEType != None and machine.EntryType != None:
135                code('''
136    TransitionResult result = doTransition(${{cvec[0]}}, ${{cvec[2]}}, ${{cvec[3]}}, ${{cvec[1]}});
137''')
138            elif machine.TBEType != None:
139                code('''
140    TransitionResult result = doTransition(${{cvec[0]}}, ${{cvec[2]}}, ${{cvec[1]}});
141''')
142            elif machine.EntryType != None:
143                code('''
144    TransitionResult result = doTransition(${{cvec[0]}}, ${{cvec[2]}}, ${{cvec[1]}});
145''')
146            else:
147                code('''
148    TransitionResult result = doTransition(${{cvec[0]}}, ${{cvec[1]}});
149''')
150
151            code('''
152    if (result == TransitionResult_Valid) {
153        counter++;
154        continue; // Check the first port again
155    }
156
157    if (result == TransitionResult_ResourceStall ||
158        result == TransitionResult_ProtocolStall) {
159        scheduleEvent(Cycles(1));
160
161        // Cannot do anything with this transition, go check next doable transition (mostly likely of next port)
162    }
163}
164''')
165        elif self.proc_name == "error":
166            code("$0", self.exprs[0].embedError(cvec[0]))
167        elif self.proc_name == "assert":
168            error = self.exprs[0].embedError('"assert failure"')
169            code('''
170#ifndef NDEBUG
171if (!(${{cvec[0]}})) {
172    $error
173}
174#endif
175''')
176
177        elif self.proc_name == "set_cache_entry":
178            code("set_cache_entry(m_cache_entry_ptr, %s);" %(cvec[0]));
179        elif self.proc_name == "unset_cache_entry":
180            code("unset_cache_entry(m_cache_entry_ptr);");
181        elif self.proc_name == "set_tbe":
182            code("set_tbe(m_tbe_ptr, %s);" %(cvec[0]));
183        elif self.proc_name == "unset_tbe":
184            code("unset_tbe(m_tbe_ptr);");
185        elif self.proc_name == "stallPort":
186            code("scheduleEvent(Cycles(1));")
187
188        else:
189            # Normal function
190            if "external" not in func and not func.isInternalMachineFunc:
191                self.error("Invalid function")
192
193            params = ""
194            first_param = True
195
196            for (param_code, type) in zip(cvec, type_vec):
197                if first_param:
198                    params = str(param_code)
199                    first_param  = False
200                else:
201                    params += ', '
202                    params += str(param_code);
203
204            fix = code.nofix()
205            code('(${{func.c_name}}($params))')
206            code.fix(fix)
207
208        return func.return_type
209