🔍 Go binary size SVG treemap
Make treemap breakdown of Go executable binary
$ go install github.com/nikolaydubina/go-binsize-treemap@latest
$ go tool nm -size <binary finename> | go-binsize-treemap > binsize.svg
Should you be worried about executable binary size? In 2022, few seconds of cat videos or even a single image is tens of MBs. Transferring them over network is not a big deal either. So, probably, you should not worry too much about it. However, this tool can still be useful in couple of cases.
cgo
.I build this in my spare time as another usecase for Go treemap tooling that I built before. Enjoy! Submit issues or PRs!
github.com/gohugoio/hugo 62MB, this famous example of large Go project
github.com/cockroachdb/cockroach 71MB, this famous db is building with C++
github.com/goccy/go-graphviz 6.5MB, this project has CGO and builds with lots of graphviz code in C
github.com/zalando/skipper 36MB, is a large Go project, some builds can include C
What is
go.itab
?
This is interface related code. Refer to this article by Russ Cox.
What is
runtime.pclntab
? And why it is so big?
As investigated Cockroach team, it is Go runtime structure for traces (reference). Past discussions in GitHub thread on why it is big and what to do about it (well, nothing).
You many need to demungle symtab file first. Install c++flit
. Then process symtab first.
Note, c++ support is work in progress.
$ go tool nm -size <binary finename> | c++filt | go-binsize-treemap > binsize.svg
If you set dimensions very large you can see lots of details and navigate map.
4096x4096 is recommended
... but you can go much higher
You can generate small preview of project that fits for embedding in README for example.
1024x256 is recommended
$ cat testdata/go-graphviz.symtab | ./go-binsize-treemap -csv > docs/go-graphviz.csv
$ cat testdata/go-graphviz.symtab | ./go-binsize-treemap > docs/go-graphviz.svg
$ cat testdata/go-graphviz.symtab | ./go-binsize-treemap -w 4096 -h 4096 > docs/go-graphviz-4096x4096.svg
$ cat testdata/cockroach.symtab | ./go-binsize-treemap -csv > docs/cockroach.csv
$ cat testdata/cockroach.symtab | ./go-binsize-treemap > docs/cockroach.svg
$ cat testdata/cockroach.symtab | ./go-binsize-treemap -w 4096 -h 4096 > docs/cockroach-4096x4096.svg
$ cat testdata/skipper.symtab | ./go-binsize-treemap > docs/skipper.svg
$ cat testdata/hugo.symtab | ./go-binsize-treemap -csv > docs/hugo.csv
$ cat testdata/hugo.symtab | ./go-binsize-treemap > docs/hugo.svg
$ cat testdata/hugo.symtab | ./go-binsize-treemap -w 1024 -h 128 > docs/hugo-1024x128.svg
$ cat testdata/hugo.symtab | ./go-binsize-treemap -w 1024 -h 256 > docs/hugo-1024x256.svg
$ cat testdata/hugo.symtab | ./go-binsize-treemap -w 1024 -h 512 > docs/hugo-1024x512.svg
$ cat testdata/hugo.symtab | ./go-binsize-treemap -w 4096 -h 4096 > docs/hugo-4096x4096.svg
$ cat testdata/hugo.symtab | ./go-binsize-treemap -w 16384 -h 16384 > docs/hugo-16384x16384.svg