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
.grammar
import Grammar
, TokenError
, ParseError
35 import slicc
.ast
as ast
36 import slicc
.util
as util
37 from slicc
.symbols
import SymbolTable
39 def read_slicc(sources
):
40 if not isinstance(sources
, (list,tuple)):
43 for source
in sources
:
44 for sm_file
in file(source
, "r"):
45 sm_file
= sm_file
.strip()
48 if sm_file
.startswith("#"):
53 def __init__(self
, **kwargs
):
54 super(SLICC
, self
).__init
__(**kwargs
)
55 self
.decl_list_vec
= []
56 self
.current_file
= None
57 self
.symtab
= SymbolTable()
59 def parse(self
, filename
):
60 self
.current_file
= filename
61 f
= file(filename
, 'r')
64 decl_list
= super(SLICC
, self
).parse(text
)
65 except (TokenError
, ParseError
), e
:
66 sys
.exit("%s: %s:%d" % (e
, filename
, e
.token
.lineno
))
67 self
.decl_list_vec
.append(decl_list
)
68 self
.current_file
= None
70 def _load(self
, *filenames
):
71 filenames
= list(filenames
)
74 if isinstance(f
, (list, tuple)):
75 filenames
[0:0] = list(f
)
79 if f
.endswith(".slicc"):
80 dirname
,basename
= os
.path
.split(f
)
81 filenames
[0:0] = [ os
.path
.join(dirname
, x
) \
82 for x
in read_slicc(f
)]
84 assert f
.endswith(".sm")
87 def load(self
, *filenames
, **kwargs
):
88 verbose
= kwargs
.pop("verbose", False)
92 gen
= self
._load
(*filenames
)
96 # Run out the generator if we don't want the verbosity
100 def findMachines(self
):
101 for decl_list
in self
.decl_list_vec
:
102 decl_list
.findMachines()
105 for decl_list
in self
.decl_list_vec
:
108 def writeCodeFiles(self
, code_path
):
109 util
.makeDir(code_path
)
110 self
.symtab
.writeCodeFiles(code_path
)
112 def writeHTMLFiles(self
, code_path
):
113 util
.makeDir(code_path
)
114 self
.symtab
.writeHTMLFiles(code_path
)
122 for decl_list
in self
.decl_list_vec
:
123 f |
= decl_list
.files()
129 # C or C++ comment (ignore)
130 def t_c_comment(self
, t
):
132 t
.lexer
.lineno
+= t
.value
.count('\n')
134 def t_cpp_comment(self
, t
):
137 # Define a rule so we can track line numbers
138 def t_newline(self
, t
):
140 t
.lexer
.lineno
+= len(t
.value
)
144 'machine' : 'MACHINE',
145 'in_port' : 'IN_PORT',
146 'out_port' : 'OUT_PORT',
148 'transition' : 'TRANS',
149 'structure' : 'STRUCT',
150 'external_type' : 'EXTERN_TYPE',
151 'enumeration' : 'ENUM',
153 'enqueue' : 'ENQUEUE',
154 'copy_head' : 'COPY_HEAD',
155 'check_allocate' : 'CHECK_ALLOCATE',
156 'check_stop_slots' : 'CHECK_STOP_SLOTS',
166 literals
= ':[]{}(),='
168 tokens
= [ 'EQ', 'NE', 'LT', 'GT', 'LE', 'GE',
169 'LEFTSHIFT', 'RIGHTSHIFT',
171 'PLUS', 'DASH', 'STAR', 'SLASH',
172 'DOUBLE_COLON', 'SEMI',
174 'IDENT', 'LIT_BOOL', 'FLOATNUMBER', 'NUMBER', 'STRING' ]
175 tokens
+= reserved
.values()
192 t_DOUBLE_COLON
= r
'::'
198 ('left', 'AND', 'OR'),
199 ('left', 'EQ', 'NE'),
200 ('left', 'LT', 'GT', 'LE', 'GE'),
201 ('left', 'RIGHTSHIFT', 'LEFTSHIFT'),
202 ('left', 'PLUS', 'DASH'),
203 ('left', 'STAR', 'SLASH'),
204 ('right', 'NOT', 'UMINUS'),
207 def t_IDENT(self
, t
):
208 r
'[a-zA-Z_][a-zA-Z_0-9]*'
209 if t
.value
== 'true':
214 if t
.value
== 'false':
219 # Check for reserved words
220 t
.type = self
.reserved
.get(t
.value
, 'IDENT')
223 def t_FLOATNUMBER(self
, t
):
226 t
.value
= float(t
.value
)
228 raise TokenError("Illegal float", t
)
231 def t_NUMBER(self
, t
):
234 t
.value
= int(t
.value
)
236 raise TokenError("Illegal number", t
)
239 def t_STRING1(self
, t
):
242 t
.value
= t
.value
[1:-1]
245 def t_STRING2(self
, t
):
248 t
.value
= t
.value
[1:-1]
255 def p_empty(self
, p
):
258 def p_decls(self
, p
):
260 p
[0] = ast
.DeclListAST(self
, p
[1])
262 def p_declsx__list(self
, p
):
263 "declsx : decl declsx"
264 p
[0] = [ p
[1] ] + p
[2]
266 def p_declsx__none(self
, p
):
270 def p_decl__machine(self
, p
):
271 "decl : MACHINE '(' ident pairs ')' ':' params '{' decls '}'"
272 p
[0] = ast
.MachineAST(self
, p
[3], p
[4], p
[7], p
[9])
274 def p_decl__action(self
, p
):
275 "decl : ACTION '(' ident pairs ')' statements"
276 p
[0] = ast
.ActionDeclAST(self
, p
[3], p
[4], p
[6])
278 def p_decl__in_port(self
, p
):
279 "decl : IN_PORT '(' ident ',' type ',' var pairs ')' statements"
280 p
[0] = ast
.InPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
282 def p_decl__out_port(self
, p
):
283 "decl : OUT_PORT '(' ident ',' type ',' var pairs ')' SEMI"
284 p
[0] = ast
.OutPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8])
286 def p_decl__trans0(self
, p
):
287 "decl : TRANS '(' idents ',' idents ',' ident pairs ')' idents"
288 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
290 def p_decl__trans1(self
, p
):
291 "decl : TRANS '(' idents ',' idents pairs ')' idents"
292 p
[0] = ast
.TransitionDeclAST(self
, p
[3], p
[5], None, p
[6], p
[8])
294 def p_decl__extern0(self
, p
):
295 "decl : EXTERN_TYPE '(' type pairs ')' SEMI"
296 p
[4]["external"] = "yes"
297 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], [])
299 def p_decl__extern1(self
, p
):
300 "decl : EXTERN_TYPE '(' type pairs ')' '{' type_methods '}'"
301 p
[4]["external"] = "yes"
302 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
304 def p_decl__global(self
, p
):
305 "decl : GLOBAL '(' type pairs ')' '{' type_members '}'"
306 p
[4]["global"] = "yes"
307 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
309 def p_decl__struct(self
, p
):
310 "decl : STRUCT '(' type pairs ')' '{' type_members '}'"
311 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
313 def p_decl__enum(self
, p
):
314 "decl : ENUM '(' type pairs ')' '{' type_enums '}'"
315 p
[4]["enumeration"] = "yes"
316 p
[0] = ast
.EnumDeclAST(self
, p
[3], p
[4], p
[7])
318 def p_decl__object(self
, p
):
319 "decl : type ident pairs SEMI"
320 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[2], p
[3])
322 def p_decl__func_decl(self
, p
):
323 """decl : void ident '(' params ')' pairs SEMI
324 | type ident '(' params ')' pairs SEMI"""
325 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], None)
327 def p_decl__func_def(self
, p
):
328 """decl : void ident '(' params ')' pairs statements
329 | type ident '(' params ')' pairs statements"""
330 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], p
[7])
333 def p_type_members__list(self
, p
):
334 "type_members : type_member type_members"
335 p
[0] = [ p
[1] ] + p
[2]
337 def p_type_members__empty(self
, p
):
338 "type_members : empty"
341 def p_type_member__1(self
, p
):
342 "type_member : type ident pairs SEMI"
343 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2], p
[3], None)
345 def p_type_member__2(self
, p
):
346 "type_member : type ident ASSIGN expr SEMI"
347 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2],
348 ast
.PairListAST(self
), p
[4])
351 def p_type_methods__list(self
, p
):
352 "type_methods : type_method type_methods"
353 p
[0] = [ p
[1] ] + p
[2]
355 def p_type_methods(self
, p
):
356 "type_methods : empty"
359 def p_type_method(self
, p
):
360 "type_method : type_or_void ident '(' types ')' pairs SEMI"
361 p
[0] = ast
.TypeFieldMethodAST(self
, p
[1], p
[2], p
[4], p
[6])
364 def p_type_enums__list(self
, p
):
365 "type_enums : type_enum type_enums"
366 p
[0] = [ p
[1] ] + p
[2]
368 def p_type_enums__empty(self
, p
):
372 def p_type_enum(self
, p
):
373 "type_enum : ident pairs SEMI"
374 p
[0] = ast
.TypeFieldEnumAST(self
, p
[1], p
[2])
377 def p_types__multiple(self
, p
):
378 "types : type ',' types"
379 p
[0] = [ p
[1] ] + p
[3]
381 def p_types__one(self
, p
):
385 def p_types__empty(self
, p
):
391 p
[0] = ast
.TypeAST(self
, p
[1])
395 p
[0] = ast
.TypeAST(self
, p
[1])
397 def p_type_or_void(self
, p
):
398 """type_or_void : type
403 def p_params__many(self
, p
):
404 "params : param ',' params"
405 p
[0] = [ p
[1] ] + p
[3]
407 def p_params__one(self
, p
):
411 def p_params__none(self
, p
):
415 def p_param(self
, p
):
417 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2])
419 def p_param__default(self
, p
):
420 "param : type ident '=' NUMBER"
421 p
[0] = ast
.FormalParamAST(self
, p
[1], p
[2], p
[4])
424 def p_idents__braced(self
, p
):
425 "idents : '{' identx '}'"
428 def p_idents__bare(self
, p
):
432 def p_identx__multiple_1(self
, p
):
433 """identx : ident SEMI identx
434 | ident ',' identx"""
435 p
[0] = [ p
[1] ] + p
[3]
437 def p_identx__multiple_2(self
, p
):
438 "identx : ident identx"
439 p
[0] = [ p
[1] ] + p
[2]
441 def p_identx__single(self
, p
):
445 def p_ident(self
, p
):
449 # Pair and pair lists
450 def p_pairs__list(self
, p
):
454 def p_pairs__empty(self
, p
):
456 p
[0] = ast
.PairListAST(self
)
458 def p_pairsx__many(self
, p
):
459 "pairsx : pair ',' pairsx"
463 def p_pairsx__one(self
, p
):
465 p
[0] = ast
.PairListAST(self
)
468 def p_pair__assign(self
, p
):
469 """pair : ident '=' STRING
471 p
[0] = ast
.PairAST(self
, p
[1], p
[3])
473 def p_pair__literal(self
, p
):
475 p
[0] = ast
.PairAST(self
, "short", p
[1])
477 # Below are the rules for action descriptions
478 def p_statements__inner(self
, p
):
479 "statements : '{' statements_inner '}'"
480 p
[0] = ast
.StatementListAST(self
, p
[2])
482 def p_statements__none(self
, p
):
483 "statements : '{' '}'"
484 p
[0] = ast
.StatementListAST(self
, [])
486 def p_statements_inner__many(self
, p
):
487 "statements_inner : statement statements_inner"
488 p
[0] = [ p
[1] ] + p
[2]
490 def p_statements_inner__one(self
, p
):
491 "statements_inner : statement"
494 def p_exprs__multiple(self
, p
):
495 "exprs : expr ',' exprs"
496 p
[0] = [ p
[1] ] + p
[3]
498 def p_exprs__one(self
, p
):
502 def p_exprs__empty(self
, p
):
506 def p_statement__expression(self, p):
507 "statement
: expr SEMI
"
508 p[0] = ast.ExprStatementAST(self, p[1])
510 def p_statement__assign(self, p):
511 "statement
: expr ASSIGN expr SEMI
"
512 p[0] = ast.AssignStatementAST(self, p[1], p[3])
514 def p_statement__enqueue(self, p):
515 "statement
: ENQUEUE
'(' var
',' type pairs
')' statements
"
516 p[0] = ast.EnqueueStatementAST(self, p[3], p[5], p[6], p[8])
518 def p_statement__peek(self, p):
519 "statement
: PEEK
'(' var
',' type pairs
')' statements
"
520 p[0] = ast.PeekStatementAST(self, p[3], p[5], p[6], p[8], "peek
")
522 def p_statement__copy_head(self, p):
523 "statement
: COPY_HEAD
'(' var
',' var pairs
')' SEMI
"
524 p[0] = ast.CopyHeadStatementAST(self, p[3], p[5], p[6])
526 def p_statement__check_allocate(self, p):
527 "statement
: CHECK_ALLOCATE
'(' var
')' SEMI
"
528 p[0] = ast.CheckAllocateStatementAST(self, p[3])
530 def p_statement__check_stop(self, p):
531 "statement
: CHECK_STOP_SLOTS
'(' var
',' STRING
',' STRING
')' SEMI
"
532 p[0] = ast.CheckStopStatementAST(self, p[3], p[5], p[7])
534 def p_statement__return(self, p):
535 "statement
: RETURN expr SEMI
"
536 p[0] = ast.ReturnStatementAST(self, p[2])
538 def p_statement__if(self, p):
539 "statement
: if_statement
"
542 def p_if_statement__if(self, p):
543 "if_statement
: IF
'(' expr
')' statements
"
544 p[0] = ast.IfStatementAST(self, p[3], p[5], None)
546 def p_if_statement__if_else(self, p):
547 "if_statement
: IF
'(' expr
')' statements ELSE statements
"
548 p[0] = ast.IfStatementAST(self, p[3], p[5], p[7])
550 def p_statement__if_else_if(self, p):
551 "if_statement
: IF
'(' expr
')' statements ELSE if_statement
"
552 p[0] = ast.IfStatementAST(self, p[3], p[5],
553 ast.StatementListAST(self, p[7]))
555 def p_expr__var(self, p):
559 def p_expr__literal(self, p):
563 def p_expr__enumeration(self, p):
564 "aexpr
: enumeration
"
567 def p_expr__func_call(self, p):
568 "aexpr
: ident
'(' exprs
')'"
569 p[0] = ast.FuncCallExprAST(self, p[1], p[3])
571 def p_expr__new(self, p):
573 p[0] = ast.NewExprAST(self, p[2])
575 # globally access a local chip component and call a method
576 def p_expr__local_chip_method(self, p):
577 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
578 p[0] = ast.LocalChipMethodAST(self, p[3], p[5], p[8], p[10], p[12])
580 # globally access a local chip component and access a data member
581 def p_expr__local_chip_member(self, p):
582 "aexpr
: THIS DOT var
'[' expr
']' DOT var DOT field
"
583 p[0] = ast.LocalChipMemberAST(self, p[3], p[5], p[8], p[10])
585 # globally access a specified chip component and call a method
586 def p_expr__specified_chip_method(self, p):
587 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT ident
'(' exprs
')'"
588 p[0] = ast.SpecifiedChipMethodAST(self, p[3], p[6], p[8], p[11], p[13],
591 # globally access a specified chip component and access a data member
592 def p_expr__specified_chip_member(self, p):
593 "aexpr
: CHIP
'[' expr
']' DOT var
'[' expr
']' DOT var DOT field
"
594 p[0] = ast.SpecifiedChipMemberAST(self, p[3], p[6], p[8], p[11], p[13])
596 def p_expr__member(self, p):
597 "aexpr
: aexpr DOT ident
"
598 p[0] = ast.MemberExprAST(self, p[1], p[3])
600 def p_expr__member_method_call(self, p):
601 "aexpr
: aexpr DOT ident
'(' exprs
')'"
602 p[0] = ast.MemberMethodCallExprAST(self, p[1], p[3], p[5])
604 def p_expr__member_method_call_lookup(self, p):
605 "aexpr
: aexpr
'[' exprs
']'"
606 p[0] = ast.MemberMethodCallExprAST(self, p[1], "lookup
", p[3])
608 def p_expr__class_method_call(self, p):
609 "aexpr
: type DOUBLE_COLON ident
'(' exprs
')'"
610 p[0] = ast.ClassMethodCallExprAST(self, p[1], p[3], p[5])
612 def p_expr__aexpr(self, p):
616 def p_expr__binary_op(self, p):
617 """expr : expr STAR expr
629 | expr RIGHTSHIFT expr
630 | expr LEFTSHIFT expr"""
631 p[0] = ast.InfixOperatorExprAST(self, p[1], p[2], p[3])
634 def p_expr__unary_op(self, p):
636 | DASH expr %prec UMINUS"""
637 p[0] = PrefixOperatorExpr(p[1], p[2])
639 def p_expr__parens(self, p):
640 "aexpr
: '(' expr
')'"
643 def p_literal__string(self, p):
645 p[0] = ast.LiteralExprAST(self, p[1], "string
")
647 def p_literal__number(self, p):
649 p[0] = ast.LiteralExprAST(self, p[1], "int")
651 def p_literal__float(self, p):
652 "literal
: FLOATNUMBER
"
653 p[0] = ast.LiteralExprAST(self, p[1], "int")
655 def p_literal__bool(self, p):
657 p[0] = ast.LiteralExprAST(self, p[1], "bool")
659 def p_enumeration(self, p):
660 "enumeration
: ident
':' ident
"
661 p[0] = ast.EnumExprAST(self, ast.TypeAST(self, p[1]), p[3])
665 p[0] = ast.VarExprAST(self, p[1])
667 def p_field(self, p):