20.打造专业的编译器环境(上)

目录

1.大型项目的目录结构(无第三方库)

2.项目架构设计分析

3.需要打造的编译环境

4.解决方案设计

5.第一阶段任务:

6.关键的实现要点

7.模块makefile中的构成

1.先编写common对应的makefile

注释


 

1.大型项目的目录结构(无第三方库)

2.项目架构设计分析

  • 项目被划分多个不同模块

               每个模块的代码用一个文件夹进行管理

                        文件夹由inc src makefile构成

                每个模块的对外函数声明统一放置于common/inc中

                        如:comm.h xxxfunc.h

3.需要打造的编译环境

  • 源码文件夹在编译时不能被改动(只读文件夹)
  • 在编译时自动创建文件夹(build)用于存放编译结果
  • 编译过程中能够自动生成依赖关系,自动搜索需要的文件
  • 每个模块可以拥有自己独立的编译方式
  • 支持调试版本的编译选项

4.解决方案设计

  • 第一阶段:将每个模块中的代码编译成静态库文件

  • 第二个阶段:将每个模块的静态文件链接成最终可执行程序

5.第一阶段任务:

  • 完成可用于各个模块编译的makefile文件
  • 每个模块的编译结果为静态库文件(.a文件)

6.关键的实现要点

  • 自动生成依赖关系(gcc -MM)
  • 自动搜索需要的文件(vpath)
  • 将目标文件打包为静态库文件(ar crs)

7.模块makefile中的构成

首先我们有以下common module main三个目录,以及目录下对应的src和inc文件夹

1.先编写common对应的makefile

.PHONY : all

DIR_COMMON_INC := /home/aston/disciple/common/inc

DIR_SRC := src
DIR_INC := inc

TYPE_INC := .h
TYPE_SRC := .c
TYPE_OBJ := .o
TYPE_DEP := .dep

AR := ar
ARFLAGS := crs

CC := gcc
CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC)

ifeq ($(DEBUG),ture)
CFLAGS += -g
endif

MODULE := $(realpath .)
MODULE := $(notdir $(MODULE))
all :
        @echo "$(MODULE)"
        @echo "$(CFLAGS)"

测试一下:是我们想要的值

make all

common

-Iinc -I/home/aston/disciple/common/inc

继续完善:我们要把编译出来的相关文件放置到build/common目录下

.PHONY : all

DIR_BUILD := /home/aston/disciple/build
DIR_COMMON_INC := /home/aston/disciple/common/inc

DIR_SRC := src
DIR_INC := inc

TYPE_INC := .h
TYPE_SRC := .c
TYPE_OBJ := .o
TYPE_DEP := .dep

AR := ar
ARFLAGS := crs

CC := gcc
CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC)

ifeq ($(DEBUG),ture)
CFLAGS += -g
endif

MODULE := $(realpath .)
MODULE := $(notdir $(MODULE))
DIR_OUTPUT := $(addprefix $(DIR_BUILD)/, $(MODULE))
all :
        @echo "$(DIR_OUTPUT)"

测试一下:

make all

/home/aston/disciple/build/common

继续完善,我们得到编译得到的静态库文件,放置到build/common目录

.PHONY : all

DIR_BUILD := /home/aston/disciple/build
DIR_COMMON_INC := /home/aston/disciple/common/inc

DIR_SRC := src
DIR_INC := inc

TYPE_INC := .h
TYPE_SRC := .c
TYPE_OBJ := .o
TYPE_DEP := .dep

AR := ar
ARFLAGS := crs

CC := gcc
CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC)

ifeq ($(DEBUG),ture)
CFLAGS += -g
endif

MODULE := $(realpath .)
MODULE := $(notdir $(MODULE))
DIR_OUTPUT := $(addprefix $(DIR_BUILD)/, $(MODULE))

OUTPUT := $(MODULE).a
OUTPUT := $(addprefix $(DIR_BUILD)/, $(OUTPUT))

