0%

xv6 makefile 解析

Posted on In Valine:

xv6操作系统安装的makefile文件逐行分析

目标描述：xv6 Makefile分析
Xv6 的Makefile是用于组织源代码的编译流程的文件，Makefile文件描述了各个源文件之间的相互依赖关系，把原本繁琐的编译过程简化为makefile文件与make指令的配合使用。
Makefile大体结构是树形结构，即把一个目标分为多个子目标。make将makefile的第一个target作为作为最终的target，凡是这个规则依赖的规则都将被执行。
编译流程：
（一）首先OBJS指定需要编译的.c文件
（二）然后配置一些环境和工具信息
（三）xv6.img、bootblock、kernel相互依赖，生成系统内核与镜像
（四）生成文件系统以及系统内部可执行文件
（五）配置启动信息

源代码注释及分析：
（1）编译目标定义

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
OBJS = \
	bio.o\
	console.o\
	exec.o\
	file.o\
	fs.o\
	ide.o\
	ioapic.o\
	kalloc.o\
	kbd.o\
	lapic.o\
	log.o\
	main.o\
	mp.o\
	picirq.o\
	pipe.o\
	proc.o\
	sleeplock.o\
	spinlock.o\
	string.o\
	swtch.o\
	syscall.o\
	sysfile.o\
	sysproc.o\
	trapasm.o\
	trap.o\
	uart.o\
	vectors.o\
	vm.o\

只要make查到某个 .o 文件，它就自动把相关的 .c 加到依赖关系中

（2）配置编译工具gcc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
ifndef TOOLPREFIX
TOOLPREFIX := $(shell if i386-jos-elf-objdump -i 2>&1 | grep '^elf32-i386$$' >/dev/null 2>&1; \
	then echo 'i386-jos-elf-'; \
	elif objdump -i 2>&1 | grep 'elf32-i386' >/dev/null 2>&1; \
	then echo ''; \
	else echo "***" 1>&2; \
	echo "*** Error: Couldn't find an i386-*-elf version of GCC/binutils." 1>&2; \
	echo "*** Is the directory with i386-jos-elf-gcc in your PATH?" 1>&2; \
	echo "*** If your i386-*-elf toolchain is installed with a command" 1>&2; \
	echo "*** prefix other than 'i386-jos-elf-', set your TOOLPREFIX" 1>&2; \
	echo "*** environment variable to that prefix and run 'make' again." 1>&2; \
	echo "*** To turn off this error, run 'gmake TOOLPREFIX= ...'." 1>&2; \
	echo "***" 1>&2; exit 1; fi)
endif

若找不到合适的版本，输出错误信息

（3）配置模拟器qemu

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
ifndef QEMU
QEMU = $(shell if which qemu > /dev/null; \
	then echo qemu; exit; \
	elif which qemu-system-i386 > /dev/null; \
	then echo qemu-system-i386; exit; \
	elif which qemu-system-x86_64 > /dev/null; \
	then echo qemu-system-x86_64; exit; \
	else \
	qemu=/Applications/Q.app/Contents/MacOS/i386-softmmu.app/Contents/MacOS/i386-softmmu; \
	if test -x $$qemu; then echo $$qemu; exit; fi; fi; \
	echo "***" 1>&2; \
	echo "*** Error: Couldn't find a working QEMU executable." 1>&2; \
	echo "*** Is the directory containing the qemu binary in your PATH" 1>&2; \
	echo "*** or have you tried setting the QEMU variable in Makefile?" 1>&2; \
	echo "***" 1>&2; exit 1)
endif

检索QEMU路径为变量QEMU赋值，若前面已定义则跳过这一步，若没有可用的QEMU，尝试使用i386-softmmu（针对MacOS），否则输出错误信息

