demikernel 0.0.1

Kernel-Bypass LibOS Architecture
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.

#=======================================================================================================================
# Default Paths
#=======================================================================================================================

export PREFIX ?= $(HOME)

export INSTALL_PREFIX ?= $(HOME)

export PKG_CONFIG_PATH ?= $(shell find $(PREFIX)/lib/ -name '*pkgconfig*' -type d 2> /dev/null | xargs | sed -e 's/\s/:/g')

export LD_LIBRARY_PATH ?= $(CURDIR)/lib:$(shell find $(PREFIX)/lib/ -name '*x86_64-linux-gnu*' -type d 2> /dev/null | xargs | sed -e 's/\s/:/g')


#=======================================================================================================================
# Build Configuration
#=======================================================================================================================

export BUILD := release

ifeq ($(DEBUG),yes)

export RUST_LOG ?= trace

export BUILD := dev

endif

#=======================================================================================================================
# Project Directories
#=======================================================================================================================

export BINDIR ?= $(CURDIR)/bin

export INCDIR := $(CURDIR)/include

export LIBDIR ?= $(CURDIR)/lib

export SRCDIR = $(CURDIR)/src

export BUILD_DIR := $(CURDIR)/target/release

ifeq ($(BUILD),dev)

export BUILD_DIR := $(CURDIR)/target/debug

endif
export INPUT ?= $(CURDIR)/nettest/input


#=======================================================================================================================
# Toolchain Configuration
#=======================================================================================================================

# Rust
export CARGO ?= $(shell which cargo || echo "$(HOME)/.cargo/bin/cargo" )

export CARGO_FLAGS += --profile $(BUILD)


# C
export CFLAGS := -I $(INCDIR)

ifeq ($(DEBUG),yes)

export CFLAGS += -O0

else
export CFLAGS += -O3

endif

#=======================================================================================================================
# Libraries
#=======================================================================================================================

export DEMIKERNEL_LIB := libdemikernel.so

export LIBS := $(BUILD_DIR)/$(DEMIKERNEL_LIB)


#=======================================================================================================================
# Build Parameters
#=======================================================================================================================

export LIBOS ?= catnap

export CARGO_FEATURES := --features=$(LIBOS)-libos --no-default-features


# Switch for DPDK
ifeq ($(LIBOS),catnip)

DRIVER ?= $(shell [ ! -z "`lspci | grep -E "ConnectX-[4,5,6]"`" ] && echo mlx5 || echo mlx4)

CARGO_FEATURES += --features=$(DRIVER)

endif

# Switch for profiler.
export PROFILER ?= no

ifeq ($(PROFILER),yes)

CARGO_FEATURES += --features=profiler

endif

CARGO_FEATURES += $(FEATURES)


#=======================================================================================================================

all: init | all-libs all-tests all-examples


init:
	mkdir -p $(LIBDIR)

	git config --local core.hooksPath .githooks


# Builds documentation.
doc:
	$(CARGO) doc $(FLAGS) --no-deps


