使用clang获取代码中的全局变量、函数（名称，参数，返回值）、结构体信息

最新推荐文章于 2023-11-23 13:54:05 发布
最新推荐文章于 2023-11-23 13:54:05 发布
阅读量4.8k 收藏 14
点赞数 2
文章标签： clang c++ llvm
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/BondChang/article/details/121337117
版权

1.下载clang源码

本人使用的为clang10.0，visual studio版本为2017（亲测2019会有问题）
clang源码下载地址为 https://releases.llvm.org/download.html#10.0.0
image.png

2.编写clang插件

1.解压刚才的源码，进入到llvm\tools\clang\tools\extra目录下，创建文件夹，为自己的项目名称。
image.png
2.进入到自己项目名称的文件夹，将自己写好的c文件和h文件放到此文件夹中。新建文件CMakeLists.txt
image.png
3.编写CMakeLists.txt，规则见图
image.png
4.返回上一级目录，即extra这一层，打开此层的CMakeLists.txt，结尾加入：
image.png

3.下载cmake

1.cmake下载地址https://cmake.org/download/
2.下载64位版本
image.png
3.傻瓜安装，记得加入到环境变量中
image.png

4.使用cmake进行编译（cmake编译依赖python解释器，记得安装python）

1.打开cmake，选择clang的源码目录和编译目录
image.png
2.选择visual stdio版本（亲测clang10.0 visual stdio2019 无法编译通过，请使用visual stdio2017）
image.png
3.点击配制，点击生成
image.png
4.生成完成后，即可在编译目录看见相应的vc工程（双击LLVM.sln。打开工程）
image.png
5.在Clang executables下可以发现自己的工程
image.png

4.ASTMatcher

1.ASTMatcher类似于正则表达式，书写规则参考官网。很详细https://clang.llvm.org/docs/LibASTMatchersReference.html
2.我们即使用ASTMatcher来匹配所有的全局变量、函数（名称，参数，返回值）、结构体信息
image.png
如varDecl为变量，hasGlobalStorage可以筛选全局变量。

5.处理全局变量

1.获取到了全局变量节点，接下来主要调用clang的接口获取全局变量的名称，类型，维度，初值等信息存储到我们自定义的数据结构中。

VariableInfoStruct variableInfoStruct;
	/* 获取变量名 */
	std::string nameStr = varDeclNode->getNameAsString();
	std::string initValueStr = "";
	std::string fileName = getNodePath(varDeclNode->getLocation(), Result);
	auto firstDeclNode = varDeclNode->getFirstDecl();
	std::string firstDeclPath = getNodePath(firstDeclNode->getLocation(), Result);
	variableInfoStruct.hPath =
		strcpy(new char[firstDeclPath.length() + 1], firstDeclPath.data());
	variableInfoStruct.path =
		strcpy(new char[fileName.length() + 1], fileName.data());
	variableInfoStruct.name =
		strcpy(new char[nameStr.length() + 1], nameStr.data());
	variableInfoStruct.nodeLocInfo = getLineNumInfo(varDeclNode->getSourceRange(), Result.Context);
	/* 获取变量类型,不带类型信息 */
	std::string typeStr = varDeclNode->getType()
		.getLocalUnqualifiedType()
		.getCanonicalType()
		.getAsString();
	QualType nodeType = varDeclNode->getType();
	// std::cout << varDeclNode->getType().getTypePtr()->getTypeClassName();
	const Type *type = varDeclNode->getType().getTypePtr();
	std::string name = clang::QualType(type, 0).getAsString();
	// std::cout << nodeType.getCanonicalType().getAsString() << "\n";
	dealType(typeStr, nodeType, &variableInfoStruct);
	/* 获取初始化器 */
	const Expr *initExpr = varDeclNode->getAnyInitializer();
	/* 处理全局变量的初值 */
	std::vector<InitAstStruct> initAstStructVector;
	dealInitValue(initExpr, &initValueStr, Result, &initAstStructVector);
	variableInfoStruct.initValue =
		strcpy(new char[initValueStr.length() + 1], initValueStr.data());
	variableInfoStruct.initAstStruct = initAstStructVector;
	cfile->globalVars.push_back(variableInfoStruct);

