I made a real-time C/C++/Rust build visualizer

https://danielchasehooper.com/posts/syscall-build-snooping/

by dhooper • 11 months ago

417 89 11 months ago

bgirard• 11 months ago

That's really cool. Fascinating to think about all the problems that get missed due to poor or missing visualizations like this.

I did a lot of work to improve the Mozilla build system a decade ago where I would have loved this tool. Wish they would have said what problem they found.

dhooper8• 11 months ago

(OP here) Thanks!

My call with the Mozilla engineer was cut short, so we didn't have time to go into detail about what he found, I want to look into it myself.

bvisness• 11 months ago

Hello, I am the engineer in question. I am not actually super familiar with the details of the build system, but from when I saw, the main issues were:

- Lots of constant-time slowness at the beginning and end of the build

- Dubious parallelism, especially with unified builds

- Cargo being Cargo

Overall it mostly looks like a soup of `make` calls with no particular rhyme or reason. It's a far cry from the ninja example the OP showed in his post.

xuhu• 11 months ago

Is there a tool that records the timestamp of each executed command during a build, and when you rebuild, it tells you how much time is left instead of "building obj 35 out of 1023" ?

Or (for cmake or ninja) use a CSV that says how long each object takes to build and use it to estimate how much is left ?

dhooper8• 11 months ago

OP Here. Thats an interesting idea. What The Fork knows all the commands run, and every path they read/write, so I should be able to make it estimate build time just by looking at what files were touched.

Surac• 11 months ago

but why? I have to admit it's a fun project

rvrb• 11 months ago

here, I'll copy the first paragraph of TFA for you:

Many software projects take a long time to compile. Sometimes that’s just due to the sheer amount of code, like in the LLVM project. But often a build is slower than it should be for dumb, fixable reasons.

corysama• 11 months ago

Looks like a general `fork()` visualizer to me. Which is great!

ItsHarper2• 11 months ago

I like that the name reflects its broad usefulness

supportengineer• 11 months ago

Amazing! Great job!

What limits your tool to compiler/build tools, can it be used for any arbitrary process?

dhooper8• 11 months ago

Thank you! Yeah it can be used for any type of program, but I haven't been able to think of anything besides compilation that creates enough processes to be interesting. I'm open to ideas!

DiddlyWinks• 11 months ago

Video encoding and 3-D rendering are a couple that come to mind; I'd think they'd launch quite a few.

This looks like a really cool tool!

Night_Thastus6• 11 months ago

I am extremely interested in this.

I am stuck in an environment with CMake, GCC and Unix Make (no clang, no ninja) and getting detailed information about WHY the build is taking so long is nearly impossible.

It's also a bit of a messy build with steps like copying a bunch of files from the source into the build folder. Multiple languages (C, C++, Fortran, Python), custom cmake steps, etc.

If this tool can handle that kind of mess, I'll be very interested to see what I can learn.

unddoch• 11 months ago

I wrote a little GCC plugin for compile time tracing/profiling, if that's something you're interested in: https://github.com/royjacobson/externis

Night_Thastus6• 11 months ago

I just went ahead and tried it out :)

I can get it to work for some sub-sets of our project, but for quite a bit of it I get the following error:

cc1: error: cannot load plugin /opt/rh/gcc-toolset-13/root/usr/lib/gcc/x86_64-redhat-linux/13/plugin/externis.so: /opt/rh/gcc-toolset-13/root/usr/lib/gcc/x86_64-redhat-linux/13/plugin/externis.so: undefined symbol: _Z14decl_as_stringP9tree_nodei

I suspect this is because these are C or Fortran sub-projects. I'm looking for some clean way to tell Cmake to apply externis to all the C++ only subprojects if possible. I'll see what I can come up with.

I'd also like to know, if multiple GCC commands end up pointing to the same trace.json, especially in a parallel build, will externis automagically ensure that it doesn't step over itself?

Night_Thastus6• 11 months ago

I figured out a way to set it at a top level, so it only happens with C++ files:

target_compile_options(${NAME} PUBLIC

$<$<COMPILE_LANGUAGE:CXX>:-fplugin=externis -fplugin-arg-externis-trace-dir=(where I want to put traces)>

)

But as I suspected, it is not a single trace file. It's thousands of trace files. Is there some way to collate all the data into one larger picture of how the build progressed?

