Skip to content

[libc++] Update GDB pretty-printer to work with GDB 17 #142106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 12, 2025

Conversation

kotborealis
Copy link
Contributor

@kotborealis kotborealis commented May 30, 2025

Fixed an issue in libcxx/utils/gdb/libcxx/printers.py.

With gdb 17 (binutils 2_44) pretty-printers do not work anymore because calls to gdb.printing requires import gdb.printing statement, which was missing from the printers.py.

Broken after commit binutils-gdb/fc14343205d3a68db1fc139e4af9796be208fab4, and import gdb.printing was first referenced in binutils-gdb/ee06c79b0fefd5e4ed5e7a1171dc3440130e41da

Fixed an issue in `libcxx/utils/gdb/libcxx/printers.py`.

With gdb 17 (binutils 2_44) pretty-printers do not work anymore because calls to `gdb.printing` require `import gdb.printing` statement, which was missing from the printers.py

Broken after commit bminor/binutils-gdb@fc14343,
and `importgdb.printing` was first referenced in bminor/binutils-gdb@ee06c79
@kotborealis kotborealis requested a review from a team as a code owner May 30, 2025 08:18
Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot llvmbot added the libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi. label May 30, 2025
@llvmbot
Copy link
Member

llvmbot commented May 30, 2025

@llvm/pr-subscribers-libcxx

Author: kotborealis (kotborealis)

Changes

Fixed an issue in libcxx/utils/gdb/libcxx/printers.py.

With gdb 17 (binutils 2_44) pretty-printers do not work anymore because calls to gdb.printing requires import gdb.printing statement, which was missing from the printers.py.

Broken after commit binutils-gdb/fc14343205d3a68db1fc139e4af9796be208fab4, and import gdb.printing was first referenced in binutils-gdb/ee06c79b0fefd5e4ed5e7a1171dc3440130e41da


Full diff: https://github.com/llvm/llvm-project/pull/142106.diff

1 Files Affected:

  • (modified) libcxx/utils/gdb/libcxx/printers.py (+1)
diff --git a/libcxx/utils/gdb/libcxx/printers.py b/libcxx/utils/gdb/libcxx/printers.py
index e3d5d87aca325..90bc54d987ee8 100644
--- a/libcxx/utils/gdb/libcxx/printers.py
+++ b/libcxx/utils/gdb/libcxx/printers.py
@@ -14,6 +14,7 @@
 
 import re
 import gdb
+import gdb.printing
 
 # One under-documented feature of the gdb pretty-printer API
 # is that clients can call any other member of the API

@chestnykh chestnykh self-requested a review May 30, 2025 08:19
Copy link
Contributor

@chestnykh chestnykh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@chestnykh chestnykh requested a review from ldionne May 30, 2025 08:22
@ldionne ldionne changed the title fix: update pretty-printer to work with gdb 17 [libc++] Update GDB pretty-printer to work with GDB 17 Jun 5, 2025
Copy link
Member

@ldionne ldionne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix. LGTM, pending CI.

@chestnykh
Copy link
Contributor

chestnykh commented Jun 5, 2025

The branch was updated to pass CI which had infrastructural errors

@ldionne
Copy link
Member

ldionne commented Jun 6, 2025

The branch was updated to pass CI which had infrastructural errors

Yeah, we're having a lot of infra issues. If it fails again, don't do anything, I'll restart just the jobs that failed.

@chestnykh
Copy link
Contributor

@ldionne could you please rerun 4 failed jobs?

@ldionne
Copy link
Member

ldionne commented Jun 12, 2025

@ldionne could you please rerun 4 failed jobs?

Done. Apologies, our CI is a real pain right now.

@ldionne
Copy link
Member

ldionne commented Jun 12, 2025

Actually, I think this has passed the necessary CI. I'm merging this. Thanks for the fix!

@ldionne ldionne merged commit a53003f into llvm:main Jun 12, 2025
110 of 117 checks passed
Copy link

@kotborealis Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

@kotborealis kotborealis deleted the patch-1 branch June 12, 2025 15:52
tomtor pushed a commit to tomtor/llvm-project that referenced this pull request Jun 14, 2025
This patch fixes an issue in libcxx/utils/gdb/libcxx/printers.py.

With gdb 17 (binutils 2_44) pretty-printers do not work anymore because
calls to `gdb.printing` requires `import gdb.printing` statement, which
was missing from the `printers.py`.

This was broken after commit bminor/binutils-gdb@fc14343205d3a
and `import gdb.printing` was first referenced in bminor/binutils-gdb@ee06c79b0f.

Co-authored-by: Dmitry Chestnykh <[email protected]>
@AngryLoki
Copy link
Contributor

AngryLoki commented Jun 21, 2025

Hi, I experienced a similar issue with GNU gdb (Gentoo 16.3 vanilla) 16.3 + GNU ld (Gentoo 2.44 p4) 2.44.0.
Adding import gdb.printing helped.

So "technically", not GDB 17 issue. Thanks for the fix!

@ldionne , is it possible to cherry-pick this change to LLVM-20?

akuhlens pushed a commit to akuhlens/llvm-project that referenced this pull request Jun 24, 2025
This patch fixes an issue in libcxx/utils/gdb/libcxx/printers.py.

With gdb 17 (binutils 2_44) pretty-printers do not work anymore because
calls to `gdb.printing` requires `import gdb.printing` statement, which
was missing from the `printers.py`.

This was broken after commit bminor/binutils-gdb@fc14343205d3a
and `import gdb.printing` was first referenced in bminor/binutils-gdb@ee06c79b0f.

Co-authored-by: Dmitry Chestnykh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants