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
19 import layout_builders
20 import rapid_type_analysis
23 # Add separate compiler specific options
24 redef class ToolContext
26 var opt_separate
: OptionBool = new OptionBool("Use separate compilation", "--separate")
28 var opt_no_inline_intern
: OptionBool = new OptionBool("Do not inline call to intern methods", "--no-inline-intern")
29 # --no-union-attribute
30 var opt_no_union_attribute
: OptionBool = new OptionBool("Put primitive attibutes in a box instead of an union", "--no-union-attribute")
31 # --no-shortcut-equate
32 var opt_no_shortcut_equate
: OptionBool = new OptionBool("Always call == in a polymorphic way", "--no-shortcut-equal")
33 # --inline-coloring-numbers
34 var opt_inline_coloring_numbers
: OptionBool = new OptionBool("Inline colors and ids", "--inline-coloring-numbers")
35 # --use-naive-coloring
36 var opt_bm_typing
: OptionBool = new OptionBool("Colorize items incrementaly, used to simulate binary matrix typing", "--bm-typing")
37 # --use-mod-perfect-hashing
38 var opt_phmod_typing
: OptionBool = new OptionBool("Replace coloration by perfect hashing (with mod operator)", "--phmod-typing")
39 # --use-and-perfect-hashing
40 var opt_phand_typing
: OptionBool = new OptionBool("Replace coloration by perfect hashing (with and operator)", "--phand-typing")
42 var opt_tables_metrics
: OptionBool = new OptionBool("Enable static size measuring of tables used for vft, typing and resolution", "--tables-metrics")
47 self.option_context
.add_option
(self.opt_separate
)
48 self.option_context
.add_option
(self.opt_no_inline_intern
)
49 self.option_context
.add_option
(self.opt_no_union_attribute
)
50 self.option_context
.add_option
(self.opt_no_shortcut_equate
)
51 self.option_context
.add_option
(self.opt_inline_coloring_numbers
)
52 self.option_context
.add_option
(self.opt_bm_typing
)
53 self.option_context
.add_option
(self.opt_phmod_typing
)
54 self.option_context
.add_option
(self.opt_phand_typing
)
55 self.option_context
.add_option
(self.opt_tables_metrics
)
59 redef class ModelBuilder
60 fun run_separate_compiler
(mainmodule
: MModule, runtime_type_analysis
: nullable RapidTypeAnalysis)
63 self.toolcontext
.info
("*** GENERATING C ***", 1)
65 var compiler
= new SeparateCompiler(mainmodule
, self, runtime_type_analysis
)
66 compiler
.compile_header
68 # compile class structures
69 self.toolcontext
.info
("Property coloring", 2)
70 compiler
.new_file
("{mainmodule.name}.classes")
71 compiler
.do_property_coloring
72 for m
in mainmodule
.in_importation
.greaters
do
73 for mclass
in m
.intro_mclasses
do
74 if mclass
.kind
== abstract_kind
or mclass
.kind
== interface_kind
then continue
75 compiler
.compile_class_to_c
(mclass
)
79 # The main function of the C
80 compiler
.new_file
("{mainmodule.name}.main")
81 compiler
.compile_main_function
84 for m
in mainmodule
.in_importation
.greaters
do
85 self.toolcontext
.info
("Generate C for module {m}", 2)
86 compiler
.new_file
("{m.name}.sep")
87 compiler
.compile_module_to_c
(m
)
90 # compile live & cast type structures
91 self.toolcontext
.info
("Type coloring", 2)
92 compiler
.new_file
("{mainmodule.name}.types")
93 var mtypes
= compiler
.do_type_coloring
95 compiler
.compile_type_to_c
(t
)
97 # compile remaining types structures (useless but needed for the symbol resolution at link-time)
98 for t
in compiler
.undead_types
do
99 if mtypes
.has
(t
) then continue
100 compiler
.compile_type_to_c
(t
)
103 compiler
.display_stats
106 self.toolcontext
.info
("*** END GENERATING C: {time1-time0} ***", 2)
107 write_and_make
(compiler
)
110 # Count number of invocations by VFT
111 private var nb_invok_by_tables
= 0
112 # Count number of invocations by direct call
113 private var nb_invok_by_direct
= 0
114 # Count number of invocations by inlining
115 private var nb_invok_by_inline
= 0
118 # Singleton that store the knowledge about the separate compilation process
119 class SeparateCompiler
120 super AbstractCompiler
122 redef type VISITOR: SeparateCompilerVisitor
124 # The result of the RTA (used to know live types and methods)
125 var runtime_type_analysis
: nullable RapidTypeAnalysis
127 private var undead_types
: Set[MType] = new HashSet[MType]
128 private var live_unresolved_types
: Map[MClassDef, Set[MType]] = new HashMap[MClassDef, HashSet[MType]]
130 private var type_layout
: nullable Layout[MType]
131 private var resolution_layout
: nullable Layout[MType]
132 protected var method_layout
: nullable Layout[PropertyLayoutElement]
133 protected var attr_layout
: nullable Layout[MAttribute]
135 init(mainmodule
: MModule, mmbuilder
: ModelBuilder, runtime_type_analysis
: nullable RapidTypeAnalysis) do
136 super(mainmodule
, mmbuilder
)
137 var file
= new_file
("nit.common")
138 self.header
= new CodeWriter(file
)
139 self.runtime_type_analysis
= runtime_type_analysis
140 self.compile_box_kinds
143 redef fun compile_header_structs
do
144 self.header
.add_decl
("typedef void(*nitmethod_t)(void); /* general C type representing a Nit method. */")
145 self.compile_header_attribute_structs
146 self.header
.add_decl
("struct class \{ int box_kind; nitmethod_t vft[]; \}; /* general C type representing a Nit class. */")
148 # With resolution_table_table, all live type resolution are stored in a big table: resolution_table
149 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. */")
150 self.header
.add_decl
("struct instance \{ const struct type *type; const struct class *class; nitattribute_t attrs[]; \}; /* general C type representing a Nit instance. */")
152 if modelbuilder
.toolcontext
.opt_phmod_typing
.value
or modelbuilder
.toolcontext
.opt_phand_typing
.value
then
153 self.header
.add_decl
("struct types \{ int mask; const struct type *types[]; \}; /* a list types (used for vts, fts and unresolved lists). */")
155 self.header
.add_decl
("struct types \{ int dummy; const struct type *types[]; \}; /* a list types (used for vts, fts and unresolved lists). */")
158 if modelbuilder
.toolcontext
.opt_phmod_typing
.value
then
159 self.header
.add_decl
("#define HASH(mask, id) ((mask)%(id))")
160 else if modelbuilder
.toolcontext
.opt_phand_typing
.value
then
161 self.header
.add_decl
("#define HASH(mask, id) ((mask)&(id))")
164 self.header
.add_decl
("typedef struct instance val; /* general C type representing a Nit instance. */")
167 fun compile_header_attribute_structs
169 if modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
170 self.header
.add_decl
("typedef void* nitattribute_t; /* general C type representing a Nit attribute. */")
172 self.header
.add_decl
("typedef union \{")
173 self.header
.add_decl
("void* val;")
174 for c
, v
in self.box_kinds
do
175 var t
= c
.mclass_type
176 self.header
.add_decl
("{t.ctype} {t.ctypename};")
178 self.header
.add_decl
("\} nitattribute_t; /* general C type representing a Nit attribute. */")
182 fun compile_box_kinds
184 # Collect all bas box class
185 # FIXME: this is not completely fine with a separate compilation scheme
186 for classname
in ["Int", "Bool", "Char", "Float", "NativeString", "Pointer"] do
187 var classes
= self.mainmodule
.model
.get_mclasses_by_name
(classname
)
188 if classes
== null then continue
189 assert classes
.length
== 1 else print classes
.join
(", ")
190 self.box_kinds
[classes
.first
] = self.box_kinds
.length
+ 1
194 var box_kinds
= new HashMap[MClass, Int]
196 fun box_kind_of
(mclass
: MClass): Int
198 if mclass
.mclass_type
.ctype
== "val*" then
200 else if mclass
.kind
== extern_kind
then
201 return self.box_kinds
[self.mainmodule
.get_primitive_class
("Pointer")]
203 return self.box_kinds
[mclass
]
208 fun compile_color_consts
(colors
: Map[Object, Int]) do
210 for m
, c
in colors
do
211 compile_color_const
(v
, m
, c
)
215 fun compile_color_const
(v
: SeparateCompilerVisitor, m
: Object, color
: Int) do
216 if color_consts_done
.has
(m
) then return
217 if m
isa MProperty then
218 if modelbuilder
.toolcontext
.opt_inline_coloring_numbers
.value
then
219 self.provide_declaration
(m
.const_color
, "#define {m.const_color} {color}")
221 self.provide_declaration
(m
.const_color
, "extern const int {m.const_color};")
222 v
.add
("const int {m.const_color} = {color};")
224 else if m
isa MPropDef then
225 if modelbuilder
.toolcontext
.opt_inline_coloring_numbers
.value
then
226 self.provide_declaration
(m
.const_color
, "#define {m.const_color} {color}")
228 self.provide_declaration
(m
.const_color
, "extern const int {m.const_color};")
229 v
.add
("const int {m.const_color} = {color};")
231 else if m
isa MType then
232 if modelbuilder
.toolcontext
.opt_inline_coloring_numbers
.value
then
233 self.provide_declaration
(m
.const_color
, "#define {m.const_color} {color}")
235 self.provide_declaration
(m
.const_color
, "extern const int {m.const_color};")
236 v
.add
("const int {m.const_color} = {color};")
239 color_consts_done
.add
(m
)
242 private var color_consts_done
= new HashSet[Object]
244 # colorize classe properties
245 fun do_property_coloring
do
246 var mclasses
= new HashSet[MClass].from
(modelbuilder
.model
.mclasses
)
249 var method_layout_builder
: PropertyLayoutBuilder[PropertyLayoutElement]
250 var attribute_layout_builder
: PropertyLayoutBuilder[MAttribute]
251 #FIXME PH and BM layouts too slow for large programs
252 #if modelbuilder.toolcontext.opt_bm_typing.value then
253 # method_layout_builder = new MMethodBMizer(self.mainmodule)
254 # attribute_layout_builder = new MAttributeBMizer(self.mainmodule)
255 #else if modelbuilder.toolcontext.opt_phmod_typing.value then
256 # method_layout_builder = new MMethodHasher(new PHModOperator, self.mainmodule)
257 # attribute_layout_builder = new MAttributeHasher(new PHModOperator, self.mainmodule)
258 #else if modelbuilder.toolcontext.opt_phand_typing.value then
259 # method_layout_builder = new MMethodHasher(new PHAndOperator, self.mainmodule)
260 # attribute_layout_builder = new MAttributeHasher(new PHAndOperator, self.mainmodule)
263 var class_layout_builder
= new MClassColorer(self.mainmodule
)
264 class_layout_builder
.build_layout
(mclasses
)
265 method_layout_builder
= new MPropertyColorer[PropertyLayoutElement](self.mainmodule
, class_layout_builder
)
266 attribute_layout_builder
= new MPropertyColorer[MAttribute](self.mainmodule
, class_layout_builder
)
269 # lookup properties to build layout with
270 var mmethods
= new HashMap[MClass, Set[PropertyLayoutElement]]
271 var mattributes
= new HashMap[MClass, Set[MAttribute]]
272 for mclass
in mclasses
do
273 mmethods
[mclass
] = new HashSet[PropertyLayoutElement]
274 mattributes
[mclass
] = new HashSet[MAttribute]
275 for mprop
in self.mainmodule
.properties
(mclass
) do
276 if mprop
isa MMethod then
277 mmethods
[mclass
].add
(mprop
)
278 else if mprop
isa MAttribute then
279 mattributes
[mclass
].add
(mprop
)
284 # Collect all super calls (dead or not)
285 var all_super_calls
= new HashSet[MMethodDef]
286 for mmodule
in self.mainmodule
.in_importation
.greaters
do
287 for mclassdef
in mmodule
.mclassdefs
do
288 for mpropdef
in mclassdef
.mpropdefs
do
289 if not mpropdef
isa MMethodDef then continue
290 if mpropdef
.has_supercall
then
291 all_super_calls
.add
(mpropdef
)
297 # lookup super calls and add it to the list of mmethods to build layout with
299 if runtime_type_analysis
!= null then
300 super_calls
= runtime_type_analysis
.live_super_sends
302 super_calls
= all_super_calls
305 for mmethoddef
in super_calls
do
306 var mclass
= mmethoddef
.mclassdef
.mclass
307 mmethods
[mclass
].add
(mmethoddef
)
308 for descendant
in mclass
.in_hierarchy
(self.mainmodule
).smallers
do
309 mmethods
[descendant
].add
(mmethoddef
)
314 self.method_layout
= method_layout_builder
.build_layout
(mmethods
)
315 self.method_tables
= build_method_tables
(mclasses
, super_calls
)
316 self.compile_color_consts
(method_layout
.pos
)
318 # attribute null color to dead supercalls
319 for mpropdef
in all_super_calls
do
320 if super_calls
.has
(mpropdef
) then continue
321 compile_color_const
(new_visitor
, mpropdef
, -1)
324 # attributes coloration
325 self.attr_layout
= attribute_layout_builder
.build_layout
(mattributes
)
326 self.attr_tables
= build_attr_tables
(mclasses
)
327 self.compile_color_consts
(attr_layout
.pos
)
330 fun build_method_tables
(mclasses
: Set[MClass], super_calls
: Set[MMethodDef]): Map[MClass, Array[nullable MPropDef]] do
331 var layout
= self.method_layout
332 var tables
= new HashMap[MClass, Array[nullable MPropDef]]
333 for mclass
in mclasses
do
334 var table
= new Array[nullable MPropDef]
335 var supercalls
= new List[MMethodDef]
337 # first, fill table from parents by reverse linearization order
338 var parents
= new Array[MClass]
339 if mainmodule
.flatten_mclass_hierarchy
.has
(mclass
) then
340 parents
= mclass
.in_hierarchy
(mainmodule
).greaters
.to_a
341 self.mainmodule
.linearize_mclasses
(parents
)
344 for parent
in parents
do
345 if parent
== mclass
then continue
346 for mproperty
in self.mainmodule
.properties
(parent
) do
347 if not mproperty
isa MMethod then continue
348 var color
= layout
.pos
[mproperty
]
349 if table
.length
<= color
then
350 for i
in [table
.length
.. color
[ do
354 for mpropdef
in mproperty
.mpropdefs
do
355 if mpropdef
.mclassdef
.mclass
== parent
then
356 table
[color
] = mpropdef
361 # lookup for super calls in super classes
362 for mmethoddef
in super_calls
do
363 for mclassdef
in parent
.mclassdefs
do
364 if mclassdef
.mpropdefs
.has
(mmethoddef
) then
365 supercalls
.add
(mmethoddef
)
371 # then override with local properties
372 for mproperty
in self.mainmodule
.properties
(mclass
) do
373 if not mproperty
isa MMethod then continue
374 var color
= layout
.pos
[mproperty
]
375 if table
.length
<= color
then
376 for i
in [table
.length
.. color
[ do
380 for mpropdef
in mproperty
.mpropdefs
do
381 if mpropdef
.mclassdef
.mclass
== mclass
then
382 table
[color
] = mpropdef
387 # lookup for super calls in local class
388 for mmethoddef
in super_calls
do
389 for mclassdef
in mclass
.mclassdefs
do
390 if mclassdef
.mpropdefs
.has
(mmethoddef
) then
391 supercalls
.add
(mmethoddef
)
395 # insert super calls in table according to receiver
396 for supercall
in supercalls
do
397 var color
= layout
.pos
[supercall
]
398 if table
.length
<= color
then
399 for i
in [table
.length
.. color
[ do
403 var mmethoddef
= supercall
.lookup_next_definition
(self.mainmodule
, mclass
.intro
.bound_mtype
)
404 table
[color
] = mmethoddef
406 tables
[mclass
] = table
411 fun build_attr_tables
(mclasses
: Set[MClass]): Map[MClass, Array[nullable MPropDef]] do
412 var layout
= self.attr_layout
413 var tables
= new HashMap[MClass, Array[nullable MPropDef]]
414 for mclass
in mclasses
do
415 var table
= new Array[nullable MPropDef]
416 # first, fill table from parents by reverse linearization order
417 var parents
= new Array[MClass]
418 if mainmodule
.flatten_mclass_hierarchy
.has
(mclass
) then
419 parents
= mclass
.in_hierarchy
(mainmodule
).greaters
.to_a
420 self.mainmodule
.linearize_mclasses
(parents
)
422 for parent
in parents
do
423 if parent
== mclass
then continue
424 for mproperty
in self.mainmodule
.properties
(parent
) do
425 if not mproperty
isa MAttribute then continue
426 var color
= layout
.pos
[mproperty
]
427 if table
.length
<= color
then
428 for i
in [table
.length
.. color
[ do
432 for mpropdef
in mproperty
.mpropdefs
do
433 if mpropdef
.mclassdef
.mclass
== parent
then
434 table
[color
] = mpropdef
440 # then override with local properties
441 for mproperty
in self.mainmodule
.properties
(mclass
) do
442 if not mproperty
isa MAttribute then continue
443 var color
= layout
.pos
[mproperty
]
444 if table
.length
<= color
then
445 for i
in [table
.length
.. color
[ do
449 for mpropdef
in mproperty
.mpropdefs
do
450 if mpropdef
.mclassdef
.mclass
== mclass
then
451 table
[color
] = mpropdef
455 tables
[mclass
] = table
460 # colorize live types of the program
461 private fun do_type_coloring
: POSet[MType] do
462 var mtypes
= new HashSet[MType]
463 mtypes
.add_all
(self.runtime_type_analysis
.live_types
)
464 mtypes
.add_all
(self.runtime_type_analysis
.live_cast_types
)
465 for c
in self.box_kinds
.keys
do
466 mtypes
.add
(c
.mclass_type
)
470 var layout_builder
: TypingLayoutBuilder[MType]
471 if modelbuilder
.toolcontext
.opt_bm_typing
.value
then
472 layout_builder
= new MTypeBMizer(self.mainmodule
)
473 else if modelbuilder
.toolcontext
.opt_phmod_typing
.value
then
474 layout_builder
= new MTypeHasher(new PHModOperator, self.mainmodule
)
475 else if modelbuilder
.toolcontext
.opt_phand_typing
.value
then
476 layout_builder
= new MTypeHasher(new PHAndOperator, self.mainmodule
)
478 layout_builder
= new MTypeColorer(self.mainmodule
)
482 self.type_layout
= layout_builder
.build_layout
(mtypes
)
483 var poset
= layout_builder
.poset
.as(not null)
484 self.type_tables
= self.build_type_tables
(poset
)
486 # VT and FT are stored with other unresolved types in the big resolution_tables
487 self.compile_resolution_tables
(mtypes
)
493 fun build_type_tables
(mtypes
: POSet[MType]): Map[MType, Array[nullable MType]] do
494 var tables
= new HashMap[MType, Array[nullable MType]]
495 var layout
= self.type_layout
496 for mtype
in mtypes
do
497 var table
= new Array[nullable MType]
498 for sup
in mtypes
[mtype
].greaters
do
500 if layout
isa PHLayout[MType, MType] then
501 color
= layout
.hashes
[mtype
][sup
]
503 color
= layout
.pos
[sup
]
505 if table
.length
<= color
then
506 for i
in [table
.length
.. color
[ do
512 tables
[mtype
] = table
517 protected fun compile_resolution_tables
(mtypes
: Set[MType]) do
518 # resolution_tables is used to perform a type resolution at runtime in O(1)
520 # During the visit of the body of classes, live_unresolved_types are collected
522 # Collect all live_unresolved_types (visited in the body of classes)
524 # Determinate fo each livetype what are its possible requested anchored types
525 var mtype2unresolved
= new HashMap[MClassType, Set[MType]]
526 for mtype
in self.runtime_type_analysis
.live_types
do
527 var set
= new HashSet[MType]
528 for cd
in mtype
.collect_mclassdefs
(self.mainmodule
) do
529 if self.live_unresolved_types
.has_key
(cd
) then
530 set
.add_all
(self.live_unresolved_types
[cd
])
533 mtype2unresolved
[mtype
] = set
536 # Compute the table layout with the prefered method
537 var resolution_builder
: ResolutionLayoutBuilder
538 if modelbuilder
.toolcontext
.opt_bm_typing
.value
then
539 resolution_builder
= new ResolutionBMizer
540 else if modelbuilder
.toolcontext
.opt_phmod_typing
.value
then
541 resolution_builder
= new ResolutionHasher(new PHModOperator)
542 else if modelbuilder
.toolcontext
.opt_phand_typing
.value
then
543 resolution_builder
= new ResolutionHasher(new PHAndOperator)
545 resolution_builder
= new ResolutionColorer
547 self.resolution_layout
= resolution_builder
.build_layout
(mtype2unresolved
)
548 self.resolution_tables
= self.build_resolution_tables
(mtype2unresolved
)
550 # Compile a C constant for each collected unresolved type.
551 # Either to a color, or to -1 if the unresolved type is dead (no live receiver can require it)
552 var all_unresolved
= new HashSet[MType]
553 for t
in self.live_unresolved_types
.values
do
554 all_unresolved
.add_all
(t
)
556 var all_unresolved_types_colors
= new HashMap[MType, Int]
557 for t
in all_unresolved
do
558 if self.resolution_layout
.pos
.has_key
(t
) then
559 all_unresolved_types_colors
[t
] = self.resolution_layout
.pos
[t
]
561 all_unresolved_types_colors
[t
] = -1
564 self.compile_color_consts
(all_unresolved_types_colors
)
567 #for k, v in unresolved_types_tables.as(not null) do
568 # print "{k}: {v.join(", ")}"
573 fun build_resolution_tables
(elements
: Map[MClassType, Set[MType]]): Map[MClassType, Array[nullable MType]] do
574 var tables
= new HashMap[MClassType, Array[nullable MType]]
575 var layout
= self.resolution_layout
576 for mclasstype
, mtypes
in elements
do
577 var table
= new Array[nullable MType]
578 for mtype
in mtypes
do
580 if layout
isa PHLayout[MClassType, MType] then
581 color
= layout
.hashes
[mclasstype
][mtype
]
583 color
= layout
.pos
[mtype
]
585 if table
.length
<= color
then
586 for i
in [table
.length
.. color
[ do
592 tables
[mclasstype
] = table
597 # Separately compile all the method definitions of the module
598 fun compile_module_to_c
(mmodule
: MModule)
600 var old_module
= self.mainmodule
601 self.mainmodule
= mmodule
602 for cd
in mmodule
.mclassdefs
do
603 for pd
in cd
.mpropdefs
do
604 if not pd
isa MMethodDef then continue
605 #print "compile {pd} @ {cd} @ {mmodule}"
606 var r
= pd
.separate_runtime_function
608 var r2
= pd
.virtual_runtime_function
609 r2
.compile_to_c
(self)
612 self.mainmodule
= old_module
615 # Globaly compile the type structure of a live type
616 fun compile_type_to_c
(mtype
: MType)
618 assert not mtype
.need_anchor
619 var layout
= self.type_layout
620 var is_live
= mtype
isa MClassType and runtime_type_analysis
.live_types
.has
(mtype
)
621 var is_cast_live
= runtime_type_analysis
.live_cast_types
.has
(mtype
)
622 var c_name
= mtype
.c_name
623 var v
= new SeparateCompilerVisitor(self)
624 v
.add_decl
("/* runtime type {mtype} */")
626 # extern const struct type_X
627 self.provide_declaration
("type_{c_name}", "extern const struct type type_{c_name};")
629 # const struct type_X
630 v
.add_decl
("const struct type type_{c_name} = \{")
632 # type id (for cast target)
634 v
.add_decl
("{layout.ids[mtype]},")
636 v
.add_decl
("-1, /*CAST DEAD*/")
640 v
.add_decl
("\"{mtype}\
", /* class_name_string */")
642 # type color (for cast target)
644 if layout
isa PHLayout[MType, MType] then
645 v
.add_decl
("{layout.masks[mtype]},")
647 v
.add_decl
("{layout.pos[mtype]},")
650 v
.add_decl
("-1, /*CAST DEAD*/")
654 if mtype
isa MNullableType then
660 # resolution table (for receiver)
662 var mclass_type
= mtype
663 if mclass_type
isa MNullableType then mclass_type
= mclass_type
.mtype
664 assert mclass_type
isa MClassType
665 if resolution_tables
[mclass_type
].is_empty
then
666 v
.add_decl
("NULL, /*NO RESOLUTIONS*/")
668 compile_type_resolution_table
(mtype
)
669 v
.require_declaration
("resolution_table_{c_name}")
670 v
.add_decl
("&resolution_table_{c_name},")
673 v
.add_decl
("NULL, /*DEAD*/")
676 # cast table (for receiver)
678 v
.add_decl
("{self.type_tables[mtype].length},")
680 for stype
in self.type_tables
[mtype
] do
681 if stype
== null then
682 v
.add_decl
("-1, /* empty */")
684 v
.add_decl
("{layout.ids[stype]}, /* {stype} */")
689 v
.add_decl
("0, \{\}, /*DEAD TYPE*/")
694 fun compile_type_resolution_table
(mtype
: MType) do
696 var mclass_type
: MClassType
697 if mtype
isa MNullableType then
698 mclass_type
= mtype
.mtype
.as(MClassType)
700 mclass_type
= mtype
.as(MClassType)
703 var layout
= self.resolution_layout
705 # extern const struct resolution_table_X resolution_table_X
706 self.provide_declaration
("resolution_table_{mtype.c_name}", "extern const struct types resolution_table_{mtype.c_name};")
708 # const struct fts_table_X fts_table_X
710 v
.add_decl
("const struct types resolution_table_{mtype.c_name} = \{")
711 if layout
isa PHLayout[MClassType, MType] then
712 v
.add_decl
("{layout.masks[mclass_type]},")
714 v
.add_decl
("0, /* dummy */")
717 for t
in self.resolution_tables
[mclass_type
] do
719 v
.add_decl
("NULL, /* empty */")
721 # The table stores the result of the type resolution
722 # Therefore, for a receiver `mclass_type`, and a unresolved type `t`
723 # the value stored is tv.
724 var tv
= t
.resolve_for
(mclass_type
, mclass_type
, self.mainmodule
, true)
725 # FIXME: What typeids means here? How can a tv not be live?
726 if self.type_layout
.ids
.has_key
(tv
) then
727 v
.require_declaration
("type_{tv.c_name}")
728 v
.add_decl
("&type_{tv.c_name}, /* {t}: {tv} */")
730 v
.add_decl
("NULL, /* empty ({t}: {tv} not a live type) */")
738 # Globally compile the table of the class mclass
739 # In a link-time optimisation compiler, tables are globally computed
740 # In a true separate compiler (a with dynamic loading) you cannot do this unfortnally
741 fun compile_class_to_c
(mclass
: MClass)
743 var mtype
= mclass
.intro
.bound_mtype
744 var c_name
= mclass
.c_name
745 var c_instance_name
= mclass
.c_instance_name
747 var vft
= self.method_tables
[mclass
]
748 var attrs
= self.attr_tables
[mclass
]
751 var is_dead
= runtime_type_analysis
!= null and not runtime_type_analysis
.live_classes
.has
(mclass
) and mtype
.ctype
== "val*" and mclass
.name
!= "NativeArray"
753 v
.add_decl
("/* runtime class {c_name} */")
757 self.provide_declaration
("class_{c_name}", "extern const struct class class_{c_name};")
758 v
.add_decl
("const struct class class_{c_name} = \{")
759 v
.add_decl
("{self.box_kind_of(mclass)}, /* box_kind */")
761 for i
in [0 .. vft
.length
[ do
762 var mpropdef
= vft
[i
]
763 if mpropdef
== null then
764 v
.add_decl
("NULL, /* empty */")
766 assert mpropdef
isa MMethodDef
767 var rf
= mpropdef
.virtual_runtime_function
768 v
.require_declaration
(rf
.c_name
)
769 v
.add_decl
("(nitmethod_t){rf.c_name}, /* pointer to {mclass.intro_mmodule}:{mclass}:{mpropdef} */")
776 if mtype
.ctype
!= "val*" then
777 if mtype
.mclass
.name
== "Pointer" or mtype
.mclass
.kind
!= extern_kind
then
778 #Build instance struct
779 self.header
.add_decl
("struct instance_{c_instance_name} \{")
780 self.header
.add_decl
("const struct type *type;")
781 self.header
.add_decl
("const struct class *class;")
782 self.header
.add_decl
("{mtype.ctype} value;")
783 self.header
.add_decl
("\};")
786 if not self.runtime_type_analysis
.live_types
.has
(mtype
) then return
789 self.provide_declaration
("BOX_{c_name}", "val* BOX_{c_name}({mtype.ctype});")
790 v
.add_decl
("/* allocate {mtype} */")
791 v
.add_decl
("val* BOX_{mtype.c_name}({mtype.ctype} value) \{")
792 v
.add
("struct instance_{c_instance_name}*res = nit_alloc(sizeof(struct instance_{c_instance_name}));")
793 v
.require_declaration
("type_{c_name}")
794 v
.add
("res->type = &type_{c_name};")
795 v
.require_declaration
("class_{c_name}")
796 v
.add
("res->class = &class_{c_name};")
797 v
.add
("res->value = value;")
798 v
.add
("return (val*)res;")
801 else if mclass
.name
== "NativeArray" then
802 #Build instance struct
803 self.header
.add_decl
("struct instance_{c_instance_name} \{")
804 self.header
.add_decl
("const struct type *type;")
805 self.header
.add_decl
("const struct class *class;")
806 # NativeArrays are just a instance header followed by an array of values
807 self.header
.add_decl
("val* values[0];")
808 self.header
.add_decl
("\};")
811 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(int length, const struct type* type);")
812 v
.add_decl
("/* allocate {mtype} */")
813 v
.add_decl
("{mtype.ctype} NEW_{c_name}(int length, const struct type* type) \{")
814 var res
= v
.new_named_var
(mtype
, "self")
816 var mtype_elt
= mtype
.arguments
.first
817 v
.add
("{res} = nit_alloc(sizeof(struct instance_{c_instance_name}) + length*sizeof({mtype_elt.ctype}));")
818 v
.add
("{res}->type = type;")
819 hardening_live_type
(v
, "type")
820 v
.require_declaration
("class_{c_name}")
821 v
.add
("{res}->class = &class_{c_name};")
822 v
.add
("return {res};")
828 self.provide_declaration
("NEW_{c_name}", "{mtype.ctype} NEW_{c_name}(const struct type* type);")
829 v
.add_decl
("/* allocate {mtype} */")
830 v
.add_decl
("{mtype.ctype} NEW_{c_name}(const struct type* type) \{")
832 v
.add_abort
("{mclass} is DEAD")
834 var res
= v
.new_named_var
(mtype
, "self")
836 v
.add
("{res} = nit_alloc(sizeof(struct instance) + {attrs.length}*sizeof(nitattribute_t));")
837 v
.add
("{res}->type = type;")
838 hardening_live_type
(v
, "type")
839 v
.require_declaration
("class_{c_name}")
840 v
.add
("{res}->class = &class_{c_name};")
841 self.generate_init_attr
(v
, res
, mtype
)
842 v
.add
("return {res};")
847 # Add a dynamic test to ensure that the type referenced by `t` is a live type
848 fun hardening_live_type
(v
: VISITOR, t
: String)
850 if not v
.compiler
.modelbuilder
.toolcontext
.opt_hardening
.value
then return
851 v
.add
("if({t} == NULL) \{")
852 v
.add_abort
("type null")
854 v
.add
("if({t}->table_size == 0) \{")
855 v
.add
("fprintf(stderr, \"Insantiation of a dead
type: %s\\n\
", {t}->name);")
856 v
.add_abort
("type dead")
860 redef fun new_visitor
do return new SeparateCompilerVisitor(self)
864 private var type_tables
: Map[MType, Array[nullable MType]] = new HashMap[MType, Array[nullable MType]]
865 private var resolution_tables
: Map[MClassType, Array[nullable MType]] = new HashMap[MClassType, Array[nullable MType]]
866 protected var method_tables
: Map[MClass, Array[nullable MPropDef]] = new HashMap[MClass, Array[nullable MPropDef]]
867 protected var attr_tables
: Map[MClass, Array[nullable MPropDef]] = new HashMap[MClass, Array[nullable MPropDef]]
869 redef fun display_stats
872 if self.modelbuilder
.toolcontext
.opt_tables_metrics
.value
then
876 var tc
= self.modelbuilder
.toolcontext
877 tc
.info
("# implementation of method invocation",2)
878 var nb_invok_total
= modelbuilder
.nb_invok_by_tables
+ modelbuilder
.nb_invok_by_direct
+ modelbuilder
.nb_invok_by_inline
879 tc
.info
("total number of invocations: {nb_invok_total}",2)
880 tc
.info
("invocations by VFT send: {modelbuilder.nb_invok_by_tables} ({div(modelbuilder.nb_invok_by_tables,nb_invok_total)}%)",2)
881 tc
.info
("invocations by direct call: {modelbuilder.nb_invok_by_direct} ({div(modelbuilder.nb_invok_by_direct,nb_invok_total)}%)",2)
882 tc
.info
("invocations by inlining: {modelbuilder.nb_invok_by_inline} ({div(modelbuilder.nb_invok_by_inline,nb_invok_total)}%)",2)
887 print
"# size of subtyping tables"
888 print
"\ttotal \tholes"
891 for t
, table
in type_tables
do
892 total
+= table
.length
893 for e
in table
do if e
== null then holes
+= 1
895 print
"\t{total}\t{holes}"
897 print
"# size of resolution tables"
898 print
"\ttotal \tholes"
901 for t
, table
in resolution_tables
do
902 total
+= table
.length
903 for e
in table
do if e
== null then holes
+= 1
905 print
"\t{total}\t{holes}"
907 print
"# size of methods tables"
908 print
"\ttotal \tholes"
911 for t
, table
in method_tables
do
912 total
+= table
.length
913 for e
in table
do if e
== null then holes
+= 1
915 print
"\t{total}\t{holes}"
917 print
"# size of attributes tables"
918 print
"\ttotal \tholes"
921 for t
, table
in attr_tables
do
922 total
+= table
.length
923 for e
in table
do if e
== null then holes
+= 1
925 print
"\t{total}\t{holes}"
928 redef fun compile_nitni_structs
930 self.header
.add_decl
("struct nitni_instance \{struct instance *value;\};")
933 redef fun finalize_ffi_for_module
(nmodule
)
935 var old_module
= self.mainmodule
936 self.mainmodule
= nmodule
.mmodule
.as(not null)
938 self.mainmodule
= old_module
942 # A visitor on the AST of property definition that generate the C code of a separate compilation process.
943 class SeparateCompilerVisitor
944 super AbstractCompilerVisitor
946 redef type COMPILER: SeparateCompiler
948 redef fun adapt_signature
(m
, args
)
950 var msignature
= m
.msignature
.resolve_for
(m
.mclassdef
.bound_mtype
, m
.mclassdef
.bound_mtype
, m
.mclassdef
.mmodule
, true)
951 var recv
= args
.first
952 if recv
.mtype
.ctype
!= m
.mclassdef
.mclass
.mclass_type
.ctype
then
953 args
.first
= self.autobox
(args
.first
, m
.mclassdef
.mclass
.mclass_type
)
955 for i
in [0..msignature
.arity
[ do
956 var t
= msignature
.mparameters
[i
].mtype
957 if i
== msignature
.vararg_rank
then
960 args
[i
+1] = self.autobox
(args
[i
+1], t
)
964 redef fun autobox
(value
, mtype
)
966 if value
.mtype
== mtype
then
968 else if value
.mtype
.ctype
== "val*" and mtype
.ctype
== "val*" then
970 else if value
.mtype
.ctype
== "val*" then
971 return self.new_expr
("((struct instance_{mtype.c_instance_name}*){value})->value; /* autounbox from {value.mtype} to {mtype} */", mtype
)
972 else if mtype
.ctype
== "val*" then
973 var valtype
= value
.mtype
.as(MClassType)
974 var res
= self.new_var
(mtype
)
975 if compiler
.runtime_type_analysis
!= null and not compiler
.runtime_type_analysis
.live_types
.has
(valtype
) then
976 self.add
("/*no autobox from {value.mtype} to {mtype}: {value.mtype} is not live! */")
977 self.add
("printf(\"Dead code executed
!\\n\
"); show_backtrace(1);")
980 self.require_declaration
("BOX_{valtype.c_name}")
981 self.add
("{res} = BOX_{valtype.c_name}({value}); /* autobox from {value.mtype} to {mtype} */")
983 else if value
.mtype
.cname_blind
== "void*" and mtype
.cname_blind
== "void*" then
986 # Bad things will appen!
987 var res
= self.new_var
(mtype
)
988 self.add
("/* {res} left unintialized (cannot convert {value.mtype} to {mtype}) */")
989 self.add
("printf(\"Cast error
: Cannot cast
%s to
%s
.\\n\
", \"{value.mtype}\
", \"{mtype}\
"); show_backtrace(1);")
994 # Return a C expression returning the runtime type structure of the value
995 # The point of the method is to works also with primitives types.
996 fun type_info
(value
: RuntimeVariable): String
998 if value
.mtype
.ctype
== "val*" then
999 return "{value}->type"
1001 compiler
.undead_types
.add
(value
.mtype
)
1002 self.require_declaration
("type_{value.mtype.c_name}")
1003 return "(&type_{value.mtype.c_name})"
1007 redef fun send
(mmethod
, arguments
)
1009 self.varargize
(mmethod
.intro
, mmethod
.intro
.msignature
.as(not null), arguments
)
1011 if arguments
.first
.mcasttype
.ctype
!= "val*" then
1012 # In order to shortcut the primitive, we need to find the most specific method
1013 # Howverr, because of performance (no flattening), we always work on the realmainmodule
1014 var m
= self.compiler
.mainmodule
1015 self.compiler
.mainmodule
= self.compiler
.realmainmodule
1016 var res
= self.monomorphic_send
(mmethod
, arguments
.first
.mcasttype
, arguments
)
1017 self.compiler
.mainmodule
= m
1021 return table_send
(mmethod
, arguments
, mmethod
.const_color
)
1024 private fun table_send
(mmethod
: MMethod, arguments
: Array[RuntimeVariable], const_color
: String): nullable RuntimeVariable
1026 compiler
.modelbuilder
.nb_invok_by_tables
+= 1
1028 assert arguments
.length
== mmethod
.intro
.msignature
.arity
+ 1 else debug
("Invalid arity for {mmethod}. {arguments.length} arguments given.")
1030 var res
: nullable RuntimeVariable
1031 var msignature
= mmethod
.intro
.msignature
.resolve_for
(mmethod
.intro
.mclassdef
.bound_mtype
, mmethod
.intro
.mclassdef
.bound_mtype
, mmethod
.intro
.mclassdef
.mmodule
, true)
1032 var ret
= msignature
.return_mtype
1033 if mmethod
.is_new
then
1034 ret
= arguments
.first
.mtype
1035 res
= self.new_var
(ret
)
1036 else if ret
== null then
1039 res
= self.new_var
(ret
)
1045 var recv
= arguments
.first
1048 for i
in [0..msignature
.arity
[ do
1049 var a
= arguments
[i
+1]
1050 var t
= msignature
.mparameters
[i
].mtype
1051 if i
== msignature
.vararg_rank
then
1052 t
= arguments
[i
+1].mcasttype
1054 s
.append
(", {t.ctype}")
1055 a
= self.autobox
(a
, t
)
1059 var consider_null
= not self.compiler
.modelbuilder
.toolcontext
.opt_no_check_other
.value
or mmethod
.name
== "==" or mmethod
.name
== "!="
1060 var maybenull
= recv
.mcasttype
isa MNullableType and consider_null
1062 self.add
("if ({recv} == NULL) \{")
1063 if mmethod
.name
== "==" then
1065 var arg
= arguments
[1]
1066 if arg
.mcasttype
isa MNullableType then
1067 self.add
("{res} = ({arg} == NULL);")
1068 else if arg
.mcasttype
isa MNullType then
1069 self.add
("{res} = 1; /* is null */")
1071 self.add
("{res} = 0; /* {arg.inspect} cannot be null */")
1073 else if mmethod
.name
== "!=" then
1075 var arg
= arguments
[1]
1076 if arg
.mcasttype
isa MNullableType then
1077 self.add
("{res} = ({arg} != NULL);")
1078 else if arg
.mcasttype
isa MNullType then
1079 self.add
("{res} = 0; /* is null */")
1081 self.add
("{res} = 1; /* {arg.inspect} cannot be null */")
1084 self.add_abort
("Receiver is null")
1086 self.add
("\} else \{")
1088 if not self.compiler
.modelbuilder
.toolcontext
.opt_no_shortcut_equate
.value
and (mmethod
.name
== "==" or mmethod
.name
== "!=") then
1090 # Recv is not null, thus is arg is, it is easy to conclude (and respect the invariants)
1091 var arg
= arguments
[1]
1092 if arg
.mcasttype
isa MNullType then
1093 if mmethod
.name
== "==" then
1094 self.add
("{res} = 0; /* arg is null but recv is not */")
1096 self.add
("{res} = 1; /* arg is null and recv is not */")
1106 if ret
== null then r
= "void" else r
= ret
.ctype
1107 self.require_declaration
(const_color
)
1108 var call
= "(({r} (*)({s}))({arguments.first}->class->vft[{const_color}]))({ss}) /* {mmethod} on {arguments.first.inspect}*/"
1111 self.add
("{res} = {call};")
1123 redef fun call
(mmethoddef
, recvtype
, arguments
)
1125 assert arguments
.length
== mmethoddef
.msignature
.arity
+ 1 else debug
("Invalid arity for {mmethoddef}. {arguments.length} arguments given.")
1127 var res
: nullable RuntimeVariable
1128 var ret
= mmethoddef
.msignature
.return_mtype
1129 if mmethoddef
.mproperty
.is_new
then
1130 ret
= arguments
.first
.mtype
1131 res
= self.new_var
(ret
)
1132 else if ret
== null then
1135 ret
= ret
.resolve_for
(mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.mmodule
, true)
1136 res
= self.new_var
(ret
)
1139 if mmethoddef
.is_intern
and not compiler
.modelbuilder
.toolcontext
.opt_no_inline_intern
.value
then
1140 compiler
.modelbuilder
.nb_invok_by_inline
+= 1
1141 var frame
= new Frame(self, mmethoddef
, recvtype
, arguments
)
1142 frame
.returnlabel
= self.get_name
("RET_LABEL")
1143 frame
.returnvar
= res
1144 var old_frame
= self.frame
1146 self.add
("\{ /* Inline {mmethoddef} ({arguments.join(",")}) */")
1147 mmethoddef
.compile_inside_to_c
(self, arguments
)
1148 self.add
("{frame.returnlabel.as(not null)}:(void)0;")
1150 self.frame
= old_frame
1153 compiler
.modelbuilder
.nb_invok_by_direct
+= 1
1156 self.adapt_signature
(mmethoddef
, arguments
)
1158 self.require_declaration
(mmethoddef
.c_name
)
1160 self.add
("{mmethoddef.c_name}({arguments.join(", ")});")
1163 self.add
("{res} = {mmethoddef.c_name}({arguments.join(", ")});")
1169 redef fun supercall
(m
: MMethodDef, recvtype
: MClassType, arguments
: Array[RuntimeVariable]): nullable RuntimeVariable
1171 if arguments
.first
.mcasttype
.ctype
!= "val*" then
1172 # In order to shortcut the primitive, we need to find the most specific method
1173 # However, because of performance (no flattening), we always work on the realmainmodule
1174 var main
= self.compiler
.mainmodule
1175 self.compiler
.mainmodule
= self.compiler
.realmainmodule
1176 var res
= self.monomorphic_super_send
(m
, recvtype
, arguments
)
1177 self.compiler
.mainmodule
= main
1180 return table_send
(m
.mproperty
, arguments
, m
.const_color
)
1183 redef fun vararg_instance
(mpropdef
, recv
, varargs
, elttype
)
1185 # A vararg must be stored into an new array
1186 # The trick is that the dymaic type of the array may depends on the receiver
1187 # of the method (ie recv) if the static type is unresolved
1188 # This is more complex than usual because the unresolved type must not be resolved
1189 # with the current receiver (ie self).
1190 # Therefore to isolate the resolution from self, a local Frame is created.
1191 # One can see this implementation as an inlined method of the receiver whose only
1192 # job is to allocate the array
1193 var old_frame
= self.frame
1194 var frame
= new Frame(self, mpropdef
, mpropdef
.mclassdef
.bound_mtype
, [recv
])
1196 #print "required Array[{elttype}] for recv {recv.inspect}. bound=Array[{self.resolve_for(elttype, recv)}]. selfvar={frame.arguments.first.inspect}"
1197 var res
= self.array_instance
(varargs
, elttype
)
1198 self.frame
= old_frame
1202 redef fun isset_attribute
(a
, recv
)
1204 self.check_recv_notnull
(recv
)
1205 var res
= self.new_var
(bool_type
)
1207 # What is the declared type of the attribute?
1208 var mtype
= a
.intro
.static_mtype
.as(not null)
1209 var intromclassdef
= a
.intro
.mclassdef
1210 mtype
= mtype
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1212 if mtype
isa MNullableType then
1213 self.add
("{res} = 1; /* easy isset: {a} on {recv.inspect} */")
1217 self.require_declaration
(a
.const_color
)
1218 if self.compiler
.modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
1219 self.add
("{res} = {recv}->attrs[{a.const_color}] != NULL; /* {a} on {recv.inspect}*/")
1222 if mtype
.ctype
== "val*" then
1223 self.add
("{res} = {recv}->attrs[{a.const_color}].val != NULL; /* {a} on {recv.inspect} */")
1225 self.add
("{res} = 1; /* NOT YET IMPLEMENTED: isset of primitives: {a} on {recv.inspect} */")
1231 redef fun read_attribute
(a
, recv
)
1233 self.check_recv_notnull
(recv
)
1235 # What is the declared type of the attribute?
1236 var ret
= a
.intro
.static_mtype
.as(not null)
1237 var intromclassdef
= a
.intro
.mclassdef
1238 ret
= ret
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1240 self.require_declaration
(a
.const_color
)
1241 if self.compiler
.modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
1242 # Get the attribute or a box (ie. always a val*)
1243 var cret
= self.object_type
.as_nullable
1244 var res
= self.new_var
(cret
)
1247 self.add
("{res} = {recv}->attrs[{a.const_color}]; /* {a} on {recv.inspect} */")
1249 # Check for Uninitialized attribute
1250 if not ret
isa MNullableType and not self.compiler
.modelbuilder
.toolcontext
.opt_no_check_initialization
.value
then
1251 self.add
("if (unlikely({res} == NULL)) \{")
1252 self.add_abort
("Uninitialized attribute {a.name}")
1256 # Return the attribute or its unboxed version
1257 # Note: it is mandatory since we reuse the box on write, we do not whant that the box escapes
1258 return self.autobox
(res
, ret
)
1260 var res
= self.new_var
(ret
)
1261 self.add
("{res} = {recv}->attrs[{a.const_color}].{ret.ctypename}; /* {a} on {recv.inspect} */")
1263 # Check for Uninitialized attribute
1264 if ret
.ctype
== "val*" and not ret
isa MNullableType and not self.compiler
.modelbuilder
.toolcontext
.opt_no_check_initialization
.value
then
1265 self.add
("if (unlikely({res} == NULL)) \{")
1266 self.add_abort
("Uninitialized attribute {a.name}")
1274 redef fun write_attribute
(a
, recv
, value
)
1276 self.check_recv_notnull
(recv
)
1278 # What is the declared type of the attribute?
1279 var mtype
= a
.intro
.static_mtype
.as(not null)
1280 var intromclassdef
= a
.intro
.mclassdef
1281 mtype
= mtype
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1283 # Adapt the value to the declared type
1284 value
= self.autobox
(value
, mtype
)
1286 self.require_declaration
(a
.const_color
)
1287 if self.compiler
.modelbuilder
.toolcontext
.opt_no_union_attribute
.value
then
1288 var attr
= "{recv}->attrs[{a.const_color}]"
1289 if mtype
.ctype
!= "val*" then
1290 assert mtype
isa MClassType
1291 # The attribute is primitive, thus we store it in a box
1292 # The trick is to create the box the first time then resuse the box
1293 self.add
("if ({attr} != NULL) \{")
1294 self.add
("((struct instance_{mtype.c_instance_name}*){attr})->value = {value}; /* {a} on {recv.inspect} */")
1295 self.add
("\} else \{")
1296 value
= self.autobox
(value
, self.object_type
.as_nullable
)
1297 self.add
("{attr} = {value}; /* {a} on {recv.inspect} */")
1300 # The attribute is not primitive, thus store it direclty
1301 self.add
("{attr} = {value}; /* {a} on {recv.inspect} */")
1304 self.add
("{recv}->attrs[{a.const_color}].{mtype.ctypename} = {value}; /* {a} on {recv.inspect} */")
1308 # Check that mtype is a live open type
1309 fun hardening_live_open_type
(mtype
: MType)
1311 if not compiler
.modelbuilder
.toolcontext
.opt_hardening
.value
then return
1312 self.require_declaration
(mtype
.const_color
)
1313 var col
= mtype
.const_color
1314 self.add
("if({col} == -1) \{")
1315 self.add
("fprintf(stderr, \"Resolution of a dead open
type: %s\\n\
", \"{mtype.to_s.escape_to_c}\
");")
1316 self.add_abort
("open type dead")
1320 # Check that mtype it a pointer to a live cast type
1321 fun hardening_cast_type
(t
: String)
1323 if not compiler
.modelbuilder
.toolcontext
.opt_hardening
.value
then return
1324 add
("if({t} == NULL) \{")
1325 add_abort
("cast type null")
1327 add
("if({t}->id == -1 || {t}->color == -1) \{")
1328 add
("fprintf(stderr, \"Try to cast on a dead cast
type: %s\\n\
", {t}->name);")
1329 add_abort
("cast type dead")
1333 redef fun init_instance
(mtype
)
1335 self.require_declaration
("NEW_{mtype.mclass.c_name}")
1336 var compiler
= self.compiler
1337 if mtype
isa MGenericType and mtype
.need_anchor
then
1338 hardening_live_open_type
(mtype
)
1339 link_unresolved_type
(self.frame
.mpropdef
.mclassdef
, mtype
)
1340 var recv
= self.frame
.arguments
.first
1341 var recv_type_info
= self.type_info
(recv
)
1342 self.require_declaration
(mtype
.const_color
)
1343 if compiler
.modelbuilder
.toolcontext
.opt_phmod_typing
.value
or compiler
.modelbuilder
.toolcontext
.opt_phand_typing
.value
then
1344 return self.new_expr
("NEW_{mtype.mclass.c_name}({recv_type_info}->resolution_table->types[HASH({recv_type_info}->resolution_table->mask, {mtype.const_color})])", mtype
)
1346 return self.new_expr
("NEW_{mtype.mclass.c_name}({recv_type_info}->resolution_table->types[{mtype.const_color}])", mtype
)
1349 compiler
.undead_types
.add
(mtype
)
1350 self.require_declaration
("type_{mtype.c_name}")
1351 return self.new_expr
("NEW_{mtype.mclass.c_name}(&type_{mtype.c_name})", mtype
)
1354 redef fun type_test
(value
, mtype
, tag
)
1356 self.add
("/* {value.inspect} isa {mtype} */")
1357 var compiler
= self.compiler
1359 var recv
= self.frame
.arguments
.first
1360 var recv_type_info
= self.type_info
(recv
)
1362 var res
= self.new_var
(bool_type
)
1364 var cltype
= self.get_name
("cltype")
1365 self.add_decl
("int {cltype};")
1366 var idtype
= self.get_name
("idtype")
1367 self.add_decl
("int {idtype};")
1369 var maybe_null
= self.maybe_null
(value
)
1370 var accept_null
= "0"
1372 if ntype
isa MNullableType then
1377 if value
.mcasttype
.is_subtype
(self.frame
.mpropdef
.mclassdef
.mmodule
, self.frame
.mpropdef
.mclassdef
.bound_mtype
, mtype
) then
1378 self.add
("{res} = 1; /* easy {value.inspect} isa {mtype}*/")
1379 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
1380 self.compiler
.count_type_test_skipped
[tag
] += 1
1381 self.add
("count_type_test_skipped_{tag}++;")
1386 if ntype
.need_anchor
then
1387 var type_struct
= self.get_name
("type_struct")
1388 self.add_decl
("const struct type* {type_struct};")
1390 # Either with resolution_table with a direct resolution
1391 hardening_live_open_type
(mtype
)
1392 link_unresolved_type
(self.frame
.mpropdef
.mclassdef
, mtype
)
1393 self.require_declaration
(mtype
.const_color
)
1394 if compiler
.modelbuilder
.toolcontext
.opt_phmod_typing
.value
or compiler
.modelbuilder
.toolcontext
.opt_phand_typing
.value
then
1395 self.add
("{type_struct} = {recv_type_info}->resolution_table->types[HASH({recv_type_info}->resolution_table->mask, {mtype.const_color})];")
1397 self.add
("{type_struct} = {recv_type_info}->resolution_table->types[{mtype.const_color}];")
1399 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
1400 self.compiler
.count_type_test_unresolved
[tag
] += 1
1401 self.add
("count_type_test_unresolved_{tag}++;")
1403 hardening_cast_type
(type_struct
)
1404 self.add
("{cltype} = {type_struct}->color;")
1405 self.add
("{idtype} = {type_struct}->id;")
1406 if maybe_null
and accept_null
== "0" then
1407 var is_nullable
= self.get_name
("is_nullable")
1408 self.add_decl
("short int {is_nullable};")
1409 self.add
("{is_nullable} = {type_struct}->is_nullable;")
1410 accept_null
= is_nullable
.to_s
1412 else if ntype
isa MClassType then
1413 compiler
.undead_types
.add
(mtype
)
1414 self.require_declaration
("type_{mtype.c_name}")
1415 hardening_cast_type
("(&type_{mtype.c_name})")
1416 self.add
("{cltype} = type_{mtype.c_name}.color;")
1417 self.add
("{idtype} = type_{mtype.c_name}.id;")
1418 if compiler
.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
1419 self.compiler
.count_type_test_resolved
[tag
] += 1
1420 self.add
("count_type_test_resolved_{tag}++;")
1423 self.add
("printf(\"NOT YET IMPLEMENTED: type_test
(%s
, {mtype}).\\n\
", \"{value.inspect}\
"); show_backtrace(1);")
1426 # check color is in table
1428 self.add
("if({value} == NULL) \{")
1429 self.add
("{res} = {accept_null};")
1430 self.add
("\} else \{")
1432 var value_type_info
= self.type_info
(value
)
1433 if compiler
.modelbuilder
.toolcontext
.opt_phmod_typing
.value
or compiler
.modelbuilder
.toolcontext
.opt_phand_typing
.value
then
1434 self.add
("{cltype} = HASH({value_type_info}->color, {idtype});")
1436 self.add
("if({cltype} >= {value_type_info}->table_size) \{")
1437 self.add
("{res} = 0;")
1438 self.add
("\} else \{")
1439 self.add
("{res} = {value_type_info}->type_table[{cltype}] == {idtype};")
1448 redef fun is_same_type_test
(value1
, value2
)
1450 var res
= self.new_var
(bool_type
)
1451 # Swap values to be symetric
1452 if value2
.mtype
.ctype
!= "val*" and value1
.mtype
.ctype
== "val*" then
1457 if value1
.mtype
.ctype
!= "val*" then
1458 if value2
.mtype
== value1
.mtype
then
1459 self.add
("{res} = 1; /* is_same_type_test: compatible types {value1.mtype} vs. {value2.mtype} */")
1460 else if value2
.mtype
.ctype
!= "val*" then
1461 self.add
("{res} = 0; /* is_same_type_test: incompatible types {value1.mtype} vs. {value2.mtype}*/")
1463 var mtype1
= value1
.mtype
.as(MClassType)
1464 self.require_declaration
("class_{mtype1.c_name}")
1465 self.add
("{res} = ({value2} != NULL) && ({value2}->class == &class_{mtype1.c_name}); /* is_same_type_test */")
1468 self.add
("{res} = ({value1} == {value2}) || ({value1} != NULL && {value2} != NULL && {value1}->class == {value2}->class); /* is_same_type_test */")
1473 redef fun class_name_string
(value
)
1475 var res
= self.get_name
("var_class_name")
1476 self.add_decl
("const char* {res};")
1477 if value
.mtype
.ctype
== "val*" then
1478 self.add
"{res} = {value} == NULL ? \"null\
" : {value}->type->name;"
1479 else if value
.mtype
isa MClassType and value
.mtype
.as(MClassType).mclass
.kind
== extern_kind
then
1480 self.add
"{res} = \"{value.mtype.as(MClassType).mclass}\
";"
1482 self.require_declaration
("type_{value.mtype.c_name}")
1483 self.add
"{res} = type_{value.mtype.c_name}.name;"
1488 redef fun equal_test
(value1
, value2
)
1490 var res
= self.new_var
(bool_type
)
1491 if value2
.mtype
.ctype
!= "val*" and value1
.mtype
.ctype
== "val*" then
1496 if value1
.mtype
.ctype
!= "val*" then
1497 if value2
.mtype
== value1
.mtype
then
1498 self.add
("{res} = {value1} == {value2};")
1499 else if value2
.mtype
.ctype
!= "val*" then
1500 self.add
("{res} = 0; /* incompatible types {value1.mtype} vs. {value2.mtype}*/")
1502 var mtype1
= value1
.mtype
.as(MClassType)
1503 self.require_declaration
("class_{mtype1.c_name}")
1504 self.add
("{res} = ({value2} != NULL) && ({value2}->class == &class_{mtype1.c_name});")
1505 self.add
("if ({res}) \{")
1506 self.add
("{res} = ({self.autobox(value2, value1.mtype)} == {value1});")
1511 var maybe_null
= true
1512 var test
= new Array[String]
1513 var t1
= value1
.mcasttype
1514 if t1
isa MNullableType then
1515 test
.add
("{value1} != NULL")
1520 var t2
= value2
.mcasttype
1521 if t2
isa MNullableType then
1522 test
.add
("{value2} != NULL")
1528 var incompatible
= false
1530 if t1
.ctype
!= "val*" then
1533 # No need to compare class
1534 else if t2
.ctype
!= "val*" then
1536 else if can_be_primitive
(value2
) then
1537 test
.add
("{value1}->class == {value2}->class")
1541 else if t2
.ctype
!= "val*" then
1543 if can_be_primitive
(value1
) then
1544 test
.add
("{value1}->class == {value2}->class")
1552 if incompatible
then
1554 self.add
("{res} = {value1} == {value2}; /* incompatible types {t1} vs. {t2}; but may be NULL*/")
1557 self.add
("{res} = 0; /* incompatible types {t1} vs. {t2}; cannot be NULL */")
1561 if primitive
!= null then
1562 test
.add
("((struct instance_{primitive.c_instance_name}*){value1})->value == ((struct instance_{primitive.c_instance_name}*){value2})->value")
1563 else if can_be_primitive
(value1
) and can_be_primitive
(value2
) then
1564 test
.add
("{value1}->class == {value2}->class")
1565 var s
= new Array[String]
1566 for t
, v
in self.compiler
.box_kinds
do
1567 s
.add
"({value1}->class->box_kind == {v} && ((struct instance_{t.c_instance_name}*){value1})->value == ((struct instance_{t.c_instance_name}*){value2})->value)"
1569 test
.add
("({s.join(" || ")})")
1571 self.add
("{res} = {value1} == {value2};")
1574 self.add
("{res} = {value1} == {value2} || ({test.join(" && ")});")
1578 fun can_be_primitive
(value
: RuntimeVariable): Bool
1580 var t
= value
.mcasttype
1581 if t
isa MNullableType then t
= t
.mtype
1582 if not t
isa MClassType then return false
1583 var k
= t
.mclass
.kind
1584 return k
== interface_kind
or t
.ctype
!= "val*"
1587 fun maybe_null
(value
: RuntimeVariable): Bool
1589 var t
= value
.mcasttype
1590 return t
isa MNullableType or t
isa MNullType
1593 redef fun array_instance
(array
, elttype
)
1595 var nclass
= self.get_class
("NativeArray")
1596 var arrayclass
= self.get_class
("Array")
1597 var arraytype
= arrayclass
.get_mtype
([elttype
])
1598 var res
= self.init_instance
(arraytype
)
1599 self.add
("\{ /* {res} = array_instance Array[{elttype}] */")
1600 var length
= self.int_instance
(array
.length
)
1601 var nat
= native_array_instance
(elttype
, length
)
1602 for i
in [0..array
.length
[ do
1603 var r
= self.autobox
(array
[i
], self.object_type
)
1604 self.add
("((struct instance_{nclass.c_name}*){nat})->values[{i}] = (val*) {r};")
1606 self.send
(self.get_property
("with_native", arrayclass
.intro
.bound_mtype
), [res
, nat
, length
])
1611 fun native_array_instance
(elttype
: MType, length
: RuntimeVariable): RuntimeVariable
1613 var mtype
= self.get_class
("NativeArray").get_mtype
([elttype
])
1614 self.require_declaration
("NEW_{mtype.mclass.c_name}")
1615 assert mtype
isa MGenericType
1616 var compiler
= self.compiler
1617 if mtype
.need_anchor
then
1618 hardening_live_open_type
(mtype
)
1619 link_unresolved_type
(self.frame
.mpropdef
.mclassdef
, mtype
)
1620 var recv
= self.frame
.arguments
.first
1621 var recv_type_info
= self.type_info
(recv
)
1622 self.require_declaration
(mtype
.const_color
)
1623 if compiler
.modelbuilder
.toolcontext
.opt_phmod_typing
.value
or compiler
.modelbuilder
.toolcontext
.opt_phand_typing
.value
then
1624 return self.new_expr
("NEW_{mtype.mclass.c_name}({length}, {recv_type_info}->resolution_table->types[HASH({recv_type_info}->resolution_table->mask, {mtype.const_color})])", mtype
)
1626 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
== "copy_to" then
1646 var recv1
= "((struct instance_{nclass.c_instance_name}*){arguments[1]})->values"
1647 self.add
("memcpy({recv1}, {recv}, {arguments[2]}*sizeof({elttype.ctype}));")
1652 redef fun calloc_array
(ret_type
, arguments
)
1654 var mclass
= self.get_class
("ArrayCapable")
1655 var ft
= mclass
.mclass_type
.arguments
.first
.as(MParameterType)
1656 var res
= self.native_array_instance
(ft
, arguments
[1])
1660 fun link_unresolved_type
(mclassdef
: MClassDef, mtype
: MType) do
1661 assert mtype
.need_anchor
1662 var compiler
= self.compiler
1663 if not compiler
.live_unresolved_types
.has_key
(self.frame
.mpropdef
.mclassdef
) then
1664 compiler
.live_unresolved_types
[self.frame
.mpropdef
.mclassdef
] = new HashSet[MType]
1666 compiler
.live_unresolved_types
[self.frame
.mpropdef
.mclassdef
].add
(mtype
)
1670 redef class MMethodDef
1671 fun separate_runtime_function
: AbstractRuntimeFunction
1673 var res
= self.separate_runtime_function_cache
1675 res
= new SeparateRuntimeFunction(self)
1676 self.separate_runtime_function_cache
= res
1680 private var separate_runtime_function_cache
: nullable SeparateRuntimeFunction
1682 fun virtual_runtime_function
: AbstractRuntimeFunction
1684 var res
= self.virtual_runtime_function_cache
1686 res
= new VirtualRuntimeFunction(self)
1687 self.virtual_runtime_function_cache
= res
1691 private var virtual_runtime_function_cache
: nullable VirtualRuntimeFunction
1694 # The C function associated to a methoddef separately compiled
1695 class SeparateRuntimeFunction
1696 super AbstractRuntimeFunction
1698 redef fun build_c_name
: String do return "{mmethoddef.c_name}"
1700 redef fun to_s
do return self.mmethoddef
.to_s
1702 redef fun compile_to_c
(compiler
)
1704 var mmethoddef
= self.mmethoddef
1706 var recv
= self.mmethoddef
.mclassdef
.bound_mtype
1707 var v
= compiler
.new_visitor
1708 var selfvar
= new RuntimeVariable("self", recv
, recv
)
1709 var arguments
= new Array[RuntimeVariable]
1710 var frame
= new Frame(v
, mmethoddef
, recv
, arguments
)
1713 var msignature
= mmethoddef
.msignature
.resolve_for
(mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
.mclassdef
.mmodule
, true)
1715 var sig
= new Buffer
1716 var comment
= new Buffer
1717 var ret
= msignature
.return_mtype
1719 sig
.append
("{ret.ctype} ")
1720 else if mmethoddef
.mproperty
.is_new
then
1722 sig
.append
("{ret.ctype} ")
1726 sig
.append
(self.c_name
)
1727 sig
.append
("({selfvar.mtype.ctype} {selfvar}")
1728 comment
.append
("({selfvar}: {selfvar.mtype}")
1729 arguments
.add
(selfvar
)
1730 for i
in [0..msignature
.arity
[ do
1731 var mtype
= msignature
.mparameters
[i
].mtype
1732 if i
== msignature
.vararg_rank
then
1733 mtype
= v
.get_class
("Array").get_mtype
([mtype
])
1735 comment
.append
(", {mtype}")
1736 sig
.append
(", {mtype.ctype} p{i}")
1737 var argvar
= new RuntimeVariable("p{i}", mtype
, mtype
)
1738 arguments
.add
(argvar
)
1743 comment
.append
(": {ret}")
1745 compiler
.provide_declaration
(self.c_name
, "{sig};")
1747 v
.add_decl
("/* method {self} for {comment} */")
1748 v
.add_decl
("{sig} \{")
1750 frame
.returnvar
= v
.new_var
(ret
)
1752 frame
.returnlabel
= v
.get_name
("RET_LABEL")
1754 if recv
!= arguments
.first
.mtype
then
1755 #print "{self} {recv} {arguments.first}"
1757 mmethoddef
.compile_inside_to_c
(v
, arguments
)
1759 v
.add
("{frame.returnlabel.as(not null)}:;")
1761 v
.add
("return {frame.returnvar.as(not null)};")
1764 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})"
1768 # The C function associated to a methoddef on a primitive type, stored into a VFT of a class
1769 # The first parameter (the reciever) is always typed by val* in order to accept an object value
1770 class VirtualRuntimeFunction
1771 super AbstractRuntimeFunction
1773 redef fun build_c_name
: String do return "VIRTUAL_{mmethoddef.c_name}"
1775 redef fun to_s
do return self.mmethoddef
.to_s
1777 redef fun compile_to_c
(compiler
)
1779 var mmethoddef
= self.mmethoddef
1781 var recv
= self.mmethoddef
.mclassdef
.bound_mtype
1782 var v
= compiler
.new_visitor
1783 var selfvar
= new RuntimeVariable("self", v
.object_type
, recv
)
1784 var arguments
= new Array[RuntimeVariable]
1785 var frame
= new Frame(v
, mmethoddef
, recv
, arguments
)
1788 var sig
= new Buffer
1789 var comment
= new Buffer
1791 # Because the function is virtual, the signature must match the one of the original class
1792 var intromclassdef
= self.mmethoddef
.mproperty
.intro
.mclassdef
1793 var msignature
= mmethoddef
.mproperty
.intro
.msignature
.resolve_for
(intromclassdef
.bound_mtype
, intromclassdef
.bound_mtype
, intromclassdef
.mmodule
, true)
1794 var ret
= msignature
.return_mtype
1796 sig
.append
("{ret.ctype} ")
1797 else if mmethoddef
.mproperty
.is_new
then
1799 sig
.append
("{ret.ctype} ")
1803 sig
.append
(self.c_name
)
1804 sig
.append
("({selfvar.mtype.ctype} {selfvar}")
1805 comment
.append
("({selfvar}: {selfvar.mtype}")
1806 arguments
.add
(selfvar
)
1807 for i
in [0..msignature
.arity
[ do
1808 var mtype
= msignature
.mparameters
[i
].mtype
1809 if i
== msignature
.vararg_rank
then
1810 mtype
= v
.get_class
("Array").get_mtype
([mtype
])
1812 comment
.append
(", {mtype}")
1813 sig
.append
(", {mtype.ctype} p{i}")
1814 var argvar
= new RuntimeVariable("p{i}", mtype
, mtype
)
1815 arguments
.add
(argvar
)
1820 comment
.append
(": {ret}")
1822 compiler
.provide_declaration
(self.c_name
, "{sig};")
1824 v
.add_decl
("/* method {self} for {comment} */")
1825 v
.add_decl
("{sig} \{")
1827 frame
.returnvar
= v
.new_var
(ret
)
1829 frame
.returnlabel
= v
.get_name
("RET_LABEL")
1831 var subret
= v
.call
(mmethoddef
, recv
, arguments
)
1833 assert subret
!= null
1834 v
.assign
(frame
.returnvar
.as(not null), subret
)
1837 v
.add
("{frame.returnlabel.as(not null)}:;")
1839 v
.add
("return {frame.returnvar.as(not null)};")
1842 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})"
1846 redef fun call
(v
, arguments
) do abort
1850 fun const_color
: String do return "COLOR_{c_name}"
1852 # C name of the instance type to use
1853 fun c_instance_name
: String do return c_name
1856 redef class MClassType
1857 redef fun c_instance_name
do return mclass
.c_instance_name
1861 # Extern classes use the C instance of kernel::Pointer
1862 fun c_instance_name
: String
1864 if kind
== extern_kind
then
1865 return "kernel__Pointer"
1870 redef class MProperty
1871 fun const_color
: String do return "COLOR_{c_name}"
1874 redef class MPropDef
1875 fun const_color
: String do return "COLOR_{c_name}"