1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2009 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Generate C code from intermediate code representation
18 package compiling_icode
21 private import analysis
24 # Compiler context from ICode to C
25 class I2CCompilerVisitor
27 var _ids
: HashMap[Object, String] = new HashMap[Object, String]
28 # Associate other things
29 var _ids2
: HashMap[Object, String] = new HashMap[Object, String]
31 # Return the string associated with a register
32 fun register
(e
: IRegister): String
34 if e
.stype
isa MMTypeNone then return "NIT_NULL"
36 if closure
and not e
.is_local
then ids
= _ids2
37 if ids
.has_key
(e
) then
42 # The register is dead
48 var strs
: HashMap[Int, String]
49 if e
.in_tag_slots
then
50 strs
= once
new HashMap[Int, String]
51 if not strs
.has_key
(i
) then strs
[i
] = "REGB{i}"
52 else if closure
and not e
.is_local
then
53 strs
= once
new HashMap[Int, String]
54 if not strs
.has_key
(i
) then strs
[i
] = "closctx->variable[{i}]"
56 strs
= once
new HashMap[Int, String]
57 if not strs
.has_key
(i
) then strs
[i
] = "REG[{i}]"
66 # Return the strings associated with registers
67 fun registers
(a
: Collection[IRegister]): Array[String]
69 var r
= new Array[String].with_capacity
(a
.length
)
76 var _last_number
: Int = 0
77 # Give a new unique number (unique for the visitor)
84 # Return the string associated with a escape label
85 fun lab
(e
: ISeq): String
87 if _ids
.has_key
(e
) then
90 var s
= "label{new_number}"
96 # The rank (number) of each closure
97 readable var _closures
: HashMap[IClosureDecl, Int] = new HashMap[IClosureDecl, Int]
99 # The functionnal type of each closure
100 readable var _clostypes
: HashMap[IClosureDecl, String] = new HashMap[IClosureDecl, String]
102 # label locally accessibles
103 readable writable var _local_labels
: HashSet[ISeq] = new HashSet[ISeq]
105 # Not local escaped labels
106 # The integer value is an index identifying the label
107 readable writable var _escaped_labels
: HashMap[ISeq, Int] = new HashMap[ISeq, Int]
109 # Register a escape to a non local label and return an index identifying the label
110 fun register_escape_label
(e
: ISeq): Int
112 if _escaped_labels
.has_key
(e
) then
113 return _escaped_labels
[e
]
115 var res
= _escaped_labels
.length
+ 1
116 _escaped_labels
[e
] = res
121 # Add a C label mark (if needed)
122 fun add_label
(e
: ISeq)
124 if _ids
.has_key
(e
) then
125 add_instr
("{_ids[e]}: while(0);")
129 # Add a goto to a label (even outside a closure)
130 fun add_goto
(seq
: ISeq)
132 if local_labels
.has
(seq
) then
133 add_instr
("goto {lab(seq)};")
136 var ind
= register_escape_label
(seq
)
137 add_instr
("closctx->has_broke = (val_t*){ind};")
138 add_instr
("goto {lab(return_label.as(not null))};")
142 # Are we in a closure ?
143 readable writable var _closure
: Bool = false
145 # The current compiler visitor
146 readable var _visitor
: CompilerVisitor
148 # The current compiled iroutine
149 readable var _iroutine
: IRoutine
151 # The return label of the current compiling C function
152 readable writable var _return_label
: nullable ISeq = null
154 fun add_decl
(s
: String)
159 fun add_instr
(s
: String)
161 var l
= _next_location
163 visitor
.add_instr
("/* ", l
.file
, ":", l
.line_start
.to_s
, " */")
164 _next_location
= null
179 fun add_assignment
(to
, from
: String)
181 visitor
.add_assignment
(to
, from
)
184 var _last_location
: nullable Location = null
185 var _next_location
: nullable Location = null
187 # Add location information in a comment
188 # Do nothing if the last location added is the same
189 fun add_location
(l
: nullable Location)
191 var last
= _last_location
192 if last
== l
or l
== null then return
194 if last
!= null and last
.file
== l
.file
and last
.line_start
== l
.line_start
then
201 # The C fonction name of the iroutine
202 readable var _basecname
: String
204 init(v
: CompilerVisitor, ir
: IRoutine, cname
: String)
213 # Declare and start a C function that match the routine
214 # Return what must be given to compile_inside_to_c or to compile_to_c
215 # After the method, an openinig { and and indent is added.
216 # So, do not forget to add a sub_context, to unintent and to add a closing }
217 fun compile_signature_to_c
(v
: CompilerVisitor, cname
: String, human_name
: nullable String, before_params
, after_params
: nullable String): Array[String]
219 var cargs
= new Array[String]
220 var cparams
= new Array[String]
221 if before_params
!= null then cparams
.add
(before_params
)
222 for i
in [0..params
.length
[ do
224 cparams
.add
("val_t p{i}")
226 if closure_decls
!= null then
227 for i
in [0..closure_decls
.length
[ do
228 var closcn
= "CLOS_{cname}_{i}"
229 var cs
= closure_decls
[i
].closure
.signature
230 var subparams
= new Array[String] # Parameters of the closure
231 subparams
.add
("struct WBT_ *")
232 for j
in [0..cs
.arity
[ do
233 subparams
.add
("val_t")
236 if cs
.return_type
!= null then rr
= "val_t"
237 v
.add_decl
("typedef {rr} (*{closcn})({subparams.join(", ")});")
239 cparams
.add
("struct WBT_ *wd{i}")
242 if after_params
!= null then cparams
.add
(after_params
)
244 if result
!= null then r
= "val_t"
246 if cparams
.is_empty
then
249 p
= cparams
.join
(", ")
251 if human_name
!= null then v
.add_decl
("#define LOCATE_", cname
, " \"", human_name, "\
"")
252 v
.add_decl
(r
, " ", cname
, "(", p
, ");")
253 v
.add_decl
("typedef ", r
, " (*", cname
, "_t)(", p
, ");")
254 v
.add_instr
(r
, " ", cname
, "(", p
, ")\{")
259 # Compile the body of the routine, return the result value is any
260 fun compile_inside_to_c
(v
: I2CCompilerVisitor, args
: Array[String]): nullable String
264 if location
!= null then
265 ll
= location
.line_start
267 v
.add_decl
("struct trace_t trace = \{NULL, NULL, {ll}, LOCATE_{v.basecname}\};")
268 v
.add_instr
("trace.prev = tracehead; tracehead = &trace;")
269 v
.add_instr
("trace.file = LOCATE_{v.visitor.module.name};")
271 # Add local variables
272 if std_slots_nb
== 0 then
273 v
.add_decl
("val_t *REG = NULL;")
275 v
.add_decl
("val_t REG[{std_slots_nb}];")
277 for i
in [0..tag_slots_nb
[ do
278 v
.add_decl
("val_t REGB{i};")
280 var iclosdecls
= closure_decls
281 if iclosdecls
!= null then
282 v
.add_decl
("struct WBT_ *CREG[{iclosdecls.length}];")
284 v
.add_decl
("struct WBT_ **CREG = NULL;")
288 if r
.slot_index
!= null then v
.add_assignment
(v
.register
(r
), args
[k
])
291 if iclosdecls
!= null then
292 for i
in [0..iclosdecls
.length
[ do
293 var iclosdecl
= iclosdecls
[i
]
294 v
.add_instr
("CREG[{i}] = {args[params.length+i]};")
295 v
.closures
[iclosdecl
] = i
296 var cs
= iclosdecl
.closure
.signature
# Closure signature
297 var subparams
= new Array[String] # Parameters of the closure
298 subparams
.add
("struct WBT_ *")
299 for j
in [0..cs
.arity
[ do
304 if cs
.return_type
!= null then r
= "val_t"
305 v
.clostypes
[iclosdecl
] = "{r} (*)({subparams.join(", ")})"
308 v
.add_decl
("val_t tmp;")
311 var old_rl
= v
.return_label
312 v
.return_label
= body
317 v
.add_instr
("tracehead = trace.prev;")
318 v
.return_label
= old_rl
327 # Full compilation of the routine
328 # Including optimization and other stuff.
329 # cv must be in the correct function
330 fun compile_to_c
(cv
: CompilerVisitor, cname
: String, args
: Array[String]): nullable String
333 var v
= new I2CCompilerVisitor(cv
, self, cname
)
334 return compile_inside_to_c
(v
, args
)
339 # Full compilation of the icode
340 fun compile_to_c
(v
: I2CCompilerVisitor)
342 v
.add_location
(location
)
343 store_result
(v
, inner_compile_to_c
(v
))
346 # Is a result really needed
347 private fun need_result
: Bool
350 return r
!= null and r
.slot_index
!= null
353 # Store s in the result value of self
354 private fun store_result
(v
: I2CCompilerVisitor, s
: nullable String)
357 if r
!= null and r
.slot_index
!= null then
359 v
.add_assignment
(v
.register
(r
), s
)
360 else if s
!= null and not is_pure
then
361 # ICode with side effects must be evaluated
362 # even if the result is not wanted
367 # Compilation of without the result assigment
368 # Return the right value is case of expression
369 # Return the full expression (witout ;) in case of statement
370 private fun inner_compile_to_c
(v
: I2CCompilerVisitor): nullable String is abstract
374 redef fun inner_compile_to_c
(v
)
376 v
.local_labels
.add
(self)
386 redef fun inner_compile_to_c
(v
)
388 v
.add_instr
("if (UNTAG_Bool({v.register(expr)})) \{")
389 if not then_seq
.icodes
.is_empty
then
391 then_seq
.inner_compile_to_c
(v
)
394 if not else_seq
.icodes
.is_empty
then
395 v
.add_instr
("} else \{")
397 else_seq
.inner_compile_to_c
(v
)
406 redef fun inner_compile_to_c
(v
)
408 v
.local_labels
.add
(self)
409 v
.add_instr
("while(1) \{")
422 redef fun inner_compile_to_c
(v
)
430 redef fun compile_to_c
(v
)
432 v
.add_location
(location
)
433 var args
= v
.registers
(exprs
)
435 # Compile closure definitions
436 var old_el
= v
.escaped_labels
437 var closdefs
= closure_defs
438 var closcns
: nullable Array[String] = null
439 if closdefs
!= null then
440 v
.escaped_labels
= new HashMap[ISeq, Int]
441 closcns
= new Array[String]
442 for cd
in closdefs
do
444 var cn
= cd
.compile_closure
(v
)
453 var s
= compile_call_to_c
(v
, args
)
454 var r
: nullable String = s
457 if closcns
!= null then
458 var els
= v
.escaped_labels
459 v
.escaped_labels
= old_el
460 # Is there possible escapes?
461 if not els
.is_empty
then
462 # Call in a tmp variable to avoid 'break' overwrite
465 v
.add_assignment
(r
, s
)
470 # What is the escape index (if any?)
471 # It's computed as the union of has_broke
472 var switcha
= new Array[String]
474 switcha
.add
("((int)({cn}->has_broke))")
476 var switch
= switcha
.join
(" | ")
477 # What are the expected escape indexes
478 v
.add_instr
("switch ({switch}) \{")
480 # No escape occured, continue as usual
481 v
.add_instr
("case 0: break;")
482 var lls
= v
.local_labels
483 var iels
= els
.iterator
484 var forward_escape
= false
488 # Local escape occured
489 v
.add_instr
("case {iels.item}: goto {v.lab(seq)};")
491 # Forward escape occured: register the escape label
493 v
.register_escape_label
(seq
)
494 forward_escape
= true
498 # Forward escape occured, just pass to the next one
499 if forward_escape
then
500 v
.add_instr
("default: closctx->has_broke = (val_t*)({switch}); goto {v.lab(v.return_label.as(not null))};")
510 redef fun inner_compile_to_c
(v
) do abort
512 # The single invocation witout fancy stuffs
513 private fun compile_call_to_c
(v
: I2CCompilerVisitor, args
: Array[String]): String is abstract
517 redef fun compile_call_to_c
(v
, args
)
520 if prop
.global
.is_init
then args
.add
("init_table")
521 if prop
.name
== (once
("add".to_symbol
)) and prop
.local_class
.name
== (once
("Array".to_symbol
)) then
522 return "{prop.cname}({args.join(", ")})"
524 return "{prop.global.meth_call}({args[0]})({args.join(", ")})"
530 redef fun compile_call_to_c
(v
, args
)
533 if prop
.global
.is_init
then args
.add
("init_table")
534 return "{prop.super_meth_call}({args[0]})({args.join(", ")})"
539 redef fun compile_call_to_c
(v
, args
)
541 return "NEW_{stype.local_class}_{property.global.intro.cname}({args.join(", ")})"
546 redef fun inner_compile_to_c
(v
)
548 if exprs
.is_empty
then
553 var c
= code
.split_with
("@@@")
556 if i
< exprs
.length
and i
< c
.length-1
then
557 res
.append
(v
.register
(exprs
[i
]))
567 redef fun inner_compile_to_c
(v
)
569 var s
= new Buffer.from
("fprintf(stderr")
571 s
.append
(", \"{t}\
"")
577 var pl
= property_location
578 s
= new Buffer.from
("fprintf(stderr, \"")
579 if pl != null then s.append(" in %s
")
585 if pl
!= null then s
.append
("LOCATE_{pl.cname}, ")
586 s
.append
("LOCATE_{module_location.name}")
588 s
.append
(", {ll.line_start}")
593 v
.add_instr
("nit_exit(1);")
599 redef fun inner_compile_to_c
(v
)
601 return v
.register
(expr
)
605 redef class IAttrRead
606 redef fun inner_compile_to_c
(v
)
608 return "{property.global.attr_access}({v.register(expr)})"
612 redef class IAttrIsset
613 redef fun inner_compile_to_c
(v
)
615 return "TAG_Bool({property.global.attr_access}({v.register(expr)})!=NIT_NULL)"
619 redef class IAttrWrite
620 redef fun inner_compile_to_c
(v
)
622 v
.add_instr
("{property.global.attr_access}({v.register(expr1)}) = {v.register(expr2)};")
627 redef class ITypeCheck
628 redef fun inner_compile_to_c
(v
)
630 # FIXME handle formaltypes
631 var g
= stype
.local_class
.global
632 var recv
= v
.register
(expr
)
634 if expr
.stype
.is_nullable
then
635 if stype
.is_nullable
then
636 s
= "({recv}==NIT_NULL) || "
637 else if stype
.as_nullable
== expr
.stype
then
638 return "TAG_Bool({recv}!=NIT_NULL)"
640 s
= "({recv}!=NIT_NULL) && "
643 return "TAG_Bool({s}VAL_ISA({recv}, {g.color_id}, {g.id_id})) /*cast {stype}*/"
648 redef fun inner_compile_to_c
(v
)
652 if t1
isa MMTypeNone then
653 if t2
isa MMTypeNone then
655 else if t2
.is_nullable
then
656 return "TAG_Bool({v.register(expr2)}==NIT_NULL)"
660 else if t1
.is_nullable
then
661 if t2
isa MMTypeNone then
662 return "TAG_Bool({v.register(expr1)}==NIT_NULL)"
663 else if t2
.is_nullable
then
664 return "TAG_Bool(IS_EQUAL_NN({v.register(expr1)},{v.register(expr2)}))"
666 return "TAG_Bool(IS_EQUAL_ON({v.register(expr2)},{v.register(expr1)}))"
669 if t2
isa MMTypeNone then
671 else if t2
.is_nullable
then
672 return "TAG_Bool(IS_EQUAL_ON({v.register(expr1)},{v.register(expr2)}))"
674 return "TAG_Bool(IS_EQUAL_OO({v.register(expr1)},{v.register(expr2)}))"
681 redef fun inner_compile_to_c
(v
)
683 return "TAG_Bool(!UNTAG_Bool({v.register(expr)}))"
688 redef fun inner_compile_to_c
(v
)
691 var res
= result
.as(not null)
692 if res
.stype
.is_nullable
then
693 v
.add_decl
("static val_t once_value_{i}; static int once_bool_{i}; /* Once value */")
694 v
.add_instr
("if (!once_bool_{i}) \{")
696 # Since the value is not nullable, we use the null value to represent the boolean
697 v
.add_decl
("static val_t once_value_{i}; /* Once value */")
698 v
.add_instr
("if (!once_value_{i}) \{")
702 var e
= v
.register
(result
.as(not null))
703 v
.add_instr
("once_value_{i} = {e};")
704 if res
.stype
.is_nullable
then v
.add_instr
("once_bool_{i} = true;")
706 v
.add_instr
("} else {e} = once_value_{i};")
711 redef class IClosCall
712 redef fun compile_to_c
(v
: I2CCompilerVisitor)
714 v
.add_location
(location
)
717 ivar
= "closctx->closurevariable[{v.closures[closure_decl]}]"
719 ivar
= "CREG[{v.closures[closure_decl]}]"
722 args
.append
(v
.registers
(exprs
))
724 var s
= "(({v.clostypes[closure_decl]})({ivar}->fun))({args.join(", ")})"
727 v
.add_instr
("if ({ivar}->has_broke) \{")
733 v
.add_goto
(v
.iroutine
.body
)
738 redef fun inner_compile_to_c
(v
) do abort
742 redef fun inner_compile_to_c
(v
)
746 ivar
= "closctx->closurevariable[{v.closures[closure_decl]}]"
748 ivar
= "CREG[{v.closures[closure_decl]}]"
750 return "TAG_Bool({ivar} != NULL)"
755 redef class IClosureDef
756 fun compile_closure
(v
: I2CCompilerVisitor): String
758 var cfc_old
= v
.closure
760 var lls_old
= v
.local_labels
761 v
.local_labels
= new HashSet[ISeq]
765 cv
.ctx
= new CContext
766 cv
.out_contexts
.add
(cv
.ctx
)
768 var cname
= "OC_{v.basecname}_{v.new_number}"
769 var args
= compile_signature_to_c
(v
.visitor
, cname
, null, "struct WBT_ *closctx", null)
770 var ctx_old2
= cv
.ctx
771 cv
.ctx
= new CContext
773 var s
= compile_inside_to_c
(v
, args
)
775 v
.add_instr
("return;")
777 v
.add_instr
("return {s};")
780 ctx_old2
.append
(cv
.ctx
)
789 var closcnv
= "wbclos{v.new_number}"
790 v
.add_decl
("struct WBT_ {closcnv};")
791 v
.add_instr
("{closcnv}.fun = (fun_t){cname};")
792 v
.add_instr
("{closcnv}.has_broke = NULL;")
794 v
.add_instr
("{closcnv}.variable = closctx->variable;")
795 v
.add_instr
("{closcnv}.closurevariable = closctx->closurevariable;")
797 v
.add_instr
("{closcnv}.variable = REG;")
798 v
.add_instr
("{closcnv}.closurevariable = CREG;")
801 v
.local_labels
= lls_old
802 return "(&{closcnv})"