基于LLVM&clang的cpp工具开发-1 环境安装

本系列文章的运行环境基于CentOS 6.3 x86_64,gcc 5.2.0,cmake version 3.15.0, glibc 2.23.2,后文不再赘述。

LLVM&clang简介

LLVM是一组编译工具链集合,值得注意的是,LLVM并不是谁的缩写,其中的VM与virtual machine也没有关系。如官网所述,LLVM就是这个项目的名称,没有其他含义。
clang(读音/klaNG/,音同可浪)是LLVM的一个子项目(sub-project)。 它是一个C系语言编译前端,同时clang还提供了以下三种面向开发者的扩展方式:

  • C Library libclang ,libclang是一套稳定的(stable)但对AST控制不够全面的C Libray
  • C++ Library libtooling,libtooling是一套对AST控制全面但却不够稳定的C++ Library,不稳定指的是无前后兼容保证,接口经常变化(包括函数名称、函数参数列表)
  • plugin, C++接口,主要针对单次编译的单个文件,比如可用于实现一个自定义风格的代码检查工具

不同的业务目标,可以在以上三种做出选择,本系列最终目的是完成中大型项目的代码索引,所以选择基于libtooling进行开发。

安装

源码下载

由于libtooling的不稳定因素,我们决定采用最新的LLVM8.0-release版本。
分别下载LLVM源码clang源码clang-tools-extra源码并解压。由于LLVM各个工程共享了很多CMake配置,因此需要调整他们的位置,
假设LLVM、clang、clang-tools-extra源码解压后被放置在 LLVM_SRC_ROOT, CLANG_SRC_ROOT,CLANG_TOOLS_EXTRA_ROOT,那么需要进行如下的目录调整

#set these 3 env
export LLVM_SRC_ROOT=/path/to/your/llvm
export CLANG_SRC_ROOT=/path/to/your/cfe #clang-src
export CLANG_TOOLS_EXTRA_ROOT=/path/to/your/clang-tools-extra

#will use 3 env defined above
mv ${CLANG_SRC_ROOT} ${LLVM_SRC_ROOT}/tools/clang
mv ${CLANG_TOOLS_EXTRA_ROOT} ${LLVM_SRC_ROOT}/tools/clang/tools/extra

使用ln -s TARGET LINK的方式建立两个软链也可达到类似的收益。

除了上面的方式,官方提供了cmake 宏 LLVM_ENABLE_PROJECTS,可以不将clang等源码目录移动到llvm下:

  1. 将clang解压至 ${LLVM_SRC_ROOT}/..,即llvm-src的平级目录, 命名为clang
  2. 将extra-tool也解压到llvm平级目录,命名为clang-tools-extra
  3. 在${LLVM_SRC_ROOT}/build下,cmake -DLLVM_ENABLE_PROJECTS=clang -G "Unix Makefiles" .., 这时, LLVM_TOOL_CLANG_TOOLS_EXTRA_BUILD 会被设置成ON,继续编译: make clang && make clangd

编译安装

先决条件

最新的LLVM需要CMake. Version 3.4.3,下文假设合适版本的cmake已经正确安装,此外编译LLVM,最好磁盘剩余80G以上空间。

编译前空间:

$ df -h
Filesystem Size Used Avail Use% Mounted on
/dev/vda1 20G 5.0G 14G 28% /
tmpfs 7.8G 11M 7.8G 1% /dev/shm
/dev/vdb 233G 8.6G 212G 4% /home

编译后剩余空间:

$ df -h
Filesystem Size Used Avail Use% Mounted on
/dev/vda1 20G 5.0G 14G 28% /
tmpfs 7.8G 11M 7.8G 1% /dev/shm
/dev/vdb 233G 82G 139G 38% /home

粗略的空间估算, 由于进行的是LLVM全系列编译,硬盘消耗约80G, 如没有如此多的空间,可根据需要只编译某一部分,比如 在cmake build时,仅执行make clang

假设CMake和CXX(比如g++)是工作的,直接按照官方文档编译即可, 编译比较耗时,为了加速,可以设置-j并发参数,参考如下build命令的注释内容,即使加速,也需要小时级别耗时(视机器配置和负荷有所不同)。

cd ${LLVM_SRC_ROOT}
mkdir -p build
cd build
cmake ${LLVM_SRC_ROOT}
CPU_NUM=`getconf _NPROCESSORS_ONLN`
cmake --build . # to speed up ,  -j <num> is recommended, say : cmake --build . -j  ${CPU_NUM} || cmake --build .
#if compile successfully, install
cmake -DCMAKE_INSTALL_PREFIX=/path/where/llvm/installed  -P cmake_install.cmake

如以上均正确返回,再double check一下,环境变量等是否正确

$ clang++ --version
clang version 8.0.0 (tags/RELEASE_800/final)
Target: x86_64-unknown-linux-gnu
Thread model: posix
InstalledDir: /home/M23/local/llvm/bin

检查一下LLVM的某项配置:

$ llvm-config --cxxflags
-I/home/M23/local/llvm/include -std=c++11 -fno-exceptions -fno-rtti -D_GNU_SOURCE -D_DEBUG -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS

在上面的步骤中,我们还下载了clang-tools-extra, 如果需要编译clangd等extra-tool, 则需要在cmake调用中增加 -DLLVM_TOOL_CLANG_TOOLS_EXTRA_BUILD=ON, 然后 make clangd即可。

至此,我们成功安装了clang开发所需的基础环境。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容