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 'copy_head' : 'COPY_HEAD',
116 'check_allocate' : 'CHECK_ALLOCATE',
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',
135 'DOUBLE_COLON', 'SEMI',
137 'IDENT', 'LIT_BOOL', 'FLOATNUMBER', 'NUMBER', 'STRING' ]
138 tokens
+= reserved
.values()
155 t_DOUBLE_COLON
= r
'::'
161 ('left', 'AND', 'OR'),
162 ('left', 'EQ', 'NE'),
163 ('left', 'LT', 'GT', 'LE', 'GE'),
164 ('left', 'RIGHTSHIFT', 'LEFTSHIFT'),
165 ('left', 'PLUS', 'DASH'),
166 ('left', 'STAR', 'SLASH'),
167 ('right', 'NOT', 'UMINUS'),
170 def t_IDENT(self
, t
):
171 r
'[a-zA-Z_][a-zA-Z_0-9]*'
172 if t
.value
== 'true':
177 if t
.value
== 'false':
182 # Check for reserved words
183 t
.type = self
.reserved
.get(t
.value
, 'IDENT')
186 def t_FLOATNUMBER(self
, t
):
189 t
.value
= float(t
.value
)
191 raise ParseError("Illegal float", t
)
194 def t_NUMBER(self
, t
):
197 t
.value
= int(t
.value
)
199 raise ParseError("Illegal number", t
)
202 def t_STRING1(self
, t
):
205 t
.value
= t
.value
[1:-1]
208 def t_STRING2(self
, t
):
211 t
.value
= t
.value
[1:-1]
218 def p_empty(self
, p
):
221 def p_decls(self
, p
):
223 p
[0] = ast
.DeclListAST(self
, p
[1])
225 def p_declsx__list(self
, p
):
226 "declsx : decl declsx"
227 if isinstance(p
[1], ast
.DeclListAST
):
235 def p_declsx__none(self
, p
):
239 def p_decl__protocol(self
, p
):
240 "decl : PROTOCOL STRING SEMI"
242 msg
= "Protocol can only be set once! Error at %s:%s\n" % \
243 (self
.current_source
, self
.current_line
)
244 raise ParseError(msg
)
248 def p_decl__include(self
, p
):
249 "decl : INCLUDE STRING SEMI"
250 dirname
= os
.path
.dirname(self
.current_source
)
251 if os
.path
.exists(os
.path
.join(dirname
, p
[2])):
252 filename
= os
.path
.join(dirname
, p
[2])
254 filename
= os
.path
.join(self
.base_dir
, p
[2])
255 p
[0] = self
.parse_file(filename
)
257 def p_decl__machine(self
, p
):
258 "decl : MACHINE '(' ident pairs ')' ':' params '{' decls '}'"
259 p
[0] = ast
.MachineAST(self
, p
[3], p
[4], p
[7], p
[9])
261 def p_decl__action(self
, p
):
262 "decl : ACTION '(' ident pairs ')' statements"
263 p
[0] = ast
.ActionDeclAST(self
, p
[3], p
[4], p
[6])
265 def p_decl__in_port(self
, p
):
266 "decl : IN_PORT '(' ident ',' type ',' var pairs ')' statements"
267 p
[0] = ast
.InPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8], p
[10])
269 def p_decl__out_port(self
, p
):
270 "decl : OUT_PORT '(' ident ',' type ',' var pairs ')' SEMI"
271 p
[0] = ast
.OutPortDeclAST(self
, p
[3], p
[5], p
[7], p
[8])
273 def p_decl__trans0(self
, p
):
274 "decl : TRANS '(' idents ',' idents ',' ident pairs ')' idents"
275 p
[0] = ast
.TransitionDeclAST(self
, [], p
[3], p
[5], p
[7], p
[8], p
[10])
277 def p_decl__trans1(self
, p
):
278 "decl : TRANS '(' idents ',' idents pairs ')' idents"
279 p
[0] = ast
.TransitionDeclAST(self
, [], p
[3], p
[5], None, p
[6], p
[8])
281 def p_decl__trans2(self
, p
):
282 "decl : TRANS '(' idents ',' idents ',' ident pairs ')' idents idents"
283 p
[0] = ast
.TransitionDeclAST(self
, p
[10], p
[3], p
[5], p
[7], p
[8], p
[11])
285 def p_decl__trans3(self
, p
):
286 "decl : TRANS '(' idents ',' idents pairs ')' idents idents"
287 p
[0] = ast
.TransitionDeclAST(self
, p
[8], p
[3], p
[5], None, p
[6], p
[9])
289 def p_decl__extern0(self
, p
):
290 "decl : EXTERN_TYPE '(' type pairs ')' SEMI"
291 p
[4]["external"] = "yes"
292 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], [])
294 def p_decl__global(self
, p
):
295 "decl : GLOBAL '(' type pairs ')' '{' type_members '}'"
296 p
[4]["global"] = "yes"
297 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
299 def p_decl__struct(self
, p
):
300 "decl : STRUCT '(' type pairs ')' '{' type_members '}'"
301 p
[0] = ast
.TypeDeclAST(self
, p
[3], p
[4], p
[7])
303 def p_decl__enum(self
, p
):
304 "decl : ENUM '(' type pairs ')' '{' type_enums '}'"
305 p
[4]["enumeration"] = "yes"
306 p
[0] = ast
.EnumDeclAST(self
, p
[3], p
[4], p
[7])
308 def p_decl__state_decl(self
, p
):
309 "decl : STATE_DECL '(' type pairs ')' '{' type_states '}'"
310 p
[4]["enumeration"] = "yes"
311 p
[4]["state_decl"] = "yes"
312 p
[0] = ast
.StateDeclAST(self
, p
[3], p
[4], p
[7])
314 def p_decl__object(self
, p
):
315 "decl : type ident pairs SEMI"
316 p
[0] = ast
.ObjDeclAST(self
, p
[1], p
[2], p
[3])
318 # Function definition and declaration
319 def p_decl__func_decl(self
, p
):
323 def p_func_decl__0(self
, p
):
324 """func_decl : void ident '(' params ')' pairs SEMI
325 | type ident '(' params ')' pairs SEMI"""
326 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], None)
328 def p_decl__func_def(self
, p
):
332 def p_func_def__0(self
, p
):
333 """func_def : void ident '(' params ')' pairs statements
334 | type ident '(' params ')' pairs statements"""
335 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], p
[7])
338 def p_type_members__list(self
, p
):
339 "type_members : type_member type_members"
340 p
[0] = [ p
[1] ] + p
[2]
342 def p_type_members__empty(self
, p
):
343 "type_members : empty"
346 def p_type_method__0(self
, p
):
347 "type_member : type_or_void ident '(' types ')' pairs SEMI"
348 p
[0] = ast
.TypeFieldMethodAST(self
, p
[1], p
[2], p
[4], p
[6])
350 def p_type_method__1(self
, p
):
351 "type_member : type_or_void ident '(' params ')' pairs statements"
352 p
[0] = ast
.FuncDeclAST(self
, p
[1], p
[2], p
[4], p
[6], p
[7])
354 def p_type_member__1(self
, p
):
355 "type_member : type_or_void 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_or_void ident ASSIGN expr SEMI"
360 p
[0] = ast
.TypeFieldMemberAST(self
, p
[1], p
[2],
361 ast
.PairListAST(self
), p
[4])
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_type_states__list(self
, p
):
378 "type_states : type_state type_states"
379 p
[0] = [ p
[1] ] + p
[2]
381 def p_type_states__empty(self
, p
):
382 "type_states : empty"
385 def p_type_state(self
, p
):
386 "type_state : ident ',' enumeration pairs SEMI"
387 p
[0] = ast
.TypeFieldStateAST(self
, p
[1], p
[3], p
[4])
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__peek(self, p):
561 "statement
: PEEK
'(' var
',' type pairs
')' statements
"
562 p[0] = ast.PeekStatementAST(self, p[3], p[5], p[6], p[8], "peek
")
564 def p_statement__copy_head(self, p):
565 "statement
: COPY_HEAD
'(' var
',' var pairs
')' SEMI
"
566 p[0] = ast.CopyHeadStatementAST(self, p[3], p[5], p[6])
568 def p_statement__check_allocate(self, p):
569 "statement
: CHECK_ALLOCATE
'(' var
')' SEMI
"
570 p[0] = ast.CheckAllocateStatementAST(self, p[3])
572 def p_statement__check_stop(self, p):
573 "statement
: CHECK_STOP_SLOTS
'(' var
',' STRING
',' STRING
')' SEMI
"
574 p[0] = ast.CheckStopStatementAST(self, p[3], p[5], p[7])
576 def p_statement__static_cast(self, p):
577 "aexpr
: STATIC_CAST
'(' type ',' expr
')'"
578 p[0] = ast.StaticCastAST(self, p[3], "ref
", p[5])
580 def p_statement__static_cast_ptr(self, p):
581 "aexpr
: STATIC_CAST
'(' type ',' STRING
',' expr
')'"
582 p[0] = ast.StaticCastAST(self, p[3], p[5], p[7])
584 def p_statement__return(self, p):
585 "statement
: RETURN expr SEMI
"
586 p[0] = ast.ReturnStatementAST(self, p[2])
588 def p_statement__if(self, p):
589 "statement
: if_statement
"
592 def p_if_statement__if(self, p):
593 "if_statement
: IF
'(' expr
')' statements
"
594 p[0] = ast.IfStatementAST(self, p[3], p[5], None)
596 def p_if_statement__if_else(self, p):
597 "if_statement
: IF
'(' expr
')' statements ELSE statements
"
598 p[0] = ast.IfStatementAST(self, p[3], p[5], p[7])
600 def p_statement__if_else_if(self, p):
601 "if_statement
: IF
'(' expr
')' statements ELSE if_statement
"
602 p[0] = ast.IfStatementAST(self, p[3], p[5],
603 ast.StatementListAST(self, p[7]))
605 def p_expr__var(self, p):
609 def p_expr__localvar(self, p):
611 p[0] = ast.LocalVariableAST(self, p[1], p[2])
613 def p_expr__literal(self, p):
617 def p_expr__enumeration(self, p):
618 "aexpr
: enumeration
"
621 def p_expr__func_call(self, p):
622 "aexpr
: ident
'(' exprs
')'"
623 p[0] = ast.FuncCallExprAST(self, p[1], p[3])
625 def p_expr__new(self, p):
627 p[0] = ast.NewExprAST(self, p[2])
629 def p_expr__null(self, p):
631 p[0] = ast.OodAST(self)
633 def p_expr__member(self, p):
634 "aexpr
: aexpr DOT ident
"
635 p[0] = ast.MemberExprAST(self, p[1], p[3])
637 def p_expr__member_method_call(self, p):
638 "aexpr
: aexpr DOT ident
'(' exprs
')'"
639 p[0] = ast.MemberMethodCallExprAST(self, p[1], p[3], p[5])
641 def p_expr__member_method_call_lookup(self, p):
642 "aexpr
: aexpr
'[' exprs
']'"
643 p[0] = ast.MemberMethodCallExprAST(self, p[1], "lookup
", p[3])
645 def p_expr__class_method_call(self, p):
646 "aexpr
: type DOUBLE_COLON ident
'(' exprs
')'"
647 p[0] = ast.ClassMethodCallExprAST(self, p[1], p[3], p[5])
649 def p_expr__aexpr(self, p):
653 def p_expr__binary_op(self, p):
654 """expr : expr STAR expr
666 | expr RIGHTSHIFT expr
667 | expr LEFTSHIFT expr"""
668 p[0] = ast.InfixOperatorExprAST(self, p[1], p[2], p[3])
671 def p_expr__unary_op(self, p):
673 | DASH expr %prec UMINUS"""
674 p[0] = PrefixOperatorExpr(p[1], p[2])
676 def p_expr__parens(self, p):
677 "aexpr
: '(' expr
')'"
680 def p_expr__is_valid_ptr(self, p):
681 "aexpr
: IS_VALID
'(' var
')'"
682 p[0] = ast.IsValidPtrExprAST(self, p[3], True)
684 def p_expr__is_invalid_ptr(self, p):
685 "aexpr
: IS_INVALID
'(' var
')'"
686 p[0] = ast.IsValidPtrExprAST(self, p[3], False)
688 def p_literal__string(self, p):
690 p[0] = ast.LiteralExprAST(self, p[1], "std
::string
")
692 def p_literal__number(self, p):
694 p[0] = ast.LiteralExprAST(self, p[1], "int")
696 def p_literal__float(self, p):
697 "literal
: FLOATNUMBER
"
698 p[0] = ast.LiteralExprAST(self, p[1], "int")
700 def p_literal__bool(self, p):
702 p[0] = ast.LiteralExprAST(self, p[1], "bool")
704 def p_enumeration(self, p):
705 "enumeration
: ident
':' ident
"
706 p[0] = ast.EnumExprAST(self, ast.TypeAST(self, p[1]), p[3])
710 p[0] = ast.VarExprAST(self, p[1])