optimize.md

Miki's Optimization Guide

Rules of Optimization Club

1. You do not optimize.
2. You do not optimize, without measuring first.
3. When the performance is not bound by the code, but by external factors, the optimization is over.
4. Only optimize code that already has full unit test coverage.
5. One factor at a time.
6. No unresolved bugs, no schedule pressure.
7. Testing will go on as long as it has to.
8. If this is your first night at Optimization Club, you have to write a test case.

See more here

Performance Mantras

By Craig Hanson and Pat Crain

1. Don't do it : Can we avoid doing the calculation at all? For example: Do we need to parse the input or just pass it as-is?

2. Do it, but don't do it again : Can we use memoization/caching? Parse objects once at the "edges" and use the parsed objects internally.

3. Do it less : Do we need to run this every millisecond? Can every second work? Can we use only a subset of the data?

4. Do it later : Can we make this API call async?

5. Do it when they're not looking : Can we run the calculation in the background while doing another task?

6. Do it concurrently : Will concurrency help here? Consider Amdhal's law.

7. Do it cheaper : Can we use a map here instead of a slice? Research available algorithms and data structures and know their complexity. Test them on your data

Go Specific

1. Memory Allocation : Avoid allocations as possible (see the design of io.Reader). Pre-allocate if you already know the size. Be careful of slices keep large amounts of memory (s := make([]int, 1000000)[:3])

2. defer might slow you Down : However consider the advantages.

3. strings are immutable : Use bytes.Buffer or strings.Builder

4. Know when a goroutine is going to stop : Avoid goroutine leaks. Use context for cancellation/timeouts.

5. cgo calls are expensive : Group them together in one cgo call.

6. Channel can be slower than sync.Mutex : However they are much easier to work with

7. Interface calls are more expensive the struct calls : You can extract the value from the interface first. However it's less generic code.

8. Use go run -gcflags=-m : You'll see what escapes to the heap.

Reading

• So you wanna go fast
• Performance tuning workshop.
• Quick look at some compiler optimization

Non Go Specific

1. Know thy Hardware : CPU affinity, CPU cache, memory, latency numbers .... For example: Cache-oblivious algorithms

2. Algorithms & Data structures Rule : They will usually give you much better performance than any other trick.

3. Include performance in your process : Design & code reviews, run & compare benchmarks on CI ...