IRScope (JRuby Core 9.0.0.0.pre1 API)

java.lang.Object
- org.jruby.ir.IRScope

All Implemented Interfaces:

ParseResult

Direct Known Subclasses:

IRClosure, IRMethod, IRModuleBody, IRScriptBody
```
public abstract class IRScope
extends Object
implements ParseResult
```
Right now, this class abstracts the following execution scopes: Method, Closure, Module, Class, MetaClass Top-level Script, and Eval Script In the compiler-land, IR versions of these scopes encapsulate only as much information as is required to convert Ruby code into equivalent Java code. But, in the non-compiler land, there will be a corresponding java object for some of these scopes which encapsulates the runtime semantics and data needed for implementing them. In the case of Module, Class, MetaClass, and Method, they also happen to be instances of the corresponding Ruby classes -- so, in addition to providing code that help with this specific ruby implementation, they also have code that let them behave as ruby instances of their corresponding classes. Examples: - the runtime class object might have refs. to the runtime method objects. - the runtime method object might have a slot for a heap frame (for when it has closures that need access to the method's local variables), it might have version information, it might have references to other methods that were optimized with the current version number, etc. - the runtime closure object will have a slot for a heap frame (for when it has closures within) and might get reified as a method in the java land (but inaccessible in ruby land). So, passing closures in Java land might be equivalent to passing around the method handles. and so on ...

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`booleanVariableIndex`
`protected int`	`fixnumVariableIndex`
`protected int`	`floatVariableIndex`
`protected InterpreterContext`	`interpreterContext` What the interpreter depends on to interpret this IRScope
`protected int`	`temporaryVariableIndex`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`IRScope(IRManager manager, IRScope lexicalParent, String name, String fileName, int lineNumber, StaticScope staticScope)`
`protected`	`IRScope(IRScope s, IRScope lexicalParent)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addChildScope(IRScope scope)`
`void`	`addClosure(IRClosure closure)`
`void`	`addInstr(Instr instr)`
`void`	`addInstrAtBeginning(Instr instr)`
`InterpreterContext`	`allocateInterpreterContext(Instr[] instructionList)` Make version specific to scope which needs it (e.g.
`protected int`	`allocateNextPrefixedName(String prefix)`
`boolean`	`bindingHasEscaped()`
`CFG`	`buildCFG()`
`Map<BasicBlock,Label>`	`buildJVMExceptionTable()`
`BasicBlock[]`	`buildLinearization()`
`boolean`	`canReceiveNonlocalReturns()`
`CFG`	`cfg()`
`void`	`computeScopeFlags()`
`TemporaryLocalVariable`	`createTemporaryVariable()`
`boolean`	`definesLocalVariable(Variable v)`
`protected void`	`depends(Object obj)`
`boolean`	`equals(Object other)`
`protected LocalVariable`	`findExistingLocalVariable(String name, int depth)`
`List<IRClosure>`	`getBeginBlocks()`
`int`	`getBooleanVariablesCount()`
`CFG`	`getCFG()`
`List<IRClosure>`	`getClosures()`
`Variable`	`getCurrentModuleVariable()`
`Variable`	`getCurrentScopeVariable()`
`DataFlowProblem`	`getDataFlowSolution(String name)`
`List<IRClosure>`	`getEndBlocks()`
`List<CompilerPass>`	`getExecutedPasses()`
`String`	`getFileName()`
`int`	`getFixnumVariablesCount()`
`EnumSet<IRFlags>`	`getFlags()`
`int`	`getFloatVariablesCount()`
`List<Instr>`	`getInstrs()`
`InterpreterContext`	`getInterpreterContext()`
`IRScope`	`getLexicalParent()` Returns the lexical scope that contains this scope definition
`List<IRScope>`	`getLexicalScopes()`
`int`	`getLineNumber()`
`LocalVariable`	`getLocalVariable(String name, int scopeDepth)` Find or create a local variable.
`Map<String,LocalVariable>`	`getLocalVariables()` Get the local variables for this scope.
`int`	`getLocalVariablesCount()`
`IRManager`	`getManager()`
`String`	`getName()`
`IRScope`	`getNearestFlipVariableScope()`
`IRMethod`	`getNearestMethod()`
`int`	`getNearestModuleReferencingScopeDepth()` Returns the nearest scope which we can extract a live module from.
`IRScope`	`getNearestTopLocalVariableScope()`
`LocalVariable`	`getNewFlipStateVariable()`
`Variable`	`getNewInlineVariable(String inlinePrefix, Variable v)`
`Label`	`getNewLabel()`
`Label`	`getNewLabel(String prefix)`
`LocalVariable`	`getNewLocalVariable(String name, int scopeDepth)`
`TemporaryLocalVariable`	`getNewTemporaryVariable(TemporaryVariableType type)`
`TemporaryLocalVariable`	`getNewTemporaryVariableFor(LocalVariable var)`
`TemporaryLocalVariable`	`getNewUnboxedVariable(Class type)`
`int`	`getNextClosureId()`
`protected int`	`getPrefixCountSize(String prefix)`
`int`	`getScopeId()`
`abstract IRScopeType`	`getScopeType()`
`LocalVariable`	`getSelf()`
`StaticScope`	`getStaticScope()`
`int`	`getTemporaryVariablesCount()`
`int`	`getThreadPollInstrsCount()`
`IRScope`	`getTopLevelScope()` Returns the top level scope
`int`	`getUsedVariablesCount()`
`Map<String,Integer>`	`getVarIndices()`
`TemporaryVariable`	`getYieldClosureVariable()` Get the variable for accessing the "yieldable" closure in this scope.
`boolean`	`hasExplicitCallProtocol()`
`int`	`hashCode()`
`boolean`	`hasLoops()`
`protected void`	`initEvalScopeVariableAllocator(boolean reset)`
`void`	`initFlipStateVariable(Variable v, Operand initState)`
`void`	`initNestedClosures()`
`protected void`	`initScope(boolean jitMode)`
`void`	`inlineMethod(IRScope method, RubyModule implClass, int classToken, BasicBlock basicBlock, CallBase call, boolean cloneHost)`
`boolean`	`isBeginEndBlock()`
`boolean`	`isFlipScope()`
`boolean`	`isModuleBody()` Does this scope represent a module body?
`boolean`	`isNestedInClosure(IRClosure closure)`
`boolean`	`isNonSingletonClassBody()` Is this IRClassBody but not IRMetaClassBody?
`boolean`	`isScriptScope()` Is this an eval script or a regular file script?
`boolean`	`isTopLocalVariableScope()`
`BasicBlock[]`	`linearization()`
`LocalVariable`	`lookupExistingLVar(String name)`
`List<BasicBlock>`	`prepareForCompilation()` Run any necessary passes to get the IR ready for compilation
`InterpreterContext`	`prepareForInterpretation()` Run any necessary passes to get the IR ready for interpretation
`protected Instr[]`	`prepareInstructions()`
`boolean`	`receivesKeywordArgs()`
`void`	`recordBeginBlock(IRClosure beginBlockClosure)` Record a begin block.
`void`	`removeClosure(IRClosure closure)`
`void`	`resetLinearizationData()`
`void`	`resetState()`
`void`	`resetTemporaryVariables()`
`protected void`	`resetVariableCounter(String prefix)`
`void`	`savePersistenceInfo(int offset, IRReaderDecoder file)`
`protected void`	`setCFG(CFG cfg)`
`void`	`setDataFlowSolution(String name, DataFlowProblem p)`
`void`	`setExplicitCallProtocolFlag()`
`void`	`setHasLoopsFlag()`
`void`	`setLabelIndices(Map<String,Integer> indices)`
`void`	`setLocalVariables(Map<String,LocalVariable> variables)` Set the local variables for this scope.
`void`	`setName(String name)`
`void`	`setPrefixedNameIndexTo(String prefix, int newIndex)`
`void`	`setTemporaryVariableCount(int count)`
`void`	`setUpUseDefLocalVarMaps()`
`String`	`toString()`
`String`	`toStringInstrs()`
`boolean`	`usesBackrefOrLastline()`
`boolean`	`usesEval()`
`boolean`	`usesLocalVariable(Variable v)`
`boolean`	`usesZSuper()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

interpreterContext
```
protected InterpreterContext interpreterContext
```
What the interpreter depends on to interpret this IRScope

temporaryVariableIndex
```
protected int temporaryVariableIndex
```

floatVariableIndex
```
protected int floatVariableIndex
```

fixnumVariableIndex
```
protected int fixnumVariableIndex
```

booleanVariableIndex
```
protected int booleanVariableIndex
```

Constructor Detail

IRScope

protected IRScope(IRScope s,
       IRScope lexicalParent)

IRScope

public IRScope(IRManager manager,
       IRScope lexicalParent,
       String name,
       String fileName,
       int lineNumber,
       StaticScope staticScope)

Method Detail

getScopeId
```
public int getScopeId()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object other)
```
Overrides:

equals in class Object

addChildScope

protected void addChildScope(IRScope scope)

getLexicalScopes

public List<IRScope> getLexicalScopes()

initNestedClosures
```
public void initNestedClosures()
```

addClosure

public void addClosure(IRClosure closure)

removeClosure

public void removeClosure(IRClosure closure)

addInstrAtBeginning

public void addInstrAtBeginning(Instr instr)

addInstr
```
public void addInstr(Instr instr)
```

getNewFlipStateVariable

public LocalVariable getNewFlipStateVariable()

initFlipStateVariable

public void initFlipStateVariable(Variable v,
                         Operand initState)

getNewLabel

public Label getNewLabel(String prefix)

getNewLabel
```
public Label getNewLabel()
```

getClosures
```
public List<IRClosure> getClosures()
```

getManager
```
public IRManager getManager()
```

getLexicalParent
```
public IRScope getLexicalParent()
```
Returns the lexical scope that contains this scope definition

getStaticScope
```
public StaticScope getStaticScope()
```

getNearestMethod
```
public IRMethod getNearestMethod()
```

getNearestFlipVariableScope

public IRScope getNearestFlipVariableScope()

getNearestTopLocalVariableScope

public IRScope getNearestTopLocalVariableScope()

getNearestModuleReferencingScopeDepth
```
public int getNearestModuleReferencingScopeDepth()
```
Returns the nearest scope which we can extract a live module from. If this returns null (like for evals), then it means it cannot be statically determined.

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getFileName
```
public String getFileName()
```

getLineNumber
```
public int getLineNumber()
```

getTopLevelScope
```
public IRScope getTopLevelScope()
```
Returns the top level scope

isNestedInClosure

public boolean isNestedInClosure(IRClosure closure)

setHasLoopsFlag
```
public void setHasLoopsFlag()
```

hasLoops
```
public boolean hasLoops()
```

hasExplicitCallProtocol

public boolean hasExplicitCallProtocol()

setExplicitCallProtocolFlag

public void setExplicitCallProtocolFlag()

receivesKeywordArgs
```
public boolean receivesKeywordArgs()
```

bindingHasEscaped
```
public boolean bindingHasEscaped()
```

usesBackrefOrLastline

public boolean usesBackrefOrLastline()

usesEval
```
public boolean usesEval()
```

usesZSuper
```
public boolean usesZSuper()
```

canReceiveNonlocalReturns

public boolean canReceiveNonlocalReturns()

buildCFG
```
public CFG buildCFG()
```

setCFG
```
protected void setCFG(CFG cfg)
```

getCFG
```
public CFG getCFG()
```

prepareInstructions

protected Instr[] prepareInstructions()

getExecutedPasses

public List<CompilerPass> getExecutedPasses()

initScope

protected void initScope(boolean jitMode)

allocateInterpreterContext
```
public InterpreterContext allocateInterpreterContext(Instr[] instructionList)
```
Make version specific to scope which needs it (e.g. Closure vs non-closure).

prepareForInterpretation
```
public InterpreterContext prepareForInterpretation()
```
Run any necessary passes to get the IR ready for interpretation

prepareForCompilation
```
public List<BasicBlock> prepareForCompilation()
```
Run any necessary passes to get the IR ready for compilation

buildJVMExceptionTable

public Map<BasicBlock,Label> buildJVMExceptionTable()

getFlags
```
public EnumSet<IRFlags> getFlags()
```

computeScopeFlags
```
public void computeScopeFlags()
```

getScopeType

public abstract IRScopeType getScopeType()

toString
```
public String toString()
```
Overrides:

toString in class Object

toStringInstrs
```
public String toStringInstrs()
```

getSelf
```
public LocalVariable getSelf()
```

getCurrentModuleVariable

public Variable getCurrentModuleVariable()

getCurrentScopeVariable

public Variable getCurrentScopeVariable()

getLocalVariables
```
public Map<String,LocalVariable> getLocalVariables()
```
Get the local variables for this scope. This should only be used by persistence layer.

setLocalVariables
```
public void setLocalVariables(Map<String,LocalVariable> variables)
```
Set the local variables for this scope. This should only be used by persistence layer.

setLabelIndices

public void setLabelIndices(Map<String,Integer> indices)

lookupExistingLVar

public LocalVariable lookupExistingLVar(String name)

findExistingLocalVariable

protected LocalVariable findExistingLocalVariable(String name,
                                      int depth)

getLocalVariable
```
public LocalVariable getLocalVariable(String name,
                             int scopeDepth)
```
Find or create a local variable. By default, scopes are assumed to only check current depth. Blocks/Closures override this because they have special nesting rules.

getNewLocalVariable

public LocalVariable getNewLocalVariable(String name,
                                int scopeDepth)

initEvalScopeVariableAllocator

protected void initEvalScopeVariableAllocator(boolean reset)

createTemporaryVariable

public TemporaryLocalVariable createTemporaryVariable()

getNewTemporaryVariableFor

public TemporaryLocalVariable getNewTemporaryVariableFor(LocalVariable var)

getNewTemporaryVariable

public TemporaryLocalVariable getNewTemporaryVariable(TemporaryVariableType type)

setTemporaryVariableCount

public void setTemporaryVariableCount(int count)

getYieldClosureVariable
```
public TemporaryVariable getYieldClosureVariable()
```
Get the variable for accessing the "yieldable" closure in this scope.

getNewUnboxedVariable

public TemporaryLocalVariable getNewUnboxedVariable(Class type)

resetTemporaryVariables
```
public void resetTemporaryVariables()
```

getTemporaryVariablesCount

public int getTemporaryVariablesCount()

getFloatVariablesCount
```
public int getFloatVariablesCount()
```

getFixnumVariablesCount
```
public int getFixnumVariablesCount()
```

getBooleanVariablesCount
```
public int getBooleanVariablesCount()
```

getNewInlineVariable

public Variable getNewInlineVariable(String inlinePrefix,
                            Variable v)

getThreadPollInstrsCount
```
public int getThreadPollInstrsCount()
```

getLocalVariablesCount
```
public int getLocalVariablesCount()
```

getUsedVariablesCount
```
public int getUsedVariablesCount()
```

setUpUseDefLocalVarMaps
```
public void setUpUseDefLocalVarMaps()
```

usesLocalVariable

public boolean usesLocalVariable(Variable v)

definesLocalVariable

public boolean definesLocalVariable(Variable v)

setDataFlowSolution

public void setDataFlowSolution(String name,
                       DataFlowProblem p)

getDataFlowSolution

public DataFlowProblem getDataFlowSolution(String name)

getInstrs
```
public List<Instr> getInstrs()
```

getInterpreterContext

public InterpreterContext getInterpreterContext()

resetLinearizationData
```
public void resetLinearizationData()
```

buildLinearization

public BasicBlock[] buildLinearization()

linearization
```
public BasicBlock[] linearization()
```

depends
```
protected void depends(Object obj)
```

cfg
```
public CFG cfg()
```

resetState
```
public void resetState()
```

inlineMethod

public void inlineMethod(IRScope method,
                RubyModule implClass,
                int classToken,
                BasicBlock basicBlock,
                CallBase call,
                boolean cloneHost)

recordBeginBlock
```
public void recordBeginBlock(IRClosure beginBlockClosure)
```
Record a begin block. Only eval and script body scopes support this

getBeginBlocks

public List<IRClosure> getBeginBlocks()

getEndBlocks
```
public List<IRClosure> getEndBlocks()
```

allocateNextPrefixedName

protected int allocateNextPrefixedName(String prefix)

setPrefixedNameIndexTo

public void setPrefixedNameIndexTo(String prefix,
                          int newIndex)

resetVariableCounter

protected void resetVariableCounter(String prefix)

getVarIndices

public Map<String,Integer> getVarIndices()

getPrefixCountSize

protected int getPrefixCountSize(String prefix)

getNextClosureId
```
public int getNextClosureId()
```

isBeginEndBlock
```
public boolean isBeginEndBlock()
```

isModuleBody
```
public boolean isModuleBody()
```
Does this scope represent a module body?

isNonSingletonClassBody
```
public boolean isNonSingletonClassBody()
```
Is this IRClassBody but not IRMetaClassBody?

isFlipScope
```
public boolean isFlipScope()
```

isTopLocalVariableScope

public boolean isTopLocalVariableScope()

isScriptScope
```
public boolean isScriptScope()
```
Is this an eval script or a regular file script?

savePersistenceInfo

public void savePersistenceInfo(int offset,
                       IRReaderDecoder file)

Class IRScope

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

interpreterContext

temporaryVariableIndex

floatVariableIndex

fixnumVariableIndex

booleanVariableIndex

Constructor Detail

IRScope

IRScope

Method Detail

getScopeId

hashCode

equals

addChildScope

getLexicalScopes

initNestedClosures

addClosure

removeClosure

addInstrAtBeginning

addInstr

getNewFlipStateVariable

initFlipStateVariable

getNewLabel

getNewLabel

getClosures

getManager

getLexicalParent

getStaticScope

getNearestMethod

getNearestFlipVariableScope

getNearestTopLocalVariableScope

getNearestModuleReferencingScopeDepth

getName

setName

getFileName

getLineNumber

getTopLevelScope

isNestedInClosure

setHasLoopsFlag

hasLoops

hasExplicitCallProtocol

setExplicitCallProtocolFlag

receivesKeywordArgs

bindingHasEscaped

usesBackrefOrLastline

usesEval

usesZSuper

canReceiveNonlocalReturns

buildCFG

setCFG

getCFG

prepareInstructions

getExecutedPasses

initScope

allocateInterpreterContext

prepareForInterpretation

prepareForCompilation

buildJVMExceptionTable

getFlags

computeScopeFlags

getScopeType

toString

toStringInstrs

getSelf

getCurrentModuleVariable

getCurrentScopeVariable

getLocalVariables

setLocalVariables

setLabelIndices

lookupExistingLVar

findExistingLocalVariable

getLocalVariable

getNewLocalVariable

initEvalScopeVariableAllocator

createTemporaryVariable