MIT6.S081 LAB00 Makefile分析

XV6操作系统启动学习

解析Makefile

K=kernel
U=user

OBJS = \
  $K/entry.o \
  $K/start.o \
  $K/console.o \
  $K/printf.o \
  $K/uart.o \
  $K/kalloc.o \
  $K/spinlock.o \
  $K/string.o \
  $K/main.o \
  $K/vm.o \
  $K/proc.o \
  $K/swtch.o \
  $K/trampoline.o \
  $K/trap.o \
  $K/syscall.o \
  $K/sysproc.o \
  $K/bio.o \
  $K/fs.o \
  $K/log.o \
  $K/sleeplock.o \
  $K/file.o \
  $K/pipe.o \
  $K/exec.o \
  $K/sysfile.o \
  $K/kernelvec.o \
  $K/plic.o \
  $K/virtio_disk.o

生成kernel的可执行文件，在makefile所属目录下的/kernel

ifndef TOOLPREFIX
TOOLPREFIX := $(shell if riscv64-unknown-elf-objdump -i 2>&1 | grep 'elf64-big' >/dev/null 2>&1; \
	then echo 'riscv64-unknown-elf-'; \
	elif riscv64-linux-gnu-objdump -i 2>&1 | grep 'elf64-big' >/dev/null 2>&1; \
	then echo 'riscv64-linux-gnu-'; \
	elif riscv64-unknown-linux-gnu-objdump -i 2>&1 | grep 'elf64-big' >/dev/null 2>&1; \
	then echo 'riscv64-unknown-linux-gnu-'; \
	else echo "***" 1>&2; \
	echo "*** Error: Couldn't find a riscv64 version of GCC/binutils." 1>&2; \
	echo "*** To turn off this error, run 'gmake TOOLPREFIX= ...'." 1>&2; \
	echo "***" 1>&2; exit 1; fi)
endif

这段代码片段是一个Makefile中的条件语句，用于设置和选择RISC-V工具链的前缀。

首先，在ifndef语句中检查变量TOOLPREFIX是否已定义。如果未定义，则在下面的代码块中进行条件判断并设置TOOLPREFIX变量。

该代码块中使用shell命令通过尝试检测不同的RISC-V工具链进行判断。检查的工具链分别是riscv64-unknown-elf、riscv64-linux-gnu和riscv64-unknown-linux-gnu。通过运行相应的objdump命令并查找特定输出，判断该工具链是否存在。

如果找到符合条件的工具链，则将其前缀赋值给TOOLPREFIX变量。

如果未找到任何符合条件的工具链，则输出错误信息并退出Makefile的执行。

最后，endif表示条件语句的结束。

总体来说，这段代码的目的是根据可用的RISC-V工具链设置TOOLPREFIX变量，以便在后续的编译和链接过程中使用正确的工具链。

QEMU = qemu-system-riscv64

CC = $(TOOLPREFIX)gcc
AS = $(TOOLPREFIX)gas
LD = $(TOOLPREFIX)ld
OBJCOPY = $(TOOLPREFIX)objcopy
OBJDUMP = $(TOOLPREFIX)objdump

CFLAGS = -Wall -Werror -O -fno-omit-frame-pointer -ggdb -gdwarf-2
CFLAGS += -MD
CFLAGS += -mcmodel=medany
CFLAGS += -ffreestanding -fno-common -nostdlib -mno-relax
CFLAGS += -I.
CFLAGS += $(shell $(CC) -fno-stack-protector -E -x c /dev/null >/dev/null 2>&1 && echo -fno-stack-protector)

# Disable PIE when possible (for Ubuntu 16.10 toolchain)
ifneq ($(shell $(CC) -dumpspecs 2>/dev/null | grep -e '[^f]no-pie'),)
CFLAGS += -fno-pie -no-pie
endif
ifneq ($(shell $(CC) -dumpspecs 2>/dev/null | grep -e '[^f]nopie'),)
CFLAGS += -fno-pie -nopie
endif

LDFLAGS = -z max-page-size=4096

