final case class OverflowDbDriver(storageLocation: Option[String] = Option(
JFile.createTempFile("plume-", ".odb").getAbsolutePath
), heapPercentageThreshold: Int = 80, serializationStatsEnabled: Boolean = false, dataFlowCacheFile: Option[Path] = Some(Paths.get("dataFlowCache.cbor")), compressDataFlowCache: Boolean = true) extends IDriver with Product with Serializable
Driver to create an OverflowDB database file.
- storageLocation
where the database will serialize to and deserialize from.
- heapPercentageThreshold
the percentage of the JVM heap from when the database will begin swapping to disk.
- serializationStatsEnabled
enables saving of serialization statistics.
- dataFlowCacheFile
the path to the cache file where data-flow paths are saved to. If None then data flow results will not be saved.
- compressDataFlowCache
whether to compress the serialized data-flow cache specified at dataFlowCacheFile.
- Alphabetic
- By Inheritance
- OverflowDbDriver
- Serializable
- Product
- Equals
- IDriver
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new OverflowDbDriver(storageLocation: Option[String] = Option(
JFile.createTempFile("plume-", ".odb").getAbsolutePath
), heapPercentageThreshold: Int = 80, serializationStatsEnabled: Boolean = false, dataFlowCacheFile: Option[Path] = Some(Paths.get("dataFlowCache.cbor")), compressDataFlowCache: Boolean = true)- storageLocation
where the database will serialize to and deserialize from.
- heapPercentageThreshold
the percentage of the JVM heap from when the database will begin swapping to disk.
- serializationStatsEnabled
enables saving of serialization statistics.
- dataFlowCacheFile
the path to the cache file where data-flow paths are saved to. If None then data flow results will not be saved.
- compressDataFlowCache
whether to compress the serialized data-flow cache specified at dataFlowCacheFile.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def NODES_IN_SCHEMA: Seq[String]
- Attributes
- protected
- Definition Classes
- IDriver
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def astLinker(): Unit
Create REF edges from TYPE nodes to TYPE_DECL, EVAL_TYPE edges from nodes of various types to TYPE, REF edges from METHOD_REFs to METHOD, INHERITS_FROM nodes from TYPE_DECL nodes to TYPE, and ALIAS_OF edges from TYPE_DECL nodes to TYPE.
- def buildInterproceduralEdges(): Unit
Runs linkers for AST node relations and calls.
Runs linkers for AST node relations and calls.
- Definition Classes
- IDriver
- def bulkTx(dg: AppliedDiff): Unit
Executes all changes contained within the given overflowdb.BatchedUpdate.AppliedDiff as a (or set of) bulk transaction(s).
Executes all changes contained within the given overflowdb.BatchedUpdate.AppliedDiff as a (or set of) bulk transaction(s).
- Definition Classes
- OverflowDbDriver → IDriver
- def bulkTx(dg: AppliedDiffGraph): Unit
Executes all changes contained within the given io.shiftleft.passes.AppliedDiffGraph as a (or set of) bulk transaction(s).
Executes all changes contained within the given io.shiftleft.passes.AppliedDiffGraph as a (or set of) bulk transaction(s).
- Definition Classes
- OverflowDbDriver → IDriver
- def clear(): Unit
Removes all entries from the database.
Removes all entries from the database.
- Definition Classes
- OverflowDbDriver → IDriver
- def clearMaps(): Unit
- Attributes
- protected
- Definition Classes
- IDriver
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def close(): Unit
- Definition Classes
- OverflowDbDriver → AutoCloseable
- val compressDataFlowCache: Boolean
- val cpg: Cpg
A direct pointer to the code property graph object.
- val dataFlowCacheFile: Option[Path]
- def deserializeLists(properties: Map[String, Any]): Map[String, Any]
Where former list properties were serialized as strings, they will be deserialized as Seq.
Where former list properties were serialized as strings, they will be deserialized as Seq.
- properties
the serialized property map.
- returns
a property map where comma-separated strings are made Seq objects.
- Attributes
- protected
- Definition Classes
- IDriver
- def dynamicCallLinker(): Unit
Links all dynamic dispatch calls to their methods.
Links all dynamic dispatch calls to their methods.
- Definition Classes
- OverflowDbDriver → IDriver
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def exists(srcId: Long, dstId: Long, edge: String): Boolean
Determines if there exists an edge between two nodes.
Determines if there exists an edge between two nodes. Edges are assumed to be directional.
- Definition Classes
- OverflowDbDriver → IDriver
- def exists(nodeId: Long): Boolean
Determines if the node exists in the database.
Determines if the node exists in the database.
- Definition Classes
- OverflowDbDriver → IDriver
- def exportAsGraphML(exportPath: File): Unit
Serializes the graph in the OverflowDB instance to the GraphML format to the given OutputStreamWriter.
Serializes the graph in the OverflowDB instance to the GraphML format to the given OutputStreamWriter. This format is supported by TinkerGraph and Cytoscape.
- exportPath
the path to write the GraphML representation of the graph to.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- val heapPercentageThreshold: Int
- def id(node: AbstractNode, dg: AppliedDiffGraph): Any
Provides the assigned ID for the given node using the given diff graph.
Provides the assigned ID for the given node using the given diff graph.
- Attributes
- protected
- Definition Classes
- IDriver
- def idInterval(lower: Long, upper: Long): Set[Long]
Returns all the taken IDs between the two boundaries (inclusive).
Returns all the taken IDs between the two boundaries (inclusive).
- Definition Classes
- OverflowDbDriver → IDriver
- def initMaps(): Unit
- Attributes
- protected
- Definition Classes
- IDriver
- def isConnected: Boolean
Will return true if the database is connected, false if otherwise.
Will return true if the database is connected, false if otherwise.
- Definition Classes
- OverflowDbDriver → IDriver
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def linkAstNodes(srcLabels: List[String], edgeType: String, dstNodeMap: Map[String, Any], dstFullNameKey: String, dstNodeType: String): Unit
Links nodes by their source label and destination full name key to their destination nodes by the specified edge type using the destination node map as the lookup table.
Links nodes by their source label and destination full name key to their destination nodes by the specified edge type using the destination node map as the lookup table. Source labels are assumed to be non-empty.
- Definition Classes
- OverflowDbDriver → IDriver
- val methodFullNameToNode: Map[String, Any]
- Attributes
- protected
- Definition Classes
- IDriver
- val namespaceNameToNode: Map[String, Any]
- Attributes
- protected
- Definition Classes
- IDriver
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nodesReachableBy(source: Traversal[CfgNode], sink: Traversal[CfgNode], sanitizers: Set[String] = Set.empty[String]): List[ReachableByResult]
Lists all of the source nodes that reach the given sinks.
Lists all of the source nodes that reach the given sinks. These results are cached between analysis runs.
- source
the source query to match.
- sink
the sink query to match.
- sanitizers
a set of full method names to filter paths out with.
- returns
the source nodes whose data flows to the given sinks uninterrupted.
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def propertyFromNodes(nodeType: String, keys: String*): List[Map[String, Any]]
Obtains properties from the specified node type and key(s).
Obtains properties from the specified node type and key(s). By default will return the ID property as one of the keys as "id".
- Definition Classes
- OverflowDbDriver → IDriver
- def removeExpiredPathsFromCache(unchangedTypes: Set[String]): Unit
Will traverse the deserialized cache and remove nodes belonging to types not in the given set of unchanged types.
Will traverse the deserialized cache and remove nodes belonging to types not in the given set of unchanged types.
- unchangedTypes
the list of types which have not changed since the last graph database update.
- def removeSourceFiles(filenames: String*): Unit
Given filenames, will remove related TYPE, TYPE_DECL, METHOD (with AST children), and NAMESPACE_BLOCK.
Given filenames, will remove related TYPE, TYPE_DECL, METHOD (with AST children), and NAMESPACE_BLOCK.
- Definition Classes
- OverflowDbDriver → IDriver
- val serializationStatsEnabled: Boolean
- def serializeLists(properties: Map[String, Any]): Map[String, Any]
To handle the case where databases don't support lists, we simply serialize these as a comma-separated string.
To handle the case where databases don't support lists, we simply serialize these as a comma-separated string.
- properties
the property map.
- returns
a property map where lists are serialized as strings.
- Attributes
- protected
- Definition Classes
- IDriver
- def setDataflowContext(maxCallDepth: Int, methodSemantics: Option[BufferedSource] = None, initialCache: Option[ResultTable] = None): EngineContext
Sets the context for the data-flow engine when performing nodesReachableBy queries.
Sets the context for the data-flow engine when performing nodesReachableBy queries.
- maxCallDepth
the new method call depth.
- methodSemantics
the file containing method semantics for external methods.
- initialCache
an initializer for the data-flow cache containing pre-calculated paths.
- def staticCallLinker(): Unit
Links all static dispatch calls to their methods.
Links all static dispatch calls to their methods.
- Definition Classes
- OverflowDbDriver → IDriver
- val storageLocation: Option[String]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val typeDeclFullNameToNode: Map[String, Any]
- Attributes
- protected
- Definition Classes
- IDriver
- val typeFullNameToNode: Map[String, Any]
- Attributes
- protected
- Definition Classes
- IDriver
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated