* Make the ksym table built-in with kernel image, thus remove the need
[lunaix-os.git] / lunaix-os / kernel / debug / trace.c
1 #include <lunaix/mm/page.h>
2 #include <lunaix/process.h>
3 #include <lunaix/spike.h>
4 #include <lunaix/syslog.h>
5 #include <lunaix/trace.h>
6
7 #include <sys/abi.h>
8 #include <sys/mm/mm_defs.h>
9 #include <sys/trace.h>
10
11 #include <klibc/string.h>
12
13 #define NB_TRACEBACK 16
14
15 LOG_MODULE("TRACE")
16
17 weak struct ksyms __lunaix_ksymtable[] = { };
18 extern struct ksyms __lunaix_ksymtable[];
19
20 static struct trace_context trace_ctx;
21
22 void
23 trace_modksyms_init(struct boot_handoff* bhctx)
24 {
25     trace_ctx.ksym_table = __lunaix_ksymtable;
26 }
27
28 struct ksym_entry*
29 trace_sym_lookup(ptr_t addr)
30 {
31     unsigned long c = trace_ctx.ksym_table->ksym_count;
32     struct ksym_entry* ksent = trace_ctx.ksym_table->syms;
33
34     int i = c - 1, j = 0, m = 0;
35
36     if (addr > ksent[i].pc || addr < ksent[j].pc || !kernel_addr(addr)) {
37         return NULL;
38     }
39
40     while (i - j != 1) {
41         m = (i + j) / 2;
42         if (ksent[m].pc > addr) {
43             i = m;
44         } else if (ksent[m].pc < addr) {
45             j = m;
46         } else {
47             break;
48         }
49     }
50
51     struct ksym_entry* result = &ksent[MIN(i, j)];
52     if (result->pc > addr) {
53         return NULL;
54     }
55
56     return result;
57 }
58
59 static char*
60 ksym_getstr(struct ksym_entry* sym)
61 {
62     if (!sym) {
63         return "???";
64     }
65
66     return sym->label;
67 }
68
69 static inline bool valid_fp(ptr_t ptr) {
70     ptr_t start = ROUNDUP(current_thread->kstack - KSTACK_SIZE, MEM_PAGE);
71
72     return (start < ptr && ptr < current_thread->kstack) 
73            || arch_valid_fp(ptr);
74 }
75
76 int
77 trace_walkback(struct trace_record* tb_buffer,
78                ptr_t fp,
79                int limit,
80                ptr_t* last_fp)
81 {
82     ptr_t* frame = (ptr_t*)fp;
83     struct ksym_entry* current = NULL;
84     int i = 0;
85
86     while (valid_fp((ptr_t)frame) && i < limit) {
87         ptr_t pc = abi_get_retaddrat((ptr_t)frame);
88
89         current = trace_sym_lookup(pc);
90         tb_buffer[i] =
91           (struct trace_record){ .pc = pc,
92                                  .sym_pc = current ? current->pc : 0,
93                                  .symbol = ksym_getstr(current) };
94
95         frame = (ptr_t*)*frame;
96         i++;
97     }
98
99     if (!valid_fp((ptr_t)frame)) {
100         frame = NULL;
101     }
102
103     if (last_fp) {
104         *last_fp = (ptr_t)frame;
105     }
106
107     return i;
108 }
109
110 static inline void
111 trace_print_code_entry(ptr_t sym_pc, ptr_t inst_pc, char* sym)
112 {
113     if (sym_pc) {
114         DEBUG("%s+%p", sym, inst_pc - sym_pc);
115     } else {
116         DEBUG("%s [%p]", sym, sym_pc);
117     }
118 }
119
120 void
121 trace_printstack_of(ptr_t fp)
122 {
123     struct trace_record tbs[NB_TRACEBACK];
124
125     // Let's get our Stackwalker does his job ;)
126     int n = trace_walkback(tbs, fp, NB_TRACEBACK, &fp);
127
128     if (fp) {
129         DEBUG("...<truncated>");
130     }
131
132     for (int i = 0; i < n; i++) {
133         struct trace_record* tb = &tbs[i];
134         trace_print_code_entry(tb->sym_pc, tb->pc, tb->symbol);
135     }
136 }
137
138 void
139 trace_printstack()
140 {
141     if (current_thread) {
142         trace_printstack_isr(current_thread->intr_ctx);
143     }
144     else {
145         trace_printstack_of(abi_get_callframe());
146     }
147 }
148
149 static void
150 trace_printswctx(const isr_param* p, bool from_usr, bool to_usr)
151 {
152
153     struct ksym_entry* sym = trace_sym_lookup(p->execp->eip);
154
155     DEBUG("^^^^^ --- %s", to_usr ? "user" : "kernel");
156     DEBUG("  interrupted on #%d, ecode=%p",
157           p->execp->vector,
158           p->execp->err_code);
159     DEBUG("vvvvv --- %s", from_usr ? "user" : "kernel");
160
161     ptr_t sym_pc = sym ? sym->pc : p->execp->eip;
162     trace_print_code_entry(sym_pc, p->execp->eip, ksym_getstr(sym));
163 }
164
165 void
166 trace_printstack_isr(const isr_param* isrm)
167 {
168     isr_param* p = isrm;
169     ptr_t fp = abi_get_callframe();
170     int prev_usrctx = 0;
171
172     DEBUG("stack trace (pid=%d)\n", __current->pid);
173
174     trace_printstack_of(fp);
175
176     while (p) {
177         if (!prev_usrctx) {
178             if (!kernel_context(p)) {
179                 trace_printswctx(p, true, false);
180             } else {
181                 trace_printswctx(p, false, false);
182             }
183         } else {
184             trace_printswctx(p, false, true);
185         }
186
187         fp = saved_fp(p);
188         if (!valid_fp(fp)) {
189             DEBUG("??? invalid frame: %p", fp);
190             break;
191         }
192
193         trace_printstack_of(fp);
194
195         prev_usrctx = !kernel_context(p);
196
197         p = p->execp->saved_prev_ctx;
198     }
199
200     DEBUG("----- [trace end] -----\n");
201 }