MIT6.828-Lab1-kern/Makefrag及注释

kern/Makefrag

#
# Makefile fragment for JOS kernel.
# This is NOT a complete makefile;
# you must run GNU make in the top-level directory
# where the GNUmakefile is located.
#

OBJDIRS += kern

KERN_LDFLAGS := $(LDFLAGS) -T kern/kernel.ld -nostdlib

# entry.S must be first, so that it's the first code in the text segment!!!
#
# We also snatch the use of a couple handy source files
# from the lib directory, to avoid gratuitous code duplication.
KERN_SRCFILES :=	kern/entry.S \
			kern/entrypgdir.c \
			kern/init.c \
			kern/console.c \
			kern/monitor.c \
			kern/pmap.c \
			kern/env.c \
			kern/kclock.c \
			kern/picirq.c \
			kern/printf.c \
			kern/trap.c \
			kern/trapentry.S \
			kern/sched.c \
			kern/syscall.c \
			kern/kdebug.c \
			lib/printfmt.c \
			lib/readline.c \
			lib/string.c

# Only build files if they exist.
#一般我们可以使用“$(wildcard *.c)”来获取工作目录下的所有的.c文件列表
#但是KERN_SRCFILES中列出了所有需要文件的具体名字，所以这里的wildcard只起到了剔除不存在文件的作用
KERN_SRCFILES := $(wildcard $(KERN_SRCFILES))

# Binary program images to embed within the kernel.
KERN_BINFILES := 

#OBJDIRS += kern
#$(patsubst a,b,c)是调用make的内置函数patsubst,功能是把文本c中的模式a替换为b
#第一条命令：将KERN_SRCFILES中的.c形式的字符串全部变成kern/%.o的字符串形式，例如lib/string.c =》obj/lib/string.o
#第二条命令：将KERN_OBJFILES（由KERN_SRCFILES转换而来)中的.S形式的字符串全部变成obj/%.o的字符串形式，例如obj/entry.S =》obj/kern/entry.o 
#第三条命令：将KERN_OBJFILES（由KERN_SRCFILES转换而来)中的obj/lib/%形式的字符串全部变成obj/kern/%的字符串形式,例如kern/kern/entry.o =》 kern/lib/entry.o
#总结：就是将KERN_SRCFILES中的“ %/%.c ” 或者 “ %/%.S ”全部变成 obj/kern/%.o （这里的改变都是指字符串的改变）
KERN_OBJFILES := $(patsubst %.c, $(OBJDIR)/%.o, $(KERN_SRCFILES))
KERN_OBJFILES := $(patsubst %.S, $(OBJDIR)/%.o, $(KERN_OBJFILES))
KERN_OBJFILES := $(patsubst $(OBJDIR)/lib/%, $(OBJDIR)/kern/%, $(KERN_OBJFILES))

KERN_BINFILES := $(patsubst %, $(OBJDIR)/%, $(KERN_BINFILES))

# How to build kernel object files
#$(@D)示"$@"的目录部分（不以斜杠作为结尾） ，如果"$@"值是"dir/foo.o"，那么"$(@D)"就是"dir"，而如果"$@"中没有包含斜杠的话，其值就是"."（当前目录） 。这里是$(OBJDIR)/kern
#CC	:= $(GCCPREFIX)gcc -pipe	#正常运行的话结果是i386-jos-elf-gcc -pipe
#makefile同名目标处理：合并依赖
#编译kern/,lib/下的.c，.S文件，生成的.o文件放在obj/kern下
#在调用$(KERN_OBJFILES)的时候将会调用到$(OBJDIR)/kern/%.o
$(OBJDIR)/kern/%.o: kern/%.c $(OBJDIR)/.vars.KERN_CFLAGS
	@echo + cc $<
	@mkdir -p $(@D)
	$(V)$(CC) -nostdinc $(KERN_CFLAGS) -c -o $@ $<

$(OBJDIR)/kern/%.o: kern/%.S $(OBJDIR)/.vars.KERN_CFLAGS
	@echo + as $<
	@mkdir -p $(@D)
	$(V)$(CC) -nostdinc $(KERN_CFLAGS) -c -o $@ $<

$(OBJDIR)/kern/%.o: lib/%.c $(OBJDIR)/.vars.KERN_CFLAGS
	@echo + cc $<
	@mkdir -p $(@D)
	$(V)$(CC) -nostdinc $(KERN_CFLAGS) -c -o $@ $<

