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")
24 # --no-check-erasure-cast
25 var opt_no_check_erasure_cast
: OptionBool = new OptionBool("Disable implicit casts on unsafe return with erasure-typing policy (dangerous)", "--no-check-erasure-cast")
30 self.option_context
.add_option
(self.opt_erasure
, self.opt_no_check_erasure_cast
)
34 redef class ModelBuilder
35 fun run_separate_erasure_compiler
(mainmodule
: MModule, runtime_type_analysis
: nullable RapidTypeAnalysis)
38 self.toolcontext
.info
("*** GENERATING C ***", 1)
40 var compiler
= new SeparateErasureCompiler(mainmodule
, self, runtime_type_analysis
)
41 compiler
.compile_header
43 # compile class structures
44 self.toolcontext
.info
("Property coloring", 2)
45 compiler
.new_file
("{mainmodule.name}.tables")
46 compiler
.do_property_coloring
47 for m
in mainmodule
.in_importation
.greaters
do
48 for mclass
in m
.intro_mclasses
do
49 compiler
.compile_class_to_c
(mclass
)
52 compiler
.compile_color_consts
(compiler
.vt_layout
.pos
)
54 # The main function of the C
55 compiler
.new_file
("{mainmodule.name}.main")
56 compiler
.compile_main_function
59 for m
in mainmodule
.in_importation
.greaters
do
60 self.toolcontext
.info
("Generate C for module {m}", 2)
61 compiler
.new_file
("{m.name}.sep")
62 compiler
.compile_module_to_c
(m
)
65 compiler
.display_stats
68 self.toolcontext
.info
("*** END GENERATING C: {time1-time0} ***", 2)
69 write_and_make
(compiler
)
73 class SeparateErasureCompiler
74 super SeparateCompiler
76 private var class_layout
: nullable Layout[MClass]
77 protected var vt_layout
: nullable Layout[MVirtualTypeProp]
79 init(mainmodule
: MModule, mmbuilder
: ModelBuilder, runtime_type_analysis
: nullable RapidTypeAnalysis) do
82 var mclasses
= new HashSet[MClass].from
(mmbuilder
.model
.mclasses
)
84 var layout_builder
: TypingLayoutBuilder[MClass]
85 var class_colorer
= new MClassColorer(mainmodule
)
86 if modelbuilder
.toolcontext
.opt_phmod_typing
.value
then
87 layout_builder
= new MClassHasher(new PHModOperator, mainmodule
)
88 class_colorer
.build_layout
(mclasses
)
89 else if modelbuilder
.toolcontext
.opt_phand_typing
.value
then
90 layout_builder
= new MClassHasher(new PHAndOperator, mainmodule
)
91 class_colorer
.build_layout
(mclasses
)
92 else if modelbuilder
.toolcontext
.opt_bm_typing
.value
then
93 layout_builder
= new MClassBMizer(mainmodule
)
94 class_colorer
.build_layout
(mclasses
)
96 layout_builder
= class_colorer
98 self.class_layout
= layout_builder
.build_layout
(mclasses
)
99 self.class_tables
= self.build_class_typing_tables
(mclasses
)
101 # lookup vt to build layout with
102 var vts
= new HashMap[MClass, Set[MVirtualTypeProp]]
103 for mclass
in mclasses
do
104 vts
[mclass
] = new HashSet[MVirtualTypeProp]
105 for mprop
in self.mainmodule
.properties
(mclass
) do
106 if mprop
isa MVirtualTypeProp then
107 vts
[mclass
].add
(mprop
)
113 var vt_coloring
= new MPropertyColorer[MVirtualTypeProp](mainmodule
, class_colorer
)
114 var vt_layout
= vt_coloring
.build_layout
(vts
)
115 self.vt_tables
= build_vt_tables
(mclasses
, vt_layout
)
116 self.vt_layout
= vt_layout
119 fun build_vt_tables
(mclasses
: Set[MClass], layout
: Layout[MProperty]): Map[MClass, Array[nullable MPropDef]] do
120 var tables
= new HashMap[MClass, Array[nullable MPropDef]]
121 for mclass
in mclasses
do
122 var table
= new Array[nullable MPropDef]
123 # first, fill table from parents by reverse linearization order
124 var parents
= new Array[MClass]
125 if mainmodule
.flatten_mclass_hierarchy
.has
(mclass
) then
126 parents
= mclass
.in_hierarchy
(mainmodule
).greaters
.to_a
127 self.mainmodule
.linearize_mclasses
(parents
)
129 for parent
in parents
do
130 if parent
== mclass
then continue
131 for mproperty
in self.mainmodule
.properties
(parent
) do
132 if not mproperty
isa MVirtualTypeProp then continue
133 var color
= layout
.pos
[mproperty
]
134 if table
.length
<= color
then
135 for i
in [table
.length
.. color
[ do
139 for mpropdef
in mproperty
.mpropdefs
do
140 if mpropdef
.mclassdef
.mclass
== parent
then
141 table
[color
] = mpropdef
147 # then override with local properties
148 for mproperty
in self.mainmodule
.properties
(mclass
) do
149 if not mproperty
isa MVirtualTypeProp then continue
150 var color
= layout
.pos
[mproperty
]
151 if table
.length
<= color
then
152 for i
in [table
.length
.. color
[ do
156 for mpropdef
in mproperty
.mpropdefs
do
157 if mpropdef
.mclassdef
.mclass
== mclass
then
158 table
[color
] = mpropdef
162 tables
[mclass
] = table
168 fun build_class_typing_tables
(mclasses
: Set[MClass]): Map[MClass, Array[nullable MClass]] do
169 var tables
= new HashMap[MClass, Array[nullable MClass]]
170 var layout
= self.class_layout
171 for mclass
in mclasses
do
172 var table
= new Array[nullable MClass]
173 var supers
= new Array[MClass]
174 if mainmodule
.flatten_mclass_hierarchy
.has
(mclass
) then
175 supers
= mclass
.in_hierarchy
(mainmodule
).greaters
.to_a
179 if layout
isa PHLayout[MClass, MClass] then
180 color
= layout
.hashes
[mclass
][sup
]
182 color
= layout
.pos
[sup
]
184 if table
.length
<= color
then
185 for i
in [table
.length
.. color
[ do
191 tables
[mclass
] = table
196 redef fun compile_header_structs
do
197 self.header
.add_decl
("typedef void(*nitmethod_t)(void); /* general C type representing a Nit method. */")
198 self.compile_header_attribute_structs
199 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. */")
200 self.header
.add_decl
("struct type_table \{ int size; int table[]; \}; /* colorized type table. */")
201 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. */")
203 if self.vt_layout
isa PHLayout[MClass, MVirtualTypeProp] then
204 self.header
.add_decl
("struct vts_table \{ int mask; const struct vts_entry vts[]; \}; /* vts list of a C type representation. */")
206 self.header
.add_decl
("struct vts_table \{ int dummy; const struct vts_entry vts[]; \}; /* vts list of a C type representation. */")
209 if modelbuilder
.toolcontext
.opt_phmod_typing
.value
then
210 self.header
.add_decl
("#define HASH(mask, id) ((mask)%(id))")
211 else if modelbuilder
.toolcontext
.opt_phand_typing
.value
then
212 self.header
.add_decl
("#define HASH(mask, id) ((mask)&(id))")
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
223 var vft
= self.method_tables
[mclass
]
224 var attrs
= self.attr_tables
[mclass
]
225 var class_table
= self.class_tables
[mclass
]
226 var v
= self.new_visitor
228 v
.add_decl
("/* runtime class {c_name} */")
230 self.provide_declaration
("class_{c_name}", "extern const struct class class_{c_name};")
231 v
.add_decl
("extern const struct type_table type_table_{c_name};")
234 v
.add_decl
("const struct class class_{c_name} = \{")
235 v
.add_decl
("{self.class_layout.ids[mclass]},")
236 v
.add_decl
("\"{mclass.name}\
", /* class_name_string */")
237 v
.add_decl
("{self.box_kind_of(mclass)}, /* box_kind */")
238 var layout
= self.class_layout
239 if layout
isa PHLayout[MClass, MClass] then
240 v
.add_decl
("{layout.masks[mclass]},")
242 v
.add_decl
("{layout.pos[mclass]},")
244 if build_class_vts_table
(mclass
) then
245 v
.require_declaration
("vts_table_{c_name}")
246 v
.add_decl
("&vts_table_{c_name},")
250 v
.add_decl
("&type_table_{c_name},")
252 for i
in [0 .. vft
.length
[ do
253 var mpropdef
= vft
[i
]
254 if mpropdef
== null then
255 v
.add_decl
("NULL, /* empty */")
257 if true or mpropdef
.mclassdef
.bound_mtype
.ctype
!= "val*" then
258 v
.require_declaration
("VIRTUAL_{mpropdef.c_name}")
259 v
.add_decl
("(nitmethod_t)VIRTUAL_{mpropdef.c_name}, /* pointer to {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
261 v
.require_declaration
("{mpropdef.c_name}")
262 v
.add_decl
("(nitmethod_t){mpropdef.c_name}, /* pointer to {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
269 # Build class type table
271 v
.add_decl
("const struct type_table type_table_{c_name} = \{")
272 v
.add_decl
("{class_table.length},")
274 for msuper
in class_table
do
275 if msuper
== null then
276 v
.add_decl
("-1, /* empty */")
278 v
.add_decl
("{self.class_layout.ids[msuper]}, /* {msuper} */")
284 if mtype
.ctype
!= "val*" then
285 #Build instance struct
286 self.header
.add_decl
("struct instance_{c_name} \{")
287 self.header
.add_decl
("const struct class *class;")
288 self.header
.add_decl
("{mtype.ctype} value;")
289 self.header
.add_decl
("\};")
292 self.header
.add_decl
("val* BOX_{c_name}({mtype.ctype});")
293 v
.add_decl
("/* allocate {mtype} */")
294 v
.add_decl
("val* BOX_{mtype.c_name}({mtype.ctype} value) \{")
295 v
.add
("struct instance_{c_name}*res = nit_alloc(sizeof(struct instance_{c_name}));")
296 v
.require_declaration
("class_{c_name}")
297 v
.add
("res->class = &class_{c_name};")
298 v
.add
("res->value = value;")
299 v
.add
("return (val*)res;")
302 else if mclass
.name
== "NativeArray" then
303 #Build instance struct
304 self.header
.add_decl
("struct instance_{c_name} \{")
305 self.header
.add_decl
("const struct class *class;")
306 self.header
.add_decl
("val* values[];")
307 self.header
.add_decl
("\};")
310 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(int length);")
311 v
.add_decl
("/* allocate {mtype} */")
312 v
.add_decl
("{mtype.ctype} NEW_{c_name}(int length) \{")
313 var res
= v
.new_named_var
(mtype
, "self")
315 var mtype_elt
= mtype
.arguments
.first
316 v
.add
("{res} = nit_alloc(sizeof(struct instance_{c_name}) + length*sizeof({mtype_elt.ctype}));")
317 v
.require_declaration
("class_{c_name}")
318 v
.add
("{res}->class = &class_{c_name};")
319 v
.add
("return {res};")
325 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(void);")
326 v
.add_decl
("/* allocate {mtype} */")
327 v
.add_decl
("{mtype.ctype} NEW_{c_name}(void) \{")
328 var res
= v
.new_named_var
(mtype
, "self")
330 v
.add
("{res} = nit_alloc(sizeof(struct instance) + {attrs.length}*sizeof(nitattribute_t));")
331 v
.require_declaration
("class_{c_name}")
332 v
.add
("{res}->class = &class_{c_name};")
333 self.generate_init_attr
(v
, res
, mtype
)
334 v
.add
("return {res};")
338 private fun build_class_vts_table
(mclass
: MClass): Bool do
339 if self.vt_tables
[mclass
].is_empty
then return false
341 self.provide_declaration
("vts_table_{mclass.c_name}", "extern const struct vts_table vts_table_{mclass.c_name};")
344 v
.add_decl
("const struct vts_table vts_table_{mclass.c_name} = \{")
345 if self.vt_layout
isa PHLayout[MClass, MVirtualTypeProp] then
346 #TODO redo this when PHPropertyLayoutBuilder will be implemented
347 #v.add_decl("{vt_masks[mclass]},")
349 v
.add_decl
("0, /* dummy */")
353 for vt
in self.vt_tables
[mclass
] do
355 v
.add_decl
("\{-1, NULL\}, /* empty */")
358 var bound
= retrieve_vt_bound
(mclass
.intro
.bound_mtype
, vt
.as(MVirtualTypeDef).bound
)
359 while bound
isa MNullableType do
360 bound
= retrieve_vt_bound
(mclass
.intro
.bound_mtype
, bound
.mtype
)
363 var vtclass
= bound
.as(MClassType).mclass
364 v
.require_declaration
("class_{vtclass.c_name}")
365 v
.add_decl
("\{{is_null}, &class_{vtclass.c_name}\}, /* {vt} */")
373 private fun retrieve_vt_bound
(anchor
: MClassType, mtype
: nullable MType): MType do
374 if mtype
== null then
375 print
"NOT YET IMPLEMENTED: retrieve_vt_bound on null"
378 if mtype
isa MVirtualType then
379 return mtype
.anchor_to
(mainmodule
, anchor
)
380 else if mtype
isa MParameterType then
381 return mtype
.anchor_to
(mainmodule
, anchor
)
387 redef fun new_visitor
do return new SeparateErasureCompilerVisitor(self)
391 private var class_tables
: Map[MClass, Array[nullable MClass]]
392 private var vt_tables
: Map[MClass, Array[nullable MPropDef]]
394 redef fun display_sizes
396 print
"# size of subtyping tables"
397 print
"\ttotal \tholes"
400 for t
, table
in class_tables
do
401 total
+= table
.length
402 for e
in table
do if e
== null then holes
+= 1
404 print
"\t{total}\t{holes}"
406 print
"# size of resolution tables"
407 print
"\ttotal \tholes"
410 for t
, table
in vt_tables
do
411 total
+= table
.length
412 for e
in table
do if e
== null then holes
+= 1
414 print
"\t{total}\t{holes}"
416 print
"# size of methods tables"
417 print
"\ttotal \tholes"
420 for t
, table
in method_tables
do
421 total
+= table
.length
422 for e
in table
do if e
== null then holes
+= 1
424 print
"\t{total}\t{holes}"
426 print
"# size of attributes tables"
427 print
"\ttotal \tholes"
430 for t
, table
in attr_tables
do
431 total
+= table
.length
432 for e
in table
do if e
== null then holes
+= 1
434 print
"\t{total}\t{holes}"
438 class SeparateErasureCompilerVisitor
439 super SeparateCompilerVisitor
441 redef fun compile_callsite
(callsite
, arguments
)
444 if callsite
.erasure_cast
and not self.compiler
.as(SeparateErasureCompiler).modelbuilder
.toolcontext
.opt_no_check_erasure_cast
.value
then
446 var mtype
= callsite
.msignature
.return_mtype
448 self.add
("/* Erasure cast for return {res} isa {mtype} */")
449 var cond
= self.type_test
(res
, mtype
, "erasure")
450 self.add
("if (!{cond}) \{")
451 #var x = self.class_name_string(res)
452 #var y = self.class_name_string(arguments.first)
453 #self.add("fprintf(stderr, \"Erasure cast: expected {mtype} (self is %s), got %s for {res}\\n\", {y}, {x});")
454 self.add_abort
("Cast failed")
460 redef fun init_instance
(mtype
)
462 self.require_declaration
("NEW_{mtype.mclass.c_name}")
463 return self.new_expr
("NEW_{mtype.mclass.c_name}()", mtype
)
466 redef fun type_test
(value
, mtype
, tag
)
468 self.add
("/* type test for {value.inspect} isa {mtype} */")
470 var res
= self.new_var
(bool_type
)
472 var cltype
= self.get_name
("cltype")
473 self.add_decl
("int {cltype};")
474 var idtype
= self.get_name
("idtype")
475 self.add_decl
("int {idtype};")
477 var maybe_null
= self.maybe_null
(value
)
478 var accept_null
= "0"
479 if mtype
isa MNullableType then
483 if mtype
isa MParameterType then
484 # Here we get the bound of the the formal type (eh, erasure...)
485 mtype
= mtype
.resolve_for
(self.frame
.mpropdef
.mclassdef
.bound_mtype
, self.frame
.mpropdef
.mclassdef
.bound_mtype
, self.frame
.mpropdef
.mclassdef
.mmodule
, false)
486 if mtype
isa MNullableType then
492 if value
.mcasttype
.is_subtype
(self.frame
.mpropdef
.mclassdef
.mmodule
, self.frame
.mpropdef
.mclassdef
.bound_mtype
, mtype
) then
493 self.add
("{res} = 1; /* easy {value.inspect} isa {mtype}*/")
494 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
495 self.compiler
.count_type_test_skipped
[tag
] += 1
496 self.add
("count_type_test_skipped_{tag}++;")
503 if value
.mtype
.ctype
== "val*" then
504 class_ptr
= "{value}->class->"
506 var mclass
= value
.mtype
.as(MClassType).mclass
507 self.require_declaration
("class_{mclass.c_name}")
508 class_ptr
= "class_{mclass.c_name}."
511 if mtype
isa MClassType then
512 self.require_declaration
("class_{mtype.mclass.c_name}")
513 self.add
("{cltype} = class_{mtype.mclass.c_name}.color;")
514 self.add
("{idtype} = class_{mtype.mclass.c_name}.id;")
515 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
516 self.compiler
.count_type_test_resolved
[tag
] += 1
517 self.add
("count_type_test_resolved_{tag}++;")
519 else if mtype
isa MVirtualType then
520 var recv
= self.frame
.arguments
.first
522 if recv
.mtype
.ctype
== "val*" then
523 recv_ptr
= "{recv}->class->"
525 var mclass
= recv
.mtype
.as(MClassType).mclass
526 self.require_declaration
("class_{mclass.c_name}")
527 recv_ptr
= "class_{mclass.c_name}."
529 var entry
= self.get_name
("entry")
530 self.add
("struct vts_entry {entry};")
531 self.require_declaration
(mtype
.mproperty
.const_color
)
532 if self.compiler
.as(SeparateErasureCompiler).vt_layout
isa PHLayout[MClass, MVirtualTypeProp] then
533 self.add
("{entry} = {recv_ptr}vts_table->vts[HASH({recv_ptr}vts_table->mask, {mtype.mproperty.const_color})];")
535 self.add
("{entry} = {recv_ptr}vts_table->vts[{mtype.mproperty.const_color}];")
537 self.add
("{cltype} = {entry}.class->color;")
538 self.add
("{idtype} = {entry}.class->id;")
539 if maybe_null
and accept_null
== "0" then
540 var is_nullable
= self.get_name
("is_nullable")
541 self.add_decl
("short int {is_nullable};")
542 self.add
("{is_nullable} = {entry}.is_nullable;")
543 accept_null
= is_nullable
.to_s
545 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
546 self.compiler
.count_type_test_unresolved
[tag
] += 1
547 self.add
("count_type_test_unresolved_{tag}++;")
550 self.debug
("type_test({value.inspect}, {mtype})")
554 # check color is in table
556 self.add
("if({value} == NULL) \{")
557 self.add
("{res} = {accept_null};")
558 self.add
("\} else \{")
560 if self.compiler
.as(SeparateErasureCompiler).class_layout
isa PHLayout[MClass, MClass] then
561 self.add
("{cltype} = HASH({class_ptr}color, {idtype});")
563 self.add
("if({cltype} >= {class_ptr}type_table->size) \{")
564 self.add
("{res} = 0;")
565 self.add
("\} else \{")
566 self.add
("{res} = {class_ptr}type_table->table[{cltype}] == {idtype};")
575 redef fun class_name_string
(value
)
577 var res
= self.get_name
("var_class_name")
578 self.add_decl
("const char* {res};")
579 if value
.mtype
.ctype
== "val*" then
580 self.add
"{res} = {value} == NULL ? \"null\
" : {value}->class->name;"
582 self.require_declaration
("class_{value.mtype.c_name}")
583 self.add
"{res} = class_{value.mtype.c_name}.name;"
588 redef fun array_instance
(array
, elttype
)
590 var nclass
= self.get_class
("NativeArray")
591 elttype
= self.anchor
(elttype
)
592 var arraytype
= self.get_class
("Array").get_mtype
([elttype
])
593 var res
= self.init_instance
(arraytype
)
594 self.add
("\{ /* {res} = array_instance Array[{elttype}] */")
595 var nat
= self.new_var
(self.get_class
("NativeArray").get_mtype
([elttype
]))
597 self.require_declaration
("NEW_{nclass.c_name}")
598 self.add
("{nat} = NEW_{nclass.c_name}({array.length});")
599 for i
in [0..array
.length
[ do
600 var r
= self.autobox
(array
[i
], self.object_type
)
601 self.add
("((struct instance_{nclass.c_name}*){nat})->values[{i}] = (val*) {r};")
603 var length
= self.int_instance
(array
.length
)
604 self.send
(self.get_property
("with_native", arraytype
), [res
, nat
, length
])
609 redef fun calloc_array
(ret_type
, arguments
)
611 var ret
= ret_type
.as(MClassType)
612 self.require_declaration
("NEW_{ret.mclass.c_name}")
613 self.ret
(self.new_expr
("NEW_{ret.mclass.c_name}({arguments[1]})", ret_type
))