Fix GDB pretty-printer for tuples and pointers #42278

gentoo90 · 2017-05-28T09:28:32Z

Names of children should not be the same, because GDB uses them to distinguish the children.

Before	After

main.rs

enum Test {
    Zero,
    One(i32),
    Two(i32, String),
    Three(i32, String, Vec<String>),
}

fn main() {
    let tuple = (1, 2, "Asdfgh");
    let zero = Test::Zero;
    let one = Test::One(10);
    let two = Test::Two(42, "Qwerty".to_owned());
    let three = Test::Three(9000,
                            "Zxcvbn".to_owned(),
                            vec!["lorem".to_owned(), "ipsum".to_owned(), "dolor".to_owned()]);
    println!(""); // breakpoint here
}

launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "gdb",
            "request": "launch",
            "gdbpath": "rust-gdb",
            "name": "Launch Program",
            "valuesFormatting": "prettyPrinters", //this requires plugin Native Debug >= 0.20.0
            "target": "./target/debug/test_pretty_printers",
            "cwd": "${workspaceRoot}"
        }
    ]
}

Names of children should not be the same, because GDB uses them to distinguish the children.

rust-highfive · 2017-05-28T09:28:46Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

carols10cents · 2017-05-29T13:51:39Z

Thanks for the PR! We’ll periodically check in on it to make sure that @alexcrichton or someone else from the team reviews it soon.

Some pointers values include additional info, so they can't be parsed with int().

gentoo90 · 2017-05-30T08:28:32Z

Fixed exception in pointers parsing

Before	After

Code:

fn main() {
    let opt_s = Some("AAAA");
    let opt_i = Some(42);
    println!(""); // breakpoint here
}

alexcrichton · 2017-05-30T14:12:17Z

r? @michaelwoerister

( knows more about debuginfo and pretty printers than I )

This looks great though!

…ters str() can't handle unicode strings

gentoo90 · 2017-05-30T20:44:20Z

str() failed on things like let opt_s = Some("I \u{2665} Unicode");

michaelwoerister · 2017-05-30T21:07:45Z

Thanks a lot for the PR, @gentoo90! I would be great if you could add test cases to the src/test/debuginfo suite so those fixes don't break again in the future. Let me know if you need any help with that.

gentoo90 · 2017-05-31T07:07:44Z

Hi @michaelwoerister, is there any way to run a single test using the nightly binary build from rustup, without fetching all the submodules or at least without compiling everything in the repository?

michaelwoerister · 2017-05-31T09:49:28Z

You could try ./x.py test --stage 0 src/test/debuginfo. That should spare you as much compiling as possible.

gentoo90 · 2017-05-31T15:47:12Z

Most of the tests are ignored, accept gdb-pretty-struct-and-enums-pre-gdb-7-7.rs. Is this OK? Is this because I don't have lldb installed?

michaelwoerister · 2017-05-31T18:59:41Z

You should not need LLDB for the GDB based tests. I assume this is on Linux? What's the GDB version you are using?

gentoo90 · 2017-05-31T19:05:36Z

Yes, gentoo linux, gdb 7.12

gentoo90 · 2017-05-31T21:33:28Z

I've found another issue while trying to debug bootstrap. When it's built as a part of cargo workspace, it doesn't have info about its source files. So when I set a breakpoint in src/bootstrap/bin/main.rs, gdb says No source file named /home/user/rust/src/bootstrap/bin/main.rs.

But if I remove src/Cargo.toml and build bootstrap with cargo build, the breakpoint works just fine.

michaelwoerister · 2017-06-01T09:25:38Z

Most of the tests are ignored...

I just tested with GDB 7.12 on Ubuntu and tests are not ignored for me. If you remove all *.stamp files from build/x86_64-unknown-linux-gnu/test/debuginfo, are tests still ignored during the first run of x.py test --stage 0 src/test/debuginfo? I get 13 ignored tests in that case, which should be fine.

I've found another issue while trying to debug bootstrap.

Would you mind opening an issue about that?

…ters

gentoo90 · 2017-06-02T15:13:41Z

A proper way to test tuple field names would be

