c

io.shiftleft.passes

NewStyleCpgPassBase

abstract class NewStyleCpgPassBase[T <: AnyRef] extends CpgPassBase

NewStyleCpgPassBase is the shared base between ForkJoinParallelCpgPass and ConcurrentWriterCpgPass, containing shared boilerplate. We don't want ConcurrentWriterCpgPass as a subclass of ForkJoinParallelCpgPass because that would make it hard to whether an instance is non-racy.

Please don't subclass this directly. The only reason it's not sealed is that this would mess with our file hierarchy.

Linear Supertypes
CpgPassBase, AnyRef, Any
Known Subclasses
ConcurrentWriterCpgPass, ForkJoinParallelCpgPass, SimpleCpgPass
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NewStyleCpgPassBase
  2. CpgPassBase
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NewStyleCpgPassBase()

Type Members

  1. type DiffGraphBuilder = overflowdb.BatchedUpdate.DiffGraphBuilder

Abstract Value Members

  1. abstract def createApplySerializeAndStore(serializedCpg: SerializedCpg, inverse: Boolean = false, prefix: String = ""): Unit
    Definition Classes
    CpgPassBase
  2. abstract def generateParts(): Array[_ <: AnyRef]
  3. abstract def runOnPart(builder: DiffGraphBuilder, part: T): Unit

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def baseLogger: Logger
    Attributes
    protected
    Definition Classes
    CpgPassBase
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def createAndApply(): Unit
    Definition Classes
    NewStyleCpgPassBase → CpgPassBase
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finish(): Unit
  11. def generateOutFileName(prefix: String, outName: String, index: Int): String
    Attributes
    protected
    Definition Classes
    CpgPassBase
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def init(): Unit
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def name: String

    Name of the pass.

    Name of the pass. By default it is inferred from the name of the class, override if needed.

    Definition Classes
    CpgPassBase
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def runWithBuilder(externalBuilder: overflowdb.BatchedUpdate.DiffGraphBuilder): Int

    Runs the cpg pass, adding changes to the passed builder.

    Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

    Definition Classes
    NewStyleCpgPassBase → CpgPassBase
  21. def runWithBuilderLogged(builder: overflowdb.BatchedUpdate.DiffGraphBuilder): Int

    Wraps runWithBuilder with logging, and swallows raised exceptions.

    Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

    Definition Classes
    CpgPassBase
  22. def serialize(appliedDiffGraph: AppliedDiffGraph, inverse: Boolean): GeneratedMessageV3
    Attributes
    protected
    Definition Classes
    CpgPassBase
  23. def store(overlay: GeneratedMessageV3, name: String, serializedCpg: SerializedCpg): Unit
    Attributes
    protected
    Definition Classes
    CpgPassBase
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. def withStartEndTimesLogged[A](fun: => A): A
    Attributes
    protected
    Definition Classes
    CpgPassBase

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from CpgPassBase

Inherited from AnyRef

Inherited from Any

Ungrouped