嵌入式Hacker (es-hacker)

Embedded bsp developer enjoys thinking and hacking opensource and develop boards(NanoPi, LicheePi, RPi...)

0%

Tools / 获取c文件函数名的几种方法

哈喽,我是老吴,继续记录我的学习心得。

如何学习新事物?

人有 2 种思维模式:专注模式和发散模式,你可以把这 2 种模式想象成从手电筒里打出来的光。

专注模式下的光束更紧密,穿透力更强,径直打在一小块区域上。

而发散模式的光柱则是分散的,照亮的范围更广,但各处的光强都会降低。

如果你想要理解新事物,那最好关掉精确的专注思考模式,把开关切换到 “广角光源”,直到你锁定了一个新的、更有成效的方法。

该方法也适用于阅读源代码
现在的软件越来越大,一个开源软件动不动就有几百个文件、几万行代码,想要快速应用或者解决 bug,你还有时间对每一个函数进行源码分析吗?

我的做法是这样的:

1) 先查看源码的目录层次,确定顶层目录负责的功能;

2) 对感兴趣或者需要定制的功能,再查看该目录下的源码文件,确定每一个文件的功能;

3) 开始阅读该文件内的源码,但是我也不会直接从源码的入门函数开始阅读,我会先获取该文件里的所有定义(包括函数、变量),找出自己最关心的函数或者变量进行跟踪阅读。

这是我在阅读源码这件事上对发散模式和专注模式的一次简单应用,你学到了吗?下面我分享几个自己临时想到的获取 C 文件函数名的方法 (list function),只是提供思路,不一定足够严谨和高效,谨慎参考。

觉得有收获的小伙伴们,请帮忙转发一下下哈~

Tools / 获取 c 文件函数名的几种方法

目录:

1
1. 方法1: grep 配合正则表达式
2
2. 方法2: nm 类的调试工具
3
3. 方法3: 开源软件 ctags
4
4. 使用 list function 的方法简单分析 Linux Input 子系统
5
5. 相关参考

1. 方法1: grep 配合正则表达式

1) private 函数:

1
$ grep -E '^(\w+ )?\w+ (\w+ )?\w+( )?\(.*)' SDL_events.c -o | sort | grep static | sort
2
static int SDL_AddEvent(SDL_Event *event)
3
static int SDLCALL SDL_GobbleEvents(void *unused)
4
static int SDL_CutEvent(int spot)
5
static int SDL_StartEventThread(Uint32 flags)
6
static void SDL_StopEventThread(void)

2) public 函数:

1
$ grep -E '^(\w+ )?\w+ (\w+ )?\w+( )?\(.*)' SDL_events.c -o | sort | grep -v static | sort
2
int SDL_PollEvent (SDL_Event *event)
3
...
4
int SDL_WaitEvent (SDL_Event *event)
5
SDL_EventFilter SDL_GetEventFilter(void)
6
Uint32 SDL_EventThreadID(void)
7
Uint8 SDL_EventState (Uint8 type, int state)
8
void SDL_Lock_EventThread(void)
9
...
10
void SDL_Unlock_EventThread(void)

3) 优点:

  • 通用性强,基本所有的 Linux 系统都会有 grep 命令;

  • 可以看到函数的完整定义;

4) 缺点:

  • 某些情景下无法完全匹配所有的函数定义,例如将函数定义分 2 行来写的情况。

2. 方法2: nm 类的调试工具

1) 什么是 nm?

nm 用于检查二进制文件 (包括库,编译后的目标模块,共享目标文件,和独立可执行文件),并显示这些文件的内容,或存储在其中的元信息,特别是符号表。

输出格式:

  • 默认按符号字母序排序;

  • 大写字母表示全局性,小写字母表示局部性;

  • U 表示此符号未定义,C 表示此符号是公共的,T/t 表示此符号在代码段中,D/d 的表示此符号在初始化数据段中,B/b 表示此符号在BSS数据段中;