6.函数

1.获取到了函数节点，接下来主要调用clang的接口获取函数的名称，参数类型，参数名称，返回值名称，返回值类型等信息存储到我们自定义的数据结构中。

 const FunctionDecl *firstDeclNode = functionDeclNode->getFirstDecl();
	std::string firstDeclFilePath = getNodePath(firstDeclNode->getLocation(), Result);
	FunctionInfoStruct functionInfoStruct;
	std::string fileName = getNodePath(functionDeclNode->getLocation(), Result);
	functionInfoStruct.path = strcpy(new char[fileName.length() + 1], fileName.data());
	functionInfoStruct.hPath = strcpy(new char[firstDeclFilePath.length() + 1], firstDeclFilePath.data());
	std::string nameStr = functionDeclNode->getNameAsString();
	std::string typeStr = functionDeclNode->getReturnType().getAsString();
	functionInfoStruct.name = strcpy(new char[nameStr.length() + 1], nameStr.data());
	functionInfoStruct.type = strcpy(new char[typeStr.length() + 1], typeStr.data());
	functionInfoStruct.nodeLocInfo = getLineNumInfo(functionDeclNode->getSourceRange(), Result.Context);
	functionInfoStruct.paraCount = functionDeclNode->getNumParams();

	unsigned int paraNum = functionDeclNode->getNumParams();
	if (paraNum > 0) 
	{
		for (int i = 0; i < paraNum; i++)
		{
			VariableInfoStruct variableInfoStruct;
			std::string nameStr = functionDeclNode->getParamDecl(i)->getNameAsString();
			variableInfoStruct.name = strcpy(new char[nameStr.length() + 1], nameStr.data());

			/* 获取函数参数的类型 */
			const clang::ParmVarDecl *paramDecl = functionDeclNode->getParamDecl(i);
			QualType parType = paramDecl->getType();
			QualType parLocalUnqualifiedType = parType.getLocalUnqualifiedType();
			QualType parCanonicalType = parLocalUnqualifiedType.getCanonicalType();
			std::string typeStr = parCanonicalType.getAsString();

			/* 将函数参数的类型转换为Type,方便后续判断是否为数组类型 */
			const Type *type = functionDeclNode->getParamDecl(i)->getType().getTypePtr();
			clang::SourceRange srcRange = functionDeclNode->getParamDecl(i)->getSourceRange();
			variableInfoStruct.nodeLocInfo = getLineNumInfo(srcRange, Result.Context);

			/* 说明是Decayed类型,即本来是数组类型，被clang转换成指针类型 */
			QualType nodeType = functionDeclNode->getParamDecl(i)->getType();
			if (type->getTypeClass() == 8) {
				const DecayedType *DT = type->getAs<DecayedType>();
				type = DT->getOriginalType().getTypePtr();
				nodeType = DT->getOriginalType();
			}
			dealType(typeStr, nodeType, &variableInfoStruct);
			functionInfoStruct.paras.push_back(variableInfoStruct);
		}
	}
	cfile->functions.push_back(functionInfoStruct);

7.结构体

1.获取到了结构体节点，接下来主要调用clang的接口获取结构体的名称，成员变量等信息存储到我们自定义的数据结构中。

if (varRecordDeclNode->field_begin() != varRecordDeclNode->field_end())
	{
		/* 说明结构体有成员 */
		StructInfo structInfo;
		structInfo.nodeLocInfo = getLineNumInfo(varRecordDeclNode->getSourceRange(), Result.Context);
		std::string nameStr = "";
		std::string qualifier = "";

		/* 如果是匿名结构体,则获取匿名结构体的名称 */
		std::string anonymousName = getAnonymousName(varRecordDeclNode, Result);
		if (!anonymousName.empty()) {
			nameStr = anonymousName;
		}
		if (nameStr.empty() && varRecordDeclNode->getTypedefNameForAnonDecl()) {
			/* 获取结构体的typedef名称 */
			nameStr = varRecordDeclNode->getTypedefNameForAnonDecl()->getNameAsString();
		}
		if (nameStr.empty()) {
			/* 直接获取结构体的名字 */
			nameStr = varRecordDeclNode->getNameAsString();
		}
		else {
			qualifier = "typedef";
		}

		std::string structType = "";
		if (varRecordDeclNode->isStruct()) {
			structType = "struct";
		}
		else {
			structType = "union";
		}

		structInfo.type = strcpy(new char[structType.length() + 1], structType.data());
		std::string fileName = getNodePath(varRecordDeclNode->getLocation(), Result);
		structInfo.path = strcpy(new char[fileName.length() + 1], fileName.data());
		structInfo.name = strcpy(new char[nameStr.length() + 1], nameStr.data());
		structInfo.qualifier = strcpy(new char[qualifier.length() + 1], qualifier.data());

		/* 记录结构体的field数量 */
		for (RecordDecl::field_iterator jt = varRecordDeclNode->field_begin(); jt != varRecordDeclNode->field_end(); jt++)
		{
			dealRecordField(&structInfo, jt, Result);
		}

		cfile->structs.push_back(structInfo);

		return (structIdx + 1);
	}
	else
	{
		return structIdx;
	}

本项目完整的代码见https://github.com/BondChang/GetCFileInfo.git。大家有疑问随时联系。一定知无不言。

