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',
176 literals
= ':[]{}(),='
178 tokens
= [ 'EQ', 'NE', 'LT', 'GT', 'LE', 'GE',
179 'LEFTSHIFT', 'RIGHTSHIFT',
181 'PLUS', 'DASH', 'STAR', 'SLASH',
182 'DOUBLE_COLON', 'SEMI',
184 'IDENT', 'LIT_BOOL', 'FLOATNUMBER', 'NUMBER', 'STRING' ]
185 tokens
+= reserved
.values()
202 t_DOUBLE_COLON
= r
'::'
208 ('left', 'AND', 'OR'),
209 ('left', 'EQ', 'NE'),
210 ('left', 'LT', 'GT', 'LE', 'GE'),
211 ('left', 'RIGHTSHIFT', 'LEFTSHIFT'),
212 ('left', 'PLUS', 'DASH'),
213 ('left', 'STAR', 'SLASH'),
214 ('right', 'NOT', 'UMINUS'),
217 def t_IDENT(self
, t
):
218 r
'[a-zA-Z_][a-zA-Z_0-9]*'
219 if t
.value
== 'true':
224 if t
.value
== 'false':
229 # Check for reserved words
230 t
.type = self
.reserved
.get(t
.value
, 'IDENT')
233 def t_FLOATNUMBER(self
, t
):
236 t
.value
= float(t
.value
)
238 raise TokenError("Illegal float", t
)
241 def t_NUMBER(self
, t
):
244 t
.value
= int(t
.value
)
246 raise TokenError("Illegal number", t
)
249 def t_STRING1(self
, t
):
252 t
.value
= t
.value
[1:-1]
255 def t_STRING2(self
, t
):
258 t
.value
= t
.value
[1:-1]
265 def p_empty(self
, p
):
268 def p_decls(self
, p
):
270 p
[0] = ast
.DeclListAST(self
, p
[1])
272 def p_declsx__list(self
, p
):
273 "declsx : decl declsx"
274 p
[0] = [ p
[1] ] + p
[2]
276 def p_declsx__none(self
, p
):
280 def p_decl__machine(self
, p
):
281 "decl : MACHINE '(' ident pairs ')' ':' params '{' decls '}'"
282 p
[0] = ast
.MachineAST(self
, p
[3], p
[4], p
[7], p
[9])
284 def p_decl__action(self
, p
):
285 "decl : ACTION '(' ident pairs ')' statements"
286 p
[0] = ast
.ActionDeclAST(self
, p
[3], p
[4], p
[6])
288 def p_decl__in_port(self
, p
):
289 "decl : IN_PORT '(' ident ',' type ',' var pairs ')' statements"
290 p
[0] = ast
.InPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
292 def p_decl__out_port(self
, p
):
293 "decl : OUT_PORT '(' ident ',' type ',' var pairs ')' SEMI"
294 p
[0] = ast
.OutPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8])
296 def p_decl__trans0(self
, p
):
297 "decl : TRANS '(' idents ',' idents ',' ident pairs ')' idents"
298 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
300 def p_decl__trans1(self
, p
):
301 "decl : TRANS '(' idents ',' idents pairs ')' idents"
302 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], None, p
[6], p
[8])
304 def p_decl__extern0(self
, p
):
305 "decl : EXTERN_TYPE '(' type pairs ')' SEMI"
306 p
[4]["external"] = "yes"
307 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], [])
309 def p_decl__extern1(self
, p
):
310 "decl : EXTERN_TYPE '(' type pairs ')' '{' type_methods '}'"
311 p
[4]["external"] = "yes"
312 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
314 def p_decl__global(self
, p
):
315 "decl : GLOBAL '(' type pairs ')' '{' type_members '}'"
316 p
[4]["global"] = "yes"
317 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
319 def p_decl__struct(self
, p
):
320 "decl : STRUCT '(' type pairs ')' '{' type_members '}'"
321 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
323 def p_decl__enum(self
, p
):
324 "decl : ENUM '(' type pairs ')' '{' type_enums '}'"
325 p
[4]["enumeration"] = "yes"
326 p
[0] = ast
.EnumDeclAST(self
, p
[3], p
[4], p
[7])
328 def p_decl__object(self
, p
):
329 "decl : type ident pairs SEMI"
330 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[2], p
[3])
332 def p_decl__func_decl(self
, p
):
333 """decl : void ident '(' params ')' pairs SEMI
334 | type ident '(' params ')' pairs SEMI"""
335 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], None)
337 def p_decl__func_def(self
, p
):
338 """decl : void ident '(' params ')' pairs statements
339 | type ident '(' params ')' pairs statements"""
340 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], p
[7])
343 def p_type_members__list(self
, p
):
344 "type_members : type_member type_members"
345 p
[0] = [ p
[1] ] + p
[2]
347 def p_type_members__empty(self
, p
):
348 "type_members : empty"
351 def p_type_member__1(self
, p
):
352 "type_member : type ident pairs SEMI"
353 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2], p
[3], None)
355 def p_type_member__2(self
, p
):
356 "type_member : type ident ASSIGN expr SEMI"
357 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2],
358 ast
.PairListAST(self
), p
[4])
361 def p_type_methods__list(self
, p
):
362 "type_methods : type_method type_methods"
363 p
[0] = [ p
[1] ] + p
[2]
365 def p_type_methods(self
, p
):
366 "type_methods : empty"
369 def p_type_method(self
, p
):
370 "type_method : type_or_void ident '(' types ')' pairs SEMI"
371 p
[0] = ast
.TypeFieldMethodAST(self
, p
[1], p
[2], p
[4], p
[6])
374 def p_type_enums__list(self
, p
):
375 "type_enums : type_enum type_enums"
376 p
[0] = [ p
[1] ] + p
[2]
378 def p_type_enums__empty(self
, p
):
382 def p_type_enum(self
, p
):
383 "type_enum : ident pairs SEMI"
384 p
[0] = ast
.TypeFieldEnumAST(self
, p
[1], p
[2])
387 def p_types__multiple(self
, p
):
388 "types : type ',' types"
389 p
[0] = [ p
[1] ] + p
[3]
391 def p_types__one(self
, p
):
395 def p_types__empty(self
, p
):
399 def p_typestr__multi(self
, p
):
400 "typestr : typestr DOUBLE_COLON ident"
401 p
[0] = '%s::%s' % (p
[1], p
[3])
403 def p_typestr__single(self
, p
):
407 def p_type__one(self
, p
):
409 p
[0] = ast
.TypeAST(self
, p
[1])
413 p
[0] = ast
.TypeAST(self
, p
[1])
415 def p_type_or_void(self
, p
):
416 """type_or_void : type
421 def p_params__many(self
, p
):
422 "params : param ',' params"
423 p
[0] = [ p
[1] ] + p
[3]
425 def p_params__one(self
, p
):
429 def p_params__none(self
, p
):
433 def p_param(self
, p
):
435 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2])
437 def p_param__pointer(self
, p
):
438 "param : type STAR ident"
439 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], None, True)
441 def p_param__pointer_default(self
, p
):
442 "param : type STAR ident '=' STRING"
443 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], p
[5], True)
445 def p_param__default_number(self
, p
):
446 "param : type ident '=' NUMBER"
447 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
449 def p_param__default_bool(self
, p
):
450 "param : type ident '=' LIT_BOOL"
451 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
453 def p_param__default_string(self
, p
):
454 "param : type ident '=' STRING"
455 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
458 def p_idents__braced(self
, p
):
459 "idents : '{' identx '}'"
462 def p_idents__bare(self
, p
):
466 def p_identx__multiple_1(self
, p
):
467 """identx : ident SEMI identx
468 | ident ',' identx"""
469 p
[0] = [ p
[1] ] + p
[3]
471 def p_identx__multiple_2(self
, p
):
472 "identx : ident identx"
473 p
[0] = [ p
[1] ] + p
[2]
475 def p_identx__single(self
, p
):
479 def p_ident(self
, p
):
483 # Pair and pair lists
484 def p_pairs__list(self
, p
):
488 def p_pairs__empty(self
, p
):
490 p
[0] = ast
.PairListAST(self
)
492 def p_pairsx__many(self
, p
):
493 "pairsx : pair ',' pairsx"
497 def p_pairsx__one(self
, p
):
499 p
[0] = ast
.PairListAST(self
)
502 def p_pair__assign(self
, p
):
503 """pair : ident '=' STRING
505 | ident '=' NUMBER"""
506 p
[0] = ast
.PairAST(self
, p
[1], p
[3])
508 def p_pair__literal(self
, p
):
510 p
[0] = ast
.PairAST(self
, "short", p
[1])
512 # Below are the rules for action descriptions
513 def p_statements__inner(self
, p
):
514 "statements : '{' statements_inner '}'"
515 p
[0] = ast
.StatementListAST(self
, p
[2])
517 def p_statements__none(self
, p
):
518 "statements : '{' '}'"
519 p
[0] = ast
.StatementListAST(self
, [])
521 def p_statements_inner__many(self
, p
):
522 "statements_inner : statement statements_inner"
523 p
[0] = [ p
[1] ] + p
[2]
525 def p_statements_inner__one(self
, p
):
526 "statements_inner : statement"
529 def p_exprs__multiple(self
, p
):
530 "exprs : expr ',' exprs"
531 p
[0] = [ p
[1] ] + p
[3]
533 def p_exprs__one(self
, p
):
537 def p_exprs__empty(self
, p
):
541 def p_statement__expression(self, p):
542 "statement
: expr SEMI
"
543 p[0] = ast.ExprStatementAST(self, p[1])
545 def p_statement__assign(self, p):
546 "statement
: expr ASSIGN expr SEMI
"
547 p[0] = ast.AssignStatementAST(self, p[1], p[3])
549 def p_statement__enqueue(self, p):
550 "statement
: ENQUEUE
'(' var
',' type pairs
')' statements
"
551 p[0] = ast.EnqueueStatementAST(self, p[3], p[5], p[6], p[8])
553 def p_statement__stall_and_wait(self, p):
554 "statement
: STALL_AND_WAIT
'(' var
',' var
')' SEMI
"
555 p[0] = ast.StallAndWaitStatementAST(self, p[3], p[5])
557 def p_statement__wake_up_dependents(self, p):
558 "statement
: WAKE_UP_DEPENDENTS
'(' var
')' SEMI
"
559 p[0] = ast.WakeUpDependentsStatementAST(self, p[3])
561 def p_statement__peek(self, p):
562 "statement
: PEEK
'(' var
',' type pairs
')' statements
"
563 p[0] = ast.PeekStatementAST(self, p[3], p[5], p[6], p[8], "peek
")
565 def p_statement__copy_head(self, p):
566 "statement
: COPY_HEAD
'(' var
',' var pairs
')' SEMI
"
567 p[0] = ast.CopyHeadStatementAST(self, p[3], p[5], p[6])
569 def p_statement__check_allocate(self, p):
570 "statement
: CHECK_ALLOCATE
'(' var
')' SEMI
"
571 p[0] = ast.CheckAllocateStatementAST(self, p[3])
573 def p_statement__check_stop(self, p):
574 "statement
: CHECK_STOP_SLOTS
'(' var
',' STRING
',' STRING
')' SEMI
"
575 p[0] = ast.CheckStopStatementAST(self, p[3], p[5], p[7])
577 def p_statement__static_cast(self, p):
578 "aexpr
: STATIC_CAST
'(' type ',' expr
')'"
579 p[0] = ast.StaticCastAST(self, p[3], p[5])
581 def p_statement__return(self, p):
582 "statement
: RETURN expr SEMI
"
583 p[0] = ast.ReturnStatementAST(self, p[2])
585 def p_statement__if(self, p):
586 "statement
: if_statement
"
589 def p_if_statement__if(self, p):
590 "if_statement
: IF
'(' expr
')' statements
"
591 p[0] = ast.IfStatementAST(self, p[3], p[5], None)
593 def p_if_statement__if_else(self, p):
594 "if_statement
: IF
'(' expr
')' statements ELSE statements
"
595 p[0] = ast.IfStatementAST(self, p[3], p[5], p[7])
597 def p_statement__if_else_if(self, p):
598 "if_statement
: IF
'(' expr
')' statements ELSE if_statement
"
599 p[0] = ast.IfStatementAST(self, p[3], p[5],
600 ast.StatementListAST(self, p[7]))
602 def p_expr__var(self, p):
606 def p_expr__literal(self, p):
610 def p_expr__enumeration(self, p):
611 "aexpr
: enumeration
"
614 def p_expr__func_call(self, p):
615 "aexpr
: ident
'(' exprs
')'"
616 p[0] = ast.FuncCallExprAST(self, p[1], p[3])
618 def p_expr__new(self, p):
620 p[0] = ast.NewExprAST(self, p[2])
622 # globally access a local chip component and call a method
623 def p_expr__local_chip_method(self, p):
624 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
625 p[0] = ast.LocalChipMethodAST(self, p[3], p[5], p[8], p[10], p[12])
627 # globally access a local chip component and access a data member
628 def p_expr__local_chip_member(self, p):
629 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT field
"
630 p[0] = ast.LocalChipMemberAST(self, p[3], p[5], p[8], p[10])
632 # globally access a specified chip component and call a method
633 def p_expr__specified_chip_method(self, p):
634 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
635 p[0] = ast.SpecifiedChipMethodAST(self, p[3], p[6], p[8], p[11], p[13],
638 # globally access a specified chip component and access a data member
639 def p_expr__specified_chip_member(self, p):
640 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT field
"
641 p[0] = ast.SpecifiedChipMemberAST(self, p[3], p[6], p[8], p[11], p[13])
643 def p_expr__member(self, p):
644 "aexpr
: aexpr DOT ident
"
645 p[0] = ast.MemberExprAST(self, p[1], p[3])
647 def p_expr__member_method_call(self, p):
648 "aexpr
: aexpr DOT ident
'(' exprs
')'"
649 p[0] = ast.MemberMethodCallExprAST(self, p[1], p[3], p[5])
651 def p_expr__member_method_call_lookup(self, p):
652 "aexpr
: aexpr
'[' exprs
']'"
653 p[0] = ast.MemberMethodCallExprAST(self, p[1], "lookup
", p[3])
655 def p_expr__class_method_call(self, p):
656 "aexpr
: type DOUBLE_COLON ident
'(' exprs
')'"
657 p[0] = ast.ClassMethodCallExprAST(self, p[1], p[3], p[5])
659 def p_expr__aexpr(self, p):
663 def p_expr__binary_op(self, p):
664 """expr : expr STAR expr
676 | expr RIGHTSHIFT expr
677 | expr LEFTSHIFT expr"""
678 p[0] = ast.InfixOperatorExprAST(self, p[1], p[2], p[3])
681 def p_expr__unary_op(self, p):
683 | DASH expr %prec UMINUS"""
684 p[0] = PrefixOperatorExpr(p[1], p[2])
686 def p_expr__parens(self, p):
687 "aexpr
: '(' expr
')'"
690 def p_literal__string(self, p):
692 p[0] = ast.LiteralExprAST(self, p[1], "std
::string
")
694 def p_literal__number(self, p):
696 p[0] = ast.LiteralExprAST(self, p[1], "int")
698 def p_literal__float(self, p):
699 "literal
: FLOATNUMBER
"
700 p[0] = ast.LiteralExprAST(self, p[1], "int")
702 def p_literal__bool(self, p):
704 p[0] = ast.LiteralExprAST(self, p[1], "bool")
706 def p_enumeration(self, p):
707 "enumeration
: ident
':' ident
"
708 p[0] = ast.EnumExprAST(self, ast.TypeAST(self, p[1]), p[3])
712 p[0] = ast.VarExprAST(self, p[1])
714 def p_field(self, p):