Skip to content
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

[Backtracing][Linux] Add Linux support to swift-backtrace. #66337

Merged
merged 12 commits into from Jun 7, 2023

Conversation

al45tair
Copy link
Contributor

@al45tair al45tair commented Jun 5, 2023

We need a Linux specific Target implementation, and a couple of minor tweaks to make things build everywhere.

rdar://110262673

@al45tair
Copy link
Contributor Author

al45tair commented Jun 5, 2023

This needs #66335 (which needs #66334 and #66333).

@al45tair
Copy link
Contributor Author

al45tair commented Jun 5, 2023

@swift-ci Please smoke test

@al45tair
Copy link
Contributor Author

al45tair commented Jun 5, 2023

@swift-ci Please smoke test

@al45tair al45tair requested a review from MaxDesiatov June 6, 2023 10:09
@al45tair
Copy link
Contributor Author

al45tair commented Jun 6, 2023

When reviewing, you can start at 450011e. Previous changesets are being reviewed in #66333, #66334 and #66335.

@al45tair
Copy link
Contributor Author

al45tair commented Jun 6, 2023

If you're wondering where the tests are, I left them until the last PR (#66338) so everything was enabled and they'd actually work.

The Swift backtracer's frame pointer unwinder cannot work on Linux
without this change, because the compiler omits the frame pointer from
the function in libSwift_Backtracing that actually captures the stack.

rdar://110260855
Using `SwiftShims` is undesirable - it creates all kinds of build issues,
and means shipping the `_SwiftBacktracing.h` header in the SDK, which is
not necessary.

While we're doing this, add the necessary definitions for reading ELF
and DWARF information.

rdar://110261712
Use the new module structure rather the old SwiftShims header.  This
is much cleaner and lets us include operating system headers to get
the relevant definitions where possible.

Add code to support ELF and DWARF, including decompression using
zlib, zstd and liblzma if those turn out to be required and available.

rdar://110261712
This is for compatibility, so that I can split up the PRs.
We'll remove it in the next PR.

rdar://110261712
@al45tair
Copy link
Contributor Author

al45tair commented Jun 6, 2023

@swift-ci Please smoke test

There's a chance that pipes might perform a partial read; we should
handle that case.

rdar://110261712
@al45tair
Copy link
Contributor Author

al45tair commented Jun 6, 2023

@swift-ci Please smoke test

The `status` argument to the `_swift_backtrace_demangle()` function
isn't especially useful, won't match behaviour on Windows, and we
actually don't use it in the Swift code that calls this SPI.

Remove it.

rdar://110261712
`__cxa_demangle()` is a rather unusual API; one of its "features" is that
the pointer you pass in must either be `nullptr`, in which case it
will call `malloc()` itself, _or_ it has to be a pointer to a block
of memory allocated with `malloc()`, because `__cxa_demangle()` may
`realloc()` it for you.

This seems to me to be something of a non-obvious footgun, so we never
pass the caller's pointer through to `__cxa_demangle()`, which lets them
decide how they want to allocate space.

rdar://110261712
@al45tair
Copy link
Contributor Author

al45tair commented Jun 7, 2023

@swift-ci Please smoke test

…ule.

There's a separate declaration here because we can't include the `Backtrace.h`
header from inside `modules/Runtime/Runtime.h`.

rdar://110261712
The `_Backtracing` module has a number of private implementation only
imports that aren't used outside of the module and that don't require
any additional libraries (hence they aren't relevant to the outside
world).  `verify_all_overlays.py` needs to know about these when it
does its test, because it loadas the module as the main module, which
results in implementation only imports being required instead of
ignored.

rdar://110261712
We need a Linux specific `Target` implementation, and a couple of minor
tweaks to make things build everywhere.

rdar://110262673
We don't need these here.  They were a leftover from previous code.

rdar://110262673
@al45tair
Copy link
Contributor Author

al45tair commented Jun 7, 2023

@swift-ci Please smoke test

@al45tair al45tair merged commit 9e008fa into apple:main Jun 7, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants