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 with heterogenous generics and customization
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.
25 # Heterogenous generics means that each intancied generic class is associated
26 # to a distinct rapid type.
27 # Heterogenous generics has the advantage to resolve the formal generic
28 # parameters types but increase the number of types.
29 # More important, heterogenous generics cannot deal with infinite number of rapid
30 # types since the analyse tries to list them all (so some programs will be badly refused)
32 # Customization means that each method definition is analyzed one per rapid
34 # Customization have the following advantages:
35 # * `self' is monomorphic
36 # * virtual types are all resolved
37 # * live attributes can be determined on each class
38 # But has the disadvantage to explode the number of rapid method: each method
39 # definition for each rapid type that need it
40 module rapid_type_analysis
45 import auto_super_init
47 redef class ModelBuilder
48 fun do_rapid_type_analysis
(mainmodule
: MModule): RapidTypeAnalysis
50 var model
= self.model
51 var analysis
= new RapidTypeAnalysis(self, mainmodule
)
52 var nmodule
= self.nmodules
.first
53 var maintype
= mainmodule
.sys_type
54 if maintype
== null then return analysis
# No entry point
55 analysis
.add_type
(maintype
)
56 var initprop
= mainmodule
.try_get_primitive_method
("init", maintype
)
57 if initprop
!= null then
58 analysis
.add_monomorphic_send
(maintype
, initprop
)
60 var mainprop
= mainmodule
.try_get_primitive_method
("main", maintype
)
61 if mainprop
!= null then
62 analysis
.add_monomorphic_send
(maintype
, mainprop
)
69 # RapidTypeAnalysis looks for alive rapid types in application.
70 # The entry point of the analysis is the mainmodule of the application.
71 class RapidTypeAnalysis
72 # The modelbuilder used to get the AST.
73 var modelbuilder
: ModelBuilder
75 # The main module of the analysis.
76 # Used to perform types operations.
77 var mainmodule
: MModule
79 # The pool to live types.
80 # During the analysis, new types are added and combined with
81 # live_send_sites to determine new customized_methoddefs to visit
82 var live_types
: HashSet[MClassType] = new HashSet[MClassType]
84 # The pool of types used to perform type checks (isa and as).
85 var live_cast_types
: HashSet[MClassType] = new HashSet[MClassType]
87 # Live method definitions.
88 # These method definitions are:
89 # * visited trough a add_send on an already known live_type
90 # * visited trough a add_type for an already known live_send_sites
91 # * visided by a add_monomorphic_send or a add_static_call
92 var live_methoddefs
: HashSet[MMethodDef] = new HashSet[MMethodDef]
94 # The pool of live customized method definitions
95 var live_customized_methoddefs
: HashSet[CustomizedMethodDef] = new HashSet[CustomizedMethodDef]
97 # The pool of live RTA send site
98 # During the analysis, new live_send_sites are added and combined with
99 # live_types to determine new live_customized_methoddefs to visit
100 var live_send_sites
: HashSet[RTASendSite] = new HashSet[RTASendSite]
102 # The customized method definitions that remain to visit
103 private var todo
: List[CustomizedMethodDef] = new List[CustomizedMethodDef]
105 # Adapt and remove nullable
106 # return null if we got the null type
107 fun cleanup_type
(mtype
: MType, recvtype
: MClassType): nullable MClassType
109 mtype
= mtype
.anchor_to
(self.mainmodule
, recvtype
)
110 if mtype
isa MNullType then return null
111 if mtype
isa MNullableType then mtype
= mtype
.mtype
112 assert mtype
isa MClassType
113 assert not mtype
.need_anchor
117 # Add a live type to the pool
119 # If the types is already live, then do nothing.
121 # REQUIRE: not mtype.need_anchor
122 fun add_type
(mtype
: MClassType)
124 if self.live_types
.has
(mtype
) then return
126 assert not mtype
.need_anchor
127 self.live_types
.add
(mtype
)
128 self.check_depth
(mtype
)
130 # Collect default attributes
131 for cd
in mtype
.collect_mclassdefs
(self.mainmodule
)
133 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[cd
]
134 for npropdef
in nclassdef
.n_propdefs
do
135 if not npropdef
isa AAttrPropdef then continue
136 var nexpr
= npropdef
.n_expr
137 if nexpr
== null then continue
138 var v
= new RapidTypeVisitor(self, nclassdef
, npropdef
.mpropdef
.as(not null), mtype
)
143 for rss
in self.live_send_sites
do
144 if not mtype
.is_subtype
(self.mainmodule
, null, rss
.receiver
) then continue
145 if mtype
.has_mproperty
(self.mainmodule
, rss
.mmethod
) then
146 self.add_monomorphic_send
(mtype
, rss
.mmethod
)
151 # Add a send site to the pool
153 # If the send site is already live, then do nothing.
154 fun add_send
(mtype
: MClassType, mmethod
: MMethod)
156 var rss
= new RTASendSite(mmethod
, mtype
)
157 if self.live_send_sites
.has
(rss
) then return
159 self.live_send_sites
.add
(rss
)
161 for mtype2
in self.live_types
do
162 if not mtype2
.is_subtype
(self.mainmodule
, null, mtype
) then continue
163 if mtype2
.has_mproperty
(self.mainmodule
, mmethod
) then
164 self.add_monomorphic_send
(mtype2
, mmethod
)
169 # Add a monomoprhic send.
170 # The send site is not added to the pool.
171 # The method just determine the associated method definition then
172 # performs a static_call
173 fun add_monomorphic_send
(mtype
: MClassType, mmethod
: MMethod)
175 assert self.live_types
.has
(mtype
)
176 if not mtype
.has_mproperty
(self.mainmodule
, mmethod
) then return
177 var def
= mmethod
.lookup_first_definition
(self.mainmodule
, mtype
)
178 self.add_static_call
(mtype
, def
)
181 # Add a customized_methoddefs to the pool
182 # Is the customized_methoddefs is already live, then do nothing
183 fun add_static_call
(mtype
: MClassType, mmethoddef
: MMethodDef)
185 assert self.live_types
.has
(mtype
)
186 var rm
= new CustomizedMethodDef(mmethoddef
, mtype
)
187 if self.live_customized_methoddefs
.has
(rm
) then return
188 self.live_customized_methoddefs
.add
(rm
)
190 self.live_methoddefs
.add
(mmethoddef
)
193 # Add mtype to the cast pool.
194 fun add_cast_type
(mtype
: MClassType)
196 if self.live_cast_types
.has
(mtype
) then return
198 assert not mtype
.need_anchor
199 self.live_cast_types
.add
(mtype
)
200 self.check_depth
(mtype
)
203 fun check_depth
(mtype
: MClassType)
207 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}.")
211 # Run the analysis until all visitable method definitions are visited.
215 var classes
= self.modelbuilder
.model
.get_mclasses_by_name
("Bool")
216 if classes
!= null then for c
in classes
do self.add_type
(c
.mclass_type
)
218 while not todo
.is_empty
do
221 var vararg_rank
= mr
.mmethoddef
.msignature
.vararg_rank
222 if vararg_rank
> -1 then
223 var node
= self.modelbuilder
.mpropdef2npropdef
[mr
.mmethoddef
]
224 var elttype
= mr
.mmethoddef
.msignature
.mparameters
[vararg_rank
].mtype
225 elttype
= elttype
.anchor_to
(self.mainmodule
, mr
.receiver
)
226 var vararg
= self.mainmodule
.get_primitive_class
("Array").get_mtype
([elttype
])
227 self.add_type
(vararg
)
228 self.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
, self.mainmodule
))
229 var native
= self.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([elttype
])
230 self.add_type
(native
)
233 for i
in [0..mr
.mmethoddef
.msignature
.arity
[ do
234 var origtype
= mr
.mmethoddef
.mproperty
.intro
.msignature
.mparameters
[i
].mtype
235 if not origtype
.need_anchor
then continue # skip non covariant stuff
236 var paramtype
= mr
.mmethoddef
.msignature
.mparameters
[i
].mtype
237 paramtype
= self.cleanup_type
(paramtype
, mr
.receiver
).as(not null)
238 self.add_cast_type
(paramtype
)
241 if not self.modelbuilder
.mpropdef2npropdef
.has_key
(mr
.mmethoddef
) then
242 # It is an init for a class?
243 if mr
.mmethoddef
.mproperty
.name
== "init" then
244 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[mr
.mmethoddef
.mclassdef
]
245 var super_inits
= nclassdef
.super_inits
246 if super_inits
!= null then
247 #assert args.length == 1
248 for su
in super_inits
do
249 self.add_monomorphic_send
(mr
.receiver
, su
)
258 var npropdef
= self.modelbuilder
.mpropdef2npropdef
[mr
.mmethoddef
]
259 if npropdef
isa AConcreteMethPropdef then
260 #npropdef.debug("Visit {mr.mmethoddef} for {mr.receiver}")
261 var nclassdef
= npropdef
.parent
.as(AClassdef)
262 var mmethoddef
= npropdef
.mpropdef
.as(not null)
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 self.add_monomorphic_send
(mr
.receiver
, auto_super_init
)
269 var v
= new RapidTypeVisitor(self, nclassdef
, mmethoddef
, mr
.receiver
)
270 v
.enter_visit
(npropdef
.n_block
)
271 else if npropdef
isa ADeferredMethPropdef then
272 # nothing to do (maybe add a waring?)
273 else if npropdef
isa AAttrPropdef then
275 else if npropdef
isa AInternMethPropdef or npropdef
isa AExternMethPropdef then
276 # UGLY: We force the "instantation" of the concrete return type if any
277 var ret
= mr
.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
279 ret
= ret
.anchor_to
(self.mainmodule
, mr
.receiver
)
282 else if npropdef
isa AExternInitPropdef then
283 self.add_type
(mr
.receiver
)
285 npropdef
.debug
("Not yet implemented")
292 # A method definitions customized to a specific receiver
293 class CustomizedMethodDef
294 var mmethoddef
: MMethodDef
295 var receiver
: MClassType
299 return "{self.mmethoddef}({receiver})"
304 return o
isa CustomizedMethodDef and o
.mmethoddef
== self.mmethoddef
and o
.receiver
== self.receiver
309 return self.mmethoddef
.hash
+ self.receiver
.hash
313 # A method invokation site bounded by a specific receiver
316 var receiver
: MClassType
320 return o
isa RTASendSite and o
.mmethod
== self.mmethod
and o
.receiver
== self.receiver
325 return self.mmethod
.hash
+ self.receiver
.hash
329 private class RapidTypeVisitor
332 var analysis
: RapidTypeAnalysis
334 var nclassdef
: AClassdef
336 var mpropdef
: MPropDef
338 var receiver
: MClassType
340 init(analysis
: RapidTypeAnalysis, nclassdef
: AClassdef, mpropdef
: MPropDef, receiver
: MClassType)
342 self.analysis
= analysis
343 self.nclassdef
= nclassdef
344 self.mpropdef
= mpropdef
345 self.receiver
= receiver
348 # Adapt and remove nullable
349 # return null if we got the null type
350 fun cleanup_type
(mtype
: MType): nullable MClassType
352 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
353 if mtype
isa MNullType then return null
354 if mtype
isa MNullableType then mtype
= mtype
.mtype
355 assert mtype
isa MClassType
356 assert not mtype
.need_anchor
360 fun add_type
(mtype
: MType)
362 var rapidtype
= cleanup_type
(mtype
)
363 if rapidtype
== null then return # we do not care about null
365 self.analysis
.add_type
(rapidtype
)
366 #self.current_node.debug("add_type {rapidtype}")
369 fun add_send
(mtype
: MType, mproperty
: MMethod)
371 var rapidtype
= cleanup_type
(mtype
)
372 if rapidtype
== null then return # we do not care about null
374 analysis
.add_send
(rapidtype
, mproperty
)
375 #self.current_node.debug("add_send {mproperty}")
378 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
380 var rapidtype
= cleanup_type
(mtype
)
381 if rapidtype
== null then return # we do not care about null
383 self.analysis
.add_monomorphic_send
(rapidtype
, mproperty
)
384 #self.current_node.debug("add_monomorphic_send {rapidtype} {mproperty}")
387 fun add_cast_type
(mtype
: MType)
389 var rapidtype
= cleanup_type
(mtype
)
390 if rapidtype
== null then return # we do not care about null
392 self.analysis
.add_cast_type
(rapidtype
)
393 #self.current_node.debug("add_cast_type {rapidtype}")
396 redef fun visit
(node
)
398 if node
== null then return
399 node
.accept_rapid_type_vistor
(self)
400 if node
isa AExpr then
401 var implicit_cast_to
= node
.implicit_cast_to
402 if implicit_cast_to
!= null then self.add_cast_type
(implicit_cast_to
)
407 # Force to get the primitive class named `name' or abort
408 fun get_class
(name
: String): MClass
410 return self.analysis
.mainmodule
.get_primitive_class
(name
)
413 # Force to get the primitive property named `name' in the instance `recv' or abort
414 fun get_method
(recv
: MType, name
: String): MMethod
416 var rapidtype
= cleanup_type
(recv
)
417 if rapidtype
== null then abort
419 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, rapidtype
, self.analysis
.mainmodule
)
426 private fun accept_rapid_type_vistor
(v
: RapidTypeVisitor)
432 redef fun accept_rapid_type_vistor
(v
)
434 v
.add_type
(self.mtype
.as(not null))
438 redef class AFloatExpr
439 redef fun accept_rapid_type_vistor
(v
)
441 v
.add_type
(self.mtype
.as(not null))
445 redef class ACharExpr
446 redef fun accept_rapid_type_vistor
(v
)
448 v
.add_type
(self.mtype
.as(not null))
452 redef class AArrayExpr
453 redef fun accept_rapid_type_vistor
(v
)
455 var mtype
= self.mtype
.as(MClassType)
457 var native
= v
.get_class
("NativeArray").get_mtype
([mtype
.arguments
.first
])
459 var prop
= v
.get_method
(mtype
, "with_native")
460 v
.add_monomorphic_send
(mtype
, prop
)
464 redef class AStringFormExpr
465 redef fun accept_rapid_type_vistor
(v
)
467 var mtype
= self.mtype
.as(not null)
469 var native
= v
.get_class
("NativeString").mclass_type
471 var prop
= v
.get_method
(mtype
, "from_cstring")
472 v
.add_monomorphic_send
(mtype
, prop
)
476 redef class ASuperstringExpr
477 redef fun accept_rapid_type_vistor
(v
)
479 var arraytype
= v
.get_class
("Array").get_mtype
([v
.get_class
("Object").mclass_type
])
480 v
.add_type
(arraytype
)
481 v
.add_type
(v
.get_class
("NativeArray").get_mtype
([v
.get_class
("Object").mclass_type
]))
482 var prop
= v
.get_method
(arraytype
, "join")
483 v
.add_monomorphic_send
(arraytype
, prop
)
484 var prop2
= v
.get_method
(arraytype
, "with_native")
485 v
.add_monomorphic_send
(arraytype
, prop2
)
489 redef class ACrangeExpr
490 redef fun accept_rapid_type_vistor
(v
)
492 var mtype
= self.mtype
.as(not null)
494 var prop
= v
.get_method
(mtype
, "init")
495 v
.add_monomorphic_send
(mtype
, prop
)
499 redef class AOrangeExpr
500 redef fun accept_rapid_type_vistor
(v
)
502 var mtype
= self.mtype
.as(not null)
504 var prop
= v
.get_method
(mtype
, "without_last")
505 v
.add_monomorphic_send
(mtype
, prop
)
509 redef class ATrueExpr
510 redef fun accept_rapid_type_vistor
(v
)
512 v
.add_type
(self.mtype
.as(not null))
516 redef class AFalseExpr
517 redef fun accept_rapid_type_vistor
(v
)
519 v
.add_type
(self.mtype
.as(not null))
524 redef fun accept_rapid_type_vistor
(v
)
526 v
.add_cast_type
(self.cast_type
.as(not null))
530 redef class AAsCastExpr
531 redef fun accept_rapid_type_vistor
(v
)
533 v
.add_cast_type
(self.mtype
.as(not null))
539 redef class ASendExpr
540 redef fun accept_rapid_type_vistor
(v
)
542 var mproperty
= self.mproperty
.as(not null)
543 if n_expr
isa ASelfExpr then
544 v
.add_monomorphic_send
(v
.receiver
, mproperty
)
546 var recvtype
= self.n_expr
.mtype
.as(not null)
547 v
.add_send
(recvtype
, mproperty
)
552 redef class ASendReassignFormExpr
553 redef fun accept_rapid_type_vistor
(v
)
555 v
.add_send
(self.read_type
.as(not null), self.reassign_property
.mproperty
)
556 var mproperty
= self.mproperty
.as(not null)
557 var write_mproperty
= self.write_mproperty
.as(not null)
558 if n_expr
isa ASelfExpr then
559 v
.add_monomorphic_send
(v
.receiver
, mproperty
)
560 v
.add_monomorphic_send
(v
.receiver
, write_mproperty
)
562 var recvtype
= self.n_expr
.mtype
.as(not null)
563 v
.add_send
(recvtype
, mproperty
)
564 v
.add_send
(recvtype
, write_mproperty
)
569 redef class AVarReassignExpr
570 redef fun accept_rapid_type_vistor
(v
)
572 v
.add_send
(self.read_type
.as(not null), self.reassign_property
.mproperty
)
576 redef class AAttrReassignExpr
577 redef fun accept_rapid_type_vistor
(v
)
579 v
.add_send
(self.read_type
.as(not null), self.reassign_property
.mproperty
)
583 redef class ASuperExpr
584 redef fun accept_rapid_type_vistor
(v
)
586 var mproperty
= self.mproperty
587 if mproperty
!= null then
588 v
.add_monomorphic_send
(v
.receiver
, mproperty
)
592 #FIXME: we do not want an ugly static call!
593 var mpropdef
= v
.mpropdef
594 var mpropdefs
= mpropdef
.mproperty
.lookup_super_definitions
(mpropdef
.mclassdef
.mmodule
, mpropdef
.mclassdef
.bound_mtype
)
595 if mpropdefs
.length
!= 1 then
596 debug
("MPRODFEFS for super {mpropdef} for {v.receiver}: {mpropdefs.join(", ")}")
598 var msuperpropdef
= mpropdefs
.first
599 assert msuperpropdef
isa MMethodDef
600 v
.analysis
.add_static_call
(v
.receiver
, msuperpropdef
)
605 redef fun accept_rapid_type_vistor
(v
)
607 var recvtype
= self.n_expr
.mtype
.as(not null)
608 var colltype
= self.coltype
.as(not null)
609 var itmeth
= v
.get_method
(colltype
, "iterator")
610 v
.add_send
(recvtype
, itmeth
)
611 var iteratortype
= itmeth
.intro
.msignature
.return_mtype
.as(MClassType).mclass
.intro
.bound_mtype
612 var objtype
= v
.get_class
("Object").mclass_type
613 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "is_ok"))
614 if self.variables
.length
== 1 then
615 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "item"))
616 else if self.variables
.length
== 2 then
617 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "key"))
618 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "item"))
622 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "next"))
627 redef fun accept_rapid_type_vistor
(v
)
629 var recvtype
= self.mtype
.as(not null)
631 v
.add_monomorphic_send
(recvtype
, mproperty
.as(not null))