stig-engine/com.stigway.engine.llvm

Package-level declarations

Types

BitcodeMemoryTransferInput

data class BitcodeMemoryTransferInput(val argument: BitcodeModelArgument, val memory: BitcodeMemorySource?)

BitcodeModelArgument

data class BitcodeModelArgument(val type: String, val value: String)

BitcodeRewriteChangeKind

enum BitcodeRewriteChangeKind : Enum<BitcodeRewriteChangeKind>

BitcodeRewriteEntry

data class BitcodeRewriteEntry(val kind: BitcodeRewriteKind, val subjectKind: BitcodeRewriteSubjectKind, val changeKind: BitcodeRewriteChangeKind, val mechanismKind: BitcodeRewriteMechanismKind, val providerKind: BitcodeRewriteProviderKind, val rewriteLabel: String = kind.label, val rewriteDefinition: String = kind.definition, val ruleScope: String?, val ruleOwner: String?, val symbolPattern: String?, val ruleId: String?, val reason: String?, val name: String, val demangledName: String, val originalDefinitionCount: Int, val transformedDefinitionCount: Int, val originalSourceFile: String? = null, val originalSource: BitcodeOriginalSource? = null, val originalSourceLine: Int? = null, val originalSourceCategory: String? = null, val originalCompileUnitSourceFile: String? = null, val originalCompileUnitSourceCategory: String? = null, val transformedSourceFile: String? = null, val transformedSourceLine: Int? = null, val transformedSourceCategory: String? = null, val transformedCompileUnitSourceFile: String? = null, val transformedCompileUnitSourceCategory: String? = null, val sourceFile: String?, val sourceLine: Int?, val sourceCategory: String?, val originalIrLines: Int? = null, val transformedIrLines: Int? = null, val originalInstructionLines: Int? = null, val transformedInstructionLines: Int? = null, val implementationSourceFile: String?, val replacementSourceFile: String?)

BitcodeRewriteMechanismKind

enum BitcodeRewriteMechanismKind : Enum<BitcodeRewriteMechanismKind>

BitcodeRewriteProviderKind

enum BitcodeRewriteProviderKind : Enum<BitcodeRewriteProviderKind>

BitcodeRewriteReport

data class BitcodeRewriteReport(val entries: List<BitcodeRewriteEntry>, val validation: BitcodeRewriteReportValidation = BitcodeRewriteReportValidation.forEntries(entries), val functionAliasTargets: Map<String, String> = emptyMap())

BitcodeRewriteReportValidation

data class BitcodeRewriteReportValidation(val violations: List<BitcodeRewriteValidationViolation>)

BitcodeRewriteSubjectKind

enum BitcodeRewriteSubjectKind : Enum<BitcodeRewriteSubjectKind>

BitcodeRewriteValidationViolation

data class BitcodeRewriteValidationViolation(val name: String, val demangledName: String, val subjectKind: BitcodeRewriteSubjectKind, val changeKind: BitcodeRewriteChangeKind, val mechanismKind: BitcodeRewriteMechanismKind, val providerKind: BitcodeRewriteProviderKind, val message: String)

GeneratedHarnessLlvmContractResult

data class GeneratedHarnessLlvmContractResult(val generatedLifecycleEntrySymbol: String?, val configuredAnalyzerEntrySymbols: List<String>, val expectedMarkerCount: Int, val definedMarkerCount: Int, val calledMarkerCount: Int, val violations: List<String>, val markerSymbols: List<String> = emptyList())

GeneratedHarnessLlvmContractVerifier

class GeneratedHarnessLlvmContractVerifier(demangle: (Collection<String>) -> Map<String, String>)

Verifies the generated harness's structural contract against a final linked textual LLVM module.

LlvmCountedScalarArray

data class LlvmCountedScalarArray(val array: BitcodeArrayField, val objectBytes: Long, val indirect: Boolean)

LlvmFixedElementMember

