iree icon indicating copy to clipboard operation
iree copied to clipboard

Tracy with internalized Capstone 6

Open bjacob opened this issue 1 year ago • 1 comments

Context

Tracy has an external dependency on Capstone for disassembly.

Only the current development branch of capstone, named next, is recent enough for our purposes, ans we in IREE are living on the cutting edge of new SIMD ISA extensions. Its version number is 6, so we currently want Capstone 6, but by the time it becomes stable we'll probably want Capstone 7, etc. We want the cutting edge.

That has been a problem for IREE users with Tracy, requiring custom documentation. Compounding that, Capstone has recently done a breaking renaming, requiring patching Tracy: https://github.com/wolfpld/tracy/pull/671 .

Now on the latter Tracy PR the discussion has mentioned that another Tracy PR https://github.com/wolfpld/tracy/pull/707 is about to internalize Tracy as a CPM.cmake package. I don't know any specifics of CPM.cmake, but that shouldn't matter too much for us since we are carrying our own Tracy CMake setup anyway: https://github.com/openxla/iree/blob/main/build_tools/third_party/tracy/CMakeLists.txt

So once Tracy has internalized a version of Capstone (currently 5.0.1), we could do a Tracy bump on our side, also internalizing the same version of Capstone in whichever way works for us; and then as a second step from there, we could work with Tracy upstream on a Capstone 5->6 bump, the Tracy-side code changes being as in https://github.com/wolfpld/tracy/pull/671 or the simpler macro-expansion of that since, being internalized, now we wouldn't have to worry about compatibility with other Capstone versions anymore.

Steps

### Tasks
- [ ] Wait for https://github.com/wolfpld/tracy/pull/707 to be merged.
- [ ] Bump Tracy, internalize the same Capstone 5 version in our own way.
- [ ] Work on a Tracy-side bump of its Capstone version from 5 to 6, as in https://github.com/wolfpld/tracy/pull/671.
- [ ] Bump Tracy again and simultaneously bump Capstone to 6.

bjacob avatar Mar 14 '24 20:03 bjacob

Tracy has been updated in IREE. Let's update the capstone version upstream and then update again?

ScottTodd avatar May 23 '24 22:05 ScottTodd

Fixed by https://github.com/iree-org/iree/pull/19842

ScottTodd avatar Feb 06 '25 16:02 ScottTodd