kaifuny / llvm-tutorial-in-rust

LLVM tutorial in Rust language

LLVM Turorial (Based on Rust Language)

Chinese English

Motivation

• Recently learning Rust language, but don't know what to do, and may need to study LLVM IR related knowledge due to work reasons.
• Official LLVM Tutorial Document, there are few Chinese translations
• MLIR is a sub-project of LLVM, is the infrastructure of the artificial intelligence field, and also needs to understand the basic knowledge of LLVM IR

Reasonable Expectations

• As the cognitive level increases, the understanding of LLVM IR will gradually deepen, and it is difficult to guarantee the completeness and correctness of this document.
• This document is still written based on the official LLVM Tutorial document, and will be written according to the outline of this tutorial, supplemented and modified based on my own understanding and practical experience.
• MLIR is not the focus of this document, and may be briefly introduced in some chapters.
• Although performance issues are an important indicator, the main focus here is on principle reproduction, and irrelevant abstract concepts are avoided as much as possible to avoid over-complication

Development Environment

TODO

References

See the reference section at the end of the document and the annotated links

llvm-tutorial-in-rust's Issues

创建自己的语言前端与 LLVM 教程索引

翻译站点：https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/index.html

注意：

1. 调整其中关于 C++ 语言相关的论述，改为基于 Rust 语言
2. 保留原文的行文顺序以及文章章节的主题**
3. 对于涉及到性能，总结，统计比较相关的描述这个只能在项目最终完成后进行汇总再做补充，此类内容不做翻译

Kaleidoscope 介绍及词法分析器

from: https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl01.html

• 文档翻译和重新组织
• Rust 代码编写
• C++ 代码编写

基于 Vitepress 静态站点生成

• 菜单生成
• Github Action 自动化部署
• 简单的样式调整