class Inliner[BT <: BTypes] extends AnyRef
- Alphabetic
- By Inheritance
- Inliner
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Inliner(btypes: BT)
Type Members
- case class InlineLog (request: InlineRequest, sizeBefore: Int, sizeAfter: Int, sizeInlined: Int, warning: Option[CannotInlineWarning]) extends Product with Serializable
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Inliner[BT], B)
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
-
def
adaptPostRequestForMainCallsite(post: InlineRequest, mainCallsite: Callsite): List[InlineRequest]
Given an InlineRequest(mainCallsite, post = List(postCallsite)), the postCallsite is a callsite in the method
mainCallsite.callee
.Given an InlineRequest(mainCallsite, post = List(postCallsite)), the postCallsite is a callsite in the method
mainCallsite.callee
. Once the mainCallsite is inlined into the target method (mainCallsite.callsiteMethod), we need to find the cloned callsite that corresponds to the postCallsite so we can inline that into the target method as well.However, it is possible that there is no cloned callsite at all that corresponds to the postCallsite, for example if the corresponding callsite already inlined. Example:
def a() = 1 def b() = a() + 2 def c() = b() + 3 def d() = c() + 4
We have the following callsite objects in the call graph:
c1 = a() in b c2 = b() in c c3 = c() in d
Assume we have the following inline request r = InlineRequest(c3, post = List(InlineRequest(c2, post = List(InlineRequest(c1, post = Nil)))))
But before inlining r, assume a separate InlineRequest(c2, post = Nil) is inlined first. We get
c1' = a() in c // added to the call graph c1.inlinedClones += (c1' at c2) // remember that c1' was created when inlining c2 ~c2~ // c2 is removed from the call graph
If we now inline r, we first inline c3. We get
c1 = a() in d // added to call graph c1'.inlinedClones += (c1 at c3) // remember that c1 was created when inlining c3 ~c3~
Now we continue with the post-requests for r, i.e. c2.
- we try to find the clone of c2 that was created when inlining c3 - but there is none. c2 was already inlined before
- we continue with the post-request of c2: c1
- we search for the callsite of c1 that was cloned when inlining c2, we find c1'
- recursively we search for the callsite of c1' that was cloned when inlining c3, we find c1
- so we create an inline request for c1
-
final
def
asInstanceOf[T0]: T0
Cast the receiver object to be of type
T0
.Cast the receiver object to be of type
T0
.Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression
1.asInstanceOf[String]
will throw aClassCastException
at runtime, while the expressionList(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
- val btypes: BT
-
def
canInlineBody(callsite: Callsite): Option[CannotInlineWarning]
Check whether the body of the callee contains any instructions that prevent the callsite from being inlined.
Check whether the body of the callee contains any instructions that prevent the callsite from being inlined. See also method
earlyCanInlineCheck
.The result of this check depends on changes to the callee method's body. For example, if the callee initially invokes a private method, it cannot be inlined into a different class. If the private method is inlined into the callee, inlining the callee becomes possible. Therefore we don't query it while traversing the call graph and selecting callsites to inline - it might rule out callsites that can be inlined just fine.
- returns
Some(message)
if inlining cannot be performed,None
otherwise
-
def
classIsAccessible(accessed: BT.BType, from: BT.ClassBType): Either[OptimizerWarning, Boolean]
Check if a type is accessible to some class, as defined in JVMS 5.4.4.
Check if a type is accessible to some class, as defined in JVMS 5.4.4. (A1) C is public (A2) C and D are members of the same run-time package
-
def
clone(): AnyRef
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the
clone
method is platform dependent.- returns
a copy of the receiver object.
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- Note
not specified by SLS as a member of AnyRef
-
def
earlyCanInlineCheck(callsite: Callsite): Option[CannotInlineWarning]
Check whether an inlining can be performed.
Check whether an inlining can be performed. This method performs tests that don't change even if the body of the callee is changed by the inliner / optimizer, so it can be used early (when looking at the call graph and collecting inline requests for the program).
The tests that inspect the callee's instructions are implemented in method
canInlineBody
, which is queried when performing an inline.- returns
Some(message)
if inlining cannot be performed,None
otherwise
- def ensuring(cond: (Inliner[BT]) ⇒ Boolean, msg: ⇒ Any): Inliner[BT]
- def ensuring(cond: (Inliner[BT]) ⇒ Boolean): Inliner[BT]
- def ensuring(cond: Boolean, msg: ⇒ Any): Inliner[BT]
- def ensuring(cond: Boolean): Inliner[BT]
-
final
def
eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the
finalize
method is invoked, as well as the interaction betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
-
def
findIllegalAccess(instructions: InsnList, calleeDeclarationClass: BT.ClassBType, destinationClass: BT.ClassBType): Option[(AbstractInsnNode, Option[OptimizerWarning])]
Returns the first instruction in the
instructions
list that would cause a java.lang.IllegalAccessError when inlined into thedestinationClass
.Returns the first instruction in the
instructions
list that would cause a java.lang.IllegalAccessError when inlined into thedestinationClass
.If validity of some instruction could not be checked because an error occurred, the instruction is returned together with a warning message that describes the problem.
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
The hashCode method for reference types.
-
def
inline(request: InlineRequest): List[CannotInlineWarning]
Inline the callsite of an inlining request and its post-inlining requests.
Inline the callsite of an inlining request and its post-inlining requests.
- returns
An inliner warning for each callsite that could not be inlined.
-
def
inlineCallsite(callsite: Callsite): Unit
Copy and adapt the instructions of a method to a callsite.
Copy and adapt the instructions of a method to a callsite.
Preconditions:
- The callsite can safely be inlined (canInlineBody is true)
- The maxLocals and maxStack values of the callsite method are correctly computed
- returns
A map associating instruction nodes of the callee with the corresponding cloned instruction in the callsite method.
- var inlineLog: List[InlineLog]
-
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.Test whether the dynamic type of the receiver object is
T0
.Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression
1.isInstanceOf[String]
will returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
def
memberIsAccessible(memberFlags: Int, memberDeclClass: BT.ClassBType, memberRefClass: BT.ClassBType, from: BT.ClassBType): Either[OptimizerWarning, Boolean]
Check if a member reference is accessible from the destinationClass, as defined in the JVMS 5.4.4.
Check if a member reference is accessible from the destinationClass, as defined in the JVMS 5.4.4. Note that the class name in a field / method reference is not necessarily the class in which the member is declared:
class A { def f = 0 }; class B extends A { f }
The INVOKEVIRTUAL instruction uses a method reference "B.f ()I". Therefore this method has two parameters:
- memberDeclClass
The class in which the member is declared (A)
- memberRefClass
The class used in the member reference (B) (B0) JVMS 5.4.3.2 / 5.4.3.3: when resolving a member of class C in D, the class C is resolved first. According to 5.4.3.1, this requires C to be accessible in D. JVMS 5.4.4 summary: A field or method R is accessible to a class D (destinationClass) iff (B1) R is public (B2) R is protected, declared in C (memberDeclClass) and D is a subclass of C. If R is not static, R must contain a symbolic reference to a class T (memberRefClass), such that T is either a subclass of D, a superclass of D, or D itself. Also (P) needs to be satisfied. (B3) R is either protected or has default access and declared by a class in the same run-time package as D. If R is protected, also (P) needs to be satisfied. (B4) R is private and is declared in D. (P) When accessing a protected instance member, the target object on the stack (the receiver) has to be a subtype of D (destinationClass). This is enforced by classfile verification (https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.10.1.8). TODO: we cannot currently implement (P) because we don't have the necessary information available. Once we have a type propagation analysis implemented, we can extract the receiver type from there (https://github.com/scala-opt/scala/issues/13).
-
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
final
def
notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
- def runInliner(): Unit
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (Inliner[BT], B)
-
object
callsiteOrdering
extends Ordering[InlineRequest]
Ordering for inline requests.
Ordering for inline requests. Required to make the inliner deterministic:
- Always remove the same request when breaking inlining cycles
- Perform inlinings in a consistent order
The Scala compiler API.
The following resources are useful for Scala plugin/compiler development: