Makefile基础


这是关于Makefile的基本用法

基础知识

目标：依赖

1
2
3
# 先检查tb.sv和dut.sv是不是存在，以及是否有修改。如果依赖有修改或者是目标不存在得时候，就执行下面得命令
simv:tb.sv dut.sv
	vcs -full64 -sverilog tb.sv

伪目标

1
2
3
.PHONY:sim
sim:simv
    ./simv

.ONESHELL:

  • 所有的指令就会在一个shell中执行了
1
2
.ONESHELL:
#正常些指令

语句的回显问题

  • 可以在语句前面用”@“就行了，但是不想每个前面都打的话，就用.SILENT
1
.SILENT: main all    # 后面是目标

条件判断

ifeq

  • 判断一个变量是不是已经定义了
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
OS = Linux
ifdef Win
    OS = Windows
endif


OS = Linux
ifdef Win
    OS = Windows
else ifdef Mac
    OS= MacOS
endif


ifdef Win
    OS = Windows
else ifdef Mac
    OS= MacOS
else 
    OS = Linux
endif

ifndef

  • 判断一个变量是不是没有定义
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
version = 3.0

ifeq ($(version),1.0)            # ifeq后一定要一个空格
    msg := 版本太旧了，请更新版本
else ifeq ($(version), 3.0)
    msg := 版本太新了，也不行
else
    msg := 版本可以用
endif


# 另外的写法
msg = Other
ifeq "$(OS)" "Windows_NT"
    msg = This is a Windows Platform
endif

ifeq '$(OS)' 'Windows_NT'

ifeq '$(OS)' "Windows_NT"

ifneq

  • 判断两个值是不是不相等
1
和上面的一样用法

变量操作

=是二次展开， :=是立即展开

1
2
3
4
5
#只需要修改文件开头就行了，":="表示变量决定于它在makefile中的位置（顺序执行的），而"="是makefile最后的位置
tbfile := tb.sv env_pkg.sv test_pkg.sv
rtlfile := dut.v a.v b.v
simv: $(tbfile) $(rtlfile)
    vcs -full64 -sverilog $(tbfile) $(rtlfile)

取消变量的定义

1
undefine <变量名>

环境变量

1
$(USERNAME)

shell运行赋值

  • 使用!=，运行一个shell命令，返回值赋值给一个变量
1
files != ls

追加

1
files += linzhiwen.cpp

条件赋值

  • 条件赋值的**?=**,变量如果已经赋值了，那么就保持原来的值，如果没有就把右边的赋值给左边
1
2
3
4
var1 = 100
var1 ?= 200
all:
	@echo $(var1)

变量的替换引用

  • 语法：$(var:a=b)，意思是将变量var的值中每一项结尾的a替换为b
1
2
3
var = main.cpp a.cpp b.cpp
objs := $(var:.cpp=.v) 
objes := $(var:%.cpp=%.v)

变量覆盖

  • makefile中的所有的变量都可以通过终端传递，实现覆盖
1
make GUI=xxx

字符替换函数

subst

  • 文本替换函数，返回替换后的文本
1
2
3
4
5
6
7
8
9
10
11
12
13
$(subst target,replacement,text)
        #--- 用relacement替换text中的target
        #--- target 需要替换的内容
        #--- replacement 替换为的内容
        #--- text 需要处理的内容，可以是任意字符串

objs = main.o hello.o
srcs = $(subst .o,.cpp,$(objs))
headers = $(subst .cpp,.h,$(srcs))

all:
    @echo $(srcs)
    @echo $(headers)

patsubst

  • 模式替换， 返回替换后的文本
1
2
3
4
5
6
7
$(patsubst pattern,replacement,text)
        #--- pattern 需要替换的模式
        #--- replacement 需要替换为
        #--- text 待处理内容，各项内容需要用空格隔开
objs = main.ohello.o
srcs = $(subst %.o,%.cpp,$(objs))
headers = $(subst %.cpp,%.h,$(srcs))

strip

  • 去除字符串头部和尾部的空格，中间如果连续有多个空格，则用一个空格替换，返回去除空格后的文本
1
2
3
4
5
$(strip string)
        #--- string 需要去除空格的字符串
files = aa hello.cpp      main.cpp     test.cpp
files := $(subst aa,        ,$(files))
files2 = $(strip $(files))

findstring

  • 查找字符串，如果找到了，则返回对应的字符串，如果没找到，则反回空串
1
2
3
4
5
6
$(findstring find,string)
        #--- find 需要查找的字符串
        #--- string 用来查找的内容
files = hello.cpp main.cpp test.cpp
find = $(findstring hel,$(files))
find = $(findstring HEL,$(files))

filter

  • 从文本中筛选出符合模式的内容并返回
1
2
3
4
5
6
$(filter pattern…,text)
        #--- pattern 模式，可以有多个，用空格隔开
        #--- text 用来筛选的文本，多项内容需要用空格隔开，否则只会当一项来处理

files = hello.cpp main.cpp test.cpp main.o hello.o hello.h
files2 = $(filter %.o %.h,$(files))

filter-out

  • 与filter相反，过滤掉符合模式的，返回剩下的内容
1
2
3
4
5
6
7
$(filter-out pattern…,text)
        #--- pattern 模式，可以有多个，用空格隔开
        #--- text 用来筛选的文本，多项内容需要用空格隔开，否则只会当一项来处理


files = hello.cpp main.cpp test.cpp main.o hello.o hello.h
files2 = $(filter-out %.o %.cpp,$(files))

sort

  • 将文本内的各项按字典顺序排列，并且移除重复项
1
2
3
4
5
6
$(sort list)
       # --- list 需要排序内容


files = hello.cpp main.cpp test.cpp main.o hello.o hello.h main.cpp hello.cpp
files2 = $(sort $(files))

word

  • 用于返回文本中第n个单词
1
2
3
4
5
6
$(word n,text)
        # --- n 第n个单词，从1开始，如果n大于总单词数，则返回空串
        # --- text 待处理文本

files = hello.cpp main.cpp test.cpp main.o hello.o hello.h main.cpp hello.cpp
files2 = $(word 3,$(files))

wordlist

  • 用于返回文本指定范围内的单词列表
1
2
3
4
5
6
$(wordlist start,end,text)
        #--- start 起始位置，如果大于单词总数，则返回空串
        #--- end 结束位置，如果大于单词总数，则返回起始位置之后全部，如果start > end，什么都不返回

files = hello.cpp main.cpp test.cpp main.o hello.o hello.h main.cpp hello.cpp
files2 = $(wordlist 3,6,$(files))

words

  • 返回文本中单词数
1
2
3
4
5
$(words text)
       # --- text 需要处理的文本

files = hello.cpp main.cpp test.cpp main.o hello.o hello.h main.cpp hello.cpp
nums = $(words $(files))

firstword

  • 返回第一个单词
1
$(firstword text)

lastword

  • 返回最后一个单词
1
$(lastword text)

文件名处理函数

dir

  • 返回文件目录
1
2
3
4
5
6
$(dir files)
        #--- files 需要返回目录的文件名，可以有多个，用空格隔开

files = src/hello.cpp main.cpp

files2 = $(dir $(files))

notdir

  • 返回除了目录部分的文件名
1
2
3
4
5
$(notdir files)
        #--- files 需要返回文件列表，可以有多个，用空格隔开

files = src/hello.cpp main.cpp
files2 = $(notdir $(files))

suffix

  • 返回文件后缀名，如果没有后缀返回空
1
2
3
4
5
6
$(suffix files)
        #--- files 需要返回后缀的文件名，可以有多个，用空格隔开


files = src/hello.cpp main.cpp hello.o hello.hpp hello
files2 = $(suffix $(files))

basename

  • 返回除了文件名字后缀的部分
1
2
3
4
5
6
$(basename files)
       # --- files 需要返回的文件名，可以有多个，用空格隔开


files = src/hello.cpp main.cpp hello.o hello.hpp hello
files2 = $(basename $(files))

addsuffix

  • 给文件名字添加后缀
1
2
3
4
5
6
$(addsuffix suffix,files)
        #--- suffix 需要添加的后缀
        #--- files 需要添加后缀的文件名，可以有多个，用空格隔开

files = src/hello.cpp main.cpp hello.o hello.hpp hello
files2 = $(addsuffix .exe,$(files))

addprefix

  • 给文件名字添加前缀
1
2
3
4
5
6
$(addprefix prefix,files)
        #--- prefix 需要添加的前缀
        #--- files 需要添加前缀的文件名，可以有多个，用空格隔开

