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 # Those with a live method definitions (see `live_methoddefs`)
87 var live_mmodules
= new HashSet[MModule]
90 var live_callsites
= new HashSet[CallSite]
92 private var live_targets_cache
= new HashMap2[MType, MProperty, Set[MMethodDef]]
94 # The live targets of a specific callsite.
95 fun live_targets
(callsite
: CallSite): Set[MMethodDef]
97 var mtype
= callsite
.recv
98 var anchor
= callsite
.anchor
99 if anchor
!= null then mtype
= mtype
.anchor_to
(callsite
.mmodule
, anchor
)
100 mtype
= mtype
.undecorate
101 if mtype
isa MClassType then mtype
= mtype
.mclass
.intro
.bound_mtype
102 var mproperty
= callsite
.mproperty
103 var res
= live_targets_cache
[mtype
, mproperty
]
104 if res
!= null then return res
105 res
= new ArraySet[MMethodDef]
106 live_targets_cache
[mtype
, mproperty
] = res
108 for c
in live_classes
do
109 var tc
= c
.intro
.bound_mtype
110 if not tc
.is_subtype
(mainmodule
, null, mtype
) then continue
111 var d
= mproperty
.lookup_first_definition
(mainmodule
, tc
)
118 # Live call-to-super.
119 var live_super_sends
= new HashSet[MMethodDef]
121 # Return a ready-to-save CSV document objet that agregates informations about live types.
122 # Each discovered type is listed in a line, with its status: resolution, liveness, cast-liveness.
123 # Note: types are listed in an alphanumeric order to improve human reading.
124 fun live_types_to_csv
: CsvDocument
126 # Gather all kind of type
127 var typeset
= new HashSet[MType]
128 typeset
.add_all
(live_types
)
129 typeset
.add_all
(live_open_types
)
130 typeset
.add_all
(live_cast_types
)
131 typeset
.add_all
(live_open_cast_types
)
132 var types
= typeset
.to_a
133 (new CachedAlphaComparator).sort
(types
)
134 var res
= new CsvDocument
135 res
.format
= new CsvFormat('"', ';', "\n")
136 res
.header
= ["Type", "Resolution", "Liveness", "Cast-liveness"]
139 if t
.need_anchor
then reso
= "OPEN " else reso
= "CLOSED"
141 if t
isa MClassType and (live_types
.has
(t
) or live_open_types
.has
(t
)) then live
= "LIVE" else live
= "DEAD"
143 if live_cast_types
.has
(t
) or live_open_cast_types
.has
(t
) then cast
= "CAST LIVE" else cast
= "CAST DEAD"
144 res
.add_record
(t
, reso
, live
, cast
)
149 # Return a ready-to-save OrderedTree object that agregates infomration about live methods.
150 # Note: methods are listed in an alphanumeric order to improve human reading.
151 fun live_methods_to_tree
: OrderedTree[Object]
153 var tree
= new OrderedTree[Object]
154 for x
in live_methods
do
157 for z
in x
.mpropdefs
do
159 if live_methoddefs
.has
(z
) then
161 if live_super_sends
.has
(z
) then
162 tree
.add
(zn
, zn
+ "(super)")
164 else if live_super_sends
.has
(z
) then
165 tree
.add
(xn
, zn
+ "(super)")
169 tree
.sort_with
(alpha_comparator
)
173 # Methods that are still candidate to the try_send
174 private var totry_methods
= new HashSet[MMethod]
176 # Methods that are are no more candidate to the try_send
177 private var totry_methods_to_remove
= new Array[MMethod]
179 # Methods that are or were candidate to the try_send
180 # Used to ensure that try_send is only used once
181 private var try_methods
= new HashSet[MMethod]
183 # The method definitions that remain to visit
184 private var todo
= new List[MMethodDef]
186 private fun force_alive
(classname
: String)
188 var classes
= self.modelbuilder
.model
.get_mclasses_by_name
(classname
)
189 if classes
!= null then for c
in classes
do self.add_new
(c
.mclass_type
, c
.mclass_type
)
192 # Run the analysis until all visitable method definitions are visited.
195 var maintype
= mainmodule
.sys_type
196 if maintype
== null then return # No entry point
197 add_new
(maintype
, maintype
)
198 var initprop
= mainmodule
.try_get_primitive_method
("init", maintype
.mclass
)
199 if initprop
!= null then
200 add_send
(maintype
, initprop
)
202 var mainprop
= mainmodule
.try_get_primitive_method
("run", maintype
.mclass
) or else
203 mainmodule
.try_get_primitive_method
("main", maintype
.mclass
)
204 if mainprop
!= null then
205 add_send
(maintype
, mainprop
)
208 var finalizable_type
= mainmodule
.finalizable_type
209 if finalizable_type
!= null then
210 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
211 if finalize_meth
!= null then add_send
(finalizable_type
, finalize_meth
)
214 # Force primitive types
219 force_alive
("Pointer")
222 while not todo
.is_empty
do
223 var mmethoddef
= todo
.shift
224 var mmeth
= mmethoddef
.mproperty
225 var msignature
= mmethoddef
.msignature
226 if msignature
== null then continue # Skip broken method
228 #print "# visit {mmethoddef}"
229 var v
= new RapidTypeVisitor(self, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
)
231 var vararg_rank
= msignature
.vararg_rank
232 if vararg_rank
> -1 then
233 var node
= self.modelbuilder
.mpropdef2node
(mmethoddef
)
234 var elttype
= msignature
.mparameters
[vararg_rank
].mtype
235 #elttype = elttype.anchor_to(self.mainmodule, v.receiver)
236 var vararg
= self.mainmodule
.array_type
(elttype
)
238 var native
= self.mainmodule
.native_array_type
(elttype
)
240 v
.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
.mclass
, self.mainmodule
))
243 # TODO? new_msignature
245 var osig
= mmeth
.intro
.msignature
.as(not null)
246 for i
in [0..sig
.arity
[ do
247 var origtype
= osig
.mparameters
[i
].mtype
248 if not origtype
.need_anchor
then continue # skip non covariant stuff
249 var paramtype
= sig
.mparameters
[i
].mtype
253 var npropdef
= modelbuilder
.mpropdef2node
(mmethoddef
)
255 if npropdef
isa AClassdef then
256 # It is an init for a class
257 assert mmethoddef
== npropdef
.mfree_init
259 if mmethoddef
.mproperty
.is_root_init
and not mmethoddef
.is_intro
then
260 self.add_super_send
(v
.receiver
, mmethoddef
)
263 else if mmethoddef
.constant_value
!= null then
264 # Make the return type live
265 v
.add_type
(msignature
.return_mtype
.as(MClassType))
267 else if npropdef
== null then
271 if npropdef
isa AMethPropdef then
272 var auto_super_inits
= npropdef
.auto_super_inits
273 if auto_super_inits
!= null then
274 for auto_super_init
in auto_super_inits
do
275 v
.add_callsite
(auto_super_init
)
278 if npropdef
.auto_super_call
then
279 self.add_super_send
(v
.receiver
, mmethoddef
)
283 if mmethoddef
.is_intern
or mmethoddef
.is_extern
then
284 # UGLY: We force the "instantation" of the concrete return type if any
285 var ret
= msignature
.return_mtype
286 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
291 v
.enter_visit
(npropdef
)
294 #print "MMethod {live_methods.length}: {live_methods.join(", ")}"
295 #print "MMethodDef {live_methoddefs.length}: {live_methoddefs.join(", ")}"
297 #print "open MType {live_open_types.length}: {live_open_types.join(", ")}"
298 var todo_types
= new List[MClassType]
299 todo_types
.add_all
(live_types
)
300 while not todo_types
.is_empty
do
301 var t
= todo_types
.shift
302 for ot
in live_open_types
do
304 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
305 var rt
= ot
.anchor_to
(mainmodule
, t
)
306 if live_types
.has
(rt
) then continue
307 if not check_depth
(rt
) then continue
308 #print "{ot}/{t} -> {rt}"
313 #print "MType {live_types.length}: {live_types.join(", ")}"
315 #print "open cast MType {live_open_cast_types.length}: {live_open_cast_types.join(", ")}"
316 for ot
in live_open_cast_types
do
317 #print "live_open_cast_type: {ot}"
318 for t
in live_types
do
319 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
320 var rt
= ot
.anchor_to
(mainmodule
, t
)
321 live_cast_types
.add
(rt
)
322 #print " {ot}/{t} -> {rt}"
325 #print "cast MType {live_cast_types.length}: {live_cast_types.join(", ")}"
328 private fun check_depth
(mtype
: MClassType): Bool
332 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}`.")
338 fun add_new
(recv
: MClassType, mtype
: MClassType)
340 assert not recv
.need_anchor
341 if mtype
.need_anchor
then
342 if live_open_types
.has
(mtype
) then return
343 live_open_types
.add
(mtype
)
345 if live_types
.has
(mtype
) then return
346 live_types
.add
(mtype
)
349 var mclass
= mtype
.mclass
350 if live_classes
.has
(mclass
) then return
351 live_classes
.add
(mclass
)
353 for p
in totry_methods
do try_send
(mtype
, p
)
354 for p
in live_super_sends
do try_super_send
(mtype
, p
)
356 # Remove cleared ones
357 for p
in totry_methods_to_remove
do totry_methods
.remove
(p
)
358 totry_methods_to_remove
.clear
360 var bound_mtype
= mtype
.anchor_to
(mainmodule
, recv
)
361 for cd
in bound_mtype
.collect_mclassdefs
(mainmodule
)
363 for npropdef
in modelbuilder
.collect_attr_propdef
(cd
) do
364 if not npropdef
.has_value
then continue
366 var mpropdef
= npropdef
.mreadpropdef
.as(not null)
367 var v
= new RapidTypeVisitor(self, bound_mtype
, mpropdef
)
368 v
.enter_visit
(npropdef
.n_expr
)
369 v
.enter_visit
(npropdef
.n_block
)
375 fun add_cast
(mtype
: MType)
377 if mtype
.need_anchor
then
378 live_open_cast_types
.add
(mtype
)
380 live_cast_types
.add
(mtype
)
384 fun try_send
(recv
: MClassType, mproperty
: MMethod)
386 recv
= recv
.mclass
.intro
.bound_mtype
387 if not recv
.has_mproperty
(mainmodule
, mproperty
) then return
388 var d
= mproperty
.lookup_first_definition
(mainmodule
, recv
)
392 fun add_call
(mpropdef
: MMethodDef)
394 if live_methoddefs
.has
(mpropdef
) then return
395 live_methoddefs
.add
(mpropdef
)
396 live_mmodules
.add
(mpropdef
.mclassdef
.mmodule
)
399 var mproperty
= mpropdef
.mproperty
400 if mproperty
.mpropdefs
.length
<= 1 then return
401 # If all definitions of a method are live, we can remove the definition of the totry set
402 for d
in mproperty
.mpropdefs
do
403 if not live_methoddefs
.has
(d
) then return
405 #print "full property: {mpropdef.mproperty} for {mpropdef.mproperty.mpropdefs.length} definitions"
406 totry_methods_to_remove
.add
(mpropdef
.mproperty
)
409 fun add_send
(recv
: MType, mproperty
: MMethod)
411 if try_methods
.has
(mproperty
) then return
412 #print "new prop: {mproperty}"
413 live_methods
.add
(mproperty
)
414 try_methods
.add
(mproperty
)
415 if mproperty
.mpropdefs
.length
== 1 then
416 # If there is only one definition, just add the definition and do not try again the property
417 var d
= mproperty
.mpropdefs
.first
421 # Else, the property is potentially called with various reciever
422 # So just try the methods with existing receiver and register it for future receiver
423 totry_methods
.add
(mproperty
)
424 for c
in live_classes
do
425 try_send
(c
.intro
.bound_mtype
, mproperty
)
429 fun try_super_send
(recv
: MClassType, mpropdef
: MMethodDef)
431 recv
= recv
.mclass
.intro
.bound_mtype
432 if not recv
.collect_mclassdefs
(mainmodule
).has
(mpropdef
.mclassdef
) then return
433 var d
= mpropdef
.lookup_next_definition
(mainmodule
, recv
)
437 fun add_super_send
(recv
: MType, mpropdef
: MMethodDef)
439 assert mpropdef
.has_supercall
440 if live_super_sends
.has
(mpropdef
) then return
441 #print "new super prop: {mpropdef}"
442 live_super_sends
.add
(mpropdef
)
443 for c
in live_classes
do
444 try_super_send
(c
.intro
.bound_mtype
, mpropdef
)
449 class RapidTypeVisitor
452 var analysis
: RapidTypeAnalysis
453 var receiver
: MClassType
454 var mpropdef
: MPropDef
458 assert not receiver
.need_anchor
464 if n
.mtype
!= null or n
.is_typed
then
465 n
.accept_rapid_type_visitor
(self)
466 var implicit_cast_to
= n
.implicit_cast_to
467 if implicit_cast_to
!= null then self.add_cast_type
(implicit_cast_to
)
470 n
.accept_rapid_type_visitor
(self)
473 # RTA does not enter in AAnnotations
474 if not n
isa AAnnotations then
479 fun cleanup_type
(mtype
: MType): nullable MClassType
481 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
482 if mtype
isa MNullType then return null
483 mtype
= mtype
.undecorate
484 assert mtype
isa MClassType
485 assert not mtype
.need_anchor
489 fun get_method
(recv
: MType, name
: String): MMethod
491 var mtype
= cleanup_type
(recv
)
493 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, mtype
.mclass
, self.analysis
.mainmodule
)
496 fun add_type
(mtype
: MClassType) do analysis
.add_new
(receiver
, mtype
)
498 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
500 analysis
.live_methods
.add
(mproperty
)
501 analysis
.try_send
(mtype
.as(MClassType), mproperty
)
504 fun add_send
(mtype
: MType, mproperty
: MMethod) do analysis
.add_send
(mtype
, mproperty
)
506 fun add_cast_type
(mtype
: MType) do analysis
.add_cast
(mtype
)
508 fun add_callsite
(callsite
: nullable CallSite) do if callsite
!= null then
509 for m
in callsite
.mpropdef
.initializers
do
510 if m
isa MMethod then
511 analysis
.add_send
(callsite
.recv
, m
)
514 analysis
.add_send
(callsite
.recv
, callsite
.mproperty
)
515 analysis
.live_callsites
.add
(callsite
)
522 private fun accept_rapid_type_visitor
(v
: RapidTypeVisitor)
528 # Make the `mtype` of the expression live
529 # Used by literals and instantiations
530 fun allocate_mtype
(v
: RapidTypeVisitor)
532 var mtype
= self.mtype
533 if not mtype
isa MClassType then return
534 v
.add_type
(self.mtype
.as(MClassType))
538 redef class AIntegerExpr
539 redef fun accept_rapid_type_visitor
(v
)
545 redef class AFloatExpr
546 redef fun accept_rapid_type_visitor
(v
)
552 redef class ACharExpr
553 redef fun accept_rapid_type_visitor
(v
)
559 redef class AArrayExpr
560 redef fun accept_rapid_type_visitor
(v
)
562 var mtype
= self.mtype
.as(MClassType)
564 var native
= v
.analysis
.mainmodule
.native_array_type
(mtype
.arguments
.first
)
566 mtype
= v
.cleanup_type
(mtype
).as(not null)
567 var prop
= v
.get_method
(mtype
, "with_native")
568 v
.add_monomorphic_send
(mtype
, prop
)
569 v
.add_callsite
(with_capacity_callsite
)
570 v
.add_callsite
(push_callsite
)
574 redef class AStringFormExpr
575 redef fun accept_rapid_type_visitor
(v
)
577 var native
= v
.analysis
.mainmodule
.native_string_type
579 var prop
= v
.get_method
(native
, "to_s_with_length")
580 v
.add_monomorphic_send
(native
, prop
)
584 redef class ASuperstringExpr
585 redef fun accept_rapid_type_visitor
(v
)
587 var mmodule
= v
.analysis
.mainmodule
588 var object_type
= mmodule
.string_type
589 var arraytype
= mmodule
.array_type
(object_type
)
590 v
.add_type
(arraytype
)
591 var nattype
= mmodule
.native_array_type
(object_type
)
593 var prop
= v
.get_method
(arraytype
, "join")
594 v
.add_monomorphic_send
(arraytype
, prop
)
595 var prop2
= v
.get_method
(arraytype
, "with_native")
596 v
.add_monomorphic_send
(arraytype
, prop2
)
597 v
.add_monomorphic_send
(nattype
, v
.get_method
(nattype
, "native_to_s"))
601 redef class ACrangeExpr
602 redef fun accept_rapid_type_visitor
(v
)
604 var mtype
= self.mtype
605 if not mtype
isa MClassType then return
607 v
.add_callsite
(init_callsite
)
611 redef class AOrangeExpr
612 redef fun accept_rapid_type_visitor
(v
)
614 var mtype
= self.mtype
615 if not mtype
isa MClassType then return
617 v
.add_callsite
(init_callsite
)
621 redef class ATrueExpr
622 redef fun accept_rapid_type_visitor
(v
)
628 redef class AFalseExpr
629 redef fun accept_rapid_type_visitor
(v
)
636 redef fun accept_rapid_type_visitor
(v
)
638 var cast_type
= self.cast_type
639 if cast_type
== null then return
640 v
.add_cast_type
(cast_type
)
644 redef class AAsCastExpr
645 redef fun accept_rapid_type_visitor
(v
)
647 var mtype
= self.mtype
648 if mtype
== null then return
649 v
.add_cast_type
(mtype
)
653 redef class ASendExpr
654 redef fun accept_rapid_type_visitor
(v
)
656 v
.add_callsite
(callsite
)
661 redef class ASendReassignFormExpr
662 redef fun accept_rapid_type_visitor
(v
)
664 v
.add_callsite
(callsite
)
665 v
.add_callsite
(reassign_callsite
)
666 v
.add_callsite
(write_callsite
)
670 redef class AVarReassignExpr
671 redef fun accept_rapid_type_visitor
(v
)
673 v
.add_callsite
(reassign_callsite
)
677 redef class AAttrReassignExpr
678 redef fun accept_rapid_type_visitor
(v
)
680 v
.add_callsite
(reassign_callsite
)
684 redef class ASuperExpr
685 redef fun accept_rapid_type_visitor
(v
)
687 var callsite
= self.callsite
688 if callsite
!= null then
689 v
.add_callsite
(callsite
)
693 v
.analysis
.add_super_send
(v
.receiver
, mpropdef
.as(not null))
698 redef fun accept_rapid_type_visitor
(v
)
700 v
.add_callsite
(self.method_iterator
)
701 v
.add_callsite
(self.method_is_ok
)
702 if self.variables
.length
== 1 then
703 v
.add_callsite
(self.method_item
)
704 else if self.variables
.length
== 2 then
705 v
.add_callsite
(self.method_key
)
706 v
.add_callsite
(self.method_item
)
710 v
.add_callsite
(self.method_next
)
711 var mf
= self.method_finish
712 if mf
!= null then v
.add_callsite
(mf
)
717 redef fun accept_rapid_type_visitor
(v
)
719 var mtype
= self.recvtype
.as(not null)
721 v
.add_callsite
(callsite
)