data class LlvmFixedElementMember(val offsetBytes: Long, val strideBytes: Long, val capacity: Int, val member: LlvmScalarMember, val objectBytes: Long, val indirect: Boolean)

LlvmFunctionBehaviorAnalyzer

object LlvmFunctionBehaviorAnalyzer

Conservative source-level taint summaries derived from untransformed textual LLVM IR.

LlvmFunctionBehaviorRequest

data class LlvmFunctionBehaviorRequest(val llvmSymbol: String, val qualifiedFunctionName: String, val demangledName: String)

LlvmFunctionContractReport

data class LlvmFunctionContractReport(val schemaId: String = "ai.exida.stig/llvm-function-contracts", val schemaVersion: Int = 1, val checkpoint: String = "P5_FINAL", val moduleSha256: String, val beforeFinalOptimizationSha256: String, val analyzerEntrySymbols: List<String>, val reachabilityScope: String, val reachableFunctionCount: Int, val harness: GeneratedHarnessLlvmContractResult?, val rules: List<LlvmFunctionRuleCheck>, val helpers: List<LlvmRequiredInlineHelperCheck>, val violations: List<LlvmFunctionContractViolation>)

LlvmFunctionContractVerifier

class LlvmFunctionContractVerifier(demangle: (Collection<String>) -> Map<String, String>)

Checks compiler contracts; the separate transform-body validator checks configured model semantics.

LlvmFunctionContractViolation

data class LlvmFunctionContractViolation(val requirement: String, val symbol: String, val message: String, val ruleId: String? = null, val callers: List<LlvmReviewCaller> = emptyList(), val referencingSymbols: List<String> = emptyList())

LlvmFunctionDebugMetadata

object LlvmFunctionDebugMetadata

Focused reader for compiler-produced function debug identity and source provenance.

LlvmFunctionDebugMetadataIndex

class LlvmFunctionDebugMetadataIndex

LlvmFunctionDisplayInfo

data class LlvmFunctionDisplayInfo(val abiVariant: String?, val referenceStatus: String)

Display-oriented identity and reference facts for one exact LLVM function symbol.

LlvmFunctionDisplayInfoAnalyzer

object LlvmFunctionDisplayInfoAnalyzer

Derives exact-symbol details that a demangled C++ name alone cannot show.

LlvmFunctionRuleCheck

data class LlvmFunctionRuleCheck(val ruleId: String, val selector: String, val inlining: Inlining, val compilerMatchedSymbols: List<String>, val beforeFinalOptimizationSymbols: List<String>, val finalDefinedSymbols: List<String>, val absentFinalSymbols: List<String>, val status: String)

LlvmIrDiagnostics

object LlvmIrDiagnostics

LlvmIrFunctionMetrics

data class LlvmIrFunctionMetrics(val name: String, val demangledName: String, val sourceFile: String?, val sourceLine: Int?, val sourceCategory: String, val compileUnitSourceFile: String?, val compileUnitSourceCategory: String, val bodyShape: String, val startLine: Int, val irLines: Int, val instructionLines: Int, val bytes: Int, val calls: Int, val invokes: Int, val loads: Int, val stores: Int, val branches: Int, val returns: Int)

LlvmIrModuleDiagnostics

data class LlvmIrModuleDiagnostics(val modulePath: String, val note: String? = null, val summary: LlvmIrSummary, val functions: List<LlvmIrFunctionMetrics>, val suspects: List<LlvmIrFunctionMetrics>, val transformValidation: LlvmIrTransformValidationReport? = null)

Lightweight textual LLVM IR diagnostics for build-time analysis debugging.

LlvmIrSummary

data class LlvmIrSummary(val functionCount: Int, val irLines: Int, val functionIrLines: Int, val instructionLines: Int, val bytes: Int, val selectedCompilationUnitFunctions: Int, val selectedCompilationUnitInstructionLines: Int, val harnessFunctions: Int, val harnessInstructionLines: Int, val stubFunctions: Int, val stubInstructionLines: Int, val dependencyFunctions: Int, val dependencyInstructionLines: Int, val unknownFunctions: Int, val unknownInstructionLines: Int)

