[go: up one dir, main page]

rlnc 0.8.6

Random Linear Network Coding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# Collects inspiration from https://github.com/0xMiden/miden-base/blob/983357b2ad42f6e8d3c338d460a69479b99a1136/Makefile

.DEFAULT_GOAL := help

.PHONY: help
help:
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

BACKTRACE=RUST_BACKTRACE=1

.PHONY: clippy
clippy: ## Runs clippy showing warnings
	cargo clippy --all-targets -- -D warnings

.PHONY: format
format: ## Formats source tree
	cargo fmt --all

.PHONY: test
test: ## Run all tests
	$(BACKTRACE) RUSTFLAGS="-C target-cpu=native" cargo test --profile test-release
	$(BACKTRACE) RUSTFLAGS="-C target-cpu=native" cargo test --profile test-release --features parallel

.PHONY: test-wasm
test-wasm: ## Run all tests in WASM environment
	$(BACKTRACE) cargo test --target wasm32-wasip1 --profile test-release --no-default-features
	$(BACKTRACE) cargo test --target wasm32-wasip2 --profile test-release --no-default-features

.PHONY: coverage
coverage: ## Generates HTML code coverage report, using `cargo-tarpaulin`
	cargo tarpaulin -t 600 --profile test-release --out Html

.PHONY: bench
bench: ## Run all benchmarks in single-threaded mode
	RUSTFLAGS="-C target-cpu=native" cargo bench --profile optimized --bench full_rlnc_encoder
	RUSTFLAGS="-C target-cpu=native" cargo bench --profile optimized --bench full_rlnc_recoder
	RUSTFLAGS="-C target-cpu=native" cargo bench --profile optimized --bench full_rlnc_decoder

.PHONY: bench_parallel
bench_parallel: ## Run all benchmarks in multi-threaded mode
	RUSTFLAGS="-C target-cpu=native" cargo bench --profile optimized --features parallel --bench full_rlnc_encoder
	RUSTFLAGS="-C target-cpu=native" cargo bench --profile optimized --features parallel --bench full_rlnc_recoder
	RUSTFLAGS="-C target-cpu=native" cargo bench --profile optimized --features parallel --bench full_rlnc_decoder

.PHONY: clean
clean: ## Removes cargo target and Python virtual environment directory
	cargo clean
	rm -rf $(VENV)

.PHONY: example
example: ## Runs the Full RLNC example program
	RUSTFLAGS="-C target-cpu=native" cargo run --example full_rlnc
	RUSTFLAGS="-C target-cpu=native" cargo run --example full_rlnc --features parallel

.PHONY: example-wasm
example-wasm: ## Runs the Full RLNC example program in WASM environment
	cargo run --example full_rlnc --target wasm32-wasip1 --no-default-features
	cargo run --example full_rlnc --target wasm32-wasip2 --no-default-features

# -----------------------------------------------------------------------------
# Following Make recipes are for easy plotting of benchmark run data, in JSONL format, on Linux or Mac machines.
# Plotting is done using Matplotlib library. Plotted images are placed inside the ./plots directory.

# Define Virtual environment state directory along with path to executables inside venv
VENV := .venv
VENV_PYTHON := $(VENV)/bin/python
VENV_PIP := $(VENV)/bin/pip

OS := $(shell uname -s)
CPU_NAME := $(shell if [ "$(OS)" = "Darwin" ]; then sysctl -n machdep.cpu.brand_string | tr ' ' '_' | tr -d '()'; elif [ "$(OS)" = "Linux" ]; then grep "model name" /proc/cpuinfo | uniq | cut -d: -f2 | sed 's/^[ \t]*//' | tr ' ' '_' | tr -d '()'; else echo "$(OS)" | tr ' ' '_' | tr -d '()'; fi)

.PHONY: setup
setup: install ## Sets up virtual environment and installs dependencies
	@echo "\n✅ Virtual environment is ready."
	@echo "To activate it, run: source $(VENV)/bin/activate"
	@echo "After activated, to deactivate it, run: deactivate"

# The install target now depends on the venv being created
.PHONY: install
install: $(VENV)/bin/activate ## Install dependencies using `pip`
	@echo "Installing dependencies..."
	$(VENV_PIP) install -r plots/scripts/requirements.txt

# This target creates the virtual environment
$(VENV)/bin/activate: plots/scripts/requirements.txt
	@echo "Setting up environment with venv..."
	python3 -m venv $(VENV)

.PHONY: bench_then_plot
bench_then_plot: setup ## Run benchmark, collect JSONL output and produce plot of benchmark throughput
	RUSTFLAGS="-C target-cpu=native" cargo criterion --bench full_rlnc_encoder --message-format json | tee full_rlnc_encoder.jsonl &&\
	$(VENV_PYTHON) plots/scripts/plot_benchmark.py -u GB/s --title-format "{group_name} on $(CPU_NAME)" full_rlnc_encoder.jsonl &&\
	rm full_rlnc_encoder.jsonl &&\
	mv benchmark_encode.png plots/benchmark_encode_on_$(CPU_NAME)_with_$(shell rustc --version | tr ' ' '_' | tr -d '()').png &&\
	mv benchmark_encode_zero_alloc.png plots/benchmark_encode_zero_alloc_on_$(CPU_NAME)_with_$(shell rustc --version | tr ' ' '_' | tr -d '()').png

	RUSTFLAGS="-C target-cpu=native" cargo criterion --bench full_rlnc_recoder --message-format json | tee full_rlnc_recoder.jsonl &&\
	$(VENV_PYTHON) plots/scripts/plot_benchmark.py -u GB/s --title-format "{group_name} on $(CPU_NAME)" full_rlnc_recoder.jsonl &&\
	rm full_rlnc_recoder.jsonl &&\
	mv benchmark_recode.png plots/benchmark_recode_on_$(CPU_NAME)_with_$(shell rustc --version | tr ' ' '_' | tr -d '()').png &&\
	mv benchmark_recode_zero_alloc.png plots/benchmark_recode_zero_alloc_on_$(CPU_NAME)_with_$(shell rustc --version | tr ' ' '_' | tr -d '()').png

	RUSTFLAGS="-C target-cpu=native" cargo criterion --bench full_rlnc_decoder --message-format json | tee full_rlnc_decoder.jsonl &&\
	$(VENV_PYTHON) plots/scripts/plot_benchmark.py --title-format "{group_name} on $(CPU_NAME)" full_rlnc_decoder.jsonl &&\
	rm full_rlnc_decoder.jsonl &&\
	mv benchmark_decode.png plots/benchmark_decode_on_$(CPU_NAME)_with_$(shell rustc --version | tr ' ' '_' | tr -d '()').png