0606c4a16a51db0c4e4d614e2f13fd637d81b702
[nit.git] / src / separate_compiler.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
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
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
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.
14
15 # Separate compilation of a Nit program
16 module separate_compiler
17
18 import abstract_compiler
19 import layout_builders
20 import rapid_type_analysis
21
22 # Add separate compiler specific options
23 redef class ToolContext
24 # --separate
25 var opt_separate: OptionBool = new OptionBool("Use separate compilation", "--separate")
26 # --no-inline-intern
27 var opt_no_inline_intern: OptionBool = new OptionBool("Do not inline call to intern methods", "--no-inline-intern")
28 # --no-union-attribute
29 var opt_no_union_attribute: OptionBool = new OptionBool("Put primitive attibutes in a box instead of an union", "--no-union-attribute")
30 # --no-shortcut-equate
31 var opt_no_shortcut_equate: OptionBool = new OptionBool("Always call == in a polymorphic way", "--no-shortcut-equal")
32 # --inline-coloring-numbers
33 var opt_inline_coloring_numbers: OptionBool = new OptionBool("Inline colors and ids", "--inline-coloring-numbers")
34 # --use-naive-coloring
35 var opt_bm_typing: OptionBool = new OptionBool("Colorize items incrementaly, used to simulate binary matrix typing", "--bm-typing")
36 # --use-mod-perfect-hashing
37 var opt_phmod_typing: OptionBool = new OptionBool("Replace coloration by perfect hashing (with mod operator)", "--phmod-typing")
38 # --use-and-perfect-hashing
39 var opt_phand_typing: OptionBool = new OptionBool("Replace coloration by perfect hashing (with and operator)", "--phand-typing")
40 # --tables-metrics
41 var opt_tables_metrics: OptionBool = new OptionBool("Enable static size measuring of tables used for vft, typing and resolution", "--tables-metrics")
42
43 redef init
44 do
45 super
46 self.option_context.add_option(self.opt_separate)
47 self.option_context.add_option(self.opt_no_inline_intern)
48 self.option_context.add_option(self.opt_no_union_attribute)
49 self.option_context.add_option(self.opt_no_shortcut_equate)
50 self.option_context.add_option(self.opt_inline_coloring_numbers)
51 self.option_context.add_option(self.opt_bm_typing)
52 self.option_context.add_option(self.opt_phmod_typing)
53 self.option_context.add_option(self.opt_phand_typing)
54 self.option_context.add_option(self.opt_tables_metrics)
55 end
56 end
57
58 redef class ModelBuilder
59 fun run_separate_compiler(mainmodule: MModule, runtime_type_analysis: RapidTypeAnalysis)
60 do
61 var time0 = get_time
62 self.toolcontext.info("*** GENERATING C ***", 1)
63
64 var compiler = new SeparateCompiler(mainmodule, self, runtime_type_analysis)
65 compiler.compile_header
66
67 # compile class structures
68 self.toolcontext.info("Property coloring", 2)
69 compiler.new_file("{mainmodule.name}.classes")
70 compiler.do_property_coloring
71 for m in mainmodule.in_importation.greaters do
72 for mclass in m.intro_mclasses do
73 if mclass.kind == abstract_kind or mclass.kind == interface_kind then continue
74 compiler.compile_class_to_c(mclass)
75 end
76 end
77
78 # The main function of the C
79 compiler.new_file("{mainmodule.name}.main")
80 compiler.compile_main_function
81
82 # compile methods
83 for m in mainmodule.in_importation.greaters do
84 self.toolcontext.info("Generate C for module {m}", 2)
85 compiler.new_file("{m.name}.sep")
86 compiler.compile_module_to_c(m)
87 end
88
89 # compile live & cast type structures
90 self.toolcontext.info("Type coloring", 2)
91 compiler.new_file("{mainmodule.name}.types")
92 var mtypes = compiler.do_type_coloring
93 for t in mtypes do
94 compiler.compile_type_to_c(t)
95 end
96
97 compiler.display_stats
98
99 var time1 = get_time
100 self.toolcontext.info("*** END GENERATING C: {time1-time0} ***", 2)
101 write_and_make(compiler)
102 end
103 end
104
105 # Singleton that store the knowledge about the separate compilation process
106 class SeparateCompiler
107 super AbstractCompiler
108
109 redef type VISITOR: SeparateCompilerVisitor
110
111 # The result of the RTA (used to know live types and methods)
112 var runtime_type_analysis: RapidTypeAnalysis
113
114 private var undead_types: Set[MType] = new HashSet[MType]
115 private var partial_types: Set[MType] = new HashSet[MType]
116 private var live_unresolved_types: Map[MClassDef, Set[MType]] = new HashMap[MClassDef, HashSet[MType]]
117
118 private var type_layout: nullable Layout[MType]
119 private var resolution_layout: nullable Layout[MType]
120 protected var method_layout: nullable Layout[PropertyLayoutElement]
121 protected var attr_layout: nullable Layout[MAttribute]
122
123 init(mainmodule: MModule, mmbuilder: ModelBuilder, runtime_type_analysis: RapidTypeAnalysis) do
124 super(mainmodule, mmbuilder)
125 var file = new_file("nit.common")
126 self.header = new CodeWriter(file)
127 self.runtime_type_analysis = runtime_type_analysis
128 self.compile_box_kinds
129 end
130
131 redef fun compile_header_structs do
132 self.header.add_decl("typedef void(*nitmethod_t)(void); /* general C type representing a Nit method. */")
133 self.compile_header_attribute_structs
134 self.header.add_decl("struct class \{ int box_kind; nitmethod_t vft[]; \}; /* general C type representing a Nit class. */")
135
136 # With resolution_table_table, all live type resolution are stored in a big table: resolution_table
137 self.header.add_decl("struct type \{ int id; const char *name; int color; short int is_nullable; const struct types *resolution_table; int table_size; int type_table[]; \}; /* general C type representing a Nit type. */")
138 self.header.add_decl("struct instance \{ const struct type *type; const struct class *class; nitattribute_t attrs[]; \}; /* general C type representing a Nit instance. */")
139
140 if modelbuilder.toolcontext.opt_phmod_typing.value or modelbuilder.toolcontext.opt_phand_typing.value then
141 self.header.add_decl("struct types \{ int mask; const struct type *types[]; \}; /* a list types (used for vts, fts and unresolved lists). */")
142 else
143 self.header.add_decl("struct types \{ int dummy; const struct type *types[]; \}; /* a list types (used for vts, fts and unresolved lists). */")
144 end
145
146 if modelbuilder.toolcontext.opt_phmod_typing.value then
147 self.header.add_decl("#define HASH(mask, id) ((mask)%(id))")
148 else if modelbuilder.toolcontext.opt_phand_typing.value then
149 self.header.add_decl("#define HASH(mask, id) ((mask)&(id))")
150 end
151
152 self.header.add_decl("typedef struct instance val; /* general C type representing a Nit instance. */")
153 end
154
155 fun compile_header_attribute_structs
156 do
157 if modelbuilder.toolcontext.opt_no_union_attribute.value then
158 self.header.add_decl("typedef void* nitattribute_t; /* general C type representing a Nit attribute. */")
159 else
160 self.header.add_decl("typedef union \{")
161 self.header.add_decl("void* val;")
162 for c, v in self.box_kinds do
163 var t = c.mclass_type
164 self.header.add_decl("{t.ctype} {t.ctypename};")
165 end
166 self.header.add_decl("\} nitattribute_t; /* general C type representing a Nit attribute. */")
167 end
168 end
169
170 fun compile_box_kinds
171 do
172 # Collect all bas box class
173 # FIXME: this is not completely fine with a separate compilation scheme
174 for classname in ["Int", "Bool", "Char", "Float", "NativeString", "Pointer"] do
175 var classes = self.mainmodule.model.get_mclasses_by_name(classname)
176 if classes == null then continue
177 assert classes.length == 1 else print classes.join(", ")
178 self.box_kinds[classes.first] = self.box_kinds.length + 1
179 end
180 end
181
182 var box_kinds = new HashMap[MClass, Int]
183
184 fun box_kind_of(mclass: MClass): Int
185 do
186 if mclass.mclass_type.ctype == "val*" then
187 return 0
188 else if mclass.kind == extern_kind then
189 return self.box_kinds[self.mainmodule.get_primitive_class("Pointer")]
190 else
191 return self.box_kinds[mclass]
192 end
193
194 end
195
196 fun compile_color_consts(colors: Map[Object, Int]) do
197 var v = new_visitor
198 for m, c in colors do
199 compile_color_const(v, m, c)
200 end
201 end
202
203 fun compile_color_const(v: SeparateCompilerVisitor, m: Object, color: Int) do
204 if color_consts_done.has(m) then return
205 if m isa MProperty then
206 if modelbuilder.toolcontext.opt_inline_coloring_numbers.value then
207 self.provide_declaration(m.const_color, "#define {m.const_color} {color}")
208 else
209 self.provide_declaration(m.const_color, "extern const int {m.const_color};")
210 v.add("const int {m.const_color} = {color};")
211 end
212 else if m isa MPropDef then
213 if modelbuilder.toolcontext.opt_inline_coloring_numbers.value then
214 self.provide_declaration(m.const_color, "#define {m.const_color} {color}")
215 else
216 self.provide_declaration(m.const_color, "extern const int {m.const_color};")
217 v.add("const int {m.const_color} = {color};")
218 end
219 else if m isa MType then
220 if modelbuilder.toolcontext.opt_inline_coloring_numbers.value then
221 self.provide_declaration(m.const_color, "#define {m.const_color} {color}")
222 else
223 self.provide_declaration(m.const_color, "extern const int {m.const_color};")
224 v.add("const int {m.const_color} = {color};")
225 end
226 end
227 color_consts_done.add(m)
228 end
229
230 private var color_consts_done = new HashSet[Object]
231
232 # colorize classe properties
233 fun do_property_coloring do
234 var mclasses = new HashSet[MClass].from(modelbuilder.model.mclasses)
235
236 # Layouts
237 var method_layout_builder: PropertyLayoutBuilder[PropertyLayoutElement]
238 var attribute_layout_builder: PropertyLayoutBuilder[MAttribute]
239 #FIXME PH and BM layouts too slow for large programs
240 #if modelbuilder.toolcontext.opt_bm_typing.value then
241 # method_layout_builder = new MMethodBMizer(self.mainmodule)
242 # attribute_layout_builder = new MAttributeBMizer(self.mainmodule)
243 #else if modelbuilder.toolcontext.opt_phmod_typing.value then
244 # method_layout_builder = new MMethodHasher(new PHModOperator, self.mainmodule)
245 # attribute_layout_builder = new MAttributeHasher(new PHModOperator, self.mainmodule)
246 #else if modelbuilder.toolcontext.opt_phand_typing.value then
247 # method_layout_builder = new MMethodHasher(new PHAndOperator, self.mainmodule)
248 # attribute_layout_builder = new MAttributeHasher(new PHAndOperator, self.mainmodule)
249 #else
250
251 var class_layout_builder = new MClassColorer(self.mainmodule)
252 class_layout_builder.build_layout(mclasses)
253 method_layout_builder = new MPropertyColorer[PropertyLayoutElement](self.mainmodule, class_layout_builder)
254 attribute_layout_builder = new MPropertyColorer[MAttribute](self.mainmodule, class_layout_builder)
255 #end
256
257 # lookup properties to build layout with
258 var mmethods = new HashMap[MClass, Set[PropertyLayoutElement]]
259 var mattributes = new HashMap[MClass, Set[MAttribute]]
260 for mclass in mclasses do
261 mmethods[mclass] = new HashSet[PropertyLayoutElement]
262 mattributes[mclass] = new HashSet[MAttribute]
263 for mprop in self.mainmodule.properties(mclass) do
264 if mprop isa MMethod then
265 mmethods[mclass].add(mprop)
266 else if mprop isa MAttribute then
267 mattributes[mclass].add(mprop)
268 end
269 end
270 end
271
272 # lookup super calls and add it to the list of mmethods to build layout with
273 var super_calls = runtime_type_analysis.live_super_sends
274 for mmethoddef in super_calls do
275 var mclass = mmethoddef.mclassdef.mclass
276 mmethods[mclass].add(mmethoddef)
277 for descendant in mclass.in_hierarchy(self.mainmodule).smallers do
278 mmethods[descendant].add(mmethoddef)
279 end
280 end
281
282 # methods coloration
283 self.method_layout = method_layout_builder.build_layout(mmethods)
284 self.method_tables = build_method_tables(mclasses, super_calls)
285 self.compile_color_consts(method_layout.pos)
286
287 # attribute null color to dead supercalls
288 for mmodule in self.mainmodule.in_importation.greaters do
289 for mclassdef in mmodule.mclassdefs do
290 for mpropdef in mclassdef.mpropdefs do
291 if mpropdef.has_supercall then
292 compile_color_const(new_visitor, mpropdef, -1)
293 end
294 end
295 end
296 end
297
298 # attributes coloration
299 self.attr_layout = attribute_layout_builder.build_layout(mattributes)
300 self.attr_tables = build_attr_tables(mclasses)
301 self.compile_color_consts(attr_layout.pos)
302 end
303
304 fun build_method_tables(mclasses: Set[MClass], super_calls: Set[MMethodDef]): Map[MClass, Array[nullable MPropDef]] do
305 var layout = self.method_layout
306 var tables = new HashMap[MClass, Array[nullable MPropDef]]
307 for mclass in mclasses do
308 var table = new Array[nullable MPropDef]
309 var supercalls = new List[MMethodDef]
310
311 # first, fill table from parents by reverse linearization order
312 var parents = new Array[MClass]
313 if mainmodule.flatten_mclass_hierarchy.has(mclass) then
314 parents = mclass.in_hierarchy(mainmodule).greaters.to_a
315 self.mainmodule.linearize_mclasses(parents)
316 end
317
318 for parent in parents do
319 if parent == mclass then continue
320 for mproperty in self.mainmodule.properties(parent) do
321 if not mproperty isa MMethod then continue
322 var color = layout.pos[mproperty]
323 if table.length <= color then
324 for i in [table.length .. color[ do
325 table[i] = null
326 end
327 end
328 for mpropdef in mproperty.mpropdefs do
329 if mpropdef.mclassdef.mclass == parent then
330 table[color] = mpropdef
331 end
332 end
333 end
334
335 # lookup for super calls in super classes
336 for mmethoddef in super_calls do
337 for mclassdef in parent.mclassdefs do
338 if mclassdef.mpropdefs.has(mmethoddef) then
339 supercalls.add(mmethoddef)
340 end
341 end
342 end
343 end
344
345 # then override with local properties
346 for mproperty in self.mainmodule.properties(mclass) do
347 if not mproperty isa MMethod then continue
348 var color = layout.pos[mproperty]
349 if table.length <= color then
350 for i in [table.length .. color[ do
351 table[i] = null
352 end
353 end
354 for mpropdef in mproperty.mpropdefs do
355 if mpropdef.mclassdef.mclass == mclass then
356 table[color] = mpropdef
357 end
358 end
359 end
360
361 # lookup for super calls in local class
362 for mmethoddef in super_calls do
363 for mclassdef in mclass.mclassdefs do
364 if mclassdef.mpropdefs.has(mmethoddef) then
365 supercalls.add(mmethoddef)
366 end
367 end
368 end
369 # insert super calls in table according to receiver
370 for supercall in supercalls do
371 var color = layout.pos[supercall]
372 if table.length <= color then
373 for i in [table.length .. color[ do
374 table[i] = null
375 end
376 end
377 var mmethoddef = supercall.lookup_next_definition(self.mainmodule, mclass.intro.bound_mtype)
378 table[color] = mmethoddef
379 end
380 tables[mclass] = table
381 end
382 return tables
383 end
384
385 fun build_attr_tables(mclasses: Set[MClass]): Map[MClass, Array[nullable MPropDef]] do
386 var layout = self.attr_layout
387 var tables = new HashMap[MClass, Array[nullable MPropDef]]
388 for mclass in mclasses do
389 var table = new Array[nullable MPropDef]
390 # first, fill table from parents by reverse linearization order
391 var parents = new Array[MClass]
392 if mainmodule.flatten_mclass_hierarchy.has(mclass) then
393 parents = mclass.in_hierarchy(mainmodule).greaters.to_a
394 self.mainmodule.linearize_mclasses(parents)
395 end
396 for parent in parents do
397 if parent == mclass then continue
398 for mproperty in self.mainmodule.properties(parent) do
399 if not mproperty isa MAttribute then continue
400 var color = layout.pos[mproperty]
401 if table.length <= color then
402 for i in [table.length .. color[ do
403 table[i] = null
404 end
405 end
406 for mpropdef in mproperty.mpropdefs do
407 if mpropdef.mclassdef.mclass == parent then
408 table[color] = mpropdef
409 end
410 end
411 end
412 end
413
414 # then override with local properties
415 for mproperty in self.mainmodule.properties(mclass) do
416 if not mproperty isa MAttribute then continue
417 var color = layout.pos[mproperty]
418 if table.length <= color then
419 for i in [table.length .. color[ do
420 table[i] = null
421 end
422 end
423 for mpropdef in mproperty.mpropdefs do
424 if mpropdef.mclassdef.mclass == mclass then
425 table[color] = mpropdef
426 end
427 end
428 end
429 tables[mclass] = table
430 end
431 return tables
432 end
433
434 # colorize live types of the program
435 private fun do_type_coloring: POSet[MType] do
436 var mtypes = new HashSet[MType]
437 mtypes.add_all(self.runtime_type_analysis.live_types)
438 mtypes.add_all(self.runtime_type_analysis.live_cast_types)
439 mtypes.add_all(self.undead_types)
440 for c in self.box_kinds.keys do
441 mtypes.add(c.mclass_type)
442 end
443
444 for mtype in mtypes do
445 retrieve_partial_types(mtype)
446 end
447 mtypes.add_all(self.partial_types)
448
449 # Typing Layout
450 var layout_builder: TypingLayoutBuilder[MType]
451 if modelbuilder.toolcontext.opt_bm_typing.value then
452 layout_builder = new MTypeBMizer(self.mainmodule)
453 else if modelbuilder.toolcontext.opt_phmod_typing.value then
454 layout_builder = new MTypeHasher(new PHModOperator, self.mainmodule)
455 else if modelbuilder.toolcontext.opt_phand_typing.value then
456 layout_builder = new MTypeHasher(new PHAndOperator, self.mainmodule)
457 else
458 layout_builder = new MTypeColorer(self.mainmodule)
459 end
460
461 # colorize types
462 self.type_layout = layout_builder.build_layout(mtypes)
463 var poset = layout_builder.poset.as(not null)
464 self.type_tables = self.build_type_tables(poset)
465
466 # VT and FT are stored with other unresolved types in the big resolution_tables
467 self.compile_resolution_tables(mtypes)
468
469 return poset
470 end
471
472 # Build type tables
473 fun build_type_tables(mtypes: POSet[MType]): Map[MType, Array[nullable MType]] do
474 var tables = new HashMap[MType, Array[nullable MType]]
475 var layout = self.type_layout
476 for mtype in mtypes do
477 var table = new Array[nullable MType]
478 for sup in mtypes[mtype].greaters do
479 var color: Int
480 if layout isa PHLayout[MType, MType] then
481 color = layout.hashes[mtype][sup]
482 else
483 color = layout.pos[sup]
484 end
485 if table.length <= color then
486 for i in [table.length .. color[ do
487 table[i] = null
488 end
489 end
490 table[color] = sup
491 end
492 tables[mtype] = table
493 end
494 return tables
495 end
496
497 protected fun compile_resolution_tables(mtypes: Set[MType]) do
498 # resolution_tables is used to perform a type resolution at runtime in O(1)
499
500 # During the visit of the body of classes, live_unresolved_types are collected
501 # and associated to
502 # Collect all live_unresolved_types (visited in the body of classes)
503
504 # Determinate fo each livetype what are its possible requested anchored types
505 var mtype2unresolved = new HashMap[MClassType, Set[MType]]
506 for mtype in self.runtime_type_analysis.live_types do
507 var set = new HashSet[MType]
508 for cd in mtype.collect_mclassdefs(self.mainmodule) do
509 if self.live_unresolved_types.has_key(cd) then
510 set.add_all(self.live_unresolved_types[cd])
511 end
512 end
513 mtype2unresolved[mtype] = set
514 end
515
516 # Compute the table layout with the prefered method
517 var resolution_builder: ResolutionLayoutBuilder
518 if modelbuilder.toolcontext.opt_bm_typing.value then
519 resolution_builder = new ResolutionBMizer
520 else if modelbuilder.toolcontext.opt_phmod_typing.value then
521 resolution_builder = new ResolutionHasher(new PHModOperator)
522 else if modelbuilder.toolcontext.opt_phand_typing.value then
523 resolution_builder = new ResolutionHasher(new PHAndOperator)
524 else
525 resolution_builder = new ResolutionColorer
526 end
527 self.resolution_layout = resolution_builder.build_layout(mtype2unresolved)
528 self.resolution_tables = self.build_resolution_tables(mtype2unresolved)
529
530 # Compile a C constant for each collected unresolved type.
531 # Either to a color, or to -1 if the unresolved type is dead (no live receiver can require it)
532 var all_unresolved = new HashSet[MType]
533 for t in self.live_unresolved_types.values do
534 all_unresolved.add_all(t)
535 end
536 var all_unresolved_types_colors = new HashMap[MType, Int]
537 for t in all_unresolved do
538 if self.resolution_layout.pos.has_key(t) then
539 all_unresolved_types_colors[t] = self.resolution_layout.pos[t]
540 else
541 all_unresolved_types_colors[t] = -1
542 end
543 end
544 self.compile_color_consts(all_unresolved_types_colors)
545
546 #print "tables"
547 #for k, v in unresolved_types_tables.as(not null) do
548 # print "{k}: {v.join(", ")}"
549 #end
550 #print ""
551 end
552
553 fun build_resolution_tables(elements: Map[MClassType, Set[MType]]): Map[MClassType, Array[nullable MType]] do
554 var tables = new HashMap[MClassType, Array[nullable MType]]
555 var layout = self.resolution_layout
556 for mclasstype, mtypes in elements do
557 var table = new Array[nullable MType]
558 for mtype in mtypes do
559 var color: Int
560 if layout isa PHLayout[MClassType, MType] then
561 color = layout.hashes[mclasstype][mtype]
562 else
563 color = layout.pos[mtype]
564 end
565 if table.length <= color then
566 for i in [table.length .. color[ do
567 table[i] = null
568 end
569 end
570 table[color] = mtype
571 end
572 tables[mclasstype] = table
573 end
574 return tables
575 end
576
577 fun retrieve_partial_types(mtype: MType) do
578 # add formal types arguments to mtypes
579 if mtype isa MGenericType then
580 for ft in mtype.arguments do
581 if ft.need_anchor then
582 print("Why do we need anchor here ?")
583 abort
584 end
585 self.partial_types.add(ft)
586 retrieve_partial_types(ft)
587 end
588 end
589 var mclass_type: MClassType
590 if mtype isa MNullableType then
591 mclass_type = mtype.mtype.as(MClassType)
592 else
593 mclass_type = mtype.as(MClassType)
594 end
595
596 # add virtual types to mtypes
597 for vt in self.mainmodule.properties(mclass_type.mclass) do
598 if vt isa MVirtualTypeProp then
599 var anchored = vt.mvirtualtype.lookup_bound(self.mainmodule, mclass_type).anchor_to(self.mainmodule, mclass_type)
600 self.partial_types.add(anchored)
601 end
602 end
603 end
604
605 # Separately compile all the method definitions of the module
606 fun compile_module_to_c(mmodule: MModule)
607 do
608 var old_module = self.mainmodule
609 self.mainmodule = mmodule
610 for cd in mmodule.mclassdefs do
611 for pd in cd.mpropdefs do
612 if not pd isa MMethodDef then continue
613 #print "compile {pd} @ {cd} @ {mmodule}"
614 var r = pd.separate_runtime_function
615 r.compile_to_c(self)
616 var r2 = pd.virtual_runtime_function
617 r2.compile_to_c(self)
618 end
619 end
620 self.mainmodule = old_module
621 end
622
623 # Globaly compile the type structure of a live type
624 fun compile_type_to_c(mtype: MType)
625 do
626 var c_name = mtype.c_name
627 var v = new SeparateCompilerVisitor(self)
628 v.add_decl("/* runtime type {mtype} */")
629
630 # extern const struct type_X
631 self.provide_declaration("type_{c_name}", "extern const struct type type_{c_name};")
632
633 # const struct type_X
634 v.add_decl("const struct type type_{c_name} = \{")
635 v.add_decl("{self.type_layout.ids[mtype]},")
636 v.add_decl("\"{mtype}\", /* class_name_string */")
637 var layout = self.type_layout
638 if layout isa PHLayout[MType, MType] then
639 v.add_decl("{layout.masks[mtype]},")
640 else
641 v.add_decl("{layout.pos[mtype]},")
642 end
643 if mtype isa MNullableType then
644 v.add_decl("1,")
645 else
646 v.add_decl("0,")
647 end
648 if compile_type_resolution_table(mtype) then
649 v.require_declaration("resolution_table_{c_name}")
650 v.add_decl("&resolution_table_{c_name},")
651 else
652 v.add_decl("NULL,")
653 end
654 v.add_decl("{self.type_tables[mtype].length},")
655 v.add_decl("\{")
656 for stype in self.type_tables[mtype] do
657 if stype == null then
658 v.add_decl("-1, /* empty */")
659 else
660 v.add_decl("{self.type_layout.ids[stype]}, /* {stype} */")
661 end
662 end
663 v.add_decl("\},")
664 v.add_decl("\};")
665 end
666
667 fun compile_type_resolution_table(mtype: MType): Bool do
668
669 var mclass_type: MClassType
670 if mtype isa MNullableType then
671 mclass_type = mtype.mtype.as(MClassType)
672 else
673 mclass_type = mtype.as(MClassType)
674 end
675 if not self.resolution_tables.has_key(mclass_type) then return false
676
677 var layout = self.resolution_layout
678
679 # extern const struct resolution_table_X resolution_table_X
680 self.provide_declaration("resolution_table_{mtype.c_name}", "extern const struct types resolution_table_{mtype.c_name};")
681
682 # const struct fts_table_X fts_table_X
683 var v = new_visitor
684 v.add_decl("const struct types resolution_table_{mtype.c_name} = \{")
685 if layout isa PHLayout[MClassType, MType] then
686 v.add_decl("{layout.masks[mclass_type]},")
687 else
688 v.add_decl("0, /* dummy */")
689 end
690 v.add_decl("\{")
691 for t in self.resolution_tables[mclass_type] do
692 if t == null then
693 v.add_decl("NULL, /* empty */")
694 else
695 # The table stores the result of the type resolution
696 # Therefore, for a receiver `mclass_type`, and a unresolved type `t`
697 # the value stored is tv.
698 var tv = t.resolve_for(mclass_type, mclass_type, self.mainmodule, true)
699 # FIXME: What typeids means here? How can a tv not be live?
700 if self.type_layout.ids.has_key(tv) then
701 v.require_declaration("type_{tv.c_name}")
702 v.add_decl("&type_{tv.c_name}, /* {t}: {tv} */")
703 else
704 v.add_decl("NULL, /* empty ({t}: {tv} not a live type) */")
705 end
706 end
707 end
708 v.add_decl("\}")
709 v.add_decl("\};")
710 return true
711 end
712
713 # Globally compile the table of the class mclass
714 # In a link-time optimisation compiler, tables are globally computed
715 # In a true separate compiler (a with dynamic loading) you cannot do this unfortnally
716 fun compile_class_to_c(mclass: MClass)
717 do
718 var mtype = mclass.intro.bound_mtype
719 var c_name = mclass.c_name
720
721 var vft = self.method_tables[mclass]
722 var attrs = self.attr_tables[mclass]
723 var v = new_visitor
724
725 var is_dead = not runtime_type_analysis.live_classes.has(mclass) and mtype.ctype == "val*" and mclass.name != "NativeArray"
726
727 v.add_decl("/* runtime class {c_name} */")
728
729 # Build class vft
730 if not is_dead then
731 self.provide_declaration("class_{c_name}", "extern const struct class class_{c_name};")
732 v.add_decl("const struct class class_{c_name} = \{")
733 v.add_decl("{self.box_kind_of(mclass)}, /* box_kind */")
734 v.add_decl("\{")
735 for i in [0 .. vft.length[ do
736 var mpropdef = vft[i]
737 if mpropdef == null then
738 v.add_decl("NULL, /* empty */")
739 else
740 assert mpropdef isa MMethodDef
741 var rf = mpropdef.virtual_runtime_function
742 v.require_declaration(rf.c_name)
743 v.add_decl("(nitmethod_t){rf.c_name}, /* pointer to {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
744 end
745 end
746 v.add_decl("\}")
747 v.add_decl("\};")
748 end
749
750 if mtype.ctype != "val*" then
751 #Build instance struct
752 self.header.add_decl("struct instance_{c_name} \{")
753 self.header.add_decl("const struct type *type;")
754 self.header.add_decl("const struct class *class;")
755 self.header.add_decl("{mtype.ctype} value;")
756 self.header.add_decl("\};")
757
758 if not self.runtime_type_analysis.live_types.has(mtype) then return
759
760 #Build BOX
761 self.header.add_decl("val* BOX_{c_name}({mtype.ctype});")
762 v.add_decl("/* allocate {mtype} */")
763 v.add_decl("val* BOX_{mtype.c_name}({mtype.ctype} value) \{")
764 v.add("struct instance_{c_name}*res = nit_alloc(sizeof(struct instance_{c_name}));")
765 v.require_declaration("type_{c_name}")
766 v.add("res->type = &type_{c_name};")
767 v.require_declaration("class_{c_name}")
768 v.add("res->class = &class_{c_name};")
769 v.add("res->value = value;")
770 v.add("return (val*)res;")
771 v.add("\}")
772 return
773 else if mclass.name == "NativeArray" then
774 #Build instance struct
775 self.header.add_decl("struct instance_{c_name} \{")
776 self.header.add_decl("const struct type *type;")
777 self.header.add_decl("const struct class *class;")
778 # NativeArrays are just a instance header followed by an array of values
779 self.header.add_decl("val* values[0];")
780 self.header.add_decl("\};")
781
782 #Build NEW
783 self.provide_declaration("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(int length, const struct type* type);")
784 v.add_decl("/* allocate {mtype} */")
785 v.add_decl("{mtype.ctype} NEW_{c_name}(int length, const struct type* type) \{")
786 var res = v.new_named_var(mtype, "self")
787 res.is_exact = true
788 var mtype_elt = mtype.arguments.first
789 v.add("{res} = nit_alloc(sizeof(struct instance_{c_name}) + length*sizeof({mtype_elt.ctype}));")
790 v.add("{res}->type = type;")
791 hardening_live_type(v, "type")
792 v.require_declaration("class_{c_name}")
793 v.add("{res}->class = &class_{c_name};")
794 v.add("return {res};")
795 v.add("\}")
796 return
797 end
798
799 #Build NEW
800 self.provide_declaration("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(const struct type* type);")
801 v.add_decl("/* allocate {mtype} */")
802 v.add_decl("{mtype.ctype} NEW_{c_name}(const struct type* type) \{")
803 if is_dead then
804 v.add_abort("{mclass} is DEAD")
805 else
806 var res = v.new_named_var(mtype, "self")
807 res.is_exact = true
808 v.add("{res} = nit_alloc(sizeof(struct instance) + {attrs.length}*sizeof(nitattribute_t));")
809 v.add("{res}->type = type;")
810 hardening_live_type(v, "type")
811 v.require_declaration("class_{c_name}")
812 v.add("{res}->class = &class_{c_name};")
813 self.generate_init_attr(v, res, mtype)
814 v.add("return {res};")
815 end
816 v.add("\}")
817
818 generate_check_init_instance(mtype)
819 end
820
821 # Add a dynamic test to ensure that the type referenced by `t` is a live type
822 fun hardening_live_type(v: VISITOR, t: String)
823 do
824 if not v.compiler.modelbuilder.toolcontext.opt_hardening.value then return
825 v.add("if({t} == NULL) \{")
826 v.add_abort("type null")
827 v.add("\}")
828 v.add("if({t}->resolution_table == NULL) \{")
829 v.add("fprintf(stderr, \"Insantiation of a dead type: %s\\n\", {t}->name);")
830 v.add_abort("type dead")
831 v.add("\}")
832 end
833
834 redef fun generate_check_init_instance(mtype)
835 do
836 if self.modelbuilder.toolcontext.opt_no_check_initialization.value then return
837
838 var v = self.new_visitor
839 var c_name = mtype.mclass.c_name
840 var res = new RuntimeVariable("self", mtype, mtype)
841 self.provide_declaration("CHECK_NEW_{c_name}", "void CHECK_NEW_{c_name}({mtype.ctype});")
842 v.add_decl("/* allocate {mtype} */")
843 v.add_decl("void CHECK_NEW_{c_name}({mtype.ctype} {res}) \{")
844 if runtime_type_analysis.live_classes.has(mtype.mclass) then
845 self.generate_check_attr(v, res, mtype)
846 else
847 v.add_abort("{mtype.mclass} is DEAD")
848 end
849 v.add("\}")
850 end
851
852 redef fun new_visitor do return new SeparateCompilerVisitor(self)
853
854 # Stats
855
856 private var type_tables: Map[MType, Array[nullable MType]] = new HashMap[MType, Array[nullable MType]]
857 private var resolution_tables: Map[MClassType, Array[nullable MType]] = new HashMap[MClassType, Array[nullable MType]]
858 protected var method_tables: Map[MClass, Array[nullable MPropDef]] = new HashMap[MClass, Array[nullable MPropDef]]
859 protected var attr_tables: Map[MClass, Array[nullable MPropDef]] = new HashMap[MClass, Array[nullable MPropDef]]
860
861 redef fun display_stats
862 do
863 super
864 if self.modelbuilder.toolcontext.opt_tables_metrics.value then
865 display_sizes
866 end
867 end
868
869 fun display_sizes
870 do
871 print "# size of subtyping tables"
872 print "\ttotal \tholes"
873 var total = 0
874 var holes = 0
875 for t, table in type_tables do
876 total += table.length
877 for e in table do if e == null then holes += 1
878 end
879 print "\t{total}\t{holes}"
880
881 print "# size of resolution tables"
882 print "\ttotal \tholes"
883 total = 0
884 holes = 0
885 for t, table in resolution_tables do
886 total += table.length
887 for e in table do if e == null then holes += 1
888 end
889 print "\t{total}\t{holes}"
890
891 print "# size of methods tables"
892 print "\ttotal \tholes"
893 total = 0
894 holes = 0
895 for t, table in method_tables do
896 total += table.length
897 for e in table do if e == null then holes += 1
898 end
899 print "\t{total}\t{holes}"
900
901 print "# size of attributes tables"
902 print "\ttotal \tholes"
903 total = 0
904 holes = 0
905 for t, table in attr_tables do
906 total += table.length
907 for e in table do if e == null then holes += 1
908 end
909 print "\t{total}\t{holes}"
910 end
911 end
912
913 # A visitor on the AST of property definition that generate the C code of a separate compilation process.
914 class SeparateCompilerVisitor
915 super AbstractCompilerVisitor
916
917 redef type COMPILER: SeparateCompiler
918
919 redef fun adapt_signature(m, args)
920 do
921 var msignature = m.msignature.resolve_for(m.mclassdef.bound_mtype, m.mclassdef.bound_mtype, m.mclassdef.mmodule, true)
922 var recv = args.first
923 if recv.mtype.ctype != m.mclassdef.mclass.mclass_type.ctype then
924 args.first = self.autobox(args.first, m.mclassdef.mclass.mclass_type)
925 end
926 for i in [0..msignature.arity[ do
927 var t = msignature.mparameters[i].mtype
928 if i == msignature.vararg_rank then
929 t = args[i+1].mtype
930 end
931 args[i+1] = self.autobox(args[i+1], t)
932 end
933 end
934
935 redef fun autobox(value, mtype)
936 do
937 if value.mtype == mtype then
938 return value
939 else if value.mtype.ctype == "val*" and mtype.ctype == "val*" then
940 return value
941 else if value.mtype.ctype == "val*" then
942 return self.new_expr("((struct instance_{mtype.c_name}*){value})->value; /* autounbox from {value.mtype} to {mtype} */", mtype)
943 else if mtype.ctype == "val*" then
944 var valtype = value.mtype.as(MClassType)
945 var res = self.new_var(mtype)
946 if not compiler.runtime_type_analysis.live_types.has(valtype) then
947 self.add("/*no autobox from {value.mtype} to {mtype}: {value.mtype} is not live! */")
948 self.add("printf(\"Dead code executed!\\n\"); exit(1);")
949 return res
950 end
951 self.add("{res} = BOX_{valtype.c_name}({value}); /* autobox from {value.mtype} to {mtype} */")
952 return res
953 else
954 # Bad things will appen!
955 var res = self.new_var(mtype)
956 self.add("/* {res} left unintialized (cannot convert {value.mtype} to {mtype}) */")
957 self.add("printf(\"Cast error: Cannot cast %s to %s.\\n\", \"{value.mtype}\", \"{mtype}\"); exit(1);")
958 return res
959 end
960 end
961
962 # Return a C expression returning the runtime type structure of the value
963 # The point of the method is to works also with primitives types.
964 fun type_info(value: RuntimeVariable): String
965 do
966 if value.mtype.ctype == "val*" then
967 return "{value}->type"
968 else
969 self.require_declaration("type_{value.mtype.c_name}")
970 return "(&type_{value.mtype.c_name})"
971 end
972 end
973
974 redef fun send(mmethod, arguments)
975 do
976 self.varargize(mmethod.intro, mmethod.intro.msignature.as(not null), arguments)
977 return table_send(mmethod, arguments, mmethod.const_color)
978 end
979
980 private fun table_send(mmethod: MMethod, arguments: Array[RuntimeVariable], const_color: String): nullable RuntimeVariable
981 do
982 if arguments.first.mcasttype.ctype != "val*" then
983 # In order to shortcut the primitive, we need to find the most specific method
984 # Howverr, because of performance (no flattening), we always work on the realmainmodule
985 var m = self.compiler.mainmodule
986 self.compiler.mainmodule = self.compiler.realmainmodule
987 var res = self.monomorphic_send(mmethod, arguments.first.mcasttype, arguments)
988 self.compiler.mainmodule = m
989 return res
990 end
991
992 var res: nullable RuntimeVariable
993 var msignature = mmethod.intro.msignature.resolve_for(mmethod.intro.mclassdef.bound_mtype, mmethod.intro.mclassdef.bound_mtype, mmethod.intro.mclassdef.mmodule, true)
994 var ret = msignature.return_mtype
995 if mmethod.is_new then
996 ret = arguments.first.mtype
997 res = self.new_var(ret)
998 else if ret == null then
999 res = null
1000 else
1001 res = self.new_var(ret)
1002 end
1003
1004 var s = new Buffer
1005 var ss = new Buffer
1006
1007 var recv = arguments.first
1008 s.append("val*")
1009 ss.append("{recv}")
1010 for i in [0..msignature.arity[ do
1011 var a = arguments[i+1]
1012 var t = msignature.mparameters[i].mtype
1013 if i == msignature.vararg_rank then
1014 t = arguments[i+1].mcasttype
1015 end
1016 s.append(", {t.ctype}")
1017 a = self.autobox(a, t)
1018 ss.append(", {a}")
1019 end
1020
1021 var consider_null = not self.compiler.modelbuilder.toolcontext.opt_no_check_other.value or mmethod.name == "==" or mmethod.name == "!="
1022 var maybenull = recv.mcasttype isa MNullableType and consider_null
1023 if maybenull then
1024 self.add("if ({recv} == NULL) \{")
1025 if mmethod.name == "==" then
1026 assert res != null
1027 var arg = arguments[1]
1028 if arg.mcasttype isa MNullableType then
1029 self.add("{res} = ({arg} == NULL);")
1030 else if arg.mcasttype isa MNullType then
1031 self.add("{res} = 1; /* is null */")
1032 else
1033 self.add("{res} = 0; /* {arg.inspect} cannot be null */")
1034 end
1035 else if mmethod.name == "!=" then
1036 assert res != null
1037 var arg = arguments[1]
1038 if arg.mcasttype isa MNullableType then
1039 self.add("{res} = ({arg} != NULL);")
1040 else if arg.mcasttype isa MNullType then
1041 self.add("{res} = 0; /* is null */")
1042 else
1043 self.add("{res} = 1; /* {arg.inspect} cannot be null */")
1044 end
1045 else
1046 self.add_abort("Reciever is null")
1047 end
1048 self.add("\} else \{")
1049 end
1050 if not self.compiler.modelbuilder.toolcontext.opt_no_shortcut_equate.value and (mmethod.name == "==" or mmethod.name == "!=") then
1051 assert res != null
1052 # Recv is not null, thus is arg is, it is easy to conclude (and respect the invariants)
1053 var arg = arguments[1]
1054 if arg.mcasttype isa MNullType then
1055 if mmethod.name == "==" then
1056 self.add("{res} = 0; /* arg is null but recv is not */")
1057 else
1058 self.add("{res} = 1; /* arg is null and recv is not */")
1059 end
1060 if maybenull then
1061 self.add("\}")
1062 end
1063 return res
1064 end
1065 end
1066
1067 var r
1068 if ret == null then r = "void" else r = ret.ctype
1069 self.require_declaration(const_color)
1070 var call = "(({r} (*)({s}))({arguments.first}->class->vft[{const_color}]))({ss}) /* {mmethod} on {arguments.first.inspect}*/"
1071
1072 if res != null then
1073 self.add("{res} = {call};")
1074 else
1075 self.add("{call};")
1076 end
1077
1078 if maybenull then
1079 self.add("\}")
1080 end
1081
1082 return res
1083 end
1084
1085 redef fun call(mmethoddef, recvtype, arguments)
1086 do
1087 var res: nullable RuntimeVariable
1088 var ret = mmethoddef.msignature.return_mtype
1089 if mmethoddef.mproperty.is_new then
1090 ret = arguments.first.mtype
1091 res = self.new_var(ret)
1092 else if ret == null then
1093 res = null
1094 else
1095 ret = ret.resolve_for(mmethoddef.mclassdef.bound_mtype, mmethoddef.mclassdef.bound_mtype, mmethoddef.mclassdef.mmodule, true)
1096 res = self.new_var(ret)
1097 end
1098
1099 if self.compiler.modelbuilder.mpropdef2npropdef.has_key(mmethoddef) and
1100 self.compiler.modelbuilder.mpropdef2npropdef[mmethoddef] isa AInternMethPropdef and
1101 not compiler.modelbuilder.toolcontext.opt_no_inline_intern.value then
1102 var frame = new Frame(self, mmethoddef, recvtype, arguments)
1103 frame.returnlabel = self.get_name("RET_LABEL")
1104 frame.returnvar = res
1105 var old_frame = self.frame
1106 self.frame = frame
1107 self.add("\{ /* Inline {mmethoddef} ({arguments.join(",")}) */")
1108 mmethoddef.compile_inside_to_c(self, arguments)
1109 self.add("{frame.returnlabel.as(not null)}:(void)0;")
1110 self.add("\}")
1111 self.frame = old_frame
1112 return res
1113 end
1114
1115 # Autobox arguments
1116 self.adapt_signature(mmethoddef, arguments)
1117
1118 self.require_declaration(mmethoddef.c_name)
1119 if res == null then
1120 self.add("{mmethoddef.c_name}({arguments.join(", ")});")
1121 return null
1122 else
1123 self.add("{res} = {mmethoddef.c_name}({arguments.join(", ")});")
1124 end
1125
1126 return res
1127 end
1128
1129 redef fun supercall(m: MMethodDef, recvtype: MClassType, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1130 do
1131 return table_send(m.mproperty, arguments, m.const_color)
1132 end
1133
1134 redef fun vararg_instance(mpropdef, recv, varargs, elttype)
1135 do
1136 # A vararg must be stored into an new array
1137 # The trick is that the dymaic type of the array may depends on the receiver
1138 # of the method (ie recv) if the static type is unresolved
1139 # This is more complex than usual because the unresolved type must not be resolved
1140 # with the current receiver (ie self).
1141 # Therefore to isolate the resolution from self, a local Frame is created.
1142 # One can see this implementation as an inlined method of the receiver whose only
1143 # job is to allocate the array
1144 var old_frame = self.frame
1145 var frame = new Frame(self, mpropdef, mpropdef.mclassdef.bound_mtype, [recv])
1146 self.frame = frame
1147 #print "required Array[{elttype}] for recv {recv.inspect}. bound=Array[{self.resolve_for(elttype, recv)}]. selfvar={frame.arguments.first.inspect}"
1148 var res = self.array_instance(varargs, elttype)
1149 self.frame = old_frame
1150 return res
1151 end
1152
1153 redef fun isset_attribute(a, recv)
1154 do
1155 self.check_recv_notnull(recv)
1156 var res = self.new_var(bool_type)
1157
1158 # What is the declared type of the attribute?
1159 var mtype = a.intro.static_mtype.as(not null)
1160 var intromclassdef = a.intro.mclassdef
1161 mtype = mtype.resolve_for(intromclassdef.bound_mtype, intromclassdef.bound_mtype, intromclassdef.mmodule, true)
1162
1163 if mtype isa MNullableType then
1164 self.add("{res} = 1; /* easy isset: {a} on {recv.inspect} */")
1165 return res
1166 end
1167
1168 self.require_declaration(a.const_color)
1169 if self.compiler.modelbuilder.toolcontext.opt_no_union_attribute.value then
1170 self.add("{res} = {recv}->attrs[{a.const_color}] != NULL; /* {a} on {recv.inspect}*/")
1171 else
1172
1173 if mtype.ctype == "val*" then
1174 self.add("{res} = {recv}->attrs[{a.const_color}].val != NULL; /* {a} on {recv.inspect} */")
1175 else
1176 self.add("{res} = 1; /* NOT YET IMPLEMENTED: isset of primitives: {a} on {recv.inspect} */")
1177 end
1178 end
1179 return res
1180 end
1181
1182 redef fun read_attribute(a, recv)
1183 do
1184 self.check_recv_notnull(recv)
1185
1186 # What is the declared type of the attribute?
1187 var ret = a.intro.static_mtype.as(not null)
1188 var intromclassdef = a.intro.mclassdef
1189 ret = ret.resolve_for(intromclassdef.bound_mtype, intromclassdef.bound_mtype, intromclassdef.mmodule, true)
1190
1191 self.require_declaration(a.const_color)
1192 if self.compiler.modelbuilder.toolcontext.opt_no_union_attribute.value then
1193 # Get the attribute or a box (ie. always a val*)
1194 var cret = self.object_type.as_nullable
1195 var res = self.new_var(cret)
1196 res.mcasttype = ret
1197
1198 self.add("{res} = {recv}->attrs[{a.const_color}]; /* {a} on {recv.inspect} */")
1199
1200 # Check for Uninitialized attribute
1201 if not ret isa MNullableType and not self.compiler.modelbuilder.toolcontext.opt_no_check_initialization.value then
1202 self.add("if ({res} == NULL) \{")
1203 self.add_abort("Uninitialized attribute {a.name}")
1204 self.add("\}")
1205 end
1206
1207 # Return the attribute or its unboxed version
1208 # Note: it is mandatory since we reuse the box on write, we do not whant that the box escapes
1209 return self.autobox(res, ret)
1210 else
1211 var res = self.new_var(ret)
1212 self.add("{res} = {recv}->attrs[{a.const_color}].{ret.ctypename}; /* {a} on {recv.inspect} */")
1213
1214 # Check for Uninitialized attribute
1215 if ret.ctype == "val*" and not ret isa MNullableType and not self.compiler.modelbuilder.toolcontext.opt_no_check_initialization.value then
1216 self.add("if ({res} == NULL) \{")
1217 self.add_abort("Uninitialized attribute {a.name}")
1218 self.add("\}")
1219 end
1220
1221 return res
1222 end
1223 end
1224
1225 redef fun write_attribute(a, recv, value)
1226 do
1227 self.check_recv_notnull(recv)
1228
1229 # What is the declared type of the attribute?
1230 var mtype = a.intro.static_mtype.as(not null)
1231 var intromclassdef = a.intro.mclassdef
1232 mtype = mtype.resolve_for(intromclassdef.bound_mtype, intromclassdef.bound_mtype, intromclassdef.mmodule, true)
1233
1234 # Adapt the value to the declared type
1235 value = self.autobox(value, mtype)
1236
1237 self.require_declaration(a.const_color)
1238 if self.compiler.modelbuilder.toolcontext.opt_no_union_attribute.value then
1239 var attr = "{recv}->attrs[{a.const_color}]"
1240 if mtype.ctype != "val*" then
1241 assert mtype isa MClassType
1242 # The attribute is primitive, thus we store it in a box
1243 # The trick is to create the box the first time then resuse the box
1244 self.add("if ({attr} != NULL) \{")
1245 self.add("((struct instance_{mtype.c_name}*){attr})->value = {value}; /* {a} on {recv.inspect} */")
1246 self.add("\} else \{")
1247 value = self.autobox(value, self.object_type.as_nullable)
1248 self.add("{attr} = {value}; /* {a} on {recv.inspect} */")
1249 self.add("\}")
1250 else
1251 # The attribute is not primitive, thus store it direclty
1252 self.add("{attr} = {value}; /* {a} on {recv.inspect} */")
1253 end
1254 else
1255 self.add("{recv}->attrs[{a.const_color}].{mtype.ctypename} = {value}; /* {a} on {recv.inspect} */")
1256 end
1257 end
1258
1259 redef fun init_instance(mtype)
1260 do
1261 self.require_declaration("NEW_{mtype.mclass.c_name}")
1262 var compiler = self.compiler
1263 if mtype isa MGenericType and mtype.need_anchor then
1264 link_unresolved_type(self.frame.mpropdef.mclassdef, mtype)
1265 var recv = self.frame.arguments.first
1266 var recv_type_info = self.type_info(recv)
1267 self.require_declaration(mtype.const_color)
1268 if compiler.modelbuilder.toolcontext.opt_phmod_typing.value or compiler.modelbuilder.toolcontext.opt_phand_typing.value then
1269 return self.new_expr("NEW_{mtype.mclass.c_name}({recv_type_info}->resolution_table->types[HASH({recv_type_info}->resolution_table->mask, {mtype.const_color})])", mtype)
1270 else
1271 return self.new_expr("NEW_{mtype.mclass.c_name}({recv_type_info}->resolution_table->types[{mtype.const_color}])", mtype)
1272 end
1273 end
1274 compiler.undead_types.add(mtype)
1275 self.require_declaration("type_{mtype.c_name}")
1276 return self.new_expr("NEW_{mtype.mclass.c_name}(&type_{mtype.c_name})", mtype)
1277 end
1278
1279 redef fun check_init_instance(value, mtype)
1280 do
1281 if self.compiler.modelbuilder.toolcontext.opt_no_check_initialization.value then return
1282 self.require_declaration("CHECK_NEW_{mtype.mclass.c_name}")
1283 self.add("CHECK_NEW_{mtype.mclass.c_name}({value});")
1284 end
1285
1286 redef fun type_test(value, mtype, tag)
1287 do
1288 self.add("/* {value.inspect} isa {mtype} */")
1289 var compiler = self.compiler
1290
1291 var recv = self.frame.arguments.first
1292 var recv_type_info = self.type_info(recv)
1293
1294 var res = self.new_var(bool_type)
1295
1296 var cltype = self.get_name("cltype")
1297 self.add_decl("int {cltype};")
1298 var idtype = self.get_name("idtype")
1299 self.add_decl("int {idtype};")
1300
1301 var maybe_null = self.maybe_null(value)
1302 var accept_null = "0"
1303 var ntype = mtype
1304 if ntype isa MNullableType then
1305 ntype = ntype.mtype
1306 accept_null = "1"
1307 end
1308
1309 if value.mcasttype.is_subtype(self.frame.mpropdef.mclassdef.mmodule, self.frame.mpropdef.mclassdef.bound_mtype, mtype) then
1310 self.add("{res} = 1; /* easy {value.inspect} isa {mtype}*/")
1311 if compiler.modelbuilder.toolcontext.opt_typing_test_metrics.value then
1312 self.compiler.count_type_test_skipped[tag] += 1
1313 self.add("count_type_test_skipped_{tag}++;")
1314 end
1315 return res
1316 end
1317
1318 if ntype.need_anchor then
1319 var type_struct = self.get_name("type_struct")
1320 self.add_decl("const struct type* {type_struct};")
1321
1322 # Either with resolution_table with a direct resolution
1323 link_unresolved_type(self.frame.mpropdef.mclassdef, ntype)
1324 self.require_declaration(ntype.const_color)
1325 if compiler.modelbuilder.toolcontext.opt_phmod_typing.value or compiler.modelbuilder.toolcontext.opt_phand_typing.value then
1326 self.add("{type_struct} = {recv_type_info}->resolution_table->types[HASH({recv_type_info}->resolution_table->mask, {ntype.const_color})];")
1327 else
1328 self.add("{type_struct} = {recv_type_info}->resolution_table->types[{ntype.const_color}];")
1329 end
1330 if compiler.modelbuilder.toolcontext.opt_typing_test_metrics.value then
1331 self.compiler.count_type_test_unresolved[tag] += 1
1332 self.add("count_type_test_unresolved_{tag}++;")
1333 end
1334 self.add("{cltype} = {type_struct}->color;")
1335 self.add("{idtype} = {type_struct}->id;")
1336 if maybe_null and accept_null == "0" then
1337 var is_nullable = self.get_name("is_nullable")
1338 self.add_decl("short int {is_nullable};")
1339 self.add("{is_nullable} = {type_struct}->is_nullable;")
1340 accept_null = is_nullable.to_s
1341 end
1342 else if ntype isa MClassType then
1343 compiler.undead_types.add(mtype)
1344 self.require_declaration("type_{mtype.c_name}")
1345 self.add("{cltype} = type_{mtype.c_name}.color;")
1346 self.add("{idtype} = type_{mtype.c_name}.id;")
1347 if compiler.modelbuilder.toolcontext.opt_typing_test_metrics.value then
1348 self.compiler.count_type_test_resolved[tag] += 1
1349 self.add("count_type_test_resolved_{tag}++;")
1350 end
1351 else
1352 self.add("printf(\"NOT YET IMPLEMENTED: type_test(%s, {mtype}).\\n\", \"{value.inspect}\"); exit(1);")
1353 end
1354
1355 # check color is in table
1356 if maybe_null then
1357 self.add("if({value} == NULL) \{")
1358 self.add("{res} = {accept_null};")
1359 self.add("\} else \{")
1360 end
1361 var value_type_info = self.type_info(value)
1362 if compiler.modelbuilder.toolcontext.opt_phmod_typing.value or compiler.modelbuilder.toolcontext.opt_phand_typing.value then
1363 self.add("{cltype} = HASH({value_type_info}->color, {idtype});")
1364 end
1365 self.add("if({cltype} >= {value_type_info}->table_size) \{")
1366 self.add("{res} = 0;")
1367 self.add("\} else \{")
1368 self.add("{res} = {value_type_info}->type_table[{cltype}] == {idtype};")
1369 self.add("\}")
1370 if maybe_null then
1371 self.add("\}")
1372 end
1373
1374 return res
1375 end
1376
1377 redef fun is_same_type_test(value1, value2)
1378 do
1379 var res = self.new_var(bool_type)
1380 # Swap values to be symetric
1381 if value2.mtype.ctype != "val*" and value1.mtype.ctype == "val*" then
1382 var tmp = value1
1383 value1 = value2
1384 value2 = tmp
1385 end
1386 if value1.mtype.ctype != "val*" then
1387 if value2.mtype == value1.mtype then
1388 self.add("{res} = 1; /* is_same_type_test: compatible types {value1.mtype} vs. {value2.mtype} */")
1389 else if value2.mtype.ctype != "val*" then
1390 self.add("{res} = 0; /* is_same_type_test: incompatible types {value1.mtype} vs. {value2.mtype}*/")
1391 else
1392 var mtype1 = value1.mtype.as(MClassType)
1393 self.require_declaration("class_{mtype1.c_name}")
1394 self.add("{res} = ({value2} != NULL) && ({value2}->class == &class_{mtype1.c_name}); /* is_same_type_test */")
1395 end
1396 else
1397 self.add("{res} = ({value1} == {value2}) || ({value1} != NULL && {value2} != NULL && {value1}->class == {value2}->class); /* is_same_type_test */")
1398 end
1399 return res
1400 end
1401
1402 redef fun class_name_string(value)
1403 do
1404 var res = self.get_name("var_class_name")
1405 self.add_decl("const char* {res};")
1406 if value.mtype.ctype == "val*" then
1407 self.add "{res} = {value} == NULL ? \"null\" : {value}->type->name;"
1408 else
1409 self.require_declaration("type_{value.mtype.c_name}")
1410 self.add "{res} = type_{value.mtype.c_name}.name;"
1411 end
1412 return res
1413 end
1414
1415 redef fun equal_test(value1, value2)
1416 do
1417 var res = self.new_var(bool_type)
1418 if value2.mtype.ctype != "val*" and value1.mtype.ctype == "val*" then
1419 var tmp = value1
1420 value1 = value2
1421 value2 = tmp
1422 end
1423 if value1.mtype.ctype != "val*" then
1424 if value2.mtype == value1.mtype then
1425 self.add("{res} = {value1} == {value2};")
1426 else if value2.mtype.ctype != "val*" then
1427 self.add("{res} = 0; /* incompatible types {value1.mtype} vs. {value2.mtype}*/")
1428 else
1429 var mtype1 = value1.mtype.as(MClassType)
1430 self.require_declaration("class_{mtype1.c_name}")
1431 self.add("{res} = ({value2} != NULL) && ({value2}->class == &class_{mtype1.c_name});")
1432 self.add("if ({res}) \{")
1433 self.add("{res} = ({self.autobox(value2, value1.mtype)} == {value1});")
1434 self.add("\}")
1435 end
1436 return res
1437 end
1438 var maybe_null = true
1439 var test = new Array[String]
1440 var t1 = value1.mcasttype
1441 if t1 isa MNullableType then
1442 test.add("{value1} != NULL")
1443 t1 = t1.mtype
1444 else
1445 maybe_null = false
1446 end
1447 var t2 = value2.mcasttype
1448 if t2 isa MNullableType then
1449 test.add("{value2} != NULL")
1450 t2 = t2.mtype
1451 else
1452 maybe_null = false
1453 end
1454
1455 var incompatible = false
1456 var primitive
1457 if t1.ctype != "val*" then
1458 primitive = t1
1459 if t1 == t2 then
1460 # No need to compare class
1461 else if t2.ctype != "val*" then
1462 incompatible = true
1463 else if can_be_primitive(value2) then
1464 test.add("{value1}->class == {value2}->class")
1465 else
1466 incompatible = true
1467 end
1468 else if t2.ctype != "val*" then
1469 primitive = t2
1470 if can_be_primitive(value1) then
1471 test.add("{value1}->class == {value2}->class")
1472 else
1473 incompatible = true
1474 end
1475 else
1476 primitive = null
1477 end
1478
1479 if incompatible then
1480 if maybe_null then
1481 self.add("{res} = {value1} == {value2}; /* incompatible types {t1} vs. {t2}; but may be NULL*/")
1482 return res
1483 else
1484 self.add("{res} = 0; /* incompatible types {t1} vs. {t2}; cannot be NULL */")
1485 return res
1486 end
1487 end
1488 if primitive != null then
1489 test.add("((struct instance_{primitive.c_name}*){value1})->value == ((struct instance_{primitive.c_name}*){value2})->value")
1490 else if can_be_primitive(value1) and can_be_primitive(value2) then
1491 test.add("{value1}->class == {value2}->class")
1492 var s = new Array[String]
1493 for t, v in self.compiler.box_kinds do
1494 s.add "({value1}->class->box_kind == {v} && ((struct instance_{t.c_name}*){value1})->value == ((struct instance_{t.c_name}*){value2})->value)"
1495 end
1496 test.add("({s.join(" || ")})")
1497 else
1498 self.add("{res} = {value1} == {value2};")
1499 return res
1500 end
1501 self.add("{res} = {value1} == {value2} || ({test.join(" && ")});")
1502 return res
1503 end
1504
1505 fun can_be_primitive(value: RuntimeVariable): Bool
1506 do
1507 var t = value.mcasttype
1508 if t isa MNullableType then t = t.mtype
1509 if not t isa MClassType then return false
1510 var k = t.mclass.kind
1511 return k == interface_kind or t.ctype != "val*"
1512 end
1513
1514 fun maybe_null(value: RuntimeVariable): Bool
1515 do
1516 var t = value.mcasttype
1517 return t isa MNullableType or t isa MNullType
1518 end
1519
1520 redef fun array_instance(array, elttype)
1521 do
1522 var nclass = self.get_class("NativeArray")
1523 var arrayclass = self.get_class("Array")
1524 var arraytype = arrayclass.get_mtype([elttype])
1525 var res = self.init_instance(arraytype)
1526 self.add("\{ /* {res} = array_instance Array[{elttype}] */")
1527 var length = self.int_instance(array.length)
1528 var nat = native_array_instance(elttype, length)
1529 for i in [0..array.length[ do
1530 var r = self.autobox(array[i], self.object_type)
1531 self.add("((struct instance_{nclass.c_name}*){nat})->values[{i}] = (val*) {r};")
1532 end
1533 self.send(self.get_property("with_native", arrayclass.intro.bound_mtype), [res, nat, length])
1534 self.check_init_instance(res, arraytype)
1535 self.add("\}")
1536 return res
1537 end
1538
1539 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable
1540 do
1541 var mtype = self.get_class("NativeArray").get_mtype([elttype])
1542 self.require_declaration("NEW_{mtype.mclass.c_name}")
1543 assert mtype isa MGenericType
1544 var compiler = self.compiler
1545 if mtype.need_anchor then
1546 link_unresolved_type(self.frame.mpropdef.mclassdef, mtype)
1547 var recv = self.frame.arguments.first
1548 var recv_type_info = self.type_info(recv)
1549 self.require_declaration(mtype.const_color)
1550 if compiler.modelbuilder.toolcontext.opt_phmod_typing.value or compiler.modelbuilder.toolcontext.opt_phand_typing.value then
1551 return self.new_expr("NEW_{mtype.mclass.c_name}({length}, {recv_type_info}->resolution_table->types[HASH({recv_type_info}->resolution_table->mask, {mtype.const_color})])", mtype)
1552 else
1553 return self.new_expr("NEW_{mtype.mclass.c_name}({length}, {recv_type_info}->resolution_table->types[{mtype.const_color}])", mtype)
1554 end
1555 end
1556 compiler.undead_types.add(mtype)
1557 self.require_declaration("type_{mtype.c_name}")
1558 return self.new_expr("NEW_{mtype.mclass.c_name}({length}, &type_{mtype.c_name})", mtype)
1559 end
1560
1561 redef fun native_array_def(pname, ret_type, arguments)
1562 do
1563 var elttype = arguments.first.mtype
1564 var nclass = self.get_class("NativeArray")
1565 var recv = "((struct instance_{nclass.c_name}*){arguments[0]})->values"
1566 if pname == "[]" then
1567 self.ret(self.new_expr("{recv}[{arguments[1]}]", ret_type.as(not null)))
1568 return
1569 else if pname == "[]=" then
1570 self.add("{recv}[{arguments[1]}]={arguments[2]};")
1571 return
1572 else if pname == "copy_to" then
1573 var recv1 = "((struct instance_{nclass.c_name}*){arguments[1]})->values"
1574 self.add("memcpy({recv1}, {recv}, {arguments[2]}*sizeof({elttype.ctype}));")
1575 return
1576 end
1577 end
1578
1579 redef fun calloc_array(ret_type, arguments)
1580 do
1581 var mclass = self.get_class("ArrayCapable")
1582 var ft = mclass.mclass_type.arguments.first.as(MParameterType)
1583 var res = self.native_array_instance(ft, arguments[1])
1584 self.ret(res)
1585 end
1586
1587 fun link_unresolved_type(mclassdef: MClassDef, mtype: MType) do
1588 assert mtype.need_anchor
1589 var compiler = self.compiler
1590 if not compiler.live_unresolved_types.has_key(self.frame.mpropdef.mclassdef) then
1591 compiler.live_unresolved_types[self.frame.mpropdef.mclassdef] = new HashSet[MType]
1592 end
1593 compiler.live_unresolved_types[self.frame.mpropdef.mclassdef].add(mtype)
1594 end
1595 end
1596
1597 redef class MMethodDef
1598 fun separate_runtime_function: AbstractRuntimeFunction
1599 do
1600 var res = self.separate_runtime_function_cache
1601 if res == null then
1602 res = new SeparateRuntimeFunction(self)
1603 self.separate_runtime_function_cache = res
1604 end
1605 return res
1606 end
1607 private var separate_runtime_function_cache: nullable SeparateRuntimeFunction
1608
1609 fun virtual_runtime_function: AbstractRuntimeFunction
1610 do
1611 var res = self.virtual_runtime_function_cache
1612 if res == null then
1613 res = new VirtualRuntimeFunction(self)
1614 self.virtual_runtime_function_cache = res
1615 end
1616 return res
1617 end
1618 private var virtual_runtime_function_cache: nullable VirtualRuntimeFunction
1619 end
1620
1621 # The C function associated to a methoddef separately compiled
1622 class SeparateRuntimeFunction
1623 super AbstractRuntimeFunction
1624
1625 redef fun build_c_name: String do return "{mmethoddef.c_name}"
1626
1627 redef fun to_s do return self.mmethoddef.to_s
1628
1629 redef fun compile_to_c(compiler)
1630 do
1631 var mmethoddef = self.mmethoddef
1632
1633 var recv = self.mmethoddef.mclassdef.bound_mtype
1634 var v = compiler.new_visitor
1635 var selfvar = new RuntimeVariable("self", recv, recv)
1636 var arguments = new Array[RuntimeVariable]
1637 var frame = new Frame(v, mmethoddef, recv, arguments)
1638 v.frame = frame
1639
1640 var msignature = mmethoddef.msignature.resolve_for(mmethoddef.mclassdef.bound_mtype, mmethoddef.mclassdef.bound_mtype, mmethoddef.mclassdef.mmodule, true)
1641
1642 var sig = new Buffer
1643 var comment = new Buffer
1644 var ret = msignature.return_mtype
1645 if ret != null then
1646 sig.append("{ret.ctype} ")
1647 else if mmethoddef.mproperty.is_new then
1648 ret = recv
1649 sig.append("{ret.ctype} ")
1650 else
1651 sig.append("void ")
1652 end
1653 sig.append(self.c_name)
1654 sig.append("({selfvar.mtype.ctype} {selfvar}")
1655 comment.append("({selfvar}: {selfvar.mtype}")
1656 arguments.add(selfvar)
1657 for i in [0..msignature.arity[ do
1658 var mtype = msignature.mparameters[i].mtype
1659 if i == msignature.vararg_rank then
1660 mtype = v.get_class("Array").get_mtype([mtype])
1661 end
1662 comment.append(", {mtype}")
1663 sig.append(", {mtype.ctype} p{i}")
1664 var argvar = new RuntimeVariable("p{i}", mtype, mtype)
1665 arguments.add(argvar)
1666 end
1667 sig.append(")")
1668 comment.append(")")
1669 if ret != null then
1670 comment.append(": {ret}")
1671 end
1672 compiler.provide_declaration(self.c_name, "{sig};")
1673
1674 v.add_decl("/* method {self} for {comment} */")
1675 v.add_decl("{sig} \{")
1676 if ret != null then
1677 frame.returnvar = v.new_var(ret)
1678 end
1679 frame.returnlabel = v.get_name("RET_LABEL")
1680
1681 if recv != arguments.first.mtype then
1682 #print "{self} {recv} {arguments.first}"
1683 end
1684 mmethoddef.compile_inside_to_c(v, arguments)
1685
1686 v.add("{frame.returnlabel.as(not null)}:;")
1687 if ret != null then
1688 v.add("return {frame.returnvar.as(not null)};")
1689 end
1690 v.add("\}")
1691 end
1692 end
1693
1694 # The C function associated to a methoddef on a primitive type, stored into a VFT of a class
1695 # The first parameter (the reciever) is always typed by val* in order to accept an object value
1696 class VirtualRuntimeFunction
1697 super AbstractRuntimeFunction
1698
1699 redef fun build_c_name: String do return "VIRTUAL_{mmethoddef.c_name}"
1700
1701 redef fun to_s do return self.mmethoddef.to_s
1702
1703 redef fun compile_to_c(compiler)
1704 do
1705 var mmethoddef = self.mmethoddef
1706
1707 var recv = self.mmethoddef.mclassdef.bound_mtype
1708 var v = compiler.new_visitor
1709 var selfvar = new RuntimeVariable("self", v.object_type, recv)
1710 var arguments = new Array[RuntimeVariable]
1711 var frame = new Frame(v, mmethoddef, recv, arguments)
1712 v.frame = frame
1713
1714 var sig = new Buffer
1715 var comment = new Buffer
1716
1717 # Because the function is virtual, the signature must match the one of the original class
1718 var intromclassdef = self.mmethoddef.mproperty.intro.mclassdef
1719 var msignature = mmethoddef.mproperty.intro.msignature.resolve_for(intromclassdef.bound_mtype, intromclassdef.bound_mtype, intromclassdef.mmodule, true)
1720 var ret = msignature.return_mtype
1721 if ret != null then
1722 sig.append("{ret.ctype} ")
1723 else if mmethoddef.mproperty.is_new then
1724 ret = recv
1725 sig.append("{ret.ctype} ")
1726 else
1727 sig.append("void ")
1728 end
1729 sig.append(self.c_name)
1730 sig.append("({selfvar.mtype.ctype} {selfvar}")
1731 comment.append("({selfvar}: {selfvar.mtype}")
1732 arguments.add(selfvar)
1733 for i in [0..msignature.arity[ do
1734 var mtype = msignature.mparameters[i].mtype
1735 if i == msignature.vararg_rank then
1736 mtype = v.get_class("Array").get_mtype([mtype])
1737 end
1738 comment.append(", {mtype}")
1739 sig.append(", {mtype.ctype} p{i}")
1740 var argvar = new RuntimeVariable("p{i}", mtype, mtype)
1741 arguments.add(argvar)
1742 end
1743 sig.append(")")
1744 comment.append(")")
1745 if ret != null then
1746 comment.append(": {ret}")
1747 end
1748 compiler.provide_declaration(self.c_name, "{sig};")
1749
1750 v.add_decl("/* method {self} for {comment} */")
1751 v.add_decl("{sig} \{")
1752 if ret != null then
1753 frame.returnvar = v.new_var(ret)
1754 end
1755 frame.returnlabel = v.get_name("RET_LABEL")
1756
1757 var subret = v.call(mmethoddef, recv, arguments)
1758 if ret != null then
1759 assert subret != null
1760 v.assign(frame.returnvar.as(not null), subret)
1761 end
1762
1763 v.add("{frame.returnlabel.as(not null)}:;")
1764 if ret != null then
1765 v.add("return {frame.returnvar.as(not null)};")
1766 end
1767 v.add("\}")
1768 end
1769
1770 # TODO ?
1771 redef fun call(v, arguments) do abort
1772 end
1773
1774 redef class MType
1775 fun const_color: String do return "COLOR_{c_name}"
1776 end
1777
1778 redef class MProperty
1779 fun const_color: String do return "COLOR_{c_name}"
1780 end
1781
1782 redef class MPropDef
1783 fun const_color: String do return "COLOR_{c_name}"
1784 end