BondChang
关注
iOS之深入解析Block的使用和外部变量捕获
╰つ栺尖篴夢ゞ
03-16 3万+
一、前言 闭包 = 一个函数「或指向函数的指针」+ 该函数执行的外部的上下文变量「也就是自由变量」; Block是Objective-C对于闭包的实现。 其中，Block: 可以嵌套定义，定义Block方法和定义函数方法相似； Block 可以定义在方法内部或外部； 只有调用Block时候，才会执行其{}体内的代码； 本质是对象，使代码高聚合。 使用 clang 将 OC 代码转换为 C++ 文件查看block的方法: 在命令行输入代码 clang -rewrite-objc 需要编译的OC文件
Clang类结构模仿重构
apple_52057430的博客
12-25 321
经过上一节的探索，可以得出实现所需的诸多类，本节旨在精简这些繁杂的类，以求找到最精简的表达方式，从而降低实现门槛。
LLVM-Clang 二次开发--查找全局变量及其调用函数
whdAlive 's blog
05-12 5557
前言 应这学期大作业要求，完成了基于Clang的二次开发，实现了基于Clang的LibTooling &amp; 库，编写ASTMatcher来查找相应变量以及调用函数。 前期准备 项目初期，由于不清楚后续的工作，没有一个总览，导致走了许多弯路。比如使用 Svn 下载llvm &amp; Clang 的源码，由于网络问题，我们发现下载得到的源码始终不完整；再比如通过 Visual Stu...
2021年2月16日 【Jiawei_Z】C语言基本功--结构体详解1（结构体定义、成员赋值的2种写法）
Jiawei_Z的博客
02-16 730
在C语言中，可以使用结构体（Struct）来存放一组不同类型的数据。结构体的定义形式为： struct 结构体名{ 结构体所包含的变量或数组 }; 结构体是一种集合，它里面包含了多个变量或数组，它们的类型可以相同，也可以不同， 每个这样的变量或数组都称为结构体的成员（Member）。 请看下面的一个例子： stu 为结构体名，它包含了 5 个成员，分别是 name、num、age、group、score。 结构体成员的定义方式与变量和数组的定义方式相同，只是不能初始化。 struct..
用python获取.c文件中的函数及函数内容
最新发布
舊梦的博客
11-23 559
需要注意的是，上述示例可能仍然无法涵盖所有的注释和宏定义情况，因为注释和宏定义的写法非常灵活。错误时，这意味着文件包含了无法解码的字符，而 Python 在默认情况下使用的是 UTF-8 编码进行解码。要在读取.c文件中定义的函数及其函数内部调用的函数名时处理注释和宏定义，可以在代码中添加一些额外的处理逻辑。因此，最好还是知道文件的实际编码方式，并根据需要指定正确的编码。通过在提取函数定义和函数调用的过程中添加注释和宏定义的处理逻辑，我们可以更好地处理这些特殊情况，并正确提取函数名。开头的行时，我们根据。
Kerner Modules Makefile 使用 clangd 补全函数
HongDaYu的搬砖之路
02-12 252
... ...
Clang看block底层结构
iOS随笔
12-03 450
学习目标： 疑问：block到底是什么 1：block是oc对象 2：block是指针 block是oc对象： int age = 30; void (^yang)(void) = ^{ NSLog(@"%d", age); }; yang(); clang转cpp struct __block_impl { void *isa; int Flags; int Reserved; void *FuncPtr; }; st
结构化编译器前端 Clang 介绍
我在天上飘的博客
11-10 812
http://www.ibm.com/developerworks/cn/opensource/os-cn-clang/ RecursiveASTVisitor，这是一个重要的函数模板。通过介绍这个模板，我们将向您简单介绍遍历抽象语法树的一些基本概念。 RecursiveASTVisitor 是一个深度优先遍历 AST 和访问节点的类。对于一个已经构造好的语法树，它将完成以下三方面的工
c代码-ce shi dai ma
07-14
对于错误处理，通常使用`errno`全局变量和`perror`函数来获取和打印错误信息。 最后，C语言的内存管理是手动进行的，使用`malloc`，`calloc`，`realloc`进行动态内存分配，用`free`释放已分配的内存。这要求程序员...
c代码-xxxxxxx
07-14
3. **函数**：C语言中的函数是可重用的代码块，可以接收参数并返回值。理解函数的定义、调用和作用域规则至关重要。 4. **指针**：C语言的指针是其强大之处，它们允许直接操作内存地址。理解指针的使用、解引用和...
Swift —— 类与结构体
LinShunIos的博客
12-28 2039
Swift —— 类与结构体1. 初识类与结构体1.1 异同点1.2 类（引用类型）1.3 结构体 （值类型）1.4 类和结构体的内存位置1.4.1 结构体的内存位置1.4.2 类的内存位置2. 类的初始化器2.1 指定初始化器&便捷初始化器2.2 可失败初始化器2.3 必要初始化器3. 类的生命周期3.1 SIL文件分析3.2 类的初始化流程 1. 初识类与结构体 1.1 异同点 结构体和类的主要相同点有: 定义存储值的属性 定义方法 定义下标以使用下标语法提供对其值的访问 定义初始化器 使用
Clang如何编译函数
wuhui_gdnt的专栏
11-02 1100
作者：John Regehr 原文地址：https://blog.regehr.org/archives/1605 我计划编写一篇关于LLVM如何优化函数的博客，但看起来首先要写清楚Clang如何将C或C++翻译为LLVM。 这将是相当高层面的： 不是关注Clang的内部，我将关注Clang的输出如何与其输入相关 我们不准备看任何非平凡的C++特性 我们将使用这个小函数，它是我从这些关于...
python展开 c函数中的宏预处理_C中的宏与函数
weixin_39631295的博客
12-13 320
ideasman42..12如有疑问,请使用函数(或内联函数).然而,这里的答案主要解释宏的问题,而不是有一些简单的观点,宏是邪恶的,因为愚蠢的事故是可能的.你可以意识到陷阱并学会避免它们.然后只有在有充分理由的情况下才使用宏.在某些特殊情况下,使用宏有一些优势,包括:通用函数,如下所述,您可以拥有一个可用于不同类型的输入参数的宏.它们可以任选包括本地信息,如调试字符串:(__FILE__,__L...
Clang解析C++程序(3)
yangsh3002的专栏
10-10 1033
编译器实例的语言设置不区区只是C语言和C++语言的简单区分，其中有多达100多条设置，其中绝大部分我都看不明白，看不明白也不用去弄明白，工作这么忙，只要知其然就好，下面是我经过仔细比较得出来的需要去手动设置的项，其它的都用默认设置。 LangOptions &lo = TheCompInst.getLangOpts(); lo.MSVCCompat = 1; lo.MicrosoftExt =
python对c语言宏展开,展开宏并检索宏值
weixin_39854778的博客
05-19 442
我尝试使用libclangpython绑定来解析我的c++源文件。我无法获取宏的值或展开宏。这是我的c++代码示例#define FOO 6001#define EXPAND_MACR \int \foo = 61int main(){EXPAND_MACR;cout << foo;return 0;}这是我的python脚本^{pr2}$这是我从clang那里得到的信息：Found...
clang插件对llvm源码插桩，分析函数调用日志(2)--google镜像
_
11-10 473
clang插件对llvm源码插桩，分析函数调用日志(2)--google镜像
GCC源码分析(九) — gcc全局符号表与符号的分析(gimplify)
ashimida
08-29 3216
一、全局符号表 在gcc中有一个全局变量symbol_table *symtab; 此变量是用来记录整个编译过程中产生的所有函数和符号的, symbol_table类的关键元素记录如下: class symbol_table { public: friend class symtab_node; friend class cgraph_node; friend class cgraph_edge; int cgraph_count; /* 记录当前全局符号表中的函数...
使用libclang解析C++代码
倦鸟归时
09-17 3683
使用libclang解析C++代码 梦在哪里2019-05-28 12:17:113689收藏9 分类专栏：C++Clang文章标签：C++libclangClangAST 版权 使用libclang解析C++代码 1. libclang? 2. libclang! 3. 基本的例子 4. Cursors(游标) 5. Visit children 6. CXString 7. 打印有意义的输出 8. 一个更复...
libClang前端语法解析(CXCursor使用)
Funning的博客
06-02 827
# std::Map template<class InputIt> using iter_key_t = std::remove_const_t<typename std::iterator_traits<InputIt>::value_type::first_type>; template<class InputIt> using iter_val_t = typename std::iterator_traits<InputIt>::v.
clang编译器中控制流完整性的参数
04-04
clang编译器中控制流完整性的参数主要有以下几个： 1. -Wunreachable-code：该参数会在编译时检查代码中是否存在不可达的代码，例如switch语句中没有处理所有情况或者if语句中没有处理else分支等。 2. -Wreturn-type：该参数会检查函数的返回值类型是否与函数定义时指定的类型一致。 3. -Wimplicit-fallthrough：该参数会检查switch语句中的case是否有意或者无意地落入下一个case，如果有则会发出警告。 4. -Wswitch：该参数会检查switch语句中是否存在case标签值重复的情况，或者是否存在不处理所有情况的情况。 5. -Wparentheses：该参数会检查代码中括号的使用是否正确，例如是否缺少括号或者是否多余括号等。 6. -Wformat：该参数会检查printf等函数的参数是否与格式字符串匹配，避免出现格式化字符串攻击的情况。 7. -Wnull-dereference：该参数会检查代码中是否存在对空指针的解引用操作，避免程序崩溃。 8. -Wuninitialized：该参数会检查变量是否未初始化就被使用，避免程序出现未定义行为。 通过使用这些控制流完整性的参数，可以有效地提高代码质量和安全性。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值