files = src/hello.cpp main.cpp hello.o hello.hpp hello
files2 = $(addprefix make/,$(files))

join

  • 将两个列表中的内容一对一连接，如果两个列表内容数量不相等，则多出来的部分原样返回
1
2
3
4
5
6
7
8
$(join list1,list2)
        #--- list1 第一个列表
        #--- list2 需要连接的第二个列表


f1 = hello main test
f2 = .cpp .hpp
files2 = $(join $(f1),$(f2))

wildcard

  • 返回符合通配符号的文件列表
1
2
3
4
5
6
$(wildcard pattern)
        #--- pattern 通配符

files2 = $(wildcard *.cpp)
files2 = $(wildcard *)
files2 = $(wildcard src/*.cpp)

realpath

  • 返回文件的绝对路径
1
2
3
4
5
$(realpath files)
       # --- files 需要返回绝对路径的文件，可以有多个，用空格隔开

f3 = $(wildcard src/*)
files2 = $(realpath $(f3))

abspath

  • 返回绝对路径，用法同realpath，如果一个文件名不存在，realpath不会返回内容，abspath则会返回一个当前文件夹一下的绝对路径
1
$(abspath files)

条件函数

if

  • 条件判断，如果条件展开不是空串，则反回真的部分，否则返回假的部分
1
2
3
4
5
6
7
$(if condition,then-part[,else-part])
        #--- condition 条件部分
        #--- then-part 条件为真时执行的部分
        #--- else-part 条件为假时执行的部分，如果省略则为假时返回空串

files = src/hello.cpp main.cpp hello.o hello.hpp hello
files2 = $(if $(files),有文件,没有文件)

or

  • 返回条件中第一个不为空的部分
1
2
3
4
5
6
7
$(or condition1[,condition2[,condition3…]])

f1 = 
f2 = 
f3 = hello.cpp
f4 = main.cpp
files2 = $(or $(f1),$(f2),$(f3),$(f4))

and

  • 如果条件中有一个为空串，则返回空，如果全都不为空，则返回最后一个条件
1
2
3
4
5
6
7
$(and condition1[,condition2[,condition3…]])

f1 = 12
f2 = 34
f3 = hello.cpp
f4 = main.cpp
files2 = $(and $(f1),$(f2),$(f3),$(f4))

intcomp

  • 比较两个整数大小，并返回对应操作结果（GNU make 4.4以上版本）
1
2
3
4
5
6
7
8
9
10
11
12
13
14
$(intcmp lhs,rhs[,lt-part[,eq-part[,gt-part]]]) 
        #--- lhs 第一个数
        #--- rhs 第二个数
        #--- lt-part  lhs < rhs时执行
        #--- eq-part  lhs = rhs时执行
        #--- gt-part  lhs > rhs时执行
        #--- 如果只提供前两个参数，则lhs == rhs时返回数值，否则返回空串 
        #    参数为lhs,rhs,lt-part时，当lhs < rhs时返回lt-part结果，否则返回空
        #    参数为lhs,rhs,lt-part,eq-part，lhs < rhs返回lt-part结果，否则都返回eq-part结果
        #    参数全时，lhs < rhs返回lt-part，lhs == rhs返回eq-part, lhs > rhs返回gt-part



@echo $(intcmp 2,2,-1,0,1)

makefile常用函数

file

  • 读写文件
1
2
3
4
5
6
7
8
9
10
11
12
$(file op filename[,text])
        #--- op 操作
        #        > 覆盖
        #        >> 追加
        #        < 读
        #--- filename 需要操作的文件名
        #--- text 写入的文本内容，读取是不需要这个参数


files = src/hello.cpp main.cpp hello.o hello.hpp hello
write = $(file > makewrite.txt,$(files))
read = $(file < makewrite.txt)

foreach

  • 对一列用空格隔开的字符序列中每一项进行处理，并返回处理后的列表
1
2
3
4
5
6
7
$(foreach each,list,process)
        #--- each list中的每一项
        #--- list 需要处理的字符串序列，用空格隔开
        #--- process 需要对每一项进行的处理

list = 1 2 3 4 5
result = $(foreach each,$(list),$(addprefix cpp,$(addsuffix .cpp,$(each))))

call

  • 将一些复杂的表达式写成一个变量，用call可以像调用函数一样进行调用。类似于编程语言中的自定义函数。在函数中可以用$(n)来访问第n个参数
1
2
3
4
5
6
$(call funcname,param1,param2,…)
       # --- funcname 自定义函数（变量名）
       # --- 参数至少一个，可以有多个，用逗号隔开

dirof =  $(dir $(realpath $(1))) $(dir $(realpath $(2)))
result = $(call dirof,main.cpp,src/hello.cpp)

value

  • 对于不是立即展开的变量，可以查看变量的原始定义；对于立即展开的变量，直接返回变量值
1
2
3
4
5
6
7
8
$(value variable)

var = value function test
var2 = $(var)
var3 := $(var)
all:
    @echo $(value var2)
    @echo $(value var3)

origin

  • 查看一个变量定义的来源
1
2
3
4
5
6
7
8
9
10
$(origin variable)


var2 = origin function 
all:
    @echo $(origin var1)    # undefined 未定义
    @echo $(origin CC)        # default 默认变量
    @echo $(origin JAVA_HOME) # environment 环境变量
    @echo $(origin var2)    # file 在Makefile文件中定义的变量
    @echo $(origin @)        # automatic 自动变量

flavor

  • 查看一个变量的赋值方式
1
2
3
4
5
6
7
8
$(flavor variable)

var2 = flavor function
var3 := flavor funciton
all:
    @echo $(flavor var1)    # undefined 未定义
    @echo $(flavor var2)    # recursive 递归展开赋值
    @echo $(flavor var3)    # simple 简单赋值

eval

  • 可以将一段文本生成Makefile的内容
1
2
3
4
5
6
7
8
$(eval text)

define eval_target = 
eval:
    @echo Target Eval Test
endef

$(eval $(eval_target))

shell

  • 用来执行shell的命令的
1
2
files = $(shell ls *.cpp)
$(shell echo This is from shell function)

let

  • 将一个字符串序列中的项拆开放入多个变量中，并对各个变量进行操作（GNU make 4.4以上版本）
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
$(let var1 [var2 ...],[list],proc)
       # --- var 变量，可以有多个，用空格隔开
       # --- list 待处理字符串，各项之间空格隔开
       # --- proc 对变量进行的操作，结果为let的返回值
            将list中的值依次一项一项放到var中，如果var的个数多于list项数，那多出来的var是空串。如果
            var的个数小于list项数，则先依次把前而的项放入var中，剩下的list所有项都放入最后一个var中


list = a b c d
letfirst = $(let first second rest,$(list),$(first))
letrest = $(let first second rest,$(list),$(rest))


# 结合call可以对所有项进行递归处理
reverse = $(let first rest,$(1),$(if $(rest),$(call reverse,$(rest)) )$(first))
all: ; @echo $(call reverse,d c b a)

信息提示函数

error

  • 用来提示错误信息并终止make执行
1
2
3
4
5
6
7
$(error text)
        #--- text 提示信息

EXIT_STATUS = -1
ifneq (0, $(EXIT_STATUS))
    $(error An error occured! make stopped!)
endif

warning

  • 提示警告信息，make不会终止
1
2
3
4
5
$(warning text)

ifneq (0, $(EXIT_STATUS))
    $(warning This is a warning message)
endif

info

  • 输出一些信息
1
2
3
4
$(info text…)

$(info 编译开始.......)
$(info 编译结束)

多个makefile文件

include

  • 可以读入其他makefile文件的内容，效果就如同在include的位置用对应的文件内容替换一样。
1
2
include mkf1 mkf2 # 可以引入多个文件，用空格隔开
include *.mk    # 可以用通配符，表示引入所有以.mk结尾的文件
  • 如果找不到对应文件，则会报错，如果要忽略错误，可以在include前加-
1
-include mkf1 mkf2

export

  • 可以通过export指令向子项目传递变量
1
2
3
export var  # 传递var
export         # 传递所有变量
unexport    # 取消传递

-C

  • 去到另一个文件夹里面执行make命令
1
$(MAKE) -C dir_name
本文作者： ICXNM-ZLin
本文链接： https://talent-tudou.github.io/2024/10/19/Programming/Makefile/
版权声明： 本作品采用 CC BY-NC-SA 4.0 进行许可。转载请注明出处！
赏

谢谢大佬打赏！

支付宝
微信

扫一扫，分享到微信

微信分享二维码
本站总访问量次 |

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

很惭愧<br><br>只做了一点微小的工作<br>谢谢大家