Linux开发基础知识Makefile语法

Posted 2022-11-28 与光同程

文章目录

• Makefile 学习笔记
• • gcc
  • make 的使用
  • Makefile的底层规则
  • Makefile 变量的引入以及使用
  • 信息显示
  • 函数的使用
  • 预定义变量
  • 定义命令包
  • 语法规则
  • Makefile常用函数
  • • 字符处理
    • 文件名操作
    • 其他函数
    • • foreach 函数
      • if 函数
      • call函数
      • origin函数
      • shell函数
      • wildcard 函数

Makefile 学习笔记

gcc

1. -o 指定目标文件

gcc sources/main.c -o bin/main

2. -c 编译的时候只生产目标文件不链接

gcc -c sources/main.c -o obj/main.o

3. -I 主要指定头文件的搜索路径

gcc -I headers -c main.c -o main.o

4. -l 指定静态库

gcc -lpthread ...

make 的使用

make 是一个解释 makefile 中指令的命令工具。make 工具最主要也是最基本的功能：就是通过 makefile文件 来描述源程序之间的相互关系并自动维护编译工作。而 makefile文件 需要按照某种语法进行编写，文件中需要说明如何编译各个源文件，并连接生成可执行文件，并要求定义源文件之间的依赖关系。

常用

-f 指定使用的Makefile 文件

-j 指定几个线程编译

Makefile的底层规则

targets：prerequisites
    command
    command
    ......

目标：依赖
    命令
    命令
    ......

由此可见Makefile 的三要素就是 目标 依赖 以及 命令

1. target 也就是一个目标文件，需要由make工具创建的目标体（target）。可以是Object File，也可以是执行文件。还可以是一个标签（Label），对于标签这种特性，在后续的“伪目标”章节中会有叙述。
2. prerequisites 就是要生成那个target所需要的文件或是目标。即要创建的目标体所依赖的文件（dependency_file）。
3. command 也就是make需要执行的命令（任意的Shell命令）。即创建每个目标体时需要运行的命令（command）。

注意：Makefile中的命令 写在一行和写在两行是有区别的，可以理解为 每一行都是用一个sh环境执行的，执行完成后该shell环境立即关闭

main: main.o 
    g++ -o main main.o
main.o: main.cpp
    g++ -o main.o -c main.cpp

clean:
    cd test ; pwd
    cd .
pwd

看看结果：

taoge@localhost Desktop> make clean
cd test ; pwd
/home/taoge/Desktop/test
cd test
pwd
/home/taoge/Desktop
taoge@localhost Desktop> 

我们看到：

cd test和pwd在同一行， pwd针对的是cd test的结果。
cd test 针对的不是上述命令的结果， 所以其实当前目录仍然是/home/taoge/Desktop
pwd的当前结果也是/home/taoge/Desktop

Makefile 变量的引入以及使用

CC=gcc -Wall
obj/st_work.o : sources/st_work.c
    \\$(CC) \\$(HEAD) \\$(SRC) \\$(OBJ)

1. 变量替换
   其格式是“$(var:a=b)”或是“$var:a=b”，
   其意思是，把变量“var”中所有以“a”字串“结尾”的“a”替换成“b”字串。
   这里的“结尾”意思是“空格”或是“结束符”。
   foo := a.o b.o c.o
   bar := $(foo:.o=.c)
2. 变量可以嵌套
   $($(x))
3. 可以使用“+=”操作符给变量追加值。

信息显示

在执行make时，会把所有这些信息都输出来。在命令前面加个@，就不会把相关信息输出屏幕了。

函数的使用

函数调用后，函数的返回值可以当做变量来使用。
调用格式如下所示：  \\$((function) (arguments);)

预定义变量

