Add rustc MIR output view#2795

junlarsen · 2021-07-20T18:49:16Z

Adds a new pane and processor for generating and showing Rust's MIR. This is my first time hacking on the front end. Let me know if there's anything that's missing.

I do not have any tests for this at the moment. I would appreciate some help in how to set up testing for this.

Fixes #2566

/cc @ojeda

junlarsen · 2021-07-20T18:51:11Z

+        const rustcOptions = [
+            inputFilename,
+            '-o',
+            this.getRustMirOutputFilename(inputFilename),
+            '--emit=mir',
+            '--crate-type',
+            'rlib',
+        ];


We might want to have some way to change these options? I don't know if other compiler options change the MIR so I hard coded them for now.

Got it; I think this is OK for now! So long as if/when we add ways to change it, these are the defaults, so older URLs still work the same way.

junlarsen · 2021-07-20T18:52:22Z

+            const content = await fs.readFile(mirPath, 'utf-8');
+            // TODO: process the output
+            return content.split('\n').map((line) => ({
+                text: line,
+            }));


Could potentially make a member function named processRustMirOutput to override transformation of the source code?

Right - that could make sense.

junlarsen · 2021-07-20T18:52:47Z

    constructor(info, env) {
        super(info, env);
        this.compiler.supportsIrView = false;
+        this.compiler.supportsRustMirView = false;


Does this work? I don't have rustc-cg-gcc locally so I was unable to test.

@dkm may know about this.

I should try it, but I don't see why it would not work, this "compiler" is only changing the backend, so MIR output should work correctly. I'll try this now and let you know!

As expected, it works fine, so you can revert this change :)

Okay, re-enabled it. Thank you for checking!

junlarsen · 2021-07-20T18:57:28Z

-          button.dropdown-item.btn.btn-sm.btn-light.view-ir(title="Show IR output")
+          button.dropdown-item.btn.btn-sm.btn-light.view-ir(title="Show LLVM IR output")
            span.dropdown-icon.fas.fa-align-center
-            | IR output
+            | LLVM IR output


Thoughts on renaming this tab item to LLVM IR to indicate that it's specifically the LLVM IR? This list will probably get crowded with other compilers' IR representations further down the road. @ojeda mentions this in #2565

I think being explicit is usually a positive -- and it is not too much text, so I guess it does not take too much space, no?

Nearly all items in this dropdown menu are compiler specific. I remember mentioning this to @RubenRBS with the idea of hiding items not compatible with currently selected compiler but there was something against it. The same renaming should be done to AST (llvm), optim output (llvm) and graph output (gcc).

So! My initial idea was to add subdropdowns or categorize the panes better, but that's more trouble than it's worth.
I thought it would be a bit tricky to add compatibility checks for all panes for every compiler, but we already do it! That's how we know when to disable to button itself, so the initial idea of hiding the buttons altoghether sounds good now.

So, what we can do is to merge this, and find a way to only show the supported panes instead of disabling them (Might not be as easy as substituting .prop('disabled', ...) by .toggle(...), but I might also be wrong)

I'm happy to worry about this in a follow up PR: as Rubén's has suggested

ojeda · 2021-07-21T09:19:37Z

Thanks a lot for working on this!

mattgodbolt

LGTM! Thanks so much!

mattgodbolt · 2021-07-24T14:13:31Z

+        const rustcOptions = [
+            inputFilename,
+            '-o',
+            this.getRustMirOutputFilename(inputFilename),
+            '--emit=mir',
+            '--crate-type',
+            'rlib',
+        ];


Got it; I think this is OK for now! So long as if/when we add ways to change it, these are the defaults, so older URLs still work the same way.

mattgodbolt · 2021-07-24T14:13:59Z

+        const mirPath = this.getRustMirOutputFilename(inputFilename);
+        if (await fs.exists(mirPath)) {
+            const content = await fs.readFile(mirPath, 'utf-8');
+            // TODO: process the output


What processing is needed?

mattgodbolt · 2021-07-24T14:14:59Z

+            const content = await fs.readFile(mirPath, 'utf-8');
+            // TODO: process the output
+            return content.split('\n').map((line) => ({
+                text: line,
+            }));


Right - that could make sense.

mattgodbolt · 2021-07-24T14:15:52Z

        };
    }

+    async generateRustMir(inputFilename) {


It's a bit unfortunate we have to put this in base-compiler, but then the alternative is to have a complex hierarchy of things... I think this is fine for now: we'll think about breaking this up another time.

mattgodbolt · 2021-07-24T14:19:28Z

-          button.dropdown-item.btn.btn-sm.btn-light.view-ir(title="Show IR output")
+          button.dropdown-item.btn.btn-sm.btn-light.view-ir(title="Show LLVM IR output")
            span.dropdown-icon.fas.fa-align-center
-            | IR output
+            | LLVM IR output


I'm happy to worry about this in a follow up PR: as Rubén's has suggested

mattgodbolt · 2021-07-24T20:36:11Z

This is live! Thanks again @supergrecko and ... re: tests...we are in a sorry state for this kind of front end testing, so - there aren't any so far. Me clicking about randomly in the staging before we deploy is the very poor setup...

* Add Rustc MIR representation view * Enable MIR view for rust-cg-gcc

github-actions bot added lang-rust ui labels Jul 20, 2021

junlarsen commented Jul 20, 2021

View reviewed changes

AbrilRBS approved these changes Jul 23, 2021

View reviewed changes

junlarsen mentioned this pull request Jul 23, 2021

Hide panes that are not supported by a compiler #2804

Merged

junlarsen added 2 commits July 24, 2021 16:21

Add Rustc MIR representation view

fd38e19

Enable MIR view for rust-cg-gcc

c3ebeb6

mattgodbolt approved these changes Jul 24, 2021

View reviewed changes

mattgodbolt merged commit aa431e1 into compiler-explorer:main Jul 24, 2021

junlarsen mentioned this pull request Jul 24, 2021

Fix Rust MIR button bug and remove invalid todo line #2806

Merged

mattgodbolt pushed a commit that referenced this pull request Aug 2, 2021

Add rustc MIR output view (#2795)

b44b94b

* Add Rustc MIR representation view * Enable MIR view for rust-cg-gcc

junlarsen mentioned this pull request Sep 26, 2021

[REQUEST] LLVM IR output for Rust #2565

Closed

ojeda mentioned this pull request Jan 6, 2023

Compiler Explorer wanted features & bugfixes Rust-for-Linux/linux#949

Open

21 tasks

Uh oh!

Conversation

junlarsen commented Jul 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ojeda Jul 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AbrilRBS Jul 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ojeda commented Jul 21, 2021

Uh oh!

mattgodbolt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattgodbolt commented Jul 24, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

junlarsen commented Jul 20, 2021 •

edited

Loading

ojeda Jul 21, 2021 •

edited

Loading

AbrilRBS Jul 23, 2021 •

edited

Loading