1 # Copyright (c) 2009 The Hewlett-Packard Development Company
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met: redistributions of source code must retain the above copyright
7 # notice, this list of conditions and the following disclaimer;
8 # redistributions in binary form must reproduce the above copyright
9 # notice, this list of conditions and the following disclaimer in the
10 # documentation and/or other materials provided with the distribution;
11 # neither the name of the copyright holders nor the names of its
12 # contributors may be used to endorse or promote products derived from
13 # this software without specific prior written permission.
15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 # Authors: Nathan Binkert
33 from m5
.util
import code_formatter
34 from m5
.util
.grammar
import Grammar
, ParseError
36 import slicc
.ast
as ast
37 import slicc
.util
as util
38 from slicc
.symbols
import SymbolTable
41 def __init__(self
, filename
, base_dir
, verbose
=False, traceback
=False, **kwargs
):
43 self
.traceback
= traceback
44 self
.verbose
= verbose
45 self
.symtab
= SymbolTable(self
)
46 self
.base_dir
= base_dir
49 self
.decl_list
= self
.parse_file(filename
, **kwargs
)
51 if not self
.traceback
:
55 def currentLocation(self
):
56 return util
.Location(self
.current_source
, self
.current_line
,
57 no_warning
=not self
.verbose
)
59 def codeFormatter(self
, *args
, **kwargs
):
60 code
= code_formatter(*args
, **kwargs
)
61 code
['protocol'] = self
.protocol
65 self
.decl_list
.findMachines()
66 self
.decl_list
.generate()
68 def writeCodeFiles(self
, code_path
, includes
):
69 self
.symtab
.writeCodeFiles(code_path
, includes
)
71 def writeHTMLFiles(self
, html_path
):
72 self
.symtab
.writeHTMLFiles(html_path
)
80 f |
= self
.decl_list
.files()
86 # C or C++ comment (ignore)
87 def t_c_comment(self
, t
):
89 t
.lexer
.lineno
+= t
.value
.count('\n')
91 def t_cpp_comment(self
, t
):
94 # Define a rule so we can track line numbers
95 def t_newline(self
, t
):
97 t
.lexer
.lineno
+= len(t
.value
)
100 'protocol' : 'PROTOCOL',
101 'include' : 'INCLUDE',
103 'machine' : 'MACHINE',
104 'in_port' : 'IN_PORT',
105 'out_port' : 'OUT_PORT',
107 'transition' : 'TRANS',
108 'structure' : 'STRUCT',
109 'external_type' : 'EXTERN_TYPE',
110 'enumeration' : 'ENUM',
111 'state_declaration' : 'STATE_DECL',
113 'stall_and_wait' : 'STALL_AND_WAIT',
114 'enqueue' : 'ENQUEUE',
115 'check_allocate' : 'CHECK_ALLOCATE',
116 'check_next_cycle' : 'CHECK_NEXT_CYCLE',
117 'check_stop_slots' : 'CHECK_STOP_SLOTS',
118 'static_cast' : 'STATIC_CAST',
120 'is_valid' : 'IS_VALID',
121 'is_invalid' : 'IS_INVALID',
129 literals
= ':[]{}(),='
131 tokens
= [ 'EQ', 'NE', 'LT', 'GT', 'LE', 'GE',
132 'LEFTSHIFT', 'RIGHTSHIFT',
134 'PLUS', 'DASH', 'STAR', 'SLASH',
136 'DOUBLE_COLON', 'SEMI',
138 'IDENT', 'LIT_BOOL', 'FLOATNUMBER', 'NUMBER', 'STRING' ]
139 tokens
+= reserved
.values()
156 t_DOUBLE_COLON
= r
'::'
164 ('left', 'INCR', 'DECR'),
165 ('left', 'AND', 'OR'),
166 ('left', 'EQ', 'NE'),
167 ('left', 'LT', 'GT', 'LE', 'GE'),
168 ('left', 'RIGHTSHIFT', 'LEFTSHIFT'),
169 ('left', 'PLUS', 'DASH'),
170 ('left', 'STAR', 'SLASH'),
171 ('right', 'NOT', 'UMINUS'),
174 def t_IDENT(self
, t
):
175 r
'[a-zA-Z_][a-zA-Z_0-9]*'
176 if t
.value
== 'true':
181 if t
.value
== 'false':
186 # Check for reserved words
187 t
.type = self
.reserved
.get(t
.value
, 'IDENT')
190 def t_FLOATNUMBER(self
, t
):
193 t
.value
= float(t
.value
)
195 raise ParseError("Illegal float", t
)
198 def t_NUMBER(self
, t
):
201 t
.value
= int(t
.value
)
203 raise ParseError("Illegal number", t
)
206 def t_STRING1(self
, t
):
209 t
.value
= t
.value
[1:-1]
212 def t_STRING2(self
, t
):
215 t
.value
= t
.value
[1:-1]
222 def p_empty(self
, p
):
225 def p_decls(self
, p
):
227 p
[0] = ast
.DeclListAST(self
, p
[1])
229 def p_declsx__list(self
, p
):
230 "declsx : decl declsx"
231 if isinstance(p
[1], ast
.DeclListAST
):
239 def p_declsx__none(self
, p
):
243 def p_decl__protocol(self
, p
):
244 "decl : PROTOCOL STRING SEMI"
246 msg
= "Protocol can only be set once! Error at %s:%s\n" % \
247 (self
.current_source
, self
.current_line
)
248 raise ParseError(msg
)
252 def p_decl__include(self
, p
):
253 "decl : INCLUDE STRING SEMI"
254 dirname
= os
.path
.dirname(self
.current_source
)
255 if os
.path
.exists(os
.path
.join(dirname
, p
[2])):
256 filename
= os
.path
.join(dirname
, p
[2])
258 filename
= os
.path
.join(self
.base_dir
, p
[2])
259 p
[0] = self
.parse_file(filename
)
261 def p_decl__machine0(self
, p
):
262 "decl : MACHINE '(' idents ')' ':' obj_decls '{' decls '}'"
263 p
[0] = ast
.MachineAST(self
, p
[3], [], p
[7], p
[9])
265 def p_decl__machine1(self
, p
):
266 "decl : MACHINE '(' idents pairs ')' ':' obj_decls '{' decls '}'"
267 p
[0] = ast
.MachineAST(self
, p
[3], p
[4], p
[7], p
[9])
269 def p_decl__action(self
, p
):
270 "decl : ACTION '(' ident pairs ')' statements"
271 p
[0] = ast
.ActionDeclAST(self
, p
[3], p
[4], p
[6])
273 def p_decl__in_port(self
, p
):
274 "decl : IN_PORT '(' ident ',' type ',' var pairs ')' statements"
275 p
[0] = ast
.InPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
277 def p_decl__out_port(self
, p
):
278 "decl : OUT_PORT '(' ident ',' type ',' var pairs ')' SEMI"
279 p
[0] = ast
.OutPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8])
281 def p_decl__trans0(self
, p
):
282 "decl : TRANS '(' idents ',' idents ',' ident_or_star ')' idents"
283 p
[0] = ast
.TransitionDeclAST(self
, [], p
[3], p
[5], p
[7], p
[9])
285 def p_decl__trans1(self
, p
):
286 "decl : TRANS '(' idents ',' idents ')' idents"
287 p
[0] = ast
.TransitionDeclAST(self
, [], p
[3], p
[5], None, p
[7])
289 def p_decl__trans2(self
, p
):
290 "decl : TRANS '(' idents ',' idents ',' ident_or_star ')' idents idents"
291 p
[0] = ast
.TransitionDeclAST(self
, p
[9], p
[3], p
[5], p
[7], p
[10])
293 def p_decl__trans3(self
, p
):
294 "decl : TRANS '(' idents ',' idents ')' idents idents"
295 p
[0] = ast
.TransitionDeclAST(self
, p
[7], p
[3], p
[5], None, p
[8])
297 def p_decl__extern0(self
, p
):
298 "decl : EXTERN_TYPE '(' type pairs ')' SEMI"
299 p
[4]["external"] = "yes"
300 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], [])
302 def p_decl__global(self
, p
):
303 "decl : GLOBAL '(' type pairs ')' '{' type_members '}'"
304 p
[4]["global"] = "yes"
305 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
307 def p_decl__struct(self
, p
):
308 "decl : STRUCT '(' type pairs ')' '{' type_members '}'"
309 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
311 def p_decl__enum(self
, p
):
312 "decl : ENUM '(' type pairs ')' '{' type_enums '}'"
313 p
[4]["enumeration"] = "yes"
314 p
[0] = ast
.EnumDeclAST(self
, p
[3], p
[4], p
[7])
316 def p_decl__state_decl(self
, p
):
317 "decl : STATE_DECL '(' type pairs ')' '{' type_states '}'"
318 p
[4]["enumeration"] = "yes"
319 p
[4]["state_decl"] = "yes"
320 p
[0] = ast
.StateDeclAST(self
, p
[3], p
[4], p
[7])
323 def p_obj_decls__list(self
, p
):
324 "obj_decls : obj_decl obj_decls"
325 p
[0] = [ p
[1] ] + p
[2]
327 def p_obj_decls__empty(self
, p
):
331 def p_type_members__list(self
, p
):
332 "type_members : type_member type_members"
333 p
[0] = [ p
[1] ] + p
[2]
335 def p_type_members__empty(self
, p
):
336 "type_members : empty"
339 def p_type_member__0(self
, p
):
340 """type_member : obj_decl
345 # Member / Variable declarations
346 def p_decl__obj_decl(self
, p
):
350 def p_obj_decl__0(self
, p
):
351 "obj_decl : type ident pairs SEMI"
352 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[2], p
[3], None, False)
354 def p_obj_decl__1(self
, p
):
355 "obj_decl : type STAR ident pairs SEMI"
356 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[3], p
[4], None, True)
358 def p_obj_decl__2(self
, p
):
359 "obj_decl : type ident ASSIGN expr SEMI"
360 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[2], ast
.PairListAST(self
), p
[4],
363 def p_obj_decl__3(self
, p
):
364 "obj_decl : type STAR ident ASSIGN expr SEMI"
365 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[3], ast
.PairListAST(self
), p
[5],
368 # Function definition and declaration
369 def p_decl__func_decl(self
, p
):
373 def p_func_decl__0(self
, p
):
374 """func_decl : void ident '(' params ')' pairs SEMI
375 | type ident '(' params ')' pairs SEMI"""
376 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], None)
378 def p_func_decl__1(self
, p
):
379 """func_decl : void ident '(' types ')' pairs SEMI
380 | type ident '(' types ')' pairs SEMI"""
381 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], None)
383 def p_decl__func_def(self
, p
):
387 def p_func_def__0(self
, p
):
388 """func_def : void ident '(' params ')' pairs statements
389 | type ident '(' params ')' pairs statements"""
390 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], p
[7])
393 def p_type_enums__list(self
, p
):
394 "type_enums : type_enum type_enums"
395 p
[0] = [ p
[1] ] + p
[2]
397 def p_type_enums__empty(self
, p
):
401 def p_type_enum(self
, p
):
402 "type_enum : ident pairs SEMI"
403 p
[0] = ast
.TypeFieldEnumAST(self
, p
[1], p
[2])
406 def p_type_states__list(self
, p
):
407 "type_states : type_state type_states"
408 p
[0] = [ p
[1] ] + p
[2]
410 def p_type_states__empty(self
, p
):
411 "type_states : empty"
414 def p_type_state(self
, p
):
415 "type_state : ident ',' enumeration pairs SEMI"
416 p
[0] = ast
.TypeFieldStateAST(self
, p
[1], p
[3], p
[4])
419 def p_params__many(self
, p
):
420 "params : param ',' params"
421 p
[0] = [ p
[1] ] + p
[3]
423 def p_params__one(self
, p
):
427 def p_params__none(self
, p
):
431 def p_param(self
, p
):
433 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2])
435 def p_param__pointer(self
, p
):
436 "param : type STAR ident"
437 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], None, True)
439 def p_param__pointer_default(self
, p
):
440 "param : type STAR ident ASSIGN STRING"
441 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], p
[5], True)
443 def p_param__default_number(self
, p
):
444 "param : type ident ASSIGN NUMBER"
445 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
447 def p_param__default_bool(self
, p
):
448 "param : type ident ASSIGN LIT_BOOL"
449 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
451 def p_param__default_string(self
, p
):
452 "param : type ident ASSIGN STRING"
453 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
456 def p_types__multiple(self
, p
):
457 "types : type ',' types"
458 p
[0] = [ p
[1] ] + p
[3]
460 def p_types__one(self
, p
):
464 def p_types__empty(self
, p
):
468 def p_typestr__multi(self
, p
):
469 "typestr : typestr DOUBLE_COLON ident"
470 p
[0] = '%s::%s' % (p
[1], p
[3])
472 def p_typestr__single(self
, p
):
476 def p_type__one(self
, p
):
478 p
[0] = ast
.TypeAST(self
, p
[1])
482 p
[0] = ast
.TypeAST(self
, p
[1])
485 def p_idents__braced(self
, p
):
486 "idents : '{' identx '}'"
489 def p_idents__bare(self
, p
):
493 def p_identx__multiple_1(self
, p
):
494 """identx : ident SEMI identx
495 | ident ',' identx"""
496 p
[0] = [ p
[1] ] + p
[3]
498 def p_identx__multiple_2(self
, p
):
499 "identx : ident identx"
500 p
[0] = [ p
[1] ] + p
[2]
502 def p_identx__single(self
, p
):
506 def p_ident(self
, p
):
510 def p_ident_or_star(self
, p
):
511 """ident_or_star : ident
515 # Pair and pair lists
516 def p_pairs__list(self
, p
):
520 def p_pairs__empty(self
, p
):
522 p
[0] = ast
.PairListAST(self
)
524 def p_pairsx__many(self
, p
):
525 "pairsx : pair ',' pairsx"
529 def p_pairsx__one(self
, p
):
531 p
[0] = ast
.PairListAST(self
)
534 def p_pair__assign(self
, p
):
535 """pair : ident '=' STRING
537 | ident '=' NUMBER"""
538 p
[0] = ast
.PairAST(self
, p
[1], p
[3])
540 def p_pair__literal(self
, p
):
542 p
[0] = ast
.PairAST(self
, "short", p
[1])
544 # Below are the rules for action descriptions
545 def p_statements__inner(self
, p
):
546 "statements : '{' statements_inner '}'"
547 p
[0] = ast
.StatementListAST(self
, p
[2])
549 def p_statements__none(self
, p
):
550 "statements : '{' '}'"
551 p
[0] = ast
.StatementListAST(self
, [])
553 def p_statements_inner__many(self
, p
):
554 "statements_inner : statement statements_inner"
555 p
[0] = [ p
[1] ] + p
[2]
557 def p_statements_inner__one(self
, p
):
558 "statements_inner : statement"
561 def p_exprs__multiple(self
, p
):
562 "exprs : expr ',' exprs"
563 p
[0] = [ p
[1] ] + p
[3]
565 def p_exprs__one(self
, p
):
569 def p_exprs__empty(self
, p
):
573 def p_statement__expression(self, p):
574 "statement
: expr SEMI
"
575 p[0] = ast.ExprStatementAST(self, p[1])
577 def p_statement__assign(self, p):
578 "statement
: expr ASSIGN expr SEMI
"
579 p[0] = ast.AssignStatementAST(self, p[1], p[3])
581 def p_statement__enqueue(self, p):
582 "statement
: ENQUEUE
'(' var
',' type ')' statements
"
583 p[0] = ast.EnqueueStatementAST(self, p[3], p[5], None, p[7])
585 def p_statement__enqueue_latency(self, p):
586 "statement
: ENQUEUE
'(' var
',' type ',' expr
')' statements
"
587 p[0] = ast.EnqueueStatementAST(self, p[3], p[5], p[7], p[9])
589 def p_statement__stall_and_wait(self, p):
590 "statement
: STALL_AND_WAIT
'(' var
',' var
')' SEMI
"
591 p[0] = ast.StallAndWaitStatementAST(self, p[3], p[5])
593 def p_statement__peek(self, p):
594 "statement
: PEEK
'(' var
',' type pairs
')' statements
"
595 p[0] = ast.PeekStatementAST(self, p[3], p[5], p[6], p[8], "peek
")
597 def p_statement__check_allocate(self, p):
598 "statement
: CHECK_ALLOCATE
'(' var
')' SEMI
"
599 p[0] = ast.CheckAllocateStatementAST(self, p[3])
601 def p_statement__check_next_cycle(self, p):
602 "statement
: CHECK_NEXT_CYCLE
'(' ')' SEMI
"
603 p[0] = ast.CheckNextCycleAST(self)
605 def p_statement__check_stop(self, p):
606 "statement
: CHECK_STOP_SLOTS
'(' var
',' STRING
',' STRING
')' SEMI
"
607 p[0] = ast.CheckStopStatementAST(self, p[3], p[5], p[7])
609 def p_statement__return(self, p):
610 "statement
: RETURN expr SEMI
"
611 p[0] = ast.ReturnStatementAST(self, p[2])
613 def p_statement__if(self, p):
614 "statement
: if_statement
"
617 def p_if_statement__if(self, p):
618 "if_statement
: IF
'(' expr
')' statements
"
619 p[0] = ast.IfStatementAST(self, p[3], p[5], None)
621 def p_if_statement__if_else(self, p):
622 "if_statement
: IF
'(' expr
')' statements ELSE statements
"
623 p[0] = ast.IfStatementAST(self, p[3], p[5], p[7])
625 def p_statement__if_else_if(self, p):
626 "if_statement
: IF
'(' expr
')' statements ELSE if_statement
"
627 p[0] = ast.IfStatementAST(self, p[3], p[5],
628 ast.StatementListAST(self, p[7]))
630 def p_expr__static_cast(self, p):
631 "aexpr
: STATIC_CAST
'(' type ',' expr
')'"
632 p[0] = ast.StaticCastAST(self, p[3], "ref
", p[5])
634 def p_expr__static_cast_ptr(self, p):
635 "aexpr
: STATIC_CAST
'(' type ',' STRING
',' expr
')'"
636 p[0] = ast.StaticCastAST(self, p[3], p[5], p[7])
638 def p_expr__var(self, p):
642 def p_expr__localvar(self, p):
644 p[0] = ast.LocalVariableAST(self, p[1], p[2])
646 def p_expr__literal(self, p):
650 def p_expr__enumeration(self, p):
651 "aexpr
: enumeration
"
654 def p_expr__func_call(self, p):
655 "aexpr
: ident
'(' exprs
')'"
656 p[0] = ast.FuncCallExprAST(self, p[1], p[3])
658 def p_expr__new(self, p):
660 p[0] = ast.NewExprAST(self, p[2])
662 def p_expr__null(self, p):
664 p[0] = ast.OodAST(self)
666 def p_expr__member(self, p):
667 "aexpr
: aexpr DOT ident
"
668 p[0] = ast.MemberExprAST(self, p[1], p[3])
670 def p_expr__member_method_call(self, p):
671 "aexpr
: aexpr DOT ident
'(' exprs
')'"
672 p[0] = ast.MemberMethodCallExprAST(self, p[1],
673 ast.FuncCallExprAST(self, p[3], p[5]))
675 def p_expr__member_method_call_lookup(self, p):
676 "aexpr
: aexpr
'[' exprs
']'"
677 p[0] = ast.MemberMethodCallExprAST(self, p[1],
678 ast.FuncCallExprAST(self, "lookup
", p[3]))
680 def p_expr__class_method_call(self, p):
681 "aexpr
: type DOUBLE_COLON ident
'(' exprs
')'"
682 p[0] = ast.ClassMethodCallExprAST(self, p[1],
683 ast.FuncCallExprAST(self, p[3], p[5]))
685 def p_expr__aexpr(self, p):
689 def p_expr__binary_op(self, p):
690 """expr : expr STAR expr
702 | expr RIGHTSHIFT expr
703 | expr LEFTSHIFT expr"""
704 p[0] = ast.InfixOperatorExprAST(self, p[1], p[2], p[3])
707 def p_expr__unary_op(self, p):
711 | DASH expr %prec UMINUS"""
712 p[0] = ast.PrefixOperatorExprAST(self, p[1], p[2])
714 def p_expr__parens(self, p):
715 "aexpr
: '(' expr
')'"
718 def p_expr__is_valid_ptr(self, p):
719 "aexpr
: IS_VALID
'(' var
')'"
720 p[0] = ast.IsValidPtrExprAST(self, p[3], True)
722 def p_expr__is_invalid_ptr(self, p):
723 "aexpr
: IS_INVALID
'(' var
')'"
724 p[0] = ast.IsValidPtrExprAST(self, p[3], False)
726 def p_literal__string(self, p):
728 p[0] = ast.LiteralExprAST(self, p[1], "std
::string
")
730 def p_literal__number(self, p):
732 p[0] = ast.LiteralExprAST(self, p[1], "int")
734 def p_literal__float(self, p):
735 "literal
: FLOATNUMBER
"
736 p[0] = ast.LiteralExprAST(self, p[1], "int")
738 def p_literal__bool(self, p):
740 p[0] = ast.LiteralExprAST(self, p[1], "bool")
742 def p_enumeration(self, p):
743 "enumeration
: ident
':' ident
"
744 p[0] = ast.EnumExprAST(self, ast.TypeAST(self, p[1]), p[3])
748 p[0] = ast.VarExprAST(self, p[1])