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
, TokenError
, ParseError
36 import slicc
.ast
as ast
37 import slicc
.util
as util
38 from slicc
.symbols
import SymbolTable
40 def read_slicc(sources
):
41 if not isinstance(sources
, (list,tuple)):
44 for source
in sources
:
45 for sm_file
in file(source
, "r"):
46 sm_file
= sm_file
.strip()
49 if sm_file
.startswith("#"):
54 def __init__(self
, protocol
, **kwargs
):
55 super(SLICC
, self
).__init
__(**kwargs
)
56 self
.decl_list_vec
= []
57 self
.current_file
= None
58 self
.protocol
= protocol
59 self
.symtab
= SymbolTable(self
)
61 def codeFormatter(self
, *args
, **kwargs
):
62 code
= code_formatter(*args
, **kwargs
)
63 code
['protocol'] = self
.protocol
66 def parse(self
, filename
):
67 self
.current_file
= filename
68 f
= file(filename
, 'r')
71 decl_list
= super(SLICC
, self
).parse(text
)
72 except (TokenError
, ParseError
), e
:
73 sys
.exit("%s: %s:%d" % (e
, filename
, e
.token
.lineno
))
74 self
.decl_list_vec
.append(decl_list
)
75 self
.current_file
= None
77 def _load(self
, *filenames
):
78 filenames
= list(filenames
)
81 if isinstance(f
, (list, tuple)):
82 filenames
[0:0] = list(f
)
86 if f
.endswith(".slicc"):
87 dirname
,basename
= os
.path
.split(f
)
88 filenames
[0:0] = [ os
.path
.join(dirname
, x
) \
89 for x
in read_slicc(f
)]
91 assert f
.endswith(".sm")
94 def load(self
, *filenames
, **kwargs
):
95 verbose
= kwargs
.pop("verbose", False)
99 gen
= self
._load
(*filenames
)
103 # Run out the generator if we don't want the verbosity
107 def findMachines(self
):
108 for decl_list
in self
.decl_list_vec
:
109 decl_list
.findMachines()
112 for decl_list
in self
.decl_list_vec
:
115 def writeCodeFiles(self
, code_path
):
116 util
.makeDir(code_path
)
117 self
.symtab
.writeCodeFiles(code_path
)
119 def writeHTMLFiles(self
, code_path
):
120 util
.makeDir(code_path
)
121 self
.symtab
.writeHTMLFiles(code_path
)
129 for decl_list
in self
.decl_list_vec
:
130 f |
= decl_list
.files()
136 # C or C++ comment (ignore)
137 def t_c_comment(self
, t
):
139 t
.lexer
.lineno
+= t
.value
.count('\n')
141 def t_cpp_comment(self
, t
):
144 # Define a rule so we can track line numbers
145 def t_newline(self
, t
):
147 t
.lexer
.lineno
+= len(t
.value
)
151 'machine' : 'MACHINE',
152 'in_port' : 'IN_PORT',
153 'out_port' : 'OUT_PORT',
155 'transition' : 'TRANS',
156 'structure' : 'STRUCT',
157 'external_type' : 'EXTERN_TYPE',
158 'enumeration' : 'ENUM',
160 'stall_and_wait' : 'STALL_AND_WAIT',
161 'wake_up_dependents' : 'WAKE_UP_DEPENDENTS',
162 'enqueue' : 'ENQUEUE',
163 'copy_head' : 'COPY_HEAD',
164 'check_allocate' : 'CHECK_ALLOCATE',
165 'check_stop_slots' : 'CHECK_STOP_SLOTS',
166 'static_cast' : 'STATIC_CAST',
168 'is_valid' : 'IS_VALID',
169 'is_invalid' : 'IS_INVALID',
179 literals
= ':[]{}(),='
181 tokens
= [ 'EQ', 'NE', 'LT', 'GT', 'LE', 'GE',
182 'LEFTSHIFT', 'RIGHTSHIFT',
184 'PLUS', 'DASH', 'STAR', 'SLASH',
185 'DOUBLE_COLON', 'SEMI',
187 'IDENT', 'LIT_BOOL', 'FLOATNUMBER', 'NUMBER', 'STRING' ]
188 tokens
+= reserved
.values()
205 t_DOUBLE_COLON
= r
'::'
211 ('left', 'AND', 'OR'),
212 ('left', 'EQ', 'NE'),
213 ('left', 'LT', 'GT', 'LE', 'GE'),
214 ('left', 'RIGHTSHIFT', 'LEFTSHIFT'),
215 ('left', 'PLUS', 'DASH'),
216 ('left', 'STAR', 'SLASH'),
217 ('right', 'NOT', 'UMINUS'),
220 def t_IDENT(self
, t
):
221 r
'[a-zA-Z_][a-zA-Z_0-9]*'
222 if t
.value
== 'true':
227 if t
.value
== 'false':
232 # Check for reserved words
233 t
.type = self
.reserved
.get(t
.value
, 'IDENT')
236 def t_FLOATNUMBER(self
, t
):
239 t
.value
= float(t
.value
)
241 raise TokenError("Illegal float", t
)
244 def t_NUMBER(self
, t
):
247 t
.value
= int(t
.value
)
249 raise TokenError("Illegal number", t
)
252 def t_STRING1(self
, t
):
255 t
.value
= t
.value
[1:-1]
258 def t_STRING2(self
, t
):
261 t
.value
= t
.value
[1:-1]
268 def p_empty(self
, p
):
271 def p_decls(self
, p
):
273 p
[0] = ast
.DeclListAST(self
, p
[1])
275 def p_declsx__list(self
, p
):
276 "declsx : decl declsx"
277 p
[0] = [ p
[1] ] + p
[2]
279 def p_declsx__none(self
, p
):
283 def p_decl__machine(self
, p
):
284 "decl : MACHINE '(' ident pairs ')' ':' params '{' decls '}'"
285 p
[0] = ast
.MachineAST(self
, p
[3], p
[4], p
[7], p
[9])
287 def p_decl__action(self
, p
):
288 "decl : ACTION '(' ident pairs ')' statements"
289 p
[0] = ast
.ActionDeclAST(self
, p
[3], p
[4], p
[6])
291 def p_decl__in_port(self
, p
):
292 "decl : IN_PORT '(' ident ',' type ',' var pairs ')' statements"
293 p
[0] = ast
.InPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
295 def p_decl__out_port(self
, p
):
296 "decl : OUT_PORT '(' ident ',' type ',' var pairs ')' SEMI"
297 p
[0] = ast
.OutPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8])
299 def p_decl__trans0(self
, p
):
300 "decl : TRANS '(' idents ',' idents ',' ident pairs ')' idents"
301 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
303 def p_decl__trans1(self
, p
):
304 "decl : TRANS '(' idents ',' idents pairs ')' idents"
305 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], None, p
[6], p
[8])
307 def p_decl__extern0(self
, p
):
308 "decl : EXTERN_TYPE '(' type pairs ')' SEMI"
309 p
[4]["external"] = "yes"
310 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], [])
312 def p_decl__extern1(self
, p
):
313 "decl : EXTERN_TYPE '(' type pairs ')' '{' type_methods '}'"
314 p
[4]["external"] = "yes"
315 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
317 def p_decl__global(self
, p
):
318 "decl : GLOBAL '(' type pairs ')' '{' type_members '}'"
319 p
[4]["global"] = "yes"
320 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
322 def p_decl__struct(self
, p
):
323 "decl : STRUCT '(' type pairs ')' '{' type_members '}'"
324 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
326 def p_decl__enum(self
, p
):
327 "decl : ENUM '(' type pairs ')' '{' type_enums '}'"
328 p
[4]["enumeration"] = "yes"
329 p
[0] = ast
.EnumDeclAST(self
, p
[3], p
[4], p
[7])
331 def p_decl__object(self
, p
):
332 "decl : type ident pairs SEMI"
333 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[2], p
[3])
335 def p_decl__func_decl(self
, p
):
336 """decl : void ident '(' params ')' pairs SEMI
337 | type ident '(' params ')' pairs SEMI"""
338 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], None)
340 def p_decl__func_def(self
, p
):
341 """decl : void ident '(' params ')' pairs statements
342 | type ident '(' params ')' pairs statements"""
343 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], p
[7])
346 def p_type_members__list(self
, p
):
347 "type_members : type_member type_members"
348 p
[0] = [ p
[1] ] + p
[2]
350 def p_type_members__empty(self
, p
):
351 "type_members : empty"
354 def p_type_member__1(self
, p
):
355 "type_member : type ident pairs SEMI"
356 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2], p
[3], None)
358 def p_type_member__2(self
, p
):
359 "type_member : type ident ASSIGN expr SEMI"
360 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2],
361 ast
.PairListAST(self
), p
[4])
364 def p_type_methods__list(self
, p
):
365 "type_methods : type_method type_methods"
366 p
[0] = [ p
[1] ] + p
[2]
368 def p_type_methods(self
, p
):
369 "type_methods : empty"
372 def p_type_method(self
, p
):
373 "type_method : type_or_void ident '(' types ')' pairs SEMI"
374 p
[0] = ast
.TypeFieldMethodAST(self
, p
[1], p
[2], p
[4], p
[6])
377 def p_type_enums__list(self
, p
):
378 "type_enums : type_enum type_enums"
379 p
[0] = [ p
[1] ] + p
[2]
381 def p_type_enums__empty(self
, p
):
385 def p_type_enum(self
, p
):
386 "type_enum : ident pairs SEMI"
387 p
[0] = ast
.TypeFieldEnumAST(self
, p
[1], p
[2])
390 def p_types__multiple(self
, p
):
391 "types : type ',' types"
392 p
[0] = [ p
[1] ] + p
[3]
394 def p_types__one(self
, p
):
398 def p_types__empty(self
, p
):
402 def p_typestr__multi(self
, p
):
403 "typestr : typestr DOUBLE_COLON ident"
404 p
[0] = '%s::%s' % (p
[1], p
[3])
406 def p_typestr__single(self
, p
):
410 def p_type__one(self
, p
):
412 p
[0] = ast
.TypeAST(self
, p
[1])
416 p
[0] = ast
.TypeAST(self
, p
[1])
418 def p_type_or_void(self
, p
):
419 """type_or_void : type
424 def p_params__many(self
, p
):
425 "params : param ',' params"
426 p
[0] = [ p
[1] ] + p
[3]
428 def p_params__one(self
, p
):
432 def p_params__none(self
, p
):
436 def p_param(self
, p
):
438 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2])
440 def p_param__pointer(self
, p
):
441 "param : type STAR ident"
442 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], None, True)
444 def p_param__pointer_default(self
, p
):
445 "param : type STAR ident '=' STRING"
446 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], p
[5], True)
448 def p_param__default_number(self
, p
):
449 "param : type ident '=' NUMBER"
450 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
452 def p_param__default_bool(self
, p
):
453 "param : type ident '=' LIT_BOOL"
454 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
456 def p_param__default_string(self
, p
):
457 "param : type ident '=' STRING"
458 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
461 def p_idents__braced(self
, p
):
462 "idents : '{' identx '}'"
465 def p_idents__bare(self
, p
):
469 def p_identx__multiple_1(self
, p
):
470 """identx : ident SEMI identx
471 | ident ',' identx"""
472 p
[0] = [ p
[1] ] + p
[3]
474 def p_identx__multiple_2(self
, p
):
475 "identx : ident identx"
476 p
[0] = [ p
[1] ] + p
[2]
478 def p_identx__single(self
, p
):
482 def p_ident(self
, p
):
486 # Pair and pair lists
487 def p_pairs__list(self
, p
):
491 def p_pairs__empty(self
, p
):
493 p
[0] = ast
.PairListAST(self
)
495 def p_pairsx__many(self
, p
):
496 "pairsx : pair ',' pairsx"
500 def p_pairsx__one(self
, p
):
502 p
[0] = ast
.PairListAST(self
)
505 def p_pair__assign(self
, p
):
506 """pair : ident '=' STRING
508 | ident '=' NUMBER"""
509 p
[0] = ast
.PairAST(self
, p
[1], p
[3])
511 def p_pair__literal(self
, p
):
513 p
[0] = ast
.PairAST(self
, "short", p
[1])
515 # Below are the rules for action descriptions
516 def p_statements__inner(self
, p
):
517 "statements : '{' statements_inner '}'"
518 p
[0] = ast
.StatementListAST(self
, p
[2])
520 def p_statements__none(self
, p
):
521 "statements : '{' '}'"
522 p
[0] = ast
.StatementListAST(self
, [])
524 def p_statements_inner__many(self
, p
):
525 "statements_inner : statement statements_inner"
526 p
[0] = [ p
[1] ] + p
[2]
528 def p_statements_inner__one(self
, p
):
529 "statements_inner : statement"
532 def p_exprs__multiple(self
, p
):
533 "exprs : expr ',' exprs"
534 p
[0] = [ p
[1] ] + p
[3]
536 def p_exprs__one(self
, p
):
540 def p_exprs__empty(self
, p
):
544 def p_statement__expression(self, p):
545 "statement
: expr SEMI
"
546 p[0] = ast.ExprStatementAST(self, p[1])
548 def p_statement__assign(self, p):
549 "statement
: expr ASSIGN expr SEMI
"
550 p[0] = ast.AssignStatementAST(self, p[1], p[3])
552 def p_statement__enqueue(self, p):
553 "statement
: ENQUEUE
'(' var
',' type pairs
')' statements
"
554 p[0] = ast.EnqueueStatementAST(self, p[3], p[5], p[6], p[8])
556 def p_statement__stall_and_wait(self, p):
557 "statement
: STALL_AND_WAIT
'(' var
',' var
')' SEMI
"
558 p[0] = ast.StallAndWaitStatementAST(self, p[3], p[5])
560 def p_statement__wake_up_dependents(self, p):
561 "statement
: WAKE_UP_DEPENDENTS
'(' var
')' SEMI
"
562 p[0] = ast.WakeUpDependentsStatementAST(self, p[3])
564 def p_statement__peek(self, p):
565 "statement
: PEEK
'(' var
',' type pairs
')' statements
"
566 p[0] = ast.PeekStatementAST(self, p[3], p[5], p[6], p[8], "peek
")
568 def p_statement__copy_head(self, p):
569 "statement
: COPY_HEAD
'(' var
',' var pairs
')' SEMI
"
570 p[0] = ast.CopyHeadStatementAST(self, p[3], p[5], p[6])
572 def p_statement__check_allocate(self, p):
573 "statement
: CHECK_ALLOCATE
'(' var
')' SEMI
"
574 p[0] = ast.CheckAllocateStatementAST(self, p[3])
576 def p_statement__check_stop(self, p):
577 "statement
: CHECK_STOP_SLOTS
'(' var
',' STRING
',' STRING
')' SEMI
"
578 p[0] = ast.CheckStopStatementAST(self, p[3], p[5], p[7])
580 def p_statement__static_cast(self, p):
581 "aexpr
: STATIC_CAST
'(' type ',' expr
')'"
582 p[0] = ast.StaticCastAST(self, p[3], "ref
", p[5])
584 def p_statement__static_cast_ptr(self, p):
585 "aexpr
: STATIC_CAST
'(' type ',' STRING
',' expr
')'"
586 p[0] = ast.StaticCastAST(self, p[3], p[5], p[7])
588 def p_statement__return(self, p):
589 "statement
: RETURN expr SEMI
"
590 p[0] = ast.ReturnStatementAST(self, p[2])
592 def p_statement__if(self, p):
593 "statement
: if_statement
"
596 def p_if_statement__if(self, p):
597 "if_statement
: IF
'(' expr
')' statements
"
598 p[0] = ast.IfStatementAST(self, p[3], p[5], None)
600 def p_if_statement__if_else(self, p):
601 "if_statement
: IF
'(' expr
')' statements ELSE statements
"
602 p[0] = ast.IfStatementAST(self, p[3], p[5], p[7])
604 def p_statement__if_else_if(self, p):
605 "if_statement
: IF
'(' expr
')' statements ELSE if_statement
"
606 p[0] = ast.IfStatementAST(self, p[3], p[5],
607 ast.StatementListAST(self, p[7]))
609 def p_expr__var(self, p):
613 def p_expr__localvar(self, p):
615 p[0] = ast.LocalVariableAST(self, p[1], p[2])
617 def p_expr__literal(self, p):
621 def p_expr__enumeration(self, p):
622 "aexpr
: enumeration
"
625 def p_expr__func_call(self, p):
626 "aexpr
: ident
'(' exprs
')'"
627 p[0] = ast.FuncCallExprAST(self, p[1], p[3])
629 def p_expr__new(self, p):
631 p[0] = ast.NewExprAST(self, p[2])
633 def p_expr__null(self, p):
635 p[0] = ast.OodAST(self)
637 # globally access a local chip component and call a method
638 def p_expr__local_chip_method(self, p):
639 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
640 p[0] = ast.LocalChipMethodAST(self, p[3], p[5], p[8], p[10], p[12])
642 # globally access a local chip component and access a data member
643 def p_expr__local_chip_member(self, p):
644 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT field
"
645 p[0] = ast.LocalChipMemberAST(self, p[3], p[5], p[8], p[10])
647 # globally access a specified chip component and call a method
648 def p_expr__specified_chip_method(self, p):
649 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
650 p[0] = ast.SpecifiedChipMethodAST(self, p[3], p[6], p[8], p[11], p[13],
653 # globally access a specified chip component and access a data member
654 def p_expr__specified_chip_member(self, p):
655 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT field
"
656 p[0] = ast.SpecifiedChipMemberAST(self, p[3], p[6], p[8], p[11], p[13])
658 def p_expr__member(self, p):
659 "aexpr
: aexpr DOT ident
"
660 p[0] = ast.MemberExprAST(self, p[1], p[3])
662 def p_expr__member_method_call(self, p):
663 "aexpr
: aexpr DOT ident
'(' exprs
')'"
664 p[0] = ast.MemberMethodCallExprAST(self, p[1], p[3], p[5])
666 def p_expr__member_method_call_lookup(self, p):
667 "aexpr
: aexpr
'[' exprs
']'"
668 p[0] = ast.MemberMethodCallExprAST(self, p[1], "lookup
", p[3])
670 def p_expr__class_method_call(self, p):
671 "aexpr
: type DOUBLE_COLON ident
'(' exprs
')'"
672 p[0] = ast.ClassMethodCallExprAST(self, p[1], p[3], p[5])
674 def p_expr__aexpr(self, p):
678 def p_expr__binary_op(self, p):
679 """expr : expr STAR expr
691 | expr RIGHTSHIFT expr
692 | expr LEFTSHIFT expr"""
693 p[0] = ast.InfixOperatorExprAST(self, p[1], p[2], p[3])
696 def p_expr__unary_op(self, p):
698 | DASH expr %prec UMINUS"""
699 p[0] = PrefixOperatorExpr(p[1], p[2])
701 def p_expr__parens(self, p):
702 "aexpr
: '(' expr
')'"
705 def p_expr__is_valid_ptr(self, p):
706 "aexpr
: IS_VALID
'(' var
')'"
707 p[0] = ast.IsValidPtrExprAST(self, p[3], True)
709 def p_expr__is_invalid_ptr(self, p):
710 "aexpr
: IS_INVALID
'(' var
')'"
711 p[0] = ast.IsValidPtrExprAST(self, p[3], False)
713 def p_literal__string(self, p):
715 p[0] = ast.LiteralExprAST(self, p[1], "std
::string
")
717 def p_literal__number(self, p):
719 p[0] = ast.LiteralExprAST(self, p[1], "int")
721 def p_literal__float(self, p):
722 "literal
: FLOATNUMBER
"
723 p[0] = ast.LiteralExprAST(self, p[1], "int")
725 def p_literal__bool(self, p):
727 p[0] = ast.LiteralExprAST(self, p[1], "bool")
729 def p_enumeration(self, p):
730 "enumeration
: ident
':' ident
"
731 p[0] = ast.EnumExprAST(self, ast.TypeAST(self, p[1]), p[3])
735 p[0] = ast.VarExprAST(self, p[1])
737 def p_field(self, p):