最近为了给xmake实现预编译头文件的支持,研究了下各大主流编译器处理预编译头的机制以及之间的一些差异。
现在的大部分c/c++编译器都是支持预编译头的,例如:gcc,clang,msvc等,用于优化c++代码的编译速度,毕竟c++的头文件如果包含了模板定义的话,编译速度是很慢的, 如果能够吧大部分通用的头文件放置在一个header.h
中,在其他源码编译之前预先对其进行编译,之后的代码都能重用这部分预编译头,就可以极大程度上减少频繁的头文件冗余编译。
但是不同编译器对它的支持力度和处理方式,还是有很大差异的,并不是非常通用,在xmake中封装成统一的接口和使用方式,还是费了很大的功夫才搞定。
msvc的预编译头处理
预编译头在msvc的项目中很常见,经常会看到类似stdafx.cpp
, stdafx.h
的文件,就是用于此目的,而msvc编译器是通过编译stdafx.cpp
来生成预编译头文件stdafx.pch
的。
创建预编译头的命令行如下:
$ cl.exe -c -Yc -Fpstdafx.pch -Fostdafx.obj stdafx.cpp
其中,-Yc
就是创建预编译头stdafx.pch
的意思,通过-Fp
来指定*.pch
的输出文件路径,用-Fo
指定编译stdafx.cpp
生成对象文件。
其他源码是如何使用这个stdafx.pch
的呢,通过将stdafx.h
传入-Yu
来告诉编译器,编译当前代码,忽略#include "stdafx.h"
,直接使用已经编译好的stdafx.pch
文件。
$ cl.exe -c -Yustdafx.h -Fpstdafx.pch -Fotest.obj test.cpp
最后链接的时候,需要把:stdafx.obj
, test.obj
都连接上才行,这个也是和gcc, clang编译器不同的地方。
$ link.exe -out:test test.obj stdafx.obj
注:一定要吧stdafx.obj
也链接上哦,虽然stdafx.cpp
仅用于生成stdafx.pch
,但是对象文件也是需要。
还有个跟gcc, clang有区别的地方是,msvc的-Yu
指定stdafx.h
必须是#include "stdafx.h"
中的头文件名字,不是文件路径哦。
clang的预编译头文件处理
个人感觉clang的预编译头文件支持方式最为友好,也最为简单。
相比于msvc,不需要stdafx.cpp
,只需要一个头文件stdafx.h
就可以生成pch文件。 相比于gcc,可以灵活控制pch文件的路径,更加灵活。
编译头文件生成pch文件:
$ clang -c -o stdafx.pch stdafx.h
使用预编译头文件:
$ clang -c -include stdafx.h -include-pch stdafx.pch -o test.o test.cpp
其中-include stdafx.h
用于忽略编译test.cpp
中的#include "stdafx.h"
,通过-include-pch
使用预先编译好的stdafx.pch
。
并且这里指定的stdafx.h
和stdafx.pch
不仅可以是在includedir搜索路径下的文件,也可以指定全路径文件名,非常灵活,例如:
$ clang -c -include inc/stdafx.h -include-pch out/stdafx.pch -o test.o test.cpp
gcc的预编译头文件处理
gcc的预编译头处理方式基本上跟clang的类似,唯一的区别就是:它不支持-include-pch
参数,因此不能所以指定使用的stdafx.pch
文件路径。
它有自己的搜索规则:
- 从
stdafx.h
所在目录中,查找stdafx.h.pch
文件是否存在 - 从
-I
的头文件搜索路径找查找stdafx.h.pch
编译头文件生成pch文件:
$ gcc -c -o stdafx.pch stdafx.h
使用预编译头文件:
$ gcc -c -include stdafx.h -o test.o test.cpp
为了让上述代码正常编译,stdafx.h.pch
必须放置在stdafx.h
的相同目录下,这样编译才能找到,目前我还没有找到可以所以指定输出目录的方法。
其他注意点
gcc、clang对于*.h
的头文件编译,默认是作为c预编译头来使用的,这跟c++的pch是不一样的,无法给c++的代码使用,如果要生成c++可用的pch文件,必须要告诉编译器,如何去编译stdafx.h
。
这个可以通过-x c++-header
参数来解决:
$ gcc -c -x c++-header -o stdafx.pch stdafx.h
当然也可以通过修改后缀名来解决:
$ gcc -c -o stdafx.pch stdafx.hpp
xmake对预编译头文件的支持
xmake支持通过预编译头文件去加速c/c++
程序编译,目前支持的编译器有:gcc, clang和msvc。
使用方式如下:
target("test")
set_precompiled_header("header.h")
通常情况下,设置c头文件的预编译,这需要加上这个配置即可,如果是对c++头文件的预编译,改成:
target("test")
set_precompiled_header("header.hpp")
其中的参数指定的是需要预编译的头文件路径,相对于当前xmake.lua
所在的目录。
如果只是调用xmake命令行进行直接编译,那么上面的设置足够了,并且已经对各个编译器进行支持,但是有些情况下,上面的设置还不能满足需求:
- 如果要使用
xmake project
工程插件生成vs工程文件,那么还缺少一个类似stdafx.cpp
的文件(上面的设置在msvc编译的时候会自动生成一个临时的,但是对IDE工程不友好)。 - 如果gcc/clang下,
header.h
想作为c++的预编译头文件就不支持了,除非改成header.hpp
(默认会当做c头文件进行预编译)。
因此为了更加地通用跨平台,可以在工程里面创建一个类似vc中stdafx.cpp
的源文件:header.cpp
。
target("test")
set_precompiled_header("header.h", "header.cpp")
header.cpp
的内容如下:
#include "header.h"
上面的设置,就可以很好地处理各种情况下的预编译处理,追加的header.cpp
也告诉了xmake:header.h
是作为c++来预编译的。
相对于经典的vc工程中的stdafx.cpp
和stdafx.h
,也能完美支持:
target("test")
set_precompiled_header("stdafx.h", "stdafx.cpp")
更多使用说明见:target.set_precompiled_header
参考资料
Speed up C++ compilation, part 1: precompiled headers
原文出处:http://tboox.org/cn/2017/07/31/precompiled-header/