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 assert mtype
isa MClassType
91 mtype
= mtype
.mclass
.intro
.bound_mtype
92 var mproperty
= callsite
.mproperty
93 var res
= live_targets_cache
[mtype
, mproperty
]
94 if res
!= null then return res
95 res
= new ArraySet[MMethodDef]
96 live_targets_cache
[mtype
, mproperty
] = res
98 for c
in live_classes
do
99 var tc
= c
.intro
.bound_mtype
100 if not tc
.is_subtype
(mainmodule
, null, mtype
) then continue
101 var d
= mproperty
.lookup_first_definition
(mainmodule
, tc
)
108 # Live call-to-super.
109 var live_super_sends
= new HashSet[MMethodDef]
111 # Return a ready-to-save CSV document objet that agregates informations about live types.
112 # Each discovered type is listed in a line, with its status: resolution, liveness, cast-liveness.
113 # Note: types are listed in an alphanumeric order to improve human reading.
114 fun live_types_to_csv
: CSVDocument
116 # Gather all kind of type
117 var typeset
= new HashSet[MType]
118 typeset
.add_all
(live_types
)
119 typeset
.add_all
(live_open_types
)
120 typeset
.add_all
(live_cast_types
)
121 typeset
.add_all
(live_open_cast_types
)
122 var types
= typeset
.to_a
123 (new CachedAlphaComparator).sort
(types
)
124 var res
= new CSVDocument
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_line
(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
.mpropdef2npropdef
[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 if not modelbuilder
.mpropdef2npropdef
.has_key
(mmethoddef
) then
239 # It is an init for a class?
240 if mmeth
.name
== "init" then
241 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[mmethoddef
.mclassdef
]
242 assert mmethoddef
== nclassdef
.mfree_init
243 var super_inits
= nclassdef
.super_inits
244 if super_inits
!= null then
245 #assert args.length == 1
246 for su
in super_inits
do
247 v
.add_monomorphic_send
(v
.receiver
, su
)
251 if mmethoddef
.mproperty
.is_root_init
and not mmethoddef
.is_intro
then
252 self.add_super_send
(v
.receiver
, mmethoddef
)
260 var npropdef
= modelbuilder
.mpropdef2npropdef
[mmethoddef
]
262 if npropdef
isa AMethPropdef then
263 var auto_super_inits
= npropdef
.auto_super_inits
264 if auto_super_inits
!= null then
265 for auto_super_init
in auto_super_inits
do
266 v
.add_callsite
(auto_super_init
)
269 if npropdef
.auto_super_call
then
270 self.add_super_send
(v
.receiver
, mmethoddef
)
275 v
.add_type
(v
.receiver
)
276 else if mmethoddef
.is_intern
or mmethoddef
.is_extern
then
277 # UGLY: We force the "instantation" of the concrete return type if any
278 var ret
= mmethoddef
.msignature
.return_mtype
279 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
284 v
.enter_visit
(npropdef
)
287 #print "MMethod {live_methods.length}: {live_methods.join(", ")}"
288 #print "MMethodDef {live_methoddefs.length}: {live_methoddefs.join(", ")}"
290 #print "open MType {live_open_types.length}: {live_open_types.join(", ")}"
291 var todo_types
= new List[MClassType]
292 todo_types
.add_all
(live_types
)
293 while not todo_types
.is_empty
do
294 var t
= todo_types
.shift
295 for ot
in live_open_types
do
297 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
298 var rt
= ot
.anchor_to
(mainmodule
, t
)
299 if live_types
.has
(rt
) then continue
300 #print "{ot}/{t} -> {rt}"
306 #print "MType {live_types.length}: {live_types.join(", ")}"
308 #print "open cast MType {live_open_cast_types.length}: {live_open_cast_types.join(", ")}"
309 for ot
in live_open_cast_types
do
310 #print "live_open_cast_type: {ot}"
311 for t
in live_types
do
312 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
313 var rt
= ot
.anchor_to
(mainmodule
, t
)
314 live_cast_types
.add
(rt
)
315 #print " {ot}/{t} -> {rt}"
318 #print "cast MType {live_cast_types.length}: {live_cast_types.join(", ")}"
321 private fun check_depth
(mtype
: MClassType)
325 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}.")
329 fun add_new
(recv
: MClassType, mtype
: MClassType)
331 assert not recv
.need_anchor
332 if mtype
.need_anchor
then
333 if live_open_types
.has
(mtype
) then return
334 live_open_types
.add
(mtype
)
336 if live_types
.has
(mtype
) then return
337 live_types
.add
(mtype
)
340 var mclass
= mtype
.mclass
341 if live_classes
.has
(mclass
) then return
342 live_classes
.add
(mclass
)
344 for p
in totry_methods
do try_send
(mtype
, p
)
345 for p
in live_super_sends
do try_super_send
(mtype
, p
)
347 # Remove cleared ones
348 for p
in totry_methods_to_remove
do totry_methods
.remove
(p
)
349 totry_methods_to_remove
.clear
351 var bound_mtype
= mtype
.anchor_to
(mainmodule
, recv
)
352 for cd
in bound_mtype
.collect_mclassdefs
(mainmodule
)
354 if not self.modelbuilder
.mclassdef2nclassdef
.has_key
(cd
) then continue
355 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[cd
]
356 for npropdef
in nclassdef
.n_propdefs
do
357 if not npropdef
isa AAttrPropdef then continue
358 var nexpr
= npropdef
.n_expr
359 if nexpr
== null then continue
360 var mpropdef
= npropdef
.mpropdef
.as(not null)
361 var v
= new RapidTypeVisitor(self, bound_mtype
, mpropdef
)
368 fun add_cast
(mtype
: MType)
370 if mtype
.need_anchor
then
371 live_open_cast_types
.add
(mtype
)
373 live_cast_types
.add
(mtype
)
377 fun try_send
(recv
: MClassType, mproperty
: MMethod)
379 recv
= recv
.mclass
.intro
.bound_mtype
380 if not recv
.has_mproperty
(mainmodule
, mproperty
) then return
381 var d
= mproperty
.lookup_first_definition
(mainmodule
, recv
)
385 fun add_call
(mpropdef
: MMethodDef)
387 if live_methoddefs
.has
(mpropdef
) then return
388 live_methoddefs
.add
(mpropdef
)
391 var mproperty
= mpropdef
.mproperty
392 if mproperty
.mpropdefs
.length
<= 1 then return
393 # If all definitions of a method are live, we can remove the definition of the totry set
394 for d
in mproperty
.mpropdefs
do
395 if d
.is_abstract
then continue
396 if not live_methoddefs
.has
(d
) then return
398 #print "full property: {mpropdef.mproperty} for {mpropdef.mproperty.mpropdefs.length} definitions"
399 totry_methods_to_remove
.add
(mpropdef
.mproperty
)
402 fun add_send
(recv
: MType, mproperty
: MMethod)
404 if try_methods
.has
(mproperty
) then return
405 #print "new prop: {mproperty}"
406 live_methods
.add
(mproperty
)
407 try_methods
.add
(mproperty
)
408 if mproperty
.mpropdefs
.length
== 1 then
409 # If there is only one definition, just add the definition and do not try again the property
410 var d
= mproperty
.mpropdefs
.first
414 # Else, the property is potentially called with various reciever
415 # So just try the methods with existing receiver and register it for future receiver
416 totry_methods
.add
(mproperty
)
417 for c
in live_classes
do
418 try_send
(c
.intro
.bound_mtype
, mproperty
)
422 fun try_super_send
(recv
: MClassType, mpropdef
: MMethodDef)
424 recv
= recv
.mclass
.intro
.bound_mtype
425 if not recv
.collect_mclassdefs
(mainmodule
).has
(mpropdef
.mclassdef
) then return
426 var d
= mpropdef
.lookup_next_definition
(mainmodule
, recv
)
430 fun add_super_send
(recv
: MType, mpropdef
: MMethodDef)
432 assert mpropdef
.has_supercall
433 if live_super_sends
.has
(mpropdef
) then return
434 #print "new super prop: {mpropdef}"
435 live_super_sends
.add
(mpropdef
)
436 for c
in live_classes
do
437 try_super_send
(c
.intro
.bound_mtype
, mpropdef
)
442 class RapidTypeVisitor
445 var analysis
: RapidTypeAnalysis
446 var receiver
: MClassType
447 var mpropdef
: MPropDef
449 init(analysis
: RapidTypeAnalysis, receiver
: MClassType, mpropdef
: MPropDef)
451 self.analysis
= analysis
452 self.receiver
= receiver
453 self.mpropdef
= mpropdef
454 assert not receiver
.need_anchor
459 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 # RTA does not enter in AAnnotations
466 if not n
isa AAnnotations then
471 fun cleanup_type
(mtype
: MType): nullable MClassType
473 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
474 if mtype
isa MNullType then return null
475 mtype
= mtype
.as_notnullable
476 assert mtype
isa MClassType
477 assert not mtype
.need_anchor
481 fun get_class
(name
: String): MClass
483 return analysis
.mainmodule
.get_primitive_class
(name
)
486 fun get_method
(recv
: MType, name
: String): MMethod
488 var mtype
= cleanup_type
(recv
)
490 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, mtype
.mclass
, self.analysis
.mainmodule
)
493 fun add_type
(mtype
: MClassType) do analysis
.add_new
(receiver
, mtype
)
495 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
497 analysis
.live_methods
.add
(mproperty
)
498 analysis
.try_send
(mtype
.as(MClassType), mproperty
)
501 fun add_send
(mtype
: MType, mproperty
: MMethod) do analysis
.add_send
(mtype
, mproperty
)
503 fun add_cast_type
(mtype
: MType) do analysis
.add_cast
(mtype
)
505 fun add_callsite
(callsite
: nullable CallSite) do if callsite
!= null then
506 for m
in callsite
.mpropdef
.initializers
do
507 if m
isa MMethod then
508 analysis
.add_send
(callsite
.recv
, m
)
511 analysis
.add_send
(callsite
.recv
, callsite
.mproperty
)
512 analysis
.live_callsites
.add
(callsite
)
519 private fun accept_rapid_type_visitor
(v
: RapidTypeVisitor)
525 redef fun accept_rapid_type_visitor
(v
)
527 v
.add_type
(self.mtype
.as(MClassType))
531 redef class AFloatExpr
532 redef fun accept_rapid_type_visitor
(v
)
534 v
.add_type
(self.mtype
.as(MClassType))
538 redef class ACharExpr
539 redef fun accept_rapid_type_visitor
(v
)
541 v
.add_type
(self.mtype
.as(MClassType))
545 redef class AArrayExpr
546 redef fun accept_rapid_type_visitor
(v
)
548 var mtype
= self.mtype
.as(MClassType)
550 var native
= v
.analysis
.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([mtype
.arguments
.first
])
552 mtype
= v
.cleanup_type
(mtype
).as(not null)
553 var prop
= v
.get_method
(mtype
, "with_native")
554 v
.add_monomorphic_send
(mtype
, prop
)
558 redef class AStringFormExpr
559 redef fun accept_rapid_type_visitor
(v
)
561 var native
= v
.get_class
("NativeString").mclass_type
563 var prop
= v
.get_method
(native
, "to_s_with_length")
564 v
.add_monomorphic_send
(native
, prop
)
568 redef class ASuperstringExpr
569 redef fun accept_rapid_type_visitor
(v
)
571 var arraytype
= v
.get_class
("Array").get_mtype
([v
.get_class
("Object").mclass_type
])
572 v
.add_type
(arraytype
)
573 v
.add_type
(v
.get_class
("NativeArray").get_mtype
([v
.get_class
("Object").mclass_type
]))
574 var prop
= v
.get_method
(arraytype
, "join")
575 v
.add_monomorphic_send
(arraytype
, prop
)
576 var prop2
= v
.get_method
(arraytype
, "with_native")
577 v
.add_monomorphic_send
(arraytype
, prop2
)
581 redef class ACrangeExpr
582 redef fun accept_rapid_type_visitor
(v
)
584 var mtype
= self.mtype
.as(MClassType)
586 v
.add_callsite
(init_callsite
)
590 redef class AOrangeExpr
591 redef fun accept_rapid_type_visitor
(v
)
593 var mtype
= self.mtype
.as(MClassType)
595 v
.add_callsite
(init_callsite
)
599 redef class ATrueExpr
600 redef fun accept_rapid_type_visitor
(v
)
602 v
.add_type
(self.mtype
.as(MClassType))
606 redef class AFalseExpr
607 redef fun accept_rapid_type_visitor
(v
)
609 v
.add_type
(self.mtype
.as(MClassType))
614 redef fun accept_rapid_type_visitor
(v
)
616 v
.add_cast_type
(self.cast_type
.as(not null))
620 redef class AAsCastExpr
621 redef fun accept_rapid_type_visitor
(v
)
623 v
.add_cast_type
(self.mtype
.as(not null))
627 redef class ASendExpr
628 redef fun accept_rapid_type_visitor
(v
)
630 v
.add_callsite
(callsite
)
635 redef class ASendReassignFormExpr
636 redef fun accept_rapid_type_visitor
(v
)
638 v
.add_callsite
(callsite
)
639 v
.add_callsite
(reassign_callsite
)
640 v
.add_callsite
(write_callsite
)
644 redef class AVarReassignExpr
645 redef fun accept_rapid_type_visitor
(v
)
647 v
.add_callsite
(reassign_callsite
)
651 redef class AAttrReassignExpr
652 redef fun accept_rapid_type_visitor
(v
)
654 v
.add_callsite
(reassign_callsite
)
658 redef class ASuperExpr
659 redef fun accept_rapid_type_visitor
(v
)
661 var callsite
= self.callsite
662 if callsite
!= null then
663 v
.add_callsite
(callsite
)
667 v
.analysis
.add_super_send
(v
.receiver
, mpropdef
.as(not null))
672 redef fun accept_rapid_type_visitor
(v
)
674 v
.add_callsite
(self.method_iterator
)
675 v
.add_callsite
(self.method_is_ok
)
676 if self.variables
.length
== 1 then
677 v
.add_callsite
(self.method_item
)
678 else if self.variables
.length
== 2 then
679 v
.add_callsite
(self.method_key
)
680 v
.add_callsite
(self.method_item
)
684 v
.add_callsite
(self.method_next
)
689 redef fun accept_rapid_type_visitor
(v
)
691 var mtype
= self.mtype
.as(MClassType)
693 v
.add_callsite
(callsite
)