xctrace support

[ldm0]

Basically working. Required to be done:

• quick-xml update Bump quick-xml to 0.37.0 and remove it from public APIs #332
• Add more logs and tests
• Documentation and changelog update

Fixes #246

xctrace is a tracer used internally by Apple Instruments. It generates a .trace folder containing a bunch of files in an unknown binary format. People have reverse engineerd it but it's internal format changed after XCode 12.

There's a xctrace export command, which can convert .trace into a readable XML file. However, it's output can't be used to generate flamegraphs until XCode 14.3, which introduces VM address and symbol name to the XML output.

In this PR, I added a stack collapser for XML files generated by xctrace export, making it possible to convert Instruments or xctrace‘s output into flamegraph.

[codecov]

Codecov Report

Attention: Patch coverage is 79.78723% with 57 lines in your changes missing coverage. Please review.

Project coverage is 90.68%. Comparing base (8e691e6) to head (29019cc).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/collapse/xctrace.rs	79.56%	57 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #286      +/-   ##
==========================================
- Coverage   91.38%   90.68%   -0.70%     
==========================================
  Files          20       21       +1     
  Lines        4444     4725     +281     
==========================================
+ Hits         4061     4285     +224     
- Misses        383      440      +57     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[kraktus]

Hey, I was going to start working on integrating this only to see the work was already done! Thanks @ldm0!

I can help add the documentation if needed. Also not sure if this feature need to be tied to the quick-xml update?

[ldm0]

I can help add the documentation if needed. Also not sure if this feature need to be tied to the quick-xml update?

Thanks! I've written some documentation already, will submit it tomorrow. I think introducing multiple versions of the same dependency is bad(in terms of artifact size and complexity), so I'm waiting for the quick-xml update.

BTW, I've forked flamegraph with this inferno branch and you can try it: cargo install --git https://github.com/ldm0/flamegraph --branch xctrace, I replaced the default tracer(dtrace) with xctrace on macOS. (Make sure you get an XCode>=14.3 though)

[ldm0]

@jonhoo

Hi, now that #332 has been merged, this PR is ready for review.
I've personally used it for quite a long time and it has worked well. Please take a look.

[kraktus]

Same, I've been using it locally without issue

[jonhoo]

That's exciting, thanks! Took a first pass now. Nothing too deep to change, though some stuff that'll make this easier to maintain longer-term :)

[jonhoo]

Nice, it's already looking a lot better, thank you!

[ldm0]

ping @jonhoo

[jonhoo]

Sorry about that taking forever! Looks good to me now — let's get this landed and released! 🎉

[jonhoo]

Releasing as 0.12.2 in #340

[ldm0]

Thanks for reviewing this!

[jonhoo]

No, thank you for sticking with it for so long!