// gdbr-command:interpreter-exec mi2 "-enable-pretty-printing"
// gdbr-check:^done
// gdbr-command:interpreter-exec mi2 "-var-create noPadding8 @ noPadding8"
// gdbr-check:^done,name="noPadding8",numchild="2",value="{...}",type="(i8, u8)",thread-id="1",has_more="0"
// gdbr-command:interpreter-exec mi2 "-var-list-children noPadding8"
// gdbr-check:^done,numchild="2",displayhint="array",children=[child={name="noPadding8.0",exp="0",numchild="0",value="-100",type="i8",thread-id="1"},child={name="noPadding8.1",exp="1",numchild="0",value="100",type="u8",thread-id="1"}],has_more="0"

but -enable-pretty-printing doesn't do anything in batch mode and pretty-printers are not used :(. Looks like a bug in GDB.

Use a class without children() method for printing empty structs. Presence of this method makes GDB's variable objects interface act like if the struct had children.

gentoo90 · 2017-06-02T18:47:42Z

Added separate pretty-printer for empty structs, which prints the struct type instead of {...} in variable objects mode.

Before	After

Testing against variable objects is impossible again without -enable-pretty-printing, and CLI interface has the tests already.

arielb1 · 2017-06-06T11:57:08Z

r? @michaelwoerister

michaelwoerister · 2017-06-06T12:10:43Z

src/test/debuginfo/pretty-std.rs

@@ -38,6 +38,9 @@
 // gdbg-check:$6 = None
 // gdbr-check:$6 = core::option::Option::None

+// gdb-command: print some_string
+// gdbr-check:$7 = Some = {"IAMA optional string!"}


We should try making this gdb-check instead of just gdbr-check, so both kinds of GDB are tested.

michaelwoerister · 2017-06-09T14:50:24Z

Ping @gentoo90, regarding #42278 (comment). Could you make these regular gdb-commands and gdb-checks? Otherwise we'll only test versions of GDB that already support Rust natively, while the pretty printers should also work for older GDB versions.

GDB can be built with Python 2 or with Python 3

gentoo90 · 2017-06-09T16:11:45Z

Sorry for delay.

older GDB versions

ahh, so that's why gdbg-* stuff isn't runned on my system.

michaelwoerister · 2017-06-09T17:07:29Z

Sorry for delay.

No worries. Thanks for continuing to work on this!

ahh, so that's why gdbg-* stuff isn't runned on my system.

Yes, that seems like a likely reason. I'm actually not sure what version of GDB is on our test infrastructure.

michaelwoerister · 2017-06-09T17:07:48Z

@bors r+

Let's give it a try.

bors · 2017-06-09T17:07:49Z

📌 Commit 63076dd has been approved by michaelwoerister

bors · 2017-06-09T18:17:22Z

⌛ Testing commit 63076dd with merge 3d5b8c6...