# Special flags for kern/init
$(OBJDIR)/kern/init.o: override KERN_CFLAGS+=$(INIT_CFLAGS)
$(OBJDIR)/kern/init.o: $(OBJDIR)/.vars.INIT_CFLAGS

# How to build the kernel itself
#第一条命令：使用加号修饰符让命令始终执行。命令行执行时不受到 make 的 -n -t -q 三个参数的影响，忽略这三个参数。
#ld命令是二进制工具集GNU Binutils的一员，是GNU链接器，用于将目标文件与库链接为可执行程序或库文件。ld [options] <objfile...>
#第二条命令：
    #$(LD) -o $(KERN_LDFLAGS)：生成一个名为$@（obj/kern/kernel）的文件的文件，如何生成：通过链接$(KERN_OBJFILES)，$(GCC_LIB)和二进制文件-b binary $(KERN_BINFILES)
	    # $(KERN_BINFILES)在lab1定义为空，但是在lab3不是
	#$(KERN_LDFLAGS)：-m elf_i386 -T kern/kernel.ld -nostdlib
	    #ld -m elf_i386：输出为 elf 的目标格式，386是目标平台
		#ld -T kern/kernel.ld：使用kernel.ld作为链接器脚本。这个脚本替换了ld的默认链接器脚本
		#ld -nostdlib：不连接系统标准启动文件和标准库文件，只把指定的文件传递给连接器。这个选项常用于编译内核、bootloader等程序，它们不需要启动文件、标准库文件。
#第三条命令：
    #OBJDUMP -S 显示混合了反汇编的源代码
	#这条主要作用是反汇编obj/kern/kernel，生成kernel.asm文件
#第四条命令：
	#nm命令是linux下针对某些特定文件的分析工具，能够列出库文件（.a、.lib）、目标文件（*.o）、可执行文件的符号表
	#-n 、-v 或 --numeric-sort：按符号对应地址的顺序排序，而非按符号名的字符顺序。
	#分析obj/kern/kernel，生成obj/kern/kernel.sym文件
$(OBJDIR)/kern/kernel: $(KERN_OBJFILES) $(KERN_BINFILES) kern/kernel.ld \
	  $(OBJDIR)/.vars.KERN_LDFLAGS
	@echo + ld $@
	$(V)$(LD) -o $@ $(KERN_LDFLAGS) $(KERN_OBJFILES) $(GCC_LIB) -b binary $(KERN_BINFILES)
	$(V)$(OBJDUMP) -S $@ > $@.asm
	$(V)$(NM) -n $@ > $@.sym

# How to build the kernel disk image
#构建kernel.img需要首先准备好$(OBJDIR)/kern/kernel和$(OBJDIR)/boot/boot
#dd命令可参考《Linux in Action》4.5节
#第一条dd命令：向$(OBJDIR)/kern/kernel.img中写入10000block个0x0字节(也可以理解为创建一个10000个block的镜像文件kernel.img~，每个block的大小可以有ibs选项设置，默认是512bytes)
#第二条dd命令：将编译出来的boot 二进制文件加载到kernel.img~的第一个block中
#第三条dd命令：第三步是将上面编译出来的kernel elf文件从第二个block开始加载到kernel.img中（seek=blocks：从输出文件开头跳过blocks个块后再开始复制。）
#第四条mv命令：将$(OBJDIR)/kern/kernel.img~改名为$(OBJDIR)/kern/kernel.img
$(OBJDIR)/kern/kernel.img: $(OBJDIR)/kern/kernel $(OBJDIR)/boot/boot
	@echo + mk $@
	$(V)dd if=/dev/zero of=$(OBJDIR)/kern/kernel.img~ count=10000 2>/dev/null
	$(V)dd if=$(OBJDIR)/boot/boot of=$(OBJDIR)/kern/kernel.img~ conv=notrunc 2>/dev/null
	$(V)dd if=$(OBJDIR)/kern/kernel of=$(OBJDIR)/kern/kernel.img~ seek=1 conv=notrunc 2>/dev/null
	$(V)mv $(OBJDIR)/kern/kernel.img~ $(OBJDIR)/kern/kernel.img

all: $(OBJDIR)/kern/kernel.img

grub: $(OBJDIR)/jos-grub

$(OBJDIR)/jos-grub: $(OBJDIR)/kern/kernel
	@echo + oc $@
	$(V)$(OBJCOPY) --adjust-vma=0x10000000 $^ $@