1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2009 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.
17 # Tools to manipulate intermediace nit code representation
20 # A simple visitor to visit icode structures
22 # Called when a iregister is read in a icode
23 fun visit_iregister_read
(ic
: ICode, r
: IRegister) do end
25 # Called when a iregister is wrote in a icode
26 fun visit_iregister_write
(ic
: ICode, r
: IRegister) do end
28 # The current icode iterator.
29 # Can be used to insert_before, used to change the item or deleted
30 readable var _current_icode
: nullable ListIterator[ICode] = null
32 # Called when a icode is visited
33 # Automatically visits iregisters and sub-icodes
34 fun visit_icode
(ic
: nullable ICode)
36 if ic
== null then return
38 var old_icode
= _current_icode
39 var cur
= ic
.icodes
.iterator
46 _current_icode
= old_icode
47 else if ic
isa IIf then
48 visit_iregister_read
(ic
, ic
.expr
)
49 visit_icode
(ic
.then_seq
)
50 visit_icode
(ic
.else_seq
)
51 else if ic
isa IOnce then
53 else if ic
isa ICode1 then
54 visit_iregister_read
(ic
, ic
.expr
)
55 else if ic
isa ICode2 then
56 visit_iregister_read
(ic
, ic
.expr1
)
57 visit_iregister_read
(ic
, ic
.expr2
)
58 else if ic
isa ICodeN then
60 visit_iregister_read
(ic
, e
)
62 var closdefs
= ic
.closure_defs
63 if ic
isa IClosCall then
64 visit_icode
(ic
.break_seq
)
66 if closdefs
!= null then
67 visit_closure_defs
(closdefs
)
71 if r
!= null then visit_iregister_write
(ic
, r
)
74 # Called when closure definitions are visited
75 # Automatically visits each closure definition
76 fun visit_closure_defs
(closdefs
: Collection[nullable IClosureDef])
85 # Called when an iroutine is visited
86 # Automatically visits the body
87 # Warning: parameters of result registers are not visited
88 fun visit_iroutine
(ir
: IRoutine)
94 redef class ICodeBuilder
95 # IRoutine currently inlining
96 # Used to avoid recursive inlining
97 var _current_inlining
: Array[IRoutine] = new Array[IRoutine]
99 # Return false if routine can be saflely inlined
100 fun is_currently_inlining_routine
(routine
: IRoutine): Bool
102 return routine
== iroutine
or _current_inlining
.has
(routine
)
105 # Inline an iroutine in the current icode sequence
106 # Require not is_currently_inlining
107 fun inline_routine
(routine
: IRoutine, args
: Sequence[IRegister], closdefs
: nullable Sequence[nullable IClosureDef]): nullable IRegister
109 assert not is_currently_inlining_routine
(routine
)
110 _current_inlining
.add
(routine
)
111 var d
= new ICodeDupContext(self)
112 assert args
.length
== routine
.params
.length
113 var closdecls
= routine
.closure_decls
114 var cdefsa
= if closdefs
!= null then closdefs
.length
else 0
115 var cdeclsa
= if closdecls
!= null then closdecls
.length
else 0
116 assert cdefsa
<= cdeclsa
118 # Fill register duplicate association
119 var dico
= d
._registers
120 var res
= routine
.result
122 var res2
= new_register
(res
.stype
)
126 for reg
in routine
.registers
do
127 assert not dico
.has_key
(reg
)
128 dico
[reg
] = new_register
(reg
.stype
)
130 for i
in [0..args
.length
[ do
131 # FIXME The following assumes that params are readonly.
132 # The alternative is safe but add one move :/
133 dico
[routine
.params
[i
]] = args
[i
]
134 #seq.icodes.add(new IMove(dico[routine.params[i]]), args[i]))
137 # Fill closure association
138 if closdecls
!= null then
139 var cdico
= d
._closures
140 for i
in [0..cdefsa
[ do
141 cdico
[closdecls
[i
]] = closdefs
[i
]
143 for i
in [cdefsa
..cdeclsa
[ do
144 cdico
[closdecls
[i
]] = null
149 routine
.body
.dup_with
(d
)
150 _current_inlining
.pop
155 # This class stores reference to allow correct duplication of icodes
156 private class ICodeDupContext
157 # Return the correct register
158 # * a duplicate of the local register 'r' of the inlined iroutine
159 # * 'r' else (it is a register of the caller iroutine)
160 fun dup_ireg
(r
: IRegister): IRegister
163 if rs
.has_key
(r
) then
170 # Return a correct bunch of registers
171 fun dup_iregs
(regs
: Sequence[IRegister]): Sequence[IRegister]
173 var a
= new Array[IRegister].with_capacity
(regs
.length
)
180 # The associoation between old_seq and new_seq
181 # Directly used by the IEscape
182 var _seqs
: Map[ISeq, ISeq] = new HashMap[ISeq, ISeq]
184 # The assocation between old_ireg and new_ireg
186 var _registers
: Map[IRegister, IRegister] = new HashMap[IRegister, IRegister]
188 # The association between a closure_decl and its closure_def (if any)
189 var _closures
: Map[IClosureDecl, nullable IClosureDef] = new ArrayMap[IClosureDecl, nullable IClosureDef]
191 # The current code builder
192 var _icb
: ICodeBuilder
194 init(icb
: ICodeBuilder)
201 # Duplicate the current icode in the icode builder of the ICodeDupContext
202 private fun dup_with
(d
: ICodeDupContext)
204 var c
= inner_dup_with
(d
)
205 if self isa ICodeN then
207 c
.closure_defs
= closure_defs
210 if r
!= null then c
.result
= d
.dup_ireg
(r
)
211 c
.location
= location
212 d
._icb
.seq
.icodes
.add
(c
)
215 # Simle partial duplication of the current icode
216 private fun inner_dup_with
(d
: ICodeDupContext): ICode is abstract
220 redef fun inner_dup_with
(d
)
227 # Duplicate each icode and store them in dest
228 # Note: dest must be empty and not modified afted duplication or IEscapes may be wrongly duplicated
229 private fun dup_seq_to
(d
: ICodeDupContext, dest
: ISeq)
231 var old_seq
= d
._icb
.seq
242 redef fun inner_dup_with
(d
)
251 redef fun inner_dup_with
(d
)
253 var c2
= new IIf(d
.dup_ireg
(expr
))
254 then_seq
.dup_seq_to
(d
, c2
.then_seq
)
255 else_seq
.dup_seq_to
(d
, c2
.else_seq
)
261 redef fun inner_dup_with
(d
)
263 if d
._seqs
.has_key
(seq
) then
264 # Jump to a duplicated sequence
265 return new IEscape(d
._seqs
[seq
])
267 # Jump to an englobing unduplicated sequence
268 return new IEscape(seq
)
274 redef fun inner_dup_with
(d
)
276 return new IAbort(texts
, module_location
)
281 redef fun inner_dup_with
(d
)
283 return new ICall(property
, d
.dup_iregs
(exprs
))
288 redef fun inner_dup_with
(d
)
290 return new ISuper(property
, d
.dup_iregs
(exprs
))
295 redef fun inner_dup_with
(d
)
297 return new INew(stype
, property
, d
.dup_iregs
(exprs
))
301 redef class IAllocateInstance
302 redef fun inner_dup_with
(d
)
304 return new IAllocateInstance(stype
)
308 redef class IStaticCall
309 redef fun inner_dup_with
(d
)
311 return new IStaticCall(property
, d
.dup_iregs
(exprs
))
315 redef class ICheckInstance
316 redef fun inner_dup_with
(d
)
318 return new ICheckInstance(stype
, d
.dup_ireg
(expr
))
322 redef class IInitAttributes
323 redef fun inner_dup_with
(d
)
325 return new IInitAttributes(stype
, d
.dup_ireg
(expr
))
329 redef class IClosCall
330 redef fun dup_with
(d
)
332 var closdef
= d
._closures
[closure_decl
]
333 if closdef
== null then
334 # Default is already guarded and inlined
337 # Break sequence cannot be inlined :/
338 assert break_seq
== null
339 var res
= d
._icb
.inline_routine
(closdef
, d
.dup_iregs
(exprs
), null)
340 if result
!= null then
342 d
._icb
.stmt
(new IMove(d
.dup_ireg
(result
.as(not null)), res
))
348 redef fun inner_dup_with
(d
)
350 var c2
= new INative(code
, d
.dup_iregs
(exprs
))
357 redef fun inner_dup_with
(d
)
359 return new IMove(d
.dup_ireg
(result
.as(not null)), d
.dup_ireg
(expr
))
363 redef class IAttrRead
364 redef fun inner_dup_with
(d
)
366 return new IAttrRead(property
, d
.dup_ireg
(expr
))
370 redef class IAttrWrite
371 redef fun inner_dup_with
(d
)
373 return new IAttrWrite(property
, d
.dup_ireg
(expr1
), d
.dup_ireg
(expr2
))
377 redef class IAttrIsset
378 redef fun inner_dup_with
(d
)
380 return new IAttrIsset(property
, d
.dup_ireg
(expr
))
384 redef class ITypeCheck
385 redef fun inner_dup_with
(d
)
387 return new ITypeCheck(d
.dup_ireg
(expr
), stype
)
392 redef fun inner_dup_with
(d
)
394 return new IIs(d
.dup_ireg
(expr1
), d
.dup_ireg
(expr2
))
399 redef fun inner_dup_with
(d
)
401 return new INot(d
.dup_ireg
(expr
))
406 redef fun inner_dup_with
(d
)
409 body
.dup_seq_to
(d
, c2
.body
)
415 redef fun inner_dup_with
(d
)
417 var closdef
= d
._closures
[closure_decl
]
419 if closdef
!= null then
420 res
= d
._icb
.lit_true_reg
422 res
= d
._icb
.lit_false_reg
424 return new IMove(d
.dup_ireg
(result
.as(not null)), res
)