xref: /DragonOS/kernel/src/debug/kallsyms.c (revision 78bf93f02f84bf5e024ddfb559f040e68ce39ccf)
1 /**
2  * @file kallsyms.c
3  * @author longjin (longjin@RinGoTek.cn)
4  * @brief 内核栈跟踪
5  * @version 0.1
6  * @date 2022-06-22
7  *
8  * @copyright Copyright (c) 2022
9  *
10  */
11 #include <stdint.h>
12 #include <stdio.h>
13 #include <stdlib.h>
14 #include <string.h>
15 
16 /**
17  * @brief 判断符号是否需要被输出(只输出text段内的符号)
18  *
19  */
20 #define symbol_to_write(vaddr, tv, etv) \
21     ((vaddr < tv || vaddr > etv) ? 0 : 1)
22 
23 /**
24  * @brief 使用nm命令提取出来的信息存到这个结构体之中
25  *
26  */
27 struct kernel_symbol_entry_t
28 {
29     uint64_t vaddr;
30     char type;
31     char *symbol;
32     int symbol_length;
33 };
34 
35 struct kernel_symbol_entry_t *symbol_table;
36 // 符号表最大能容纳的entry数量
37 uint64_t table_size = 0;
38 // 符号表当前的entry数量
39 uint64_t entry_count = 0;
40 // 符号表中,text和etext的下标
41 uint64_t text_vaddr, etext_vaddr;
42 
43 /**
44  * @brief 读取一个符号到entry之中
45  *
46  * @param filp stdin的文件指针
47  * @param entry 待填写的entry
48  * @return int 返回码
49  */
50 int read_symbol(FILE *filp, struct kernel_symbol_entry_t *entry)
51 {
52     // 本函数假设nm命令输出的结果中,每行最大512字节
53     char str[512] = {0};
54     int retval = fscanf(filp, "%llx %c %510s\n", &entry->vaddr, &entry->type, str);
55 
56     // 如果当前行不符合要求
57     if (retval != 3)
58     {
59         if (retval != EOF)
60         {
61             // 如果不是输入流的结尾,说明该行不符合要求,将其过滤
62             fgets(str, 512, filp);
63         }
64 
65         return -1;
66     }
67     // malloc一块内存,然后把str的内容拷贝进去,接着修改symbol指针
68     entry->symbol = strdup(str);
69     entry->symbol_length = strlen(str) + 1; // +1的原因是.asciz指令会在字符串末尾自动添加结束符\0
70     return 0;
71 }
72 
73 /**
74  * @brief 接收标准输入流的数据,解析nm命令输出的内容
75  *
76  * @param filp
77  */
78 void read_map(FILE *filp)
79 {
80     // 循环读入数据直到输入流结束
81     while (!feof(filp))
82     {
83         // 给符号表扩容
84         if (entry_count >= table_size)
85         {
86             table_size += 100;
87             // 由于使用了realloc,因此符号表原有的内容会被自动的copy过去
88             symbol_table = (struct kernel_symbol_entry_t *)realloc(symbol_table, sizeof(struct kernel_symbol_entry_t) * table_size);
89         }
90 
91         // 若成功读取符号表的内容,则将计数器+1
92         if (read_symbol(filp, &symbol_table[entry_count]) == 0)
93             ++entry_count;
94     }
95 
96     // 查找符号表中的text和etext标签
97     for (uint64_t i = 0; i < entry_count; ++i)
98     {
99         if (strcmp(symbol_table[i].symbol, "_text")==0)
100             text_vaddr = symbol_table[i].vaddr;
101         if (strcmp(symbol_table[i].symbol, "_etext")==0)
102             etext_vaddr = symbol_table[i].vaddr;
103     }
104 }
105 
106 /**
107  * @brief 输出最终的kallsyms汇编代码文件
108  * 直接输出到stdout,通过命令行的 > 命令,写入文件
109  */
110 void generate_result()
111 {
112     printf(".section .rodata\n\n");
113     printf(".global kallsyms_address\n");
114     printf(".align 8\n\n");
115 
116     printf("kallsyms_address:\n"); // 地址数组
117 
118     uint64_t last_vaddr = 0;
119     uint64_t total_syms_to_write = 0; // 真正输出的符号的数量
120 
121     // 循环写入地址数组
122     for (uint64_t i = 0; i < entry_count; ++i)
123     {
124         // 判断是否为text段的符号
125         if (!symbol_to_write(symbol_table[i].vaddr, text_vaddr, etext_vaddr))
126             continue;
127 
128         if (symbol_table[i].vaddr == last_vaddr)
129             continue;
130 
131         // 输出符号地址
132         printf("\t.quad\t%#llx\n", symbol_table[i].vaddr);
133         ++total_syms_to_write;
134 
135         last_vaddr = symbol_table[i].vaddr;
136     }
137 
138     putchar('\n');
139 
140     // 写入符号表的表项数量
141     printf(".global kallsyms_num\n");
142     printf(".align 8\n");
143     printf("kallsyms_num:\n");
144     printf("\t.quad\t%lld\n", total_syms_to_write);
145 
146     putchar('\n');
147 
148     // 循环写入符号名称的下标索引
149     printf(".global kallsyms_names_index\n");
150     printf(".align 8\n");
151     printf("kallsyms_names_index:\n");
152     uint64_t position = 0;
153     last_vaddr = 0;
154     for (uint64_t i = 0; i < entry_count; ++i)
155     {
156         // 判断是否为text段的符号
157         if (!symbol_to_write(symbol_table[i].vaddr, text_vaddr, etext_vaddr))
158             continue;
159 
160         if (symbol_table[i].vaddr == last_vaddr)
161             continue;
162 
163         // 输出符号名称的偏移量
164         printf("\t.quad\t%lld\n", position);
165         position += symbol_table[i].symbol_length;
166         last_vaddr = symbol_table[i].vaddr;
167     }
168 
169     putchar('\n');
170 
171     // 输出符号名
172     printf(".global kallsyms_names\n");
173     printf(".align 8\n");
174     printf("kallsyms_names:\n");
175 
176     last_vaddr = 0;
177     for (uint64_t i = 0; i < entry_count; ++i)
178     {
179         // 判断是否为text段的符号
180         if (!symbol_to_write(symbol_table[i].vaddr, text_vaddr, etext_vaddr))
181             continue;
182 
183         if (symbol_table[i].vaddr == last_vaddr)
184             continue;
185 
186         // 输出符号名称
187         printf("\t.asciz\t\"%s\"\n", symbol_table[i].symbol);
188 
189         last_vaddr = symbol_table[i].vaddr;
190     }
191 
192     putchar('\n');
193 
194 }
195 int main(int argc, char **argv)
196 {
197     read_map(stdin);
198 
199     generate_result();
200 }