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->REG[{i}]"
56 strs
= once
new HashMap[Int, String]
57 if not strs
.has_key
(i
) then strs
[i
] = "fra.me.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, String] = new HashMap[IClosureDecl, String]
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 = {ind};")
138 add_instr
("goto {lab(return_label.as(not null))};")
142 # Association between IEscapeMarks and visited ISeq
143 readable var _marks_to_seq
: Map[IEscapeMark, ISeq] = new HashMap[IEscapeMark, ISeq]
145 # Are we in a closure ?
146 readable writable var _closure
: Bool = false
148 # The current compiler visitor
149 readable var _visitor
: CompilerVisitor
151 # The current compiled iroutine
152 readable var _iroutine
: IRoutine
154 # The return label of the current compiling C function
155 readable writable var _return_label
: nullable ISeq = null
157 fun add_decl
(s
: String)
162 # Prepare a new instuction (indent, comment)
163 # Caller must ensure to add a new line to finish its instr
164 fun new_instr
: Writer
166 var w
= visitor
.writer
167 var l
= _next_location
169 visitor
.add_indent
(w
)
173 w
.add
(l
.line_start
.to_s
)
175 _next_location
= null
177 visitor
.add_indent
(w
)
181 fun add_instr
(s
: String)
183 new_instr
.add
(s
).add
("\n")
196 fun add_assignment
(to
, from
: String)
198 visitor
.add_assignment
(to
, from
)
201 var _last_location
: nullable Location = null
202 var _next_location
: nullable Location = null
204 # Add location information in a comment
205 # Do nothing if the last location added is the same
206 fun add_location
(l
: nullable Location)
208 var last
= _last_location
209 if last
== l
or l
== null then return
211 if last
!= null and last
.file
== l
.file
and last
.line_start
== l
.line_start
then
218 # The C fonction name of the iroutine
219 readable var _basecname
: String
221 init(v
: CompilerVisitor, ir
: IRoutine, cname
: String)
230 # Declare and start a C function that match the routine
231 # Return what must be given to compile_inside_to_c or to compile_to_c
232 # After the method, an openinig { and and indent is added.
233 # So, do not forget to add a sub_context, to unintent and to add a closing }
234 fun compile_signature_to_c
(v
: CompilerVisitor, cname
: String, human_name
: nullable String, before_params
, after_params
: nullable String): Array[String]
236 var cargs
= new Array[String]
237 var cparams
= new Array[String]
238 if before_params
!= null then cparams
.add
(before_params
)
239 for i
in [0..params
.length
[ do
241 cparams
.add
("val_t p{i}")
243 if closure_decls
!= null then
244 cparams
.add
("struct stack_frame_t *closctx_param")
245 for i
in [0..closure_decls
.length
[ do
246 var closcn
= "CLOS_{cname}_{i}"
247 var cs
= closure_decls
[i
].closure
.signature
248 var subparams
= new Array[String] # Parameters of the closure
249 subparams
.add
("struct stack_frame_t *")
250 for j
in [0..cs
.arity
[ do
251 subparams
.add
("val_t")
254 if cs
.return_type
!= null then rr
= "val_t"
255 v
.add_decl
("typedef {rr} (*{closcn})({subparams.join(", ")});")
256 cargs
.add
("clos_fun{i}")
257 cparams
.add
("fun_t clos_fun{i}")
260 if after_params
!= null then cparams
.add
(after_params
)
262 if result
!= null then r
= "val_t"
264 if cparams
.is_empty
then
267 p
= cparams
.join
(", ")
269 if human_name
!= null then v
.add_decl
("#define LOCATE_{cname} \"{human_name}\
"")
270 v
.add_decl
("{r} {cname}({p});")
271 v
.add_decl
("typedef {r} (*{cname}_t)({p});")
272 v
.add_instr
("{r} {cname}({p})\{")
277 # Compile the body of the routine, return the result value is any
278 fun compile_inside_to_c
(v
: I2CCompilerVisitor, args
: Array[String]): nullable String
280 # Create and push the stack frame
282 if location
!= null then
283 ll
= location
.line_start
285 # Encapsulate the frame ('me') in a larger structure ('fra') that has enough space to store the local variables (REG)
286 if std_slots_nb
> 1 then
287 v
.add_decl
("struct \{struct stack_frame_t me; val_t MORE_REG[{std_slots_nb-1}];\} fra;")
289 v
.add_decl
("struct \{struct stack_frame_t me;\} fra;")
291 v
.add_instr
("fra.me.prev = stack_frame_head; stack_frame_head = &fra.me;")
292 v
.add_instr
("fra.me.file = LOCATE_{v.visitor.module.name};")
293 v
.add_instr
("fra.me.line = {ll};")
294 v
.add_instr
("fra.me.meth = LOCATE_{v.basecname};")
295 v
.add_instr
("fra.me.has_broke = 0;")
296 v
.add_instr
("fra.me.REG_size = {std_slots_nb};")
298 # Declare/initialize local variables
299 for i
in [0..std_slots_nb
[ do
300 v
.add_instr
("fra.me.REG[{i}] = NIT_NULL;")
302 for i
in [0..tag_slots_nb
[ do
303 v
.add_decl
("val_t REGB{i};")
305 var iclosdecls
= closure_decls
306 if iclosdecls
!= null then
307 v
.add_decl
("fun_t CREG[{iclosdecls.length}];")
308 v
.add_instr
("fra.me.closure_ctx = closctx_param;")
309 v
.add_instr
("fra.me.closure_funs = CREG;")
313 if r
.slot_index
!= null then v
.add_assignment
(v
.register
(r
), args
[k
])
316 if iclosdecls
!= null then
317 for i
in [0..iclosdecls
.length
[ do
318 var iclosdecl
= iclosdecls
[i
]
319 v
.add_instr
("CREG[{i}] = {args[params.length+i]};")
320 v
.closures
[iclosdecl
] = i
.to_s
321 var cs
= iclosdecl
.closure
.signature
# Closure signature
322 var subparams
= new Array[String] # Parameters of the closure
323 subparams
.add
("struct stack_frame_t *")
324 for j
in [0..cs
.arity
[ do
329 if cs
.return_type
!= null then r
= "val_t"
330 v
.clostypes
[iclosdecl
] = "{r} (*)({subparams.join(", ")})"
333 v
.add_decl
("val_t tmp;")
336 var old_rl
= v
.return_label
337 v
.return_label
= body
342 v
.add_instr
("stack_frame_head = fra.me.prev;")
343 v
.return_label
= old_rl
352 # Full compilation of the routine
353 # cv must be in the correct function
354 fun compile_to_c
(cv
: CompilerVisitor, cname
: String, args
: Array[String]): nullable String
356 var v
= new I2CCompilerVisitor(cv
, self, cname
)
357 return compile_inside_to_c
(v
, args
)
362 # Full compilation of the icode
363 fun compile_to_c
(v
: I2CCompilerVisitor) is abstract
365 # Is a result really needed
366 private fun need_result
: Bool
369 return r
!= null and r
.slot_index
!= null
372 # Store s in the result value of self
373 private fun store_result
(v
: I2CCompilerVisitor, w
: nullable Writer)
376 if r
!= null and r
.slot_index
!= null then
379 w2
.add
(v
.register
(r
))
383 else if w
!= null and not is_pure
then
384 # ICode with side effects must be evaluated
385 # even if the result is not wanted
392 # Prepare a writer if the expression icode need to be compiled
393 # * Result assigment is automatic if needed
394 private fun new_result
(v
: I2CCompilerVisitor): Writer
396 assert need_result
or not is_pure
399 if r
!= null and r
.slot_index
!= null then
400 w2
.add
(v
.register
(r
))
410 redef fun compile_to_c
(v
)
412 v
.add_location
(location
)
413 v
.local_labels
.add
(self)
414 var mark
= iescape_mark
415 if mark
!= null then v
.marks_to_seq
[mark
] = self
424 redef fun compile_to_c
(v
)
426 v
.add_location
(location
)
428 w
.add
("if (UNTAG_Bool(")
429 w
.add
(v
.register
(expr
))
431 if not then_seq
.icodes
.is_empty
then
433 then_seq
.compile_to_c
(v
)
436 if not else_seq
.icodes
.is_empty
then
437 v
.add_instr
("\} else \{")
439 else_seq
.compile_to_c
(v
)
447 redef fun compile_to_c
(v
)
449 v
.add_location
(location
)
450 v
.local_labels
.add
(self)
451 var mark
= iescape_mark
452 if mark
!= null then v
.marks_to_seq
[mark
] = self
453 v
.add_instr
("while(1) \{")
465 redef fun compile_to_c
(v
)
467 v
.add_location
(location
)
468 v
.add_goto
(v
.marks_to_seq
[iescape_mark
])
473 redef fun compile_to_c
(v
)
475 v
.add_location
(location
)
476 var args
= v
.registers
(exprs
)
478 # Compile closure definitions
479 var old_el
= v
.escaped_labels
480 var closdefs
= closure_defs
481 var closctx
: nullable String = null # The closure context of closdefs
482 if closdefs
!= null then
483 # Get the closure context
487 closctx
= "(&(fra.me))"
490 # First aditionnal arguments is the closure context
493 # We are in a new escape boundary
494 v
.escaped_labels
= new HashMap[ISeq, Int]
496 # Compile each closures and add each sub-function as an other additionnal parameter
497 for cd
in closdefs
do
499 var cn
= cd
.compile_closure
(v
)
507 # Compile the real call
508 var call
= compile_call_to_c
(v
, args
)
509 var res
: nullable Writer = call
512 if closctx
!= null then
513 var els
= v
.escaped_labels
514 v
.escaped_labels
= old_el
515 # Is there possible escapes?
516 if not els
.is_empty
then
517 # Call in a tmp variable to avoid 'break' overwrite
531 # What are the expected escape indexes
532 v
.new_instr
.add
("switch (").add
(closctx
).add
("->has_broke) \{\n")
534 # No escape occured, continue as usual
535 v
.add_instr
("case 0: break;")
536 var lls
= v
.local_labels
537 var iels
= els
.iterator
538 var forward_escape
= false
542 # Local escape occured
543 # Clear the has_broke information and go to the target
544 v
.new_instr
.add
("case ").add
(iels
.item
.to_s
).add
(": ").add
(closctx
).add
("->has_broke = 0; goto ").add
(v
.lab
(seq
)).add
(";\n")
546 # Forward escape occured: register the escape label
548 v
.register_escape_label
(seq
)
549 forward_escape
= true
553 # If forward escape occured, just pass to the next one
554 if forward_escape
then
555 # Do not need to copy 'has_broke' value since it is shared by the next one.
556 # So just exit the C function.
557 v
.new_instr
.add
("default: goto ").add
(v
.lab
(v
.return_label
.as(not null))).add
(";\n")
565 var w
= new_result
(v
)
570 # The single invocation witout fancy stuffs
571 private fun compile_call_to_c
(v
: I2CCompilerVisitor, args
: Array[String]): Writer is abstract
575 redef fun compile_call_to_c
(v
, args
)
579 if prop
.global
.is_init
then args
.add
("init_table")
580 if prop
.name
== (once
("add".to_symbol
)) and prop
.local_class
.name
== (once
("Array".to_symbol
)) then
584 w
.add
(prop
.global
.meth_call
)
590 w
.add_all
(args
, ", ")
597 redef fun compile_call_to_c
(v
, args
)
600 if prop
.global
.is_init
then args
.add
("init_table")
602 w
.add
(prop
.super_meth_call
)
606 w
.add_all
(args
, ", ")
613 redef fun compile_call_to_c
(v
, args
)
617 w
.add
(stype
.local_class
.to_s
)
619 w
.add
(property
.global
.intro
.cname
)
621 w
.add_all
(args
, ", ")
627 redef class IAllocateInstance
628 redef fun compile_to_c
(v
)
630 v
.add_location
(location
)
631 var w
= new_result
(v
)
633 w
.add
(stype
.local_class
.name
.to_s
)
638 redef class ICheckInstance
639 redef fun compile_to_c
(v
)
641 v
.add_location
(location
)
642 var w
= new_result
(v
)
644 w
.add
(stype
.local_class
.name
.to_s
)
646 w
.add
(v
.register
(expr
))
651 redef class IInitAttributes
652 redef fun compile_to_c
(v
)
654 v
.add_location
(location
)
656 w
.add
("INIT_ATTRIBUTES__")
657 w
.add
(stype
.local_class
.name
.to_s
)
659 w
.add
(v
.register
(expr
))
664 redef class IStaticCall
665 redef fun compile_call_to_c
(v
, args
)
668 if prop
.global
.is_init
then args
.add
("init_table")
670 w
.add
(property
.cname
)
672 w
.add_all
(args
, ", ")
679 redef fun compile_to_c
(v
)
681 v
.add_location
(location
)
682 var w
= new_result
(v
)
683 if exprs
.is_empty
then
687 var c
= code
.split_with
("@@@")
690 if i
< exprs
.length
and i
< c
.length-1
then
691 w
.add
(v
.register
(exprs
[i
]))
700 redef fun compile_to_c
(v
)
702 v
.add_location
(location
)
704 w
.add
("fprintf(stderr")
714 w
.add
("fprintf(stderr, \" (%s
")
718 w.add(")\\n\
", LOCATE_")
719 w
.add
(module_location
.name
.to_s
)
722 w
.add
(ll
.line_start
.to_s
)
726 v
.add_instr
("nit_exit(1);")
731 redef fun compile_to_c
(v
)
733 if not need_result
then return
734 var e
= v
.register
(expr
)
735 var r
= v
.register
(result
.as(not null))
736 if e
== r
then return
737 v
.add_location
(location
)
746 redef class IAttrRead
747 redef fun compile_to_c
(v
)
749 if not need_result
then return
750 v
.add_location
(location
)
751 var w
= new_result
(v
)
752 w
.add
(property
.global
.attr_access
)
754 w
.add
(v
.register
(expr
))
759 redef class IAttrIsset
760 redef fun compile_to_c
(v
)
762 if not need_result
then return
763 v
.add_location
(location
)
764 var w
= new_result
(v
)
766 w
.add
(property
.global
.attr_access
)
768 w
.add
(v
.register
(expr
))
769 w
.add
(")!=NIT_NULL)")
773 redef class IAttrWrite
774 redef fun compile_to_c
(v
)
776 v
.add_location
(location
)
778 w
.add
(property
.global
.attr_access
)
780 w
.add
(v
.register
(expr1
))
782 w
.add
(v
.register
(expr2
))
787 redef class ITypeCheck
788 redef fun compile_to_c
(v
)
790 if not need_result
then return
791 # FIXME handle formaltypes
792 v
.add_location
(location
)
793 var g
= stype
.local_class
.global
794 var recv
= v
.register
(expr
)
795 var w
= new_result
(v
)
797 if expr
.stype
.is_nullable
then
798 if stype
.is_nullable
then
801 w
.add
("==NIT_NULL) || ")
802 else if stype
.as_nullable
== expr
.stype
then
809 w
.add
("!=NIT_NULL) && ")
825 redef fun compile_to_c
(v
)
827 if not need_result
then return
828 v
.add_location
(location
)
829 var w
= new_result
(v
)
833 if t1
isa MMTypeNone then
834 if t2
isa MMTypeNone then
837 else if t2
.is_nullable
then
838 w
.add
(v
.register
(expr2
))
845 else if t1
.is_nullable
then
846 if t2
isa MMTypeNone then
847 w
.add
(v
.register
(expr1
))
850 else if t2
.is_nullable
then
851 w
.add
("IS_EQUAL_NN(")
853 w
.add
("IS_EQUAL_ON(")
854 w
.add
(v
.register
(expr2
))
856 w
.add
(v
.register
(expr1
))
861 if t2
isa MMTypeNone then
864 else if t2
.is_nullable
then
865 w
.add
("IS_EQUAL_ON(")
867 w
.add
("IS_EQUAL_OO(")
870 w
.add
(v
.register
(expr1
))
872 w
.add
(v
.register
(expr2
))
878 redef fun compile_to_c
(v
)
880 if not need_result
then return
881 v
.add_location
(location
)
882 var w
= new_result
(v
)
883 w
.add
("TAG_Bool(!UNTAG_Bool(")
884 w
.add
(v
.register
(expr
))
890 redef fun compile_to_c
(v
)
892 v
.add_location
(location
)
894 var res
= result
.as(not null)
895 if res
.stype
.is_nullable
then
896 v
.add_decl
("static val_t once_value_{i}; static int once_bool_{i}; /* Once value */")
897 v
.add_instr
("if (!once_bool_{i}) \{")
899 # Since the value is not nullable, we use the null value to represent the boolean
900 v
.add_decl
("static val_t once_value_{i}; /* Once value */")
901 v
.add_instr
("if (!once_value_{i}) \{")
905 var e
= v
.register
(res
)
906 v
.add_instr
("once_value_{i} = {e};")
907 v
.add_instr
("register_static_object(&once_value_{i});")
908 if res
.stype
.is_nullable
then v
.add_instr
("once_bool_{i} = true;")
910 v
.add_instr
("\} else {e} = once_value_{i};")
911 var w
= new_result
(v
)
916 redef class IClosCall
917 redef fun compile_to_c
(v
: I2CCompilerVisitor)
919 v
.add_location
(location
)
921 var args
: Array[String]
923 ivar
= "closctx->closure_funs[{v.closures[closure_decl]}]"
924 args
= ["closctx->closure_ctx"]
926 ivar
= "CREG[{v.closures[closure_decl]}]"
927 args
= ["closctx_param"]
929 args
.append
(v
.registers
(exprs
))
931 var s
= "(({v.clostypes[closure_decl]})({ivar}))({args.join(", ")})"
937 v
.add_instr
("if ({args.first}->has_broke) \{")
943 v
.add_goto
(v
.iroutine
.body
)
950 redef fun compile_to_c
(v
)
952 if not need_result
then return
953 v
.add_location
(location
)
954 var w
= new_result
(v
)
957 w
.add
("closctx->closure_funs[")
958 w
.add
(v
.closures
[closure_decl
])
962 w
.add
(v
.closures
[closure_decl
])
969 redef class IClosureDef
970 # Compile the closure as a separate C function in the visitor out_contexts.
971 # Return a fun_t pointer to the function.
972 fun compile_closure
(v
: I2CCompilerVisitor): String
976 # We are now in a closure
977 var cfc_old
= v
.closure
980 # We are now in a escape boundary
981 var lls_old
= v
.local_labels
982 v
.local_labels
= new HashSet[ISeq]
984 # We are now in a new C context
985 var decl_writer_old
= cv
.decl_writer
986 var writer_old
= cv
.writer
987 cv
.writer
= cv
.top_writer
.sub
988 cv
.decl_writer
= cv
.header_writer
.sub
990 # Generate the C function
991 var cname
= "OC_{v.basecname}_{v.new_number}"
992 var args
= compile_signature_to_c
(v
.visitor
, cname
, null, "struct stack_frame_t *closctx", null)
993 cv
.decl_writer
= cv
.writer
.sub
995 var s
= compile_inside_to_c
(v
, args
)
997 v
.add_instr
("return;")
999 v
.add_instr
("return {s};")
1005 cv
.writer
= writer_old
1006 cv
.decl_writer
= decl_writer_old
1008 v
.local_labels
= lls_old
1009 return "((fun_t){cname})"