1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
18 # Rapid type analysis on the AST
20 # Rapid type analysis is an analyse that aproximates the set of live classes
21 # and the set of live methods starting from the entry point of the program.
22 # These two sets are interdependant and computed together.
23 # It is quite efficient but the type set is global and pollutes each call site.
24 module rapid_type_analysis
28 private import csv
# for live_types_to_csv
29 private import ordered_tree
# for live_methods_to_tree
31 private import more_collections
33 redef class ModelBuilder
34 # Performs a rapid-type-analysis on the program associated with `mainmodule`.
35 fun do_rapid_type_analysis
(mainmodule
: MModule): RapidTypeAnalysis
37 var analysis
= new RapidTypeAnalysis(self, mainmodule
)
40 if toolcontext
.opt_log
.value
then
41 var basename
= toolcontext
.log_directory
/ mainmodule
.name
42 analysis
.live_methods_to_tree
.write_to_file
(basename
+ ".rta_methods.txt")
43 analysis
.live_types_to_csv
.write_to_file
(basename
+ ".rta_types.csv")
50 # RapidTypeAnalysis looks for alive rapid types in application.
51 # The entry point of the analysis is the mainmodule of the application.
52 class RapidTypeAnalysis
53 # The modelbuilder used to get the AST.
54 var modelbuilder
: ModelBuilder
56 # The main module of the analysis.
57 # Used to perform types operations.
58 var mainmodule
: MModule
60 # The pool to live types.
61 # During the analysis, new types are added and combined with
62 # live_methods to determine new methoddefs to visit
63 var live_types
= new HashSet[MClassType]
65 # The pool of undesolved live types
66 # They are globally resolved at the end of the analaysis
67 var live_open_types
= new HashSet[MClassType]
69 # Live (instantiated) classes.
70 var live_classes
= new HashSet[MClass]
72 # The pool of types used to perform type checks (isa and as).
73 var live_cast_types
= new HashSet[MType]
75 # The pool of undesolved types used to perform type checks (isa and as).
76 # They are globally resolved at the end of the analaysis
77 var live_open_cast_types
= new HashSet[MType]
79 # Live method definitions.
80 var live_methoddefs
= new HashSet[MMethodDef]
83 var live_methods
= new HashSet[MMethod]
86 var live_callsites
= new HashSet[CallSite]
88 private var live_targets_cache
= new HashMap2[MType, MProperty, Set[MMethodDef]]
90 # The live targets of a specific callsite.
91 fun live_targets
(callsite
: CallSite): Set[MMethodDef]
93 var mtype
= callsite
.recv
94 var anchor
= callsite
.anchor
95 if anchor
!= null then mtype
= mtype
.anchor_to
(callsite
.mmodule
, anchor
)
96 mtype
= mtype
.undecorate
97 if mtype
isa MClassType then mtype
= mtype
.mclass
.intro
.bound_mtype
98 var mproperty
= callsite
.mproperty
99 var res
= live_targets_cache
[mtype
, mproperty
]
100 if res
!= null then return res
101 res
= new ArraySet[MMethodDef]
102 live_targets_cache
[mtype
, mproperty
] = res
104 for c
in live_classes
do
105 var tc
= c
.intro
.bound_mtype
106 if not tc
.is_subtype
(mainmodule
, null, mtype
) then continue
107 var d
= mproperty
.lookup_first_definition
(mainmodule
, tc
)
114 # Live call-to-super.
115 var live_super_sends
= new HashSet[MMethodDef]
117 # Return a ready-to-save CSV document objet that agregates informations about live types.
118 # Each discovered type is listed in a line, with its status: resolution, liveness, cast-liveness.
119 # Note: types are listed in an alphanumeric order to improve human reading.
120 fun live_types_to_csv
: CsvDocument
122 # Gather all kind of type
123 var typeset
= new HashSet[MType]
124 typeset
.add_all
(live_types
)
125 typeset
.add_all
(live_open_types
)
126 typeset
.add_all
(live_cast_types
)
127 typeset
.add_all
(live_open_cast_types
)
128 var types
= typeset
.to_a
129 (new CachedAlphaComparator).sort
(types
)
130 var res
= new CsvDocument
131 res
.format
= new CsvFormat('"', ';', "\n")
132 res
.header
= ["Type", "Resolution", "Liveness", "Cast-liveness"]
135 if t
.need_anchor
then reso
= "OPEN " else reso
= "CLOSED"
137 if t
isa MClassType and (live_types
.has
(t
) or live_open_types
.has
(t
)) then live
= "LIVE" else live
= "DEAD"
139 if live_cast_types
.has
(t
) or live_open_cast_types
.has
(t
) then cast
= "CAST LIVE" else cast
= "CAST DEAD"
140 res
.add_record
(t
, reso
, live
, cast
)
145 # Return a ready-to-save OrderedTree object that agregates infomration about live methods.
146 # Note: methods are listed in an alphanumeric order to improve human reading.
147 fun live_methods_to_tree
: OrderedTree[Object]
149 var tree
= new OrderedTree[Object]
150 for x
in live_methods
do
153 for z
in x
.mpropdefs
do
155 if live_methoddefs
.has
(z
) then
157 if live_super_sends
.has
(z
) then
158 tree
.add
(zn
, zn
+ "(super)")
160 else if live_super_sends
.has
(z
) then
161 tree
.add
(xn
, zn
+ "(super)")
165 tree
.sort_with
(alpha_comparator
)
169 # Methods that are still candidate to the try_send
170 private var totry_methods
= new HashSet[MMethod]
172 # Methods that are are no more candidate to the try_send
173 private var totry_methods_to_remove
= new Array[MMethod]
175 # Methods that are or were candidate to the try_send
176 # Used to ensure that try_send is only used once
177 private var try_methods
= new HashSet[MMethod]
179 # The method definitions that remain to visit
180 private var todo
= new List[MMethodDef]
182 private fun force_alive
(classname
: String)
184 var classes
= self.modelbuilder
.model
.get_mclasses_by_name
(classname
)
185 if classes
!= null then for c
in classes
do self.add_new
(c
.mclass_type
, c
.mclass_type
)
188 # Run the analysis until all visitable method definitions are visited.
191 var maintype
= mainmodule
.sys_type
192 if maintype
== null then return # No entry point
193 add_new
(maintype
, maintype
)
194 var initprop
= mainmodule
.try_get_primitive_method
("init", maintype
.mclass
)
195 if initprop
!= null then
196 add_send
(maintype
, initprop
)
198 var mainprop
= mainmodule
.try_get_primitive_method
("run", maintype
.mclass
) or else
199 mainmodule
.try_get_primitive_method
("main", maintype
.mclass
)
200 if mainprop
!= null then
201 add_send
(maintype
, mainprop
)
204 var finalizable_type
= mainmodule
.finalizable_type
205 if finalizable_type
!= null then
206 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
207 if finalize_meth
!= null then add_send
(finalizable_type
, finalize_meth
)
210 # Force primitive types
215 force_alive
("Pointer")
218 while not todo
.is_empty
do
219 var mmethoddef
= todo
.shift
220 var mmeth
= mmethoddef
.mproperty
221 var msignature
= mmethoddef
.msignature
222 if msignature
== null then continue # Skip broken method
224 #print "# visit {mmethoddef}"
225 var v
= new RapidTypeVisitor(self, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
)
227 var vararg_rank
= msignature
.vararg_rank
228 if vararg_rank
> -1 then
229 var node
= self.modelbuilder
.mpropdef2node
(mmethoddef
)
230 var elttype
= msignature
.mparameters
[vararg_rank
].mtype
231 #elttype = elttype.anchor_to(self.mainmodule, v.receiver)
232 var vararg
= self.mainmodule
.array_type
(elttype
)
234 var native
= self.mainmodule
.native_array_type
(elttype
)
236 v
.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
.mclass
, self.mainmodule
))
239 # TODO? new_msignature
241 var osig
= mmeth
.intro
.msignature
.as(not null)
242 for i
in [0..sig
.arity
[ do
243 var origtype
= osig
.mparameters
[i
].mtype
244 if not origtype
.need_anchor
then continue # skip non covariant stuff
245 var paramtype
= sig
.mparameters
[i
].mtype
249 var npropdef
= modelbuilder
.mpropdef2node
(mmethoddef
)
251 if npropdef
isa AClassdef then
252 # It is an init for a class
253 assert mmethoddef
== npropdef
.mfree_init
255 if mmethoddef
.mproperty
.is_root_init
and not mmethoddef
.is_intro
then
256 self.add_super_send
(v
.receiver
, mmethoddef
)
259 else if mmethoddef
.constant_value
!= null then
260 # Make the return type live
261 v
.add_type
(msignature
.return_mtype
.as(MClassType))
263 else if npropdef
== null then
267 if npropdef
isa AMethPropdef then
268 var auto_super_inits
= npropdef
.auto_super_inits
269 if auto_super_inits
!= null then
270 for auto_super_init
in auto_super_inits
do
271 v
.add_callsite
(auto_super_init
)
274 if npropdef
.auto_super_call
then
275 self.add_super_send
(v
.receiver
, mmethoddef
)
279 if mmethoddef
.is_intern
or mmethoddef
.is_extern
then
280 # UGLY: We force the "instantation" of the concrete return type if any
281 var ret
= msignature
.return_mtype
282 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
287 v
.enter_visit
(npropdef
)
290 #print "MMethod {live_methods.length}: {live_methods.join(", ")}"
291 #print "MMethodDef {live_methoddefs.length}: {live_methoddefs.join(", ")}"
293 #print "open MType {live_open_types.length}: {live_open_types.join(", ")}"
294 var todo_types
= new List[MClassType]
295 todo_types
.add_all
(live_types
)
296 while not todo_types
.is_empty
do
297 var t
= todo_types
.shift
298 for ot
in live_open_types
do
300 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
301 var rt
= ot
.anchor_to
(mainmodule
, t
)
302 if live_types
.has
(rt
) then continue
303 if not check_depth
(rt
) then continue
304 #print "{ot}/{t} -> {rt}"
309 #print "MType {live_types.length}: {live_types.join(", ")}"
311 #print "open cast MType {live_open_cast_types.length}: {live_open_cast_types.join(", ")}"
312 for ot
in live_open_cast_types
do
313 #print "live_open_cast_type: {ot}"
314 for t
in live_types
do
315 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
316 var rt
= ot
.anchor_to
(mainmodule
, t
)
317 live_cast_types
.add
(rt
)
318 #print " {ot}/{t} -> {rt}"
321 #print "cast MType {live_cast_types.length}: {live_cast_types.join(", ")}"
324 private fun check_depth
(mtype
: MClassType): Bool
328 self.modelbuilder
.toolcontext
.fatal_error
(null, "Fatal Error: limitation in the rapidtype analysis engine: a type depth of {d} is too important, the problematic type is `{mtype}`.")
334 fun add_new
(recv
: MClassType, mtype
: MClassType)
336 assert not recv
.need_anchor
337 if mtype
.need_anchor
then
338 if live_open_types
.has
(mtype
) then return
339 live_open_types
.add
(mtype
)
341 if live_types
.has
(mtype
) then return
342 live_types
.add
(mtype
)
345 var mclass
= mtype
.mclass
346 if live_classes
.has
(mclass
) then return
347 live_classes
.add
(mclass
)
349 for p
in totry_methods
do try_send
(mtype
, p
)
350 for p
in live_super_sends
do try_super_send
(mtype
, p
)
352 # Remove cleared ones
353 for p
in totry_methods_to_remove
do totry_methods
.remove
(p
)
354 totry_methods_to_remove
.clear
356 var bound_mtype
= mtype
.anchor_to
(mainmodule
, recv
)
357 for cd
in bound_mtype
.collect_mclassdefs
(mainmodule
)
359 for npropdef
in modelbuilder
.collect_attr_propdef
(cd
) do
360 if not npropdef
.has_value
then continue
362 var mpropdef
= npropdef
.mreadpropdef
.as(not null)
363 var v
= new RapidTypeVisitor(self, bound_mtype
, mpropdef
)
364 v
.enter_visit
(npropdef
.n_expr
)
365 v
.enter_visit
(npropdef
.n_block
)
371 fun add_cast
(mtype
: MType)
373 if mtype
.need_anchor
then
374 live_open_cast_types
.add
(mtype
)
376 live_cast_types
.add
(mtype
)
380 fun try_send
(recv
: MClassType, mproperty
: MMethod)
382 recv
= recv
.mclass
.intro
.bound_mtype
383 if not recv
.has_mproperty
(mainmodule
, mproperty
) then return
384 var d
= mproperty
.lookup_first_definition
(mainmodule
, recv
)
388 fun add_call
(mpropdef
: MMethodDef)
390 if live_methoddefs
.has
(mpropdef
) then return
391 live_methoddefs
.add
(mpropdef
)
394 var mproperty
= mpropdef
.mproperty
395 if mproperty
.mpropdefs
.length
<= 1 then return
396 # If all definitions of a method are live, we can remove the definition of the totry set
397 for d
in mproperty
.mpropdefs
do
398 if not live_methoddefs
.has
(d
) then return
400 #print "full property: {mpropdef.mproperty} for {mpropdef.mproperty.mpropdefs.length} definitions"
401 totry_methods_to_remove
.add
(mpropdef
.mproperty
)
404 fun add_send
(recv
: MType, mproperty
: MMethod)
406 if try_methods
.has
(mproperty
) then return
407 #print "new prop: {mproperty}"
408 live_methods
.add
(mproperty
)
409 try_methods
.add
(mproperty
)
410 if mproperty
.mpropdefs
.length
== 1 then
411 # If there is only one definition, just add the definition and do not try again the property
412 var d
= mproperty
.mpropdefs
.first
416 # Else, the property is potentially called with various reciever
417 # So just try the methods with existing receiver and register it for future receiver
418 totry_methods
.add
(mproperty
)
419 for c
in live_classes
do
420 try_send
(c
.intro
.bound_mtype
, mproperty
)
424 fun try_super_send
(recv
: MClassType, mpropdef
: MMethodDef)
426 recv
= recv
.mclass
.intro
.bound_mtype
427 if not recv
.collect_mclassdefs
(mainmodule
).has
(mpropdef
.mclassdef
) then return
428 var d
= mpropdef
.lookup_next_definition
(mainmodule
, recv
)
432 fun add_super_send
(recv
: MType, mpropdef
: MMethodDef)
434 assert mpropdef
.has_supercall
435 if live_super_sends
.has
(mpropdef
) then return
436 #print "new super prop: {mpropdef}"
437 live_super_sends
.add
(mpropdef
)
438 for c
in live_classes
do
439 try_super_send
(c
.intro
.bound_mtype
, mpropdef
)
444 class RapidTypeVisitor
447 var analysis
: RapidTypeAnalysis
448 var receiver
: MClassType
449 var mpropdef
: MPropDef
453 assert not receiver
.need_anchor
459 if n
.mtype
!= null or n
.is_typed
then
460 n
.accept_rapid_type_visitor
(self)
461 var implicit_cast_to
= n
.implicit_cast_to
462 if implicit_cast_to
!= null then self.add_cast_type
(implicit_cast_to
)
465 n
.accept_rapid_type_visitor
(self)
468 # RTA does not enter in AAnnotations
469 if not n
isa AAnnotations then
474 fun cleanup_type
(mtype
: MType): nullable MClassType
476 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
477 if mtype
isa MNullType then return null
478 mtype
= mtype
.undecorate
479 assert mtype
isa MClassType
480 assert not mtype
.need_anchor
484 fun get_method
(recv
: MType, name
: String): MMethod
486 var mtype
= cleanup_type
(recv
)
488 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, mtype
.mclass
, self.analysis
.mainmodule
)
491 fun add_type
(mtype
: MClassType) do analysis
.add_new
(receiver
, mtype
)
493 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
495 analysis
.live_methods
.add
(mproperty
)
496 analysis
.try_send
(mtype
.as(MClassType), mproperty
)
499 fun add_send
(mtype
: MType, mproperty
: MMethod) do analysis
.add_send
(mtype
, mproperty
)
501 fun add_cast_type
(mtype
: MType) do analysis
.add_cast
(mtype
)
503 fun add_callsite
(callsite
: nullable CallSite) do if callsite
!= null then
504 for m
in callsite
.mpropdef
.initializers
do
505 if m
isa MMethod then
506 analysis
.add_send
(callsite
.recv
, m
)
509 analysis
.add_send
(callsite
.recv
, callsite
.mproperty
)
510 analysis
.live_callsites
.add
(callsite
)
517 private fun accept_rapid_type_visitor
(v
: RapidTypeVisitor)
523 # Make the `mtype` of the expression live
524 # Used by literals and instantiations
525 fun allocate_mtype
(v
: RapidTypeVisitor)
527 var mtype
= self.mtype
528 if not mtype
isa MClassType then return
529 v
.add_type
(self.mtype
.as(MClassType))
534 redef fun accept_rapid_type_visitor
(v
)
540 redef class AByteExpr
541 redef fun accept_rapid_type_visitor
(v
)
547 redef class AFloatExpr
548 redef fun accept_rapid_type_visitor
(v
)
554 redef class ACharExpr
555 redef fun accept_rapid_type_visitor
(v
)
561 redef class AArrayExpr
562 redef fun accept_rapid_type_visitor
(v
)
564 var mtype
= self.mtype
.as(MClassType)
566 var native
= v
.analysis
.mainmodule
.native_array_type
(mtype
.arguments
.first
)
568 mtype
= v
.cleanup_type
(mtype
).as(not null)
569 var prop
= v
.get_method
(mtype
, "with_native")
570 v
.add_monomorphic_send
(mtype
, prop
)
571 v
.add_callsite
(with_capacity_callsite
)
572 v
.add_callsite
(push_callsite
)
576 redef class AStringFormExpr
577 redef fun accept_rapid_type_visitor
(v
)
579 var native
= v
.analysis
.mainmodule
.native_string_type
581 var prop
= v
.get_method
(native
, "to_s_with_length")
582 v
.add_monomorphic_send
(native
, prop
)
586 redef class ASuperstringExpr
587 redef fun accept_rapid_type_visitor
(v
)
589 var mmodule
= v
.analysis
.mainmodule
590 var object_type
= mmodule
.string_type
591 var arraytype
= mmodule
.array_type
(object_type
)
592 v
.add_type
(arraytype
)
593 var nattype
= mmodule
.native_array_type
(object_type
)
595 var prop
= v
.get_method
(arraytype
, "join")
596 v
.add_monomorphic_send
(arraytype
, prop
)
597 var prop2
= v
.get_method
(arraytype
, "with_native")
598 v
.add_monomorphic_send
(arraytype
, prop2
)
599 v
.add_monomorphic_send
(nattype
, v
.get_method
(nattype
, "native_to_s"))
603 redef class ACrangeExpr
604 redef fun accept_rapid_type_visitor
(v
)
606 var mtype
= self.mtype
607 if not mtype
isa MClassType then return
609 v
.add_callsite
(init_callsite
)
613 redef class AOrangeExpr
614 redef fun accept_rapid_type_visitor
(v
)
616 var mtype
= self.mtype
617 if not mtype
isa MClassType then return
619 v
.add_callsite
(init_callsite
)
623 redef class ATrueExpr
624 redef fun accept_rapid_type_visitor
(v
)
630 redef class AFalseExpr
631 redef fun accept_rapid_type_visitor
(v
)
638 redef fun accept_rapid_type_visitor
(v
)
640 var cast_type
= self.cast_type
641 if cast_type
== null then return
642 v
.add_cast_type
(cast_type
)
646 redef class AAsCastExpr
647 redef fun accept_rapid_type_visitor
(v
)
649 var mtype
= self.mtype
650 if mtype
== null then return
651 v
.add_cast_type
(mtype
)
655 redef class ASendExpr
656 redef fun accept_rapid_type_visitor
(v
)
658 v
.add_callsite
(callsite
)
663 redef class ASendReassignFormExpr
664 redef fun accept_rapid_type_visitor
(v
)
666 v
.add_callsite
(callsite
)
667 v
.add_callsite
(reassign_callsite
)
668 v
.add_callsite
(write_callsite
)
672 redef class AVarReassignExpr
673 redef fun accept_rapid_type_visitor
(v
)
675 v
.add_callsite
(reassign_callsite
)
679 redef class AAttrReassignExpr
680 redef fun accept_rapid_type_visitor
(v
)
682 v
.add_callsite
(reassign_callsite
)
686 redef class ASuperExpr
687 redef fun accept_rapid_type_visitor
(v
)
689 var callsite
= self.callsite
690 if callsite
!= null then
691 v
.add_callsite
(callsite
)
695 v
.analysis
.add_super_send
(v
.receiver
, mpropdef
.as(not null))
700 redef fun accept_rapid_type_visitor
(v
)
702 v
.add_callsite
(self.method_iterator
)
703 v
.add_callsite
(self.method_is_ok
)
704 if self.variables
.length
== 1 then
705 v
.add_callsite
(self.method_item
)
706 else if self.variables
.length
== 2 then
707 v
.add_callsite
(self.method_key
)
708 v
.add_callsite
(self.method_item
)
712 v
.add_callsite
(self.method_next
)
713 var mf
= self.method_finish
714 if mf
!= null then v
.add_callsite
(mf
)
719 redef fun accept_rapid_type_visitor
(v
)
721 var mtype
= self.recvtype
.as(not null)
723 v
.add_callsite
(callsite
)