Ghidra decompiler #2705

nimashoghi · 2021-06-05T01:55:02Z

No description provided.

mattgodbolt · 2021-06-09T22:44:07Z

Thanks for this! Will take a look in a while: sorry it's already been 5 days. (I'm on vacation for another week or so, but maybe someone else can take a look too)

AbrilRBS

Sorry about the radio silence

AbrilRBS · 2021-07-06T03:23:22Z

lib/tooling/_all.js

 export { LLVMMcaTool } from './llvm-mca-tool';
 export { OSACATool } from './osaca-tool';
 export { PaholeTool } from './pahole-tool';
 export { PvsStudioTool } from './pvs-studio-tool';
 export { ReadElfTool } from './readelf-tool';
 export { StringsTool } from './strings-tool';
-export { x86to6502Tool } from './x86to6502-tool';
+export { x86to6502Tool } from './x86to6502-tool';


Suggested change

export { x86to6502Tool } from './x86to6502-tool';

export { x86to6502Tool } from './x86to6502-tool';

AbrilRBS · 2021-07-06T03:23:32Z

lib/tooling/ghidra.js

@@ -0,0 +1,167 @@
+// Copyright (c) 2020, Compiler Explorer Authors


Suggested change

// Copyright (c) 2020, Compiler Explorer Authors

// Copyright (c) 2021, Compiler Explorer Authors

AbrilRBS · 2021-07-06T03:23:39Z

lib/tooling/ghidra.js

+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+// import {spawn} from "child_process"


Suggested change

// import {spawn} from "child_process"

AbrilRBS · 2021-07-06T03:24:01Z

lib/tooling/ghidra.js

+// const _demange = async (buffer) =>
+//     await new Promise((resolve, reject) => {
+//         const child = spawn("c++filt", ["--no-params"])
+//         child.on("error", (error) => reject(error))
+
+//         const bufs = []
+//         child.stdout.on("data", (chunk) => bufs.push(chunk))
+//         child.stdout.on("end", () => resolve(Buffer.concat(bufs)))
+
+//         child.stdin.write(buffer)
+//         child.stdin.end()
+//     })


Suggested change

// const _demange = async (buffer) =>

// await new Promise((resolve, reject) => {

// const child = spawn("c++filt", ["--no-params"])

// child.on("error", (error) => reject(error))

// const bufs = []

// child.stdout.on("data", (chunk) => bufs.push(chunk))

// child.stdout.on("end", () => resolve(Buffer.concat(bufs)))

// child.stdin.write(buffer)

// child.stdin.end()

// })

AbrilRBS · 2021-07-06T03:24:26Z

lib/tooling/ghidra.js

+        // const startLineIndex = result.stdout.findIndex(
+        //     (line) => line.text.trim() === START_INDICATOR,
+        // )
+        // const endLineIndex = result.stdout.findIndex(
+        //     (line) => line.text.trim() === END_INDICATOR,
+        // )
+        // if (startLineIndex !== -1 && endLineIndex !== -1) {
+        //     result.stdout = result.stdout.slice(
+        //         startLineIndex + 1,
+        //         endLineIndex,
+        //     )
+        // }
+
+        // const exeDir = path.dirname(this.tool.exe)
+        // const output = await _demange(
+        //     result.stdout.map((line) => line.text).join("\n"),
+        // )
+        // result.stdout = utils.parseOutput(
+        //     output.toString("utf-8"),
+        //     compilationInfo.executableFilename,
+        //     exeDir,
+        // )


Suggested change

// const startLineIndex = result.stdout.findIndex(

// (line) => line.text.trim() === START_INDICATOR,

// )

// const endLineIndex = result.stdout.findIndex(

// (line) => line.text.trim() === END_INDICATOR,

// )

// if (startLineIndex !== -1 && endLineIndex !== -1) {

// result.stdout = result.stdout.slice(

// startLineIndex + 1,

// endLineIndex,

// )

// }

// const exeDir = path.dirname(this.tool.exe)

// const output = await _demange(

// result.stdout.map((line) => line.text).join("\n"),

// )

// result.stdout = utils.parseOutput(

// output.toString("utf-8"),

// compilationInfo.executableFilename,

// exeDir,

// )

mattgodbolt · 2021-07-06T12:57:10Z

This looks like a great start, but as @RubenRBS has pointed out there's a few minor things to look at. From the amount of commented-out code it seems incomplete? Is this the case? Is there anything we need to know about to get this merged in, known limitations or similar?

nimashoghi · 2021-07-06T15:02:52Z

First of all, thanks for the review @RubenRBS! I appreciate the comments.

@mattgodbolt, yes, you are correct that this implementation is incomplete and needs to be adjusted.

My primary limitation in implementing this is my lack of experience with the compiler explorer codebase, but with the implementation I have committed, the limitations are:

Ghidra's decompiler must be installed beforehands.
Ghidra's decompiler needs SLEIGH (instruction set description) files that need to be downloaded, and the SLEIGHHOME environment variable must point to this installation path.
The decompiler tooling only works on binary outputs.
Compiler explorer's built-in name demangling must be disabled. This means that Ghidra's output will also have demangled names.

My remaining tasks on this were:

