使用 Ninja 代替 make
摘自:https://www.jianshu.com/p/d118615c1943
前言
在傳統的 C/C++ 等項目構建時,通常會采用 make 系統使用 Makefile 文件來進行整個項目的編譯構建,通過 Makefile 中指定的編譯所依賴的規則使得程序的構建非常簡單,並且在復雜項目中可以避免由於少部分源碼修改而造成的很多不必要的重編譯。但是它仍然不夠好,因為其大而且復雜,有時候我們並不需要 make 那么強大的功能,相反我們需要更靈活,速度更快的編譯工具。Ninja 作為一個新型的編譯工具,小巧而又高效,它就是為此而生。
這篇文章介紹 Ninja 的安裝以及如何使用 Ninja 來構建項目
首先,我們需要安裝 Ninja,只需要去官網下載一個 release 的二進制版本,放在系統目錄(比如 /usr/bin)中就可以了,非常的簡單。另外,現在大多數 Linux 發行版都有自己的包管理工具,直接使用包管理工具來下載也很簡單。
下面簡單介紹下通過編譯 Ninja 源碼的方式來安裝
首先,確保已經安裝了這些依賴:g++,graphviz,gtest,git,re2c 和 python2.7+。
獲取源碼
$ git clone git://github.com/ninja-build/ninja.git && cd ninja $ git checkout release $ cat README $ ls COPYING HACKING.md README RELEASING bootstrap.py configure.py doc/ misc/ src/
我們可以去 HACKING.md 中查看更多信息。
編譯
一切就緒之后,執行下列命令來編譯 ninja
$ ./configure.py --bootstrap
上述命令會在當前目錄下生成一個叫 ninja (Windows 下是 ninja.exe)的可執行文件,然后我們把這個文件拷到系統目錄(比如 /usr/bin)就完成安裝了。
編譯過程解析
實際上 ninja 本身也是通過 ninja 系統來編譯完成的。
具體過程就是:執行 ./configure.py --bootstrap
之后先編譯源碼(生成一個 a.out),然后在當前目錄生成一個 ninja.build(這個文件類似於 make 工具的 Makefile,語法和規則非常類似)。然后再根據這個 ninja.build 來重新編譯生成可執行文件 ninja,在 ninja 根據 ninja.build 來編譯時會自動創建一個 build 目錄用於存放編譯過程中的臨時文件,比如 *.o 等。
執行./configure.py
時還可以指定其他選項:
--bootstrap bootstrap a ninja binary from nothing
--verbose enable verbose build
--platform choose known platforms
--host choose host known_platforms
--debug enable debugging extras
--profile enable profiling
--with-gtest
--with-python use EXE as the Python interpreter
--force-pselect ppoll() is used by default where available
可以通過 ./configure.py -h
可以查看更多幫助。
如果我們想要開啟 Ninja 的其他特性(比如:Bash completion, Emacs 和 Vim 編輯模式等),編譯完成之后,我們需要把 /misc 目錄中的文件拷貝到合適的位置。
測試
現在,我們可以測試一下 ninja 是否成功安裝並且可以使用。
當直接執行 ninja
命令是,它會在當前目錄下默認尋找 build.ninja 文件來進行編譯。
ninja 的語法格式是:
$ ninja [options] TARGETs
上述 options 如果沒有則可以省略。比如,直接執行 ./ninja ninja_test
將會生成可執行文件 ninja_test,然后再執行 ninja_test 就可以看到測試結果。
如下:
$ ./ninja ninja_test $ ./ninja_test [214/226] SubprocessTest.SetWithLotsRaise [ulimit -n] above 1025 (currently 1024) to make this test go [226/226] ElideMiddle.ElideInTheMiddle passed
或者,我們還可以直接執行 ./ninja all
,這樣,ninja 就會執行 ninja.build 中指定的所有目標了。
$ ./ninja all [10/10] LINK canon_perftest
上述 ninja_test 和 all 都是 ninja.build 中的 build rule,概念類似於 Makefile 中的 target recipe。
測試完成之后,我們就把 ninja 拷貝到一個系統目錄中 /usr/bin 來完成整個的安裝。
提示: build.ninja 文件類似於 Makefile,熟悉它的語法規則之后我們也可以手動編寫。另外,可以通過 ninja -f NINJA_FILE
的方式來指定 .ninja 文件
更多選項

實際上, ninja 還提供了一個 Python based generator ,它實際上是一個 Python 模塊 misc/ninja_syntax.py
,通過它我們可以較方便的生成 build.ninja 文件。比如,在我們的 Python 文件中引入該模塊之后,就可以直接通過調用 ninja.rule(name='foo', command='bar', depfile='$out.d')
來生成符合 ninja 語法的內容。下面是一個簡單例子:
from ninja_syntax import Writer with open("build.ninja", "w") as buildfile: n = Writer(buildfile) if platform.is_msvc(): n.rule("link", command="$cxx $in $libs /nologo /link $ldflags /out:$out", description="LINK $out") else: n.rule("link", command="$cxx $ldflags -o $out $in $libs", description="LINK $out")
另外,我們還可以在執行 cmake 時通過 -G 選項指定生成器為 ninja 來生成 build.ninja。
比如:
$ cd build
$ cmake -GNinja ../proj_src_dir
Ninja 工具集
Ninja 還集成了 graphviz 等一些對開發非常有用的工具,通過執行 ./ninja -t list
可以查看 ninja 中集成了哪些工具。
下面是一個常見的工具集列表:
ninja subtools:
browse # 在瀏覽器中瀏覽依賴關系圖。(默認會在 8080 端口啟動一個基於python的http服務)
clean # 清除構建生成的文件
commands # 羅列重新構建制定目標所需的所有命令
deps # 顯示存儲在deps日志中的依賴關系
graph # 為指定目標生成 graphviz dot 文件。
如 ninja -t graph all |dot -Tpng -ograph.png
query # 顯示一個路徑的inputs/outputs
targets # 通過DAG中rule或depth羅列target
compdb # dump JSON兼容的數據庫到標准輸出
recompact # 重新緊湊化ninja內部數據結構
手動編寫 .ninja 文件
.ninja 的語法規則跟 Makefile 類似,雖然有許多 generator 工具 可以用來自動生成 .ninja 文件,但是在某些場合可能需要手動編寫或修改 .ninja 文件,下面做個簡單介紹:
# VARIABLE: (referenced like $name or alternate ${name})
cflag = -g -Wall -Werror
# RULE:
rule RULE_NAME
command = gcc $cflags -c $in -o $out
description = ${out} will be treat as "$out"
# BUILD statement:
build TARGET_NAME: RULE_NAME INPUTS
# PHONE rule:(creating alias)
build ALIAS: phony INPUTS ...
# DEFAULT target statement(cumulative):
default TARGET1 TARGET2
default TARGET3
$ ninja
build TARGET1 TARGET2 TARGET3
例子: build.ninja
ninja_required_version = 1.3
#variable
cc = g++
cflags = -Wall
# rule
rule cc
command = gcc $cflags -c $in -o $out
description = compile .cc
# build
build foo.o: cc foo.c
.ninja_log
可以用來指定保存 build 時產生的 log。
子模塊 和 include 指令
subninja 指令可以用來引入其他 .ninja 文件,從而引入一個新的 scope。這意味着,子模塊中可以引用父模塊中的變量。
比如:
subninja obj/content/content_resources.ninja
subninja obj/extensions/extensions_strings.ninja
subninja obj/third_party/expat/expat_nacl.ninja
include 指令也是用來引入其他 .ninja 文件,但是不同的是,引入的其他 .ninja 文件會被引入當前 scope,子模塊中不可以訪問父模塊中的變量。
include obj/content/content_resource.ninja
include obj/extensions/extensions_strings.ninja
include obj/third_party/expat/expat_nacl.ninja
參考
https://github.com/ninja-build/ninja
https://ninja-build.org/manual.html
https://www.jianshu.com/p/d118615c1943