另外,objdump -t 和 readelf -s 也可以查看目标文件的符号表。

2) 例子:
下面的例子展示了变量和函数在全局、局部、外部、静态、自动和初始化的不同情况下的不同符号类型。

全局/静态 变量:

1
int global_var;
2
int global_var_init = 26;
3
4
static int static_var;
5
static int static_var_init = 25;
6
7
extern int extern_var;
8
extern int extern_function(int);

静态函数:

1
static int static_function(int x, int y)
2
{
3
	int local_automatic_var;
4
5
	local_automatic_var = x + y;
6
	return local_automatic_var;
7
}

全局函数:

1
int global_function(int p)
2
{
3
	static int local_static_var;
4
	static int local_static_var_init=5;
5
	
6
	local_static_var = static_function(local_static_var_init, p);	
7
	return local_static_var;
8
}
9
10
int main(int argc, char** argv)
11
{
12
	static_var = 1;
13
14
	global_var = global_function(2);
15
	extern_var = extern_function(3);
16
	return 0;
17
}
18
19
#ifdef __cplusplus
20
extern "C"
21
#endif
22
void non_mangled_function(void)
23
{
24
	// I do nothing
25
}

3) private 函数:

1
$ gcc -c c_obj.c
2
$ nm c_obj.o | grep " t " | cut -d' ' -f3
3
static_function

4) public 函数:

1
$ gcc -c c_obj.c
2
$ nm c_obj.o | grep " T " | cut -d' ' -f3
3
global_function
4
main
5
non_mangled_function

5) 优点:

  • 可以看到整个文件的所有调试信息,不仅仅是函数列表;

  • 同时适用于C 和 C++;

  • 呈现的是编译后的结果,更加准确可靠,例如不用关心源码中宏定义是否打开。

6) 缺点:

  • 只能对编译后的目标文件进行查看;

  • 目标文件如果被 strip 后,则无法使用该方法。

  • 无法看到完整的函数定义;


3. 方法3: 开源软件 Ctags

1) 什么是 ctags?
Ctags 是一个用于从程序源代码树产生索引文件(或tag文件),从而便于文本编辑器来实现快速定位的实用工具。在产生的 tag 文件中,每一个 tag 的入口指向了一个编程语言的对象。这个对象可以是变量定义、函数、类或其他的物件

Ctags 支持下列的编程语言:
汇编,AWK, ASP, BETA, Bourne/Korn/Zsh Shell, C, C++, COBOL, Eiffel, Fortran, Java, Lisp, Lua, Make, Pascal, Perl, PHP, Python, REXX, Ruby, S-Lang, Scheme, Tcl, Vim, and YACC。

2) private 函数:

1
$ ctags -x SDL_events.c | grep function | tr -s ' ' | cut -d' ' -f5- | grep static | sort
2
3
static int SDL_AddEvent(SDL_Event *event)
4
static int SDLCALL SDL_GobbleEvents(void *unused)
5
static int SDL_CutEvent(int spot)
6
static int SDL_StartEventThread(Uint32 flags)
7
static void SDL_StopEventThread(void)

3) public 函数:

1
$ ctags -x SDL_events.c | grep function | tr -s ' ' | cut -d' ' -f5- | grep -v static | sort
2
3
int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action,
4
int SDL_PollEvent (SDL_Event *event)
5
...
6
int SDL_WaitEvent (SDL_Event *event)
7
SDL_EventFilter SDL_GetEventFilter(void)
8
...
9
void SDL_Lock_EventThread(void)
10
...
11
void SDL_Unlock_EventThread(void)

4) 优点:

  • 支持多语言;

  • 可以看到函数的完整定义;

  • Ctags 不是编译器也不是预处理器,它的解析能力是有限的;

5) 缺点:

  • 分2行定义的函数无法完整显示:
1
int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action,

