nitlanguage / nit.git / blob
? search:


97514accd06b61c659b8ca7c7eac1168059d3609
[nit.git] / src / compiling / compiling_icode.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2009 Jean Privat <jean@pryen.org>
4 #
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
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
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.
16
17 # Generate C code from intermediate code representation
18 package compiling_icode
19
20 import icode
21 private import analysis
22 import compiling_base
23
24 # Compiler context from ICode to C
25 class I2CCompilerVisitor
26 # Associate things
27 var _ids: HashMap[Object, String] = new HashMap[Object, String]
28 # Associate other things
29 var _ids2: HashMap[Object, String] = new HashMap[Object, String]
30
31 # Return the string associated with a register
32 fun register(e: IRegister): String
33 do
34 if e.stype isa MMTypeNone then return "NIT_NULL"
35 var ids = _ids
36 if closure and not e.is_local then ids = _ids2
37 if ids.has_key(e) then
38 return ids[e]
39 else
40 var i = e.slot_index
41 if i == null then
42 # The register is dead
43 var s = "NIT_NULL"
44 ids[e] = s
45 return s
46 else
47 var s: String
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}]"
55 else
56 strs = once new HashMap[Int, String]
57 if not strs.has_key(i) then strs[i] = "REG[{i}]"
58 end
59 s = strs[i]
60 ids[e] = s
61 return s
62 end
63 end
64 end
65
66 # Return the strings associated with registers
67 fun registers(a: Collection[IRegister]): Array[String]
68 do
69 var r = new Array[String].with_capacity(a.length)
70 for e in a do
71 r.add(register(e))
72 end
73 return r
74 end
75
76 var _last_number: Int = 0
77 # Give a new unique number (unique for the visitor)
78 fun new_number: Int
79 do
80 _last_number += 1
81 return _last_number
82 end
83
84 # Return the string associated with a escape label
85 fun lab(e: ISeq): String
86 do
87 if _ids.has_key(e) then
88 return _ids[e]
89 else
90 var s = "label{new_number}"
91 _ids[e] = s
92 return s
93 end
94 end
95
96 # The rank (number) of each closure
97 readable var _closures: HashMap[IClosureDecl, Int] = new HashMap[IClosureDecl, Int]
98
99 # The functionnal type of each closure
100 readable var _clostypes: HashMap[IClosureDecl, String] = new HashMap[IClosureDecl, String]
101
102 # label locally accessibles
103 readable writable var _local_labels: HashSet[ISeq] = new HashSet[ISeq]
104
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]
108
109 # Register a escape to a non local label and return an index identifying the label
110 fun register_escape_label(e: ISeq): Int
111 do
112 if _escaped_labels.has_key(e) then
113 return _escaped_labels[e]
114 else
115 var res = _escaped_labels.length + 1
116 _escaped_labels[e] = res
117 return res
118 end
119 end
120
121 # Add a C label mark (if needed)
122 fun add_label(e: ISeq)
123 do
124 if _ids.has_key(e) then
125 add_instr("{_ids[e]}: while(0);")
126 end
127 end
128
129 # Add a goto to a label (even outside a closure)
130 fun add_goto(seq: ISeq)
131 do
132 if local_labels.has(seq) then
133 add_instr("goto {lab(seq)};")
134 else
135 assert closure
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))};")
139 end
140 end
141
142 # Are we in a closure ?
143 readable writable var _closure: Bool = false
144
145 # The current compiler visitor
146 readable var _visitor: CompilerVisitor
147
148 # The current compiled iroutine
149 readable var _iroutine: IRoutine
150
151 # The return label of the current compiling C function
152 readable writable var _return_label: nullable ISeq = null
153
154 fun add_decl(s: String)
155 do
156 visitor.add_decl(s)
157 end
158
159 fun add_instr(s: String)
160 do
161 var l = _next_location
162 if l != null then
163 visitor.add_instr("/* ", l.file, ":", l.line_start.to_s, " */")
164 _next_location = null
165 end
166 visitor.add_instr(s)
167 end
168
169 fun indent
170 do
171 visitor.indent
172 end
173
174 fun unindent
175 do
176 visitor.unindent
177 end
178
179 fun add_assignment(to, from: String)
180 do
181 visitor.add_assignment(to, from)
182 end
183
184 var _last_location: nullable Location = null
185 var _next_location: nullable Location = null
186
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)
190 do
191 var last = _last_location
192 if last == l or l == null then return
193 _last_location = l
194 if last != null and last.file == l.file and last.line_start == l.line_start then
195 return
196 else
197 _next_location = l
198 end
199 end
200
201 # The C fonction name of the iroutine
202 readable var _basecname: String
203
204 init(v: CompilerVisitor, ir: IRoutine, cname: String)
205 do
206 _visitor = v
207 _iroutine = ir
208 _basecname = cname
209 end
210 end
211
212 redef class IRoutine
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]
218 do
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
223 cargs.add("p{i}")
224 cparams.add("val_t p{i}")
225 end
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")
234 end
235 var rr = "void"
236 if cs.return_type != null then rr = "val_t"
237 v.add_decl("typedef {rr} (*{closcn})({subparams.join(", ")});")
238 cargs.add("wd{i}")
239 cparams.add("struct WBT_ *wd{i}")
240 end
241 end
242 if after_params != null then cparams.add(after_params)
243 var r = "void"
244 if result != null then r = "val_t"
245 var p: String
246 if cparams.is_empty then
247 p = "void"
248 else
249 p = cparams.join(", ")
250 end
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, ")\{")
255 v.indent
256 return cargs
257 end
258
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
261 do
262 # Add the trace
263 var ll = 0
264 if location != null then
265 ll = location.line_start
266 end
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};")
270
271 # Add local variables
272 if std_slots_nb == 0 then
273 v.add_decl("val_t *REG = NULL;")
274 else
275 v.add_decl("val_t REG[{std_slots_nb}];")
276 end
277 for i in [0..tag_slots_nb[ do
278 v.add_decl("val_t REGB{i};")
279 end
280 var iclosdecls = closure_decls
281 if iclosdecls != null then
282 v.add_decl("struct WBT_ *CREG[{iclosdecls.length}];")
283 else
284 v.add_decl("struct WBT_ **CREG = NULL;")
285 end
286 var i = 0
287 for r in params do
288 if r.slot_index != null then v.add_assignment(v.register(r), args[i])
289 i += 1
290 end
291 var iclosdecls = closure_decls
292 if iclosdecls != null then
293 for i in [0..iclosdecls.length[ do
294 var iclosdecl = iclosdecls[i]
295 v.add_instr("CREG[{i}] = {args[params.length+i]};")
296 v.closures[iclosdecl] = i
297 var cs = iclosdecl.closure.signature # Closure signature
298 var subparams = new Array[String] # Parameters of the closure
299 subparams.add("struct WBT_ *")
300 for j in [0..cs.arity[ do
301 var p = "val_t"
302 subparams.add(p)
303 end
304 var r = "void"
305 if cs.return_type != null then r = "val_t"
306 v.clostypes[iclosdecl] = "{r} (*)({subparams.join(", ")})"
307 end
308 end
309 v.add_decl("val_t tmp;")
310
311 # Prepare return
312 var old_rl = v.return_label
313 v.return_label = body
314
315 # Compile body
316 body.compile_to_c(v)
317
318 v.add_instr("tracehead = trace.prev;")
319 v.return_label = old_rl
320 var r = result
321 if r != null then
322 return v.register(r)
323 else
324 return null
325 end
326 end
327
328 # Full compilation of the routine
329 # Including optimization and other stuff.
330 # cv must be in the correct function
331 fun compile_to_c(cv: CompilerVisitor, cname: String, args: Array[String]): nullable String
332 do
333 optimize
334 var v = new I2CCompilerVisitor(cv, self, cname)
335 return compile_inside_to_c(v, args)
336 end
337 end
338
339 redef class ICode
340 # Full compilation of the icode
341 fun compile_to_c(v: I2CCompilerVisitor)
342 do
343 v.add_location(location)
344 store_result(v, inner_compile_to_c(v))
345 end
346
347 # Is a result really needed
348 private fun need_result: Bool
349 do
350 var r = result
351 return r != null and r.slot_index != null
352 end
353
354 # Store s in the result value of self
355 private fun store_result(v: I2CCompilerVisitor, s: nullable String)
356 do
357 var r = result
358 if r != null and r.slot_index != null then
359 assert s != null
360 v.add_assignment(v.register(r), s)
361 else if s != null and not is_pure then
362 # ICode with side effects must be evaluated
363 # even if the result is not wanted
364 v.add_instr(s + ";")
365 end
366 end
367
368 # Compilation of without the result assigment
369 # Return the right value is case of expression
370 # Return the full expression (witout ;) in case of statement
371 private fun inner_compile_to_c(v: I2CCompilerVisitor): nullable String is abstract
372 end
373
374 redef class ISeq
375 redef fun inner_compile_to_c(v)
376 do
377 v.local_labels.add(self)
378 for ic in icodes do
379 ic.compile_to_c(v)
380 end
381 v.add_label(self)
382 return null
383 end
384 end
385
386 redef class IIf
387 redef fun inner_compile_to_c(v)
388 do
389 v.add_instr("if (UNTAG_Bool({v.register(expr)})) \{")
390 if not then_seq.icodes.is_empty then
391 v.indent
392 then_seq.inner_compile_to_c(v)
393 v.unindent
394 end
395 if not else_seq.icodes.is_empty then
396 v.add_instr("} else \{")
397 v.indent
398 else_seq.inner_compile_to_c(v)
399 v.unindent
400 end
401 v.add_instr("}")
402 return null
403 end
404 end
405
406 redef class ILoop
407 redef fun inner_compile_to_c(v)
408 do
409 v.local_labels.add(self)
410 v.add_instr("while(1) \{")
411 v.indent
412 for ic in icodes do
413 ic.compile_to_c(v)
414 end
415 v.unindent
416 v.add_instr("}")
417 v.add_label(self)
418 return null
419 end
420 end
421
422 redef class IEscape
423 redef fun inner_compile_to_c(v)
424 do
425 v.add_goto(seq)
426 return null
427 end
428 end
429
430 redef class IAbsCall
431 redef fun compile_to_c(v)
432 do
433 v.add_location(location)
434 var args = v.registers(exprs)
435
436 # Compile closure definitions
437 var old_el = v.escaped_labels
438 var closdefs = closure_defs
439 var closcns: nullable Array[String] = null
440 if closdefs != null then
441 v.escaped_labels = new HashMap[ISeq, Int]
442 closcns = new Array[String]
443 for cd in closdefs do
444 if cd != null then
445 var cn = cd.compile_closure(v)
446 args.add(cn)
447 closcns.add(cn)
448 else
449 args.add("NULL")
450 end
451 end
452 end
453
454 var s = compile_call_to_c(v, args)
455 var r: nullable String = s
456
457 # Intercept escapes
458 if closcns != null then
459 var els = v.escaped_labels
460 v.escaped_labels = old_el
461 # Is there possible escapes?
462 if not els.is_empty then
463 # Call in a tmp variable to avoid 'break' overwrite
464 if need_result then
465 r = "tmp"
466 v.add_assignment(r, s)
467 else
468 r = null
469 v.add_instr(s + ";")
470 end
471 # What is the escape index (if any?)
472 # It's computed as the union of has_broke
473 var switcha = new Array[String]
474 for cn in closcns do
475 switcha.add("((int)({cn}->has_broke))")
476 end
477 var switch = switcha.join(" | ")
478 # What are the expected escape indexes
479 v.add_instr("switch ({switch}) \{")
480 v.indent
481 # No escape occured, continue as usual
482 v.add_instr("case 0: break;")
483 var lls = v.local_labels
484 var iels = els.iterator
485 var forward_escape = false
486 while iels.is_ok do
487 var seq = iels.key
488 if lls.has(seq) then
489 # Local escape occured
490 v.add_instr("case {iels.item}: goto {v.lab(seq)};")
491 else
492 # Forward escape occured: register the escape label
493 assert v.closure
494 v.register_escape_label(seq)
495 forward_escape = true
496 end
497 iels.next
498 end
499 # Forward escape occured, just pass to the next one
500 if forward_escape then
501 v.add_instr("default: closctx->has_broke = (val_t*)({switch}); goto {v.lab(v.return_label.as(not null))};")
502 end
503 v.unindent
504 v.add_instr("\}")
505 end
506 end
507
508 store_result(v, r)
509 end
510
511 redef fun inner_compile_to_c(v) do abort
512
513 # The single invocation witout fancy stuffs
514 private fun compile_call_to_c(v: I2CCompilerVisitor, args: Array[String]): String is abstract
515 end
516
517 redef class ICall
518 redef fun compile_call_to_c(v, args)
519 do
520 var prop = property
521 if prop.global.is_init then args.add("init_table")
522 if prop.name == (once ("add".to_symbol)) and prop.local_class.name == (once ("Array".to_symbol)) then
523 return "{prop.cname}({args.join(", ")})"
524 else
525 return "{prop.global.meth_call}({args[0]})({args.join(", ")})"
526 end
527 end
528 end
529
530 redef class ISuper
531 redef fun compile_call_to_c(v, args)
532 do
533 var prop = property
534 if prop.global.is_init then args.add("init_table")
535 return "{prop.super_meth_call}({args[0]})({args.join(", ")})"
536 end
537 end
538
539 redef class INew
540 redef fun compile_call_to_c(v, args)
541 do
542 return "NEW_{stype.local_class}_{property.global.intro.cname}({args.join(", ")})"
543 end
544 end
545
546 redef class INative
547 redef fun inner_compile_to_c(v)
548 do
549 if exprs.is_empty then
550 return code
551 else
552 var res = new Buffer
553 var i = 0
554 var c = code.split_with("@@@")
555 for s in c do
556 res.append(s)
557 if i < exprs.length and i < c.length-1 then
558 res.append(v.register(exprs[i]))
559 end
560 i += 1
561 end
562 return res.to_s
563 end
564 end
565 end
566
567 redef class IAbort
568 redef fun inner_compile_to_c(v)
569 do
570 var s = new Buffer.from("fprintf(stderr")
571 for t in texts do
572 s.append(", \"{t}\"")
573 end
574 s.append(");")
575 v.add_instr(s.to_s)
576
577 var ll = location
578 var pl = property_location
579 s = new Buffer.from("fprintf(stderr, \"")
580 if pl != null then s.append(" in %s")
581 s.append(" (%s")
582 if ll != null then
583 s.append(":%d")
584 end
585 s.append(")\\n\", ")
586 if pl != null then s.append("LOCATE_{pl.cname}, ")
587 s.append("LOCATE_{module_location.name}")
588 if ll != null then
589 s.append(", {ll.line_start}")
590 end
591 s.append(");")
592 v.add_instr(s.to_s)
593
594 v.add_instr("nit_exit(1);")
595 return null
596 end
597 end
598
599 redef class IMove
600 redef fun inner_compile_to_c(v)
601 do
602 return v.register(expr)
603 end
604 end
605
606 redef class IAttrRead
607 redef fun inner_compile_to_c(v)
608 do
609 return "{property.global.attr_access}({v.register(expr)})"
610 end
611 end
612
613 redef class IAttrIsset
614 redef fun inner_compile_to_c(v)
615 do
616 return "TAG_Bool({property.global.attr_access}({v.register(expr)})!=NIT_NULL)"
617 end
618 end
619
620 redef class IAttrWrite
621 redef fun inner_compile_to_c(v)
622 do
623 v.add_instr("{property.global.attr_access}({v.register(expr1)}) = {v.register(expr2)};")
624 return null
625 end
626 end
627
628 redef class ITypeCheck
629 redef fun inner_compile_to_c(v)
630 do
631 # FIXME handle formaltypes
632 var g = stype.local_class.global
633 var recv = v.register(expr)
634 var s = ""
635 if expr.stype.is_nullable then
636 if stype.is_nullable then
637 s = "({recv}==NIT_NULL) || "
638 else if stype.as_nullable == expr.stype then
639 return "TAG_Bool({recv}!=NIT_NULL)"
640 else
641 s = "({recv}!=NIT_NULL) && "
642 end
643 end
644 return "TAG_Bool({s}VAL_ISA({recv}, {g.color_id}, {g.id_id})) /*cast {stype}*/"
645 end
646 end
647
648 redef class IIs
649 redef fun inner_compile_to_c(v)
650 do
651 var t1 = expr1.stype
652 var t2 = expr2.stype
653 if t1 isa MMTypeNone then
654 if t2 isa MMTypeNone then
655 return "TAG_Bool(1)"
656 else if t2.is_nullable then
657 return "TAG_Bool({v.register(expr2)}==NIT_NULL)"
658 else
659 return "TAG_Bool(0)"
660 end
661 else if t1.is_nullable then
662 if t2 isa MMTypeNone then
663 return "TAG_Bool({v.register(expr1)}==NIT_NULL)"
664 else if t2.is_nullable then
665 return "TAG_Bool(IS_EQUAL_NN({v.register(expr1)},{v.register(expr2)}))"
666 else
667 return "TAG_Bool(IS_EQUAL_ON({v.register(expr2)},{v.register(expr1)}))"
668 end
669 else
670 if t2 isa MMTypeNone then
671 return "TAG_Bool(0)"
672 else if t2.is_nullable then
673 return "TAG_Bool(IS_EQUAL_ON({v.register(expr1)},{v.register(expr2)}))"
674 else
675 return "TAG_Bool(IS_EQUAL_OO({v.register(expr1)},{v.register(expr2)}))"
676 end
677 end
678 end
679 end
680
681 redef class INot
682 redef fun inner_compile_to_c(v)
683 do
684 return "TAG_Bool(!UNTAG_Bool({v.register(expr)}))"
685 end
686 end
687
688 redef class IOnce
689 redef fun inner_compile_to_c(v)
690 do
691 var i = v.new_number
692 var res = result.as(not null)
693 if res.stype.is_nullable then
694 v.add_decl("static val_t once_value_{i}; static int once_bool_{i}; /* Once value */")
695 v.add_instr("if (!once_bool_{i}) \{")
696 else
697 # Since the value is not nullable, we use the null value to represent the boolean
698 v.add_decl("static val_t once_value_{i}; /* Once value */")
699 v.add_instr("if (!once_value_{i}) \{")
700 end
701 v.indent
702 body.compile_to_c(v)
703 var e = v.register(result.as(not null))
704 v.add_instr("once_value_{i} = {e};")
705 if res.stype.is_nullable then v.add_instr("once_bool_{i} = true;")
706 v.unindent
707 v.add_instr("} else {e} = once_value_{i};")
708 return e
709 end
710 end
711
712 redef class IClosCall
713 redef fun compile_to_c(v: I2CCompilerVisitor)
714 do
715 v.add_location(location)
716 var ivar: String
717 if v.closure then
718 ivar = "closctx->closurevariable[{v.closures[closure_decl]}]"
719 else
720 ivar = "CREG[{v.closures[closure_decl]}]"
721 end
722 var args = [ivar]
723 args.append(v.registers(exprs))
724
725 var s = "(({v.clostypes[closure_decl]})({ivar}->fun))({args.join(", ")})"
726 store_result(v, s)
727
728 v.add_instr("if ({ivar}->has_broke) \{")
729 v.indent
730 var bs = break_seq
731 if bs != null then
732 bs.compile_to_c(v)
733 end
734 v.add_goto(v.iroutine.body)
735 v.unindent
736 v.add_instr("\}")
737 end
738
739 redef fun inner_compile_to_c(v) do abort
740 end
741
742 redef class IHasClos
743 redef fun inner_compile_to_c(v)
744 do
745 var ivar: String
746 if v.closure then
747 ivar = "closctx->closurevariable[{v.closures[closure_decl]}]"
748 else
749 ivar = "CREG[{v.closures[closure_decl]}]"
750 end
751 return "TAG_Bool({ivar} != NULL)"
752 end
753 end
754
755
756 redef class IClosureDef
757 fun compile_closure(v: I2CCompilerVisitor): String
758 do
759 var cfc_old = v.closure
760 v.closure = true
761 var lls_old = v.local_labels
762 v.local_labels = new HashSet[ISeq]
763
764 var cv = v.visitor
765 var ctx_old = cv.ctx
766 cv.ctx = new CContext
767 cv.out_contexts.add(cv.ctx)
768
769 var cname = "OC_{v.basecname}_{v.new_number}"
770 var args = compile_signature_to_c(v.visitor, cname, null, "struct WBT_ *closctx", null)
771 var ctx_old2 = cv.ctx
772 cv.ctx = new CContext
773
774 var s = compile_inside_to_c(v, args)
775 if s == null then
776 v.add_instr("return;")
777 else
778 v.add_instr("return {s};")
779 end
780
781 ctx_old2.append(cv.ctx)
782 cv.ctx = ctx_old2
783 v.unindent
784 v.add_instr("}")
785 cv.ctx = ctx_old
786
787 v.closure = cfc_old
788
789 # Build closure
790 var closcnv = "wbclos{v.new_number}"
791 v.add_decl("struct WBT_ {closcnv};")
792 v.add_instr("{closcnv}.fun = (fun_t){cname};")
793 v.add_instr("{closcnv}.has_broke = NULL;")
794 if cfc_old then
795 v.add_instr("{closcnv}.variable = closctx->variable;")
796 v.add_instr("{closcnv}.closurevariable = closctx->closurevariable;")
797 else
798 v.add_instr("{closcnv}.variable = REG;")
799 v.add_instr("{closcnv}.closurevariable = CREG;")
800 end
801
802 v.local_labels = lls_old
803 return "(&{closcnv})"
804 end
805 end
Nit language project; an oo programing language and its tool suite.