1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Separate compilation of a Nit program
16 module separate_compiler
18 import abstract_compiler
20 import rapid_type_analysis
22 # Add separate compiler specific options
23 redef class ToolContext
25 var opt_separate
: OptionBool = new OptionBool("Use separate compilation", "--separate")
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 (semi-global)", "--inline-coloring-numbers")
34 # --inline-some-methods
35 var opt_inline_some_methods
: OptionBool = 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
: OptionBool = new OptionBool("Allow the separate compiler to direct call monomorph sites (semi-global)", "--direct-call-monomorph")
39 var opt_skip_dead_methods
= new OptionBool("Do not compile dead methods (semi-global)", "--skip-dead-methods")
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")
45 var opt_tables_metrics
: OptionBool = new OptionBool("Enable static size measuring of tables used for vft, typing and resolution", "--tables-metrics")
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
)
59 redef fun process_options
(args
)
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
72 var separate_compiler_phase
= new SeparateCompilerPhase(self, null)
75 class SeparateCompilerPhase
77 redef fun process_mainmodule
(mainmodule
, given_mmodules
) do
78 if not toolcontext
.opt_separate
.value
then return
80 var modelbuilder
= toolcontext
.modelbuilder
81 var analysis
= modelbuilder
.do_rapid_type_analysis
(mainmodule
)
82 modelbuilder
.run_separate_compiler
(mainmodule
, analysis
)
86 redef class ModelBuilder
87 fun run_separate_compiler
(mainmodule
: MModule, runtime_type_analysis
: nullable RapidTypeAnalysis)
90 self.toolcontext
.info
("*** GENERATING C ***", 1)
92 var compiler
= new SeparateCompiler(mainmodule
, self, runtime_type_analysis
)
93 compiler
.compile_header
95 # compile class structures
96 self.toolcontext
.info
("Property coloring", 2)
97 compiler
.new_file
("{mainmodule.name}.classes")
98 compiler
.do_property_coloring
99 for m
in mainmodule
.in_importation
.greaters
do
100 for mclass
in m
.intro_mclasses
do
101 if mclass
.kind
== abstract_kind
or mclass
.kind
== interface_kind
then continue
102 compiler
.compile_class_to_c
(mclass
)
106 # The main function of the C
107 compiler
.new_file
("{mainmodule.name}.main")
108 compiler
.compile_nitni_global_ref_functions
109 compiler
.compile_main_function
110 compiler
.compile_finalizer_function
113 for m
in mainmodule
.in_importation
.greaters
do
114 self.toolcontext
.info
("Generate C for module {m}", 2)
115 compiler
.new_file
("{m.name}.sep")
116 compiler
.compile_module_to_c
(m
)
119 # compile live & cast type structures
120 self.toolcontext
.info
("Type coloring", 2)
121 compiler
.new_file
("{mainmodule.name}.types")
122 var mtypes
= compiler
.do_type_coloring
124 compiler
.compile_type_to_c
(t
)
126 # compile remaining types structures (useless but needed for the symbol resolution at link-time)
127 for t
in compiler
.undead_types
do
128 if mtypes
.has
(t
) then continue
129 compiler
.compile_type_to_c
(t
)
132 compiler
.display_stats
135 self.toolcontext
.info
("*** END GENERATING C: {time1-time0} ***", 2)
136 write_and_make
(compiler
)
139 # Count number of invocations by VFT
140 private var nb_invok_by_tables
= 0
141 # Count number of invocations by direct call
142 private var nb_invok_by_direct
= 0
143 # Count number of invocations by inlining
144 private var nb_invok_by_inline
= 0
147 # Singleton that store the knowledge about the separate compilation process
148 class SeparateCompiler
149 super AbstractCompiler
151 redef type VISITOR: SeparateCompilerVisitor
153 # The result of the RTA (used to know live types and methods)
154 var runtime_type_analysis
: nullable RapidTypeAnalysis
156 private var undead_types
: Set[MType] = new HashSet[MType]
157 private var live_unresolved_types
: Map[MClassDef, Set[MType]] = new HashMap[MClassDef, HashSet[MType]]
159 private var type_ids
: Map[MType, Int]
160 private var type_colors
: Map[MType, Int]
161 private var opentype_colors
: Map[MType, Int]
162 protected var method_colors
: Map[PropertyLayoutElement, Int]
163 protected var attr_colors
: Map[MAttribute, Int]
165 init(mainmodule
: MModule, mmbuilder
: ModelBuilder, runtime_type_analysis
: nullable RapidTypeAnalysis) do
166 super(mainmodule
, mmbuilder
)
167 var file
= new_file
("nit.common")
168 self.header
= new CodeWriter(file
)
169 self.runtime_type_analysis
= runtime_type_analysis
170 self.compile_box_kinds
173 redef fun compile_header_structs
do
174 self.header
.add_decl
("typedef void(*nitmethod_t)(void); /* general C type representing a Nit method. */")
175 self.compile_header_attribute_structs
176 self.header
.add_decl
("struct class \{ int box_kind; nitmethod_t vft[]; \}; /* general C type representing a Nit class. */")
178 # With resolution_table_table, all live type resolution are stored in a big table: resolution_table
179 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. */")
180 self.header
.add_decl
("struct instance \{ const struct type *type; const struct class *class; nitattribute_t attrs[]; \}; /* general C type representing a Nit instance. */")
181 self.header
.add_decl
("struct types \{ int dummy; const struct type *types[]; \}; /* a list types (used for vts, fts and unresolved lists). */")
182 self.header
.add_decl
("typedef struct instance val; /* general C type representing a Nit instance. */")
185 fun compile_header_attribute_structs
187 if modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
188 self.header
.add_decl
("typedef void* nitattribute_t; /* general C type representing a Nit attribute. */")
190 self.header
.add_decl
("typedef union \{")
191 self.header
.add_decl
("void* val;")
192 for c
, v
in self.box_kinds
do
193 var t
= c
.mclass_type
194 self.header
.add_decl
("{t.ctype} {t.ctypename};")
196 self.header
.add_decl
("\} nitattribute_t; /* general C type representing a Nit attribute. */")
200 fun compile_box_kinds
202 # Collect all bas box class
203 # FIXME: this is not completely fine with a separate compilation scheme
204 for classname
in ["Int", "Bool", "Char", "Float", "NativeString", "Pointer"] do
205 var classes
= self.mainmodule
.model
.get_mclasses_by_name
(classname
)
206 if classes
== null then continue
207 assert classes
.length
== 1 else print classes
.join
(", ")
208 self.box_kinds
[classes
.first
] = self.box_kinds
.length
+ 1
212 var box_kinds
= new HashMap[MClass, Int]
214 fun box_kind_of
(mclass
: MClass): Int
216 if mclass
.mclass_type
.ctype
== "val*" then
218 else if mclass
.kind
== extern_kind
then
219 return self.box_kinds
[self.mainmodule
.get_primitive_class
("Pointer")]
221 return self.box_kinds
[mclass
]
226 fun compile_color_consts
(colors
: Map[Object, Int]) do
228 for m
, c
in colors
do
229 compile_color_const
(v
, m
, c
)
233 fun compile_color_const
(v
: SeparateCompilerVisitor, m
: Object, color
: Int) do
234 if color_consts_done
.has
(m
) then return
235 if m
isa MProperty then
236 if modelbuilder
.toolcontext
.opt_inline_coloring_numbers
.value
then
237 self.provide_declaration
(m
.const_color
, "#define {m.const_color} {color}")
239 self.provide_declaration
(m
.const_color
, "extern const int {m.const_color};")
240 v
.add
("const int {m.const_color} = {color};")
242 else if m
isa MPropDef then
243 if modelbuilder
.toolcontext
.opt_inline_coloring_numbers
.value
then
244 self.provide_declaration
(m
.const_color
, "#define {m.const_color} {color}")
246 self.provide_declaration
(m
.const_color
, "extern const int {m.const_color};")
247 v
.add
("const int {m.const_color} = {color};")
249 else if m
isa MType then
250 if modelbuilder
.toolcontext
.opt_inline_coloring_numbers
.value
then
251 self.provide_declaration
(m
.const_color
, "#define {m.const_color} {color}")
253 self.provide_declaration
(m
.const_color
, "extern const int {m.const_color};")
254 v
.add
("const int {m.const_color} = {color};")
257 color_consts_done
.add
(m
)
260 private var color_consts_done
= new HashSet[Object]
262 # colorize classe properties
263 fun do_property_coloring
do
265 var rta
= runtime_type_analysis
268 var poset
= mainmodule
.flatten_mclass_hierarchy
269 var mclasses
= new HashSet[MClass].from
(poset
)
270 var colorer
= new POSetColorer[MClass]
271 colorer
.colorize
(poset
)
273 # The dead methods, still need to provide a dead color symbol
274 var dead_methods
= new Array[MMethod]
276 # lookup properties to build layout with
277 var mmethods
= new HashMap[MClass, Set[PropertyLayoutElement]]
278 var mattributes
= new HashMap[MClass, Set[MAttribute]]
279 for mclass
in mclasses
do
280 mmethods
[mclass
] = new HashSet[PropertyLayoutElement]
281 mattributes
[mclass
] = new HashSet[MAttribute]
282 for mprop
in self.mainmodule
.properties
(mclass
) do
283 if mprop
isa MMethod then
284 if not modelbuilder
.toolcontext
.opt_colo_dead_methods
.value
and rta
!= null and not rta
.live_methods
.has
(mprop
) then
285 dead_methods
.add
(mprop
)
288 mmethods
[mclass
].add
(mprop
)
289 else if mprop
isa MAttribute then
290 mattributes
[mclass
].add
(mprop
)
295 # Collect all super calls (dead or not)
296 var all_super_calls
= new HashSet[MMethodDef]
297 for mmodule
in self.mainmodule
.in_importation
.greaters
do
298 for mclassdef
in mmodule
.mclassdefs
do
299 for mpropdef
in mclassdef
.mpropdefs
do
300 if not mpropdef
isa MMethodDef then continue
301 if mpropdef
.has_supercall
then
302 all_super_calls
.add
(mpropdef
)
308 # lookup super calls and add it to the list of mmethods to build layout with
311 super_calls
= rta
.live_super_sends
313 super_calls
= all_super_calls
316 for mmethoddef
in super_calls
do
317 var mclass
= mmethoddef
.mclassdef
.mclass
318 mmethods
[mclass
].add
(mmethoddef
)
319 for descendant
in mclass
.in_hierarchy
(self.mainmodule
).smallers
do
320 mmethods
[descendant
].add
(mmethoddef
)
325 var meth_colorer
= new POSetBucketsColorer[MClass, PropertyLayoutElement](poset
, colorer
.conflicts
)
326 method_colors
= meth_colorer
.colorize
(mmethods
)
327 method_tables
= build_method_tables
(mclasses
, super_calls
)
328 compile_color_consts
(method_colors
)
330 # attribute null color to dead methods and supercalls
331 for mproperty
in dead_methods
do
332 compile_color_const
(new_visitor
, mproperty
, -1)
334 for mpropdef
in all_super_calls
do
335 if super_calls
.has
(mpropdef
) then continue
336 compile_color_const
(new_visitor
, mpropdef
, -1)
339 # attributes coloration
340 var attr_colorer
= new POSetBucketsColorer[MClass, MAttribute](poset
, colorer
.conflicts
)
341 attr_colors
= attr_colorer
.colorize
(mattributes
)
342 attr_tables
= build_attr_tables
(mclasses
)
343 compile_color_consts
(attr_colors
)
346 fun build_method_tables
(mclasses
: Set[MClass], super_calls
: Set[MMethodDef]): Map[MClass, Array[nullable MPropDef]] do
347 var tables
= new HashMap[MClass, Array[nullable MPropDef]]
348 for mclass
in mclasses
do
349 var table
= new Array[nullable MPropDef]
350 tables
[mclass
] = table
352 var mproperties
= self.mainmodule
.properties
(mclass
)
353 var mtype
= mclass
.intro
.bound_mtype
355 for mproperty
in mproperties
do
356 if not mproperty
isa MMethod then continue
357 if not method_colors
.has_key
(mproperty
) then continue
358 var color
= method_colors
[mproperty
]
359 if table
.length
<= color
then
360 for i
in [table
.length
.. color
[ do
364 table
[color
] = mproperty
.lookup_first_definition
(mainmodule
, mtype
)
367 for supercall
in super_calls
do
368 if not mtype
.collect_mclassdefs
(mainmodule
).has
(supercall
.mclassdef
) then continue
370 var color
= method_colors
[supercall
]
371 if table
.length
<= color
then
372 for i
in [table
.length
.. color
[ do
376 var mmethoddef
= supercall
.lookup_next_definition
(mainmodule
, mtype
)
377 table
[color
] = mmethoddef
384 fun build_attr_tables
(mclasses
: Set[MClass]): Map[MClass, Array[nullable MPropDef]] do
385 var tables
= new HashMap[MClass, Array[nullable MPropDef]]
386 for mclass
in mclasses
do
387 var table
= new Array[nullable MPropDef]
388 tables
[mclass
] = table
390 var mproperties
= self.mainmodule
.properties
(mclass
)
391 var mtype
= mclass
.intro
.bound_mtype
393 for mproperty
in mproperties
do
394 if not mproperty
isa MAttribute then continue
395 if not attr_colors
.has_key
(mproperty
) then continue
396 var color
= attr_colors
[mproperty
]
397 if table
.length
<= color
then
398 for i
in [table
.length
.. color
[ do
402 table
[color
] = mproperty
.lookup_first_definition
(mainmodule
, mtype
)
408 # colorize live types of the program
409 private fun do_type_coloring
: POSet[MType] do
410 # Collect types to colorize
411 var live_types
= runtime_type_analysis
.live_types
412 var live_cast_types
= runtime_type_analysis
.live_cast_types
413 var mtypes
= new HashSet[MType]
414 mtypes
.add_all
(live_types
)
415 mtypes
.add_all
(live_cast_types
)
416 for c
in self.box_kinds
.keys
do
417 mtypes
.add
(c
.mclass_type
)
421 var poset
= poset_from_mtypes
(mtypes
)
422 var colorer
= new POSetColorer[MType]
423 colorer
.colorize
(poset
)
424 type_ids
= colorer
.ids
425 type_colors
= colorer
.colors
426 type_tables
= build_type_tables
(poset
)
428 # VT and FT are stored with other unresolved types in the big resolution_tables
429 self.compile_resolution_tables
(mtypes
)
434 private fun poset_from_mtypes
(mtypes
: Set[MType]): POSet[MType] do
435 var poset
= new POSet[MType]
439 if e
== o
then continue
440 if e
.is_subtype
(mainmodule
, null, o
) then
449 fun build_type_tables
(mtypes
: POSet[MType]): Map[MType, Array[nullable MType]] do
450 var tables
= new HashMap[MType, Array[nullable MType]]
451 for mtype
in mtypes
do
452 var table
= new Array[nullable MType]
453 for sup
in mtypes
[mtype
].greaters
do
454 var color
= type_colors
[sup
]
455 if table
.length
<= color
then
456 for i
in [table
.length
.. color
[ do
462 tables
[mtype
] = table
467 protected fun compile_resolution_tables
(mtypes
: Set[MType]) do
468 # resolution_tables is used to perform a type resolution at runtime in O(1)
470 # During the visit of the body of classes, live_unresolved_types are collected
472 # Collect all live_unresolved_types (visited in the body of classes)
474 # Determinate fo each livetype what are its possible requested anchored types
475 var mtype2unresolved
= new HashMap[MClassType, Set[MType]]
476 for mtype
in self.runtime_type_analysis
.live_types
do
477 var set
= new HashSet[MType]
478 for cd
in mtype
.collect_mclassdefs
(self.mainmodule
) do
479 if self.live_unresolved_types
.has_key
(cd
) then
480 set
.add_all
(self.live_unresolved_types
[cd
])
483 mtype2unresolved
[mtype
] = set
486 # Compute the table layout with the prefered method
487 var colorer
= new BucketsColorer[MType, MType]
488 opentype_colors
= colorer
.colorize
(mtype2unresolved
)
489 resolution_tables
= self.build_resolution_tables
(mtype2unresolved
)
491 # Compile a C constant for each collected unresolved type.
492 # Either to a color, or to -1 if the unresolved type is dead (no live receiver can require it)
493 var all_unresolved
= new HashSet[MType]
494 for t
in self.live_unresolved_types
.values
do
495 all_unresolved
.add_all
(t
)
497 var all_unresolved_types_colors
= new HashMap[MType, Int]
498 for t
in all_unresolved
do
499 if opentype_colors
.has_key
(t
) then
500 all_unresolved_types_colors
[t
] = opentype_colors
[t
]
502 all_unresolved_types_colors
[t
] = -1
505 self.compile_color_consts
(all_unresolved_types_colors
)
508 #for k, v in unresolved_types_tables.as(not null) do
509 # print "{k}: {v.join(", ")}"
514 fun build_resolution_tables
(elements
: Map[MClassType, Set[MType]]): Map[MClassType, Array[nullable MType]] do
515 var tables
= new HashMap[MClassType, Array[nullable MType]]
516 for mclasstype
, mtypes
in elements
do
517 var table
= new Array[nullable MType]
518 for mtype
in mtypes
do
519 var color
= opentype_colors
[mtype
]
520 if table
.length
<= color
then
521 for i
in [table
.length
.. color
[ do
527 tables
[mclasstype
] = table
532 # Separately compile all the method definitions of the module
533 fun compile_module_to_c
(mmodule
: MModule)
535 var old_module
= self.mainmodule
536 self.mainmodule
= mmodule
537 for cd
in mmodule
.mclassdefs
do
538 for pd
in cd
.mpropdefs
do
539 if not pd
isa MMethodDef then continue
540 var rta
= runtime_type_analysis
541 if modelbuilder
.toolcontext
.opt_skip_dead_methods
.value
and rta
!= null and not rta
.live_methoddefs
.has
(pd
) then continue
542 #print "compile {pd} @ {cd} @ {mmodule}"
543 var r
= pd
.separate_runtime_function
545 var r2
= pd
.virtual_runtime_function
546 r2
.compile_to_c
(self)
549 self.mainmodule
= old_module
552 # Globaly compile the type structure of a live type
553 fun compile_type_to_c
(mtype
: MType)
555 assert not mtype
.need_anchor
556 var is_live
= mtype
isa MClassType and runtime_type_analysis
.live_types
.has
(mtype
)
557 var is_cast_live
= runtime_type_analysis
.live_cast_types
.has
(mtype
)
558 var c_name
= mtype
.c_name
559 var v
= new SeparateCompilerVisitor(self)
560 v
.add_decl
("/* runtime type {mtype} */")
562 # extern const struct type_X
563 self.provide_declaration
("type_{c_name}", "extern const struct type type_{c_name};")
565 # const struct type_X
566 v
.add_decl
("const struct type type_{c_name} = \{")
568 # type id (for cast target)
570 v
.add_decl
("{type_ids[mtype]},")
572 v
.add_decl
("-1, /*CAST DEAD*/")
576 v
.add_decl
("\"{mtype}\
", /* class_name_string */")
578 # type color (for cast target)
580 v
.add_decl
("{type_colors[mtype]},")
582 v
.add_decl
("-1, /*CAST DEAD*/")
586 if mtype
isa MNullableType then
592 # resolution table (for receiver)
594 var mclass_type
= mtype
.as_notnullable
595 assert mclass_type
isa MClassType
596 if resolution_tables
[mclass_type
].is_empty
then
597 v
.add_decl
("NULL, /*NO RESOLUTIONS*/")
599 compile_type_resolution_table
(mtype
)
600 v
.require_declaration
("resolution_table_{c_name}")
601 v
.add_decl
("&resolution_table_{c_name},")
604 v
.add_decl
("NULL, /*DEAD*/")
607 # cast table (for receiver)
609 v
.add_decl
("{self.type_tables[mtype].length},")
611 for stype
in self.type_tables
[mtype
] do
612 if stype
== null then
613 v
.add_decl
("-1, /* empty */")
615 v
.add_decl
("{type_ids[stype]}, /* {stype} */")
620 v
.add_decl
("0, \{\}, /*DEAD TYPE*/")
625 fun compile_type_resolution_table
(mtype
: MType) do
627 var mclass_type
= mtype
.as_notnullable
.as(MClassType)
629 # extern const struct resolution_table_X resolution_table_X
630 self.provide_declaration
("resolution_table_{mtype.c_name}", "extern const struct types resolution_table_{mtype.c_name};")
632 # const struct fts_table_X fts_table_X
634 v
.add_decl
("const struct types resolution_table_{mtype.c_name} = \{")
635 v
.add_decl
("0, /* dummy */")
637 for t
in self.resolution_tables
[mclass_type
] do
639 v
.add_decl
("NULL, /* empty */")
641 # The table stores the result of the type resolution
642 # Therefore, for a receiver `mclass_type`, and a unresolved type `t`
643 # the value stored is tv.
644 var tv
= t
.resolve_for
(mclass_type
, mclass_type
, self.mainmodule
, true)
645 # FIXME: What typeids means here? How can a tv not be live?
646 if type_ids
.has_key
(tv
) then
647 v
.require_declaration
("type_{tv.c_name}")
648 v
.add_decl
("&type_{tv.c_name}, /* {t}: {tv} */")
650 v
.add_decl
("NULL, /* empty ({t}: {tv} not a live type) */")
658 # Globally compile the table of the class mclass
659 # In a link-time optimisation compiler, tables are globally computed
660 # In a true separate compiler (a with dynamic loading) you cannot do this unfortnally
661 fun compile_class_to_c
(mclass
: MClass)
663 var mtype
= mclass
.intro
.bound_mtype
664 var c_name
= mclass
.c_name
665 var c_instance_name
= mclass
.c_instance_name
667 var vft
= self.method_tables
[mclass
]
668 var attrs
= self.attr_tables
[mclass
]
671 var rta
= runtime_type_analysis
672 var is_dead
= rta
!= null and not rta
.live_classes
.has
(mclass
) and mtype
.ctype
== "val*" and mclass
.name
!= "NativeArray"
674 v
.add_decl
("/* runtime class {c_name} */")
678 self.provide_declaration
("class_{c_name}", "extern const struct class class_{c_name};")
679 v
.add_decl
("const struct class class_{c_name} = \{")
680 v
.add_decl
("{self.box_kind_of(mclass)}, /* box_kind */")
682 for i
in [0 .. vft
.length
[ do
683 var mpropdef
= vft
[i
]
684 if mpropdef
== null then
685 v
.add_decl
("NULL, /* empty */")
687 assert mpropdef
isa MMethodDef
688 if rta
!= null and not rta
.live_methoddefs
.has
(mpropdef
) then
689 v
.add_decl
("NULL, /* DEAD {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
692 var rf
= mpropdef
.virtual_runtime_function
693 v
.require_declaration
(rf
.c_name
)
694 v
.add_decl
("(nitmethod_t){rf.c_name}, /* pointer to {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
701 if mtype
.ctype
!= "val*" then
702 if mtype
.mclass
.name
== "Pointer" or mtype
.mclass
.kind
!= extern_kind
then
703 #Build instance struct
704 self.header
.add_decl
("struct instance_{c_instance_name} \{")
705 self.header
.add_decl
("const struct type *type;")
706 self.header
.add_decl
("const struct class *class;")
707 self.header
.add_decl
("{mtype.ctype} value;")
708 self.header
.add_decl
("\};")
711 if not rta
.live_types
.has
(mtype
) then return
714 self.provide_declaration
("BOX_{c_name}", "val* BOX_{c_name}({mtype.ctype});")
715 v
.add_decl
("/* allocate {mtype} */")
716 v
.add_decl
("val* BOX_{mtype.c_name}({mtype.ctype} value) \{")
717 v
.add
("struct instance_{c_instance_name}*res = nit_alloc(sizeof(struct instance_{c_instance_name}));")
718 v
.require_declaration
("type_{c_name}")
719 v
.add
("res->type = &type_{c_name};")
720 v
.require_declaration
("class_{c_name}")
721 v
.add
("res->class = &class_{c_name};")
722 v
.add
("res->value = value;")
723 v
.add
("return (val*)res;")
726 else if mclass
.name
== "NativeArray" then
727 #Build instance struct
728 self.header
.add_decl
("struct instance_{c_instance_name} \{")
729 self.header
.add_decl
("const struct type *type;")
730 self.header
.add_decl
("const struct class *class;")
731 # NativeArrays are just a instance header followed by a length and an array of values
732 self.header
.add_decl
("int length;")
733 self.header
.add_decl
("val* values[0];")
734 self.header
.add_decl
("\};")
737 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(int length, const struct type* type);")
738 v
.add_decl
("/* allocate {mtype} */")
739 v
.add_decl
("{mtype.ctype} NEW_{c_name}(int length, const struct type* type) \{")
740 var res
= v
.get_name
("self")
741 v
.add_decl
("struct instance_{c_instance_name} *{res};")
742 var mtype_elt
= mtype
.arguments
.first
743 v
.add
("{res} = nit_alloc(sizeof(struct instance_{c_instance_name}) + length*sizeof({mtype_elt.ctype}));")
744 v
.add
("{res}->type = type;")
745 hardening_live_type
(v
, "type")
746 v
.require_declaration
("class_{c_name}")
747 v
.add
("{res}->class = &class_{c_name};")
748 v
.add
("{res}->length = length;")
749 v
.add
("return (val*){res};")
755 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(const struct type* type);")
756 v
.add_decl
("/* allocate {mtype} */")
757 v
.add_decl
("{mtype.ctype} NEW_{c_name}(const struct type* type) \{")
759 v
.add_abort
("{mclass} is DEAD")
761 var res
= v
.new_named_var
(mtype
, "self")
763 v
.add
("{res} = nit_alloc(sizeof(struct instance) + {attrs.length}*sizeof(nitattribute_t));")
764 v
.add
("{res}->type = type;")
765 hardening_live_type
(v
, "type")
766 v
.require_declaration
("class_{c_name}")
767 v
.add
("{res}->class = &class_{c_name};")
768 self.generate_init_attr
(v
, res
, mtype
)
770 v
.add
("return {res};")
775 # Add a dynamic test to ensure that the type referenced by `t` is a live type
776 fun hardening_live_type
(v
: VISITOR, t
: String)
778 if not v
.compiler
.modelbuilder
.toolcontext
.opt_hardening
.value
then return
779 v
.add
("if({t} == NULL) \{")
780 v
.add_abort
("type null")
782 v
.add
("if({t}->table_size == 0) \{")
783 v
.add
("PRINT_ERROR(\"Insantiation of a dead
type: %s\\n\
", {t}->name);")
784 v
.add_abort
("type dead")
788 redef fun new_visitor
do return new SeparateCompilerVisitor(self)
792 private var type_tables
: Map[MType, Array[nullable MType]] = new HashMap[MType, Array[nullable MType]]
793 private var resolution_tables
: Map[MClassType, Array[nullable MType]] = new HashMap[MClassType, Array[nullable MType]]
794 protected var method_tables
: Map[MClass, Array[nullable MPropDef]] = new HashMap[MClass, Array[nullable MPropDef]]
795 protected var attr_tables
: Map[MClass, Array[nullable MPropDef]] = new HashMap[MClass, Array[nullable MPropDef]]
797 redef fun display_stats
800 if self.modelbuilder
.toolcontext
.opt_tables_metrics
.value
then
803 if self.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
806 var tc
= self.modelbuilder
.toolcontext
807 tc
.info
("# implementation of method invocation",2)
808 var nb_invok_total
= modelbuilder
.nb_invok_by_tables
+ modelbuilder
.nb_invok_by_direct
+ modelbuilder
.nb_invok_by_inline
809 tc
.info
("total number of invocations: {nb_invok_total}",2)
810 tc
.info
("invocations by VFT send: {modelbuilder.nb_invok_by_tables} ({div(modelbuilder.nb_invok_by_tables,nb_invok_total)}%)",2)
811 tc
.info
("invocations by direct call: {modelbuilder.nb_invok_by_direct} ({div(modelbuilder.nb_invok_by_direct,nb_invok_total)}%)",2)
812 tc
.info
("invocations by inlining: {modelbuilder.nb_invok_by_inline} ({div(modelbuilder.nb_invok_by_inline,nb_invok_total)}%)",2)
817 print
"# size of subtyping tables"
818 print
"\ttotal \tholes"
821 for t
, table
in type_tables
do
822 total
+= table
.length
823 for e
in table
do if e
== null then holes
+= 1
825 print
"\t{total}\t{holes}"
827 print
"# size of resolution tables"
828 print
"\ttotal \tholes"
831 for t
, table
in resolution_tables
do
832 total
+= table
.length
833 for e
in table
do if e
== null then holes
+= 1
835 print
"\t{total}\t{holes}"
837 print
"# size of methods tables"
838 print
"\ttotal \tholes"
841 for t
, table
in method_tables
do
842 total
+= table
.length
843 for e
in table
do if e
== null then holes
+= 1
845 print
"\t{total}\t{holes}"
847 print
"# size of attributes tables"
848 print
"\ttotal \tholes"
851 for t
, table
in attr_tables
do
852 total
+= table
.length
853 for e
in table
do if e
== null then holes
+= 1
855 print
"\t{total}\t{holes}"
858 protected var isset_checks_count
= 0
859 protected var attr_read_count
= 0
861 fun display_isset_checks
do
862 print
"# total number of compiled attribute reads"
863 print
"\t{attr_read_count}"
864 print
"# total number of compiled isset-checks"
865 print
"\t{isset_checks_count}"
868 redef fun compile_nitni_structs
870 self.header
.add_decl
"""
871 struct nitni_instance \{
872 struct nitni_instance *next,
873 *prev; /* adjacent global references in global list */
874 int count; /* number of time this global reference has been marked */
875 struct instance *value;
881 redef fun finalize_ffi_for_module
(mmodule
)
883 var old_module
= self.mainmodule
884 self.mainmodule
= mmodule
886 self.mainmodule
= old_module
890 # A visitor on the AST of property definition that generate the C code of a separate compilation process.
891 class SeparateCompilerVisitor
892 super AbstractCompilerVisitor
894 redef type COMPILER: SeparateCompiler
896 redef fun adapt_signature
(m
, args
)
898 var msignature
= m
.msignature
.resolve_for
(m
.mclassdef
.bound_mtype
, m
.mclassdef
.bound_mtype
, m
.mclassdef
.mmodule
, true)
899 var recv
= args
.first
900 if recv
.mtype
.ctype
!= m
.mclassdef
.mclass
.mclass_type
.ctype
then
901 args
.first
= self.autobox
(args
.first
, m
.mclassdef
.mclass
.mclass_type
)
903 for i
in [0..msignature
.arity
[ do
904 var t
= msignature
.mparameters
[i
].mtype
905 if i
== msignature
.vararg_rank
then
908 args
[i
+1] = self.autobox
(args
[i
+1], t
)
912 redef fun autobox
(value
, mtype
)
914 if value
.mtype
== mtype
then
916 else if value
.mtype
.ctype
== "val*" and mtype
.ctype
== "val*" then
918 else if value
.mtype
.ctype
== "val*" then
919 return self.new_expr
("((struct instance_{mtype.c_instance_name}*){value})->value; /* autounbox from {value.mtype} to {mtype} */", mtype
)
920 else if mtype
.ctype
== "val*" then
921 var valtype
= value
.mtype
.as(MClassType)
922 var res
= self.new_var
(mtype
)
923 if compiler
.runtime_type_analysis
!= null and not compiler
.runtime_type_analysis
.live_types
.has
(valtype
) then
924 self.add
("/*no autobox from {value.mtype} to {mtype}: {value.mtype} is not live! */")
925 self.add
("PRINT_ERROR(\"Dead code executed
!\\n\
"); show_backtrace(1);")
928 self.require_declaration
("BOX_{valtype.c_name}")
929 self.add
("{res} = BOX_{valtype.c_name}({value}); /* autobox from {value.mtype} to {mtype} */")
931 else if (value
.mtype
.ctype
== "void*" and mtype
.ctype
== "void*") or
932 (value
.mtype
.ctype
== "char*" and mtype
.ctype
== "void*") or
933 (value
.mtype
.ctype
== "void*" and mtype
.ctype
== "char*") then
936 # Bad things will appen!
937 var res
= self.new_var
(mtype
)
938 self.add
("/* {res} left unintialized (cannot convert {value.mtype} to {mtype}) */")
939 self.add
("PRINT_ERROR(\"Cast error
: Cannot cast
%s to
%s
.\\n\
", \"{value.mtype}\
", \"{mtype}\
"); show_backtrace(1);")
944 # Return a C expression returning the runtime type structure of the value
945 # The point of the method is to works also with primitives types.
946 fun type_info
(value
: RuntimeVariable): String
948 if value
.mtype
.ctype
== "val*" then
949 return "{value}->type"
951 compiler
.undead_types
.add
(value
.mtype
)
952 self.require_declaration
("type_{value.mtype.c_name}")
953 return "(&type_{value.mtype.c_name})"
957 redef fun compile_callsite
(callsite
, args
)
959 var rta
= compiler
.runtime_type_analysis
960 var recv
= args
.first
.mtype
961 var mmethod
= callsite
.mproperty
962 # TODO: Inlining of new-style constructors
963 if compiler
.modelbuilder
.toolcontext
.opt_direct_call_monomorph
.value
and rta
!= null and not mmethod
.is_root_init
then
964 var tgs
= rta
.live_targets
(callsite
)
965 if tgs
.length
== 1 then
967 self.varargize
(mmethod
.intro
, mmethod
.intro
.msignature
.as(not null), args
)
968 var res0
= before_send
(mmethod
, args
)
969 var res
= call
(tgs
.first
, tgs
.first
.mclassdef
.bound_mtype
, args
)
972 self.assign
(res0
, res
)
975 add
("\}") # close the before_send
981 redef fun send
(mmethod
, arguments
)
983 self.varargize
(mmethod
.intro
, mmethod
.intro
.msignature
.as(not null), arguments
)
985 if arguments
.first
.mcasttype
.ctype
!= "val*" then
986 # In order to shortcut the primitive, we need to find the most specific method
987 # Howverr, because of performance (no flattening), we always work on the realmainmodule
988 var m
= self.compiler
.mainmodule
989 self.compiler
.mainmodule
= self.compiler
.realmainmodule
990 var res
= self.monomorphic_send
(mmethod
, arguments
.first
.mcasttype
, arguments
)
991 self.compiler
.mainmodule
= m
995 return table_send
(mmethod
, arguments
, mmethod
.const_color
)
998 # Handel common special cases before doing the effective method invocation
999 # This methods handle the `==` and `!=` methods and the case of the null receiver.
1000 # Note: a { is open in the generated C, that enclose and protect the effective method invocation.
1001 # Client must not forget to close the } after them.
1003 # The value returned is the result of the common special cases.
1004 # If not null, client must compine it with the result of their own effective method invocation.
1006 # If `before_send` can shortcut the whole message sending, a dummy `if(0){`
1007 # is generated to cancel the effective method invocation that will follow
1008 # TODO: find a better approach
1009 private fun before_send
(mmethod
: MMethod, arguments
: Array[RuntimeVariable]): nullable RuntimeVariable
1011 var res
: nullable RuntimeVariable = null
1012 var recv
= arguments
.first
1013 var consider_null
= not self.compiler
.modelbuilder
.toolcontext
.opt_no_check_null
.value
or mmethod
.name
== "==" or mmethod
.name
== "!="
1014 var maybenull
= recv
.mcasttype
isa MNullableType and consider_null
1016 self.add
("if ({recv} == NULL) \{")
1017 if mmethod
.name
== "==" then
1018 res
= self.new_var
(bool_type
)
1019 var arg
= arguments
[1]
1020 if arg
.mcasttype
isa MNullableType then
1021 self.add
("{res} = ({arg} == NULL);")
1022 else if arg
.mcasttype
isa MNullType then
1023 self.add
("{res} = 1; /* is null */")
1025 self.add
("{res} = 0; /* {arg.inspect} cannot be null */")
1027 else if mmethod
.name
== "!=" then
1028 res
= self.new_var
(bool_type
)
1029 var arg
= arguments
[1]
1030 if arg
.mcasttype
isa MNullableType then
1031 self.add
("{res} = ({arg} != NULL);")
1032 else if arg
.mcasttype
isa MNullType then
1033 self.add
("{res} = 0; /* is null */")
1035 self.add
("{res} = 1; /* {arg.inspect} cannot be null */")
1038 self.add_abort
("Receiver is null")
1040 self.add
("\} else \{")
1044 if not self.compiler
.modelbuilder
.toolcontext
.opt_no_shortcut_equate
.value
and (mmethod
.name
== "==" or mmethod
.name
== "!=") then
1045 if res
== null then res
= self.new_var
(bool_type
)
1046 # Recv is not null, thus is arg is, it is easy to conclude (and respect the invariants)
1047 var arg
= arguments
[1]
1048 if arg
.mcasttype
isa MNullType then
1049 if mmethod
.name
== "==" then
1050 self.add
("{res} = 0; /* arg is null but recv is not */")
1052 self.add
("{res} = 1; /* arg is null and recv is not */")
1054 self.add
("\}") # closes the null case
1055 self.add
("if (0) \{") # what follow is useless, CC will drop it
1061 private fun table_send
(mmethod
: MMethod, arguments
: Array[RuntimeVariable], const_color
: String): nullable RuntimeVariable
1063 compiler
.modelbuilder
.nb_invok_by_tables
+= 1
1064 if compiler
.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then add
("count_invoke_by_tables++;")
1066 assert arguments
.length
== mmethod
.intro
.msignature
.arity
+ 1 else debug
("Invalid arity for {mmethod}. {arguments.length} arguments given.")
1067 var recv
= arguments
.first
1069 var res0
= before_send
(mmethod
, arguments
)
1071 var res
: nullable RuntimeVariable
1072 var msignature
= mmethod
.intro
.msignature
.resolve_for
(mmethod
.intro
.mclassdef
.bound_mtype
, mmethod
.intro
.mclassdef
.bound_mtype
, mmethod
.intro
.mclassdef
.mmodule
, true)
1073 var ret
= msignature
.return_mtype
1074 if mmethod
.is_new
then
1075 ret
= arguments
.first
.mtype
1076 res
= self.new_var
(ret
)
1077 else if ret
== null then
1080 res
= self.new_var
(ret
)
1083 var s
= new FlatBuffer
1084 var ss
= new FlatBuffer
1088 for i
in [0..msignature
.arity
[ do
1089 var a
= arguments
[i
+1]
1090 var t
= msignature
.mparameters
[i
].mtype
1091 if i
== msignature
.vararg_rank
then
1092 t
= arguments
[i
+1].mcasttype
1094 s
.append
(", {t.ctype}")
1095 a
= self.autobox
(a
, t
)
1101 if ret
== null then r
= "void" else r
= ret
.ctype
1102 self.require_declaration
(const_color
)
1103 var call
= "(({r} (*)({s}))({arguments.first}->class->vft[{const_color}]))({ss}) /* {mmethod} on {arguments.first.inspect}*/"
1106 self.add
("{res} = {call};")
1111 if res0
!= null then
1117 self.add
("\}") # closes the null case
1122 redef fun call
(mmethoddef
, recvtype
, arguments
)
1124 assert arguments
.length
== mmethoddef
.msignature
.arity
+ 1 else debug
("Invalid arity for {mmethoddef}. {arguments.length} arguments given.")
1126 var res
: nullable RuntimeVariable
1127 var ret
= mmethoddef
.msignature
.return_mtype
1128 if mmethoddef
.mproperty
.is_new
then
1129 ret
= arguments
.first
.mtype
1130 res
= self.new_var
(ret
)
1131 else if ret
== null then
1134 ret
= ret
.resolve_for
(mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.mmodule
, true)
1135 res
= self.new_var
(ret
)
1138 if (mmethoddef
.is_intern
and not compiler
.modelbuilder
.toolcontext
.opt_no_inline_intern
.value
) or
1139 (compiler
.modelbuilder
.toolcontext
.opt_inline_some_methods
.value
and mmethoddef
.can_inline
(self)) then
1140 compiler
.modelbuilder
.nb_invok_by_inline
+= 1
1141 if compiler
.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then add
("count_invoke_by_inline++;")
1142 var frame
= new Frame(self, mmethoddef
, recvtype
, arguments
)
1143 frame
.returnlabel
= self.get_name
("RET_LABEL")
1144 frame
.returnvar
= res
1145 var old_frame
= self.frame
1147 self.add
("\{ /* Inline {mmethoddef} ({arguments.join(",")}) on {arguments.first.inspect} */")
1148 mmethoddef
.compile_inside_to_c
(self, arguments
)
1149 self.add
("{frame.returnlabel.as(not null)}:(void)0;")
1151 self.frame
= old_frame
1154 compiler
.modelbuilder
.nb_invok_by_direct
+= 1
1155 if compiler
.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then add
("count_invoke_by_direct++;")
1158 self.adapt_signature
(mmethoddef
, arguments
)
1160 self.require_declaration
(mmethoddef
.c_name
)
1162 self.add
("{mmethoddef.c_name}({arguments.join(", ")}); /* Direct call {mmethoddef} on {arguments.first.inspect}*/")
1165 self.add
("{res} = {mmethoddef.c_name}({arguments.join(", ")});")
1171 redef fun supercall
(m
: MMethodDef, recvtype
: MClassType, arguments
: Array[RuntimeVariable]): nullable RuntimeVariable
1173 if arguments
.first
.mcasttype
.ctype
!= "val*" then
1174 # In order to shortcut the primitive, we need to find the most specific method
1175 # However, because of performance (no flattening), we always work on the realmainmodule
1176 var main
= self.compiler
.mainmodule
1177 self.compiler
.mainmodule
= self.compiler
.realmainmodule
1178 var res
= self.monomorphic_super_send
(m
, recvtype
, arguments
)
1179 self.compiler
.mainmodule
= main
1182 return table_send
(m
.mproperty
, arguments
, m
.const_color
)
1185 redef fun vararg_instance
(mpropdef
, recv
, varargs
, elttype
)
1187 # A vararg must be stored into an new array
1188 # The trick is that the dymaic type of the array may depends on the receiver
1189 # of the method (ie recv) if the static type is unresolved
1190 # This is more complex than usual because the unresolved type must not be resolved
1191 # with the current receiver (ie self).
1192 # Therefore to isolate the resolution from self, a local Frame is created.
1193 # One can see this implementation as an inlined method of the receiver whose only
1194 # job is to allocate the array
1195 var old_frame
= self.frame
1196 var frame
= new Frame(self, mpropdef
, mpropdef
.mclassdef
.bound_mtype
, [recv
])
1198 #print "required Array[{elttype}] for recv {recv.inspect}. bound=Array[{self.resolve_for(elttype, recv)}]. selfvar={frame.arguments.first.inspect}"
1199 var res
= self.array_instance
(varargs
, elttype
)
1200 self.frame
= old_frame
1204 redef fun isset_attribute
(a
, recv
)
1206 self.check_recv_notnull
(recv
)
1207 var res
= self.new_var
(bool_type
)
1209 # What is the declared type of the attribute?
1210 var mtype
= a
.intro
.static_mtype
.as(not null)
1211 var intromclassdef
= a
.intro
.mclassdef
1212 mtype
= mtype
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1214 if mtype
isa MNullableType then
1215 self.add
("{res} = 1; /* easy isset: {a} on {recv.inspect} */")
1219 self.require_declaration
(a
.const_color
)
1220 if self.compiler
.modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
1221 self.add
("{res} = {recv}->attrs[{a.const_color}] != NULL; /* {a} on {recv.inspect}*/")
1224 if mtype
.ctype
== "val*" then
1225 self.add
("{res} = {recv}->attrs[{a.const_color}].val != NULL; /* {a} on {recv.inspect} */")
1227 self.add
("{res} = 1; /* NOT YET IMPLEMENTED: isset of primitives: {a} on {recv.inspect} */")
1233 redef fun read_attribute
(a
, recv
)
1235 self.check_recv_notnull
(recv
)
1237 # What is the declared type of the attribute?
1238 var ret
= a
.intro
.static_mtype
.as(not null)
1239 var intromclassdef
= a
.intro
.mclassdef
1240 ret
= ret
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1242 if self.compiler
.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
1243 self.compiler
.attr_read_count
+= 1
1244 self.add
("count_attr_reads++;")
1247 self.require_declaration
(a
.const_color
)
1248 if self.compiler
.modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
1249 # Get the attribute or a box (ie. always a val*)
1250 var cret
= self.object_type
.as_nullable
1251 var res
= self.new_var
(cret
)
1254 self.add
("{res} = {recv}->attrs[{a.const_color}]; /* {a} on {recv.inspect} */")
1256 # Check for Uninitialized attribute
1257 if not ret
isa MNullableType and not self.compiler
.modelbuilder
.toolcontext
.opt_no_check_attr_isset
.value
then
1258 self.add
("if (unlikely({res} == NULL)) \{")
1259 self.add_abort
("Uninitialized attribute {a.name}")
1262 if self.compiler
.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
1263 self.compiler
.isset_checks_count
+= 1
1264 self.add
("count_isset_checks++;")
1268 # Return the attribute or its unboxed version
1269 # Note: it is mandatory since we reuse the box on write, we do not whant that the box escapes
1270 return self.autobox
(res
, ret
)
1272 var res
= self.new_var
(ret
)
1273 self.add
("{res} = {recv}->attrs[{a.const_color}].{ret.ctypename}; /* {a} on {recv.inspect} */")
1275 # Check for Uninitialized attribute
1276 if ret
.ctype
== "val*" and not ret
isa MNullableType and not self.compiler
.modelbuilder
.toolcontext
.opt_no_check_attr_isset
.value
then
1277 self.add
("if (unlikely({res} == NULL)) \{")
1278 self.add_abort
("Uninitialized attribute {a.name}")
1280 if self.compiler
.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
1281 self.compiler
.isset_checks_count
+= 1
1282 self.add
("count_isset_checks++;")
1290 redef fun write_attribute
(a
, recv
, value
)
1292 self.check_recv_notnull
(recv
)
1294 # What is the declared type of the attribute?
1295 var mtype
= a
.intro
.static_mtype
.as(not null)
1296 var intromclassdef
= a
.intro
.mclassdef
1297 mtype
= mtype
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1299 # Adapt the value to the declared type
1300 value
= self.autobox
(value
, mtype
)
1302 self.require_declaration
(a
.const_color
)
1303 if self.compiler
.modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
1304 var attr
= "{recv}->attrs[{a.const_color}]"
1305 if mtype
.ctype
!= "val*" then
1306 assert mtype
isa MClassType
1307 # The attribute is primitive, thus we store it in a box
1308 # The trick is to create the box the first time then resuse the box
1309 self.add
("if ({attr} != NULL) \{")
1310 self.add
("((struct instance_{mtype.c_instance_name}*){attr})->value = {value}; /* {a} on {recv.inspect} */")
1311 self.add
("\} else \{")
1312 value
= self.autobox
(value
, self.object_type
.as_nullable
)
1313 self.add
("{attr} = {value}; /* {a} on {recv.inspect} */")
1316 # The attribute is not primitive, thus store it direclty
1317 self.add
("{attr} = {value}; /* {a} on {recv.inspect} */")
1320 self.add
("{recv}->attrs[{a.const_color}].{mtype.ctypename} = {value}; /* {a} on {recv.inspect} */")
1324 # Check that mtype is a live open type
1325 fun hardening_live_open_type
(mtype
: MType)
1327 if not compiler
.modelbuilder
.toolcontext
.opt_hardening
.value
then return
1328 self.require_declaration
(mtype
.const_color
)
1329 var col
= mtype
.const_color
1330 self.add
("if({col} == -1) \{")
1331 self.add
("PRINT_ERROR(\"Resolution of a dead open
type: %s\\n\
", \"{mtype.to_s.escape_to_c}\
");")
1332 self.add_abort
("open type dead")
1336 # Check that mtype it a pointer to a live cast type
1337 fun hardening_cast_type
(t
: String)
1339 if not compiler
.modelbuilder
.toolcontext
.opt_hardening
.value
then return
1340 add
("if({t} == NULL) \{")
1341 add_abort
("cast type null")
1343 add
("if({t}->id == -1 || {t}->color == -1) \{")
1344 add
("PRINT_ERROR(\"Try to cast on a dead cast
type: %s\\n\
", {t}->name);")
1345 add_abort
("cast type dead")
1349 redef fun init_instance
(mtype
)
1351 self.require_declaration
("NEW_{mtype.mclass.c_name}")
1352 var compiler
= self.compiler
1353 if mtype
isa MGenericType and mtype
.need_anchor
then
1354 hardening_live_open_type
(mtype
)
1355 link_unresolved_type
(self.frame
.mpropdef
.mclassdef
, mtype
)
1356 var recv
= self.frame
.arguments
.first
1357 var recv_type_info
= self.type_info
(recv
)
1358 self.require_declaration
(mtype
.const_color
)
1359 return self.new_expr
("NEW_{mtype.mclass.c_name}({recv_type_info}->resolution_table->types[{mtype.const_color}])", mtype
)
1361 compiler
.undead_types
.add
(mtype
)
1362 self.require_declaration
("type_{mtype.c_name}")
1363 return self.new_expr
("NEW_{mtype.mclass.c_name}(&type_{mtype.c_name})", mtype
)
1366 redef fun type_test
(value
, mtype
, tag
)
1368 self.add
("/* {value.inspect} isa {mtype} */")
1369 var compiler
= self.compiler
1371 var recv
= self.frame
.arguments
.first
1372 var recv_type_info
= self.type_info
(recv
)
1374 var res
= self.new_var
(bool_type
)
1376 var cltype
= self.get_name
("cltype")
1377 self.add_decl
("int {cltype};")
1378 var idtype
= self.get_name
("idtype")
1379 self.add_decl
("int {idtype};")
1381 var maybe_null
= self.maybe_null
(value
)
1382 var accept_null
= "0"
1384 if ntype
isa MNullableType then
1389 if value
.mcasttype
.is_subtype
(self.frame
.mpropdef
.mclassdef
.mmodule
, self.frame
.mpropdef
.mclassdef
.bound_mtype
, mtype
) then
1390 self.add
("{res} = 1; /* easy {value.inspect} isa {mtype}*/")
1391 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
1392 self.compiler
.count_type_test_skipped
[tag
] += 1
1393 self.add
("count_type_test_skipped_{tag}++;")
1398 if ntype
.need_anchor
then
1399 var type_struct
= self.get_name
("type_struct")
1400 self.add_decl
("const struct type* {type_struct};")
1402 # Either with resolution_table with a direct resolution
1403 hardening_live_open_type
(mtype
)
1404 link_unresolved_type
(self.frame
.mpropdef
.mclassdef
, mtype
)
1405 self.require_declaration
(mtype
.const_color
)
1406 self.add
("{type_struct} = {recv_type_info}->resolution_table->types[{mtype.const_color}];")
1407 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
1408 self.compiler
.count_type_test_unresolved
[tag
] += 1
1409 self.add
("count_type_test_unresolved_{tag}++;")
1411 hardening_cast_type
(type_struct
)
1412 self.add
("{cltype} = {type_struct}->color;")
1413 self.add
("{idtype} = {type_struct}->id;")
1414 if maybe_null
and accept_null
== "0" then
1415 var is_nullable
= self.get_name
("is_nullable")
1416 self.add_decl
("short int {is_nullable};")
1417 self.add
("{is_nullable} = {type_struct}->is_nullable;")
1418 accept_null
= is_nullable
.to_s
1420 else if ntype
isa MClassType then
1421 compiler
.undead_types
.add
(mtype
)
1422 self.require_declaration
("type_{mtype.c_name}")
1423 hardening_cast_type
("(&type_{mtype.c_name})")
1424 self.add
("{cltype} = type_{mtype.c_name}.color;")
1425 self.add
("{idtype} = type_{mtype.c_name}.id;")
1426 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
1427 self.compiler
.count_type_test_resolved
[tag
] += 1
1428 self.add
("count_type_test_resolved_{tag}++;")
1431 self.add
("PRINT_ERROR(\"NOT YET IMPLEMENTED: type_test
(%s
, {mtype}).\\n\
", \"{value.inspect}\
"); show_backtrace(1);")
1434 # check color is in table
1436 self.add
("if({value} == NULL) \{")
1437 self.add
("{res} = {accept_null};")
1438 self.add
("\} else \{")
1440 var value_type_info
= self.type_info
(value
)
1441 self.add
("if({cltype} >= {value_type_info}->table_size) \{")
1442 self.add
("{res} = 0;")
1443 self.add
("\} else \{")
1444 self.add
("{res} = {value_type_info}->type_table[{cltype}] == {idtype};")
1453 redef fun is_same_type_test
(value1
, value2
)
1455 var res
= self.new_var
(bool_type
)
1456 # Swap values to be symetric
1457 if value2
.mtype
.ctype
!= "val*" and value1
.mtype
.ctype
== "val*" then
1462 if value1
.mtype
.ctype
!= "val*" then
1463 if value2
.mtype
== value1
.mtype
then
1464 self.add
("{res} = 1; /* is_same_type_test: compatible types {value1.mtype} vs. {value2.mtype} */")
1465 else if value2
.mtype
.ctype
!= "val*" then
1466 self.add
("{res} = 0; /* is_same_type_test: incompatible types {value1.mtype} vs. {value2.mtype}*/")
1468 var mtype1
= value1
.mtype
.as(MClassType)
1469 self.require_declaration
("class_{mtype1.c_name}")
1470 self.add
("{res} = ({value2} != NULL) && ({value2}->class == &class_{mtype1.c_name}); /* is_same_type_test */")
1473 self.add
("{res} = ({value1} == {value2}) || ({value1} != NULL && {value2} != NULL && {value1}->class == {value2}->class); /* is_same_type_test */")
1478 redef fun class_name_string
(value
)
1480 var res
= self.get_name
("var_class_name")
1481 self.add_decl
("const char* {res};")
1482 if value
.mtype
.ctype
== "val*" then
1483 self.add
"{res} = {value} == NULL ? \"null\
" : {value}->type->name;"
1484 else if value
.mtype
isa MClassType and value
.mtype
.as(MClassType).mclass
.kind
== extern_kind
then
1485 self.add
"{res} = \"{value.mtype.as(MClassType).mclass}\
";"
1487 self.require_declaration
("type_{value.mtype.c_name}")
1488 self.add
"{res} = type_{value.mtype.c_name}.name;"
1493 redef fun equal_test
(value1
, value2
)
1495 var res
= self.new_var
(bool_type
)
1496 if value2
.mtype
.ctype
!= "val*" and value1
.mtype
.ctype
== "val*" then
1501 if value1
.mtype
.ctype
!= "val*" then
1502 if value2
.mtype
== value1
.mtype
then
1503 self.add
("{res} = {value1} == {value2};")
1504 else if value2
.mtype
.ctype
!= "val*" then
1505 self.add
("{res} = 0; /* incompatible types {value1.mtype} vs. {value2.mtype}*/")
1507 var mtype1
= value1
.mtype
.as(MClassType)
1508 self.require_declaration
("class_{mtype1.c_name}")
1509 self.add
("{res} = ({value2} != NULL) && ({value2}->class == &class_{mtype1.c_name});")
1510 self.add
("if ({res}) \{")
1511 self.add
("{res} = ({self.autobox(value2, value1.mtype)} == {value1});")
1516 var maybe_null
= true
1517 var test
= new Array[String]
1518 var t1
= value1
.mcasttype
1519 if t1
isa MNullableType then
1520 test
.add
("{value1} != NULL")
1525 var t2
= value2
.mcasttype
1526 if t2
isa MNullableType then
1527 test
.add
("{value2} != NULL")
1533 var incompatible
= false
1535 if t1
.ctype
!= "val*" then
1538 # No need to compare class
1539 else if t2
.ctype
!= "val*" then
1541 else if can_be_primitive
(value2
) then
1542 test
.add
("{value1}->class == {value2}->class")
1546 else if t2
.ctype
!= "val*" then
1548 if can_be_primitive
(value1
) then
1549 test
.add
("{value1}->class == {value2}->class")
1557 if incompatible
then
1559 self.add
("{res} = {value1} == {value2}; /* incompatible types {t1} vs. {t2}; but may be NULL*/")
1562 self.add
("{res} = 0; /* incompatible types {t1} vs. {t2}; cannot be NULL */")
1566 if primitive
!= null then
1567 test
.add
("((struct instance_{primitive.c_instance_name}*){value1})->value == ((struct instance_{primitive.c_instance_name}*){value2})->value")
1568 else if can_be_primitive
(value1
) and can_be_primitive
(value2
) then
1569 test
.add
("{value1}->class == {value2}->class")
1570 var s
= new Array[String]
1571 for t
, v
in self.compiler
.box_kinds
do
1572 s
.add
"({value1}->class->box_kind == {v} && ((struct instance_{t.c_instance_name}*){value1})->value == ((struct instance_{t.c_instance_name}*){value2})->value)"
1574 test
.add
("({s.join(" || ")})")
1576 self.add
("{res} = {value1} == {value2};")
1579 self.add
("{res} = {value1} == {value2} || ({test.join(" && ")});")
1583 fun can_be_primitive
(value
: RuntimeVariable): Bool
1585 var t
= value
.mcasttype
.as_notnullable
1586 if not t
isa MClassType then return false
1587 var k
= t
.mclass
.kind
1588 return k
== interface_kind
or t
.ctype
!= "val*"
1591 fun maybe_null
(value
: RuntimeVariable): Bool
1593 var t
= value
.mcasttype
1594 return t
isa MNullableType or t
isa MNullType
1597 redef fun array_instance
(array
, elttype
)
1599 var nclass
= self.get_class
("NativeArray")
1600 var arrayclass
= self.get_class
("Array")
1601 var arraytype
= arrayclass
.get_mtype
([elttype
])
1602 var res
= self.init_instance
(arraytype
)
1603 self.add
("\{ /* {res} = array_instance Array[{elttype}] */")
1604 var length
= self.int_instance
(array
.length
)
1605 var nat
= native_array_instance
(elttype
, length
)
1606 for i
in [0..array
.length
[ do
1607 var r
= self.autobox
(array
[i
], self.object_type
)
1608 self.add
("((struct instance_{nclass.c_name}*){nat})->values[{i}] = (val*) {r};")
1610 self.send
(self.get_property
("with_native", arrayclass
.intro
.bound_mtype
), [res
, nat
, length
])
1615 redef fun native_array_instance
(elttype
: MType, length
: RuntimeVariable): RuntimeVariable
1617 var mtype
= self.get_class
("NativeArray").get_mtype
([elttype
])
1618 self.require_declaration
("NEW_{mtype.mclass.c_name}")
1619 assert mtype
isa MGenericType
1620 var compiler
= self.compiler
1621 if mtype
.need_anchor
then
1622 hardening_live_open_type
(mtype
)
1623 link_unresolved_type
(self.frame
.mpropdef
.mclassdef
, mtype
)
1624 var recv
= self.frame
.arguments
.first
1625 var recv_type_info
= self.type_info
(recv
)
1626 self.require_declaration
(mtype
.const_color
)
1627 return self.new_expr
("NEW_{mtype.mclass.c_name}({length}, {recv_type_info}->resolution_table->types[{mtype.const_color}])", mtype
)
1629 compiler
.undead_types
.add
(mtype
)
1630 self.require_declaration
("type_{mtype.c_name}")
1631 return self.new_expr
("NEW_{mtype.mclass.c_name}({length}, &type_{mtype.c_name})", mtype
)
1634 redef fun native_array_def
(pname
, ret_type
, arguments
)
1636 var elttype
= arguments
.first
.mtype
1637 var nclass
= self.get_class
("NativeArray")
1638 var recv
= "((struct instance_{nclass.c_instance_name}*){arguments[0]})->values"
1639 if pname
== "[]" then
1640 self.ret
(self.new_expr
("{recv}[{arguments[1]}]", ret_type
.as(not null)))
1642 else if pname
== "[]=" then
1643 self.add
("{recv}[{arguments[1]}]={arguments[2]};")
1645 else if pname
== "length" then
1646 self.ret
(self.new_expr
("((struct instance_{nclass.c_instance_name}*){arguments[0]})->length", ret_type
.as(not null)))
1648 else if pname
== "copy_to" then
1649 var recv1
= "((struct instance_{nclass.c_instance_name}*){arguments[1]})->values"
1650 self.add
("memmove({recv1}, {recv}, {arguments[2]}*sizeof({elttype.ctype}));")
1655 redef fun calloc_array
(ret_type
, arguments
)
1657 var mclass
= self.get_class
("ArrayCapable")
1658 var ft
= mclass
.mclass_type
.arguments
.first
.as(MParameterType)
1659 var res
= self.native_array_instance
(ft
, arguments
[1])
1663 fun link_unresolved_type
(mclassdef
: MClassDef, mtype
: MType) do
1664 assert mtype
.need_anchor
1665 var compiler
= self.compiler
1666 if not compiler
.live_unresolved_types
.has_key
(self.frame
.mpropdef
.mclassdef
) then
1667 compiler
.live_unresolved_types
[self.frame
.mpropdef
.mclassdef
] = new HashSet[MType]
1669 compiler
.live_unresolved_types
[self.frame
.mpropdef
.mclassdef
].add
(mtype
)
1673 redef class MMethodDef
1674 fun separate_runtime_function
: AbstractRuntimeFunction
1676 var res
= self.separate_runtime_function_cache
1678 res
= new SeparateRuntimeFunction(self)
1679 self.separate_runtime_function_cache
= res
1683 private var separate_runtime_function_cache
: nullable SeparateRuntimeFunction
1685 fun virtual_runtime_function
: AbstractRuntimeFunction
1687 var res
= self.virtual_runtime_function_cache
1689 res
= new VirtualRuntimeFunction(self)
1690 self.virtual_runtime_function_cache
= res
1694 private var virtual_runtime_function_cache
: nullable VirtualRuntimeFunction
1697 # The C function associated to a methoddef separately compiled
1698 class SeparateRuntimeFunction
1699 super AbstractRuntimeFunction
1701 redef fun build_c_name
: String do return "{mmethoddef.c_name}"
1703 redef fun to_s
do return self.mmethoddef
.to_s
1705 redef fun compile_to_c
(compiler
)
1707 var mmethoddef
= self.mmethoddef
1709 var recv
= self.mmethoddef
.mclassdef
.bound_mtype
1710 var v
= compiler
.new_visitor
1711 var selfvar
= new RuntimeVariable("self", recv
, recv
)
1712 var arguments
= new Array[RuntimeVariable]
1713 var frame
= new Frame(v
, mmethoddef
, recv
, arguments
)
1716 var msignature
= mmethoddef
.msignature
.resolve_for
(mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.mmodule
, true)
1718 var sig
= new FlatBuffer
1719 var comment
= new FlatBuffer
1720 var ret
= msignature
.return_mtype
1722 sig
.append
("{ret.ctype} ")
1723 else if mmethoddef
.mproperty
.is_new
then
1725 sig
.append
("{ret.ctype} ")
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
])
1738 comment
.append
(", {mtype}")
1739 sig
.append
(", {mtype.ctype} p{i}")
1740 var argvar
= new RuntimeVariable("p{i}", mtype
, mtype
)
1741 arguments
.add
(argvar
)
1746 comment
.append
(": {ret}")
1748 compiler
.provide_declaration
(self.c_name
, "{sig};")
1750 v
.add_decl
("/* method {self} for {comment} */")
1751 v
.add_decl
("{sig} \{")
1753 frame
.returnvar
= v
.new_var
(ret
)
1755 frame
.returnlabel
= v
.get_name
("RET_LABEL")
1757 if recv
!= arguments
.first
.mtype
then
1758 #print "{self} {recv} {arguments.first}"
1760 mmethoddef
.compile_inside_to_c
(v
, arguments
)
1762 v
.add
("{frame.returnlabel.as(not null)}:;")
1764 v
.add
("return {frame.returnvar.as(not null)};")
1767 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})"
1771 # The C function associated to a methoddef on a primitive type, stored into a VFT of a class
1772 # The first parameter (the reciever) is always typed by val* in order to accept an object value
1773 class VirtualRuntimeFunction
1774 super AbstractRuntimeFunction
1776 redef fun build_c_name
: String do return "VIRTUAL_{mmethoddef.c_name}"
1778 redef fun to_s
do return self.mmethoddef
.to_s
1780 redef fun compile_to_c
(compiler
)
1782 var mmethoddef
= self.mmethoddef
1784 var recv
= self.mmethoddef
.mclassdef
.bound_mtype
1785 var v
= compiler
.new_visitor
1786 var selfvar
= new RuntimeVariable("self", v
.object_type
, recv
)
1787 var arguments
= new Array[RuntimeVariable]
1788 var frame
= new Frame(v
, mmethoddef
, recv
, arguments
)
1791 var sig
= new FlatBuffer
1792 var comment
= new FlatBuffer
1794 # Because the function is virtual, the signature must match the one of the original class
1795 var intromclassdef
= self.mmethoddef
.mproperty
.intro
.mclassdef
1796 var msignature
= mmethoddef
.mproperty
.intro
.msignature
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1797 var ret
= msignature
.return_mtype
1799 sig
.append
("{ret.ctype} ")
1800 else if mmethoddef
.mproperty
.is_new
then
1802 sig
.append
("{ret.ctype} ")
1806 sig
.append
(self.c_name
)
1807 sig
.append
("({selfvar.mtype.ctype} {selfvar}")
1808 comment
.append
("({selfvar}: {selfvar.mtype}")
1809 arguments
.add
(selfvar
)
1810 for i
in [0..msignature
.arity
[ do
1811 var mtype
= msignature
.mparameters
[i
].mtype
1812 if i
== msignature
.vararg_rank
then
1813 mtype
= v
.get_class
("Array").get_mtype
([mtype
])
1815 comment
.append
(", {mtype}")
1816 sig
.append
(", {mtype.ctype} p{i}")
1817 var argvar
= new RuntimeVariable("p{i}", mtype
, mtype
)
1818 arguments
.add
(argvar
)
1823 comment
.append
(": {ret}")
1825 compiler
.provide_declaration
(self.c_name
, "{sig};")
1827 v
.add_decl
("/* method {self} for {comment} */")
1828 v
.add_decl
("{sig} \{")
1830 frame
.returnvar
= v
.new_var
(ret
)
1832 frame
.returnlabel
= v
.get_name
("RET_LABEL")
1834 var subret
= v
.call
(mmethoddef
, recv
, arguments
)
1836 assert subret
!= null
1837 v
.assign
(frame
.returnvar
.as(not null), subret
)
1840 v
.add
("{frame.returnlabel.as(not null)}:;")
1842 v
.add
("return {frame.returnvar.as(not null)};")
1845 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})"
1849 redef fun call
(v
, arguments
) do abort
1853 fun const_color
: String do return "COLOR_{c_name}"
1855 # C name of the instance type to use
1856 fun c_instance_name
: String do return c_name
1859 redef class MClassType
1860 redef fun c_instance_name
do return mclass
.c_instance_name
1864 # Extern classes use the C instance of kernel::Pointer
1865 fun c_instance_name
: String
1867 if kind
== extern_kind
then
1868 return "kernel__Pointer"
1873 interface PropertyLayoutElement end
1875 redef class MProperty
1876 super PropertyLayoutElement
1877 fun const_color
: String do return "COLOR_{c_name}"
1880 redef class MPropDef
1881 super PropertyLayoutElement
1882 fun const_color
: String do return "COLOR_{c_name}"