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")
217 while not todo
.is_empty
do
218 var mmethoddef
= todo
.shift
219 var mmeth
= mmethoddef
.mproperty
220 #print "# visit {mmethoddef}"
221 var v
= new RapidTypeVisitor(self, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
)
223 var vararg_rank
= mmethoddef
.msignature
.vararg_rank
224 if vararg_rank
> -1 then
225 var node
= self.modelbuilder
.mpropdef2node
(mmethoddef
)
226 var elttype
= mmethoddef
.msignature
.mparameters
[vararg_rank
].mtype
227 #elttype = elttype.anchor_to(self.mainmodule, v.receiver)
228 var vararg
= self.mainmodule
.array_type
(elttype
)
230 var native
= self.mainmodule
.native_array_type
(elttype
)
232 v
.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
.mclass
, self.mainmodule
))
235 # TODO? new_msignature
236 var sig
= mmethoddef
.msignature
.as(not null)
237 var osig
= mmeth
.intro
.msignature
.as(not null)
238 for i
in [0..sig
.arity
[ do
239 var origtype
= osig
.mparameters
[i
].mtype
240 if not origtype
.need_anchor
then continue # skip non covariant stuff
241 var paramtype
= sig
.mparameters
[i
].mtype
245 var npropdef
= modelbuilder
.mpropdef2node
(mmethoddef
)
247 if npropdef
isa AClassdef then
248 # It is an init for a class
249 assert mmethoddef
== npropdef
.mfree_init
251 if mmethoddef
.mproperty
.is_root_init
and not mmethoddef
.is_intro
then
252 self.add_super_send
(v
.receiver
, mmethoddef
)
255 else if mmethoddef
.constant_value
!= null then
256 # Make the return type live
257 v
.add_type
(mmethoddef
.msignature
.return_mtype
.as(MClassType))
259 else if npropdef
== null then
263 if npropdef
isa AMethPropdef then
264 var auto_super_inits
= npropdef
.auto_super_inits
265 if auto_super_inits
!= null then
266 for auto_super_init
in auto_super_inits
do
267 v
.add_callsite
(auto_super_init
)
270 if npropdef
.auto_super_call
then
271 self.add_super_send
(v
.receiver
, mmethoddef
)
275 if mmethoddef
.is_intern
or mmethoddef
.is_extern
then
276 # UGLY: We force the "instantation" of the concrete return type if any
277 var ret
= mmethoddef
.msignature
.return_mtype
278 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
283 v
.enter_visit
(npropdef
)
286 #print "MMethod {live_methods.length}: {live_methods.join(", ")}"
287 #print "MMethodDef {live_methoddefs.length}: {live_methoddefs.join(", ")}"
289 #print "open MType {live_open_types.length}: {live_open_types.join(", ")}"
290 var todo_types
= new List[MClassType]
291 todo_types
.add_all
(live_types
)
292 while not todo_types
.is_empty
do
293 var t
= todo_types
.shift
294 for ot
in live_open_types
do
296 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
297 var rt
= ot
.anchor_to
(mainmodule
, t
)
298 if live_types
.has
(rt
) then continue
299 #print "{ot}/{t} -> {rt}"
305 #print "MType {live_types.length}: {live_types.join(", ")}"
307 #print "open cast MType {live_open_cast_types.length}: {live_open_cast_types.join(", ")}"
308 for ot
in live_open_cast_types
do
309 #print "live_open_cast_type: {ot}"
310 for t
in live_types
do
311 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
312 var rt
= ot
.anchor_to
(mainmodule
, t
)
313 live_cast_types
.add
(rt
)
314 #print " {ot}/{t} -> {rt}"
317 #print "cast MType {live_cast_types.length}: {live_cast_types.join(", ")}"
320 private fun check_depth
(mtype
: MClassType)
324 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}`.")
328 fun add_new
(recv
: MClassType, mtype
: MClassType)
330 assert not recv
.need_anchor
331 if mtype
.need_anchor
then
332 if live_open_types
.has
(mtype
) then return
333 live_open_types
.add
(mtype
)
335 if live_types
.has
(mtype
) then return
336 live_types
.add
(mtype
)
339 var mclass
= mtype
.mclass
340 if live_classes
.has
(mclass
) then return
341 live_classes
.add
(mclass
)
343 for p
in totry_methods
do try_send
(mtype
, p
)
344 for p
in live_super_sends
do try_super_send
(mtype
, p
)
346 # Remove cleared ones
347 for p
in totry_methods_to_remove
do totry_methods
.remove
(p
)
348 totry_methods_to_remove
.clear
350 var bound_mtype
= mtype
.anchor_to
(mainmodule
, recv
)
351 for cd
in bound_mtype
.collect_mclassdefs
(mainmodule
)
353 for npropdef
in modelbuilder
.collect_attr_propdef
(cd
) do
354 if not npropdef
.has_value
then continue
356 var mpropdef
= npropdef
.mpropdef
.as(not null)
357 var v
= new RapidTypeVisitor(self, bound_mtype
, mpropdef
)
358 v
.enter_visit
(npropdef
.n_expr
)
359 v
.enter_visit
(npropdef
.n_block
)
365 fun add_cast
(mtype
: MType)
367 if mtype
.need_anchor
then
368 live_open_cast_types
.add
(mtype
)
370 live_cast_types
.add
(mtype
)
374 fun try_send
(recv
: MClassType, mproperty
: MMethod)
376 recv
= recv
.mclass
.intro
.bound_mtype
377 if not recv
.has_mproperty
(mainmodule
, mproperty
) then return
378 var d
= mproperty
.lookup_first_definition
(mainmodule
, recv
)
382 fun add_call
(mpropdef
: MMethodDef)
384 if live_methoddefs
.has
(mpropdef
) then return
385 live_methoddefs
.add
(mpropdef
)
388 var mproperty
= mpropdef
.mproperty
389 if mproperty
.mpropdefs
.length
<= 1 then return
390 # If all definitions of a method are live, we can remove the definition of the totry set
391 for d
in mproperty
.mpropdefs
do
392 if not live_methoddefs
.has
(d
) then return
394 #print "full property: {mpropdef.mproperty} for {mpropdef.mproperty.mpropdefs.length} definitions"
395 totry_methods_to_remove
.add
(mpropdef
.mproperty
)
398 fun add_send
(recv
: MType, mproperty
: MMethod)
400 if try_methods
.has
(mproperty
) then return
401 #print "new prop: {mproperty}"
402 live_methods
.add
(mproperty
)
403 try_methods
.add
(mproperty
)
404 if mproperty
.mpropdefs
.length
== 1 then
405 # If there is only one definition, just add the definition and do not try again the property
406 var d
= mproperty
.mpropdefs
.first
410 # Else, the property is potentially called with various reciever
411 # So just try the methods with existing receiver and register it for future receiver
412 totry_methods
.add
(mproperty
)
413 for c
in live_classes
do
414 try_send
(c
.intro
.bound_mtype
, mproperty
)
418 fun try_super_send
(recv
: MClassType, mpropdef
: MMethodDef)
420 recv
= recv
.mclass
.intro
.bound_mtype
421 if not recv
.collect_mclassdefs
(mainmodule
).has
(mpropdef
.mclassdef
) then return
422 var d
= mpropdef
.lookup_next_definition
(mainmodule
, recv
)
426 fun add_super_send
(recv
: MType, mpropdef
: MMethodDef)
428 assert mpropdef
.has_supercall
429 if live_super_sends
.has
(mpropdef
) then return
430 #print "new super prop: {mpropdef}"
431 live_super_sends
.add
(mpropdef
)
432 for c
in live_classes
do
433 try_super_send
(c
.intro
.bound_mtype
, mpropdef
)
438 class RapidTypeVisitor
441 var analysis
: RapidTypeAnalysis
442 var receiver
: MClassType
443 var mpropdef
: MPropDef
447 assert not receiver
.need_anchor
452 n
.accept_rapid_type_visitor
(self)
454 var implicit_cast_to
= n
.implicit_cast_to
455 if implicit_cast_to
!= null then self.add_cast_type
(implicit_cast_to
)
458 # RTA does not enter in AAnnotations
459 if not n
isa AAnnotations then
464 fun cleanup_type
(mtype
: MType): nullable MClassType
466 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
467 if mtype
isa MNullType then return null
468 mtype
= mtype
.undecorate
469 assert mtype
isa MClassType
470 assert not mtype
.need_anchor
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
.native_array_type
(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
)
543 v
.add_callsite
(with_capacity_callsite
)
544 v
.add_callsite
(push_callsite
)
548 redef class AStringFormExpr
549 redef fun accept_rapid_type_visitor
(v
)
551 var native
= v
.analysis
.mainmodule
.native_string_type
553 var prop
= v
.get_method
(native
, "to_s_with_length")
554 v
.add_monomorphic_send
(native
, prop
)
558 redef class ASuperstringExpr
559 redef fun accept_rapid_type_visitor
(v
)
561 var mmodule
= v
.analysis
.mainmodule
562 var object_type
= mmodule
.object_type
563 var arraytype
= mmodule
.array_type
(object_type
)
564 v
.add_type
(arraytype
)
565 var nattype
= mmodule
.native_array_type
(object_type
)
567 var prop
= v
.get_method
(arraytype
, "join")
568 v
.add_monomorphic_send
(arraytype
, prop
)
569 var prop2
= v
.get_method
(arraytype
, "with_native")
570 v
.add_monomorphic_send
(arraytype
, prop2
)
571 v
.add_monomorphic_send
(nattype
, v
.get_method
(nattype
, "native_to_s"))
575 redef class ACrangeExpr
576 redef fun accept_rapid_type_visitor
(v
)
578 var mtype
= self.mtype
.as(MClassType)
580 v
.add_callsite
(init_callsite
)
584 redef class AOrangeExpr
585 redef fun accept_rapid_type_visitor
(v
)
587 var mtype
= self.mtype
.as(MClassType)
589 v
.add_callsite
(init_callsite
)
593 redef class ATrueExpr
594 redef fun accept_rapid_type_visitor
(v
)
596 v
.add_type
(self.mtype
.as(MClassType))
600 redef class AFalseExpr
601 redef fun accept_rapid_type_visitor
(v
)
603 v
.add_type
(self.mtype
.as(MClassType))
608 redef fun accept_rapid_type_visitor
(v
)
610 v
.add_cast_type
(self.cast_type
.as(not null))
614 redef class AAsCastExpr
615 redef fun accept_rapid_type_visitor
(v
)
617 v
.add_cast_type
(self.mtype
.as(not null))
621 redef class ASendExpr
622 redef fun accept_rapid_type_visitor
(v
)
624 v
.add_callsite
(callsite
)
629 redef class ASendReassignFormExpr
630 redef fun accept_rapid_type_visitor
(v
)
632 v
.add_callsite
(callsite
)
633 v
.add_callsite
(reassign_callsite
)
634 v
.add_callsite
(write_callsite
)
638 redef class AVarReassignExpr
639 redef fun accept_rapid_type_visitor
(v
)
641 v
.add_callsite
(reassign_callsite
)
645 redef class AAttrReassignExpr
646 redef fun accept_rapid_type_visitor
(v
)
648 v
.add_callsite
(reassign_callsite
)
652 redef class ASuperExpr
653 redef fun accept_rapid_type_visitor
(v
)
655 var callsite
= self.callsite
656 if callsite
!= null then
657 v
.add_callsite
(callsite
)
661 v
.analysis
.add_super_send
(v
.receiver
, mpropdef
.as(not null))
666 redef fun accept_rapid_type_visitor
(v
)
668 v
.add_callsite
(self.method_iterator
)
669 v
.add_callsite
(self.method_is_ok
)
670 if self.variables
.length
== 1 then
671 v
.add_callsite
(self.method_item
)
672 else if self.variables
.length
== 2 then
673 v
.add_callsite
(self.method_key
)
674 v
.add_callsite
(self.method_item
)
678 v
.add_callsite
(self.method_next
)
679 var mf
= self.method_finish
680 if mf
!= null then v
.add_callsite
(mf
)
685 redef fun accept_rapid_type_visitor
(v
)
687 var mtype
= self.recvtype
.as(not null)
689 v
.add_callsite
(callsite
)