一些Makefile的基础知识

分手后的思念是犯贱 2022-12-31 15:23 224阅读 0赞

### 文章目录 ###

*  一、简介
 *  二、Makefile练习
 *   *  2.1基本规则
     *  2.2隐含规则和模式规则
     *  2.3变量
     *  2.4自动处理头文件的依赖关系
     *  2.5常用的make命令行选项
 *  三、小结

# 一、简介 #

> 除了一些极其简单程序之外，一般的程序都需要由多个文件链接而成，而Makefile就是一个很好的管理源文件编译的工具。这里只是简单的了解一些Makefile的一些基础用法，如果想要深入了解还是需要系统的读一些相关的书籍，如《mastering cmake》等等。

# 二、Makefile练习 #

## 2.1基本规则 ##

1、创建下面这些文件。

> main.c

#include<stdio.h>
    #include"stack.h"
    
    int a,b=1;
    
    int main(void)
    { 
    	push('a');
    	push('b');
    	push('c');
    
    	while(!is_empty())
    		putchar(pop());
    	putchar('\n');
    
    	return 0;
    }

> stack.c

char stack[512]; 	
    int top=1;

> push.c

extern char stack[512];		//声明变量
    extern int top;
    
    //栈的压入动作
    void push(char c)
    { 
    	stack[++top]=c;
    }

> pop.c

extern char stack[512];
    extern int top;
    
    //栈的弹出动作
    char pop(void)
    { 
    	return stack[top--];
    }

> is\_empty.c

extern char stack[512];
    extern int top;
    
    //判断是否为空
    int is_empty(void)
    { 
    	return top==-1;
    }

2、代码的确有些简单，但是可以说明问题就可以了*～*。执行下面的命令就可以生成可执行文件了。

> gcc main.c stack.c push.c pop.c is\_empty.c -o main

![在这里插入图片描述][20201230144153198.png]  
但是很现实的一个问题就会摆在我们面前，当其中有一个文件中的代码被修改了怎么办呢？好像只能重新执行上面的命令，但这样相当于之前编译的东西白折腾了。当然，我们也可以使用生成一些中间文件.o的方式来减少编译的工作，但是这样仍然容易出错。为了解决这个问题，所以就有了Makefile。  
3、编写下面的makefile文件，将它与源代码放置在同一个文件夹下。

main: main.o stack.o pop.o push.o is_empty.o
            gcc main.o stack.o pop.o push.o is_empty.o -o main1
    
    main.o: main.c stack.h
            gcc -c main.c
    
    stack.o:stack.c
            gcc -c stack.c
    
    pop.o:pop.c
            gcc -c pop.c
    
    push.o:push.c
            gcc -c push.c
    
    is_empty.o:is_empty.c
            gcc -c is_empty.c

> main是这条规则的目标（Target），main.o、stack.o、push.o、pop.o和is\_empty.o是这条规则的条件。目标和条之间的关系是：想要更新目标，就必须先更新它的所有条件，所有条件中只要有一个被更新，目标也会被更新。特别要注意的是，命令列表中的每一条命令必须以一个Tab开头，不能用空格代替他。此外如果某行命令以空格结尾也有可能会导致命令失败。

> 执行make命令

![在这里插入图片描述][20201230155506143.png]

那么这样做有什么好处呢？我们修改其中的一个文件试一下。

> pop.c

#include<stdio.h>
    
    extern char stack[512];
    extern int top;
    
    //栈的弹出动作
    char pop(void)
    { 
    	printf("\n");
    	return stack[top--];
    }

再次执行make命令。  
![在这里插入图片描述][20201230160408708.png]

可以看到make会自动选择那些受到影响的源文件进行编译，不受影响的源文件则不重新编译。但是有时候生成过多的.o文件也不太方便处理，所以我们可以在Makefile文件末尾加上下面的内容。

clean:
    	@echo "cleanning project"
    	-rm main1 *.o
    	@echo "clean completed"
    .PHONY:clean

> 执行make clean命令，文件家下的.o文件就会全部删除。

![在这里插入图片描述][2020123017083155.png]

> 其中的@符号是指只显示输出内容，不显示命令本身；“-”符号则是即使命令出错也会执行后面的内容。

## 2.2隐含规则和模式规则 ##

1、一个目标依赖的所有条件不一定非要写到一条规则中，也可以拆开写，如.c与.h文件拆开。

main: main.o stack.o pop.o push.o is_empty.o
            gcc main.o stack.o pop.o push.o is_empty.o -o main1
    
    main.o: main.c 
            gcc -c main.c
    
    main.o:stack.h
    
    stack.o:stack.c
            gcc -c stack.c
    
    pop.o:pop.c
            gcc -c pop.c
    
    push.o:push.c
            gcc -c push.c
    
    is_empty.o:is_empty.c
            gcc -c is_empty.c
    
    clean:
            @echo "cleanning project"
            -rm main1 *.o
            @echo "clean completed"
    
    .PHONY:clean

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70]

> 不过要注意的是，把目标拆开写成多条规则，只能允许其中的一条规则有命令列表，否则就会警告并采用最后一条规则的命令列表。

2、可以只保留头文件。

main: main.o stack.o pop.o push.o is_empty.o
    	gcc main.o stack.o pop.o push.o is_empty.o -o main1
    
    main.o:stack.h
    
    stack.o:stack.c
    	gcc -c stack.c
    
    pop.o:pop.c
    	gcc -c pop.c
    
    push.o:push.c
    	gcc -c push.c
    
    is_empty.o:is_empty.c
    	gcc -c is_empty.c
    
    clean:
    	@echo "cleanning project"
    	-rm main1 *.o
    	@echo "clean completed"
    
    .PHONY:clean

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 1]

> 这是由于make中所存在的隐含规则才导致了上面的效果，可以使用make -p命令打印出Makefile的格式、变量以及规则进行查看。而在隐含规则中的%.o和%.c是一种特殊的规则，称为模式规则。

## 2.3变量 ##

> make处理Makefile的过程主要可以分为两个阶段：  
> 第一个阶段：建立依赖关系图。  
> 第二个阶段：根据依赖关系选择合适的规则执行。

了解了这些才能理解Makefile下面的这种行为：

all:
            @echo $(foo)
    
    foo=$(bar)
    bar=First

![在这里插入图片描述][20201231083247674.png]

> 虽然后面的变量定义在all之后，但因为Makefile的执行分为两个阶段，很明显这里的变量是在第二个阶段被展开，故而并不会影响输出的结果。当然，我们也可以定义在第一个阶段处理时遇到变量就展开，如下

all:
            @echo $(foo)
    
    bar=First
    foo:=$(bar)		#此时的bar变量只能在foo变量之前被定义

> 除了这些我们自定义的变量，make中还存在着许多自动变量，如$<,$?,$^等的。  
> 其中，**$<表示当前所有的依赖文件名；$?表示规则中所有比目标新的条件，组成一个列表，以空格分隔；$^则表示规则中的所有条件，组成一个列表，以空格分隔，如果这个列表中有重复的项则将其消除；$@表示当前目标集；$\*表示不包括后缀名的当前依赖文件名字**。

如下面写的规则：

main: main.o stack.o pop.o push.o is_empty.o
            gcc main.o stack.o pop.o push.o is_empty.o -o main

可以写成这样：

main:main.o stack.o pop.o push.o is_empty.o
    		gcc $^ -o $@

> 这样即使以后又添加新的目标文件，$^也能自动包含新的目标文件名，编译的命令就不需要进行修改。

## 2.4自动处理头文件的依赖关系 ##

main: main.o stack.o pop.o push.o is_empty.o
            gcc $^ -o main1
    
    main.o:stack.h
    
    stack.o:stack.c
            gcc -c $^ 
    
    pop.o:pop.c
            gcc -c $^ 
    
    push.o:push.c
            gcc -c $^
    
    is_empty.o:is_empty.c
            gcc -c $^
    
    clean:
            @echo "cleanning project"
            -rm main1 *.o
            @echo "clean completed"
    
    .PHONY:clean