设置QEMU硬件平台架构，将编译器设置为riscv64架构，定义了一系列变量，包括QEMU、CC、AS、LD、OBJCOPY和OBJDUMP。这些变量用于指定对应的命令和工具。接着，设置了CFLAGS和LDFLAGS变量，用于指定编译和链接过程中的选项。
在CFLAGS中，包含了一系列编译选项，如 -Wall（开启所有警告）、-Werror（将警告作为错误对待）、-O（优化级别）、-fno-omit-frame-pointer（不省略帧指针）、-ggdb（生成调试信息）等。其中还包括了为不同目标指定的选项，如
-mcmodel=medany（使用中等模型的内存访问模型、
-ffreestanding -fno-common -nostdlib -mno-relax（用于无标准库且不使用共享数据区的自由环境）等
-I.表示将当前目录添加到头文件搜索路径中。
-fno-stack-protector用于禁用栈保护机制（如果编译器支持）。

接下来的代码用于根据编译器的规格，禁用PIE（位置无关执行）选项。它首先检查编译器是否支持-fno-pie选项，如果支持则添加该选项，否则检查是否支持-nopie选项，如果支持则添加该选项。这样做是为了确保在编译和链接过程中禁用PIE，以便在特定环境中正确构建可执行文件。

最后，LDFLAGS用于指定链接器的选项，这里指定了-z max-page-size=4096选项，用于限制最大页大小为4096字节。

总体来说，这段代码是用于设置编译器和链接器的选项和参数，以便在编译和链接时正确地配置和构建软件项目。

$K/kernel: $(OBJS) $K/kernel.ld $U/initcode
	$(LD) $(LDFLAGS) -T $K/kernel.ld -o $K/kernel $(OBJS) 
	$(OBJDUMP) -S $K/kernel > $K/kernel.asm
	$(OBJDUMP) -t $K/kernel | sed '1,/SYMBOL TABLE/d; s/ .* / /; /^$$/d' > $K/kernel.sym

$U/initcode: $U/initcode.S
	$(CC) $(CFLAGS) -march=rv64g -nostdinc -I. -Ikernel -c $U/initcode.S -o $U/initcode.o
	$(LD) $(LDFLAGS) -N -e start -Ttext 0 -o $U/initcode.out $U/initcode.o
	$(OBJCOPY) -S -O binary $U/initcode.out $U/initcode
	$(OBJDUMP) -S $U/initcode.o > $U/initcode.asm

tags: $(OBJS) _init
	etags *.S *.c

ULIB = $U/ulib.o $U/usys.o $U/printf.o $U/umalloc.o

_%: %.o $(ULIB)
	$(LD) $(LDFLAGS) -T $U/user.ld -o $@ $^
	$(OBJDUMP) -S $@ > $*.asm
	$(OBJDUMP) -t $@ | sed '1,/SYMBOL TABLE/d; s/ .* / /; /^$$/d' > $*.sym

$U/usys.S : $U/usys.pl
	perl $U/usys.pl > $U/usys.S

$U/usys.o : $U/usys.S
	$(CC) $(CFLAGS) -c -o $U/usys.o $U/usys.S

$U/_forktest: $U/forktest.o $(ULIB)
	# forktest has less library code linked in - needs to be small
	# in order to be able to max out the proc table.
	$(LD) $(LDFLAGS) -N -e main -Ttext 0 -o $U/_forktest $U/forktest.o $U/ulib.o $U/usys.o
	$(OBJDUMP) -S $U/_forktest > $U/forktest.asm

mkfs/mkfs: mkfs/mkfs.c $K/fs.h $K/param.h
	gcc -Werror -Wall -I. -o mkfs/mkfs mkfs/mkfs.c

# Prevent deletion of intermediate files, e.g. cat.o, after first build, so
# that disk image changes after first build are persistent until clean.  More
# details:
# http://www.gnu.org/software/make/manual/html_node/Chained-Rules.html
.PRECIOUS: %.o

