Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 6.71 KB

llvm.md

File metadata and controls

126 lines (94 loc) · 6.71 KB
Raw

LLVM

Everything is on llvm official website.

1. Introduction

1.1 Installation via official script

Only for Debian and Ubuntu:

wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 13

1.2 Installation via source code

And the llvm download page, select a version (13.0.0) and then download three files:

  • LLVM source code
  • Clang source code
  • Compiler RT source code

After downloading and unzip, you can get three files: llvm-13.0.0.src、clang-13.0.0.src、compiler-rt-13.0.0.src. Usually, you can rename three files: llvm-13.0.0.src is recommended to llvm-13.0.0；clang-13.0.0.src is renamed to clang，and put it into llvm-13.0.0/tools；compiler-rt-13.0.0.src is renamed to compiler-rt and put into llvm-13.0.0/projects/.

The shell script is as follows (13.0.0 as an example)

# 下载源码
wget https://github.com/llvm/llvm-project/releases/download/llvmorg-13.0.0/llvm-project-13.0.0.src.tar.xz
# 解压源码
tar xvf llvm-project-13.0.0.src.tar.xz
# 新建安装目录
sudo mkdir -p /usr/local/llvm
# 新建编译目录
sudo mkdir -p llvm-project-13.0.0.src/build
# 进入编译目录
cd llvm-project-13.0.0.src/build
# cmake生成编译信息
cmake -G "Unix Makefiles" -DLLVM_ENABLE_PROJECTS="clang;lldb" -DLLVM_TARGETS_TO_BUILD=X86 -DCMAKE_BUILD_TYPE="Release" -DLLVM_INCLUDE_TESTS=OFF -DCMAKE_INSTALL_PREFIX="/usr/local/llvm" ../llvm
# 编译
make
# 安装到安装目录
make install

usr/local/llvm is installation directory, llvm-project-13.0.0.src is source code directory, llvm-project-13.0.0.src/build is a directory which contains the built file.

and we could see whether it is installed succesfully:

./clang -v
./clang -help

and then we write a helloworld program in main.c.

# 二进制代码形式
clang -emit-llvm -c main.c -o main.bc

# 可读文本代码形式
clang -S -emit-llvm -c main.c -o main.ll

2. LLVM Doc

LLVM的文档主要分为一下几类：

  • Design & Overview 这个类别里的文档主要是几篇介绍LLVM架构和设计的论文和会议报告。

  • Publications 这个类别主要是一个已经发布的基于LLVM的项目列表。

  • User Guides 这个类别的文档主要是针对刚接触LLVM，打算使用LLVM的用户，并且此类用户打算接触LLVM的中间表示。如果只是打算把LLVM作为一个编译器使用，可以考虑clang : http://clang.llvm.org/ 或者DragonEgg: http://dragonegg.llvm.org/

  • API Clients 这个类别主要是针对以LLVM为基础进行工程开发的人。提供一些介绍编程需要的文档。比如:编程手册、编程规范等文档。

  • Subsystems 这个类别里的文档主要是介绍子系统的。相对前一个类别，这个列别里的文档都是针对的是LLVM里的某一块。比如介绍如何写Pass,如何写 Backend等。

  • Development Process 这个类别里主要介绍的是开发过程中的几个动作需要的文档。如何构建工程，如果编译工程，如何发布等。

  • Mailing Lists 这里主要是几个邮件列表，有开发的还有报告bug的，还有关于提交代码的。

3. LLVM IR

IR是 intermediate representation的缩写，顾名思义是中间表示的的缩写。中间表示已经被越来越多的编译器所采用，传统的编译器多采用汇编语言作为自己的中间语言，而现在大一些的编译器都有了自己专属的中间表示。LLVM IR的官方文档地址： http://llvm.org/docs/LangRef.html

LLVM IR主要有三种格式：一种是在内存中的编译中间语言；一种是硬盘上存储的二进制中间语言(以.bc结尾)，最后一种是可读的中间格式(以.ll结尾)。这三种中间格式是完全相等的。

LLVM IR是LLVM优化和进行代码生成的关键。根据可读的IR，我们可以知道再最终生成目标代码之前，我们已经生成了什么样的代码。而且根据IR，我们可以选择使用不同的后端而生成不同的可执行代码。同时，因为使用了统一的IR，所以我们可以重用LLVM的优化功能，即使我们使用的是自己设计的编程语言。

我们需要首先理解四个具有依次包含关系的基本概念：

  • Module（模块）是一份LLVM IR的顶层容器，对应于编译前端的每个翻译单元（TranslationUnit）。每个模块由目标机器信息、全局符号（全局变量和函数）及元信息组成。
  • Function（函数）就是编程语言中的函数，包括函数签名和若干个基本块，函数内的第一个基本块叫做入口基本块。
  • BasicBlock（基本块）是一组顺序执行的指令集合，只有一个入口和一个出口，非头尾指令执行时不会违背顺序跳转到其他指令上去。每个基本块最后一条指令一般是跳转指令（跳转到其它基本块上去），函数内最后一个基本块的最后条指令是函数返回指令。
  • Instruction（指令）是LLVM IR中的最小可执行单位，每一条指令都单占一行

如果想直观的看下llvm的IR到底是什么样的，可以先写一个helloworld的程序，文件名字叫做hello.c。

然后根据文档的内容使用下列命令可以得到二进制的.bc文件： clang -emit-llvm -c hello.c -o hello.bc

然后使用下列命令可以得到对应的hello.ll文件，这个文件是可读的，可以通过文本编辑器打开。 llvm-dis hello.bc

4. LLVM Pass

阅读文档 Write an LLVM pass: http://llvm.org/docs/WritingAnLLVMPass.html

LLVM 的Pass框架是LLVM系统的一个很重要的部分。每个Pass都是做优化或者转变的工作，LLVM的优化和转换工作就是由很多个Pass来一起完成的。

所以按照我的理解，Pass就是LLVM系统转化和优化的工作的一个节点，每个节点做一些工作，这些工作加起来就构成了LLVM整个系统的优化和转化。Pass架构这么做的话，可重用性非常好，你可以选择已有的一些Pass，自己去构建出自己想要的优化和转化效果。并且自己也可以重新写Pass去做自己想要的优化和转变，因为每个Pass都可以独立存在，所以新建Pass并不用考虑LLVM之前的优化和转化是怎么做的，自己可以只运行自己新建的Pass，这样可以方便的实现自己想要的效果。

MISC