a097d0eb7dc8df4371fdb96043ec91d43f3e96a5
[akaros.git] / kern / src / monitor.c
1 // Simple command-line kernel monitor useful for
2 // controlling the kernel and exploring the system interactively.
3
4 #ifdef __DEPUTY__
5 #pragma nodeputy
6 #endif
7
8 #include <arch/x86.h>
9 #include <arch/stab.h>
10 #include <arch/apic.h>
11 #include <arch/smp.h>
12 #include <arch/console.h>
13
14 #include <stdio.h>
15 #include <string.h>
16 #include <assert.h>
17 #include <monitor.h>
18 #include <trap.h>
19 #include <pmap.h>
20 #include <kdebug.h>
21 #include <testing.h>
22
23 #include <ros/memlayout.h>
24
25 #define CMDBUF_SIZE     80      // enough for one VGA text line
26
27 typedef struct command {
28         const char *NTS name;
29         const char *NTS desc;
30         // return -1 to force monitor to exit
31         int (*func)(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf);
32 } command_t;
33
34 static command_t commands[] = {
35         { "help", "Display this list of commands", mon_help },
36         { "kerninfo", "Display information about the kernel", mon_kerninfo },
37         { "backtrace", "Dump a backtrace", mon_backtrace },
38         { "reboot", "Take a ride to the South Bay", mon_reboot },
39         { "showmapping", "Shows VA->PA mappings between two virtual addresses (parameters)", mon_showmapping},
40         { "setmapperm", "Sets permissions on a VA->PA mapping", mon_setmapperm},
41         { "cpuinfo", "Prints CPU diagnostics", mon_cpuinfo},
42 };
43 #define NCOMMANDS (sizeof(commands)/sizeof(commands[0]))
44
45 /***** Implementations of basic kernel monitor commands *****/
46
47 int mon_help(int argc, char **argv, trapframe_t *tf)
48 {
49         int i;
50
51         for (i = 0; i < NCOMMANDS; i++)
52                 cprintf("%s - %s\n", commands[i].name, commands[i].desc);
53         return 0;
54 }
55
56 int mon_kerninfo(int argc, char **argv, trapframe_t *tf)
57 {
58         extern char (SNT _start)[], (SNT etext)[], (SNT edata)[], (SNT end)[];
59
60         cprintf("Special kernel symbols:\n");
61         cprintf("  _start %08x (virt)  %08x (phys)\n", _start, (uint32_t)(_start - KERNBASE));
62         cprintf("  etext  %08x (virt)  %08x (phys)\n", etext, (uint32_t)(etext - KERNBASE));
63         cprintf("  edata  %08x (virt)  %08x (phys)\n", edata, (uint32_t)(edata - KERNBASE));
64         cprintf("  end    %08x (virt)  %08x (phys)\n", end, (uint32_t)(end - KERNBASE));
65         cprintf("Kernel executable memory footprint: %dKB\n",
66                 (uint32_t)(end-_start+1023)/1024);
67         return 0;
68 }
69
70 static char* function_of(uint32_t address) 
71 {
72         extern stab_t stab[], estab[];
73         extern char stabstr[];
74         stab_t* symtab;
75         stab_t* best_symtab = 0;
76         uint32_t best_func = 0;
77         
78         // ugly and unsorted
79         for (symtab = stab; symtab < estab; symtab++) {
80                 // only consider functions, type = N_FUN
81                 if ((symtab->n_type == N_FUN) && 
82                     (symtab->n_value <= address) && 
83                         (symtab->n_value > best_func)) {
84                         best_func = symtab->n_value;
85                         best_symtab = symtab;
86                 }
87         }
88         // maybe the first stab really is the right one...  we'll see.
89         if (best_symtab == 0)
90                 return "Function not found!";
91         return stabstr + best_symtab->n_strx;
92 }
93
94 int mon_backtrace(int argc, char **argv, trapframe_t *tf)
95 {
96         uint32_t* ebp, eip;
97         eipdebuginfo_t debuginfo;
98         char buf[256];
99         int j, i = 1;
100         ebp = (uint32_t*)read_ebp();    
101         // this is part of the way back into the call() instruction's bytes
102         // eagle-eyed readers should be able to explain why this is good enough,
103         // and retaddr (just *(ebp + 1) is not)
104         eip = *(ebp + 1) - 1;
105         // jump back a frame (out of mon_backtrace)
106         ebp = (uint32_t*)(*ebp);
107         cprintf("Stack Backtrace:\n");
108         // on each iteration, ebp holds the stack frame and eip an addr in that func
109         while (ebp != 0) {
110                 debuginfo_eip(eip, &debuginfo);
111                 memset(buf, 0, 256);
112                 strncpy(buf, debuginfo.eip_fn_name, MIN(debuginfo.eip_fn_namelen, 256));
113                 buf[MIN(debuginfo.eip_fn_namelen, 255)] = 0;
114                 cprintf("#%02d [<%x>] in %s+%x(%p) from %s:%d\n", i++,  eip, buf, 
115                         debuginfo.eip_fn_addr - (uint32_t)_start, debuginfo.eip_fn_addr, 
116                         debuginfo.eip_file, debuginfo.eip_line);
117                 cprintf("    ebp: %x   Args:", ebp);
118                 for (j = 0; j < MIN(debuginfo.eip_fn_narg, 5); j++)
119                         cprintf(" %08x", *(ebp + 2 + j));
120                 cprintf("\n");
121                 eip = *(ebp + 1) - 1;
122                 ebp = (uint32_t*)(*ebp);
123         }
124         return 0;
125 }
126
127 int mon_reboot(int argc, char **argv, trapframe_t *tf)
128 {
129         cprintf("[Irish Accent]: She's goin' down, Cap'n!\n");
130         outb(0x92, 0x3);
131         // KVM doesn't reboot yet, but this next bit will make it
132         // if you're in kernel mode and you can't do a push, when an interrupt
133         // comes in, the system just resets.  if esp = 0, there's no room left.
134         // somewhat curious about what happens in an SMP....
135         cprintf("[Irish Accent]: I'm givin' you all she's got!\n");
136         asm volatile ("movl $0, %esp; int $0");
137         // really, should never see this
138         cprintf("Sigh....\n");
139         return 0;
140 }
141
142 int mon_showmapping(int argc, char **argv, trapframe_t *tf)
143 {
144         if (argc < 2) {
145                 cprintf("Shows virtual -> physical mappings for a virtual address range.\n");
146                 cprintf("Usage: showmappings START_ADDR [END_ADDR]\n");
147                 return 1;
148         }
149         pde_t* pgdir = (pde_t*)vpd;
150         pte_t *pte, *pde;
151         page_t* page;
152         uintptr_t start, i;
153         size_t size;
154         start = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
155         size = (argc == 2) ? 1 : strtol(argv[2], 0, 16) - start;
156         if (size/PGSIZE > 512) {
157                 cprintf("Not going to do this for more than 512 items\n");
158                 return 1;
159         }
160         cprintf("   Virtual    Physical  Ps Dr Ac CD WT U W\n");
161         cprintf("------------------------------------------\n");
162         for(i = 0; i < size; i += PGSIZE, start += PGSIZE) {
163                 page = page_lookup(pgdir, (void*)start, &pte);
164                 cprintf("%08p  ", start);
165                 if (page) {
166                         pde = &pgdir[PDX(start)];
167                         // for a jumbo, pde = pte and PTE_PS (better be) = 1
168                         cprintf("%08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", page2pa(page), 
169                                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5,
170                                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, 
171                                (*pte & *pde & PTE_U) >> 2, (*pte & *pde & PTE_W) >> 1);
172                 } else
173                         cprintf("%08p\n", 0);
174         }
175         return 0;
176 }
177
178 int mon_setmapperm(int argc, char **argv, trapframe_t *tf)
179 {
180         if (argc < 3) {
181                 cprintf("Sets VIRT_ADDR's mapping's permissions to PERMS (in hex)\n");
182                 cprintf("Only affects the lowest level PTE.  To adjust the PDE, do the math.\n");
183                 cprintf("Be careful with this around UVPT, VPT, and friends.\n");
184                 cprintf("Usage: setmapperm VIRT_ADDR PERMS\n");
185                 return 1;
186         }
187         pde_t* pgdir = (pde_t*)vpd;
188         pte_t *pte, *pde;
189         page_t* page;
190         uintptr_t va;
191         va = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
192         page = page_lookup(pgdir, (void*)va, &pte);
193         if (!page) {
194                 cprintf("No such mapping\n");
195                 return 1;
196         }
197         pde = &pgdir[PDX(va)];
198         cprintf("   Virtual    Physical  Ps Dr Ac CD WT U W\n");
199         cprintf("------------------------------------------\n");
200         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page), 
201                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5, 
202                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2, 
203                (*pte & *pde & PTE_W) >> 1);
204         *pte = PTE_ADDR(*pte) | (*pte & PTE_PS) |
205                (PGOFF(strtol(argv[2], 0, 16)) & ~PTE_PS ) | PTE_P;
206         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page), 
207                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5, 
208                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2, 
209                (*pte & *pde & PTE_W) >> 1);
210         return 0;
211 }
212
213 int mon_cpuinfo(int argc, char **argv, trapframe_t *tf)
214 {
215         extern uint8_t num_cpus;
216
217         cprintf("Number of CPUs detected: %d\n", num_cpus);     
218         cprintf("Calling CPU's LAPIC ID: 0x%08x\n", lapic_get_id());
219         if (argc < 2)
220                 smp_call_function_self(test_print_info_handler, 0, 0);
221         else
222                 smp_call_function_single(strtol(argv[1], 0, 16),
223                                          test_print_info_handler, 0, 0);
224         return 0;
225 }
226
227 /***** Kernel monitor command interpreter *****/
228
229 #define WHITESPACE "\t\r\n "
230 #define MAXARGS 16
231
232 static int runcmd(char *COUNT(CMDBUF_SIZE) real_buf, trapframe_t *tf) {
233         char *BND(real_buf, real_buf+CMDBUF_SIZE) buf = real_buf;
234         int argc;
235         char *NTS argv[MAXARGS];
236         int i;
237
238         // Parse the command buffer into whitespace-separated arguments
239         argc = 0;
240         argv[argc] = 0;
241         while (1) {
242                 // gobble whitespace
243                 while (*buf && strchr(WHITESPACE, *buf))
244                         *buf++ = 0;
245                 if (*buf == 0)
246                         break;
247
248                 // save and scan past next arg
249                 if (argc == MAXARGS-1) {
250                         cprintf("Too many arguments (max %d)\n", MAXARGS);
251                         return 0;
252                 }
253                 //This will get fucked at runtime..... in the ASS
254                 argv[argc++] = (char *NTS) TC(buf);
255                 while (*buf && !strchr(WHITESPACE, *buf))
256                         buf++;
257         }
258         argv[argc] = 0;
259
260         // Lookup and invoke the command
261         if (argc == 0)
262                 return 0;
263         for (i = 0; i < NCOMMANDS; i++) {
264                 if (strcmp(argv[0], commands[i].name) == 0)
265                         return commands[i].func(argc, argv, tf);
266         }
267         cprintf("Unknown command '%s'\n", argv[0]);
268         return 0;
269 }
270
271 void monitor(trapframe_t *tf) {
272         char *buf;
273
274         cprintf("Welcome to the ROS kernel monitor!\n");
275         cprintf("Type 'help' for a list of commands.\n");
276
277         if (tf != NULL)
278                 print_trapframe(tf);
279
280         while (1) {
281                 buf = readline("K> ");
282                 if (buf != NULL)
283                         if (runcmd(buf, tf) < 0)
284                                 break;
285         }
286 }