# Copies demikernel artifacts to a INSTALL_PREFIX directory.
install:
	mkdir -p $(INSTALL_PREFIX)/include $(INSTALL_PREFIX)/lib

	cp -rf $(INCDIR)/* $(INSTALL_PREFIX)/include/

	cp -rf  $(LIBDIR)/* $(INSTALL_PREFIX)/lib/

	cp -f $(CURDIR)/scripts/config/default.yaml $(INSTALL_PREFIX)/config.yaml


#=======================================================================================================================
# Libs
#=======================================================================================================================

# Builds all libraries.
all-libs: all-shim all-libs-demikernel


all-libs-demikernel:
	@echo "LD_LIBRARY_PATH: $(LD_LIBRARY_PATH)"

	@echo "PKG_CONFIG_PATH: $(PKG_CONFIG_PATH)"

	@echo "$(CARGO) build --libs $(CARGO_FEATURES) $(CARGO_FLAGS)"

	$(CARGO) build --lib $(CARGO_FEATURES) $(CARGO_FLAGS)

	cp -f $(BUILD_DIR)/$(DEMIKERNEL_LIB) $(LIBDIR)/$(DEMIKERNEL_LIB)


all-shim: all-libs-demikernel

	$(MAKE) -C shim all BINDIR=$(BINDIR)/shim


clean-libs: clean-shim clean-libs-demikernel


clean-libs-demikernel:
	rm -f $(LIBDIR)/$(DEMIKERNEL_LIB)

	rm -rf target ; \

	rm -f Cargo.lock ; \

	$(CARGO) clean


clean-shim:
	$(MAKE) -C shim clean BINDIR=$(BINDIR)/shim


#=======================================================================================================================
# Tests
#=======================================================================================================================

# Builds all tests.
all-tests: all-tests-rust all-tests-c


# Builds all Rust tests.
all-tests-rust:
	@echo "$(CARGO) build --tests $(CARGO_FEATURES) $(CARGO_FLAGS)"

	$(CARGO) build --tests $(CARGO_FEATURES) $(CARGO_FLAGS)


# Builds all C tests.
all-tests-c: all-libs

	$(MAKE) -C tests all


# Cleans up all build artifactos for tests.
clean-tests: clean-tests-c


# Cleans up all C build artifacts for tests.
clean-tests-c:
	$(MAKE) -C tests clean


#=======================================================================================================================
# Examples
#=======================================================================================================================

# Builds all examples.
all-examples: all-examples-c all-examples-rust


# Builds all C examples.
all-examples-c: all-libs

	$(MAKE) -C examples/c all


# Builds all Rust examples.
all-examples-rust:
	$(MAKE) -C examples/rust all


# Cleans all examples.
clean-examples: clean-examples-c clean-examples-rust


# Cleans all C examples.
clean-examples-c:
	$(MAKE) -C examples/c clean


# Cleans all Rust examples.
clean-examples-rust:
	$(MAKE) -C examples/rust clean


#=======================================================================================================================
# Benchmarks
#=======================================================================================================================

# Builds all C benchmarks
all-benchmarks-c: all-libs

	$(MAKE) -C benchmarks all


# Cleans up all C build artifacts for benchmarks.
clean-benchmarks-c:
	$(MAKE) -C benchmarks clean


#=======================================================================================================================
# Check
#=======================================================================================================================

# Check code style formatting.
check-fmt: check-fmt-c check-fmt-rust


# Check code style formatting for C.
check-fmt-c:
	$(shell find include/ -name "*.h" -name "*.hxx" -name "*.c" -name "*.cpp" -type f -print0 | xargs -0 clang-format --fallback-style=Microsoft --dry-run -Werror )

	@exit $(.SHELLSTATUS)


# Check code style formatting for Rust.
check-fmt-rust:
	$(CARGO) fmt --all -- --check


#=======================================================================================================================
# Clean
#=======================================================================================================================

# Cleans up all build artifacts.
clean: clean-examples clean-tests clean-libs


#=======================================================================================================================
# Tests
#=======================================================================================================================

export CONFIG_PATH ?= $(HOME)/config.yaml

export MTU ?= 1500

export MSS ?= 1500

export PEER ?= server

export TEST ?= udp-push-pop

export TEST_INTEGRATION ?= tcp-test

export TEST_UNIT ?=
export TIMEOUT ?= 120


# Runs system tests.
test-system: test-system-rust


# Rust system tests.
test-system-rust:
	timeout $(TIMEOUT) $(BINDIR)/examples/rust/$(TEST).elf $(ARGS)


# Runs unit tests.
test-unit: test-unit-rust


# C unit tests.
test-unit-c: all-tests test-unit-c-sizes test-unit-c-syscalls


test-unit-c-sizes: all-tests $(BINDIR)/sizes.elf

	timeout $(TIMEOUT) $(BINDIR)/sizes.elf


test-unit-c-syscalls: all-tests $(BINDIR)/syscalls.elf

	timeout $(TIMEOUT) $(BINDIR)/syscalls.elf


# Rust unit tests.
test-unit-rust: test-unit-rust-lib test-unit-rust-udp test-unit-rust-tcp

	timeout $(TIMEOUT) $(CARGO) test --test sga $(BUILD) $(CARGO_FEATURES) -- --nocapture --test-threads=1 test_unit_sga_alloc_free_single_small

	timeout $(TIMEOUT) $(CARGO) test --test sga $(BUILD) $(CARGO_FEATURES) -- --nocapture --test-threads=1 test_unit_sga_alloc_free_loop_tight_small

	timeout $(TIMEOUT) $(CARGO) test --test sga $(BUILD) $(CARGO_FEATURES) -- --nocapture --test-threads=1 test_unit_sga_alloc_free_loop_decoupled_small

	timeout $(TIMEOUT) $(CARGO) test --test sga $(BUILD) $(CARGO_FEATURES) -- --nocapture --test-threads=1 test_unit_sga_alloc_free_single_big

	timeout $(TIMEOUT) $(CARGO) test --test sga $(BUILD) $(CARGO_FEATURES) -- --nocapture --test-threads=1 test_unit_sga_alloc_free_loop_tight_big

	timeout $(TIMEOUT) $(CARGO) test --test sga $(BUILD) $(CARGO_FEATURES) -- --nocapture --test-threads=1 test_unit_sga_alloc_free_loop_decoupled_big


# Rust unit tests for the library.
test-unit-rust-lib: all-tests-rust

	timeout $(TIMEOUT) $(CARGO) test --lib $(CARGO_FLAGS) $(CARGO_FEATURES) -- --nocapture $(TEST_UNIT)


# Rust unit tests for UDP.
test-unit-rust-udp: all-tests-rust

	timeout $(TIMEOUT) $(CARGO) test --test udp $(CARGO_FLAGS) $(CARGO_FEATURES) -- --nocapture $(TEST_UNIT)


# Rust unit tests for TCP.
test-unit-rust-tcp: all-tests-rust

	timeout $(TIMEOUT) $(CARGO) test --test tcp $(CARGO_FLAGS) $(CARGO_FEATURES) -- --nocapture $(TEST_UNIT)


# Runs Rust integration tests.
test-integration-rust:
	timeout $(TIMEOUT) $(CARGO) test --test $(TEST_INTEGRATION) $(CARGO_FLAGS) $(CARGO_FEATURES) -- $(ARGS)


# Cleans dangling test resources.
test-clean:
	rm -f /dev/shm/demikernel-*


#=======================================================================================================================
# Benchmarks
#=======================================================================================================================

# C unit benchmarks.
run-benchmarks-c: all-benchmarks-c $(BINDIR)/syscalls.elf

	timeout $(TIMEOUT) $(BINDIR)/benchmarks.elf