phaedrus• 11 months ago

When I was trying to improve compile time for my game engine, I ended up using compiled size as a proxy measure. Although it is an imperfect correlation, the fact that compiled size is deterministic across build runs and even across builds on different machines makes it easier to work with than wall clock time.

mlsu• 11 months ago

Wait, this is not intuitive at all for me.

If the compiler is working harder wouldn't that result in a more compact binary? Maybe I'm thinking too much from an embedded software POV.

I suppose the compiler does eventually do IO but IO isn't really the constraint most of the time right?

pklausler• 11 months ago

strace might help, if you have it.

touisteur• 11 months ago

perf record -e "syscalls:,sched:" is my go-to there - or just apply it on whole-system, aasone does.

17186274403• 11 months ago

Can you set CC=time gcc ?

wakawaka283• 11 months ago

It's not "nearly impossible" but actually built in: https://cmake.org/cmake/help/latest/manual/cmake.1.html#cmdo... For the actual compile time you can easily insert a wrapper script. To be honest I haven't done that in over 4 years, but it has been done by many and it is easy.

There may be times when CMake itself is the bottleneck but it is almost certainly an issue with your dependencies and so on. CMake has many features to assist you in speeding up your compile and link time too. But it would take a series of blog posts to describe how you should try to speed it up.

Night_Thastus6• 11 months ago

Does that just profile cmake's time to configure and generate, or the underlying compile of each file as well? Configuration and generation are only seconds when done from scratch - the build is more like 20 minutes.

Just trying to add that argument with 3.26.5 on Rocky Linux 9, I get 'Unknown argument --profiling-format=google-trace'.

Not sure why, as cmake --help clearly states it should be there...

  --profiling-format=<fmt>     = Output data for profiling CMake scripts.
                                 Supported formats: google-trace
  --profiling-output=<file>    = Select an output path for the profiling data
                                 enabled through --profiling-format.

hagendaasalpine• 11 months ago

Tsoding wrote https://github.com/tsoding/nob.h, single header C library for cross platform builds, only requirement is cc. GDB profiling tools can then be used to look at your build step. It's a neat idea. I suspect this is not an option but Nix is great build tool if you are dealing with multiple languages.

jppittma• 11 months ago

Btw, he has a YouTube channel and streams. I recommend it if you’re seeking imposter syndrome.

fransje26• 11 months ago

I am stuck in an environment with CMake, GCC and Unix Make (no clang, no ninja) and getting detailed information about WHY the build is taking so long is nearly impossible.

I have a similar problem, with a tangential question that I think about from time to time without really having the time to investigate it further, unfortunately.

I notice sometimes that CMake recompiles files that shouldn't have been affected by the code changes made previously. Like recompiling some independent objects after only slight changes to a .cpp file without any interface changes.

So I often wonder if CMake is not making some file more inter-dependent than what they are, leading to longer compilation times.

aanet2• 11 months ago

This is fabulous!!

Is there a version available for MacOS today?? I'd love to give it a whirl... For Rust, C++ / Swift and other stuff.

Thanks!

dhooper8• 11 months ago

I'll be sending out the a macOS version to another wave of beta users after I fix an outstanding issue, if you sign up (at bottom of article) and mention this comment I can make sure you're in that wave.

aanet2• 11 months ago

Thanks. Signed up

Night_Thastus6• 11 months ago

It looks like it doesn't have a public release for any OS yet, but has a way to enter for early access.

mgaunard• 11 months ago

The real solution is to eliminate build systems where you have to define your own targets.

Developers always get it wrong and do it badly.

tiddles• 11 months ago

Nice, I’ve been looking for something like this for a while.

I’ve noticed on my huge catkin cmake project that cmake is checking the existence of the same files hundreds of times too. Is there anything that can hook into fork() and provide a cached value after the first invocation?

lights0123• 11 months ago

My tips for speeding up builds (from making this same project but with ebpf):

- switch to ninja to avoid that exact issue since CMake + Make spawns a subprocess for every directory (use the binary from PyPi for jobserver integration)

- catkin as in ROS? rm /opt/ros/noetic/etc/catkin/profile.d/99.roslisp.sh to remove 2 python spawns per package

ethan_smith• 11 months ago

