https://github.com/akutz/go-interface-values
When storing a value in a Go interface allocates memory on the heap.
https://github.com/akutz/go-interface-values
benchmark go golang heap malloc
Last synced: 3 months ago
JSON representation
When storing a value in a Go interface allocates memory on the heap.
- Host: GitHub
- URL: https://github.com/akutz/go-interface-values
- Owner: akutz
- License: apache-2.0
- Created: 2022-01-27T05:09:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-27T18:43:21.000Z (over 3 years ago)
- Last Synced: 2025-02-23T10:52:09.384Z (4 months ago)
- Topics: benchmark, go, golang, heap, malloc
- Language: Go
- Homepage:
- Size: 207 KB
- Stars: 72
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go interface values
This repository deep dives Go interface values, what they are, how they work, and when storing a value in a Go interface allocates memory on the heap.
* [**Labs**](#labs): a step-by-step walkthrough of the topic
* [**FAQ**](#FAQ): answers to frequently asked questions
* [**Links**](#links): links to related reference material
* [**Thanks**](#thanks): it takes a community
* [**Appendix**](#appendix): in-repo reference material
## Labs
1. [**Prerequisites**](./docs/01-prereqs/): how to get from here to there
1. [**Interface values**](./docs/02-interface-values/): whatever you do, do not call it "boxing"
1. [**Escape analysis**](./docs/03-escape-analysis/): to malloc or not to malloc
1. [**Missing mallocs**](./docs/04-missing-mallocs/): there's a heap of missing memory
1. [**Lessons learned**](./docs/05-lessons-learned/): key takeaways
## FAQ
* [**What does the `Q` suffix for instructions like `MOVQ` and `LEAQ` mean?**](#what-does-the-q-suffix-for-instructions-like-movq-and-leaq-mean)
* [**What is the x86 assembly instruction `CALL` actually calling?**](#what-is-the-x86-assembly-instruction-call-actually-calling)
* [**Where is the `CALL` instruction in ARM assembly?**](#where-is-the-call-instruction-in-arm-assembly)
* [**What is the `hack` directory and the files inside of it?**](#what-is-the-hack-directory-and-the-files-inside-of-it)
### What does the `Q` suffix for instructions like `MOVQ` and `LEAQ` mean?
Please refer to [this answer](./docs/99-appendix/assembly.md#what-does-the-q-suffix-for-instructions-like-movq-and-leaq-mean) from the assembly section in the appendix.
### What is the x86 assembly instruction `CALL` actually calling?
Please refer to [this answer](./docs/99-appendix/assembly.md#what-is-the-x86-assembly-instruction-actually-calling) from the assembly section in the appendix.
### Where is the `CALL` instruction in ARM assembly?
Please refer to [this answer](./docs/99-appendix/assembly.md#where-is-the-call-instruction-in-arm-assembly) from the assembly section in the appendix.
### What is the [`hack`](./hack) directory and the files inside of it?
The `hack` directory is a convention I picked up from working on Kubernetes and projects related to Kuberentes. The directory contains scripts useful to the project, but not a core piece of the project itself. For example:
* [**`hack/`**](./hack)
* [**`asm2md.py`**](./hack/asm2md.py): parses the output of `go tool compile -S -wb=false ./tests/mem/*.go` and produces a markdown table
* [**`b2md.py`**](./hack/b2md.py): parses the output of `go test -v -count 1 -benchtime 1000x -bench BenchmarkMem -run Mem -benchmem ./tests/mem` and produces a markdown table
* [**`gen.py`**](./hack/gen.py): generates [`./tests/mem/bench_test.go`](./tests/mem/mem_test.go) and [`./tests/mem/types_test.go`](./tests/mem/types_test.go)
## Links
* [**ARM developer documentation**](https://developer.arm.com/documentation/ddi0602/2021-12/?lang=en)
* [**x86 and amd64 instruction set**](https://www.felixcloutier.com/x86/index.html)
* [**A quick guide to Go assembly**](https://go.dev/doc/asm)
* [**Go internal application binary interface (ABI) specification**](https://github.com/golang/go/blob/master/src/cmd/compile/abi-internal.md)
* [**Logging, interfaces, and allocation**](https://commaok.xyz/post/interface-allocs/)
* [**Go introduction to escape analysise**](https://medium.com/a-journey-with-go/go-introduction-to-the-escape-analysis-f7610174e890)
* [**Type definitions for leaks**](https://github.com/golang/go/blob/master/src/cmd/compile/internal/escape/graph.go)
* [**Enums for escape**](https://github.com/golang/go/blob/master/src/cmd/compile/internal/ir/node.go)
* [**Type definition for a Go stack frame**](https://github.com/golang/go/blob/master/src/runtime/stack.go)
## Thanks
* Many thanks to reddit user _nikandfor_ for [their response](https://www.reddit.com/r/golang/comments/sdsfl9/trying_to_understand_when_boxing_results_in_a/huf2upt/) to my post on this topic. Without that initial work, I am not sure this repository would exist today.
* My gratitude to Crypto Jones from Gopher Slack for keeping me honest about "boxing." :smiley:
* My colleague Michael Gasch who spent a lot of time proofreading this repository. Hear that y'all? Any mistakes you find? Totally Michael's fault! :smiley:
* Andrew Williams, another co-worker, who did not judge me when he helpfully explained [cache lines](https://teivah.medium.com/go-and-cpu-caches-af5d32cc5592).
* The first person who offered to help me dig into the assembly, Kevin Grittner!
* Several of my colleagues who directed me to a [Trie](https://en.wikipedia.org/wiki/Trie) structure for the repository's bespoke test framework:
* Michal Jankowski
* Zhanghe Liu
* Yiyi Zhou
* Mayank Bhatt
* Arunesh Pandey
## Appendix
* [**Assembly**](./docs/99-appendix/assembly.md): reference section for go asm