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 'enqueue' : 'ENQUEUE',
161 'copy_head' : 'COPY_HEAD',
162 'check_allocate' : 'CHECK_ALLOCATE',
163 'check_stop_slots' : 'CHECK_STOP_SLOTS',
164 'static_cast' : 'STATIC_CAST',
174 literals
= ':[]{}(),='
176 tokens
= [ 'EQ', 'NE', 'LT', 'GT', 'LE', 'GE',
177 'LEFTSHIFT', 'RIGHTSHIFT',
179 'PLUS', 'DASH', 'STAR', 'SLASH',
180 'DOUBLE_COLON', 'SEMI',
182 'IDENT', 'LIT_BOOL', 'FLOATNUMBER', 'NUMBER', 'STRING' ]
183 tokens
+= reserved
.values()
200 t_DOUBLE_COLON
= r
'::'
206 ('left', 'AND', 'OR'),
207 ('left', 'EQ', 'NE'),
208 ('left', 'LT', 'GT', 'LE', 'GE'),
209 ('left', 'RIGHTSHIFT', 'LEFTSHIFT'),
210 ('left', 'PLUS', 'DASH'),
211 ('left', 'STAR', 'SLASH'),
212 ('right', 'NOT', 'UMINUS'),
215 def t_IDENT(self
, t
):
216 r
'[a-zA-Z_][a-zA-Z_0-9]*'
217 if t
.value
== 'true':
222 if t
.value
== 'false':
227 # Check for reserved words
228 t
.type = self
.reserved
.get(t
.value
, 'IDENT')
231 def t_FLOATNUMBER(self
, t
):
234 t
.value
= float(t
.value
)
236 raise TokenError("Illegal float", t
)
239 def t_NUMBER(self
, t
):
242 t
.value
= int(t
.value
)
244 raise TokenError("Illegal number", t
)
247 def t_STRING1(self
, t
):
250 t
.value
= t
.value
[1:-1]
253 def t_STRING2(self
, t
):
256 t
.value
= t
.value
[1:-1]
263 def p_empty(self
, p
):
266 def p_decls(self
, p
):
268 p
[0] = ast
.DeclListAST(self
, p
[1])
270 def p_declsx__list(self
, p
):
271 "declsx : decl declsx"
272 p
[0] = [ p
[1] ] + p
[2]
274 def p_declsx__none(self
, p
):
278 def p_decl__machine(self
, p
):
279 "decl : MACHINE '(' ident pairs ')' ':' params '{' decls '}'"
280 p
[0] = ast
.MachineAST(self
, p
[3], p
[4], p
[7], p
[9])
282 def p_decl__action(self
, p
):
283 "decl : ACTION '(' ident pairs ')' statements"
284 p
[0] = ast
.ActionDeclAST(self
, p
[3], p
[4], p
[6])
286 def p_decl__in_port(self
, p
):
287 "decl : IN_PORT '(' ident ',' type ',' var pairs ')' statements"
288 p
[0] = ast
.InPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
290 def p_decl__out_port(self
, p
):
291 "decl : OUT_PORT '(' ident ',' type ',' var pairs ')' SEMI"
292 p
[0] = ast
.OutPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8])
294 def p_decl__trans0(self
, p
):
295 "decl : TRANS '(' idents ',' idents ',' ident pairs ')' idents"
296 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
298 def p_decl__trans1(self
, p
):
299 "decl : TRANS '(' idents ',' idents pairs ')' idents"
300 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], None, p
[6], p
[8])
302 def p_decl__extern0(self
, p
):
303 "decl : EXTERN_TYPE '(' type pairs ')' SEMI"
304 p
[4]["external"] = "yes"
305 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], [])
307 def p_decl__extern1(self
, p
):
308 "decl : EXTERN_TYPE '(' type pairs ')' '{' type_methods '}'"
309 p
[4]["external"] = "yes"
310 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
312 def p_decl__global(self
, p
):
313 "decl : GLOBAL '(' type pairs ')' '{' type_members '}'"
314 p
[4]["global"] = "yes"
315 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
317 def p_decl__struct(self
, p
):
318 "decl : STRUCT '(' type pairs ')' '{' type_members '}'"
319 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
321 def p_decl__enum(self
, p
):
322 "decl : ENUM '(' type pairs ')' '{' type_enums '}'"
323 p
[4]["enumeration"] = "yes"
324 p
[0] = ast
.EnumDeclAST(self
, p
[3], p
[4], p
[7])
326 def p_decl__object(self
, p
):
327 "decl : type ident pairs SEMI"
328 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[2], p
[3])
330 def p_decl__func_decl(self
, p
):
331 """decl : void ident '(' params ')' pairs SEMI
332 | type ident '(' params ')' pairs SEMI"""
333 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], None)
335 def p_decl__func_def(self
, p
):
336 """decl : void ident '(' params ')' pairs statements
337 | type ident '(' params ')' pairs statements"""
338 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], p
[7])
341 def p_type_members__list(self
, p
):
342 "type_members : type_member type_members"
343 p
[0] = [ p
[1] ] + p
[2]
345 def p_type_members__empty(self
, p
):
346 "type_members : empty"
349 def p_type_member__1(self
, p
):
350 "type_member : type ident pairs SEMI"
351 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2], p
[3], None)
353 def p_type_member__2(self
, p
):
354 "type_member : type ident ASSIGN expr SEMI"
355 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2],
356 ast
.PairListAST(self
), p
[4])
359 def p_type_methods__list(self
, p
):
360 "type_methods : type_method type_methods"
361 p
[0] = [ p
[1] ] + p
[2]
363 def p_type_methods(self
, p
):
364 "type_methods : empty"
367 def p_type_method(self
, p
):
368 "type_method : type_or_void ident '(' types ')' pairs SEMI"
369 p
[0] = ast
.TypeFieldMethodAST(self
, p
[1], p
[2], p
[4], p
[6])
372 def p_type_enums__list(self
, p
):
373 "type_enums : type_enum type_enums"
374 p
[0] = [ p
[1] ] + p
[2]
376 def p_type_enums__empty(self
, p
):
380 def p_type_enum(self
, p
):
381 "type_enum : ident pairs SEMI"
382 p
[0] = ast
.TypeFieldEnumAST(self
, p
[1], p
[2])
385 def p_types__multiple(self
, p
):
386 "types : type ',' types"
387 p
[0] = [ p
[1] ] + p
[3]
389 def p_types__one(self
, p
):
393 def p_types__empty(self
, p
):
399 p
[0] = ast
.TypeAST(self
, p
[1])
403 p
[0] = ast
.TypeAST(self
, p
[1])
405 def p_type_or_void(self
, p
):
406 """type_or_void : type
411 def p_params__many(self
, p
):
412 "params : param ',' params"
413 p
[0] = [ p
[1] ] + p
[3]
415 def p_params__one(self
, p
):
419 def p_params__none(self
, p
):
423 def p_param(self
, p
):
425 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2])
427 def p_param__pointer(self
, p
):
428 "param : type STAR ident"
429 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], None, True)
431 def p_param__pointer_default(self
, p
):
432 "param : type STAR ident '=' STRING"
433 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[3], p
[5], True)
435 def p_param__default_number(self
, p
):
436 "param : type ident '=' NUMBER"
437 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
439 def p_param__default_bool(self
, p
):
440 "param : type ident '=' LIT_BOOL"
441 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
443 def p_param__default_string(self
, p
):
444 "param : type ident '=' STRING"
445 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
448 def p_idents__braced(self
, p
):
449 "idents : '{' identx '}'"
452 def p_idents__bare(self
, p
):
456 def p_identx__multiple_1(self
, p
):
457 """identx : ident SEMI identx
458 | ident ',' identx"""
459 p
[0] = [ p
[1] ] + p
[3]
461 def p_identx__multiple_2(self
, p
):
462 "identx : ident identx"
463 p
[0] = [ p
[1] ] + p
[2]
465 def p_identx__single(self
, p
):
469 def p_ident(self
, p
):
473 # Pair and pair lists
474 def p_pairs__list(self
, p
):
478 def p_pairs__empty(self
, p
):
480 p
[0] = ast
.PairListAST(self
)
482 def p_pairsx__many(self
, p
):
483 "pairsx : pair ',' pairsx"
487 def p_pairsx__one(self
, p
):
489 p
[0] = ast
.PairListAST(self
)
492 def p_pair__assign(self
, p
):
493 """pair : ident '=' STRING
495 p
[0] = ast
.PairAST(self
, p
[1], p
[3])
497 def p_pair__literal(self
, p
):
499 p
[0] = ast
.PairAST(self
, "short", p
[1])
501 # Below are the rules for action descriptions
502 def p_statements__inner(self
, p
):
503 "statements : '{' statements_inner '}'"
504 p
[0] = ast
.StatementListAST(self
, p
[2])
506 def p_statements__none(self
, p
):
507 "statements : '{' '}'"
508 p
[0] = ast
.StatementListAST(self
, [])
510 def p_statements_inner__many(self
, p
):
511 "statements_inner : statement statements_inner"
512 p
[0] = [ p
[1] ] + p
[2]
514 def p_statements_inner__one(self
, p
):
515 "statements_inner : statement"
518 def p_exprs__multiple(self
, p
):
519 "exprs : expr ',' exprs"
520 p
[0] = [ p
[1] ] + p
[3]
522 def p_exprs__one(self
, p
):
526 def p_exprs__empty(self
, p
):
530 def p_statement__expression(self, p):
531 "statement
: expr SEMI
"
532 p[0] = ast.ExprStatementAST(self, p[1])
534 def p_statement__assign(self, p):
535 "statement
: expr ASSIGN expr SEMI
"
536 p[0] = ast.AssignStatementAST(self, p[1], p[3])
538 def p_statement__enqueue(self, p):
539 "statement
: ENQUEUE
'(' var
',' type pairs
')' statements
"
540 p[0] = ast.EnqueueStatementAST(self, p[3], p[5], p[6], p[8])
542 def p_statement__peek(self, p):
543 "statement
: PEEK
'(' var
',' type pairs
')' statements
"
544 p[0] = ast.PeekStatementAST(self, p[3], p[5], p[6], p[8], "peek
")
546 def p_statement__copy_head(self, p):
547 "statement
: COPY_HEAD
'(' var
',' var pairs
')' SEMI
"
548 p[0] = ast.CopyHeadStatementAST(self, p[3], p[5], p[6])
550 def p_statement__check_allocate(self, p):
551 "statement
: CHECK_ALLOCATE
'(' var
')' SEMI
"
552 p[0] = ast.CheckAllocateStatementAST(self, p[3])
554 def p_statement__check_stop(self, p):
555 "statement
: CHECK_STOP_SLOTS
'(' var
',' STRING
',' STRING
')' SEMI
"
556 p[0] = ast.CheckStopStatementAST(self, p[3], p[5], p[7])
558 def p_statement__static_cast(self, p):
559 "aexpr
: STATIC_CAST
'(' type ',' expr
')'"
560 p[0] = ast.StaticCastAST(self, p[3], p[5])
562 def p_statement__return(self, p):
563 "statement
: RETURN expr SEMI
"
564 p[0] = ast.ReturnStatementAST(self, p[2])
566 def p_statement__if(self, p):
567 "statement
: if_statement
"
570 def p_if_statement__if(self, p):
571 "if_statement
: IF
'(' expr
')' statements
"
572 p[0] = ast.IfStatementAST(self, p[3], p[5], None)
574 def p_if_statement__if_else(self, p):
575 "if_statement
: IF
'(' expr
')' statements ELSE statements
"
576 p[0] = ast.IfStatementAST(self, p[3], p[5], p[7])
578 def p_statement__if_else_if(self, p):
579 "if_statement
: IF
'(' expr
')' statements ELSE if_statement
"
580 p[0] = ast.IfStatementAST(self, p[3], p[5],
581 ast.StatementListAST(self, p[7]))
583 def p_expr__var(self, p):
587 def p_expr__literal(self, p):
591 def p_expr__enumeration(self, p):
592 "aexpr
: enumeration
"
595 def p_expr__func_call(self, p):
596 "aexpr
: ident
'(' exprs
')'"
597 p[0] = ast.FuncCallExprAST(self, p[1], p[3])
599 def p_expr__new(self, p):
601 p[0] = ast.NewExprAST(self, p[2])
603 # globally access a local chip component and call a method
604 def p_expr__local_chip_method(self, p):
605 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
606 p[0] = ast.LocalChipMethodAST(self, p[3], p[5], p[8], p[10], p[12])
608 # globally access a local chip component and access a data member
609 def p_expr__local_chip_member(self, p):
610 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT field
"
611 p[0] = ast.LocalChipMemberAST(self, p[3], p[5], p[8], p[10])
613 # globally access a specified chip component and call a method
614 def p_expr__specified_chip_method(self, p):
615 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
616 p[0] = ast.SpecifiedChipMethodAST(self, p[3], p[6], p[8], p[11], p[13],
619 # globally access a specified chip component and access a data member
620 def p_expr__specified_chip_member(self, p):
621 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT field
"
622 p[0] = ast.SpecifiedChipMemberAST(self, p[3], p[6], p[8], p[11], p[13])
624 def p_expr__member(self, p):
625 "aexpr
: aexpr DOT ident
"
626 p[0] = ast.MemberExprAST(self, p[1], p[3])
628 def p_expr__member_method_call(self, p):
629 "aexpr
: aexpr DOT ident
'(' exprs
')'"
630 p[0] = ast.MemberMethodCallExprAST(self, p[1], p[3], p[5])
632 def p_expr__member_method_call_lookup(self, p):
633 "aexpr
: aexpr
'[' exprs
']'"
634 p[0] = ast.MemberMethodCallExprAST(self, p[1], "lookup
", p[3])
636 def p_expr__class_method_call(self, p):
637 "aexpr
: type DOUBLE_COLON ident
'(' exprs
')'"
638 p[0] = ast.ClassMethodCallExprAST(self, p[1], p[3], p[5])
640 def p_expr__aexpr(self, p):
644 def p_expr__binary_op(self, p):
645 """expr : expr STAR expr
657 | expr RIGHTSHIFT expr
658 | expr LEFTSHIFT expr"""
659 p[0] = ast.InfixOperatorExprAST(self, p[1], p[2], p[3])
662 def p_expr__unary_op(self, p):
664 | DASH expr %prec UMINUS"""
665 p[0] = PrefixOperatorExpr(p[1], p[2])
667 def p_expr__parens(self, p):
668 "aexpr
: '(' expr
')'"
671 def p_literal__string(self, p):
673 p[0] = ast.LiteralExprAST(self, p[1], "string
")
675 def p_literal__number(self, p):
677 p[0] = ast.LiteralExprAST(self, p[1], "int")
679 def p_literal__float(self, p):
680 "literal
: FLOATNUMBER
"
681 p[0] = ast.LiteralExprAST(self, p[1], "int")
683 def p_literal__bool(self, p):
685 p[0] = ast.LiteralExprAST(self, p[1], "bool")
687 def p_enumeration(self, p):
688 "enumeration
: ident
':' ident
"
689 p[0] = ast.EnumExprAST(self, ast.TypeAST(self, p[1]), p[3])
693 p[0] = ast.VarExprAST(self, p[1])
695 def p_field(self, p):