Figuring out how Compiler Explorer installs these different applications and making sure Ghidra's decompiler is installed properly. This would also involve making sure that Ghidra has the right SLEIGH (instruction set descriptions) installed for the instruction sets that it would be used on. This is due to limitations # 1 and # 2 above.
(Less important) Using c++filt to demangle Ghidra's output symbols for functions. This is due to limitation # 4 described above. The commented code was for this demangler. I wanted to put behind some sort of a flag/setting, but I did not have the time to figure out how this is done with the Compiler Explorer's tooling API.

Finally, I have been a bit busy the past two weeks, but I will review these tasks, as well as @RubenRBS' comments and will push my changes accordingly. Please let me know if you have any comments or suggestions.

mattgodbolt · 2021-07-06T17:25:24Z

Thanks @nimashoghi ! That's great. We can definitely help with 1. and 2. - there is a separate repo for installation and set up of apps etc. 3. is a bit of an issue but we have a number of tools that mandate "binary only", so it wouldn't be the first. 4. is something we can work on.

Thank you! We're here to help when you have time.

…r tooling usage (when demangling is enabled).

…e user has demangling enabled. Added comments to the code for the Ghidra tooling.

nimashoghi · 2021-07-19T20:56:35Z

Ok, I have updated my code, which takes care of limitation #4.

I have also created a PR in the misc-builder repository which takes care of limitations #1 and #2.

Feel free to review everything and provide any feedback that you have.

I have also updated the tooling pane code to allow for word wrapping even if we're using the monaco editor as the output editor type. Previously, the word wrapping toggle button would be disabled in this case.

mattgodbolt · 2022-04-26T13:13:20Z

Hi there! Sorry this went stale for so long. I'm trying to pick up the pieces here. The PR to misc-builder is still a draft: as far as I can tell this PR is blocked on that. I'll take a look there now.

mattgodbolt · 2022-08-15T23:18:13Z

We seem to have stalled on this. I would like to get support but with https://dogbolt.org/ around I wonder if the need has reduced? I mean, taking source and compiling then decompiling is still valuable, which dogbolt doesn't do... so ... maybe still worth looking in to.

mattgodbolt · 2022-09-26T01:14:29Z

Ok - I would love to have this but I'm going to close this. I'd be delighted to reopen. Ghidfra would be great, but this PR is a long way behind main these days, and we're moving more and more to typescript, which will make things worse.

Added basic code for running ghidra disassembler

93f996a

github-actions bot added the lang-c++ label Jun 5, 2021

nimashoghi mentioned this pull request Jun 5, 2021

Investigate adding GHIDRA tooling #1340

Open

AbrilRBS requested changes Jul 6, 2021

View reviewed changes

nimashoghi added 3 commits July 19, 2021 18:57

Update the tooling pane to support line wrapping for monaco editors

4019e75

Updates the base compiler's objdump to retain the mangled assembly fo…

f30f009

…r tooling usage (when demangling is enabled).

Updated the Ghidra tooling to automatically demangle its output if th…

431f700

…e user has demangling enabled. Added comments to the code for the Ghidra tooling.

github-actions bot added the ui label Jul 19, 2021

Updated SLEIGHHOME

c224f05

nimashoghi mentioned this pull request Jul 19, 2021

Added ghidra build script compiler-explorer/misc-builder#11

Draft

mattgodbolt closed this Sep 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ghidra decompiler #2705

Ghidra decompiler #2705

nimashoghi commented Jun 5, 2021

mattgodbolt commented Jun 9, 2021

AbrilRBS left a comment

AbrilRBS Jul 6, 2021

AbrilRBS Jul 6, 2021

AbrilRBS Jul 6, 2021

AbrilRBS Jul 6, 2021

AbrilRBS Jul 6, 2021

mattgodbolt commented Jul 6, 2021

nimashoghi commented Jul 6, 2021

mattgodbolt commented Jul 6, 2021

nimashoghi commented Jul 19, 2021 •

edited

Loading

mattgodbolt commented Apr 26, 2022

mattgodbolt commented Aug 15, 2022

mattgodbolt commented Sep 26, 2022

	export { x86to6502Tool } from './x86to6502-tool';
	export { x86to6502Tool } from './x86to6502-tool';

		@@ -0,0 +1,167 @@
		// Copyright (c) 2020, Compiler Explorer Authors

	// Copyright (c) 2020, Compiler Explorer Authors
	// Copyright (c) 2021, Compiler Explorer Authors

Ghidra decompiler #2705

Ghidra decompiler #2705

Conversation

nimashoghi commented Jun 5, 2021

mattgodbolt commented Jun 9, 2021

AbrilRBS left a comment

Choose a reason for hiding this comment

AbrilRBS Jul 6, 2021

Choose a reason for hiding this comment

AbrilRBS Jul 6, 2021

Choose a reason for hiding this comment

AbrilRBS Jul 6, 2021

Choose a reason for hiding this comment

AbrilRBS Jul 6, 2021

Choose a reason for hiding this comment

AbrilRBS Jul 6, 2021

Choose a reason for hiding this comment

mattgodbolt commented Jul 6, 2021

nimashoghi commented Jul 6, 2021

mattgodbolt commented Jul 6, 2021

nimashoghi commented Jul 19, 2021 • edited Loading

mattgodbolt commented Apr 26, 2022

mattgodbolt commented Aug 15, 2022

mattgodbolt commented Sep 26, 2022

nimashoghi commented Jul 19, 2021 •

edited

Loading