org.jetbrains.kotlin.backend.konan.llvm.StaticData.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-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
 * that can be found in the LICENSE file.
 */

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

import llvm.*

/**
 * Provides utilities to create static data.
 */
internal open class StaticData(val module: LLVMModuleRef, private val llvm: CodegenLlvmHelpers) {

    /**
     * Represents the LLVM global variable.
     */
    class Global private constructor(val llvmGlobal: LLVMValueRef) {
        companion object {

            private fun createLlvmGlobal(module: LLVMModuleRef,
                                         type: LLVMTypeRef,
                                         name: String,
                                         isExported: Boolean
            ): LLVMValueRef {

                if (isExported && LLVMGetNamedGlobal(module, name) != null) {
                    throw IllegalArgumentException("Global '$name' already exists")
                }

                // Globals created with this API are *not* thread local.
                val llvmGlobal = LLVMAddGlobal(module, type, name)!!

                if (!isExported) {
                    LLVMSetLinkage(llvmGlobal, LLVMLinkage.LLVMInternalLinkage)
                }

                return llvmGlobal
            }

            fun create(staticData: StaticData, type: LLVMTypeRef, name: String, isExported: Boolean): Global {
                val isUnnamed = (name == "") // LLVM will select the unique index and represent the global as `@idx`.
                if (isUnnamed && isExported) {
                    throw IllegalArgumentException("unnamed global can't be exported")
                }

                val llvmGlobal = createLlvmGlobal(staticData.module, type, name, isExported)
                return Global(llvmGlobal)
            }

            fun get(staticData: StaticData, name: String): Global? {
                val llvmGlobal = LLVMGetNamedGlobal(staticData.module, name) ?: return null
                return Global(llvmGlobal)
            }

            fun get(module: LLVMModuleRef, name: String): Global? {
                val llvmGlobal = LLVMGetNamedGlobal(module, name) ?: return null
                return Global(llvmGlobal)
            }
        }

        val type get() = getGlobalType(this.llvmGlobal)

        fun getInitializer() = LLVMGetInitializer(llvmGlobal)

        fun setInitializer(value: ConstValue) {
            LLVMSetInitializer(llvmGlobal, value.llvm)
        }

        fun setZeroInitializer() {
            LLVMSetInitializer(llvmGlobal, LLVMConstNull(this.type)!!)
        }

        fun setConstant(value: Boolean) {
            LLVMSetGlobalConstant(llvmGlobal, if (value) 1 else 0)
        }

        /**
         * Globals that are marked with unnamed_addr might be merged by LLVM's ConstantMerge pass.
         */
        fun setUnnamedAddr(value: Boolean) {
            LLVMSetUnnamedAddr(llvmGlobal, if (value) 1 else 0)
        }

        fun setLinkage(value: LLVMLinkage) {
            LLVMSetLinkage(llvmGlobal, value)
        }

        fun setAlignment(value: Int) {
            LLVMSetAlignment(llvmGlobal, value)
        }

        fun setSection(name: String) {
            LLVMSetSection(llvmGlobal, name)
        }

        fun setExternallyInitialized(value: Boolean) {
            LLVMSetExternallyInitialized(llvmGlobal, if (value) 1 else 0)
        }

        val pointer : ConstPointer = constPointer(this.llvmGlobal)
    }

    /**
     * Creates [Global] with given type and name.
     *
     * It is external until explicitly initialized with [Global.setInitializer].
     */
    fun createGlobal(type: LLVMTypeRef, name: String, isExported: Boolean = false): Global {
        return Global.create(this, type, name, isExported)
    }

    /**
     * Creates [Global] with given name and value.
     */
    fun placeGlobal(name: String, initializer: ConstValue, isExported: Boolean = false): Global {
        val global = createGlobal(initializer.llvmType, name, isExported)
        global.setInitializer(initializer)
        return global
    }

    fun getGlobal(name: String): Global? {
        return Global.get(this, name)
    }

    /**
     * Creates array-typed global with given name and value.
     */
    fun placeGlobalArray(name: String, elemType: LLVMTypeRef?, elements: List, isExported: Boolean = false): Global {
        val initializer = ConstArray(elemType, elements)
        val global = placeGlobal(name, initializer, isExported)

        return global
    }

    private val cStringLiterals = mutableMapOf()

    internal fun placeGlobalConstArray(name: String,
                                       elemType: LLVMTypeRef,
                                       elements: List,
                                       isExported: Boolean = false): ConstPointer {
        if (elements.isNotEmpty() || isExported) {
            val global = placeGlobalArray(name, elemType, elements, isExported)
            global.setConstant(true)
            return global.pointer.getElementPtr(llvm, LLVMArrayType(elemType, elements.size)!!, 0)
        } else {
            return NullPointer(elemType)
        }
    }

    internal fun placeCStringLiteral(value: String) : ConstPointer {
        val chars = value.toByteArray(Charsets.UTF_8).map { llvm.constInt8(it) } + llvm.constInt8(0)

        return placeGlobalConstArray("", llvm.int8Type, chars)
    }

    internal fun cStringLiteral(value: String) = cStringLiterals.getOrPut(value) { placeCStringLiteral(value) }

    companion object {
        fun getGlobal(module: LLVMModuleRef, name: String) = Global.get(module, name)
    }
}