预定义变量	作用
$*	不包含扩展名的目标文件名称
$+	所有的依赖文件，以空格分开，并以出现的先后为序，可能包含重复的依赖文件。
$(	第一个依赖文件的名称。
$?	所有的依赖文件，以空格分开，这些依赖文件的修改日期比目标的创建日期晚。
$@	目标的完整名称。
$^	所有的依赖文件，以空格分开，不包含重复的依赖文件。

定义命令包

如果Makefile中出现一些相同命令序列，那么我们可以为这些相同的命令序列定义一个变量。定义这种命令序列的语法以“define”开始，以“endef”结束，如：

define run-yacc 
yacc \\$(firstword \\$^) 
mv y.tab.c \\$@ 
endef 

这里，“run-yacc”是这个命令包的名字，其不要和Makefile中的变量重名。在“define”和“endef”中的两行就是命令序列。这个命令包中的第一个命令是运行Yacc程序，因为Yacc程序总是生成“y.tab.c”的文件，所以第二行的命令就是把这个文件改改名字。还是把这个命令包放到一个示例中来看看吧。

语法规则

条件表达式的语法为：

(conditional-directive);
(text-if-true);
endif

以及：

(conditional-directive);
(text-if-true);
else
(text-if-false);
endif

其中(conditional-directive);表示条件关键字 ifeq ifneq ifdef ifndef
ifeq ((arg1),(arg2))

Makefile常用函数

字符处理

$(subst (from);,(to);,(text)

  名称：字符串替换函数——subst。 

    功能：把字串(text);中的(from);字符串替换成(to);。 
    返回：函数返回被替换过后的字符串。 

    示例：
    $(subst ee,EE,feet on the street)，      
    把“feet on the street”中的“ee”替换成“EE”，返回结果是“fEEt on the strEEt”。 

$(patsubst (pattern);,(replacement);,(text)

   名称：模式字符串替换函数——patsubst。 

    功能：查找(text);中的单词（单词以“空格”、“Tab”或“回车”“换行”分隔）是否符合模式(pattern);，如果匹配的话，则以(replacement);替换。这里，(pattern);可以包括通配符\\%，表示任意长度的字串。如果(replacement);中也包含“\\%”，那么，(replacement);中的这个“\\%”将是(pattern);中的那个“\\%”所代表的字串。（可以用“\\”来转义，以“\\%”来表示真实含义的“\\%”字符） 
    返回：函数返回被替换过后的字符串。 

    示例： 
        \\$(patsubst %.c,%.o,x.c.c bar.c) 
        把字串“x.c.c bar.c”符合模式[%.c]的单词替换成[%.o]，返回结果是“x.c.o bar.o” 

$(findstring (find);,(in)😉

  名称：查找字符串函数——findstring。 

功能：在字串(in);中查找(find);字串。 
返回：如果找到，那么返回(find);，否则返回空字符串。 
示例： 
    \\$(findstring a,a b c) 
    \\$(findstring a,b c) 
    第一个函数返回“a”字符串，第二个返回“”字符串（空字符串） 

$(filter (pattern…);,(text)😉

  名称：过滤函数——filter。 

功能：以(pattern);模式过滤(text);字符串中的单词，保留符合模式(pattern);的单词。可以有多个模式。 
返回：返回符合模式(pattern);的字串。 
示例： 
    sources := foo.c bar.c baz.s ugh.h 
    foo: \\$(sources) 
            cc \\$(filter %.c %.s,\\$(sources)) -o foo 
    \\$(filter %.c %.s,\\$(sources))返回的值是“foo.c bar.c baz.s”。 

$(filter-out (pattern…);,(text)😉

  名称：反过滤函数——filter-out。 

功能：以(pattern);模式过滤(text);字符串中的单词，去除符合模式(pattern);的单词。可以有多个模式。 
返回：返回不符合模式(pattern);的字串。 
示例： 
    objects=main1.o foo.o main2.o bar.o 
    mains=main1.o main2.o 
    \\$(filter-out \\$(mains),\\$(objects)) 返回值是“foo.o bar.o”。 

$(sort (list)😉

  名称：排序函数——sort。 

功能：给字符串(list);中的单词排序（升序）。 
返回：返回排序后的字符串。 
示例：\\$(sort foo bar lose)返回“bar foo lose” 。 
备注：sort函数会去掉(list);中相同的单词。 

$(word (n);,(text)😉

  名称：取单词函数——word。 

功能：取字符串(text);中第(n);个单词。（从一开始） 
返回：返回字符串(text);中第(n);个单词。如果(n);比(text);中的单词数要大，那么返回空字符串。 
示例：\\$(word 2, foo bar baz)返回值是“bar”。 

$(wordlist (s);,(e);,(text)😉

  名称：取单词串函数——wordlist。 

功能：从字符串(text);中取从(s);开始到(e);的单词串。(s);和(e);是一个数字。 
返回：返回字符串(text);中从(s);到(e);的单词字串。如果(s);比(text);中的单词数要大，那么返回空字符串。如果(e);大于(text);的单词数，那么返回从(s);开始，到(text);结束的单词串。 
示例： \\$(wordlist 2, 3, foo bar baz)返回值是“bar baz”。 

$(words (text)😉

 名称：单词个数统计函数——words。 

功能：统计(text);中字符串中的单词个数。 
返回：返回(text);中的单词数。 
示例：\\$(words, foo bar baz)返回值是“3”。 
备注：如果我们要取(text);中最后的一个单词，我们可以这样：\\$(word \\$(words (text);),(text);)。 

$(firstword (text)😉

名称：首单词函数——firstword 

功能：取字符串(text);中的第一个单词。 
返回：返回字符串(text);的第一个单词。 
示例：\\$(firstword foo bar)返回值是“foo”。 
备注：这个函数可以用word函数来实现：\\$(word 1,(text);)。

文件名操作

$(dir (names…)😉

 名称：取目录函数——dir。 

功能：从文件名序列(names);中取出目录部分。目录部分是指最后一个反斜杠（“/”）之前的部分。如果没有反斜杠，那么返回“./”。 
返回：返回文件名序列(names);的目录部分。 
示例： \\$(dir src/foo.c hacks)返回值是“src/ ./”。 

$(notdir (names…)😉

 名称：取文件函数——notdir。 

功能：从文件名序列(names);中取出非目录部分。非目录部分是指最后一个反斜杠（“/”）之后的部分。
返回：返回文件名序列(names);的非目录部分。 
示例： \\$(notdir src/foo.c hacks)返回值是“foo.c hacks”。 

$(suffix (names…)😉

 名称：取后缀函数——suffix。 

功能：从文件名序列(names);中取出各个文件名的后缀。 
返回：返回文件名序列(names);的后缀序列，如果文件没有后缀，则返回空字串。 
示例：\\$(suffix src/foo.c src-1.0/bar.c hacks)返回值是“.c .c”。 

$(basename (names…)😉

 名称：取前缀函数——basename。 

功能：从文件名序列(names);中取出各个文件名的前缀部分。 
返回：返回文件名序列(names);的前缀序列，如果文件没有前缀，则返回空字串。 
示例：\\$(basename src/foo.c src-1.0/bar.c hacks)返回值是“src/foo src-1.0/bar hacks”。 

$(addsuffix (suffix);,(names…)😉

名称：加后缀函数——addsuffix。 

 功能：把后缀(suffix);加到(names);中的每个单词后面。 
 返回：返回加过后缀的文件名序列。 
 示例：\\$(addsuffix .c,foo bar)返回值是“foo.c bar.c”。 

$(addprefix (prefix);,(names…)😉

名称：加前缀函数——addprefix。 

 功能：把前缀(prefix);加到(names);中的每个单词后面。 
 返回：返回加过前缀的文件名序列。 
 示例：\\$(addprefix src/,foo bar)返回值是“src/foo src/bar”。 

$(join (list1);,(list2)😉

名称：连接函数——join。 

 功能：把(list2);中的单词对应地加到(list1);的单词后面。如果(list1);的单词个数要比(list2);的多，那么，(list1);中的多出来的单词将保持原样。如果(list2);的单词个数要比(list1);多，那么，(list2);多出来的单词将被复制到(list2);中。 
 返回：返回连接过后的字符串。 
 示例：\\$(join aaa bbb , 111 222 333)返回值是“aaa111 bbb222 333”。

其他函数

foreach 函数

foreach函数和别的函数非常的不一样。因为这个函数是用来做循环用的，Makefile中的foreach函数几乎是仿照于Unix标准Shell（/bin/sh）中的for语句，或是C-Shell（/bin/csh）中的foreach语句而构建的。它的语法是：
$(foreach (var);,(list);,(text)😉

这个函数的意思是，把参数(list);中的单词逐一取出放到参数(var);所指定的变量中，然后再执行(text);所包含的表达式。每一次(text);会返回一个字符串，循环过程中，(text);的所返回的每个字符串会以空格分隔，最后当整个循环结束时，(text);所返回的每个字符串所组成的整个字符串（以空格分隔）将会是foreach函数的返回值。

if 函数

if函数很像GNU的make所支持的条件语句——ifeq，if函数的语法是：
$(if (condition);,(then-part)😉
或是
$(if (condition);,(then-part);,(else-part)😉

可见，if函数可以包含“else”部分，或是不含。即if函数的参数可以是两个，也可以是三个。(condition);参数是if的表达式，如果其返回的为非空字符串，那么这个表达式就相当于返回真，于是，(then-part);会被计算，否则(else-part);会被计算。

而if函数的返回值是，如果(condition);为真（非空字符串），那个(then-part);会是整个函数的返回值，如果(condition);为假（空字符串），那么(else-part);会是整个函数的返回值，此时如果(else-part);没有被定义，那么，整个函数返回空字串。

所以，(then-part);和(else-part);只会有一个被计算。

call函数

call函数是唯一一个可以用来创建新的参数化的函数。你可以写一个非常复杂的表达式，这个表达式中，你可以定义许多参数，然后你可以用call函数来向这个表达式传递参数。其语法是：
$(call (expression);,(parm1);,(parm2);,(parm3);…)
当make执行这个函数时，(expression);参数中的变量，如$(1)，$(2)，$(3)等，会被参数(parm1);，(parm2);，(parm3);依次取代。而(expression);的返回值就是call函数的返回值。例如：

reverse =  \\$(1) \\$(2) 
foo = \\$(call reverse,a,b) 

那么，foo的值就是“a b”。当然，参数的次序是可以自定义的，不一定是顺序的，如：

reverse =  \\$(2) \\$(1) 
foo = \\$(call reverse,a,b) 

此时的foo的值就是“b a”。

origin函数

origin函数不像其它的函数，他并不操作变量的值，他只是告诉你你的这个变量是哪里来的？其语法是：
$(origin (variable)😉
注意，(variable);是变量的名字，不应该是引用。所以你最好不要在(variable);中使用“$”字符。Origin函数会以其返回值来告诉你这个变量的“出生情况”，下面，是origin函数的返回值:

“undefined”
        如果(variable);从来没有定义过，origin函数返回这个值“undefined”。
“default”
        如果(variable);是一个默认的定义，比如“CC”这个变量，这种变量我们将在后面讲述。
“environment”
        如果(variable);是一个环境变量，并且当Makefile被执行时，“-e”参数没有被打开。
“file”
        如果(variable);这个变量被定义在Makefile中。
“command line”
        如果(variable);这个变量是被命令行定义的。
“override”
        如果(variable);是被override指示符重新定义的。
“automatic”
        如果(variable);是一个命令运行中的自动化变量。关于自动化变量将在后面讲述。

这些信息对于我们编写Makefile是非常有用的，例如，假设我们有一个Makefile其包了一个定义文件Make.def，在Make.def中定义了一个变量“bletch”，而我们的环境中也有一个环境变量“bletch”，此时，我们想判断一下，如果变量来源于环境，那么我们就把之重定义了，如果来源于Make.def或是命令行等非环境的，那么我们就不重新定义它。于是，在我们的Makefile中，我们可以这样写：

shell函数

shell函数也不像其它的函数。顾名思义，它的参数应该就是操作系统Shell的命令。它和反引号“`”是相同的功能。这就是说，shell函数把执行操作系统命令后的输出作为函数返回。于是，我们可以用操作系统命令以及字符串处理命令awk，sed等等命令来生成一个变量，如：

contents := $(shell cat foo)
files := $(shell echo *.c)

注意，这个函数会新生成一个Shell程序来执行命令，所以你要注意其运行性能，如果你的Makefile中有一些比较复杂的规则，并大量使用了这个函数，那么对于你的系统性能是有害的。特别是Makefile的隐晦的规则可能会让你的shell函数执行的次数比你想像的多得多。

wildcard 函数

他有一个参数，功能是展开成一列所有符合由其参数描述的文
件名，文件间以空格间隔。你能像下面所示使用这个命令：
SOURCES = $(wildcard *.c)
这行会产生一个所有以 ’.c’ 结尾的文件的列表，然后存入变量 SOURCES 里。当然你不必一定要把结果存入一个变量。