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