scala.tools.nsc.backend.opt.Inliners

# Inliner

#### class Inliner extends AnyRef

Simple inliner.

Source
  Inliners.scala

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Inliner
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new Inliner()

### Type Members

1. #### case class AccessReq(accessNeeded: NonPublicRefs.Value, toBecomePublic: List[Global.Symbol]) extends Product with Serializable

2. #### final class CallerCalleeInfo extends AnyRef

3. #### case class DontInlineHere(msg: String) extends InlineSafetyInfo with Product with Serializable

4. #### case class FeasibleInline(accessNeeded: NonPublicRefs.Value, toBecomePublic: List[Global.Symbol]) extends InlineSafetyInfo with Product with Serializable

5. #### class IMethodInfo extends AnyRef

6. #### sealed abstract class InlineSafetyInfo extends AnyRef

   Classifies a pair (caller, callee) into one of four categories:

   Classifies a pair (caller, callee) into one of four categories:

   (a) inlining should be performed, classified in turn into: (a.1) `InlineableAtThisCaller`: unconditionally at this caller (a.2) `FeasibleInline`: it only remains for certain access requirements to be met (see `IMethodInfo.accessRequirements()`)

   (b) inlining shouldn't be performed, classified in turn into: (b.1) `DontInlineHere`: indicates that this particular occurrence of the callee at the caller shouldn't be inlined.

   - Nothing is said about the outcome for other callers, or for other occurrences of the callee for the same caller.
   - In particular inlining might be possible, but heuristics gave a low score for it. (b.2) `NeverSafeToInline`: the callee can't be inlined anywhere, irrespective of caller.

   The classification above is computed by `isStampedForInlining()` based on which `analyzeInc()` goes on to:

   - either log the reason for failure --- case (b) ---,
   - or perform inlining --- case (a) ---.

### Value Members

1. #### final def !=(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

2. #### final def ##(): Int

   Definition Classes
     AnyRef → Any

3. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from Inliner to any2stringadd[Inliner] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd

4. #### def ->[B](y: B): (Inliner, B)

   Implicit information
     This member is added by an implicit conversion from Inliner to ArrowAssoc[Inliner] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

5. #### final def ==(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

6. #### object InlineableAtThisCaller extends InlineSafetyInfo with Product with Serializable

7. #### object NeverSafeToInline extends InlineSafetyInfo with Product with Serializable

8. #### object NonPublicRefs extends Enumeration

9. #### def analyzeClass(cls: Global.icodes.IClass): Unit

10. #### def analyzeMethod(m: Global.icodes.IMethod): Unit

    A transformation local to the body of the IMethod received as argument.

    A transformation local to the body of the IMethod received as argument. An linining decision consists in replacing a callsite with the body of the callee. Please notice that, because `analyzeMethod()` itself may modify a method body, the particular callee bodies that end up being inlined depend on the particular order in which methods are visited (no topological sorting over the call-graph is attempted).

    Making an inlining decision requires type-flow information for both caller and callee. Regarding the caller, such information is needed only for basic blocks containing inlining candidates (and their transitive predecessors). This observation leads to using a custom type-flow analysis (MTFAGrowable) that can be re-inited, i.e. that reuses lattice elements (type-flow information computed in a previous iteration) as starting point for faster convergence in a new iteration.

    The mechanics of inlining are iterative for a given invocation of `analyzeMethod(m)`, and are affected by inlinings from previous iterations (ie, "heuristic" rules are based on statistics tracked for that purpose):

    (1) before the iterations proper start, so-called preinlining is performed. Those callsites whose (receiver, concreteMethod) are both known statically can be analyzed for inlining before computing a type-flow. Details in `preInline()`

    (2) the first iteration computes type-flow information for basic blocks containing inlining candidates (and their transitive predecessors), so called `relevantBBs` basic blocks. The ensuing analysis of each candidate (performed by `analyzeInc()`) may result in a CFG isomorphic to that of the callee being inserted in place of the callsite (i.e. a CALL_METHOD instruction is replaced with a single-entry single-exit CFG, a substitution we call "successful inlining").

    (3) following iterations have `relevantBBs` updated to focus on the inlined basic blocks and their successors only. Details in `MTFAGrowable.reinit()`

11. #### final def asInstanceOf[T0]: T0

    Definition Classes
      Any

12. #### def clearCaches(): Unit

13. #### def clone(): AnyRef

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

14. #### def ensuring(cond: (Inliner) ⇒ Boolean, msg: ⇒ Any): Inliner

    Implicit information
      This member is added by an implicit conversion from Inliner to Ensuring[Inliner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

15. #### def ensuring(cond: (Inliner) ⇒ Boolean): Inliner

    Implicit information
      This member is added by an implicit conversion from Inliner to Ensuring[Inliner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

16. #### def ensuring(cond: Boolean, msg: ⇒ Any): Inliner

    Implicit information
      This member is added by an implicit conversion from Inliner to Ensuring[Inliner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

17. #### def ensuring(cond: Boolean): Inliner

    Implicit information
      This member is added by an implicit conversion from Inliner to Ensuring[Inliner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

18. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

19. #### def equals(arg0: Any): Boolean

    Definition Classes
      AnyRef → Any

20. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

21. #### def formatted(fmtstr: String): String

    Implicit information
      This member is added by an implicit conversion from Inliner to StringFormat[Inliner] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

22. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

23. #### def hashCode(): Int

    Definition Classes
      AnyRef → Any

24. #### object imethodOrdering extends Ordering[Global.icodes.IMethod]

25. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

26. #### def lookupIMethod(meth: Global.Symbol, receiver: Global.Symbol): Option[Global.icodes.IMethod]

27. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

28. #### final def notify(): Unit

    Definition Classes
      AnyRef

29. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

30. #### val recentTFAs: Map[Global.Symbol, (Boolean, Global.analysis.MethodTFA)]

31. #### def shouldLoadImplFor(sym: Global.Symbol, receiver: Global.Symbol): Boolean

    Should method 'sym' being called in 'receiver' be loaded from disk?

32. #### val splicedBlocks: Set[Global.icodes.BasicBlock]

33. #### val staleIn: Set[Global.icodes.BasicBlock]

34. #### val staleOut: ListBuffer[Global.icodes.BasicBlock]

35. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

36. #### val tfa: Global.analysis.MTFAGrowable

37. #### def toString(): String

    Definition Classes
      AnyRef → Any

38. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

39. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

40. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

41. #### def →[B](y: B): (Inliner, B)

    Implicit information
      This member is added by an implicit conversion from Inliner to ArrowAssoc[Inliner] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from Inliner to any2stringadd[Inliner]

### Inherited by implicit conversion StringFormat from Inliner to StringFormat[Inliner]

### Inherited by implicit conversion Ensuring from Inliner to Ensuring[Inliner]

### Inherited by implicit conversion ArrowAssoc from Inliner to ArrowAssoc[Inliner]

### Ungrouped