feat(perf): add (provision, build, run) tooling

perf/README.md

@@ -0,0 +1,49 @@
+# libp2p performance benchmarking
+
+This project includes the following components:
+
+- `terraform/`: a Terraform scripts to provision infrastructure
+- `impl/`: implementations of the [libp2p perf protocol](https://github.com/libp2p/specs/pull/478) running on top of e.g. go-libp2p, rust-libp2p or Go's std-library https stack
+- `runner/`: a set of scripts building and running the above implementations on the above infrastructure, reporting the results in `benchmark-results.json`
+
+Benchmark results can be visualized with https://observablehq.com/@mxinden-workspace/libp2p-perf.
+
+## Provision infrastructure
+
+1. `cd terraform`
+2. Save your public SSH key as the file `./user.pub`.
+3. `terraform init`
+4. `terraform apply`
+
+## Build and run implementations
+
+1. `cd runner`
+2. `npm ci`
+3. `npm run start -- --client-public-ip $(terraform output -raw -state ../terraform/terraform.tfstate client_public_ip) --server-public-ip $(terraform output -raw -state ../terraform/terraform.tfstate server_public_ip)`
+
+## Deprovision infrastructure
+
+1. `cd terraform`
+3. `terraform destroy`
+
+## Adding a new implementation
+
+1. Add implementation to `impl/`. Requirements for the binary:
+  - Running as a libp2p-perf server
+    - Command line flags
+      - `--run-server`
+      - `--secret-key-seed` unsigned integer to be used as a seed by libp2p-based implementations. Likely to go away in future iterations.
+  - Running as a libp2p-perf client
+      - Input via command line
+        - `--server-ip-address`
+        - `--transport` (see `runner/versions.ts` for possible variants)
+        - `--upload-bytes` number of bytes to upload per stream.
+        - `--download-bytes` number of bytes to upload per stream.
+      - Output
+        - Logging MUST go to stderr.
+        - Measurement output is printed to stdout as JSON in the form of:
+          ```json
+          {"connectionEstablishedSeconds":0.246442851,"uploadSeconds":0.000002077,"downloadSeconds":0.060712241}
+          ```
+
+2. Reference implementation in `runner/src/versions.ts`.

perf/impl/Makefile

@@ -0,0 +1,24 @@
+GO_SUBDIRS := $(wildcard go-libp2p/*/.)
+RUST_SUBDIRS := $(wildcard rust-libp2p/*/.)
+RUST_QUINN_SUBDIRS := $(wildcard rust-libp2p-quinn/*/.)
+HTTPS_SUBDIRS := $(wildcard https/*/.)
+QUIC_GO_SUBDIRS := $(wildcard quic-go/*/.)
+
+all: $(RUST_SUBDIRS) $(RUST_QUINN_SUBDIRS) $(GO_SUBDIRS) $(HTTPS_SUBDIRS) $(QUIC_GO_SUBDIRS)
+$(RUST_SUBDIRS):
+	$(MAKE) -C $@
+$(RUST_QUINN_SUBDIRS):
+	$(MAKE) -C $@
+$(GO_SUBDIRS):
+	$(MAKE) -C $@
+$(HTTPS_SUBDIRS):
+	$(MAKE) -C $@
+$(QUIC_GO_SUBDIRS):
+	$(MAKE) -C $@
+
+clean: $(RUST_SUBDIRS:%=%clean) $(RUST_QUINN_SUBDIRS:%=%clean) $(GO_SUBDIRS:%=%clean) $(HTTPS_SUBDIRS:%=%clean) $(QUIC_GO_SUBDIRS:%=%clean)
+
+%clean:
+	$(MAKE) -C $* clean
+
+.PHONY: $(RUST_SUBDIRS) $(RUST_QUINN_SUBDIRS) $(GO_SUBDIRS) $(HTTPS_SUBDIRS) $(QUIC_GO_SUBDIRS) all clean

perf/impl/go-libp2p/.gitignore

@@ -0,0 +1,4 @@
+go-libp2p-*.zip
+go-libp2p-*
+go-libp2p-*/*
+image.json

perf/impl/go-libp2p/v0.27/.gitignore

@@ -0,0 +1,3 @@
+perf
+.cache
+v0.27

perf/impl/go-libp2p/v0.27/Dockerfile

@@ -0,0 +1,14 @@
+# Build Go Binary
+FROM golang:1.20-alpine AS builder
+
+WORKDIR /app
+COPY go.mod go.sum ./
+RUN go mod download
+COPY *.go ./
+RUN go build -o perf .
+
+FROM alpine
+
+COPY --from=builder /app/perf /app/perf
+
+ENTRYPOINT [ "/app/perf" ]

perf/impl/go-libp2p/v0.27/Makefile

@@ -0,0 +1,13 @@
+GO_FILES := $(wildcard *.go)
+
+all: perf
+
+perf: $(GO_FILES)
+	docker run --rm --user "$(shell id -u):$(shell id -g)" -v "$(shell pwd)":/usr/src/myapp -w /usr/src/myapp -e GOCACHE=/usr/src/myapp/.cache golang:1.20 go build -o perf .
+
+clean:
+	rm perf
+	rm .cache
+	rm v0.27
+
+.PHONY: all clean

perf/impl/go-libp2p/v0.27/README.md

@@ -0,0 +1,12 @@
+1. Build with `docker build .`
+
+Run with:
+
+```
+docker run --rm -it <imageId>
+```
+
+Run server with
+```
+docker run --rm -it --entrypoint /app/server <imageId>
+```

perf/impl/go-libp2p/v0.27/go.mod

@@ -0,0 +1,98 @@
+module github.com/libp2p/test-plans/perf/go/v0.27/v2
+
+go 1.19
+
+require (
+	github.com/ipfs/go-log/v2 v2.5.1
+	github.com/libp2p/go-buffer-pool v0.1.0
+	github.com/libp2p/go-libp2p v0.27.0
+	github.com/multiformats/go-multiaddr v0.9.0
+	github.com/stretchr/testify v1.8.2
+)
+
+require (
+	github.com/benbjohnson/clock v1.3.0 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/containerd/cgroups v1.1.0 // indirect
+	github.com/coreos/go-systemd/v22 v22.5.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/davidlazar/go-crypto v0.0.0-20200604182044-b73af7476f6c // indirect
+	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.1.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/elastic/gosigar v0.14.2 // indirect
+	github.com/flynn/noise v1.0.0 // indirect
+	github.com/francoispqt/gojay v1.2.13 // indirect
+	github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 // indirect
+	github.com/godbus/dbus/v5 v5.1.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/mock v1.6.0 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/google/gopacket v1.1.19 // indirect
+	github.com/google/pprof v0.0.0-20230405160723-4a4c7d95572b // indirect
+	github.com/huin/goupnp v1.1.0 // indirect
+	github.com/ipfs/go-cid v0.4.1 // indirect
+	github.com/jackpal/go-nat-pmp v1.0.2 // indirect
+	github.com/jbenet/go-temp-err-catcher v0.1.0 // indirect
+	github.com/klauspost/compress v1.16.4 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.4 // indirect
+	github.com/koron/go-ssdp v0.0.4 // indirect
+	github.com/libp2p/go-cidranger v1.1.0 // indirect
+	github.com/libp2p/go-flow-metrics v0.1.0 // indirect
+	github.com/libp2p/go-libp2p-asn-util v0.3.0 // indirect
+	github.com/libp2p/go-msgio v0.3.0 // indirect
+	github.com/libp2p/go-nat v0.1.0 // indirect
+	github.com/libp2p/go-netroute v0.2.1 // indirect
+	github.com/libp2p/go-reuseport v0.2.0 // indirect
+	github.com/libp2p/go-yamux/v4 v4.0.0 // indirect
+	github.com/marten-seemann/tcp v0.0.0-20210406111302-dfbc87cc63fd // indirect
+	github.com/mattn/go-isatty v0.0.18 // indirect
+	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
+	github.com/miekg/dns v1.1.53 // indirect
+	github.com/mikioh/tcpinfo v0.0.0-20190314235526-30a79bb1804b // indirect
+	github.com/mikioh/tcpopt v0.0.0-20190314235656-172688c1accc // indirect
+	github.com/minio/sha256-simd v1.0.0 // indirect
+	github.com/mr-tron/base58 v1.2.0 // indirect
+	github.com/multiformats/go-base32 v0.1.0 // indirect
+	github.com/multiformats/go-base36 v0.2.0 // indirect
+	github.com/multiformats/go-multiaddr-dns v0.3.1 // indirect
+	github.com/multiformats/go-multiaddr-fmt v0.1.0 // indirect
+	github.com/multiformats/go-multibase v0.2.0 // indirect
+	github.com/multiformats/go-multicodec v0.8.1 // indirect
+	github.com/multiformats/go-multihash v0.2.1 // indirect
+	github.com/multiformats/go-multistream v0.4.1 // indirect
+	github.com/multiformats/go-varint v0.0.7 // indirect
+	github.com/onsi/ginkgo/v2 v2.9.2 // indirect
+	github.com/opencontainers/runtime-spec v1.0.2 // indirect
+	github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/prometheus/client_golang v1.14.0 // indirect
+	github.com/prometheus/client_model v0.3.0 // indirect
+	github.com/prometheus/common v0.42.0 // indirect
+	github.com/prometheus/procfs v0.9.0 // indirect
+	github.com/quic-go/qpack v0.4.0 // indirect
+	github.com/quic-go/qtls-go1-19 v0.3.2 // indirect
+	github.com/quic-go/qtls-go1-20 v0.2.2 // indirect
+	github.com/quic-go/quic-go v0.33.0 // indirect
+	github.com/quic-go/webtransport-go v0.5.2 // indirect
+	github.com/raulk/go-watchdog v1.3.0 // indirect
+	github.com/spaolacci/murmur3 v1.1.0 // indirect
+	go.uber.org/atomic v1.10.0 // indirect
+	go.uber.org/dig v1.16.1 // indirect
+	go.uber.org/fx v1.19.2 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.24.0 // indirect
+	golang.org/x/crypto v0.7.0 // indirect
+	golang.org/x/exp v0.0.0-20230321023759-10a507213a29 // indirect
+	golang.org/x/mod v0.10.0 // indirect
+	golang.org/x/net v0.8.0 // indirect
+	golang.org/x/sync v0.1.0 // indirect
+	golang.org/x/sys v0.7.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
+	golang.org/x/tools v0.7.0 // indirect
+	google.golang.org/protobuf v1.30.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	lukechampine.com/blake3 v1.1.7 // indirect
+	nhooyr.io/websocket v1.8.7 // indirect
+)