Fix GDB pretty-printer for tuples and pointers Names of children should not be the same, because GDB uses them to distinguish the children. |Before|After| |---|---| |![tuples_before](https://cloud.githubusercontent.com/assets/1297574/26527639/5d6cf10e-43a0-11e7-9498-abfcddb08055.png)|![tuples_after](https://cloud.githubusercontent.com/assets/1297574/26527655/9699233a-43a0-11e7-83c6-f58f713b51a0.png)| `main.rs` ```rust enum Test { Zero, One(i32), Two(i32, String), Three(i32, String, Vec<String>), } fn main() { let tuple = (1, 2, "Asdfgh"); let zero = Test::Zero; let one = Test::One(10); let two = Test::Two(42, "Qwerty".to_owned()); let three = Test::Three(9000, "Zxcvbn".to_owned(), vec!["lorem".to_owned(), "ipsum".to_owned(), "dolor".to_owned()]); println!(""); // breakpoint here } ``` `launch.json` ```json { "version": "0.2.0", "configurations": [ { "type": "gdb", "request": "launch", "gdbpath": "rust-gdb", "name": "Launch Program", "valuesFormatting": "prettyPrinters", //this requires plugin Native Debug >= 0.20.0 "target": "./target/debug/test_pretty_printers", "cwd": "${workspaceRoot}" } ] } ```

bors · 2017-06-09T23:19:45Z

☀️ Test successful - status-appveyor, status-travis
Approved by: michaelwoerister
Pushing 3d5b8c6 to master...

michaelwoerister · 2017-06-12T08:30:39Z

🎉
Thanks, @gentoo90!

Fix GDB pretty-printer for tuples

ac33d2c

Names of children should not be the same, because GDB uses them to distinguish the children.

rust-highfive assigned alexcrichton May 28, 2017

carols10cents added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 29, 2017

Fix 'invalid literal for int()' exception in pretty-printers

167e4b0

Some pointers values include additional info, so they can't be parsed with int().

gentoo90 force-pushed the gdb-pretty-printers branch from 8de9edb to 167e4b0 Compare May 30, 2017 08:17

gentoo90 changed the title ~~Fix GDB pretty-printer for tuples~~ Fix GDB pretty-printer for tuples and pointers May 30, 2017

rust-highfive assigned michaelwoerister and unassigned alexcrichton May 30, 2017

Fix 'invalid literal for int()' exception with unicode in pretty-prin…

10977bc

…ters str() can't handle unicode strings

gentoo90 added 2 commits June 1, 2017 21:26

Add test for 'invalid literal for int()' exception in gdb pretty-prin…

c7ef85c

…ters

Add GDB pretty-printer for OsString

c1f687b

Add separate GDB pretty-printer for empty structs

b9f9c77

Use a class without children() method for printing empty structs. Presence of this method makes GDB's variable objects interface act like if the struct had children.

michaelwoerister reviewed Jun 6, 2017

View reviewed changes

michaelwoerister added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 9, 2017

gentoo90 added 2 commits June 9, 2017 18:51

Pretty-printers tests: gdbr -> gdb

d7c0d75

Add compat_str() which works with unicode in both Python 2 and 3

63076dd

GDB can be built with Python 2 or with Python 3

bors merged commit 63076dd into rust-lang:master Jun 9, 2017

kennytm mentioned this pull request Aug 7, 2018

Re-enable a bunch of debuginfo tests. #53154

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix GDB pretty-printer for tuples and pointers #42278

Fix GDB pretty-printer for tuples and pointers #42278

gentoo90 commented May 28, 2017

rust-highfive commented May 28, 2017

carols10cents commented May 29, 2017

gentoo90 commented May 30, 2017 •

edited

Loading

alexcrichton commented May 30, 2017

gentoo90 commented May 30, 2017

michaelwoerister commented May 30, 2017

gentoo90 commented May 31, 2017

michaelwoerister commented May 31, 2017

gentoo90 commented May 31, 2017

michaelwoerister commented May 31, 2017

gentoo90 commented May 31, 2017

gentoo90 commented May 31, 2017

michaelwoerister commented Jun 1, 2017

gentoo90 commented Jun 2, 2017 •

edited

Loading

gentoo90 commented Jun 2, 2017

arielb1 commented Jun 6, 2017

michaelwoerister Jun 6, 2017

michaelwoerister commented Jun 9, 2017

gentoo90 commented Jun 9, 2017

michaelwoerister commented Jun 9, 2017

michaelwoerister commented Jun 9, 2017

bors commented Jun 9, 2017

bors commented Jun 9, 2017

bors commented Jun 9, 2017

michaelwoerister commented Jun 12, 2017

Fix GDB pretty-printer for tuples and pointers #42278

Fix GDB pretty-printer for tuples and pointers #42278

Conversation

gentoo90 commented May 28, 2017

rust-highfive commented May 28, 2017

carols10cents commented May 29, 2017

gentoo90 commented May 30, 2017 • edited Loading

alexcrichton commented May 30, 2017

gentoo90 commented May 30, 2017

michaelwoerister commented May 30, 2017

gentoo90 commented May 31, 2017

michaelwoerister commented May 31, 2017

gentoo90 commented May 31, 2017

michaelwoerister commented May 31, 2017

gentoo90 commented May 31, 2017

gentoo90 commented May 31, 2017

michaelwoerister commented Jun 1, 2017

gentoo90 commented Jun 2, 2017 • edited Loading

gentoo90 commented Jun 2, 2017

arielb1 commented Jun 6, 2017

michaelwoerister Jun 6, 2017

Choose a reason for hiding this comment

michaelwoerister commented Jun 9, 2017

gentoo90 commented Jun 9, 2017

michaelwoerister commented Jun 9, 2017

michaelwoerister commented Jun 9, 2017

bors commented Jun 9, 2017

bors commented Jun 9, 2017

bors commented Jun 9, 2017

michaelwoerister commented Jun 12, 2017

gentoo90 commented May 30, 2017 •

edited

Loading

gentoo90 commented Jun 2, 2017 •

edited

Loading