forked from nuta/microkernel-book
/
Makefile
375 lines (323 loc) · 14 KB
/
Makefile
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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# ビルド設定 --------------------------------------------
# CPUアーキテクチャ名 (riscv32のみ有効)
ARCH ?= riscv32
# ビルド時の生成物を置くディレクトリ
BUILD_DIR ?= build
# ClangやLLD、llvm-objcopyなどのLLVMツールチェインのプレフィックス
LLVM_PREFIX ?=
# 自動起動するサーバのリスト
BOOT_SERVERS ?= fs tcpip shell virtio_blk virtio_net pong echo
# 起動時に自動実行するシェルコマンド (テストを自動化したいときに便利)
#
# 例: make AUTORUN="cat hello.txt; shutdown"
AUTORUN ?=
# make V=1: Makefileの実行ログを表示する
V ?=
# make RELEASE=1: デバッグ用の機能の無効化とコンパイラの最適化の強化 (リリースビルド)
RELEASE ?=
# make run CPUS=<CPU数>: QEMUの仮想CPU数を指定する
QEMUFLAGS += -smp $(if $(CPUS),$(CPUS),1)
# make run GUI=1: QEMUのウィンドウを表示する
ifeq ($(GUI),)
QEMUFLAGS += -nographic -serial mon:stdio
endif
# make run GDBSERVER=1: QEMUをデバッガつきで起動する (make gdb と組み合わせて使う)
ifneq ($(GDBSERVER),)
QEMUFLAGS += -S -gdb tcp::7777
endif
# make run QEMU_DEBUG=1: QEMUのデバッグメッセージをqemu-debug.logに出力する
ifneq ($(QEMU_DEBUG),)
QEMUFLAGS += -d unimp,guest_errors,int,cpu_reset -D qemu-debug.log
endif
# -----------------------------------------------------
# ビルドに使うコマンド・変数を定義する
ifeq ($(OS),Windows_NT)
SHELL := cmd
top_dir := $(shell echo %cd%)
PROGRESS ?= echo
PYTHON3 ?= py
RM := $(PYTHON3) $(top_dir)/tools/coreutils.py rm
CP ?= $(PYTHON3) $(top_dir)/tools/coreutils.py cp
MKDIR ?= $(PYTHON3) $(top_dir)/tools/coreutils.py mkdir
FIND ?= $(PYTHON3) $(top_dir)/tools/coreutils.py find
export PYTHONUTF8=1
ifeq ($(LLVM_PREFIX),)
# wingetでインストールされた次のLLVMツールチェーンを使う
# https://winget.run/pkg/LLVM/LLVM
LLVM_PREFIX = "C:/Program Files/llvm/bin/"
endif
else
top_dir := $(shell pwd)
RM := rm
ifeq ($(shell uname), Darwin)
ifeq ($(shell uname -m), arm64)
# Apple Sillicon
HOMEBREW_PREFIX ?= /opt/homebrew/
else
# Intel CPU
HOMEBREW_PREFIX ?= /usr/local/
endif
ifeq ($(LLVM_PREFIX),)
LLVM_PREFIX = $(HOMEBREW_PREFIX)/opt/llvm/bin/
endif
endif
endif
# 暗黙のビルドルールなどを無効化する
MAKEFLAGS += --no-builtin-rules --no-builtin-variables
.SUFFIXES:
# $(V) がセットされていなければ、コマンド実行表示を無効化する
ifeq ($(V),)
.SILENT:
endif
#
# ビルドに必要なコマンド
#
CC := $(LLVM_PREFIX)clang$(LLVM_SUFFIX)
LD := $(LLVM_PREFIX)ld.lld$(LLVM_SUFFIX)
WASMLD := wasm-ld
OBJCOPY := $(LLVM_PREFIX)llvm-objcopy$(LLVM_SUFFIX)
AR := $(LLVM_PREFIX)llvm-ar$(LLVM_SUFFIX)
ADDR2LINE := $(LLVM_PREFIX)llvm-addr2line$(LLVM_SUFFIX)
NM := $(LLVM_PREFIX)llvm-nm$(LLVM_SUFFIX)
GDB ?= riscv64-unknown-elf-gdb
PROGRESS ?= printf " \\033[1;96m%8s\\033[0m \\033[1;m%s\\033[0m\\n"
PYTHON3 ?= python3
CP ?= cp
MKDIR ?= mkdir
FIND ?= find
ECHO ?= echo
# ビルド対象のサーバとライブラリの名前リスト (例: "fs tcpip shell ...")
all_servers := $(notdir $(patsubst %/build.mk, %, $(wildcard servers/*/build.mk)))
wasm_servers := $(filter wasm_%, $(all_servers))
core_servers := $(filter-out $(wasm_servers), $(all_servers))
all_libs := $(notdir $(patsubst %/build.mk, %, $(wildcard libs/*/build.mk)))
# リンカーとCコンパイラのオプション
LDFLAGS :=
CFLAGS :=
CFLAGS += -g3 -std=c11 -ffreestanding -fno-builtin -nostdlib -nostdinc
CFLAGS += -fno-omit-frame-pointer -fno-optimize-sibling-calls -fstack-size-section
CFLAGS += -Wall -Wextra
CFLAGS += -Werror=implicit-function-declaration
CFLAGS += -Werror=int-conversion
CFLAGS += -Werror=incompatible-pointer-types
CFLAGS += -Werror=shift-count-overflow
CFLAGS += -Werror=switch
CFLAGS += -Werror=return-type
CFLAGS += -Werror=pointer-integer-compare
CFLAGS += -Werror=tautological-constant-out-of-range-compare
CFLAGS += -Werror=visibility
CFLAGS += -Wno-unused-parameter
# トップディレクトリをインクルードパスに追加する
CFLAGS += -I$(top_dir)
# 各ライブラリの "libs/<ライブラリ名>/<CPUアーキテクチャ名>" をインクルードパスに追加する
CFLAGS += $(foreach lib,$(all_libs),-Ilibs/$(lib)/$(ARCH))
# RISC-V特有のコンパイラオプション
ifeq ($(ARCH),riscv32)
CFLAGS += --target=riscv32 -mno-relax
endif
ifeq ($(RELEASE),)
# デバッグビルド
CFLAGS += -O1 -fsanitize=undefined -DDEBUG_BUILD
else
# リリースビルド
CFLAGS += -O3 -DRELEASE_BUILD
endif
# Compiler flags to build .wasm
WASMCFLAGS := $(filter-out -mno-relax -fsanitize=undefined, $(CFLAGS))
WASMCFLAGS += --target=wasm32
# Linker flags to build .wasm
WASMLDFLAGS :=
WASMLDFLAGS += --strip-all
WASMLDFLAGS += --no-entry
WASMLDFLAGS += --allow-undefined
# エミュレータ (QEMU) の起動コマンド
QEMU ?= $(QEMU_PREFIX)qemu-system-riscv32
QEMUFLAGS += --no-reboot -m 128 -machine virt,aclint=on -bios none
QEMUFLAGS += -global virtio-mmio.force-legacy=true
QEMUFLAGS += -drive file=$(hinafs_img),if=none,format=raw,id=drive0
QEMUFLAGS += -device virtio-blk-device,drive=drive0,bus=virtio-mmio-bus.0
QEMUFLAGS += -device virtio-net-device,netdev=net0,bus=virtio-mmio-bus.1
QEMUFLAGS += -object filter-dump,id=fiter0,netdev=net0,file=virtio-net.pcap
QEMUFLAGS += -netdev user,id=net0
wasmos_elf := $(BUILD_DIR)/wasmos.elf
boot_elf := $(BUILD_DIR)/servers/vm.elf
bootfs_bin := $(BUILD_DIR)/bootfs.bin
hinafs_img := $(BUILD_DIR)/hinafs.img
# Commands to build WASMOS
.PHONY: build
build: $(wasmos_elf) $(hinafs_img)
$(PROGRESS) GEN $(BUILD_DIR)/compile_commands.json
$(PYTHON3) ./tools/merge_compile_commands_json.py -o $(BUILD_DIR)/compile_commands.json $(BUILD_DIR)
$(PYTHON3) ./tools/print_build_info.py --kernel-elf $(wasmos_elf) --bootfs-bin $(bootfs_bin) --hinafs-img $(hinafs_img)
# ビルド時に生成されたファイルたちを消すコマンド
.PHONY: clean
clean:
$(RM) -rf $(BUILD_DIR)
# QEMU (エミュレータ) でHinaOSを試すコマンド
.PHONY: run
run: build
$(PROGRESS) QEMU $(wasmos_elf)
$(QEMU) $(QEMUFLAGS) -kernel $(wasmos_elf)
# GDBでQEMUに接続するコマンド (make run GDBSERVER=1 と組み合わせて使う)
.PHONY: gdb
gdb:
$(PROGRESS) GEN $(BUILD_DIR)/gdbinit
$(PYTHON3) ./tools/generate_gdbinit.py -o $(BUILD_DIR)/gdbinit $(wasmos_elf).gdb $(wildcard $(BUILD_DIR)/servers/*.elf.gdb)
$(PROGRESS) GDB $(BUILD_DIR)/gdbinit
$(GDB) -q -ex "source $(BUILD_DIR)/gdbinit"
# Automated test
export QEMUFLAGS
.PHONY: test
test:
$(PYTHON3) \
-m pytest tests -p no:cacheprovider \
--qemu $(QEMU) \
$(if $(FLAKE_RUNS),--flake-finder --flake-runs=$(FLAKE_RUNS))
# トラブルシューティングに役立つ情報を表示するコマンド
.PHONY: doctor
doctor:
$(ECHO) "OS: $(shell $(PYTHON3) -m platform)"
$(ECHO) "PYTHON3: $(shell $(PYTHON3) --version)"
$(ECHO) "CC: $(shell $(CC) --version)"
$(ECHO) "LD: $(shell $(LD) --version)"
$(ECHO) "QEMU: $(shell $(QEMU) --version)"
$(ECHO) "OBJCOPY: $(shell $(OBJCOPY) --version)"
$(ECHO) "MAKE: $(shell $(MAKE) --version)"
# Rules to build kernel executable (build/wasmos.elf)
executable := $(wasmos_elf)
name := kernel
dir := kernel
build_dir := $(BUILD_DIR)/kernel
objs-y :=
cflags-y := -DKERNEL -DBOOT_ELF_PATH='"$(boot_elf)"' -Ikernel/$(ARCH)/include
ldflags-y := -T$(BUILD_DIR)/kernel/kernel.ld
libs-y := common
extra-deps-y := $(BUILD_DIR)/kernel/kernel.ld
include kernel/build.mk
include mk/executable.mk
# ライブラリの生成ルール (build/libs/<ライブラリ名>.o)
$(foreach lib, $(all_libs), \
$(eval dir := libs/$(lib)) \
$(eval build_dir := $(BUILD_DIR)/$(dir)) \
$(eval output := $(BUILD_DIR)/libs/$(lib).o) \
$(eval objs-y :=) \
$(eval cflags-y :=) \
$(eval ldflags-y :=) \
$(eval subdirs-y :=) \
$(eval include $(dir)/build.mk) \
$(eval include $(top_dir)/mk/lib.mk) \
)
# Build rule for core servers (build/servers/*.elf)
$(foreach server, $(core_servers), \
$(eval dir := servers/$(server)) \
$(eval build_dir := $(BUILD_DIR)/$(dir)) \
$(eval executable := $(BUILD_DIR)/servers/$(server).elf) \
$(eval name := $(server)) \
$(eval objs-y :=) \
$(eval libs-y := common user) \
$(eval cflags-y :=) \
$(eval ldflags-y := -T$(BUILD_DIR)/servers/$(server)/user.ld) \
$(eval subdirs-y :=) \
$(eval extra-deps-y := $(BUILD_DIR)/servers/$(server)/user.ld) \
$(eval include $(dir)/build.mk) \
$(eval include $(top_dir)/mk/executable.mk) \
)
# Build rule for wasm servers (build/servers/*.wasm)
$(foreach server, $(wasm_servers), \
$(eval dir := servers/$(server)) \
$(eval build_dir := $(BUILD_DIR)/$(dir)) \
$(eval executable := $(BUILD_DIR)/servers/$(server).wasm) \
$(eval name := $(server)) \
$(eval objs-y :=) \
$(eval libs-y := wasm) \
$(eval cflags-y :=) \
$(eval ldflags-y :=) \
$(eval subdirs-y :=) \
$(eval extra-deps-y :=) \
$(eval include $(dir)/build.mk) \
$(eval include $(top_dir)/mk/wasm.mk) \
)
# Cファイルのコンパイル規則
$(BUILD_DIR)/%.o: %.c Makefile $(BUILD_DIR)/consts.mk libs/common/ipcstub.h
$(PROGRESS) CC $<
$(MKDIR) -p $(@D)
$(CC) $(CFLAGS) -c -o $@ $< -MD -MF $(@:.o=.deps) -MJ $(@:.o=.json)
# Build rule for *.wasm.o
# Remove compiler flags specific to riscv and add ones for WAS
$(BUILD_DIR)/%.wasm.o: %.c Makefile $(BUILD_DIR)/consts.mk libs/common/ipcstub.h
$(PROGRESS) CC $<
$(MKDIR) -p $(@D)
$(CC) $(WASMCFLAGS) -c -o $@ $< -MD -MF $(@:.o=.deps) -MJ $(@:.o=.json)
# ビルドディレクトリ下にある (自動生成される) Cファイルのコンパイル規則
$(BUILD_DIR)/%.o: $(BUILD_DIR)/%.c Makefile $(BUILD_DIR)/consts.mk libs/common/ipcstub.h
$(PROGRESS) CC $<
$(MKDIR) -p $(@D)
$(CC) $(CFLAGS) -c -o $@ $< -MD -MF $(@:.o=.deps) -MJ $(@:.o=.json)
# アセンブリファイルのコンパイル規則
$(BUILD_DIR)/%.o: %.S Makefile
$(PROGRESS) CC $<
$(MKDIR) -p $(@D)
$(CC) $(CFLAGS) -c -o $@ $< -MD -MF $(@:.o=.deps) -MJ $(@:.o=.json)
# ビルドディレクトリ下にある (自動生成される) アセンブリファイルのコンパイル規則
$(BUILD_DIR)/%.o: $(BUILD_DIR)/%.S Makefile
$(PROGRESS) CC $<
$(MKDIR) -p $(@D)
$(CC) $(CFLAGS) -c -o $@ $< -MD -MF $(@:.o=.deps) -MJ $(@:.o=.json)
# bootfsイメージ
server_elf_files := $(foreach server, $(filter-out vm, $(core_servers)), $(BUILD_DIR)/bootfs/$(server).elf)
server_wasm_files := $(foreach server, $(wasm_servers), $(BUILD_DIR)/bootfs/$(server).wasm)
$(bootfs_bin): $(server_elf_files) $(server_wasm_files) tools/mkbootfs.py
$(PROGRESS) MKBOOTFS $@
$(MKDIR) -p $(@D)
$(PYTHON3) ./tools/mkbootfs.py -o $@ $(BUILD_DIR)/bootfs
# bootfsの中身を生成するためのルール
$(BUILD_DIR)/bootfs/%.elf: $(BUILD_DIR)/servers/%.elf
$(MKDIR) -p $(@D)
$(CP) $< $@
$(BUILD_DIR)/bootfs/%.wasm: $(BUILD_DIR)/servers/%.wasm
$(MKDIR) -p $(@D)
$(CP) $< $@
# hinafsイメージ
$(hinafs_img): ./tools/mkhinafs.py $(wildcard fs/*)
$(PROGRESS) MKFS $@
$(MKDIR) -p $(@D)
$(PYTHON3) ./tools/mkhinafs.py $(@) fs
# メッセージ定義ファイル
libs/common/ipcstub.h: messages.idl tools/generate_ipcstub.py
$(PROGRESS) IPCSTUB $@
$(MKDIR) -p $(@D)
$(PYTHON3) ./tools/generate_ipcstub.py -o $@ messages.idl
# カーネルのリンカスクリプト
$(BUILD_DIR)/kernel/kernel.ld: kernel/$(ARCH)/kernel.ld.template
$(PROGRESS) CPP $@
$(MKDIR) -p $(@D)
$(CC) $(CFLAGS) -E -x c -o $@ $<
# ユーザープログラムのリンカスクリプトで使われる定数
$(BUILD_DIR)/user_ld_params.h: tools/generate_user_ld_params.py $(BUILD_DIR)/consts.mk
$(PROGRESS) GEN $@
$(MKDIR) -p $(@D)
$(PYTHON3) ./tools/generate_user_ld_params.py -o $@ $(core_servers)
# ユーザープログラムのリンカスクリプト
$(BUILD_DIR)/servers/%/user.ld: libs/user/$(ARCH)/user.ld.template $(BUILD_DIR)/user_ld_params.h
$(PROGRESS) CPP $@
$(MKDIR) -p $(@D)
$(CC) $(CFLAGS) -E -x c -o $@ $< \
-DSERVER_$(patsubst $(BUILD_DIR)/servers/%/user.ld,%,$@) \
-include $(BUILD_DIR)/user_ld_params.h
# makeのコマンドライン引数や環境変数から指定できるビルド設定が変更された場合に、すべてのファイル
# を再コンパイルするためのギミック。
build_vars := ARCH BUILD_DIR BOOT_SERVERS AUTORUN RELEASE core_servers wasm_servers
$(BUILD_DIR)/consts.mk: FORCE
$(PROGRESS) UPDATE $@
$(MKDIR) -p $(@D)
$(PYTHON3) ./tools/update_file_if_changed.py $@ \
"$(foreach var,$(build_vars),$(var)=$(value $(var));)"
FORCE:
# 前回ビルド時にCコンパイラが生成したヘッダーの依存関係を読み込む。初回ビルドでは何もしない。
ifneq ($(wildcard $(BUILD_DIR)),)
dep_files := $(shell $(FIND) $(BUILD_DIR) -name '*.deps')
ifneq ($(dep_files),)
-include $(dep_files)
%.deps: %.c
endif
endif