Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
359 lines (313 loc) · 13.8 KB
/
Copy pathMakefile
File metadata and controls
359 lines (313 loc) · 13.8 KB
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
LIBRARY_HEADER = include/libkrun.h
LIBRARY_HEADER_DISPLAY = include/libkrun_display.h
LIBRARY_HEADER_INPUT = include/libkrun_input.h
LIBRARY_HEADER_INIT = include/libkrun_init.h
ABI_VERSION=2
FULL_VERSION=2.0.0
KRUN_INIT_ABI_VERSION=0
KRUN_INIT_FULL_VERSION=0.1.0
KRUN_INIT_BINARY_Linux = libkrun_init.so.$(KRUN_INIT_FULL_VERSION)
KRUN_INIT_SONAME_Linux = libkrun_init.so.$(KRUN_INIT_ABI_VERSION)
KRUN_INIT_BASE_Linux = libkrun_init.so
KRUN_INIT_BINARY_Darwin = libkrun_init.$(KRUN_INIT_FULL_VERSION).dylib
KRUN_INIT_SONAME_Darwin = libkrun_init.$(KRUN_INIT_ABI_VERSION).dylib
KRUN_INIT_BASE_Darwin = libkrun_init.dylib
# Install prefix for `make test` and, going forward, the examples. Defined
# early so goal names (e.g. `test-prefix`) and their recipes reference one
# symbol; renaming the directory is a single-line change.
TEST_PREFIX = test-prefix
ifeq ($(SEV),1)
VARIANT = -sev
FEATURE_FLAGS := --features amd-sev
endif
ifeq ($(TDX),1)
VARIANT = -tdx
FEATURE_FLAGS := --features tdx
endif
ifeq ($(VIRGL_RESOURCE_MAP2),1)
FEATURE_FLAGS += --features virgl_resource_map2
endif
# Test targets require the block device (BLK) feature for FreeBSD disk tests
# and the NET feature for gvproxy-based network tests. The FFI feature (weak
# linking tests) is enabled by default (see FFI below). Enable BLK/NET
# automatically unless the user explicitly set them to a value.
ifeq ($(BLK),)
ifneq ($(filter test $(TEST_PREFIX),$(MAKECMDGOALS)),)
BLK := 1
endif
endif
ifeq ($(NET),)
ifneq ($(filter test $(TEST_PREFIX),$(MAKECMDGOALS)),)
NET := 1
endif
endif
ifeq ($(INIT_BLOB),0)
FEATURE_FLAGS += --no-default-features
endif
ifeq ($(BLK),1)
FEATURE_FLAGS += --features blk
endif
ifeq ($(NET),1)
FEATURE_FLAGS += --features net
endif
ifeq ($(GPU),1)
FEATURE_FLAGS += --features gpu
endif
ifeq ($(INPUT),1)
FEATURE_FLAGS += --features input
endif
ifeq ($(VHOST_USER),1)
FEATURE_FLAGS += --features vhost-user
endif
ifeq ($(TIMESYNC),1)
FEATURE_FLAGS += --features timesync
endif
# The C ABI export bridge (ffier) is built by default so the installed
# libkrun.so always carries its C API. Pass FFI=0 for a pure-Rust build.
FFI ?= 1
ifeq ($(FFI),1)
FEATURE_FLAGS += --features ffi
endif
ifeq ($(AWS_NITRO),1)
VARIANT = -awsnitro
FEATURE_FLAGS += --features aws-nitro,net
endif
CLANG = /usr/bin/clang
OS = $(shell uname -s)
ARCH = $(shell uname -m)
FREEBSD_VERSION ?= 14.5-RELEASE
FREEBSD_ROOTFS_DIR = freebsd-sysroot
KRUN_BINARY_Linux = libkrun$(VARIANT).so.$(FULL_VERSION)
KRUN_SONAME_Linux = libkrun$(VARIANT).so.$(ABI_VERSION)
KRUN_BASE_Linux = libkrun$(VARIANT).so
KRUN_BINARY_Darwin = libkrun$(VARIANT).$(FULL_VERSION).dylib
KRUN_SONAME_Darwin = libkrun$(VARIANT).$(ABI_VERSION).dylib
KRUN_BASE_Darwin = libkrun$(VARIANT).dylib
LIBRARY_RELEASE_Linux = target/release/$(KRUN_BINARY_Linux)
LIBRARY_DEBUG_Linux = target/debug/$(KRUN_BINARY_Linux)
LIBRARY_RELEASE_Darwin = target/release/$(KRUN_BINARY_Darwin)
LIBRARY_DEBUG_Darwin = target/debug/$(KRUN_BINARY_Darwin)
LIBDIR_Linux = $(shell if [ -e /etc/debian_version ]; then echo 'lib/$(ARCH)-linux-gnu'; else echo lib64; fi)
LIBDIR_Darwin = lib
ifeq ($(PREFIX),)
PREFIX := /usr/local
endif
.PHONY: install clean test $(TEST_PREFIX) gen-libkrun-bindings gen-init-blob-bindings $(LIBRARY_RELEASE_$(OS)) $(LIBRARY_DEBUG_$(OS)) libkrun.pc libkrun_init.pc clean-sysroot clean-all
all: $(LIBRARY_RELEASE_$(OS)) libkrun.pc libkrun_init.pc
debug: $(LIBRARY_DEBUG_$(OS)) libkrun.pc libkrun_init.pc
# Regenerate ffier bindings for libkrun.
# The Rust client is generated at compile time from the committed JSON
# (see bindings/libkrun-via-libc/build.rs). Run this after changing the
# libkrun ffier API.
#
# Optional device API is emitted as if every unlisted feature were enabled.
# `tee` and `aws-nitro` change which API exists, so the header guards both and
# the consumer selects what its library was built with.
#
# Neither can be left assumed-enabled. `FsDevice` and `FsOverlay` are gated
# `not(any(tee, aws-nitro))`, so assuming aws-nitro on would drop them from the
# default header.
GEN_HEADER_FFIER_FLAGS ?= --guard-features tee,aws-nitro
gen-libkrun-bindings:
cargo build -p libkrun --features ffi $(FEATURE_FLAGS)
cp target/ffier-krun.json bindings/libkrun-via-libc/ffier-krun.json
{ echo '/* @generated by: make gen-libkrun-bindings — do not edit manually. */'; \
ffier-gen-c-header --fn-typedefs $(GEN_HEADER_FFIER_FLAGS) target/ffier-krun.json LIBKRUN_H; } > $(LIBRARY_HEADER)
# Regenerate the ffier JSON schema and C header for init-blob.
# The Rust client is generated at compile time from the committed JSON
# (see bindings/init-blob-via-cdylib/build.rs). Run this after changing the
# init-blob ffier API.
gen-init-blob-bindings:
cargo build -p krun-init-blob --no-default-features --features ffi,libkrun-via-libc/ffier-dynlookup
cp target/ffier-krun_init.json bindings/init-blob-via-cdylib/ffier-krun_init.json
{ echo '/* @generated by: make gen-init-blob-bindings — do not edit manually. */'; \
ffier-gen-c-header --fn-typedefs target/ffier-krun_init.json LIBKRUN_INIT_H; } > $(LIBRARY_HEADER_INIT)
ifeq ($(AWS_NITRO), 1)
AWS_NITRO_MUSL_TARGET = $(ARCH)-unknown-linux-musl
AWS_NITRO_INIT_BINARY= init/aws-nitro/init
$(AWS_NITRO_INIT_BINARY): init/aws-nitro/Cargo.toml $(shell find init/aws-nitro/src -name '*.rs' 2>/dev/null)
cargo build --release --manifest-path init/aws-nitro/Cargo.toml \
--target $(AWS_NITRO_MUSL_TARGET)
cp init/aws-nitro/target/$(AWS_NITRO_MUSL_TARGET)/release/krun-init-awsnitro $@
endif
ifeq ($(OS),Darwin)
# macOS -> FreeBSD cross-compilation
ifeq ($(SYSROOT_BSD),)
SYSROOT_BSD = $(FREEBSD_ROOTFS_DIR)
SYSROOT_BSD_TARGET = $(FREEBSD_ROOTFS_DIR)/.sysroot_ready
else
SYSROOT_BSD_TARGET =
endif
# Cross-compile on macOS with the LLVM linker (brew install lld)
CC_BSD=$(CLANG) -target $(ARCH)-unknown-freebsd -fuse-ld=lld -stdlib=libc++ -Wl,-strip-debug --sysroot $(SYSROOT_BSD)
CARGO_BSD_RUSTFLAGS = -C linker=$(CLANG) -C link-arg=-target -C link-arg=$(ARCH)-unknown-freebsd -C link-arg=-fuse-ld=lld -C link-arg=-stdlib=libc++ -C link-arg=--sysroot=$(abspath $(SYSROOT_BSD)) -C target-feature=+crt-static
else ifeq ($(OS),Linux)
# Linux -> FreeBSD cross-compilation
ifeq ($(SYSROOT_BSD),)
SYSROOT_BSD = $(FREEBSD_ROOTFS_DIR)
SYSROOT_BSD_TARGET = $(FREEBSD_ROOTFS_DIR)/.sysroot_ready
else
SYSROOT_BSD_TARGET =
endif
# Cross-compile on Linux with clang
CC_BSD=$(CLANG) -target $(ARCH)-unknown-freebsd -fuse-ld=lld -Wl,-strip-debug --sysroot $(SYSROOT_BSD)
CARGO_BSD_RUSTFLAGS = -C linker=$(CLANG) -C link-arg=-target -C link-arg=$(ARCH)-unknown-freebsd -C link-arg=-fuse-ld=lld -C link-arg=--sysroot=$(abspath $(SYSROOT_BSD)) -C target-feature=+crt-static
else
# Build on FreeBSD host
CC_BSD=$(CC)
SYSROOT_BSD_TARGET =
CARGO_BSD_RUSTFLAGS = -C target-feature=+crt-static
endif
FREEBSD_RUST_TARGET = $(subst arm64,aarch64,$(ARCH))-unknown-freebsd
# aarch64-unknown-freebsd is Tier 3: no prebuilt std, requires nightly + build-std.
ifeq ($(FREEBSD_RUST_TARGET),aarch64-unknown-freebsd)
CARGO_BSD_TOOLCHAIN = +nightly
CARGO_BSD_EXTRA_FLAGS = -Z build-std
else
CARGO_BSD_TOOLCHAIN =
CARGO_BSD_EXTRA_FLAGS =
endif
ifeq ($(BUILD_BSD_INIT),1)
INIT_BINARY_BSD = init/init-binary/init-freebsd
$(INIT_BINARY_BSD): $(shell find init/init-binary/src -name '*.rs') init/init-binary/Cargo.toml $(SYSROOT_BSD_TARGET)
RUSTFLAGS="$(CARGO_BSD_RUSTFLAGS)" \
cargo $(CARGO_BSD_TOOLCHAIN) build --release \
$(CARGO_BSD_EXTRA_FLAGS) \
--manifest-path init/init-binary/Cargo.toml \
--target $(FREEBSD_RUST_TARGET)
cp init/init-binary/target/$(FREEBSD_RUST_TARGET)/release/krun-init $@
endif
# FreeBSD sysroot preparation rules for cross-compilation on macOS
FREEBSD_BASE_TXZ = $(FREEBSD_ROOTFS_DIR)/base.txz
.INTERMEDIATE: $(FREEBSD_BASE_TXZ)
$(FREEBSD_ROOTFS_DIR)/.sysroot_ready: $(FREEBSD_BASE_TXZ)
@echo "Extracting FreeBSD base to $(FREEBSD_ROOTFS_DIR)..."
@cd $(FREEBSD_ROOTFS_DIR) && tar xJf base.txz 2>/dev/null || true
@touch $@
BSD_ARCH=$(subst x86_64,amd64,$(subst aarch64,arm64,$(ARCH)))
$(FREEBSD_BASE_TXZ):
@echo "Downloading FreeBSD $(FREEBSD_VERSION) base for $(BSD_ARCH)..."
@mkdir -p $(FREEBSD_ROOTFS_DIR)
@curl -fL -o $@ https://download.freebsd.org/releases/$(BSD_ARCH)/$(FREEBSD_VERSION)/base.txz
clean-sysroot:
rm -rf $(FREEBSD_ROOTFS_DIR)
$(LIBRARY_RELEASE_$(OS)): $(INIT_BINARY_BSD) $(AWS_NITRO_INIT_BINARY)
cargo build --release -p libkrun $(FEATURE_FLAGS)
cargo build --release -p krun-init-blob --no-default-features --features ffi,libkrun-via-libc/ffier-dynlookup
ifeq ($(SEV),1)
mv target/release/libkrun.so target/release/$(KRUN_BASE_$(OS))
endif
ifeq ($(AWS_NITRO),1)
mv target/release/libkrun.so target/release/$(KRUN_BASE_$(OS))
endif
ifeq ($(TDX),1)
mv target/release/libkrun.so target/release/$(KRUN_BASE_$(OS))
endif
ifeq ($(OS),Darwin)
ifneq ($(KRUN_BASE_$(OS)),libkrun.dylib)
mv target/release/libkrun.dylib target/release/$(KRUN_BASE_$(OS))
endif
endif
cp target/release/$(KRUN_BASE_$(OS)) $(LIBRARY_RELEASE_$(OS))
cp target/release/$(KRUN_INIT_BASE_$(OS)) target/release/$(KRUN_INIT_BINARY_$(OS))
$(LIBRARY_DEBUG_$(OS)): $(INIT_BINARY_BSD)
cargo build -p libkrun $(FEATURE_FLAGS)
cargo build -p krun-init-blob --no-default-features --features ffi,libkrun-via-libc/ffier-dynlookup
ifeq ($(SEV),1)
mv target/debug/libkrun.so target/debug/$(KRUN_BASE_$(OS))
endif
ifeq ($(TDX),1)
mv target/debug/libkrun.so target/debug/$(KRUN_BASE_$(OS))
endif
cp target/debug/$(KRUN_BASE_$(OS)) $(LIBRARY_DEBUG_$(OS))
cp target/debug/$(KRUN_INIT_BASE_$(OS)) target/debug/$(KRUN_INIT_BINARY_$(OS))
libkrun.pc: libkrun.pc.in Makefile
rm -f $@ $@-t
sed -e 's|@prefix@|$(PREFIX)|' \
-e 's|@libdir@|$(PREFIX)/$(LIBDIR_$(OS))|' \
-e 's|@includedir@|$(PREFIX)/include|' \
-e 's|@PACKAGE_NAME@|libkrun|' \
-e 's|@PACKAGE_VERSION@|$(FULL_VERSION)|' \
libkrun.pc.in > $@-t
mv $@-t $@
libkrun_init.pc: libkrun_init.pc.in Makefile
rm -f $@ $@-t
sed -e 's|@prefix@|$(PREFIX)|' \
-e 's|@libdir@|$(PREFIX)/$(LIBDIR_$(OS))|' \
-e 's|@includedir@|$(PREFIX)/include|' \
-e 's|@PACKAGE_NAME@|libkrun_init|' \
-e 's|@PACKAGE_VERSION@|$(KRUN_INIT_FULL_VERSION)|' \
libkrun_init.pc.in > $@-t
mv $@-t $@
install: libkrun.pc libkrun_init.pc
install -d $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/
install -d $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/pkgconfig
install -d $(DESTDIR)$(PREFIX)/include
install -m 644 $(LIBRARY_HEADER) $(DESTDIR)$(PREFIX)/include
install -m 644 $(LIBRARY_HEADER_DISPLAY) $(DESTDIR)$(PREFIX)/include
install -m 644 $(LIBRARY_HEADER_INPUT) $(DESTDIR)$(PREFIX)/include
install -m 644 $(LIBRARY_HEADER_INIT) $(DESTDIR)$(PREFIX)/include
install -m 644 libkrun.pc $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/pkgconfig
install -m 644 libkrun_init.pc $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/pkgconfig
install -m 755 $(LIBRARY_RELEASE_$(OS)) $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/
cd $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/ ; ln -sf $(KRUN_BINARY_$(OS)) $(KRUN_SONAME_$(OS)) ; ln -sf $(KRUN_SONAME_$(OS)) $(KRUN_BASE_$(OS))
install -m 755 target/release/$(KRUN_INIT_BINARY_$(OS)) $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/
cd $(DESTDIR)$(PREFIX)/$(LIBDIR_$(OS))/ ; ln -sf $(KRUN_INIT_BINARY_$(OS)) $(KRUN_INIT_SONAME_$(OS)) ; ln -sf $(KRUN_INIT_SONAME_$(OS)) $(KRUN_INIT_BASE_$(OS))
clean:
ifeq ($(BUILD_BSD_INIT),1)
rm -f $(INIT_BINARY_BSD)
endif
ifeq ($(AWS_NITRO), 1)
rm -f $(AWS_NITRO_INIT_BINARY)
endif
cargo clean
rm -rf $(TEST_PREFIX)
cd tests; cargo clean
clean-all: clean clean-sysroot
$(TEST_PREFIX)/$(LIBDIR_$(OS))/libkrun.pc: $(LIBRARY_RELEASE_$(OS))
mkdir -p $(TEST_PREFIX)
PREFIX="$$(realpath $(TEST_PREFIX))" make install
# Build and install libkrunfw from a source tree into $(TEST_PREFIX).
# Usage: make test LIBKRUNFW_SRC=/path/to/libkrunfw
ifdef LIBKRUNFW_SRC
.PHONY: $(TEST_PREFIX)-libkrunfw
$(TEST_PREFIX)-libkrunfw:
$(MAKE) -C $(LIBKRUNFW_SRC)
mkdir -p $(TEST_PREFIX)
PREFIX="$$(realpath $(TEST_PREFIX))" $(MAKE) -C $(LIBKRUNFW_SRC) install
$(TEST_PREFIX): $(TEST_PREFIX)/$(LIBDIR_$(OS))/libkrun.pc $(TEST_PREFIX)-libkrunfw
else
$(TEST_PREFIX): $(TEST_PREFIX)/$(LIBDIR_$(OS))/libkrun.pc
@if ls $(TEST_PREFIX)/$(LIBDIR_$(OS))/libkrunfw* >/dev/null 2>&1; then \
echo "WARNING: $(TEST_PREFIX) contains a custom libkrunfw from a previous LIBKRUNFW_SRC= run." >&2; \
echo " Tests will use it instead of the system libkrunfw." >&2; \
echo " To reset, run: rm -rf $(TEST_PREFIX)" >&2; \
fi
endif
TEST ?= *
TEST_FLAGS ?=
# Extra library paths needed for tests (libkrunfw, llvm)
EXTRA_LIBPATH_Linux =
EXTRA_LIBPATH_Darwin = /opt/homebrew/opt/libkrunfw/lib:/opt/homebrew/opt/llvm/lib
# On macOS, SIP strips DYLD_LIBRARY_PATH when executing scripts via a shebang,
# so we pass the path via LIBKRUN_LIB_PATH and let run.sh set the real variable.
# Static test runs normally need no $(TEST_PREFIX) at all, but a custom
# libkrunfw is still dlopen'd by libkrun at runtime. Include a copy already
# installed in $(TEST_PREFIX), even when LIBKRUNFW_SRC is omitted later.
ifdef LIBKRUNFW_SRC
TEST_STATIC_DEPS = $(TEST_PREFIX)-libkrunfw
endif
ifneq ($(strip $(LIBKRUNFW_SRC) $(wildcard $(TEST_PREFIX)/$(LIBDIR_$(OS))/libkrunfw*)),)
TEST_LIBPATH = $$(realpath ../$(TEST_PREFIX)/$(LIBDIR_$(OS)))/:$(EXTRA_LIBPATH_$(OS))
else
TEST_LIBPATH = $(EXTRA_LIBPATH_$(OS))
endif
ifeq ($(FFI),1)
test: $(TEST_PREFIX)
cd tests; RUST_LOG=trace KRUN_TEST_FFI=$(FFI) LIBKRUN_LIB_PATH="$$(realpath ../$(TEST_PREFIX)/$(LIBDIR_$(OS)))/:$(EXTRA_LIBPATH_$(OS))" PKG_CONFIG_PATH="$$(realpath ../$(TEST_PREFIX)/$(LIBDIR_$(OS))/pkgconfig/)" ./run.sh test --test-case "$(TEST)" $(TEST_FLAGS)
else
# Static-linking test run: the runner links libkrun at compile time, so no
# libkrun build/install into $(TEST_PREFIX) is needed (and libkrun.so is not built).
test: $(TEST_STATIC_DEPS)
cd tests; RUST_LOG=trace KRUN_TEST_FFI=$(FFI) LIBKRUN_LIB_PATH="$(TEST_LIBPATH)" ./run.sh test --test-case "$(TEST)" $(TEST_FLAGS)
endif