1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Separate compilation of a Nit program with generic type erasure
16 module separate_erasure_compiler
18 intrude import separate_compiler
20 # Add separate erased compiler specific options
21 redef class ToolContext
23 var opt_erasure
: OptionBool = new OptionBool("Erase generic types", "--erasure")
25 var opt_rta
= new OptionBool("Activate RTA (implicit with --global and --separate)", "--rta")
26 # --no-check-erasure-cast
27 var opt_no_check_erasure_cast
: OptionBool = new OptionBool("Disable implicit casts on unsafe return with erasure-typing policy (dangerous)", "--no-check-erasure-cast")
32 self.option_context
.add_option
(self.opt_erasure
, self.opt_no_check_erasure_cast
, opt_rta
)
35 redef fun process_options
(args
)
39 if opt_no_check_all
.value
then
40 opt_no_check_erasure_cast
.value
= true
44 var erasure_compiler_phase
= new ErasureCompilerPhase(self, null)
47 class ErasureCompilerPhase
49 redef fun process_mainmodule
(mainmodule
, given_mmodules
) do
50 if not toolcontext
.opt_erasure
.value
then return
52 var modelbuilder
= toolcontext
.modelbuilder
54 if toolcontext
.opt_rta
.value
then
55 analysis
= modelbuilder
.do_rapid_type_analysis
(mainmodule
)
57 modelbuilder
.run_separate_erasure_compiler
(mainmodule
, analysis
)
61 redef class ModelBuilder
62 fun run_separate_erasure_compiler
(mainmodule
: MModule, runtime_type_analysis
: nullable RapidTypeAnalysis)
65 self.toolcontext
.info
("*** GENERATING C ***", 1)
67 var compiler
= new SeparateErasureCompiler(mainmodule
, self, runtime_type_analysis
)
68 compiler
.compile_header
70 # compile class structures
71 self.toolcontext
.info
("Property coloring", 2)
72 compiler
.new_file
("{mainmodule.name}.tables")
73 compiler
.do_property_coloring
74 for m
in mainmodule
.in_importation
.greaters
do
75 for mclass
in m
.intro_mclasses
do
76 compiler
.compile_class_to_c
(mclass
)
79 compiler
.compile_color_consts
(compiler
.vt_colors
)
81 # The main function of the C
82 compiler
.new_file
("{mainmodule.name}.main")
83 compiler
.compile_nitni_global_ref_functions
84 compiler
.compile_main_function
87 for m
in mainmodule
.in_importation
.greaters
do
88 self.toolcontext
.info
("Generate C for module {m}", 2)
89 compiler
.new_file
("{m.name}.sep")
90 compiler
.compile_module_to_c
(m
)
93 compiler
.display_stats
96 self.toolcontext
.info
("*** END GENERATING C: {time1-time0} ***", 2)
97 write_and_make
(compiler
)
101 class SeparateErasureCompiler
102 super SeparateCompiler
104 private var class_ids
: Map[MClass, Int]
105 private var class_colors
: Map[MClass, Int]
106 protected var vt_colors
: Map[MVirtualTypeProp, Int]
108 init(mainmodule
: MModule, mmbuilder
: ModelBuilder, runtime_type_analysis
: nullable RapidTypeAnalysis) do
112 var poset
= mainmodule
.flatten_mclass_hierarchy
113 var mclasses
= new HashSet[MClass].from
(poset
)
114 var colorer
= new POSetColorer[MClass]
115 colorer
.colorize
(poset
)
116 class_ids
= colorer
.ids
117 class_colors
= colorer
.colors
118 class_tables
= self.build_class_typing_tables
(mclasses
)
120 # lookup vt to build layout with
121 var vts
= new HashMap[MClass, Set[MVirtualTypeProp]]
122 for mclass
in mclasses
do
123 vts
[mclass
] = new HashSet[MVirtualTypeProp]
124 for mprop
in self.mainmodule
.properties
(mclass
) do
125 if mprop
isa MVirtualTypeProp then
126 vts
[mclass
].add
(mprop
)
132 var vt_colorer
= new POSetBucketsColorer[MClass, MVirtualTypeProp](poset
, colorer
.conflicts
)
133 vt_colors
= vt_colorer
.colorize
(vts
)
134 vt_tables
= build_vt_tables
(mclasses
)
137 fun build_vt_tables
(mclasses
: Set[MClass]): Map[MClass, Array[nullable MPropDef]] do
138 var tables
= new HashMap[MClass, Array[nullable MPropDef]]
139 for mclass
in mclasses
do
140 var table
= new Array[nullable MPropDef]
141 # first, fill table from parents by reverse linearization order
142 var parents
= new Array[MClass]
143 if mainmodule
.flatten_mclass_hierarchy
.has
(mclass
) then
144 parents
= mclass
.in_hierarchy
(mainmodule
).greaters
.to_a
145 self.mainmodule
.linearize_mclasses
(parents
)
147 for parent
in parents
do
148 if parent
== mclass
then continue
149 for mproperty
in self.mainmodule
.properties
(parent
) do
150 if not mproperty
isa MVirtualTypeProp then continue
151 var color
= vt_colors
[mproperty
]
152 if table
.length
<= color
then
153 for i
in [table
.length
.. color
[ do
157 for mpropdef
in mproperty
.mpropdefs
do
158 if mpropdef
.mclassdef
.mclass
== parent
then
159 table
[color
] = mpropdef
165 # then override with local properties
166 for mproperty
in self.mainmodule
.properties
(mclass
) do
167 if not mproperty
isa MVirtualTypeProp then continue
168 var color
= vt_colors
[mproperty
]
169 if table
.length
<= color
then
170 for i
in [table
.length
.. color
[ do
174 for mpropdef
in mproperty
.mpropdefs
do
175 if mpropdef
.mclassdef
.mclass
== mclass
then
176 table
[color
] = mpropdef
180 tables
[mclass
] = table
186 fun build_class_typing_tables
(mclasses
: Set[MClass]): Map[MClass, Array[nullable MClass]] do
187 var tables
= new HashMap[MClass, Array[nullable MClass]]
188 for mclass
in mclasses
do
189 var table
= new Array[nullable MClass]
190 var supers
= new Array[MClass]
191 if mainmodule
.flatten_mclass_hierarchy
.has
(mclass
) then
192 supers
= mclass
.in_hierarchy
(mainmodule
).greaters
.to_a
195 var color
= class_colors
[sup
]
196 if table
.length
<= color
then
197 for i
in [table
.length
.. color
[ do
203 tables
[mclass
] = table
208 redef fun compile_header_structs
do
209 self.header
.add_decl
("typedef void(*nitmethod_t)(void); /* general C type representing a Nit method. */")
210 self.compile_header_attribute_structs
211 self.header
.add_decl
("struct class \{ int id; const char *name; int box_kind; int color; const struct vts_table *vts_table; const struct type_table *type_table; nitmethod_t vft[]; \}; /* general C type representing a Nit class. */")
212 self.header
.add_decl
("struct type_table \{ int size; int table[]; \}; /* colorized type table. */")
213 self.header
.add_decl
("struct vts_entry \{ short int is_nullable; const struct class *class; \}; /* link (nullable or not) between the vts and is bound. */")
214 self.header
.add_decl
("struct vts_table \{ int dummy; const struct vts_entry vts[]; \}; /* vts list of a C type representation. */")
215 self.header
.add_decl
("typedef struct instance \{ const struct class *class; nitattribute_t attrs[1]; \} val; /* general C type representing a Nit instance. */")
218 redef fun compile_class_to_c
(mclass
: MClass)
220 var mtype
= mclass
.intro
.bound_mtype
221 var c_name
= mclass
.c_name
222 var c_instance_name
= mclass
.c_instance_name
224 var vft
= self.method_tables
[mclass
]
225 var attrs
= self.attr_tables
[mclass
]
226 var class_table
= self.class_tables
[mclass
]
227 var v
= self.new_visitor
229 var rta
= runtime_type_analysis
230 var is_dead
= mclass
.kind
== abstract_kind
or mclass
.kind
== interface_kind
231 if not is_dead
and rta
!= null and not rta
.live_classes
.has
(mclass
) and mtype
.ctype
== "val*" and mclass
.name
!= "NativeArray" then
235 v
.add_decl
("/* runtime class {c_name} */")
237 self.provide_declaration
("class_{c_name}", "extern const struct class class_{c_name};")
238 v
.add_decl
("extern const struct type_table type_table_{c_name};")
241 v
.add_decl
("const struct class class_{c_name} = \{")
242 v
.add_decl
("{class_ids[mclass]},")
243 v
.add_decl
("\"{mclass.name}\
", /* class_name_string */")
244 v
.add_decl
("{self.box_kind_of(mclass)}, /* box_kind */")
245 v
.add_decl
("{class_colors[mclass]},")
247 if build_class_vts_table
(mclass
) then
248 v
.require_declaration
("vts_table_{c_name}")
249 v
.add_decl
("&vts_table_{c_name},")
253 v
.add_decl
("&type_table_{c_name},")
255 for i
in [0 .. vft
.length
[ do
256 var mpropdef
= vft
[i
]
257 if mpropdef
== null then
258 v
.add_decl
("NULL, /* empty */")
260 assert mpropdef
isa MMethodDef
261 if rta
!= null and not rta
.live_methoddefs
.has
(mpropdef
) then
262 v
.add_decl
("NULL, /* DEAD {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
265 if true or mpropdef
.mclassdef
.bound_mtype
.ctype
!= "val*" then
266 v
.require_declaration
("VIRTUAL_{mpropdef.c_name}")
267 v
.add_decl
("(nitmethod_t)VIRTUAL_{mpropdef.c_name}, /* pointer to {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
269 v
.require_declaration
("{mpropdef.c_name}")
270 v
.add_decl
("(nitmethod_t){mpropdef.c_name}, /* pointer to {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
278 # Build class type table
280 v
.add_decl
("const struct type_table type_table_{c_name} = \{")
281 v
.add_decl
("{class_table.length},")
283 for msuper
in class_table
do
284 if msuper
== null then
285 v
.add_decl
("-1, /* empty */")
287 v
.add_decl
("{self.class_ids[msuper]}, /* {msuper} */")
293 if mtype
.ctype
!= "val*" then
294 if mtype
.mclass
.name
== "Pointer" or mtype
.mclass
.kind
!= extern_kind
then
295 #Build instance struct
296 self.header
.add_decl
("struct instance_{c_instance_name} \{")
297 self.header
.add_decl
("const struct class *class;")
298 self.header
.add_decl
("{mtype.ctype} value;")
299 self.header
.add_decl
("\};")
303 self.provide_declaration
("BOX_{c_name}", "val* BOX_{c_name}({mtype.ctype});")
304 v
.add_decl
("/* allocate {mtype} */")
305 v
.add_decl
("val* BOX_{mtype.c_name}({mtype.ctype} value) \{")
306 v
.add
("struct instance_{c_instance_name}*res = nit_alloc(sizeof(struct instance_{c_instance_name}));")
307 v
.require_declaration
("class_{c_name}")
308 v
.add
("res->class = &class_{c_name};")
309 v
.add
("res->value = value;")
310 v
.add
("return (val*)res;")
313 else if mclass
.name
== "NativeArray" then
314 #Build instance struct
315 self.header
.add_decl
("struct instance_{c_name} \{")
316 self.header
.add_decl
("const struct class *class;")
317 self.header
.add_decl
("int length;")
318 self.header
.add_decl
("val* values[];")
319 self.header
.add_decl
("\};")
322 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(int length);")
323 v
.add_decl
("/* allocate {mtype} */")
324 v
.add_decl
("{mtype.ctype} NEW_{c_name}(int length) \{")
325 var res
= v
.get_name
("self")
326 v
.add_decl
("struct instance_{c_name} *{res};")
327 var mtype_elt
= mtype
.arguments
.first
328 v
.add
("{res} = nit_alloc(sizeof(struct instance_{c_name}) + length*sizeof({mtype_elt.ctype}));")
329 v
.require_declaration
("class_{c_name}")
330 v
.add
("{res}->class = &class_{c_name};")
331 v
.add
("{res}->length = length;")
332 v
.add
("return (val*){res};")
338 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(void);")
339 v
.add_decl
("/* allocate {mtype} */")
340 v
.add_decl
("{mtype.ctype} NEW_{c_name}(void) \{")
342 v
.add_abort
("{mclass} is DEAD")
345 var res
= v
.new_named_var
(mtype
, "self")
347 v
.add
("{res} = nit_alloc(sizeof(struct instance) + {attrs.length}*sizeof(nitattribute_t));")
348 v
.require_declaration
("class_{c_name}")
349 v
.add
("{res}->class = &class_{c_name};")
350 self.generate_init_attr
(v
, res
, mtype
)
352 v
.add
("return {res};")
357 private fun build_class_vts_table
(mclass
: MClass): Bool do
358 if self.vt_tables
[mclass
].is_empty
then return false
360 self.provide_declaration
("vts_table_{mclass.c_name}", "extern const struct vts_table vts_table_{mclass.c_name};")
363 v
.add_decl
("const struct vts_table vts_table_{mclass.c_name} = \{")
364 v
.add_decl
("0, /* dummy */")
367 for vt
in self.vt_tables
[mclass
] do
369 v
.add_decl
("\{-1, NULL\}, /* empty */")
372 var bound
= retrieve_vt_bound
(mclass
.intro
.bound_mtype
, vt
.as(MVirtualTypeDef).bound
)
373 while bound
isa MNullableType do
374 bound
= retrieve_vt_bound
(mclass
.intro
.bound_mtype
, bound
.mtype
)
377 var vtclass
= bound
.as(MClassType).mclass
378 v
.require_declaration
("class_{vtclass.c_name}")
379 v
.add_decl
("\{{is_null}, &class_{vtclass.c_name}\}, /* {vt} */")
387 private fun retrieve_vt_bound
(anchor
: MClassType, mtype
: nullable MType): MType do
388 if mtype
== null then
389 print
"NOT YET IMPLEMENTED: retrieve_vt_bound on null"
392 if mtype
isa MVirtualType then
393 return mtype
.anchor_to
(mainmodule
, anchor
)
394 else if mtype
isa MParameterType then
395 return mtype
.anchor_to
(mainmodule
, anchor
)
401 redef fun new_visitor
do return new SeparateErasureCompilerVisitor(self)
405 private var class_tables
: Map[MClass, Array[nullable MClass]]
406 private var vt_tables
: Map[MClass, Array[nullable MPropDef]]
408 redef fun display_sizes
410 print
"# size of subtyping tables"
411 print
"\ttotal \tholes"
414 for t
, table
in class_tables
do
415 total
+= table
.length
416 for e
in table
do if e
== null then holes
+= 1
418 print
"\t{total}\t{holes}"
420 print
"# size of resolution tables"
421 print
"\ttotal \tholes"
424 for t
, table
in vt_tables
do
425 total
+= table
.length
426 for e
in table
do if e
== null then holes
+= 1
428 print
"\t{total}\t{holes}"
430 print
"# size of methods tables"
431 print
"\ttotal \tholes"
434 for t
, table
in method_tables
do
435 total
+= table
.length
436 for e
in table
do if e
== null then holes
+= 1
438 print
"\t{total}\t{holes}"
440 print
"# size of attributes tables"
441 print
"\ttotal \tholes"
444 for t
, table
in attr_tables
do
445 total
+= table
.length
446 for e
in table
do if e
== null then holes
+= 1
448 print
"\t{total}\t{holes}"
452 class SeparateErasureCompilerVisitor
453 super SeparateCompilerVisitor
455 redef fun compile_callsite
(callsite
, arguments
)
458 if callsite
.erasure_cast
and not self.compiler
.as(SeparateErasureCompiler).modelbuilder
.toolcontext
.opt_no_check_erasure_cast
.value
then
460 var mtype
= callsite
.msignature
.return_mtype
462 self.add
("/* Erasure cast for return {res} isa {mtype} */")
463 var cond
= self.type_test
(res
, mtype
, "erasure")
464 self.add
("if (!{cond}) \{")
465 #var x = self.class_name_string(res)
466 #var y = self.class_name_string(arguments.first)
467 #self.add("PRINT_ERROR(\"Erasure cast: expected {mtype} (self is %s), got %s for {res}\\n\", {y}, {x});")
468 self.add_abort
("Cast failed")
474 redef fun init_instance
(mtype
)
476 self.require_declaration
("NEW_{mtype.mclass.c_name}")
477 return self.new_expr
("NEW_{mtype.mclass.c_name}()", mtype
)
480 redef fun type_test
(value
, mtype
, tag
)
482 self.add
("/* type test for {value.inspect} isa {mtype} */")
484 var res
= self.new_var
(bool_type
)
486 var cltype
= self.get_name
("cltype")
487 self.add_decl
("int {cltype};")
488 var idtype
= self.get_name
("idtype")
489 self.add_decl
("int {idtype};")
491 var maybe_null
= self.maybe_null
(value
)
492 var accept_null
= "0"
493 if mtype
isa MNullableType then
497 if mtype
isa MParameterType then
498 # Here we get the bound of the the formal type (eh, erasure...)
499 mtype
= mtype
.resolve_for
(self.frame
.mpropdef
.mclassdef
.bound_mtype
, self.frame
.mpropdef
.mclassdef
.bound_mtype
, self.frame
.mpropdef
.mclassdef
.mmodule
, false)
500 if mtype
isa MNullableType then
506 if value
.mcasttype
.is_subtype
(self.frame
.mpropdef
.mclassdef
.mmodule
, self.frame
.mpropdef
.mclassdef
.bound_mtype
, mtype
) then
507 self.add
("{res} = 1; /* easy {value.inspect} isa {mtype}*/")
508 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
509 self.compiler
.count_type_test_skipped
[tag
] += 1
510 self.add
("count_type_test_skipped_{tag}++;")
517 if value
.mtype
.ctype
== "val*" then
518 class_ptr
= "{value}->class->"
520 var mclass
= value
.mtype
.as(MClassType).mclass
521 self.require_declaration
("class_{mclass.c_name}")
522 class_ptr
= "class_{mclass.c_name}."
525 if mtype
isa MClassType then
526 self.require_declaration
("class_{mtype.mclass.c_name}")
527 self.add
("{cltype} = class_{mtype.mclass.c_name}.color;")
528 self.add
("{idtype} = class_{mtype.mclass.c_name}.id;")
529 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
530 self.compiler
.count_type_test_resolved
[tag
] += 1
531 self.add
("count_type_test_resolved_{tag}++;")
533 else if mtype
isa MVirtualType then
534 var recv
= self.frame
.arguments
.first
536 if recv
.mtype
.ctype
== "val*" then
537 recv_ptr
= "{recv}->class->"
539 var mclass
= recv
.mtype
.as(MClassType).mclass
540 self.require_declaration
("class_{mclass.c_name}")
541 recv_ptr
= "class_{mclass.c_name}."
543 var entry
= self.get_name
("entry")
544 self.add
("struct vts_entry {entry};")
545 self.require_declaration
(mtype
.mproperty
.const_color
)
546 self.add
("{entry} = {recv_ptr}vts_table->vts[{mtype.mproperty.const_color}];")
547 self.add
("{cltype} = {entry}.class->color;")
548 self.add
("{idtype} = {entry}.class->id;")
549 if maybe_null
and accept_null
== "0" then
550 var is_nullable
= self.get_name
("is_nullable")
551 self.add_decl
("short int {is_nullable};")
552 self.add
("{is_nullable} = {entry}.is_nullable;")
553 accept_null
= is_nullable
.to_s
555 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
556 self.compiler
.count_type_test_unresolved
[tag
] += 1
557 self.add
("count_type_test_unresolved_{tag}++;")
560 self.debug
("type_test({value.inspect}, {mtype})")
564 # check color is in table
566 self.add
("if({value} == NULL) \{")
567 self.add
("{res} = {accept_null};")
568 self.add
("\} else \{")
570 self.add
("if({cltype} >= {class_ptr}type_table->size) \{")
571 self.add
("{res} = 0;")
572 self.add
("\} else \{")
573 self.add
("{res} = {class_ptr}type_table->table[{cltype}] == {idtype};")
582 redef fun class_name_string
(value
)
584 var res
= self.get_name
("var_class_name")
585 self.add_decl
("const char* {res};")
586 if value
.mtype
.ctype
== "val*" then
587 self.add
"{res} = {value} == NULL ? \"null\
" : {value}->class->name;"
589 self.require_declaration
("class_{value.mtype.c_name}")
590 self.add
"{res} = class_{value.mtype.c_name}.name;"
595 redef fun native_array_instance
(elttype
, length
)
597 var nclass
= self.get_class
("NativeArray")
598 var mtype
= nclass
.get_mtype
([elttype
])
599 var res
= self.new_var
(mtype
)
601 self.require_declaration
("NEW_{nclass.c_name}")
602 self.add
("{res} = NEW_{nclass.c_name}({length});")
606 redef fun calloc_array
(ret_type
, arguments
)
608 var ret
= ret_type
.as(MClassType)
609 self.require_declaration
("NEW_{ret.mclass.c_name}")
610 self.ret
(self.new_expr
("NEW_{ret.mclass.c_name}({arguments[1]})", ret_type
))