You could try ccache with the CCACHE_SLOPPINESS=file_stat_matches option, or implement a filesystem-level caching proxy like CachingFS or FUSE-based solutions that intercept and cache those redundant stat() calls.

brcmthrowaway• 11 months ago

What about OSes that dont use fork()?

dhooper8• 11 months ago

I use whatever the equivalent is on that OS.

klik99• 11 months ago

Nice! Leaving a comment to easily find this later, dont have anything to add except this looks cool

boris• 11 months ago

It also has 6 seconds of inactivity before starting any useful work. For comparison, ninja takes 0.4 seconds to start compiling the 2,468,083 line llvm project. Ninja is not a 100% fair comparison to other tools, because it benefits from some “baked in” build logic by the tool that created the ninja file, but I think it’s a reasonable “speed of light” performance benchmark for build systems.

This is an important observation that is often overlooked. What’s more, the changes to the information on which this “baked in” build logic is based is not tracked very precisely.

How close can we get to this “speed of light” without such “baking in”? I ran a little benchmark (not 100% accurate for various reasons but good enough as a general indication) which builds the same project (Xerces-C++) both with ninja as configured by CMake and with build2, which doesn’t require a separate step and does configuration management as part of the build (and with precise change tracking). Ninja builds this project from scratch in 3.23s while build2 builds it in 3.54s. If we omit some of the steps done by CMake (like generating config.h) by not cleaning the corresponding files, then the time goes down to 3.28s. For reference, the CMake step takes 4.83s. So a fully from-scratch CMake+ninja build actually takes 8s, which is what you would normally pay if you were using this project as a dependency.

remexre• 11 months ago

What’s more, the changes to the information on which this “baked in” build logic is based is not tracked very precisely.

kbuild handles this on top of Make by having each target depend on a dummy file that gets updated when e.g. the CFLAGS change. It also treats Make a lot more like Ninja (e.g. avoiding putting the entire build graph into every Make process) -- I'd be interested to see how it compares.

forrestthewoods• 11 months ago

This is great. I was skeptical from the title but the implementation is very clever. This could be a super super useful tool for the industry.

kirito1337• 11 months ago

That's interesting.

jeffbee• 11 months ago

This seems like a good place to integrate a Bazel Build Event Protocol stream consumer.

MathMonkeyMan• 11 months ago

I was going to comment that "what the fork" might not work for a client/server build system like Bazel, but now I have something to google instead.

CyberDildonics• 11 months ago

I love the visualization, I think it's great information and will be very helpful to whoever uses it.

I would think about a different name. Often names are either meant to be funny or just unique nonsense but something short and elegantly descriptive (like BuildViz etc.) can go a long way to making it seem more legitimate and being more widely used.

dhooper8• 11 months ago

Thanks CyberDildoNics!

17186274403• 11 months ago

I'm interested to try, but don't get what that early access signup is about. Where is the email address going to show up? Can I use a temp mail?

hiccuphippo• 11 months ago

Name checks out.

entelechy2• 11 months ago

Love it! We did something similar using strace/dtruss back in 2018 with https://buildinfer.loopperfect.com/ and were generating graphs (using eg. graphviz and perfetto.dev) and BUCK files on the back of that

Whilst we regrettably never came around to package it as a propper product, we found it immensly valuable in our consulting work, to pinpoint issues and aid the conversion to BUCK/Bazel. We used graphviz, https://perfetto.dev/ and couple other tools to visualise things

Recently we cicled back to this too but with a broader usecase in mind.

There are some inherent technical challanges with this approach & domain:

- syscall logs can get huge - especially when saved to disk. Our strace logs would get over 100GB for some projects (llvm was around ~50GB)

- some projects also use https and inter process communications and that needs ot be properly handled too. (We even had a customer that was retriving code from a firebird database via perl as part of the compilation step!)

- It's runtime analysis - you might need to repeat the analysis for each configuration.

flakes• 11 months ago

Curious, what were you using for doing syscall logging? LD_PRELOAD tricks, or ebpf filtering?

entelechy2• 11 months ago

mostly strace and it's macos equivalent; Later we moved to ptrace and ebpf. LD_PRELOAD unfortunately doesn't work for statically linked libc. There are also kernel probes but didn't like that it required root permissions...

proctorg76• 11 months ago

