org.jetbrains.kotlin.backend.konan.llvm.diagnostics.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-native-compiler-embeddable Show documentation
Embeddable JAR of Kotlin/Native compiler
There is a newer version: 2.1.0-RC2
Show newest version
/*
 * Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */

package org.jetbrains.kotlin.backend.konan.llvm

import kotlinx.cinterop.*
import llvm.*
import org.jetbrains.kotlin.backend.konan.llvm.LlvmDiagnostic.Severity

// Note: we rely on LLVM reporting diagnostics to callback.
// This happens during execution of LLVM C++ code, so the callback shouldn't throw Kotlin exceptions.
// That's why the supposed operation is: collect diagnostics while running LLVM, then handle after returning to Kotlin.
//
// By default LLVM prints messages to stderr and terminates the process on errors,
// which isn't ok for Kotlin compiler, e.g. when embedding it into Gradle daemon process.

internal class LlvmDiagnostic(val severity: Severity, val message: String) {
    enum class Severity {
        ERROR,
        WARNING,
        REMARK,
        NOTE
    }
}

internal class LlvmDiagnosticCollector {
    private val diagnostics = mutableListOf()

    fun add(diagnostic: LlvmDiagnostic) {
        diagnostics += diagnostic
    }

    fun flush(handler: LlvmDiagnosticHandler) {
        handler.handle(diagnostics)
        diagnostics.clear()
    }
}

internal interface LlvmDiagnosticHandler {
    fun handle(diagnostics: List)
}

internal inline fun  withLlvmDiagnosticHandler(llvmContext: LLVMContextRef, handler: LlvmDiagnosticHandler, block: () -> R): R {
    val collector = LlvmDiagnosticCollector()
    return try {
        withLlvmDiagnosticCollector(llvmContext, collector, block)
    } finally {
        collector.flush(handler)
    }
}

internal inline fun  withLlvmDiagnosticCollector(llvmContext: LLVMContextRef, collector: LlvmDiagnosticCollector, block: () -> R): R {
    val handler: LLVMDiagnosticHandler = staticCFunction { diagnostic, context ->
        context!!.asStableRef().get().add(createLlvmDiagnostic(diagnostic))
    }
    val context = StableRef.create(collector)
    return try {
        withLlvmDiagnosticHandler(llvmContext, handler, context.asCPointer(), block)
    } finally {
        context.dispose()
    }
}

internal inline fun  withLlvmDiagnosticHandler(
        llvmContext: LLVMContextRef,
        handler: LLVMDiagnosticHandler,
        context: COpaquePointer,
        block: () -> R
): R {
    val currentHandler = LLVMContextGetDiagnosticHandler(llvmContext)
    val currentContext = LLVMContextGetDiagnosticContext(llvmContext)

    return try {
        LLVMContextSetDiagnosticHandler(llvmContext, handler, context)
        block()
    } finally {
        LLVMContextSetDiagnosticHandler(llvmContext, currentHandler, currentContext)
    }
}

private fun createLlvmDiagnostic(diagnostic: LLVMDiagnosticInfoRef?) = if (diagnostic == null) {
    LlvmDiagnostic(Severity.ERROR, "Unknown LLVM error")
} else {
    LlvmDiagnostic(
            severity = when (LLVMGetDiagInfoSeverity(diagnostic)) {
                LLVMDiagnosticSeverity.LLVMDSError -> Severity.ERROR
                LLVMDiagnosticSeverity.LLVMDSWarning -> Severity.WARNING
                LLVMDiagnosticSeverity.LLVMDSRemark -> Severity.REMARK
                LLVMDiagnosticSeverity.LLVMDSNote -> Severity.NOTE
            },
            message = LLVMGetDiagInfoDescription(diagnostic)?.toKString() ?: "Unknown LLVM error"
    )
}