> 现在还有一点麻烦之处就是文件之间的依赖关系的处理，有时候我们可能会遇到一个头文件中还包含着另一个头文件或是修改了源代码之后忘记更新规则等等情况，所以为了更为方便和减少出错，我们需要一种自动维护的方法。

1、首先，使用-MM选项查看文件依赖关系，后续我们可以借助这个命令自动维护文件之间的依赖关系。  
![在这里插入图片描述][20201231102551471.png]

2、修改我们之前的Makefile文件。

all:main
    
    main: main.o stack.o pop.o push.o is_empty.o
            gcc $^ -o main1
    
    clean:
            @echo "cleanning project"
            -rm main1 *.o
            @echo "clean completed"
    
    .PHONY:clean
    
    sources=main.c stack.c pop.c push.c is_empty.c
    
    include $(sources:.c=.d)
    
    %.d:%.c
            set -e; rm -f $@;\
            $(CC) -MM $(CPPFLAGS) $< > $@.$$$$;\
            sed 's,$$*$\.o[ :]*,\l.o $@ : ,g' < $@.$$$$ > $@;\
            rm -f $@.$$$$

> 其中（1）set -e命令设置当前Shell进程为这样的状态：如果它执行的任何一条命令的退出状态非零，则终止后续操作。  
> （2）删除原来的\*\*.d文件。  
> （3）使用-MM重新构建依赖关系并把它保存到\*\*.d. $$文件中。里面的 $$$$其实表示 $$,这表示Shell当前的id号，主要就是用它作为一个临时文件名。(这里加了转义字符仍然出现问题)  
> （4）sed命令在这里主要就是起一个文件中查找替换的作用。比如将main.o:stack.h stack.c经过处理之后的结果保存为main.d，其中的内容是main.o main.d:stack.h stack.c。  
> （5）最后只需要把临时文件\*\*.d.$$删除即可。

3、执行结果如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 2]

## 2.5常用的make命令行选项 ##

> \-n:查看一下命令的执行顺序。

![在这里插入图片描述][20201231143705832.png]

> \-C：切换目录去执行Makefile文件。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 3]

> CFLAGS=-g：这次编译会加入调试信息。

![在这里插入图片描述][20201231144506929.png]

> 特别要注意的是，Shell进程中的环境变量会受到make进程中变量的影响，如下所示。

a=1
    all:
    		@echo $(a)

![在这里插入图片描述][20201231145126568.png]

> 其他常用选项还有：  
> \-k：让make命令在发现错误时仍继续执行。  
> \-f：告诉make命令将那个文件作为makefile文件。  
> …

# 三、小结 #

在使用的过程中Make给我这样一种感觉，它的语法有点类似于脚本语言，我们使用他来间接的调用Shell以完成程序的编译工作，当然其中可能要比我想象的复杂的多，Make的许多用法我还没有了解，这仍需要后续深入学习。

> 参考资料：《Linux C编程一站式学习》、《Linux程序设计》

[20201230144153198.png]: /images/20221120/ba6375e6f8434a75860015808f31fe2f.png
[20201230155506143.png]: /images/20221120/9e4be4905b9a49cfa8595070544b6649.png
[20201230160408708.png]: /images/20221120/3a85db11cade46bcb20ba7650cc00052.png
[2020123017083155.png]: /images/20221120/68666c509556443d871e498072585e0e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70]: /images/20221120/58d9ccdf3414448bb7cbff69c51776fd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 1]: /images/20221120/c7498432622f42878b12d0cd2483aed0.png
[20201231083247674.png]: /images/20221120/6919219bf18d45c599d14f61caa754d4.png
[20201231102551471.png]: /images/20221120/0446cc9ba0e24adc8c77c42c12d1727c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 2]: /images/20221120/14309d27c62d467d8464ae7d58b74144.png
[20201231143705832.png]: /images/20221120/2eefa411013c463b96c96f4f1dc6ec48.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 3]: /images/20221120/c16894096213479b8d1deca1fa2def1e.png
[20201231144506929.png]: /images/20221120/165c88f258f54227af14da1832714dcb.png
[20201231145126568.png]: /images/20221120/deb9c33d1154467bb8d90b7d7c992d6c.png