Decoupling Architectural-specific Code (#35)
[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_log(const char* fmt, ...)
24 {
25     va_list args;
26     va_start(args, fmt);
27
28     kprintf_m("TRACE", fmt, args);
29
30     va_end(args);
31 }
32
33 void
34 trace_modksyms_init(struct boot_handoff* bhctx)
35 {
36     trace_ctx.ksym_table = __lunaix_ksymtable;
37 }
38
39 struct ksym_entry*
40 trace_sym_lookup(ptr_t addr)
41 {
42     unsigned long c = trace_ctx.ksym_table->ksym_count;
43     struct ksym_entry* ksent = trace_ctx.ksym_table->syms;
44
45     int i = c - 1, j = 0, m = 0;
46
47     if (addr > ksent[i].pc || addr < ksent[j].pc || !kernel_addr(addr)) {
48         return NULL;
49     }
50
51     while (i - j != 1) {
52         m = (i + j) / 2;
53         if (ksent[m].pc > addr) {
54             i = m;
55         } else if (ksent[m].pc < addr) {
56             j = m;
57         } else {
58             break;
59         }
60     }
61
62     struct ksym_entry* result = &ksent[MIN(i, j)];
63     if (result->pc > addr) {
64         return NULL;
65     }
66
67     return result;
68 }
69
70 static char*
71 ksym_getstr(struct ksym_entry* sym)
72 {
73     if (!sym) {
74         return "???";
75     }
76
77     return sym->label;
78 }
79
80 static inline bool valid_fp(ptr_t ptr) {
81     ptr_t start = ROUNDUP(current_thread->kstack - KSTACK_SIZE, MEM_PAGE);
82
83     return (start < ptr && ptr < current_thread->kstack) 
84            || arch_valid_fp(ptr);
85 }
86
87 int
88 trace_walkback(struct trace_record* tb_buffer,
89                ptr_t fp,
90                int limit,
91                ptr_t* last_fp)
92 {
93     ptr_t* frame = (ptr_t*)fp;
94     struct ksym_entry* current = NULL;
95     int i = 0;
96
97     while (valid_fp((ptr_t)frame) && i < limit) {
98         ptr_t pc = abi_get_retaddrat((ptr_t)frame);
99
100         current = trace_sym_lookup(pc);
101         tb_buffer[i] =
102           (struct trace_record){ .pc = pc,
103                                  .sym_pc = current ? current->pc : 0,
104                                  .symbol = ksym_getstr(current) };
105
106         frame = (ptr_t*)*frame;
107         i++;
108     }
109
110     if (!valid_fp((ptr_t)frame)) {
111         frame = NULL;
112     }
113
114     if (last_fp) {
115         *last_fp = (ptr_t)frame;
116     }
117
118     return i;
119 }
120
121 static inline void
122 trace_print_code_entry(ptr_t sym_pc, ptr_t inst_pc, char* sym)
123 {
124     if (sym_pc) {
125         trace_log("%s+%p", sym, inst_pc - sym_pc);
126     } else {
127         trace_log("%s [%p]", sym, sym_pc);
128     }
129 }
130
131 void
132 trace_printstack_of(ptr_t fp)
133 {
134     struct trace_record tbs[NB_TRACEBACK];
135
136     // Let's get our Stackwalker does his job ;)
137     int n = trace_walkback(tbs, fp, NB_TRACEBACK, &fp);
138
139     if (fp) {
140         trace_log("...<truncated>");
141     }
142
143     for (int i = 0; i < n; i++) {
144         struct trace_record* tb = &tbs[i];
145         trace_print_code_entry(tb->sym_pc, tb->pc, tb->symbol);
146     }
147 }
148
149 void
150 trace_printstack()
151 {
152     if (current_thread) {
153         trace_printstack_isr(current_thread->hstate);
154     }
155     else {
156         trace_printstack_of(abi_get_callframe());
157     }
158 }
159
160 static void
161 trace_printswctx(const struct hart_state* hstate, bool from_usr, bool to_usr)
162 {
163
164     struct ksym_entry* sym = trace_sym_lookup(hstate->execp->eip);
165
166     trace_log("^^^^^ --- %s", to_usr ? "user" : "kernel");
167     trace_print_transistion_short(hstate);
168     trace_log("vvvvv --- %s", from_usr ? "user" : "kernel");
169
170     ptr_t sym_pc = sym ? sym->pc : hart_pc(hstate);
171     trace_print_code_entry(sym_pc, hart_pc(hstate), ksym_getstr(sym));
172 }
173
174 void
175 trace_printstack_isr(const struct hart_state* hstate)
176 {
177     struct hart_state* p = hstate;
178     ptr_t fp = abi_get_callframe();
179     int prev_usrctx = 0;
180
181     trace_log("stack trace (pid=%d)\n", __current->pid);
182
183     trace_printstack_of(fp);
184
185     while (p) {
186         if (!prev_usrctx) {
187             if (!kernel_context(p)) {
188                 trace_printswctx(p, true, false);
189             } else {
190                 trace_printswctx(p, false, false);
191             }
192         } else {
193             trace_printswctx(p, false, true);
194         }
195
196         fp = hart_stack_frame(p);
197         if (!valid_fp(fp)) {
198             trace_log("??? invalid frame: %p", fp);
199             break;
200         }
201
202         trace_printstack_of(fp);
203
204         prev_usrctx = !kernel_context(p);
205
206         p = hart_parent_state(p);
207     }
208
209     trace_log("----- [trace end] -----\n");
210 }