xref: /DragonOS/Makefile (revision 99dbf38d2e279ea70e9e186753fd37001dbb749f)
1SUBDIRS = kernel user tools build-scripts
2
3# ifndef $(EMULATOR)
4ifeq ($(EMULATOR), )
5export EMULATOR=__NO_EMULATION__
6endif
7# todo: 增加参数,判断是否在QEMU中仿真,若是,则启用该环境变量
8# export EMULATOR=__QEMU_EMULATION__
9
10# 计算cpu核心数
11NPROCS:=1
12OS:=$(shell uname -s)
13
14ifeq ($(OS),Linux)
15  NPROCS:=$(shell grep -c ^processor /proc/cpuinfo)
16endif
17ifeq ($(OS),Darwin) # Assume Mac OS X
18  NPROCS:=$(shell system_profiler | awk '/Number Of CPUs/{print $4}{next;}')
19endif
20
21export ARCH=__x86_64__
22export ROOT_PATH=$(shell pwd)
23
24export DEBUG=DEBUG
25export GLOBAL_CFLAGS := -mcmodel=large -fno-builtin -m64  -fno-stack-protector -D $(ARCH) -D $(EMULATOR) -O1
26
27ifeq ($(DEBUG), DEBUG)
28GLOBAL_CFLAGS += -g
29endif
30
31
32export CC=$(DragonOS_GCC)/x86_64-elf-gcc
33export LD=ld
34export AS=$(DragonOS_GCC)/x86_64-elf-as
35export NM=$(DragonOS_GCC)/x86_64-elf-nm
36export AR=$(DragonOS_GCC)/x86_64-elf-ar
37export OBJCOPY=$(DragonOS_GCC)/x86_64-elf-objcopy
38
39# 检查是否需要进行fmt --check
40# 解析命令行参数
41FMT_CHECK?=0
42
43ifeq ($(FMT_CHECK), 1)
44	FMT_CHECK=--check
45else
46	FMT_CHECK=
47endif
48
49
50.PHONY: all
51all: kernel user
52
53
54.PHONY: kernel
55kernel:
56	mkdir -p bin/kernel/
57	@if [ -z $$DragonOS_GCC ]; then echo "\033[31m  [错误]尚未安装DragonOS交叉编译器, 请使用tools文件夹下的build_gcc_toolchain.sh脚本安装  \033[0m"; exit 1; fi
58	$(MAKE) -C ./kernel all || (sh -c "echo 内核编译失败" && exit 1)
59
60.PHONY: user
61user:
62
63	@if [ -z $$DragonOS_GCC ]; then echo "\033[31m  [错误]尚未安装DragonOS交叉编译器, 请使用tools文件夹下的build_gcc_toolchain.sh脚本安装  \033[0m"; exit 1; fi
64	$(MAKE) -C ./user all || (sh -c "echo 用户程序编译失败" && exit 1)
65
66.PHONY: clean
67clean:
68	@list='$(SUBDIRS)'; for subdir in $$list; do \
69		echo "Clean in dir: $$subdir";\
70		cd $$subdir && $(MAKE) clean;\
71		cd .. ;\
72	done
73
74.PHONY: ECHO
75ECHO:
76	@echo "$@"
77
78cppcheck-xml:
79	cppcheck kernel user --platform=unix64 --std=c11 -I user/libs/ -I=kernel/ --force -j $(NPROCS) --xml 2> cppcheck.xml
80
81cppcheck:
82	cppcheck kernel user --platform=unix64 --std=c11 -I user/libs/ -I=kernel/ --force -j $(NPROCS)
83
84docs: ECHO
85	bash -c "cd docs && make html && cd .."
86
87clean-docs:
88	bash -c "cd docs && make clean && cd .."
89
90gdb:
91	rust-gdb -n -x tools/.gdbinit
92
93# 写入磁盘镜像
94write_diskimage:
95	bash -c "cd tools && bash grub_auto_install.sh && sudo bash $(ROOT_PATH)/tools/write_disk_image.sh --bios=legacy && cd .."
96
97# 写入磁盘镜像(uefi)
98write_diskimage-uefi:
99	bash -c "cd tools && bash grub_auto_install.sh && sudo bash $(ROOT_PATH)/tools/write_disk_image.sh --bios=uefi && cd .."
100# 不编译,直接启动QEMU
101qemu:
102	sh -c "cd tools && bash run-qemu.sh --bios=legacy --display=window && cd .."
103# 不编译,直接启动QEMU(UEFI)
104qemu-uefi:
105	sh -c "cd tools && bash run-qemu.sh --bios=uefi --display=window && cd .."
106# 不编译,直接启动QEMU,使用VNC Display作为图像输出
107qemu-vnc:
108	sh -c "cd tools && bash run-qemu.sh --bios=legacy --display=vnc && cd .."
109# 不编译,直接启动QEMU(UEFI),使用VNC Display作为图像输出
110qemu-uefi-vnc:
111	sh -c "cd tools && bash run-qemu.sh --bios=uefi --display=vnc && cd .."
112
113# 编译并写入磁盘镜像
114build:
115	$(MAKE) all -j $(NPROCS)
116	$(MAKE) write_diskimage || exit 1
117
118# 在docker中编译,并写入磁盘镜像
119docker:
120	@echo "使用docker构建"
121	sudo bash tools/build_in_docker.sh || exit 1
122	$(MAKE) write_diskimage || exit 1
123
124# uefi方式启动
125run-uefi:
126	$(MAKE) all -j $(NPROCS)
127	$(MAKE) write_diskimage-uefi || exit 1
128	$(MAKE) qemu-uefi
129
130# 编译并启动QEMU
131run:
132	$(MAKE) all -j $(NPROCS)
133	$(MAKE) write_diskimage || exit 1
134	$(MAKE) qemu
135
136# uefi方式启动,使用VNC Display作为图像输出
137run-uefi-vnc:
138	$(MAKE) all -j $(NPROCS)
139	$(MAKE) write_diskimage-uefi || exit 1
140	$(MAKE) qemu-uefi-vnc
141
142# 编译并启动QEMU,使用VNC Display作为图像输出
143run-vnc:
144	$(MAKE) all -j $(NPROCS)
145	$(MAKE) write_diskimage || exit 1
146	$(MAKE) qemu-vnc
147
148# 在docker中编译,并启动QEMU
149run-docker:
150	@echo "使用docker构建并运行"
151	sudo bash tools/build_in_docker.sh || exit 1
152	$(MAKE) write_diskimage || exit 1
153	$(MAKE) qemu
154
155fmt:
156	@echo "格式化代码"
157	FMT_CHECK=$(FMT_CHECK) $(MAKE) fmt -C kernel
158	FMT_CHECK=$(FMT_CHECK) $(MAKE) fmt -C user
159	FMT_CHECK=$(FMT_CHECK) $(MAKE) fmt -C build-scripts
160
161log-monitor:
162	@echo "启动日志监控"
163	@sh -c "cd tools/debugging/logmonitor && cargo run --release -- --log-dir $(ROOT_PATH)/logs/ --kernel $(ROOT_PATH)/bin/kernel/kernel.elf"
164
165help:
166	@echo "编译:"
167	@echo "  make all -j <n>       - 本地编译,不运行,n为要用于编译的CPU核心数"
168	@echo "  make build            - 本地编译,并写入磁盘镜像"
169	@echo "  make docker           - Docker编译,并写入磁盘镜像"
170	@echo ""
171	@echo "编译并运行:"
172	@echo "  make run-docker       - Docker编译,写入磁盘镜像,并在QEMU中运行"
173	@echo "  make run              - 本地编译,写入磁盘镜像,并在QEMU中运行"
174	@echo "  make run-uefi         - 以uefi方式启动运行"
175	@echo ""
176	@echo "运行:"
177	@echo "  make qemu             - 不编译,直接从已有的磁盘镜像启动运行"
178	@echo "  make qemu-uefi        - 不编译,直接从已有的磁盘镜像以UEFI启动运行"
179	@echo ""
180	@echo ""
181	@echo "注: 对于上述的run, run-uefi, qemu, qemu-uefi命令可以在命令后加上-vnc后缀,来通过vnc连接到DragonOS, 默认会在5900端口运行vnc服务器。如:make run-vnc "
182