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 escape mark association
138 for m
in routine
.escape_marks
do
139 var m2
= new IEscapeMark
140 iroutine
.escape_marks
.add
(m2
)
144 # Fill closure association
145 if closdecls
!= null then
146 var cdico
= d
._closures
147 for i
in [0..cdefsa
[ do
148 cdico
[closdecls
[i
]] = closdefs
[i
]
150 for i
in [cdefsa
..cdeclsa
[ do
151 cdico
[closdecls
[i
]] = null
156 routine
.body
.dup_with
(d
)
157 _current_inlining
.pop
162 # This class stores reference to allow correct duplication of icodes
163 private class ICodeDupContext
164 # Return the correct register
165 # * a duplicate of the local register 'r' of the inlined iroutine
166 # * 'r' else (it is a register of the caller iroutine)
167 fun dup_ireg
(r
: IRegister): IRegister
170 if rs
.has_key
(r
) then
177 # Return a correct bunch of registers
178 fun dup_iregs
(regs
: Sequence[IRegister]): Array[IRegister]
180 var a
= new Array[IRegister].with_capacity
(regs
.length
)
187 # The assocation between old_ireg and new_ireg
189 var _registers
: Map[IRegister, IRegister] = new HashMap[IRegister, IRegister]
191 # Return the correct escape mark
192 # * a duplicate of the local escape mark 'm' of the inlined iroutine
193 # * 'r' else (it is a escape mark of the caller iroutine)
194 fun dup_mark
(m
: IEscapeMark): IEscapeMark
197 if ms
.has_key
(m
) then
204 # The associoation between old_seq and new_seq
206 var _marks
: Map[IEscapeMark, IEscapeMark] = new HashMap[IEscapeMark, IEscapeMark]
208 # The association between a closure_decl and its closure_def (if any)
209 var _closures
: Map[IClosureDecl, nullable IClosureDef] = new ArrayMap[IClosureDecl, nullable IClosureDef]
211 # The current code builder
212 var _icb
: ICodeBuilder
214 init(icb
: ICodeBuilder)
221 # Duplicate the current icode in the icode builder of the ICodeDupContext
222 private fun dup_with
(d
: ICodeDupContext)
224 var c
= inner_dup_with
(d
)
225 if self isa ICodeN then
227 var cdecl
= closure_defs
228 if cdecl
!= null then
229 # Duplicate the colsure definitions
230 var cdecl2
= new Array[nullable IClosureDef].with_capacity
(cdecl
.length
)
236 if r
!= null then r
= d
.dup_ireg
(r
)
237 var cd2
= new IClosureDef(d
.dup_iregs
(cd
.params
), r
)
239 cd
.body
.dup_seq_to
(d
, cd2
.body
)
242 c
.closure_defs
= cdecl2
246 if r
!= null then c
.result
= d
.dup_ireg
(r
)
247 c
.location
= location
248 d
._icb
.seq
.icodes
.add
(c
)
251 # Simle partial duplication of the current icode
252 private fun inner_dup_with
(d
: ICodeDupContext): ICode is abstract
256 redef fun inner_dup_with
(d
)
263 # Duplicate each icode and store them in dest
264 # Note: dest must be empty and not modified afted duplication or IEscapes may be wrongly duplicated
265 private fun dup_seq_to
(d
: ICodeDupContext, dest
: ISeq)
267 var old_seq
= d
._icb
.seq
273 assert dest
.iescape_mark
== null
274 var mark
= iescape_mark
276 dest
.iescape_mark
= d
.dup_mark
(mark
)
282 redef fun inner_dup_with
(d
)
291 redef fun inner_dup_with
(d
)
293 var c2
= new IIf(d
.dup_ireg
(expr
))
294 then_seq
.dup_seq_to
(d
, c2
.then_seq
)
295 else_seq
.dup_seq_to
(d
, c2
.else_seq
)
301 redef fun inner_dup_with
(d
)
303 # Get the associated mark (duplicated of not)
304 var mark
= d
.dup_mark
(iescape_mark
)
306 return new IEscape(mark
)
311 redef fun inner_dup_with
(d
)
313 return new IAbort(texts
, module_location
)
318 redef fun inner_dup_with
(d
)
320 return new ICall(property
, d
.dup_iregs
(exprs
))
325 redef fun inner_dup_with
(d
)
327 return new ISuper(property
, d
.dup_iregs
(exprs
))
332 redef fun inner_dup_with
(d
)
334 return new INew(stype
, property
, d
.dup_iregs
(exprs
))
338 redef class IAllocateInstance
339 redef fun inner_dup_with
(d
)
341 return new IAllocateInstance(stype
)
345 redef class IStaticCall
346 redef fun inner_dup_with
(d
)
348 return new IStaticCall(property
, d
.dup_iregs
(exprs
))
352 redef class ICheckInstance
353 redef fun inner_dup_with
(d
)
355 return new ICheckInstance(stype
, d
.dup_ireg
(expr
))
359 redef class IInitAttributes
360 redef fun inner_dup_with
(d
)
362 return new IInitAttributes(stype
, d
.dup_ireg
(expr
))
366 redef class IClosCall
367 redef fun dup_with
(d
)
369 if d
._closures
.has_key
(closure_decl
) then
370 # The icloscall need to be replaced with an inlined closdef
371 var closdef
= d
._closures
[closure_decl
]
372 if closdef
== null then
373 # Default is already guarded and inlined
376 # Break sequence cannot be inlined :/
377 assert break_seq
== null
379 var res
= d
._icb
.inline_routine
(closdef
, d
.dup_iregs
(exprs
), null)
380 if result
!= null then
382 d
._icb
.stmt
(new IMove(d
.dup_ireg
(result
.as(not null)), res
))
385 # Standard icloscall duplication
390 redef fun inner_dup_with
(d
)
392 return new IClosCall(closure_decl
, exprs
)
397 redef fun inner_dup_with
(d
)
399 var c2
= new INative(code
, d
.dup_iregs
(exprs
))
406 redef fun inner_dup_with
(d
)
408 return new IMove(d
.dup_ireg
(result
.as(not null)), d
.dup_ireg
(expr
))
412 redef class IAttrRead
413 redef fun inner_dup_with
(d
)
415 return new IAttrRead(property
, d
.dup_ireg
(expr
))
419 redef class IAttrWrite
420 redef fun inner_dup_with
(d
)
422 return new IAttrWrite(property
, d
.dup_ireg
(expr1
), d
.dup_ireg
(expr2
))
426 redef class IAttrIsset
427 redef fun inner_dup_with
(d
)
429 return new IAttrIsset(property
, d
.dup_ireg
(expr
))
433 redef class ITypeCheck
434 redef fun inner_dup_with
(d
)
436 return new ITypeCheck(d
.dup_ireg
(expr
), stype
)
441 redef fun inner_dup_with
(d
)
443 return new IIs(d
.dup_ireg
(expr1
), d
.dup_ireg
(expr2
))
448 redef fun inner_dup_with
(d
)
450 return new INot(d
.dup_ireg
(expr
))
455 redef fun inner_dup_with
(d
)
458 body
.dup_seq_to
(d
, c2
.body
)
464 redef fun inner_dup_with
(d
)
466 if d
._closures
.has_key
(closure_decl
) then
467 # closdef will be inlined
468 var closdef
= d
._closures
[closure_decl
]
470 if closdef
!= null then
471 res
= d
._icb
.lit_true_reg
473 res
= d
._icb
.lit_false_reg
475 return new IMove(d
.dup_ireg
(result
.as(not null)), res
)
477 return new IHasClos(closure_decl
)