LlvmIrTransformFunctionViolation

data class LlvmIrTransformFunctionViolation(val kind: String, val id: String?, val symbol: String, val function: String, val demangledName: String, val expectedShape: String, val actualShape: String, val instructionLines: Int)

LlvmIrTransformRuleValidation

data class LlvmIrTransformRuleValidation(val kind: String, val id: String?, val symbol: String, val reason: String?, val expectedShape: String, val matchedFunctions: Int)

LlvmIrTransformValidationReport

data class LlvmIrTransformValidationReport(val configuredRuleCount: Int, val checkedRuleCount: Int, val matchedRuleCount: Int, val unmatchedRules: List<LlvmIrTransformRuleValidation>, val violations: List<LlvmIrTransformFunctionViolation>)

LlvmPointerMember

data class LlvmPointerMember(val offsetBytes: Long, val pointerBytes: Long, val objectBytes: Long)

Writable stored byte pointer selected from compiler types; the pointee is distinct from this slot.

LlvmReferenceMember

data class LlvmReferenceMember(val offsetBytes: Long, val pointerBytes: Long)

One C++ reference member whose stored pointer must be loaded before selecting its referent.

LlvmRequiredInlineHelperCheck

data class LlvmRequiredInlineHelperCheck(val helper: LlvmRequiredInlineHelper, val remainingCalls: List<LlvmFunctionContractViolation>, val addressUses: List<LlvmFunctionContractViolation> = emptyList())

LlvmReturnMember

data class LlvmReturnMember(val path: List<String>, val member: LlvmScalarMember)

LlvmReviewCall

data class LlvmReviewCall(val symbol: String, val lines: List<Int>)

LlvmReviewCaller

data class LlvmReviewCaller(val symbol: String, val lines: List<Int>)

LlvmReviewIndexer

object LlvmReviewIndexer

One streaming pass over a canonical llvm-dis module. Bodies stay in the module, with exact byte/line ranges.

LlvmReviewLine

data class LlvmReviewLine(val line: Int, val instruction: String)

LlvmReviewModuleIndex

data class LlvmReviewModuleIndex(val schemaId: String = "ai.exida.stig/llvm-review-index", val schemaVersion: Int = 1, val bytes: Long, val sha256: String, val symbols: Map<String, LlvmReviewSymbol>)

LlvmReviewSymbol

data class LlvmReviewSymbol(val symbol: String, val kind: String, val state: String, val startLine: Int, val endLine: Int, val byteOffset: Long, val byteLength: Long, val sha256: String, val header: String, val attributes: String = "", val returnType: String? = null, val parameters: List<String> = emptyList(), val sretParameterIndexes: List<Int> = emptyList(), val aliasTarget: String? = null, val calls: List<LlvmReviewCall> = emptyList(), val callers: List<LlvmReviewCaller> = emptyList(), val referencedSymbols: List<String> = emptyList(), val instructionCounts: Map<String, Int> = emptyMap(), val excerpts: Map<String, List<LlvmReviewLine>> = emptyMap())

Compiler facts only. Effects listed here do not establish agreement with an activity's sinks.

LlvmScalarMember

data class LlvmScalarMember(val offsetBytes: Long, val llvmType: String, val bytes: Long, val isBoolean: Boolean, val readOnly: Boolean, val objectBytes: Long, val indirect: Boolean, val references: List<LlvmReferenceMember> = emptyList())

A scalar location derived from the exact function's compiler debug types, never from configured offsets.

LlvmSourceLocation

data class LlvmSourceLocation(val file: String, val line: Int?)

LoweredBitcodeFunctionModel

data class LoweredBitcodeFunctionModel(val body: List<String>, val declarations: Set<String> = emptySet())