all :
        @echo "$(OUTPUT)"

测试一下:

make all

/home/aston/disciple/build/common.a

继续完善得到所有源文件名和目标文件名以及定义dep依赖文件变量

SRCS := $(wildcard $(DIR_SRC)/*$(TYPE_SRC))
OBJS := $(SRCS:$(TYPE_SRC)=$(TYPE_OBJ))
OBJS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(OBJS))
DEPS := $(SRCS:$(TYPE_SRC)=$(TYPE_DEP))
DEPS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(DEPS))
all :
        @echo "$(SRCS)"
        @echo "$(OBJS)"
		@echo "$(DEPS)"

测试一下:

make all

src/common.c src/func.c

 /home/aston/disciple/build/common/common.o  /home/aston/disciple/build/common/func.o

 /home/aston/disciple/build/common/common.dep  /home/aston/disciple/build/common/func.dep

定义好这些变量,就开始编写规则

1.使用vpath告诉make去哪里找文件

vpath %$(TYPE_INC) $(DIR_INC)
vpath %$(TYPE_INC) $(DIR_COMMON_INC)
vpath %$(TYPE_SRC) $(DIR_SRC)

2.include部分自动生成依赖关系

include $(DEPS)


$(DIR_OUTPUT)/%$(TYPE_DEP) : %$(TYPE_SRC)
        @echo "Creating $@..."
        @set -e; \
        $(CC) $(CFLAGS) -MM -E $(filter %$(TYPE_SRC), $^) | sed 's,\(.*\)\.o[ :]*,$(DIR_OUTPUT)/\1$(TYPE_OBJ) $@ : ,g' > $@

综合:

vpath %$(TYPE_INC) $(DIR_INC)
vpath %$(TYPE_INC) $(DIR_COMMON_INC)
vpath %$(TYPE_SRC) $(DIR_SRC)

include $(DEPS)

all : 
        @echo "$(DEPS)"

$(DIR_OUTPUT)/%$(TYPE_DEP) : %$(TYPE_SRC)
        @echo "Creating $@..."
        @set -e; \
        $(CC) $(CFLAGS) -MM -E $(filter %$(TYPE_SRC), $^) | sed 's,\(.*\)\.o[ :]*,$(DIR_OUTPUT)/\1$(TYPE_OBJ) $@ : ,g' > $@

测试一下:测试之前先手动创建build/common目录。

make all

makefile:41: /home/aston/disciple/build/common/common.dep: No such file or directory
makefile:41: /home/aston/disciple/build/common/func.dep: No such file or directory
Creating /home/aston/disciple/build/common/func.dep...
Creating /home/aston/disciple/build/common/common.dep...
#@echo "Success! Target ==> /home/aston/disciple/build/common.a"
 /home/aston/disciple/build/common/common.dep  /home/aston/disciple/build/common/func.dep

查看下文件:

aston@ubuntu:~/disciple/common$ cat ../build/common/func.dep 
/home/aston/disciple/build/common/func.o /home/aston/disciple/build/common/func.dep : src/func.c inc/func.h
aston@ubuntu:~/disciple/common$ cat ../build/common/func.dep 
/home/aston/disciple/build/common/func.o /home/aston/disciple/build/common/func.dep : src/func.c inc/func.h

3.编写规则

all : $(OUTPUT)
        @echo "Success! Target ==> $(OUTPUT)"

$(OUTPUT) : $(OBJS)
        $(AR) $(ARFLAGS)  $@ $^

$(DIR_OUTPUT)/%$(TYPE_OBJ) : %$(TYPE_SRC)
        @$(CC) $(CFLAGS) -o $@ -c $(filter %$(TYPE_SRC), $^)

测试一下:

aston@ubuntu:~/disciple/common$ make all
ar crs  /home/aston/disciple/build/common.a /home/aston/disciple/build/common/common.o /home/aston/disciple/build/common/func.o
Success! Target ==> /home/aston/disciple/build/common.a
aston@ubuntu:~/disciple/common$ ls ../build/common
common.dep  common.o  func.dep  func.o

综上:common/makefile

.PHONY : all

DIR_BUILD := /home/aston/disciple/build
DIR_COMMON_INC := /home/aston/disciple/common/inc

DIR_SRC := src
DIR_INC := inc

TYPE_INC := .h
TYPE_SRC := .c
TYPE_OBJ := .o
TYPE_DEP := .dep

AR := ar
ARFLAGS := crs

CC := gcc
CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC)

ifeq ($(DEBUG),ture)
CFLAGS += -g
endif

MODULE := $(realpath .)
MODULE := $(notdir $(MODULE))
DIR_OUTPUT := $(addprefix $(DIR_BUILD)/, $(MODULE))

OUTPUT := $(MODULE).a
OUTPUT := $(addprefix $(DIR_BUILD)/, $(OUTPUT))

SRCS := $(wildcard $(DIR_SRC)/*$(TYPE_SRC))
OBJS := $(SRCS:$(TYPE_SRC)=$(TYPE_OBJ))
OBJS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(OBJS))
DEPS := $(SRCS:$(TYPE_SRC)=$(TYPE_DEP))
DEPS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(DEPS))

vpath %$(TYPE_INC) $(DIR_INC)
vpath %$(TYPE_INC) $(DIR_COMMON_INC)
vpath %$(TYPE_SRC) $(DIR_SRC)

include $(DEPS)

all : $(OUTPUT)
        @echo "Success! Target ==> $(OUTPUT)"

$(OUTPUT) : $(OBJS)
        $(AR) $(ARFLAGS)  $@ $^

$(DIR_OUTPUT)/%$(TYPE_OBJ) : %$(TYPE_SRC)
        @$(CC) $(CFLAGS) -o $@ -c $(filter %$(TYPE_SRC), $^)

$(DIR_OUTPUT)/%$(TYPE_DEP) : %$(TYPE_SRC)
        @echo "Creating $@..."
        @set -e; \
        $(CC) $(CFLAGS) -MM -E $(filter %$(TYPE_SRC), $^) | sed 's,\(.*\)\.o[ :]*,$(DIR_OUTPUT)/\1$(TYPE_OBJ) $@ : ,g' > $@

 现在拷贝common/makefile到module和main中

测试之前先手动创建build/module和build/main

aston@ubuntu:~/disciple/main$ make all
makefile:41: /home/aston/disciple/build/main/main.dep: No such file or directory
Creating /home/aston/disciple/build/main/main.dep...
ar crs  /home/aston/disciple/build/main.a /home/aston/disciple/build/main/main.o
Success! Target ==> /home/aston/disciple/build/main.a
aston@ubuntu:~/disciple/main$ ls ../build/
common  common.a  main  main.a  module
aston@ubuntu:~/disciple/main$ ls ../build/main
main.dep  main.o
aston@ubuntu:~/disciple/module$ make all
makefile:41: /home/aston/disciple/build/module/module.dep: No such file or directory
Creating /home/aston/disciple/build/module/module.dep...
ar crs  /home/aston/disciple/build/module.a /home/aston/disciple/build/module/module.o
Success! Target ==> /home/aston/disciple/build/module.a
aston@ubuntu:~/disciple/module$ ls ../build/
common  common.a  main  main.a  module  module.a
aston@ubuntu:~/disciple/module$ ls ../build/module
module.dep  module.o

有个疑问:虽然赋值过来可以编译通过,假设module要包含main目录下的函数或者代码,而makefile中只是指定在当前目录和common目录中查找。后面解决这个疑问

  • To be continued…

思考:

如何编写项目makefile使其能够触发模块makefile的调用,并最终生成可执行程序?

注释

 

 

 

 

 

 

 

 

 

 

 

 

 

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值