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 fun do_rapid_type_analysis
(mainmodule
: MModule): RapidTypeAnalysis
36 var analysis
= new RapidTypeAnalysis(self, mainmodule
)
42 # RapidTypeAnalysis looks for alive rapid types in application.
43 # The entry point of the analysis is the mainmodule of the application.
44 class RapidTypeAnalysis
45 # The modelbuilder used to get the AST.
46 var modelbuilder
: ModelBuilder
48 # The main module of the analysis.
49 # Used to perform types operations.
50 var mainmodule
: MModule
52 # The pool to live types.
53 # During the analysis, new types are added and combined with
54 # live_methods to determine new methoddefs to visit
55 var live_types
= new HashSet[MClassType]
57 # The pool of undesolved live types
58 # They are globally resolved at the end of the analaysis
59 var live_open_types
= new HashSet[MClassType]
61 # Live (instantiated) classes.
62 var live_classes
= new HashSet[MClass]
64 # The pool of types used to perform type checks (isa and as).
65 var live_cast_types
= new HashSet[MType]
67 # The pool of undesolved types used to perform type checks (isa and as).
68 # They are globally resolved at the end of the analaysis
69 var live_open_cast_types
= new HashSet[MType]
71 # Live method definitions.
72 var live_methoddefs
= new HashSet[MMethodDef]
75 var live_methods
= new HashSet[MMethod]
78 var live_callsites
= new HashSet[CallSite]
80 private var live_targets_cache
= new HashMap2[MType, MProperty, Set[MMethodDef]]
82 # The live targets of a specific callsite.
83 fun live_targets
(callsite
: CallSite): Set[MMethodDef]
85 var mtype
= callsite
.recv
86 var anchor
= callsite
.anchor
87 if anchor
!= null then mtype
= mtype
.anchor_to
(callsite
.mmodule
, anchor
)
88 mtype
= mtype
.as_notnullable
89 assert mtype
isa MClassType
90 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
.header
= ["Type", "Resolution", "Liveness", "Cast-liveness"]
127 if t
.need_anchor
then reso
= "OPEN " else reso
= "CLOSED"
129 if t
isa MClassType and (live_types
.has
(t
) or live_open_types
.has
(t
)) then live
= "LIVE" else live
= "DEAD"
131 if live_cast_types
.has
(t
) or live_open_cast_types
.has
(t
) then cast
= "CAST LIVE" else cast
= "CAST DEAD"
132 res
.add_line
(t
, reso
, live
, cast
)
137 # Return a ready-to-save OrderedTree object that agregates infomration about live methods.
138 # Note: methods are listed in an alphanumeric order to improve human reading.
139 fun live_methods_to_tree
: OrderedTree[Object]
141 var tree
= new OrderedTree[Object]
142 for x
in live_methods
do
145 for z
in x
.mpropdefs
do
147 if live_methoddefs
.has
(z
) then
149 if live_super_sends
.has
(z
) then
150 tree
.add
(zn
, zn
+ "(super)")
152 else if live_super_sends
.has
(z
) then
153 tree
.add
(xn
, zn
+ "(super)")
157 tree
.sort_with
(alpha_comparator
)
161 # Methods that are still candidate to the try_send
162 private var totry_methods
= new HashSet[MMethod]
164 # Methods that are are no more candidate to the try_send
165 private var totry_methods_to_remove
= new Array[MMethod]
167 # Methods that are or were candidate to the try_send
168 # Used to ensure that try_send is only used once
169 private var try_methods
= new HashSet[MMethod]
171 # The method definitions that remain to visit
172 private var todo
= new List[MMethodDef]
174 private fun force_alive
(classname
: String)
176 var classes
= self.modelbuilder
.model
.get_mclasses_by_name
(classname
)
177 if classes
!= null then for c
in classes
do self.add_new
(c
.mclass_type
, c
.mclass_type
)
180 # Run the analysis until all visitable method definitions are visited.
183 var maintype
= mainmodule
.sys_type
184 if maintype
== null then return # No entry point
185 add_new
(maintype
, maintype
)
186 var initprop
= mainmodule
.try_get_primitive_method
("init", maintype
.mclass
)
187 if initprop
!= null then
188 add_send
(maintype
, initprop
)
190 var mainprop
= mainmodule
.try_get_primitive_method
("run", maintype
.mclass
) or else
191 mainmodule
.try_get_primitive_method
("main", maintype
.mclass
)
192 if mainprop
!= null then
193 add_send
(maintype
, mainprop
)
196 var finalizable_type
= mainmodule
.finalizable_type
197 if finalizable_type
!= null then
198 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
199 if finalize_meth
!= null then add_send
(finalizable_type
, finalize_meth
)
202 # Force primitive types
208 while not todo
.is_empty
do
209 var mmethoddef
= todo
.shift
210 var mmeth
= mmethoddef
.mproperty
211 #print "# visit {mmethoddef}"
212 var v
= new RapidTypeVisitor(self, mmethoddef
.mclassdef
.bound_mtype
, mmethoddef
)
214 var vararg_rank
= mmethoddef
.msignature
.vararg_rank
215 if vararg_rank
> -1 then
216 var node
= self.modelbuilder
.mpropdef2npropdef
[mmethoddef
]
217 var elttype
= mmethoddef
.msignature
.mparameters
[vararg_rank
].mtype
218 #elttype = elttype.anchor_to(self.mainmodule, v.receiver)
219 var vararg
= self.mainmodule
.get_primitive_class
("Array").get_mtype
([elttype
])
221 var native
= self.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([elttype
])
223 v
.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
.mclass
, self.mainmodule
))
226 # TODO? new_msignature
227 var sig
= mmethoddef
.msignature
.as(not null)
228 var osig
= mmeth
.intro
.msignature
.as(not null)
229 for i
in [0..sig
.arity
[ do
230 var origtype
= osig
.mparameters
[i
].mtype
231 if not origtype
.need_anchor
then continue # skip non covariant stuff
232 var paramtype
= sig
.mparameters
[i
].mtype
236 if not modelbuilder
.mpropdef2npropdef
.has_key
(mmethoddef
) then
237 # It is an init for a class?
238 if mmeth
.name
== "init" then
239 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[mmethoddef
.mclassdef
]
240 assert mmethoddef
== nclassdef
.mfree_init
241 var super_inits
= nclassdef
.super_inits
242 if super_inits
!= null then
243 #assert args.length == 1
244 for su
in super_inits
do
245 v
.add_monomorphic_send
(v
.receiver
, su
)
249 if mmethoddef
.mproperty
.is_root_init
and not mmethoddef
.is_intro
then
250 self.add_super_send
(v
.receiver
, mmethoddef
)
258 var npropdef
= modelbuilder
.mpropdef2npropdef
[mmethoddef
]
260 if npropdef
isa AMethPropdef then
261 var auto_super_inits
= npropdef
.auto_super_inits
262 if auto_super_inits
!= null then
263 for auto_super_init
in auto_super_inits
do
264 v
.add_callsite
(auto_super_init
)
267 if npropdef
.auto_super_call
then
268 self.add_super_send
(v
.receiver
, mmethoddef
)
273 v
.add_type
(v
.receiver
)
274 else if mmethoddef
.is_intern
or mmethoddef
.is_extern
then
275 # UGLY: We force the "instantation" of the concrete return type if any
276 var ret
= mmethoddef
.msignature
.return_mtype
277 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
282 v
.enter_visit
(npropdef
)
285 #print "MMethod {live_methods.length}: {live_methods.join(", ")}"
286 #print "MMethodDef {live_methoddefs.length}: {live_methoddefs.join(", ")}"
288 #print "open MType {live_open_types.length}: {live_open_types.join(", ")}"
289 var todo_types
= new List[MClassType]
290 todo_types
.add_all
(live_types
)
291 while not todo_types
.is_empty
do
292 var t
= todo_types
.shift
293 for ot
in live_open_types
do
295 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
296 var rt
= ot
.anchor_to
(mainmodule
, t
)
297 if live_types
.has
(rt
) then continue
298 #print "{ot}/{t} -> {rt}"
304 #print "MType {live_types.length}: {live_types.join(", ")}"
306 #print "open cast MType {live_open_cast_types.length}: {live_open_cast_types.join(", ")}"
307 for ot
in live_open_cast_types
do
308 #print "live_open_cast_type: {ot}"
309 for t
in live_types
do
310 if not ot
.can_resolve_for
(t
, t
, mainmodule
) then continue
311 var rt
= ot
.anchor_to
(mainmodule
, t
)
312 live_cast_types
.add
(rt
)
313 #print " {ot}/{t} -> {rt}"
316 #print "cast MType {live_cast_types.length}: {live_cast_types.join(", ")}"
319 private fun check_depth
(mtype
: MClassType)
323 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}.")
327 fun add_new
(recv
: MClassType, mtype
: MClassType)
329 assert not recv
.need_anchor
330 if mtype
.need_anchor
then
331 if live_open_types
.has
(mtype
) then return
332 live_open_types
.add
(mtype
)
334 if live_types
.has
(mtype
) then return
335 live_types
.add
(mtype
)
338 var mclass
= mtype
.mclass
339 if live_classes
.has
(mclass
) then return
340 live_classes
.add
(mclass
)
342 for p
in totry_methods
do try_send
(mtype
, p
)
343 for p
in live_super_sends
do try_super_send
(mtype
, p
)
345 # Remove cleared ones
346 for p
in totry_methods_to_remove
do totry_methods
.remove
(p
)
347 totry_methods_to_remove
.clear
349 var bound_mtype
= mtype
.anchor_to
(mainmodule
, recv
)
350 for cd
in bound_mtype
.collect_mclassdefs
(mainmodule
)
352 if not self.modelbuilder
.mclassdef2nclassdef
.has_key
(cd
) then continue
353 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[cd
]
354 for npropdef
in nclassdef
.n_propdefs
do
355 if not npropdef
isa AAttrPropdef then continue
356 var nexpr
= npropdef
.n_expr
357 if nexpr
== null then continue
358 var mpropdef
= npropdef
.mpropdef
.as(not null)
359 var v
= new RapidTypeVisitor(self, bound_mtype
, mpropdef
)
366 fun add_cast
(mtype
: MType)
368 if mtype
.need_anchor
then
369 live_open_cast_types
.add
(mtype
)
371 live_cast_types
.add
(mtype
)
375 fun try_send
(recv
: MClassType, mproperty
: MMethod)
377 recv
= recv
.mclass
.intro
.bound_mtype
378 if not recv
.has_mproperty
(mainmodule
, mproperty
) then return
379 var d
= mproperty
.lookup_first_definition
(mainmodule
, recv
)
383 fun add_call
(mpropdef
: MMethodDef)
385 if live_methoddefs
.has
(mpropdef
) then return
386 live_methoddefs
.add
(mpropdef
)
389 var mproperty
= mpropdef
.mproperty
390 if mproperty
.mpropdefs
.length
<= 1 then return
391 # If all definitions of a method are live, we can remove the definition of the totry set
392 for d
in mproperty
.mpropdefs
do
393 if d
.is_abstract
then continue
394 if not live_methoddefs
.has
(d
) then return
396 #print "full property: {mpropdef.mproperty} for {mpropdef.mproperty.mpropdefs.length} definitions"
397 totry_methods_to_remove
.add
(mpropdef
.mproperty
)
400 fun add_send
(recv
: MType, mproperty
: MMethod)
402 if try_methods
.has
(mproperty
) then return
403 #print "new prop: {mproperty}"
404 live_methods
.add
(mproperty
)
405 try_methods
.add
(mproperty
)
406 if mproperty
.mpropdefs
.length
== 1 then
407 # If there is only one definition, just add the definition and do not try again the property
408 var d
= mproperty
.mpropdefs
.first
412 # Else, the property is potentially called with various reciever
413 # So just try the methods with existing receiver and register it for future receiver
414 totry_methods
.add
(mproperty
)
415 for c
in live_classes
do
416 try_send
(c
.intro
.bound_mtype
, mproperty
)
420 fun try_super_send
(recv
: MClassType, mpropdef
: MMethodDef)
422 recv
= recv
.mclass
.intro
.bound_mtype
423 if not recv
.collect_mclassdefs
(mainmodule
).has
(mpropdef
.mclassdef
) then return
424 var d
= mpropdef
.lookup_next_definition
(mainmodule
, recv
)
428 fun add_super_send
(recv
: MType, mpropdef
: MMethodDef)
430 assert mpropdef
.has_supercall
431 if live_super_sends
.has
(mpropdef
) then return
432 #print "new super prop: {mpropdef}"
433 live_super_sends
.add
(mpropdef
)
434 for c
in live_classes
do
435 try_super_send
(c
.intro
.bound_mtype
, mpropdef
)
440 class RapidTypeVisitor
443 var analysis
: RapidTypeAnalysis
444 var receiver
: MClassType
445 var mpropdef
: MPropDef
447 init(analysis
: RapidTypeAnalysis, receiver
: MClassType, mpropdef
: MPropDef)
449 self.analysis
= analysis
450 self.receiver
= receiver
451 self.mpropdef
= mpropdef
452 assert not receiver
.need_anchor
457 n
.accept_rapid_type_visitor
(self)
459 var implicit_cast_to
= n
.implicit_cast_to
460 if implicit_cast_to
!= null then self.add_cast_type
(implicit_cast_to
)
463 # RTA does not enter in AAnnotations
464 if not n
isa AAnnotations then
469 fun cleanup_type
(mtype
: MType): nullable MClassType
471 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
472 if mtype
isa MNullType then return null
473 mtype
= mtype
.as_notnullable
474 assert mtype
isa MClassType
475 assert not mtype
.need_anchor
479 fun get_class
(name
: String): MClass
481 return analysis
.mainmodule
.get_primitive_class
(name
)
484 fun get_method
(recv
: MType, name
: String): MMethod
486 var mtype
= cleanup_type
(recv
)
488 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, mtype
.mclass
, self.analysis
.mainmodule
)
491 fun add_type
(mtype
: MClassType) do analysis
.add_new
(receiver
, mtype
)
493 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
495 analysis
.live_methods
.add
(mproperty
)
496 analysis
.try_send
(mtype
.as(MClassType), mproperty
)
499 fun add_send
(mtype
: MType, mproperty
: MMethod) do analysis
.add_send
(mtype
, mproperty
)
501 fun add_cast_type
(mtype
: MType) do analysis
.add_cast
(mtype
)
503 fun add_callsite
(callsite
: nullable CallSite) do if callsite
!= null then
504 for m
in callsite
.mpropdef
.initializers
do
505 if m
isa MMethod then
506 analysis
.add_send
(callsite
.recv
, m
)
509 analysis
.add_send
(callsite
.recv
, callsite
.mproperty
)
510 analysis
.live_callsites
.add
(callsite
)
517 private fun accept_rapid_type_visitor
(v
: RapidTypeVisitor)
523 redef fun accept_rapid_type_visitor
(v
)
525 v
.add_type
(self.mtype
.as(MClassType))
529 redef class AFloatExpr
530 redef fun accept_rapid_type_visitor
(v
)
532 v
.add_type
(self.mtype
.as(MClassType))
536 redef class ACharExpr
537 redef fun accept_rapid_type_visitor
(v
)
539 v
.add_type
(self.mtype
.as(MClassType))
543 redef class AArrayExpr
544 redef fun accept_rapid_type_visitor
(v
)
546 var mtype
= self.mtype
.as(MClassType)
548 var native
= v
.analysis
.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([mtype
.arguments
.first
])
550 mtype
= v
.cleanup_type
(mtype
).as(not null)
551 var prop
= v
.get_method
(mtype
, "with_native")
552 v
.add_monomorphic_send
(mtype
, prop
)
556 redef class AStringFormExpr
557 redef fun accept_rapid_type_visitor
(v
)
559 var native
= v
.get_class
("NativeString").mclass_type
561 var prop
= v
.get_method
(native
, "to_s_with_length")
562 v
.add_monomorphic_send
(native
, prop
)
566 redef class ASuperstringExpr
567 redef fun accept_rapid_type_visitor
(v
)
569 var arraytype
= v
.get_class
("Array").get_mtype
([v
.get_class
("Object").mclass_type
])
570 v
.add_type
(arraytype
)
571 v
.add_type
(v
.get_class
("NativeArray").get_mtype
([v
.get_class
("Object").mclass_type
]))
572 var prop
= v
.get_method
(arraytype
, "join")
573 v
.add_monomorphic_send
(arraytype
, prop
)
574 var prop2
= v
.get_method
(arraytype
, "with_native")
575 v
.add_monomorphic_send
(arraytype
, prop2
)
579 redef class ACrangeExpr
580 redef fun accept_rapid_type_visitor
(v
)
582 var mtype
= self.mtype
.as(MClassType)
584 v
.add_callsite
(init_callsite
)
588 redef class AOrangeExpr
589 redef fun accept_rapid_type_visitor
(v
)
591 var mtype
= self.mtype
.as(MClassType)
593 v
.add_callsite
(init_callsite
)
597 redef class ATrueExpr
598 redef fun accept_rapid_type_visitor
(v
)
600 v
.add_type
(self.mtype
.as(MClassType))
604 redef class AFalseExpr
605 redef fun accept_rapid_type_visitor
(v
)
607 v
.add_type
(self.mtype
.as(MClassType))
612 redef fun accept_rapid_type_visitor
(v
)
614 v
.add_cast_type
(self.cast_type
.as(not null))
618 redef class AAsCastExpr
619 redef fun accept_rapid_type_visitor
(v
)
621 v
.add_cast_type
(self.mtype
.as(not null))
625 redef class ASendExpr
626 redef fun accept_rapid_type_visitor
(v
)
628 v
.add_callsite
(callsite
)
633 redef class ASendReassignFormExpr
634 redef fun accept_rapid_type_visitor
(v
)
636 v
.add_callsite
(callsite
)
637 v
.add_callsite
(reassign_callsite
)
638 v
.add_callsite
(write_callsite
)
642 redef class AVarReassignExpr
643 redef fun accept_rapid_type_visitor
(v
)
645 v
.add_callsite
(reassign_callsite
)
649 redef class AAttrReassignExpr
650 redef fun accept_rapid_type_visitor
(v
)
652 v
.add_callsite
(reassign_callsite
)
656 redef class ASuperExpr
657 redef fun accept_rapid_type_visitor
(v
)
659 var callsite
= self.callsite
660 if callsite
!= null then
661 v
.add_callsite
(callsite
)
665 v
.analysis
.add_super_send
(v
.receiver
, mpropdef
.as(not null))
670 redef fun accept_rapid_type_visitor
(v
)
672 v
.add_callsite
(self.method_iterator
)
673 v
.add_callsite
(self.method_is_ok
)
674 if self.variables
.length
== 1 then
675 v
.add_callsite
(self.method_item
)
676 else if self.variables
.length
== 2 then
677 v
.add_callsite
(self.method_key
)
678 v
.add_callsite
(self.method_item
)
682 v
.add_callsite
(self.method_next
)
687 redef fun accept_rapid_type_visitor
(v
)
689 var mtype
= self.mtype
.as(MClassType)
691 v
.add_callsite
(callsite
)