SourceCodeAnalysisFunctionInventoryEntry

data class SourceCodeAnalysisFunctionInventoryEntry(val llvmSymbol: String, val demangledName: String, val ownerUnits: List<String>)

One exact function definition in the complete untransformed native inventory.

SourceCodeAnalysisOverloadConflictAnalyzer

object SourceCodeAnalysisOverloadConflictAnalyzer

Distinguishes incompatible established behaviors from incomplete evidence across original overloads.

Functions

importLlvmMemberTransferSignatures

fun importLlvmMemberTransferSignatures(module: String, originalModule: String, signatureTargets: Map<String, String>): String

Retain exact P3 compiler signatures for address-only P5 declarations. Clang does not always emit DISubprogram for taking a free function's address. Every parameter/receiver record type must already exist in P5 with the same compiler identity and object layout; no implementation or inferred layout is imported. Linked P3 class records without an identifier require an identified copy of the same compiler declaration, with the same exact member linkage names and complete layout. C file-scope records instead use their exact checksum-bearing source declaration and complete type layout. The caller checks the exact LLVM signatures before invoking this function.

lowerAtomicStoredPointerGlobal

fun lowerAtomicStoredPointerGlobal(model: BitcodeFunctionModel, abi: BitcodeFunctionAbi, parameters: List<String>, returnType: String, pointerBytes: Long): List<String>

lowerBitcodeFunctionModel

fun lowerBitcodeFunctionModel(model: BitcodeFunctionModel, returnType: String, arguments: List<BitcodeModelArgument>): LoweredBitcodeFunctionModel

Lowers a reviewed model after source-level endpoints have been resolved against the exact function ABI.

lowerBitcodeMemberTransfers

fun lowerBitcodeMemberTransfers(transfers: List<BitcodeTransferEdge>, abi: BitcodeFunctionAbi, parameters: List<String>, arguments: List<BitcodeModelArgument>, returnType: String, llvmSymbol: String, debugMetadata: LlvmFunctionDebugMetadataIndex, zeroInitializeReturn: Boolean = false): List<String>

Emit scalar assignments at compiler-resolved member locations. All sources are read before any store. Multiple contributors to one destination form a dependency union. A self-edge explicitly includes the entry-time destination value. Counted array snapshots are shared across every destination using them.

lowerBitcodeMemoryCopy

fun lowerBitcodeMemoryCopy(model: BitcodeFunctionModel, abi: BitcodeFunctionAbi, parameters: List<String>, arguments: List<BitcodeModelArgument>, returnType: String, llvmSymbol: String, metadata: LlvmFunctionDebugMetadataIndex): List<String>

Copy through the entry cursor, then reload its storage before advancing; aliases can change that storage.

lowerBitcodeMemoryTransfer

fun lowerBitcodeMemoryTransfer(returnType: String, inputs: List<BitcodeMemoryTransferInput>): List<String>

Materialize a union of selected-memory/scalar dependencies in a scalar return. Dependency loads read individual bytes and never include padding outside the configured ranges. Count fields contribute even when an array is empty or its count exceeds capacity.

lowerBitcodePointerBinding

fun lowerBitcodePointerBinding(model: BitcodeFunctionModel, abi: BitcodeFunctionAbi, parameters: List<String>, arguments: List<BitcodeModelArgument>, returnType: String, llvmSymbol: String, metadata: LlvmFunctionDebugMetadataIndex): List<String>

Preserve stored pointer identity; these operations neither copy nor read pointee contents.

matches

fun LlvmRequiredInlineHelper.matches(demangledName: String): Boolean

validateAtomicStoredPointerGlobal

fun validateAtomicStoredPointerGlobal(module: String, symbol: String): Long

Return the proven pointer width; reject other storage instead of treating integer bits as pointer state.

validateStoredPointerGlobal

fun validateStoredPointerGlobal(module: String, symbol: String)

The fallback is a global pointer's stored value, never its address or an external/TLS object.