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
.format
= new CsvFormat('"', ';', "\n")
126 res
.header
= ["Type", "Resolution", "Liveness", "Cast-liveness"]
129 if t
.need_anchor
then reso
= "OPEN " else reso
= "CLOSED"
131 if t
isa MClassType and (live_types
.has
(t
) or live_open_types
.has
(t
)) then live
= "LIVE" else live
= "DEAD"
133 if live_cast_types
.has
(t
) or live_open_cast_types
.has
(t
) then cast
= "CAST LIVE" else cast
= "CAST DEAD"
134 res
.add_record
(t
, reso
, live
, cast
)
139 # Return a ready-to-save OrderedTree object that agregates infomration about live methods.
140 # Note: methods are listed in an alphanumeric order to improve human reading.
141 fun live_methods_to_tree
: OrderedTree[Object]
143 var tree
= new OrderedTree[Object]
144 for x
in live_methods
do
147 for z
in x
.mpropdefs
do
149 if live_methoddefs
.has
(z
) then
151 if live_super_sends
.has
(z
) then
152 tree
.add
(zn
, zn
+ "(super)")
154 else if live_super_sends
.has
(z
) then
155 tree
.add
(xn
, zn
+ "(super)")
159 tree
.sort_with
(alpha_comparator
)
163 # Methods that are still candidate to the try_send
164 private var totry_methods
= new HashSet[MMethod]
166 # Methods that are are no more candidate to the try_send
167 private var totry_methods_to_remove
= new Array[MMethod]
169 # Methods that are or were candidate to the try_send
170 # Used to ensure that try_send is only used once
171 private var try_methods
= new HashSet[MMethod]
173 # The method definitions that remain to visit
174 private var todo
= new List[MMethodDef]
176 private fun force_alive
(classname
: String)
178 var classes
= self.modelbuilder
.model
.get_mclasses_by_name
(classname
)
179 if classes
!= null then for c
in classes
do self.add_new
(c
.mclass_type
, c
.mclass_type
)
182 # Run the analysis until all visitable method definitions are visited.
185 var maintype
= mainmodule
.sys_type
186 if maintype
== null then return # No entry point
187 add_new
(maintype
, maintype
)
188 var initprop
= mainmodule
.try_get_primitive_method
("init", maintype
.mclass
)
189 if initprop
!= null then
190 add_send
(maintype
, initprop
)
192 var mainprop
= mainmodule
.try_get_primitive_method
("run", maintype
.mclass
) or else
193 mainmodule
.try_get_primitive_method
("main", maintype
.mclass
)
194 if mainprop
!= null then
195 add_send
(maintype
, mainprop
)
198 var finalizable_type
= mainmodule
.finalizable_type
199 if finalizable_type
!= null then
200 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
201 if finalize_meth
!= null then add_send
(finalizable_type
, finalize_meth
)
204 # Force primitive types
209 force_alive
("Pointer")
211 while not todo
.is_empty
do
212 var mmethoddef
= todo
.shift
213 var mmeth
= mmethoddef
.mproperty
214 #print "# visit {mmethoddef}"
215 var v
= new RapidTypeVisitor(self, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
)
217 var vararg_rank
= mmethoddef
.msignature
.vararg_rank
218 if vararg_rank
> -1 then
219 var node
= self.modelbuilder
.mpropdef2node
(mmethoddef
)
220 var elttype
= mmethoddef
.msignature
.mparameters
[vararg_rank
].mtype
221 #elttype = elttype.anchor_to(self.mainmodule, v.receiver)
222 var vararg
= self.mainmodule
.get_primitive_class
("Array").get_mtype
([elttype
])
224 var native
= self.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([elttype
])
226 v
.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
.mclass
, self.mainmodule
))
229 # TODO? new_msignature
230 var sig
= mmethoddef
.msignature
.as(not null)
231 var osig
= mmeth
.intro
.msignature
.as(not null)
232 for i
in [0..sig
.arity
[ do
233 var origtype
= osig
.mparameters
[i
].mtype
234 if not origtype
.need_anchor
then continue # skip non covariant stuff
235 var paramtype
= sig
.mparameters
[i
].mtype
239 var npropdef
= modelbuilder
.mpropdef2node
(mmethoddef
)
241 if npropdef
isa AClassdef then
242 # It is an init for a class
243 assert mmethoddef
== npropdef
.mfree_init
245 if mmethoddef
.mproperty
.is_root_init
and not mmethoddef
.is_intro
then
246 self.add_super_send
(v
.receiver
, mmethoddef
)
249 else if mmethoddef
.constant_value
!= null then
250 # Make the return type live
251 v
.add_type
(mmethoddef
.msignature
.return_mtype
.as(MClassType))
253 else if npropdef
== null then
257 if npropdef
isa AMethPropdef then
258 var auto_super_inits
= npropdef
.auto_super_inits
259 if auto_super_inits
!= null then
260 for auto_super_init
in auto_super_inits
do
261 v
.add_callsite
(auto_super_init
)
264 if npropdef
.auto_super_call
then
265 self.add_super_send
(v
.receiver
, mmethoddef
)
269 if mmethoddef
.is_intern
or mmethoddef
.is_extern
then
270 # UGLY: We force the "instantation" of the concrete return type if any
271 var ret
= mmethoddef
.msignature
.return_mtype
272 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
277 v
.enter_visit
(npropdef
)
280 #print "MMethod {live_methods.length}: {live_methods.join(", ")}"
281 #print "MMethodDef {live_methoddefs.length}: {live_methoddefs.join(", ")}"
283 #print "open MType {live_open_types.length}: {live_open_types.join(", ")}"
284 var todo_types
= new List[MClassType]
285 todo_types
.add_all
(live_types
)
286 while not todo_types
.is_empty
do
287 var t
= todo_types
.shift
288 for ot
in live_open_types
do
290 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
291 var rt
= ot
.anchor_to
(mainmodule
, t
)
292 if live_types
.has
(rt
) then continue
293 #print "{ot}/{t} -> {rt}"
299 #print "MType {live_types.length}: {live_types.join(", ")}"
301 #print "open cast MType {live_open_cast_types.length}: {live_open_cast_types.join(", ")}"
302 for ot
in live_open_cast_types
do
303 #print "live_open_cast_type: {ot}"
304 for t
in live_types
do
305 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
306 var rt
= ot
.anchor_to
(mainmodule
, t
)
307 live_cast_types
.add
(rt
)
308 #print " {ot}/{t} -> {rt}"
311 #print "cast MType {live_cast_types.length}: {live_cast_types.join(", ")}"
314 private fun check_depth
(mtype
: MClassType)
318 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}.")
322 fun add_new
(recv
: MClassType, mtype
: MClassType)
324 assert not recv
.need_anchor
325 if mtype
.need_anchor
then
326 if live_open_types
.has
(mtype
) then return
327 live_open_types
.add
(mtype
)
329 if live_types
.has
(mtype
) then return
330 live_types
.add
(mtype
)
333 var mclass
= mtype
.mclass
334 if live_classes
.has
(mclass
) then return
335 live_classes
.add
(mclass
)
337 for p
in totry_methods
do try_send
(mtype
, p
)
338 for p
in live_super_sends
do try_super_send
(mtype
, p
)
340 # Remove cleared ones
341 for p
in totry_methods_to_remove
do totry_methods
.remove
(p
)
342 totry_methods_to_remove
.clear
344 var bound_mtype
= mtype
.anchor_to
(mainmodule
, recv
)
345 for cd
in bound_mtype
.collect_mclassdefs
(mainmodule
)
347 for npropdef
in modelbuilder
.collect_attr_propdef
(cd
) do
348 if not npropdef
.has_value
then continue
350 var mpropdef
= npropdef
.mpropdef
.as(not null)
351 var v
= new RapidTypeVisitor(self, bound_mtype
, mpropdef
)
352 v
.enter_visit
(npropdef
.n_expr
)
353 v
.enter_visit
(npropdef
.n_block
)
359 fun add_cast
(mtype
: MType)
361 if mtype
.need_anchor
then
362 live_open_cast_types
.add
(mtype
)
364 live_cast_types
.add
(mtype
)
368 fun try_send
(recv
: MClassType, mproperty
: MMethod)
370 recv
= recv
.mclass
.intro
.bound_mtype
371 if not recv
.has_mproperty
(mainmodule
, mproperty
) then return
372 var d
= mproperty
.lookup_first_definition
(mainmodule
, recv
)
376 fun add_call
(mpropdef
: MMethodDef)
378 if live_methoddefs
.has
(mpropdef
) then return
379 live_methoddefs
.add
(mpropdef
)
382 var mproperty
= mpropdef
.mproperty
383 if mproperty
.mpropdefs
.length
<= 1 then return
384 # If all definitions of a method are live, we can remove the definition of the totry set
385 for d
in mproperty
.mpropdefs
do
386 if d
.is_abstract
then continue
387 if not live_methoddefs
.has
(d
) then return
389 #print "full property: {mpropdef.mproperty} for {mpropdef.mproperty.mpropdefs.length} definitions"
390 totry_methods_to_remove
.add
(mpropdef
.mproperty
)
393 fun add_send
(recv
: MType, mproperty
: MMethod)
395 if try_methods
.has
(mproperty
) then return
396 #print "new prop: {mproperty}"
397 live_methods
.add
(mproperty
)
398 try_methods
.add
(mproperty
)
399 if mproperty
.mpropdefs
.length
== 1 then
400 # If there is only one definition, just add the definition and do not try again the property
401 var d
= mproperty
.mpropdefs
.first
405 # Else, the property is potentially called with various reciever
406 # So just try the methods with existing receiver and register it for future receiver
407 totry_methods
.add
(mproperty
)
408 for c
in live_classes
do
409 try_send
(c
.intro
.bound_mtype
, mproperty
)
413 fun try_super_send
(recv
: MClassType, mpropdef
: MMethodDef)
415 recv
= recv
.mclass
.intro
.bound_mtype
416 if not recv
.collect_mclassdefs
(mainmodule
).has
(mpropdef
.mclassdef
) then return
417 var d
= mpropdef
.lookup_next_definition
(mainmodule
, recv
)
421 fun add_super_send
(recv
: MType, mpropdef
: MMethodDef)
423 assert mpropdef
.has_supercall
424 if live_super_sends
.has
(mpropdef
) then return
425 #print "new super prop: {mpropdef}"
426 live_super_sends
.add
(mpropdef
)
427 for c
in live_classes
do
428 try_super_send
(c
.intro
.bound_mtype
, mpropdef
)
433 class RapidTypeVisitor
436 var analysis
: RapidTypeAnalysis
437 var receiver
: MClassType
438 var mpropdef
: MPropDef
442 assert not receiver
.need_anchor
447 n
.accept_rapid_type_visitor
(self)
449 var implicit_cast_to
= n
.implicit_cast_to
450 if implicit_cast_to
!= null then self.add_cast_type
(implicit_cast_to
)
453 # RTA does not enter in AAnnotations
454 if not n
isa AAnnotations then
459 fun cleanup_type
(mtype
: MType): nullable MClassType
461 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
462 if mtype
isa MNullType then return null
463 mtype
= mtype
.as_notnullable
464 assert mtype
isa MClassType
465 assert not mtype
.need_anchor
469 fun get_class
(name
: String): MClass
471 return analysis
.mainmodule
.get_primitive_class
(name
)
474 fun get_method
(recv
: MType, name
: String): MMethod
476 var mtype
= cleanup_type
(recv
)
478 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, mtype
.mclass
, self.analysis
.mainmodule
)
481 fun add_type
(mtype
: MClassType) do analysis
.add_new
(receiver
, mtype
)
483 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
485 analysis
.live_methods
.add
(mproperty
)
486 analysis
.try_send
(mtype
.as(MClassType), mproperty
)
489 fun add_send
(mtype
: MType, mproperty
: MMethod) do analysis
.add_send
(mtype
, mproperty
)
491 fun add_cast_type
(mtype
: MType) do analysis
.add_cast
(mtype
)
493 fun add_callsite
(callsite
: nullable CallSite) do if callsite
!= null then
494 for m
in callsite
.mpropdef
.initializers
do
495 if m
isa MMethod then
496 analysis
.add_send
(callsite
.recv
, m
)
499 analysis
.add_send
(callsite
.recv
, callsite
.mproperty
)
500 analysis
.live_callsites
.add
(callsite
)
507 private fun accept_rapid_type_visitor
(v
: RapidTypeVisitor)
513 redef fun accept_rapid_type_visitor
(v
)
515 v
.add_type
(self.mtype
.as(MClassType))
519 redef class AFloatExpr
520 redef fun accept_rapid_type_visitor
(v
)
522 v
.add_type
(self.mtype
.as(MClassType))
526 redef class ACharExpr
527 redef fun accept_rapid_type_visitor
(v
)
529 v
.add_type
(self.mtype
.as(MClassType))
533 redef class AArrayExpr
534 redef fun accept_rapid_type_visitor
(v
)
536 var mtype
= self.mtype
.as(MClassType)
538 var native
= v
.analysis
.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([mtype
.arguments
.first
])
540 mtype
= v
.cleanup_type
(mtype
).as(not null)
541 var prop
= v
.get_method
(mtype
, "with_native")
542 v
.add_monomorphic_send
(mtype
, prop
)
546 redef class AStringFormExpr
547 redef fun accept_rapid_type_visitor
(v
)
549 var native
= v
.get_class
("NativeString").mclass_type
551 var prop
= v
.get_method
(native
, "to_s_with_length")
552 v
.add_monomorphic_send
(native
, prop
)
556 redef class ASuperstringExpr
557 redef fun accept_rapid_type_visitor
(v
)
559 var arraytype
= v
.get_class
("Array").get_mtype
([v
.get_class
("Object").mclass_type
])
560 v
.add_type
(arraytype
)
561 v
.add_type
(v
.get_class
("NativeArray").get_mtype
([v
.get_class
("Object").mclass_type
]))
562 var prop
= v
.get_method
(arraytype
, "join")
563 v
.add_monomorphic_send
(arraytype
, prop
)
564 var prop2
= v
.get_method
(arraytype
, "with_native")
565 v
.add_monomorphic_send
(arraytype
, prop2
)
569 redef class ACrangeExpr
570 redef fun accept_rapid_type_visitor
(v
)
572 var mtype
= self.mtype
.as(MClassType)
574 v
.add_callsite
(init_callsite
)
578 redef class AOrangeExpr
579 redef fun accept_rapid_type_visitor
(v
)
581 var mtype
= self.mtype
.as(MClassType)
583 v
.add_callsite
(init_callsite
)
587 redef class ATrueExpr
588 redef fun accept_rapid_type_visitor
(v
)
590 v
.add_type
(self.mtype
.as(MClassType))
594 redef class AFalseExpr
595 redef fun accept_rapid_type_visitor
(v
)
597 v
.add_type
(self.mtype
.as(MClassType))
602 redef fun accept_rapid_type_visitor
(v
)
604 v
.add_cast_type
(self.cast_type
.as(not null))
608 redef class AAsCastExpr
609 redef fun accept_rapid_type_visitor
(v
)
611 v
.add_cast_type
(self.mtype
.as(not null))
615 redef class ASendExpr
616 redef fun accept_rapid_type_visitor
(v
)
618 v
.add_callsite
(callsite
)
623 redef class ASendReassignFormExpr
624 redef fun accept_rapid_type_visitor
(v
)
626 v
.add_callsite
(callsite
)
627 v
.add_callsite
(reassign_callsite
)
628 v
.add_callsite
(write_callsite
)
632 redef class AVarReassignExpr
633 redef fun accept_rapid_type_visitor
(v
)
635 v
.add_callsite
(reassign_callsite
)
639 redef class AAttrReassignExpr
640 redef fun accept_rapid_type_visitor
(v
)
642 v
.add_callsite
(reassign_callsite
)
646 redef class ASuperExpr
647 redef fun accept_rapid_type_visitor
(v
)
649 var callsite
= self.callsite
650 if callsite
!= null then
651 v
.add_callsite
(callsite
)
655 v
.analysis
.add_super_send
(v
.receiver
, mpropdef
.as(not null))
660 redef fun accept_rapid_type_visitor
(v
)
662 v
.add_callsite
(self.method_iterator
)
663 v
.add_callsite
(self.method_is_ok
)
664 if self.variables
.length
== 1 then
665 v
.add_callsite
(self.method_item
)
666 else if self.variables
.length
== 2 then
667 v
.add_callsite
(self.method_key
)
668 v
.add_callsite
(self.method_item
)
672 v
.add_callsite
(self.method_next
)
673 var mf
= self.method_finish
674 if mf
!= null then v
.add_callsite
(mf
)
679 redef fun accept_rapid_type_visitor
(v
)
681 var mtype
= self.recvtype
.as(not null)
683 v
.add_callsite
(callsite
)