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 # Add a live type to the pool
107 # If the types is already live, then do nothing.
109 # REQUIRE: not mtype.need_anchor
110 fun add_type
(mtype
: MClassType)
112 if self.live_types
.has
(mtype
) then return
114 assert not mtype
.need_anchor
115 self.live_types
.add
(mtype
)
116 self.check_depth
(mtype
)
118 # Collect default attributes
119 for cd
in mtype
.collect_mclassdefs
(self.mainmodule
)
121 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[cd
]
122 for npropdef
in nclassdef
.n_propdefs
do
123 if not npropdef
isa AAttrPropdef then continue
124 var nexpr
= npropdef
.n_expr
125 if nexpr
== null then continue
126 var v
= new RapidTypeVisitor(self, nclassdef
, npropdef
.mpropdef
.as(not null), mtype
)
131 for rss
in self.live_send_sites
do
132 if not mtype
.is_subtype
(self.mainmodule
, null, rss
.receiver
) then continue
133 if mtype
.has_mproperty
(self.mainmodule
, rss
.mmethod
) then
134 self.add_monomorphic_send
(mtype
, rss
.mmethod
)
139 # Add a send site to the pool
141 # If the send site is already live, then do nothing.
142 fun add_send
(mtype
: MClassType, mmethod
: MMethod)
144 var rss
= new RTASendSite(mmethod
, mtype
)
145 if self.live_send_sites
.has
(rss
) then return
147 self.live_send_sites
.add
(rss
)
149 for mtype2
in self.live_types
do
150 if not mtype2
.is_subtype
(self.mainmodule
, null, mtype
) then continue
151 if mtype2
.has_mproperty
(self.mainmodule
, mmethod
) then
152 self.add_monomorphic_send
(mtype2
, mmethod
)
157 # Add a monomoprhic send.
158 # The send site is not added to the pool.
159 # The method just determine the associated method definition then
160 # performs a static_call
161 fun add_monomorphic_send
(mtype
: MClassType, mmethod
: MMethod)
163 assert self.live_types
.has
(mtype
)
164 var defs
= mmethod
.lookup_definitions
(self.mainmodule
, mtype
)
165 if defs
.is_empty
then return
166 assert defs
.length
== 1 else print
"conflict on {mtype} for {mmethod}: {defs.join(" ")}"
167 self.add_static_call
(mtype
, defs
.first
)
170 # Add a customized_methoddefs to the pool
171 # Is the customized_methoddefs is already live, then do nothing
172 fun add_static_call
(mtype
: MClassType, mmethoddef
: MMethodDef)
174 assert self.live_types
.has
(mtype
)
175 var rm
= new CustomizedMethodDef(mmethoddef
, mtype
)
176 if self.live_customized_methoddefs
.has
(rm
) then return
177 self.live_customized_methoddefs
.add
(rm
)
179 self.live_methoddefs
.add
(mmethoddef
)
182 # Add mtype to the cast pool.
183 fun add_cast_type
(mtype
: MClassType)
185 if self.live_cast_types
.has
(mtype
) then return
187 assert not mtype
.need_anchor
188 self.live_cast_types
.add
(mtype
)
189 self.check_depth
(mtype
)
192 fun check_depth
(mtype
: MClassType)
196 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}.")
200 # Run the analysis until all visitable method definitions are visited.
204 var classes
= self.modelbuilder
.model
.get_mclasses_by_name
("Bool")
205 if classes
!= null then for c
in classes
do self.add_type
(c
.mclass_type
)
207 while not todo
.is_empty
do
210 var vararg_rank
= mr
.mmethoddef
.msignature
.vararg_rank
211 if vararg_rank
> -1 then
212 var node
= self.modelbuilder
.mpropdef2npropdef
[mr
.mmethoddef
]
213 var elttype
= mr
.mmethoddef
.msignature
.mparameters
[vararg_rank
].mtype
214 elttype
= elttype
.anchor_to
(self.mainmodule
, mr
.receiver
)
215 var vararg
= self.mainmodule
.get_primitive_class
("Array").get_mtype
([elttype
])
216 self.add_type
(vararg
)
217 self.add_monomorphic_send
(vararg
, self.modelbuilder
.force_get_primitive_method
(node
, "with_native", vararg
, self.mainmodule
))
218 var native
= self.mainmodule
.get_primitive_class
("NativeArray").get_mtype
([elttype
])
219 self.add_type
(native
)
222 if not self.modelbuilder
.mpropdef2npropdef
.has_key
(mr
.mmethoddef
) then
223 # It is an init for a class?
224 if mr
.mmethoddef
.mproperty
.name
== "init" then
225 var nclassdef
= self.modelbuilder
.mclassdef2nclassdef
[mr
.mmethoddef
.mclassdef
]
226 var super_inits
= nclassdef
.super_inits
227 if super_inits
!= null then
228 #assert args.length == 1
229 for su
in super_inits
do
230 self.add_monomorphic_send
(mr
.receiver
, su
)
239 var npropdef
= self.modelbuilder
.mpropdef2npropdef
[mr
.mmethoddef
]
240 if npropdef
isa AConcreteMethPropdef then
241 #npropdef.debug("Visit {mr.mmethoddef} for {mr.receiver}")
242 var nclassdef
= npropdef
.parent
.as(AClassdef)
243 var mmethoddef
= npropdef
.mpropdef
.as(not null)
244 var auto_super_inits
= npropdef
.auto_super_inits
245 if auto_super_inits
!= null then
246 for auto_super_init
in auto_super_inits
do
247 self.add_monomorphic_send
(mr
.receiver
, auto_super_init
)
250 var v
= new RapidTypeVisitor(self, nclassdef
, mmethoddef
, mr
.receiver
)
251 v
.enter_visit
(npropdef
.n_block
)
252 else if npropdef
isa ADeferredMethPropdef then
253 # nothing to do (maybe add a waring?)
254 else if npropdef
isa AAttrPropdef then
256 else if npropdef
isa AInternMethPropdef or npropdef
isa AExternMethPropdef then
257 # UGLY: We force the "instantation" of the concrete return type if any
258 var ret
= mr
.mmethoddef
.msignature
.return_mtype
259 if ret
!= null and ret
isa MClassType and ret
.mclass
.kind
!= abstract_kind
and ret
.mclass
.kind
!= interface_kind
then
260 ret
= ret
.anchor_to
(self.mainmodule
, mr
.receiver
)
263 else if npropdef
isa AExternInitPropdef then
264 self.add_type
(mr
.receiver
)
266 npropdef
.debug
("Not yet implemented")
273 # A method definitions customized to a specific receiver
274 class CustomizedMethodDef
275 var mmethoddef
: MMethodDef
276 var receiver
: MClassType
280 return "{self.mmethoddef}({receiver})"
285 return o
isa CustomizedMethodDef and o
.mmethoddef
== self.mmethoddef
and o
.receiver
== self.receiver
290 return self.mmethoddef
.hash
+ self.receiver
.hash
294 # A method invokation site bounded by a specific receiver
297 var receiver
: MClassType
301 return o
isa RTASendSite and o
.mmethod
== self.mmethod
and o
.receiver
== self.receiver
306 return self.mmethod
.hash
+ self.receiver
.hash
310 private class RapidTypeVisitor
313 var analysis
: RapidTypeAnalysis
315 var nclassdef
: AClassdef
317 var mpropdef
: MPropDef
319 var receiver
: MClassType
321 init(analysis
: RapidTypeAnalysis, nclassdef
: AClassdef, mpropdef
: MPropDef, receiver
: MClassType)
323 self.analysis
= analysis
324 self.nclassdef
= nclassdef
325 self.mpropdef
= mpropdef
326 self.receiver
= receiver
329 # Adapt and remove nullable
330 # return null if we got the null type
331 fun cleanup_type
(mtype
: MType): nullable MClassType
333 mtype
= mtype
.anchor_to
(self.analysis
.mainmodule
, self.receiver
)
334 if mtype
isa MNullType then return null
335 if mtype
isa MNullableType then mtype
= mtype
.mtype
336 assert mtype
isa MClassType
337 assert not mtype
.need_anchor
341 fun add_type
(mtype
: MType)
343 var rapidtype
= cleanup_type
(mtype
)
344 if rapidtype
== null then return # we do not care about null
346 self.analysis
.add_type
(rapidtype
)
347 #self.current_node.debug("add_type {rapidtype}")
350 fun add_send
(mtype
: MType, mproperty
: MMethod)
352 var rapidtype
= cleanup_type
(mtype
)
353 if rapidtype
== null then return # we do not care about null
355 analysis
.add_send
(rapidtype
, mproperty
)
356 #self.current_node.debug("add_send {mproperty}")
359 fun add_monomorphic_send
(mtype
: MType, mproperty
: MMethod)
361 var rapidtype
= cleanup_type
(mtype
)
362 if rapidtype
== null then return # we do not care about null
364 self.analysis
.add_monomorphic_send
(rapidtype
, mproperty
)
365 #self.current_node.debug("add_monomorphic_send {rapidtype} {mproperty}")
368 fun add_cast_type
(mtype
: MType)
370 var rapidtype
= cleanup_type
(mtype
)
371 if rapidtype
== null then return # we do not care about null
373 self.analysis
.add_cast_type
(rapidtype
)
374 #self.current_node.debug("add_cast_type {rapidtype}")
377 redef fun visit
(node
)
379 if node
== null then return
380 node
.accept_rapid_type_vistor
(self)
384 # Force to get the primitive class named `name' or abort
385 fun get_class
(name
: String): MClass
387 return self.analysis
.mainmodule
.get_primitive_class
(name
)
390 # Force to get the primitive property named `name' in the instance `recv' or abort
391 fun get_method
(recv
: MType, name
: String): MMethod
393 var rapidtype
= cleanup_type
(recv
)
394 if rapidtype
== null then abort
396 return self.analysis
.modelbuilder
.force_get_primitive_method
(self.current_node
.as(not null), name
, rapidtype
, self.analysis
.mainmodule
)
403 private fun accept_rapid_type_vistor
(v
: RapidTypeVisitor)
409 redef fun accept_rapid_type_vistor
(v
)
411 v
.add_type
(self.mtype
.as(not null))
415 redef class AFloatExpr
416 redef fun accept_rapid_type_vistor
(v
)
418 v
.add_type
(self.mtype
.as(not null))
422 redef class ACharExpr
423 redef fun accept_rapid_type_vistor
(v
)
425 v
.add_type
(self.mtype
.as(not null))
429 redef class AArrayExpr
430 redef fun accept_rapid_type_vistor
(v
)
432 var mtype
= self.mtype
.as(MClassType)
434 var native
= v
.get_class
("NativeArray").get_mtype
([mtype
.arguments
.first
])
436 var prop
= v
.get_method
(mtype
, "with_native")
437 v
.add_monomorphic_send
(mtype
, prop
)
441 redef class AStringFormExpr
442 redef fun accept_rapid_type_vistor
(v
)
444 var mtype
= self.mtype
.as(not null)
446 var native
= v
.get_class
("NativeString").mclass_type
448 var prop
= v
.get_method
(mtype
, "from_cstring")
449 v
.add_monomorphic_send
(mtype
, prop
)
453 redef class ASuperstringExpr
454 redef fun accept_rapid_type_vistor
(v
)
456 var arraytype
= v
.get_class
("Array").get_mtype
([v
.get_class
("Object").mclass_type
])
457 v
.add_type
(arraytype
)
458 v
.add_type
(v
.get_class
("NativeArray").get_mtype
([v
.get_class
("Object").mclass_type
]))
459 var prop
= v
.get_method
(arraytype
, "join")
460 v
.add_monomorphic_send
(arraytype
, prop
)
464 redef class ACrangeExpr
465 redef fun accept_rapid_type_vistor
(v
)
467 var mtype
= self.mtype
.as(not null)
469 var prop
= v
.get_method
(mtype
, "init")
470 v
.add_monomorphic_send
(mtype
, prop
)
474 redef class AOrangeExpr
475 redef fun accept_rapid_type_vistor
(v
)
477 var mtype
= self.mtype
.as(not null)
479 var prop
= v
.get_method
(mtype
, "without_last")
480 v
.add_monomorphic_send
(mtype
, prop
)
484 redef class ATrueExpr
485 redef fun accept_rapid_type_vistor
(v
)
487 v
.add_type
(self.mtype
.as(not null))
491 redef class AFalseExpr
492 redef fun accept_rapid_type_vistor
(v
)
494 v
.add_type
(self.mtype
.as(not null))
499 redef fun accept_rapid_type_vistor
(v
)
501 v
.add_cast_type
(self.cast_type
.as(not null))
505 redef class AAsCastExpr
506 redef fun accept_rapid_type_vistor
(v
)
508 v
.add_cast_type
(self.mtype
.as(not null))
514 redef class ASendExpr
515 redef fun accept_rapid_type_vistor
(v
)
517 var mproperty
= self.mproperty
.as(not null)
518 if n_expr
isa ASelfExpr then
519 v
.add_monomorphic_send
(v
.receiver
, mproperty
)
521 var recvtype
= self.n_expr
.mtype
.as(not null)
522 v
.add_send
(recvtype
, mproperty
)
527 redef class ASendReassignFormExpr
528 redef fun accept_rapid_type_vistor
(v
)
530 v
.add_send
(self.read_type
.as(not null), self.reassign_property
.mproperty
)
531 var mproperty
= self.mproperty
.as(not null)
532 var write_mproperty
= self.write_mproperty
.as(not null)
533 if n_expr
isa ASelfExpr then
534 v
.add_monomorphic_send
(v
.receiver
, mproperty
)
535 v
.add_monomorphic_send
(v
.receiver
, write_mproperty
)
537 var recvtype
= self.n_expr
.mtype
.as(not null)
538 v
.add_send
(recvtype
, mproperty
)
539 v
.add_send
(recvtype
, write_mproperty
)
544 redef class AVarReassignExpr
545 redef fun accept_rapid_type_vistor
(v
)
547 v
.add_send
(self.read_type
.as(not null), self.reassign_property
.mproperty
)
551 redef class AAttrReassignExpr
552 redef fun accept_rapid_type_vistor
(v
)
554 v
.add_send
(self.read_type
.as(not null), self.reassign_property
.mproperty
)
558 redef class ASuperExpr
559 redef fun accept_rapid_type_vistor
(v
)
561 var mproperty
= self.mproperty
562 if mproperty
!= null then
563 v
.add_monomorphic_send
(v
.receiver
, mproperty
)
567 #FIXME: we do not want an ugly static call!
568 var mpropdef
= v
.mpropdef
569 var mpropdefs
= mpropdef
.mproperty
.lookup_super_definitions
(mpropdef
.mclassdef
.mmodule
, mpropdef
.mclassdef
.bound_mtype
)
570 if mpropdefs
.length
!= 1 then
571 debug
("MPRODFEFS for super {mpropdef} for {v.receiver}: {mpropdefs.join(", ")}")
573 var msuperpropdef
= mpropdefs
.first
574 assert msuperpropdef
isa MMethodDef
575 v
.analysis
.add_static_call
(v
.receiver
, msuperpropdef
)
580 redef fun accept_rapid_type_vistor
(v
)
582 var recvtype
= self.n_expr
.mtype
.as(not null)
583 var colltype
= self.coltype
.as(not null)
584 var itmeth
= v
.get_method
(colltype
, "iterator")
585 v
.add_send
(recvtype
, itmeth
)
586 var iteratortype
= itmeth
.intro
.msignature
.return_mtype
.as(MClassType).mclass
.intro
.bound_mtype
587 var objtype
= v
.get_class
("Object").mclass_type
588 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "is_ok"))
589 if self.variables
.length
== 1 then
590 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "item"))
591 else if self.variables
.length
== 2 then
592 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "key"))
593 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "item"))
597 v
.add_send
(objtype
, v
.get_method
(iteratortype
, "next"))
602 redef fun accept_rapid_type_vistor
(v
)
604 var recvtype
= self.mtype
.as(not null)
606 v
.add_monomorphic_send
(recvtype
, mproperty
.as(not null))