org.jetbrains.kotlin.backend.wasm.wasmCompiler.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler-embeddable Show documentation
Show all versions of kotlin-compiler-embeddable Show documentation
the Kotlin compiler embeddable
/*
* Copyright 2010-2019 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.wasm
import org.jetbrains.kotlin.backend.common.linkage.issues.checkNoUnboundSymbols
import org.jetbrains.kotlin.backend.common.phaser.PhaseConfig
import org.jetbrains.kotlin.backend.common.phaser.PhaserState
import org.jetbrains.kotlin.backend.wasm.export.ExportModelGenerator
import org.jetbrains.kotlin.backend.wasm.ir2wasm.JsModuleAndQualifierReference
import org.jetbrains.kotlin.backend.wasm.ir2wasm.WasmCompiledModuleFragment
import org.jetbrains.kotlin.backend.wasm.ir2wasm.WasmModuleFragmentGenerator
import org.jetbrains.kotlin.backend.wasm.ir2wasm.toJsStringLiteral
import org.jetbrains.kotlin.backend.wasm.lower.JsInteropFunctionsLowering
import org.jetbrains.kotlin.backend.wasm.lower.markExportedDeclarations
import org.jetbrains.kotlin.backend.wasm.utils.SourceMapGenerator
import org.jetbrains.kotlin.cli.common.CommonCompilerPerformanceManager
import org.jetbrains.kotlin.config.CompilerConfiguration
import org.jetbrains.kotlin.ir.backend.js.IrModuleInfo
import org.jetbrains.kotlin.ir.backend.js.MainModule
import org.jetbrains.kotlin.ir.backend.js.export.ExportModelToTsDeclarations
import org.jetbrains.kotlin.ir.backend.js.export.TypeScriptFragment
import org.jetbrains.kotlin.ir.declarations.IrModuleFragment
import org.jetbrains.kotlin.ir.util.ExternalDependenciesGenerator
import org.jetbrains.kotlin.ir.util.patchDeclarationParents
import org.jetbrains.kotlin.name.FqName
import org.jetbrains.kotlin.serialization.js.ModuleKind
import org.jetbrains.kotlin.utils.addToStdlib.ifNotEmpty
import org.jetbrains.kotlin.utils.addToStdlib.runIf
import org.jetbrains.kotlin.wasm.config.WasmConfigurationKeys
import org.jetbrains.kotlin.wasm.ir.convertors.WasmIrToBinary
import org.jetbrains.kotlin.wasm.ir.convertors.WasmIrToText
import java.io.ByteArrayOutputStream
import java.io.File
import java.nio.file.Files
import java.nio.file.Paths
import java.nio.file.StandardCopyOption
class WasmCompilerResult(
val wat: String?,
val jsUninstantiatedWrapper: String?,
val jsWrapper: String,
val wasm: ByteArray,
val debugInformation: DebugInformation?,
val dts: String?
)
class DebugInformation(
val sourceMapForBinary: String?,
val sourceMapForText: String?,
)
data class LoweredIrWithExtraArtifacts(
val loweredIr: List,
val backendContext: WasmBackendContext,
val typeScriptFragment: TypeScriptFragment?
)
fun compileToLoweredIr(
irModuleInfo: IrModuleInfo,
mainModule: MainModule,
configuration: CompilerConfiguration,
performanceManager: CommonCompilerPerformanceManager?,
phaseConfig: PhaseConfig,
exportedDeclarations: Set = emptySet(),
generateTypeScriptFragment: Boolean,
propertyLazyInitialization: Boolean,
): LoweredIrWithExtraArtifacts {
val (moduleFragment, dependencyModules, irBuiltIns, symbolTable, irLinker) = irModuleInfo
val allModules = when (mainModule) {
is MainModule.SourceFiles -> dependencyModules + listOf(moduleFragment)
is MainModule.Klib -> dependencyModules
}
val moduleDescriptor = moduleFragment.descriptor
val context = WasmBackendContext(moduleDescriptor, irBuiltIns, symbolTable, moduleFragment, propertyLazyInitialization, configuration)
// Load declarations referenced during `context` initialization
allModules.forEach {
ExternalDependenciesGenerator(symbolTable, listOf(irLinker)).generateUnboundSymbolsAsDependencies()
}
// Create stubs
ExternalDependenciesGenerator(symbolTable, listOf(irLinker)).generateUnboundSymbolsAsDependencies()
allModules.forEach { it.patchDeclarationParents() }
irLinker.postProcess(inOrAfterLinkageStep = true)
irLinker.checkNoUnboundSymbols(symbolTable, "at the end of IR linkage process")
irLinker.clear()
for (module in allModules)
for (file in module.files)
markExportedDeclarations(context, file, exportedDeclarations)
val typeScriptFragment = runIf(generateTypeScriptFragment) {
val exportModel = ExportModelGenerator(context).generateExport(allModules)
val exportModelToDtsTranslator = ExportModelToTsDeclarations()
val fragment = exportModelToDtsTranslator.generateTypeScriptFragment(ModuleKind.ES, exportModel.declarations)
TypeScriptFragment(exportModelToDtsTranslator.generateTypeScript("", ModuleKind.ES, listOf(fragment)))
}
performanceManager?.notifyIRTranslationFinished()
performanceManager?.notifyGenerationStarted()
performanceManager?.notifyIRLoweringStarted()
val phaserState = PhaserState()
loweringList.forEachIndexed { _, lowering ->
allModules.forEach { module ->
lowering.invoke(phaseConfig, phaserState, context, module)
}
}
performanceManager?.notifyIRLoweringFinished()
return LoweredIrWithExtraArtifacts(allModules, context, typeScriptFragment)
}
fun compileWasm(
allModules: List,
backendContext: WasmBackendContext,
typeScriptFragment: TypeScriptFragment?,
baseFileName: String,
emitNameSection: Boolean = false,
allowIncompleteImplementations: Boolean = false,
generateWat: Boolean = false,
generateSourceMaps: Boolean = false,
useDebuggerCustomFormatters: Boolean = false
): WasmCompilerResult {
val useJsTag = backendContext.configuration.getBoolean(WasmConfigurationKeys.WASM_USE_JS_TAG)
val compiledWasmModule = WasmCompiledModuleFragment(
backendContext.irBuiltIns,
backendContext.configuration.getBoolean(WasmConfigurationKeys.WASM_USE_TRAPS_INSTEAD_OF_EXCEPTIONS),
backendContext.isWasmJsTarget && useJsTag,
)
val codeGenerator = WasmModuleFragmentGenerator(backendContext, compiledWasmModule, allowIncompleteImplementations = allowIncompleteImplementations)
allModules.forEach { codeGenerator.collectInterfaceTables(it) }
allModules.forEach { codeGenerator.generateModule(it) }
val sourceMapGeneratorForBinary = runIf(generateSourceMaps) {
SourceMapGenerator("$baseFileName.wasm", backendContext.configuration)
}
val sourceMapGeneratorForText = runIf(generateWat && generateSourceMaps) {
SourceMapGenerator("$baseFileName.wat", backendContext.configuration)
}
val linkedModule = compiledWasmModule.linkWasmCompiledFragments()
val wat = if (generateWat) {
val watGenerator = WasmIrToText(sourceMapGeneratorForText)
watGenerator.appendWasmModule(linkedModule)
watGenerator.toString()
} else {
null
}
val os = ByteArrayOutputStream()
val wasmIrToBinary =
WasmIrToBinary(
os,
linkedModule,
allModules.last().descriptor.name.asString(),
emitNameSection,
sourceMapGeneratorForBinary
)
wasmIrToBinary.appendWasmModule()
val byteArray = os.toByteArray()
val jsUninstantiatedWrapper: String?
val jsWrapper: String
if (backendContext.isWasmJsTarget) {
jsUninstantiatedWrapper = compiledWasmModule.generateAsyncJsWrapper(
"./$baseFileName.wasm",
backendContext.jsModuleAndQualifierReferences,
useJsTag
)
jsWrapper = compiledWasmModule.generateEsmExportsWrapper(
"./$baseFileName.uninstantiated.mjs",
backendContext.jsModuleAndQualifierReferences,
useDebuggerCustomFormatters
)
} else {
jsUninstantiatedWrapper = null
jsWrapper = compiledWasmModule.generateAsyncWasiWrapper("./$baseFileName.wasm")
}
return WasmCompilerResult(
wat = wat,
jsUninstantiatedWrapper = jsUninstantiatedWrapper,
jsWrapper = jsWrapper,
wasm = byteArray,
debugInformation = DebugInformation(
sourceMapGeneratorForBinary?.generate(),
sourceMapGeneratorForText?.generate(),
),
dts = typeScriptFragment?.raw
)
}
//language=js
fun WasmCompiledModuleFragment.generateAsyncWasiWrapper(wasmFilePath: String): String = """
import { WASI } from 'wasi';
import { argv, env } from 'node:process';
const wasi = new WASI({ version: 'preview1', args: argv, env, });
const fs = await import('node:fs');
const url = await import('node:url');
const wasmBuffer = fs.readFileSync(url.fileURLToPath(import.meta.resolve('$wasmFilePath')));
const wasmModule = new WebAssembly.Module(wasmBuffer);
const wasmInstance = new WebAssembly.Instance(wasmModule, wasi.getImportObject());
wasi.initialize(wasmInstance);
const exports = wasmInstance.exports
${generateExports()}
"""
fun WasmCompiledModuleFragment.generateAsyncJsWrapper(
wasmFilePath: String,
jsModuleAndQualifierReferences: Set,
useJsTag: Boolean,
): String {
val jsCodeBody = jsFuns.joinToString(",\n") {
"${it.importName.toJsStringLiteral()} : ${it.jsCode}"
}
val jsCodeBodyIndented = jsCodeBody.prependIndent(" ")
val imports = jsModuleImports
.toList()
.sorted()
.joinToString("") {
val moduleSpecifier = it.toJsStringLiteral()
" $moduleSpecifier: imports[$moduleSpecifier],\n"
}
val referencesToQualifiedAndImportedDeclarations = jsModuleAndQualifierReferences
.map {
val module = it.module
val qualifier = it.qualifier
buildString {
append(" const ")
append(it.jsVariableName)
append(" = ")
if (module != null) {
append("imports[${module.toJsStringLiteral()}]")
if (qualifier != null)
append(".")
}
if (qualifier != null) {
append(qualifier)
}
append(";")
}
}.sorted()
.joinToString("\n")
//language=js
return """
export async function instantiate(imports={}, runInitializer=true) {
const cachedJsObjects = new WeakMap();
// ref must be non-null
function getCachedJsObject(ref, ifNotCached) {
if (typeof ref !== 'object' && typeof ref !== 'function') return ifNotCached;
const cached = cachedJsObjects.get(ref);
if (cached !== void 0) return cached;
cachedJsObjects.set(ref, ifNotCached);
return ifNotCached;
}
$referencesToQualifiedAndImportedDeclarations
const js_code = {
$jsCodeBodyIndented
}
// Placed here to give access to it from externals (js_code)
let wasmInstance;
let require;
let wasmExports;
const isNodeJs = (typeof process !== 'undefined') && (process.release.name === 'node');
const isDeno = !isNodeJs && (typeof Deno !== 'undefined')
const isStandaloneJsVM =
!isDeno && !isNodeJs && (
typeof d8 !== 'undefined' // V8
|| typeof inIon !== 'undefined' // SpiderMonkey
|| typeof jscOptions !== 'undefined' // JavaScriptCore
);
const isBrowser = !isNodeJs && !isDeno && !isStandaloneJsVM && (typeof window !== 'undefined' || typeof self !== 'undefined');
if (!isNodeJs && !isDeno && !isStandaloneJsVM && !isBrowser) {
throw "Supported JS engine not detected";
}
const wasmFilePath = ${wasmFilePath.toJsStringLiteral()};
const importObject = {
js_code,
intrinsics: {
${if (useJsTag) "js_error_tag: WebAssembly.JSTag" else ""}
},
$imports
};
try {
if (isNodeJs) {
const module = await import(/* webpackIgnore: true */'node:module');
const importMeta = import.meta;
require = module.default.createRequire(importMeta.url);
const fs = require('fs');
const url = require('url');
const filepath = import.meta.resolve(wasmFilePath);
const wasmBuffer = fs.readFileSync(url.fileURLToPath(filepath));
const wasmModule = new WebAssembly.Module(wasmBuffer);
wasmInstance = new WebAssembly.Instance(wasmModule, importObject);
}
if (isDeno) {
const path = await import(/* webpackIgnore: true */'https://deno.land/std/path/mod.ts');
const binary = Deno.readFileSync(path.fromFileUrl(import.meta.resolve(wasmFilePath)));
const module = await WebAssembly.compile(binary);
wasmInstance = await WebAssembly.instantiate(module, importObject);
}
if (isStandaloneJsVM) {
const wasmBuffer = read(wasmFilePath, 'binary');
const wasmModule = new WebAssembly.Module(wasmBuffer);
wasmInstance = new WebAssembly.Instance(wasmModule, importObject);
}
if (isBrowser) {
wasmInstance = (await WebAssembly.instantiateStreaming(fetch(wasmFilePath), importObject)).instance;
}
} catch (e) {
if (e instanceof WebAssembly.CompileError) {
let text = `Please make sure that your runtime environment supports the latest version of Wasm GC and Exception-Handling proposals.
For more information, see https://kotl.in/wasm-help
`;
if (isBrowser) {
console.error(text);
} else {
const t = "\n" + text;
if (typeof console !== "undefined" && console.log !== void 0)
console.log(t);
else
print(t);
}
}
throw e;
}
wasmExports = wasmInstance.exports;
if (runInitializer) {
wasmExports._initialize();
}
return { instance: wasmInstance, exports: wasmExports };
}
"""
}
fun WasmCompiledModuleFragment.generateEsmExportsWrapper(
asyncWrapperFileName: String,
jsModuleAndQualifierReferences: MutableSet,
useCustomFormatters: Boolean
): String {
val importedModules = jsModuleImports
.map {
val moduleSpecifier = it.toJsStringLiteral().toString()
val importVariableString = JsModuleAndQualifierReference.encode(it)
moduleSpecifier to importVariableString
}
val referencesToImportedDeclarations = jsModuleAndQualifierReferences
.filter { it.module != null }
.map {
val module = it.module!!
val stringLiteral = module.toJsStringLiteral().toString()
stringLiteral to if (it.qualifier != null) {
it.importVariableName
} else {
it.jsVariableName
}
}
val allModules = (importedModules + referencesToImportedDeclarations)
.distinctBy {
it.first
}.sortedBy { it.first }
val importsImportedSection = allModules.joinToString("\n") {
buildString {
append("import * as ")
append(it.second)
append(" from ")
append(it.first)
append(";")
}
}
val imports = allModules.joinToString(",\n") {
" ${it.first}: ${it.second}"
}
/*language=js */
return """
$importsImportedSection
import { instantiate } from ${asyncWrapperFileName.toJsStringLiteral()};
${if (useCustomFormatters) "import \"./custom-formatters.js\"" else ""}
const exports = (await instantiate({
$imports
})).exports;
${generateExports()}
"""
}
fun writeCompilationResult(
result: WasmCompilerResult,
dir: File,
fileNameBase: String,
useDebuggerCustomFormatters: Boolean
) {
dir.mkdirs()
if (result.wat != null) {
File(dir, "$fileNameBase.wat").writeText(result.wat)
}
File(dir, "$fileNameBase.wasm").writeBytes(result.wasm)
if (result.jsUninstantiatedWrapper != null) {
File(dir, "$fileNameBase.uninstantiated.mjs").writeText(result.jsUninstantiatedWrapper)
}
File(dir, "$fileNameBase.mjs").writeText(result.jsWrapper)
result.debugInformation?.sourceMapForBinary?.let {
File(dir, "$fileNameBase.wasm.map").writeText(it)
}
result.debugInformation?.sourceMapForText?.let {
File(dir, "$fileNameBase.wat.map").writeText(it)
}
if (useDebuggerCustomFormatters) {
val fileName = "custom-formatters.js"
val systemClassLoader = ClassLoader.getSystemClassLoader()
val customFormattersInputStream = systemClassLoader.getResourceAsStream(fileName)
Files.copy(customFormattersInputStream, Paths.get(dir.path, fileName), StandardCopyOption.REPLACE_EXISTING)
}
if (result.dts != null) {
File(dir, "$fileNameBase.d.ts").writeText(result.dts)
}
}
fun WasmCompiledModuleFragment.generateExports(): String {
// TODO: necessary to move export check onto common place
val exportNames = exports
.filterNot { it.name.startsWith(JsInteropFunctionsLowering.CALL_FUNCTION) }
.ifNotEmpty {
joinToString(",\n") {
" ${it.name}"
}
}?.let {
"""
|const {
|$it
|}
""".trimMargin()
}
/*language=js */
return """
${exportNames?.let { "export $it = exports;" }}
"""
}