UPROGS=\
	$U/_cat\
	$U/_echo\
	$U/_forktest\
	$U/_grep\
	$U/_init\
	$U/_kill\
	$U/_ln\
	$U/_ls\
	$U/_mkdir\
	$U/_rm\
	$U/_sh\
	$U/_stressfs\`在这里插入代码片`
	$U/_usertests\
	$U/_grind\
	$U/_wc\
	$U/_zombie\

构造了用户程序的编译顺序，生成相应的可执行文件

fs.img: mkfs/mkfs README $(UPROGS)
	mkfs/mkfs fs.img README $(UPROGS)

-include kernel/*.d user/*.d

clean: 
	rm -f *.tex *.dvi *.idx *.aux *.log *.ind *.ilg \
	*/*.o */*.d */*.asm */*.sym \
	$U/initcode $U/initcode.out $K/kernel fs.img \
	mkfs/mkfs .gdbinit \
        $U/usys.S \
	$(UPROGS)

# try to generate a unique GDB port
GDBPORT = $(shell expr `id -u` % 5000 + 25000)
# QEMU's gdb stub command line changed in 0.11
QEMUGDB = $(shell if $(QEMU) -help | grep -q '^-gdb'; \
	then echo "-gdb tcp::$(GDBPORT)"; \
	else echo "-s -p $(GDBPORT)"; fi)
ifndef CPUS
CPUS := 3
endif

QEMUOPTS = -machine virt -bios none -kernel $K/kernel -m 128M -smp $(CPUS) -nographic
QEMUOPTS += -global virtio-mmio.force-legacy=false
QEMUOPTS += -drive file=fs.img,if=none,format=raw,id=x0
QEMUOPTS += -device virtio-blk-device,drive=x0,bus=virtio-mmio-bus.0

qemu: $K/kernel fs.img
	$(QEMU) $(QEMUOPTS)

.gdbinit: .gdbinit.tmpl-riscv
	sed "s/:1234/:$(GDBPORT)/" < $^ > $@

qemu-gdb: $K/kernel .gdbinit fs.img
	@echo "*** Now run 'gdb' in another window." 1>&2
	$(QEMU) $(QEMUOPTS) -S $(QEMUGDB)

这段代码是一个Makefile中描述了一些构建和运行项目的规则和命令。

首先定义了一个目标 fs.img，它依赖于 mkfs/mkfs、README 和 $(UPROGS) 文件。然后通过以下命令生成 fs.img 文件：

makefile
mkfs/mkfs fs.img README $(UPROGS)
接下来使用了 -include 指令，用于包含 kernel/.d 和 user/.d 文件。

然后定义了一个 clean 目标，用于清理编译生成的文件和目录。它使用 rm -f 命令删除了多个文件和目录，包括一些通配符表示的文件。

代码中使用了一个 GDBPORT 变量，它使用 expr 命令计算出一个唯一的 GDB 端口号。

然后使用了一个 QEMUGDB 变量，根据运行 $(QEMU) -help 命令的结果，判断是否支持 -gdb 选项，从而生成正确的 QEMU 的 GDB stub 命令行选项。

接下来使用了一个条件判断，如果未定义 CPUS 变量，则将其设置为 3。

定义了 QEMUOPTS 变量，用于指定运行 QEMU 的选项。其中包括了虚拟机的参数，内核文件的路径，内存大小，CPU 数量等。

继续往下，定义了一个 qemu 目标，它依赖于 $(K)/kernel 和 fs.img 文件，并使用 $(QEMU) 和 $(QEMUOPTS) 运行 QEMU。

接下来定义了一个 .gdbinit 目标，它是通过将 .gdbinit.tmpl-riscv 文件复制到 .gdbinit 文件并替换其中的端口号来生成的。

然后定义了一个 qemu-gdb 目标，它依赖于 $(K)/kernel、.gdbinit 和 fs.img 文件。它会在运行之前输出一条提示信息，并使用 $(QEMU)、$(QEMUOPTS) 和 -S 参数（暂停执行）来运行 QEMU。

总体来说，这个 Makefile 提供了构建文件系统镜像、清理项目文件、运行 QEMU 等功能的规则和命令，方便了项目的构建和调试。

总结

需要将makefile好好分析弄懂程序的编译逻辑才能更好的分析整个项目