From a4d093afa14b7a324d5faaca47b5fbc304d7c542 Mon Sep 17 00:00:00 2001 From: Irmen de Jong Date: Wed, 2 Aug 2023 21:26:40 +0200 Subject: [PATCH] added -sourcelines cli option to include src lines in generated assembly (which is now off by default) --- .../src/prog8/code/core/CompilationOptions.kt | 1 + .../src/prog8/codegen/cpu6502/AsmGen.kt | 2 +- .../codegen/intermediate/AssignmentGen.kt | 8 ++++++-- .../prog8/codegen/intermediate/IRCodeGen.kt | 2 ++ .../intermediate/IRPeepholeOptimizer.kt | 7 ++++++- compiler/src/prog8/CompilerMain.kt | 5 ++++- compiler/src/prog8/compiler/Compiler.kt | 2 ++ compiler/test/TestCompilerOnExamples.kt | 1 + compiler/test/TestCompilerOptionLibdirs.kt | 1 + compiler/test/helpers/compileXyz.kt | 1 + docs/source/compiling.rst | 5 +++++ docs/source/todo.rst | 2 -- .../src/prog8/http/TestHttp.kt | 1 + .../src/prog8/intermediate/IRFileReader.kt | 5 +++++ .../src/prog8/intermediate/IRFileWriter.kt | 19 +++++++++++++++++++ .../src/prog8/intermediate/IRProgram.kt | 11 +++++++++++ 16 files changed, 66 insertions(+), 7 deletions(-) diff --git a/codeCore/src/prog8/code/core/CompilationOptions.kt b/codeCore/src/prog8/code/core/CompilationOptions.kt index 7d1719922..bda16934e 100644 --- a/codeCore/src/prog8/code/core/CompilationOptions.kt +++ b/codeCore/src/prog8/code/core/CompilationOptions.kt @@ -16,6 +16,7 @@ class CompilationOptions(val output: OutputType, var optimize: Boolean = false, var asmQuiet: Boolean = false, var asmListfile: Boolean = false, + var includeSourcelines: Boolean = false, var experimentalCodegen: Boolean = false, var varsHighBank: Int? = null, var splitWordArrays: Boolean = false, diff --git a/codeGenCpu6502/src/prog8/codegen/cpu6502/AsmGen.kt b/codeGenCpu6502/src/prog8/codegen/cpu6502/AsmGen.kt index 6f1d1784e..ff6905d0b 100644 --- a/codeGenCpu6502/src/prog8/codegen/cpu6502/AsmGen.kt +++ b/codeGenCpu6502/src/prog8/codegen/cpu6502/AsmGen.kt @@ -239,7 +239,7 @@ class AsmGen6502Internal ( internal fun isTargetCpu(cpu: CpuType) = options.compTarget.machine.cpu == cpu internal fun outputSourceLine(node: PtNode) { - if(node.position===Position.DUMMY) + if(!options.includeSourcelines || node.position===Position.DUMMY) return val srcComment = "\t; source: ${node.position.file}:${node.position.line}" val line = SourceLineCache.retrieveLine(node.position) diff --git a/codeGenIntermediate/src/prog8/codegen/intermediate/AssignmentGen.kt b/codeGenIntermediate/src/prog8/codegen/intermediate/AssignmentGen.kt index 92d8fbaf8..f44b53965 100644 --- a/codeGenIntermediate/src/prog8/codegen/intermediate/AssignmentGen.kt +++ b/codeGenIntermediate/src/prog8/codegen/intermediate/AssignmentGen.kt @@ -13,7 +13,9 @@ internal class AssignmentGen(private val codeGen: IRCodeGen, private val express if(assignment.target.children.single() is PtMachineRegister) throw AssemblyError("assigning to a register should be done by just evaluating the expression into resultregister") - return translateRegularAssign(assignment) + val chunks = translateRegularAssign(assignment) + chunks.filterIsInstance().firstOrNull()?.appendSrcPosition(assignment.position) + return chunks } internal fun translate(augAssign: PtAugmentedAssign): IRCodeChunks { @@ -24,7 +26,7 @@ internal class AssignmentGen(private val codeGen: IRCodeGen, private val express val memory = augAssign.target.memory val array = augAssign.target.array - return if(ident!=null) { + val chunks = if(ident!=null) { assignVarAugmented(ident.name, augAssign) } else if(memory != null) { if(memory.address is PtNumber) @@ -39,6 +41,8 @@ internal class AssignmentGen(private val codeGen: IRCodeGen, private val express } else { fallbackAssign(augAssign) } + chunks.filterIsInstance().firstOrNull()?.appendSrcPosition(augAssign.position) + return chunks } private fun assignMemoryAugmented( diff --git a/codeGenIntermediate/src/prog8/codegen/intermediate/IRCodeGen.kt b/codeGenIntermediate/src/prog8/codegen/intermediate/IRCodeGen.kt index c69a9b9d3..da0782ded 100644 --- a/codeGenIntermediate/src/prog8/codegen/intermediate/IRCodeGen.kt +++ b/codeGenIntermediate/src/prog8/codegen/intermediate/IRCodeGen.kt @@ -289,6 +289,8 @@ class IRCodeGen( } } + chunks.filterIsInstance().firstOrNull()?.appendSrcPosition(node.position) + return chunks } diff --git a/codeGenIntermediate/src/prog8/codegen/intermediate/IRPeepholeOptimizer.kt b/codeGenIntermediate/src/prog8/codegen/intermediate/IRPeepholeOptimizer.kt index aaf9f67a3..c6ae1784f 100644 --- a/codeGenIntermediate/src/prog8/codegen/intermediate/IRPeepholeOptimizer.kt +++ b/codeGenIntermediate/src/prog8/codegen/intermediate/IRPeepholeOptimizer.kt @@ -105,7 +105,10 @@ class IRPeepholeOptimizer(private val irprog: IRProgram) { relabelChunks.forEach { (index, label) -> val chunk = IRCodeChunk(label, null) - chunk.instructions += sub.chunks[index].instructions + val subChunk = sub.chunks[index] + chunk.instructions += subChunk.instructions + if(subChunk is IRCodeChunk) + chunk.appendSrcPositions(subChunk.sourceLinesPositions) sub.chunks[index] = chunk } removeChunks.reversed().forEach { index -> sub.chunks.removeAt(index) } @@ -140,6 +143,8 @@ class IRPeepholeOptimizer(private val irprog: IRProgram) { if(mayJoinCodeChunks(lastChunk, candidate)) { lastChunk.instructions += candidate.instructions lastChunk.next = candidate.next + if(lastChunk is IRCodeChunk) + lastChunk.appendSrcPositions(candidate.sourceLinesPositions) } else chunks += candidate diff --git a/compiler/src/prog8/CompilerMain.kt b/compiler/src/prog8/CompilerMain.kt index 396ff4496..1376166c8 100644 --- a/compiler/src/prog8/CompilerMain.kt +++ b/compiler/src/prog8/CompilerMain.kt @@ -46,11 +46,12 @@ private fun compileMain(args: Array): Boolean { val outputDir by cli.option(ArgType.String, fullName = "out", description = "directory for output files instead of current directory").default(".") val quietAssembler by cli.option(ArgType.Boolean, fullName = "quietasm", description = "don't print assembler output results") val sourceDirs by cli.option(ArgType.String, fullName="srcdirs", description = "list of extra paths, separated with ${File.pathSeparator}, to search in for imported modules").multiple().delimiter(File.pathSeparator) + val includeSourcelines by cli.option(ArgType.Boolean, fullName = "sourcelines", description = "include original Prog8 source lines in generated asm code") + val splitWordArrays by cli.option(ArgType.Boolean, fullName = "splitarrays", description = "treat all word arrays as tagged with @split to make them lsb/msb split in memory") val compilationTarget by cli.option(ArgType.String, fullName = "target", description = "target output of the compiler (one of '${C64Target.NAME}', '${C128Target.NAME}', '${Cx16Target.NAME}', '${AtariTarget.NAME}', '${VMTarget.NAME}') (required)") val startVm by cli.option(ArgType.Boolean, fullName = "vm", description = "load and run a .p8ir IR source file in the VM") val watchMode by cli.option(ArgType.Boolean, fullName = "watch", description = "continuous compilation mode (watch for file changes)") val varsHighBank by cli.option(ArgType.Int, fullName = "varshigh", description = "put uninitialized variables in high memory area instead of at the end of the program. On the cx16 target the value specifies the HiRAM bank (0=keep active), on other systems it is ignored.") - val splitWordArrays by cli.option(ArgType.Boolean, fullName = "splitarrays", description = "treat all word arrays as tagged with @split to make them lsb/msb split in memory") val moduleFiles by cli.argument(ArgType.String, fullName = "modules", description = "main module file(s) to compile").multiple(999) try { @@ -114,6 +115,7 @@ private fun compileMain(args: Array): Boolean { dontWriteAssembly != true, quietAssembler == true, asmListfile == true, + includeSourcelines == true, experimentalCodegen == true, varsHighBank, compilationTarget!!, @@ -180,6 +182,7 @@ private fun compileMain(args: Array): Boolean { dontWriteAssembly != true, quietAssembler == true, asmListfile == true, + includeSourcelines == true, experimentalCodegen == true, varsHighBank, compilationTarget!!, diff --git a/compiler/src/prog8/compiler/Compiler.kt b/compiler/src/prog8/compiler/Compiler.kt index 5373802dd..bf54f0c5a 100644 --- a/compiler/src/prog8/compiler/Compiler.kt +++ b/compiler/src/prog8/compiler/Compiler.kt @@ -32,6 +32,7 @@ class CompilerArguments(val filepath: Path, val writeAssembly: Boolean, val quietAssembler: Boolean, val asmListfile: Boolean, + val includeSourcelines: Boolean, val experimentalCodegen: Boolean, val varsHighBank: Int?, val compilationTarget: String, @@ -68,6 +69,7 @@ fun compileProgram(args: CompilerArguments): CompilationResult? { optimize = args.optimize asmQuiet = args.quietAssembler asmListfile = args.asmListfile + includeSourcelines = args.includeSourcelines experimentalCodegen = args.experimentalCodegen varsHighBank = args.varsHighBank splitWordArrays = args.splitWordArrays diff --git a/compiler/test/TestCompilerOnExamples.kt b/compiler/test/TestCompilerOnExamples.kt index 09a3f8b0a..60b15c4bb 100644 --- a/compiler/test/TestCompilerOnExamples.kt +++ b/compiler/test/TestCompilerOnExamples.kt @@ -29,6 +29,7 @@ private fun compileTheThing(filepath: Path, optimize: Boolean, target: ICompilat writeAssembly = true, quietAssembler = true, asmListfile = false, + includeSourcelines = false, experimentalCodegen = false, varsHighBank = null, compilationTarget = target.name, diff --git a/compiler/test/TestCompilerOptionLibdirs.kt b/compiler/test/TestCompilerOptionLibdirs.kt index 020323237..d38241b04 100644 --- a/compiler/test/TestCompilerOptionLibdirs.kt +++ b/compiler/test/TestCompilerOptionLibdirs.kt @@ -46,6 +46,7 @@ class TestCompilerOptionSourcedirs: FunSpec({ writeAssembly = true, quietAssembler = true, asmListfile = false, + includeSourcelines = false, experimentalCodegen = false, varsHighBank = null, compilationTarget = Cx16Target.NAME, diff --git a/compiler/test/helpers/compileXyz.kt b/compiler/test/helpers/compileXyz.kt index 16010c595..a01401bff 100644 --- a/compiler/test/helpers/compileXyz.kt +++ b/compiler/test/helpers/compileXyz.kt @@ -26,6 +26,7 @@ internal fun compileFile( writeAssembly = writeAssembly, quietAssembler = true, asmListfile = false, + includeSourcelines = false, experimentalCodegen = false, varsHighBank = null, platform.name, diff --git a/docs/source/compiling.rst b/docs/source/compiling.rst index ba2f4a065..fb7668e2e 100644 --- a/docs/source/compiling.rst +++ b/docs/source/compiling.rst @@ -160,6 +160,11 @@ One or more .p8 module files ``-expericodegen`` Use experimental code generation backend (*incomplete*). +``-sourcelines`` + Also include the original prog8 source code lines as comments in the generated assembly code file, + mixed in between the actual generated assembly code. + This can be useful for debugging purposes to see what assembly was generated for what prog8 source code. + ``-splitarrays`` Treat all word arrays as tagged with @split so they are all lsb/msb split into memory. This removes the need to add @split yourself but some programs may fail to compile with diff --git a/docs/source/todo.rst b/docs/source/todo.rst index c11fbfaac..398324b66 100644 --- a/docs/source/todo.rst +++ b/docs/source/todo.rst @@ -1,8 +1,6 @@ TODO ==== -- add command line option to enable/disable the inclusion of p8 source lines into the generated assembly / p8ir see outputSourceLine() -- add a mechanism to pass the original p8 source lines into the p8ir file as comments. Remove the position xml tags. - try to reduce the number of uses of temp variables for example in array[idx] -= amount / - investigate McCarthy evaluation again? this may also reduce code size perhaps for things like if a>4 or a<2 .... / - investigate McCarthy evaluation again? this may also reduce code size perhaps for things like if a>4 or a<2 .... diff --git a/httpCompilerService/src/prog8/http/TestHttp.kt b/httpCompilerService/src/prog8/http/TestHttp.kt index 15265fd1c..8e43851ea 100644 --- a/httpCompilerService/src/prog8/http/TestHttp.kt +++ b/httpCompilerService/src/prog8/http/TestHttp.kt @@ -37,6 +37,7 @@ class RequestParser : Take { compilationTarget = "c64", symbolDefs = emptyMap(), quietAssembler = false, + includeSourcelines = false, asmListfile = false, experimentalCodegen = false, splitWordArrays = false, diff --git a/intermediate/src/prog8/intermediate/IRFileReader.kt b/intermediate/src/prog8/intermediate/IRFileReader.kt index 3777b6f6e..ce7e060e6 100644 --- a/intermediate/src/prog8/intermediate/IRFileReader.kt +++ b/intermediate/src/prog8/intermediate/IRFileReader.kt @@ -294,6 +294,11 @@ class IRFileReader { skipText(reader) val start = reader.nextEvent().asStartElement() require(start.name.localPart=="CODE") { "missing CODE" } + val next = reader.peek() + if(next.isStartElement && next.asStartElement().name.localPart=="P8SRC") { + reader.nextEvent() // skip the P8SRC node + while(!reader.nextEvent().isEndElement) { /* skip until end of P8SRC node */ } + } val label = start.attributes.asSequence().singleOrNull { it.name.localPart == "LABEL" }?.value?.ifBlank { null } val text = readText(reader).trim() val chunk = IRCodeChunk(label, null) diff --git a/intermediate/src/prog8/intermediate/IRFileWriter.kt b/intermediate/src/prog8/intermediate/IRFileWriter.kt index 122a43608..0a9494a1c 100644 --- a/intermediate/src/prog8/intermediate/IRFileWriter.kt +++ b/intermediate/src/prog8/intermediate/IRFileWriter.kt @@ -3,6 +3,7 @@ package prog8.intermediate import prog8.code.core.* import java.nio.file.Path import javax.xml.stream.XMLOutputFactory +import javax.xml.stream.XMLStreamWriter import kotlin.io.path.bufferedWriter import kotlin.io.path.div @@ -126,6 +127,7 @@ class IRFileWriter(private val irProgram: IRProgram, outfileOverride: Path?) { xml.writeStartElement("CODE") chunk.label?.let { xml.writeAttribute("LABEL", chunk.label) } // xml.writeAttribute("used-registers", chunk.usedRegisters().toString()) + writeSourcelines(xml, chunk) xml.writeCharacters("\n") chunk.instructions.forEach { instr -> numInstr++ @@ -136,6 +138,23 @@ class IRFileWriter(private val irProgram: IRProgram, outfileOverride: Path?) { xml.writeCharacters("\n") } + private fun writeSourcelines(xml: XMLStreamWriter, code: IRCodeChunk) { + if(irProgram.options.includeSourcelines) { + if(code.sourceLinesPositions.any {it !== Position.DUMMY}) { + xml.writeStartElement("P8SRC") + var sourceTxt = StringBuilder("\n") + code.sourceLinesPositions.forEach { pos -> + val line = SourceLineCache.retrieveLine(pos) + if(line!=null) { + sourceTxt.append("$pos $line\n") + } + } + xml.writeCData(sourceTxt.toString()) + xml.writeEndElement() + } + } + } + private fun writeInlineBytes(chunk: IRInlineBinaryChunk) { xml.writeStartElement("BYTES") chunk.label?.let { xml.writeAttribute("LABEL", chunk.label) } diff --git a/intermediate/src/prog8/intermediate/IRProgram.kt b/intermediate/src/prog8/intermediate/IRProgram.kt index 2a496e57a..778020328 100644 --- a/intermediate/src/prog8/intermediate/IRProgram.kt +++ b/intermediate/src/prog8/intermediate/IRProgram.kt @@ -447,6 +447,17 @@ class IRCodeChunk(label: String?, next: IRCodeChunkBase?): IRCodeChunkBase(label operator fun plusAssign(chunk: IRCodeChunkBase) { instructions.addAll(chunk.instructions) } + + fun appendSrcPosition(position: Position) { + if(sourceLinesPositions.lastOrNull()!=position) + sourceLinesPositions.add(position) + } + + fun appendSrcPositions(positions: Collection) { + positions.forEach { appendSrcPosition(it) } + } + + val sourceLinesPositions = mutableListOf() } class IRInlineAsmChunk(label: String?,