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