（3）配置编译器、汇编器、链接器、copy工具和dump工具（反编译）

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
CC = $(TOOLPREFIX)gcc
# i386-jos-elf-gcc编译器
AS = $(TOOLPREFIX)gas
# i386-jos-elf-gas汇编器
LD = $(TOOLPREFIX)ld
# i386-jos-elf-ld链接器
# 通过shell指令为CC、AS和LD添加附加参数，指定copy工具和dump工具
OBJCOPY = $(TOOLPREFIX)objcopy
OBJDUMP = $(TOOLPREFIX)objdump
CFLAGS = -fno-pic -static -fno-builtin -fno-strict-aliasing -O2 -Wall -MD -ggdb -m32 -Werror -fno-omit-frame-pointer
# -fno-pic不使用PIC（位置无关代码），-static将依赖的动态库编译为静态，
# -fno-builtin不使用C语言自身的内建函数，因为是要写一个完整的操作系统，防止重名，
# -fno-strict-aliasing编译器规则优化，使一些规则（-O1，-O2，-O3）可以混淆使用。
# -Wall显示警告 -MD编译并保存代码依赖性 -ggdb产生GDB所需的调试信息 -m32生成32位汇编代码（默认64）-Werror遇到警告也停止编译
# -fno-omit-frame-pointer保留函数调用产生的frame pointer，方便调试时的回溯
CFLAGS += $(shell $(CC) -fno-stack-protector -E -x c /dev/null >/dev/null 2>&1 && echo -fno-stack-protector)
# -fno-stack-protector 禁用栈保护，使编译器不会对局部变量的组织方式进行重新布局
# -E -x c对后缀c的文件进行预处理而不编译
ASFLAGS = -m32 -gdwarf-2 -Wa,-divide
# FreeBSD ld wants ``elf_i386_fbsd''指定ELF文件系统格式和x86架构
LDFLAGS += -m $(shell $(LD) -V | grep elf_i386 2>/dev/null | head -n 1)
# LDFLAGS即链接到相应版本的模拟器，grep管道查看匹配elf_i386架构的模拟器

# Disable PIE when possible (for Ubuntu 16.10 toolchain) PIE用于将程序装载到随机的地址，这里选择禁用PIE机制
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

（3）生成xv6镜像（即最终装载到模拟器的）

1
2
3
4
5
6
7
xv6.img: bootblock kernel
	dd if=/dev/zero of=xv6.img count=10000
	dd if=bootblock of=xv6.img conv=notrunc
	dd if=kernel of=xv6.img seek=1 conv=notrunc
需要启动块引导程序bootblock和系统内核kernel
# dd指令：把指定的输入文件拷贝到指定的输出文件中，并且在拷贝的过程中可以进行格式转换。
# conv=notrunc防止文件被截断（用于虚拟软盘）

（4）生成xv6memfs镜像

1
2
3
4
xv6memfs.img: bootblock kernelmemfs
	dd if=/dev/zero of=xv6memfs.img count=10000
	dd if=bootblock of=xv6memfs.img conv=notrunc
dd if=kernelmemfs of=xv6memfs.img seek=1 conv=notrunc

（5）生成启动引导块bootblock

1
2
3
4
5
6
7
8
9
10
bootblock: bootasm.S bootmain.c
	$(CC) $(CFLAGS) -fno-pic -O -nostdinc -I. -c bootmain.c
	$(CC) $(CFLAGS) -fno-pic -nostdinc -I. -c bootasm.S
	$(LD) $(LDFLAGS) -N -e start -Ttext 0x7C00 -o bootblock.o bootasm.o bootmain.o
	$(OBJDUMP) -S bootblock.o > bootblock.asm
	$(OBJCOPY) -S -O binary -j .text bootblock.o bootblock
	./sign.pl bootblock
# 主引导记录存入0x7C00地址
# 链接bootasm.o bootmain.o生成bootblock.o文件，objdump反编译输出到bootblock.asm，使用工具objcopy把bootblock.o的.text段(该段包含程序的可执行指令)拷贝出来生成bootblock
# 执行sign.pl，为bootblock设置大小512，得到BIOS之后执行的BootLoader

（6）生成entryother

1
2
3
4
5
entryother: entryother.S
	$(CC) $(CFLAGS) -fno-pic -nostdinc -I. -c entryother.S
	$(LD) $(LDFLAGS) -N -e start -Ttext 0x7000 -o bootblockother.o entryother.o
	$(OBJCOPY) -S -O binary -j .text bootblockother.o entryother
	$(OBJDUMP) -S bootblockother.o > entryother.asm

用于多核启动

（7）生成initcode

1
2
3
4
5
initcode: initcode.S
	$(CC) $(CFLAGS) -nostdinc -I. -c initcode.S
	$(LD) $(LDFLAGS) -N -e start -Ttext 0 -o initcode.out initcode.o
	$(OBJCOPY) -S -O binary initcode.out initcode
	$(OBJDUMP) -S initcode.o > initcode.asm

