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
)
43 # RapidTypeAnalysis looks for alive rapid types in application.
44 # The entry point of the analysis is the mainmodule of the application.
45 class RapidTypeAnalysis
46 # The modelbuilder used to get the AST.
47 var modelbuilder
: ModelBuilder
49 # The main module of the analysis.
50 # Used to perform types operations.
51 var mainmodule
: MModule
53 # The pool to live types.
54 # During the analysis, new types are added and combined with
55 # live_methods to determine new methoddefs to visit
56 var live_types
= new HashSet[MClassType]
58 # The pool of undesolved live types
59 # They are globally resolved at the end of the analaysis
60 var live_open_types
= new HashSet[MClassType]
62 # Live (instantiated) classes.
63 var live_classes
= new HashSet[MClass]
65 # The pool of types used to perform type checks (isa and as).
66 var live_cast_types
= new HashSet[MType]
68 # The pool of undesolved types used to perform type checks (isa and as).
69 # They are globally resolved at the end of the analaysis
70 var live_open_cast_types
= new HashSet[MType]
72 # Live method definitions.
73 var live_methoddefs
= new HashSet[MMethodDef]
76 var live_methods
= new HashSet[MMethod]
79 var live_callsites
= new HashSet[CallSite]
81 private var live_targets_cache
= new HashMap2[MType, MProperty, Set[MMethodDef]]
83 # The live targets of a specific callsite.
84 fun live_targets
(callsite
: CallSite): Set[MMethodDef]
86 var mtype
= callsite
.recv
87 var anchor
= callsite
.anchor
88 if anchor
!= null then mtype
= mtype
.anchor_to
(callsite
.mmodule
, anchor
)
89 mtype
= mtype
.as_notnullable
90 if mtype
isa MClassType then mtype
= mtype
.mclass
.intro
.bound_mtype
91 var mproperty
= callsite
.mproperty
92 var res
= live_targets_cache
[mtype
, mproperty
]
93 if res
!= null then return res
94 res
= new ArraySet[MMethodDef]
95 live_targets_cache
[mtype
, mproperty
] = res
97 for c
in live_classes
do
98 var tc
= c
.intro
.bound_mtype
99 if not tc
.is_subtype
(mainmodule
, null, mtype
) then continue
100 var d
= mproperty
.lookup_first_definition
(mainmodule
, tc
)
107 # Live call-to-super.
108 var live_super_sends
= new HashSet[MMethodDef]
110 # Return a ready-to-save CSV document objet that agregates informations about live types.
111 # Each discovered type is listed in a line, with its status: resolution, liveness, cast-liveness.
112 # Note: types are listed in an alphanumeric order to improve human reading.
113 fun live_types_to_csv
: CsvDocument
115 # Gather all kind of type
116 var typeset
= new HashSet[MType]
117 typeset
.add_all
(live_types
)
118 typeset
.add_all
(live_open_types
)
119 typeset
.add_all
(live_cast_types
)
120 typeset
.add_all
(live_open_cast_types
)
121 var types
= typeset
.to_a
122 (new CachedAlphaComparator).sort
(types
)
123 var res
= new CsvDocument
124 res
.format
= new CsvFormat('"', ';', "\n")
125 res
.header
= ["Type", "Resolution", "Liveness", "Cast-liveness"]
128 if t
.need_anchor
then reso
= "OPEN " else reso
= "CLOSED"
130 if t
isa MClassType and (live_types
.has
(t
) or live_open_types
.has
(t
)) then live
= "LIVE" else live
= "DEAD"
132 if live_cast_types
.has
(t
) or live_open_cast_types
.has
(t
) then cast
= "CAST LIVE" else cast
= "CAST DEAD"
133 res
.add_record
(t
, reso
, live
, cast
)
138 # Return a ready-to-save OrderedTree object that agregates infomration about live methods.
139 # Note: methods are listed in an alphanumeric order to improve human reading.
140 fun live_methods_to_tree
: OrderedTree[Object]
142 var tree
= new OrderedTree[Object]
143 for x
in live_methods
do
146 for z
in x
.mpropdefs
do
148 if live_methoddefs
.has
(z
) then
150 if live_super_sends
.has
(z
) then
151 tree
.add
(zn
, zn
+ "(super)")
153 else if live_super_sends
.has
(z
) then
154 tree
.add
(xn
, zn
+ "(super)")
158 tree
.sort_with
(alpha_comparator
)
162 # Methods that are still candidate to the try_send
163 private var totry_methods
= new HashSet[MMethod]
165 # Methods that are are no more candidate to the try_send
166 private var totry_methods_to_remove
= new Array[MMethod]
168 # Methods that are or were candidate to the try_send
169 # Used to ensure that try_send is only used once
170 private var try_methods
= new HashSet[MMethod]
172 # The method definitions that remain to visit
173 private var todo
= new List[MMethodDef]
175 private fun force_alive
(classname
: String)
177 var classes
= self.modelbuilder
.model
.get_mclasses_by_name
(classname
)
178 if classes
!= null then for c
in classes
do self.add_new
(c
.mclass_type
, c
.mclass_type
)
181 # Run the analysis until all visitable method definitions are visited.
184 var maintype
= mainmodule
.sys_type
185 if maintype
== null then return # No entry point
186 add_new
(maintype
, maintype
)
187 var initprop
= mainmodule
.try_get_primitive_method
("init", maintype
.mclass
)
188 if initprop
!= null then
189 add_send
(maintype
, initprop
)
191 var mainprop
= mainmodule
.try_get_primitive_method
("run", maintype
.mclass
) or else
192 mainmodule
.try_get_primitive_method
("main", maintype
.mclass
)
193 if mainprop
!= null then
194 add_send
(maintype
, mainprop
)
197 var finalizable_type
= mainmodule
.finalizable_type
198 if finalizable_type
!= null then
199 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
200 if finalize_meth
!= null then add_send
(finalizable_type
, finalize_meth
)
203 # Force primitive types
208 force_alive
("Pointer")
210 while not todo
.is_empty
do
211 var mmethoddef
= todo
.shift
212 var mmeth
= mmethoddef
.mproperty
213 #print "# visit {mmethoddef}"
214 var v
= new RapidTypeVisitor(self, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
)
216 var vararg_rank
= mmethoddef
.msignature
.vararg_rank
217 if vararg_rank
> -1 then
218 var node
= self.modelbuilder
.mpropdef2node
(mmethoddef
)
219 var elttype
= mmethoddef
.msignature
.mparameters
[vararg_rank
].mtype
220 #elttype = elttype.anchor_to(self.mainmodule, v.receiver)
221 var vararg
= self.mainmodule
.get_primitive_class
("Array").get_mtype
([elttype
])
223 var native
= self.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([elttype
])
225 v
.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
.mclass
, self.mainmodule
))
228 # TODO? new_msignature
229 var sig
= mmethoddef
.msignature
.as(not null)
230 var osig
= mmeth
.intro
.msignature
.as(not null)
231 for i
in [0..sig
.arity
[ do
232 var origtype
= osig
.mparameters
[i
].mtype
233 if not origtype
.need_anchor
then continue # skip non covariant stuff
234 var paramtype
= sig
.mparameters
[i
].mtype
238 var npropdef
= modelbuilder
.mpropdef2node
(mmethoddef
)
240 if npropdef
isa AClassdef then
241 # It is an init for a class
242 assert mmethoddef
== npropdef
.mfree_init
244 if mmethoddef
.mproperty
.is_root_init
and not mmethoddef
.is_intro
then
245 self.add_super_send
(v
.receiver
, mmethoddef
)
248 else if mmethoddef
.constant_value
!= null then
249 # Make the return type live
250 v
.add_type
(mmethoddef
.msignature
.return_mtype
.as(MClassType))
252 else if npropdef
== null then
256 if npropdef
isa AMethPropdef then
257 var auto_super_inits
= npropdef
.auto_super_inits
258 if auto_super_inits
!= null then
259 for auto_super_init
in auto_super_inits
do
260 v
.add_callsite
(auto_super_init
)
263 if npropdef
.auto_super_call
then
264 self.add_super_send
(v
.receiver
, mmethoddef
)
268 if mmethoddef
.is_intern
or mmethoddef
.is_extern
then
269 # UGLY: We force the "instantation" of the concrete return type if any
270 var ret
= mmethoddef
.msignature
.return_mtype
271 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
276 v
.enter_visit
(npropdef
)
279 #print "MMethod {live_methods.length}: {live_methods.join(", ")}"
280 #print "MMethodDef {live_methoddefs.length}: {live_methoddefs.join(", ")}"
282 #print "open MType {live_open_types.length}: {live_open_types.join(", ")}"
283 var todo_types
= new List[MClassType]
284 todo_types
.add_all
(live_types
)
285 while not todo_types
.is_empty
do
286 var t
= todo_types
.shift
287 for ot
in live_open_types
do
289 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
290 var rt
= ot
.anchor_to
(mainmodule
, t
)
291 if live_types
.has
(rt
) then continue
292 #print "{ot}/{t} -> {rt}"
298 #print "MType {live_types.length}: {live_types.join(", ")}"
300 #print "open cast MType {live_open_cast_types.length}: {live_open_cast_types.join(", ")}"
301 for ot
in live_open_cast_types
do
302 #print "live_open_cast_type: {ot}"
303 for t
in live_types
do
304 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
305 var rt
= ot
.anchor_to
(mainmodule
, t
)
306 live_cast_types
.add
(rt
)
307 #print " {ot}/{t} -> {rt}"
310 #print "cast MType {live_cast_types.length}: {live_cast_types.join(", ")}"
313 private fun check_depth
(mtype
: MClassType)
317 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}.")
321 fun add_new
(recv
: MClassType, mtype
: MClassType)
323 assert not recv
.need_anchor
324 if mtype
.need_anchor
then
325 if live_open_types
.has
(mtype
) then return
326 live_open_types
.add
(mtype
)
328 if live_types
.has
(mtype
) then return
329 live_types
.add
(mtype
)
332 var mclass
= mtype
.mclass
333 if live_classes
.has
(mclass
) then return
334 live_classes
.add
(mclass
)
336 for p
in totry_methods
do try_send
(mtype
, p
)
337 for p
in live_super_sends
do try_super_send
(mtype
, p
)
339 # Remove cleared ones
340 for p
in totry_methods_to_remove
do totry_methods
.remove
(p
)
341 totry_methods_to_remove
.clear
343 var bound_mtype
= mtype
.anchor_to
(mainmodule
, recv
)
344 for cd
in bound_mtype
.collect_mclassdefs
(mainmodule
)
346 for npropdef
in modelbuilder
.collect_attr_propdef
(cd
) do
347 if not npropdef
.has_value
then continue
349 var mpropdef
= npropdef
.mpropdef
.as(not null)
350 var v
= new RapidTypeVisitor(self, bound_mtype
, mpropdef
)
351 v
.enter_visit
(npropdef
.n_expr
)
352 v
.enter_visit
(npropdef
.n_block
)
358 fun add_cast
(mtype
: MType)
360 if mtype
.need_anchor
then
361 live_open_cast_types
.add
(mtype
)
363 live_cast_types
.add
(mtype
)
367 fun try_send
(recv
: MClassType, mproperty
: MMethod)
369 recv
= recv
.mclass
.intro
.bound_mtype
370 if not recv
.has_mproperty
(mainmodule
, mproperty
) then return
371 var d
= mproperty
.lookup_first_definition
(mainmodule
, recv
)
375 fun add_call
(mpropdef
: MMethodDef)
377 if live_methoddefs
.has
(mpropdef
) then return
378 live_methoddefs
.add
(mpropdef
)
381 var mproperty
= mpropdef
.mproperty
382 if mproperty
.mpropdefs
.length
<= 1 then return
383 # If all definitions of a method are live, we can remove the definition of the totry set
384 for d
in mproperty
.mpropdefs
do
385 if d
.is_abstract
then continue
386 if not live_methoddefs
.has
(d
) then return
388 #print "full property: {mpropdef.mproperty} for {mpropdef.mproperty.mpropdefs.length} definitions"
389 totry_methods_to_remove
.add
(mpropdef
.mproperty
)
392 fun add_send
(recv
: MType, mproperty
: MMethod)
394 if try_methods
.has
(mproperty
) then return
395 #print "new prop: {mproperty}"
396 live_methods
.add
(mproperty
)
397 try_methods
.add
(mproperty
)
398 if mproperty
.mpropdefs
.length
== 1 then
399 # If there is only one definition, just add the definition and do not try again the property
400 var d
= mproperty
.mpropdefs
.first
404 # Else, the property is potentially called with various reciever
405 # So just try the methods with existing receiver and register it for future receiver
406 totry_methods
.add
(mproperty
)
407 for c
in live_classes
do
408 try_send
(c
.intro
.bound_mtype
, mproperty
)
412 fun try_super_send
(recv
: MClassType, mpropdef
: MMethodDef)
414 recv
= recv
.mclass
.intro
.bound_mtype
415 if not recv
.collect_mclassdefs
(mainmodule
).has
(mpropdef
.mclassdef
) then return
416 var d
= mpropdef
.lookup_next_definition
(mainmodule
, recv
)
420 fun add_super_send
(recv
: MType, mpropdef
: MMethodDef)
422 assert mpropdef
.has_supercall
423 if live_super_sends
.has
(mpropdef
) then return
424 #print "new super prop: {mpropdef}"
425 live_super_sends
.add
(mpropdef
)
426 for c
in live_classes
do
427 try_super_send
(c
.intro
.bound_mtype
, mpropdef
)
432 class RapidTypeVisitor
435 var analysis
: RapidTypeAnalysis
436 var receiver
: MClassType
437 var mpropdef
: MPropDef
441 assert not receiver
.need_anchor
446 n
.accept_rapid_type_visitor
(self)
448 var implicit_cast_to
= n
.implicit_cast_to
449 if implicit_cast_to
!= null then self.add_cast_type
(implicit_cast_to
)
452 # RTA does not enter in AAnnotations
453 if not n
isa AAnnotations then
458 fun cleanup_type
(mtype
: MType): nullable MClassType
460 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
461 if mtype
isa MNullType then return null
462 mtype
= mtype
.as_notnullable
463 assert mtype
isa MClassType
464 assert not mtype
.need_anchor
468 fun get_class
(name
: String): MClass
470 return analysis
.mainmodule
.get_primitive_class
(name
)
473 fun get_method
(recv
: MType, name
: String): MMethod
475 var mtype
= cleanup_type
(recv
)
477 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, mtype
.mclass
, self.analysis
.mainmodule
)
480 fun add_type
(mtype
: MClassType) do analysis
.add_new
(receiver
, mtype
)
482 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
484 analysis
.live_methods
.add
(mproperty
)
485 analysis
.try_send
(mtype
.as(MClassType), mproperty
)
488 fun add_send
(mtype
: MType, mproperty
: MMethod) do analysis
.add_send
(mtype
, mproperty
)
490 fun add_cast_type
(mtype
: MType) do analysis
.add_cast
(mtype
)
492 fun add_callsite
(callsite
: nullable CallSite) do if callsite
!= null then
493 for m
in callsite
.mpropdef
.initializers
do
494 if m
isa MMethod then
495 analysis
.add_send
(callsite
.recv
, m
)
498 analysis
.add_send
(callsite
.recv
, callsite
.mproperty
)
499 analysis
.live_callsites
.add
(callsite
)
506 private fun accept_rapid_type_visitor
(v
: RapidTypeVisitor)
512 redef fun accept_rapid_type_visitor
(v
)
514 v
.add_type
(self.mtype
.as(MClassType))
518 redef class AFloatExpr
519 redef fun accept_rapid_type_visitor
(v
)
521 v
.add_type
(self.mtype
.as(MClassType))
525 redef class ACharExpr
526 redef fun accept_rapid_type_visitor
(v
)
528 v
.add_type
(self.mtype
.as(MClassType))
532 redef class AArrayExpr
533 redef fun accept_rapid_type_visitor
(v
)
535 var mtype
= self.mtype
.as(MClassType)
537 var native
= v
.analysis
.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([mtype
.arguments
.first
])
539 mtype
= v
.cleanup_type
(mtype
).as(not null)
540 var prop
= v
.get_method
(mtype
, "with_native")
541 v
.add_monomorphic_send
(mtype
, prop
)
545 redef class AStringFormExpr
546 redef fun accept_rapid_type_visitor
(v
)
548 var native
= v
.get_class
("NativeString").mclass_type
550 var prop
= v
.get_method
(native
, "to_s_with_length")
551 v
.add_monomorphic_send
(native
, prop
)
555 redef class ASuperstringExpr
556 redef fun accept_rapid_type_visitor
(v
)
558 var arraytype
= v
.get_class
("Array").get_mtype
([v
.get_class
("Object").mclass_type
])
559 v
.add_type
(arraytype
)
560 v
.add_type
(v
.get_class
("NativeArray").get_mtype
([v
.get_class
("Object").mclass_type
]))
561 var prop
= v
.get_method
(arraytype
, "join")
562 v
.add_monomorphic_send
(arraytype
, prop
)
563 var prop2
= v
.get_method
(arraytype
, "with_native")
564 v
.add_monomorphic_send
(arraytype
, prop2
)
568 redef class ACrangeExpr
569 redef fun accept_rapid_type_visitor
(v
)
571 var mtype
= self.mtype
.as(MClassType)
573 v
.add_callsite
(init_callsite
)
577 redef class AOrangeExpr
578 redef fun accept_rapid_type_visitor
(v
)
580 var mtype
= self.mtype
.as(MClassType)
582 v
.add_callsite
(init_callsite
)
586 redef class ATrueExpr
587 redef fun accept_rapid_type_visitor
(v
)
589 v
.add_type
(self.mtype
.as(MClassType))
593 redef class AFalseExpr
594 redef fun accept_rapid_type_visitor
(v
)
596 v
.add_type
(self.mtype
.as(MClassType))
601 redef fun accept_rapid_type_visitor
(v
)
603 v
.add_cast_type
(self.cast_type
.as(not null))
607 redef class AAsCastExpr
608 redef fun accept_rapid_type_visitor
(v
)
610 v
.add_cast_type
(self.mtype
.as(not null))
614 redef class ASendExpr
615 redef fun accept_rapid_type_visitor
(v
)
617 v
.add_callsite
(callsite
)
622 redef class ASendReassignFormExpr
623 redef fun accept_rapid_type_visitor
(v
)
625 v
.add_callsite
(callsite
)
626 v
.add_callsite
(reassign_callsite
)
627 v
.add_callsite
(write_callsite
)
631 redef class AVarReassignExpr
632 redef fun accept_rapid_type_visitor
(v
)
634 v
.add_callsite
(reassign_callsite
)
638 redef class AAttrReassignExpr
639 redef fun accept_rapid_type_visitor
(v
)
641 v
.add_callsite
(reassign_callsite
)
645 redef class ASuperExpr
646 redef fun accept_rapid_type_visitor
(v
)
648 var callsite
= self.callsite
649 if callsite
!= null then
650 v
.add_callsite
(callsite
)
654 v
.analysis
.add_super_send
(v
.receiver
, mpropdef
.as(not null))
659 redef fun accept_rapid_type_visitor
(v
)
661 v
.add_callsite
(self.method_iterator
)
662 v
.add_callsite
(self.method_is_ok
)
663 if self.variables
.length
== 1 then
664 v
.add_callsite
(self.method_item
)
665 else if self.variables
.length
== 2 then
666 v
.add_callsite
(self.method_key
)
667 v
.add_callsite
(self.method_item
)
671 v
.add_callsite
(self.method_next
)
672 var mf
= self.method_finish
673 if mf
!= null then v
.add_callsite
(mf
)
678 redef fun accept_rapid_type_visitor
(v
)
680 var mtype
= self.recvtype
.as(not null)
682 v
.add_callsite
(callsite
)