the parallels between tech and manufacturing never cease to amaze, this looks so much like the machine monitoring / execution system we use in the car parts plant I want to ask if you've calculated the TEEP and OEE of your build farm

Cloudef• 11 months ago

LLVM is taking its sweet time, brew coffee

mrlonglong2• 11 months ago

Does it work with cmake?

MBCook• 11 months ago

There is an example cmake graph in the article.

mrlonglong2• 11 months ago

Thanks.

ItsHarper2• 11 months ago

A CMake build is used as an example in the blog post. It's literally just visualizing all spawned processes, so it will work for anything that spawns subprocesses to do the build.

tom_3• 11 months ago

If you use the Visual C++ compiler on Windows, vcperf is worth a look: https://github.com/microsoft/vcperf - comes with VS2022, or you can build from github.

I've used it with projects generated by UBT and CMake. I can't remember if it provides any info that'd let you assess the quality of build parallelism, but it does have some compiler front end info which is pretty straightforward to read. Particularly expensive headers (whether inherently so, or just because they're included a lot) are easy to find.

muststopmyths• 11 months ago

Also Incredibuild. The free version is probably good enough to visualize your build and see any bottlenecks.

metalliqaz• 11 months ago

Isn't `wtf` already a fairly common command?

audiofish• 11 months ago

Really cool tool, but perhaps not for the original use-case. I often find myself trying to figure out what call tree a large Bash script creates, and this looks like it visualises it well.

This would have been really useful 6 months ago, when I was trying to figure out what on earth some Jetson tools actually did to build and flash an OS image.

Mawr• 11 months ago

Suggestion to the blog author - put:

Here it is recording the build of a macOS app:
<gif>

At the top of the page, it should be right under the header.

You made a thing, so show the thing. You can waffle on about it later. Just show the thing.

dhooper8• 11 months ago

Good suggestion. Updated.

hdjrudni• 11 months ago

Good job. This caught my eye. I don't think the visual even needs much of an explanation, I can see what it's doing.

epage2• 11 months ago

How does this compare to `cargo check --timings`?

It visualizes each crate's build, shows the dependencies between them, shows when the initial compilation is done that unblocks dependents, and soon will have link information.

rustystump• 11 months ago

10/10 this is very cool and the kind of hacking i come here for

time4tea• 11 months ago

Then I hid it away.

This is an ad not a helpful announcement.

JackYoustra• 11 months ago

For anyone using xcode: there's a builtin button to show a visualization for a build (not realtime afaik) for it too.

bdash• 11 months ago

I've had success using https://github.com/nico/ninjatracing along with Clang's `-ftime-trace` to visualize the build performance of a C++ project using CMake. https://github.com/aras-p/ClangBuildAnalyzer helps further break down what the compiler is spending its time on.

bitbasher• 11 months ago

This is cool, but for Rust you have `cargo build --timings` built in and has even more details.

saagarjha• 11 months ago

I've done something similar by running Instruments during the build, which not only tells me which processes are running when but also what they're doing. Unfortunately Instruments gets upset if your build takes a long time, and it doesn't really allow filtering by process tree, but it helped shipped several major wins for our builds when I was working on Twitter's iOS codebase. Alas trying to this these days will not work because Instrument's "All Processes" tracing has been broken for a while (FB14533747).

tempodox• 11 months ago

I would be interested and even pay for it, but I am not a joiner. And I don't want Google to know any of my email addresses.

pjmlp• 11 months ago

Great piece of work.

Without trying to devalue it, note that VS and XCode have similar visualization tools.

torarnv• 11 months ago

Awesome!! Are you planning to open source this? I’ve been working on something similar and would love to join forces!

emigre• 11 months ago

Really nice and interesting! Thanks!

terabytest• 11 months ago

It looks really nice. I wonder if it’d be possible to break it down even further by somehow instrumenting the actual processes and including their execution flame graphs as part of the chart. That would expose a ton of extra information about the large gaps of “inactivity”.

secondcoming• 11 months ago

This looks awesome.

I've used clang's -ftime-trace option in the past and that's also really good. It's a pity gcc has nothing similar.

lsuresh• 11 months ago

Would love to have our team try this out (we have some ridiculous rust builds).

I made a real-time C/C++/Rust build visualizer

Related Stories