用于启动系统第一个进程

（8）生成内核

1
2
3
4
kernel: $(OBJS) entry.o entryother initcode kernel.ld
	$(LD) $(LDFLAGS) -T kernel.ld -o kernel entry.o $(OBJS) -b binary initcode entryother
	$(OBJDUMP) -S kernel > kernel.asm
	$(OBJDUMP) -t kernel | sed '1,/SYMBOL TABLE/d; s/ .* / /; /^$$/d' > kernel.sym

输出到二进制文件initcode entryother，用于指定系统启动的第一个进程

（9）tags工具，用于emac阅读代码

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

（10）生成可供系统调用的可执行文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
UPROGS=\
	_cat\
	_echo\
	_forktest\
	_grep\
	_init\
	_kill\
	_ln\
	_ls\
	_mkdir\
	_rm\
	_sh\
	_stressfs\
	_usertests\
	_wc\
	_zombie\

（11）生成文件系统镜像

1
2
3
4
fs.img: mkfs README $(UPROGS)
	./mkfs fs.img README $(UPROGS)

-include *.d

（12）若运行make clean指令则删除原始文件以外的生成文件

1
2
3
4
5
6
clean: 
	rm -f *.tex *.dvi *.idx *.aux *.log *.ind *.ilg \
	*.o *.d *.asm *.sym vectors.S bootblock entryother \
	initcode initcode.out kernel xv6.img fs.img kernelmemfs \
	xv6memfs.img mkfs .gdbinit \
	$(UPROGS)

（13）生成pdf

1
2
3
4
5
xv6.pdf: $(PRINT)
	./runoff
	ls -l xv6.pdf

print: xv6.pdf

（14）一个虚拟机broch的配置

1
2
3
bochs : fs.img xv6.img
	if [ ! -e .bochsrc ]; then ln -s dot-bochsrc .bochsrc; fi
	bochs -q

（15）配置GDB调试器

1
2
3
4
5
6
7
8
# 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为qemu模拟器中关于GDB的帮助信息
QEMUGDB = $(shell if $(QEMU) -help | grep -q '^-gdb'; \
	then echo "-gdb tcp::$(GDBPORT)"; \
	else echo "-s -p $(GDBPORT)"; fi)

（16）qemu的一些设置

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
ifndef CPUS
CPUS := 2
endif
# 配置硬件信息
# -drive定义驱动器 file=指定镜像文件，磁盘类型raw -smp指定cpu -m指定内存
QEMUOPTS = -drive file=fs.img,index=1,media=disk,format=raw -drive file=xv6.img,index=0,media=disk,format=raw -smp $(CPUS) -m 512 $(QEMUEXTRA)


# qemu加载fs xv6镜像，-serial指定串口号mon:stdio，以及配置驱动器
qemu: fs.img xv6.img
	$(QEMU) -serial mon:stdio $(QEMUOPTS)

# qemu-memfs加载xv6memfs镜像，配置驱动器
qemu-memfs: xv6memfs.img
	$(QEMU) -drive file=xv6memfs.img,index=0,media=disk,format=raw -smp $(CPUS) -m 256

# -nographic非图形界面
qemu-nox: fs.img xv6.img
	$(QEMU) -nographic $(QEMUOPTS)

# 初始化调试器
.gdbinit: .gdbinit.tmpl
	sed "s/localhost:1234/localhost:$(GDBPORT)/" < $^ > $@

qemu-gdb: fs.img xv6.img .gdbinit
	@echo "*** Now run 'gdb'." 1>&2
	$(QEMU) -serial mon:stdio $(QEMUOPTS) -S $(QEMUGDB)

qemu-nox-gdb: fs.img xv6.img .gdbinit
	@echo "*** Now run 'gdb'." 1>&2
	$(QEMU) -nographic $(QEMUOPTS) -S $(QEMUGDB)

（17）文件整理打包为tar

1
2
3
4
5
tar:
	rm -rf /tmp/xv6
	mkdir -p /tmp/xv6
	cp dist/* dist/.gdbinit.tmpl /tmp/xv6
	(cd /tmp; tar cf - xv6) | gzip >xv6-rev10.tar.gz  # the next one will be 10 (9/17)