6) 我有必要了解 ctags 的内部实现吗?

  • 并不十分清楚 Ctags 使用何种技术来解析内容,估计包括正则表达式、词法分析、语法分析。日后如果工作对上述知识点有需求的话,应该也是一个很不错的学习资料,暂时不深入学习,

4. 使用 list function 的方法简单分析 Linux Input 子系统

1) 先是发散思维,了解 Linux input 的整体框架:

linux-input-overview

1
ls -1X
2
3
// 目录
4
gameport
5
joystick
6
keyboard
7
misc
8
mouse
9
rmi4
10
serio
11
tablet
12
touchscreen
13
14
// 文件
15
apm-power.c
16
evbug.c
17
ff-core.c
18
ff-memless.c
19
input-compat.c
20
input-leds.c
21
input-mt.c
22
input-polldev.c
23
joydev.c
24
matrix-keymap.c
25
mousedev.c
26
sparse-keymap.c

2) 然后开始专注在自己关心的内容上,例如我想多了解一下 input core 的内容,那么我就去查看 input .c 结构:

public function:

1
$ ctags -x input.c | grep function | tr -s ' ' | sort -t' ' -k 3 -n | cut -d' ' -f5- | grep -v static
2
3
// input_dev 相关
4
struct input_dev *devm_input_allocate_device(struct device *dev)
5
int input_register_device(struct input_dev *dev)
6
struct input_dev *input_allocate_device(void)
7
void input_free_device(struct input_dev *dev)
8
void input_free_minor(unsigned int minor)
9
int input_open_device(struct input_handle *handle)
10
void input_release_device(struct input_handle *handle)
11
void input_unregister_device(struct input_dev *dev)
12
13
...
14
// input_handler 相关
15
bool input_match_device_id(const struct input_dev *dev,
16
int input_register_handle(struct input_handle *handle)
17
int input_register_handler(struct input_handler *handler)
18
void input_unregister_handle(struct input_handle *handle)
19
void input_unregister_handler(struct input_handler *handler)

private var:

1
$ ctags -x input.c | grep variable | tr -s ' ' | sort -t' ' -k 3 -n | cut -d' ' -f5- | grep static
2
3
static LIST_HEAD(input_dev_list);
4
static LIST_HEAD(input_handler_list);
5
...
6
static const struct seq_operations input_devices_seq_ops = {
7
static const struct file_operations input_devices_fileops = {
8
static const struct seq_operations input_handlers_seq_ops = {
9
static const struct file_operations input_handlers_fileops = {
10
11
static struct attribute *input_dev_attrs[] = {
12
static struct attribute_group input_dev_attr_group = {
13
static struct attribute *input_dev_id_attrs[] = {
14
static struct attribute_group input_dev_id_attr_group = {
15
static struct attribute *input_dev_caps_attrs[] = {
16
static struct attribute_group input_dev_caps_attr_group = {
17
static const struct attribute_group *input_dev_attr_groups[] = {
18
19
static const struct dev_pm_ops input_dev_pm_ops = {
20
static struct device_type input_dev_type = {

3) 剩下的就可以重点去阅读相关代码了,例如 input_allocate_device()


5. 相关参考


思考技术,也要思考人生

学习技术,更要学习如何生活

你和我各有一个苹果,如果我们交换苹果的话,我们还是只有一个苹果。但当你和我各有一个想法,我们交换想法的话,我们就都有两个想法了。

公众号

嵌入式系统 (Linux、RTOS、OpenWrt、Android) 和 开源软件 感兴趣,想和更多人互相交流学习,关注公众号:嵌入式Hacker,一起来学习吧。

关注 / 转发 / 打赏,都是对作者莫大的支持。觉得文章对你有价值的话,不妨点个 在看和点赞 哦。

ps:
欢迎加入我的微信群:先加我微信,我拉你进群,暗号(我最棒)。

祝工作顺利,家庭幸福,财源滚滚~

这是一篇有趣的文章吗?

欢迎关注我的其它发布渠道