minor changes, disregard
[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         { "nanwan", "Meet Nanwan!!", mon_nanwan},
43 };
44 #define NCOMMANDS (sizeof(commands)/sizeof(commands[0]))
45
46 /***** Implementations of basic kernel monitor commands *****/
47
48 int mon_help(int argc, char **argv, trapframe_t *tf)
49 {
50         int i;
51
52         for (i = 0; i < NCOMMANDS; i++)
53                 cprintf("%s - %s\n", commands[i].name, commands[i].desc);
54         return 0;
55 }
56
57 int mon_kerninfo(int argc, char **argv, trapframe_t *tf)
58 {
59         extern char (SNT _start)[], (SNT etext)[], (SNT edata)[], (SNT end)[];
60
61         cprintf("Special kernel symbols:\n");
62         cprintf("  _start %08x (virt)  %08x (phys)\n", _start, (uint32_t)(_start - KERNBASE));
63         cprintf("  etext  %08x (virt)  %08x (phys)\n", etext, (uint32_t)(etext - KERNBASE));
64         cprintf("  edata  %08x (virt)  %08x (phys)\n", edata, (uint32_t)(edata - KERNBASE));
65         cprintf("  end    %08x (virt)  %08x (phys)\n", end, (uint32_t)(end - KERNBASE));
66         cprintf("Kernel executable memory footprint: %dKB\n",
67                 (uint32_t)(end-_start+1023)/1024);
68         return 0;
69 }
70
71 static char* function_of(uint32_t address) 
72 {
73         extern stab_t stab[], estab[];
74         extern char stabstr[];
75         stab_t* symtab;
76         stab_t* best_symtab = 0;
77         uint32_t best_func = 0;
78         
79         // ugly and unsorted
80         for (symtab = stab; symtab < estab; symtab++) {
81                 // only consider functions, type = N_FUN
82                 if ((symtab->n_type == N_FUN) && 
83                     (symtab->n_value <= address) && 
84                         (symtab->n_value > best_func)) {
85                         best_func = symtab->n_value;
86                         best_symtab = symtab;
87                 }
88         }
89         // maybe the first stab really is the right one...  we'll see.
90         if (best_symtab == 0)
91                 return "Function not found!";
92         return stabstr + best_symtab->n_strx;
93 }
94
95 int mon_backtrace(int argc, char **argv, trapframe_t *tf)
96 {
97         uint32_t* ebp, eip;
98         eipdebuginfo_t debuginfo;
99         char buf[256];
100         int j, i = 1;
101         ebp = (uint32_t*)read_ebp();    
102         // this is part of the way back into the call() instruction's bytes
103         // eagle-eyed readers should be able to explain why this is good enough,
104         // and retaddr (just *(ebp + 1) is not)
105         eip = *(ebp + 1) - 1;
106         // jump back a frame (out of mon_backtrace)
107         ebp = (uint32_t*)(*ebp);
108         cprintf("Stack Backtrace:\n");
109         // on each iteration, ebp holds the stack frame and eip an addr in that func
110         while (ebp != 0) {
111                 debuginfo_eip(eip, &debuginfo);
112                 memset(buf, 0, 256);
113                 strncpy(buf, debuginfo.eip_fn_name, MIN(debuginfo.eip_fn_namelen, 256));
114                 buf[MIN(debuginfo.eip_fn_namelen, 255)] = 0;
115                 cprintf("#%02d [<%x>] in %s+%x(%p) from %s:%d\n", i++,  eip, buf, 
116                         debuginfo.eip_fn_addr - (uint32_t)_start, debuginfo.eip_fn_addr, 
117                         debuginfo.eip_file, debuginfo.eip_line);
118                 cprintf("    ebp: %x   Args:", ebp);
119                 for (j = 0; j < MIN(debuginfo.eip_fn_narg, 5); j++)
120                         cprintf(" %08x", *(ebp + 2 + j));
121                 cprintf("\n");
122                 eip = *(ebp + 1) - 1;
123                 ebp = (uint32_t*)(*ebp);
124         }
125         return 0;
126 }
127
128 int mon_reboot(int argc, char **argv, trapframe_t *tf)
129 {
130         cprintf("[Irish Accent]: She's goin' down, Cap'n!\n");
131         outb(0x92, 0x3);
132         // KVM doesn't reboot yet, but this next bit will make it
133         // if you're in kernel mode and you can't do a push, when an interrupt
134         // comes in, the system just resets.  if esp = 0, there's no room left.
135         // somewhat curious about what happens in an SMP....
136         cprintf("[Irish Accent]: I'm givin' you all she's got!\n");
137         asm volatile ("movl $0, %esp; int $0");
138         // really, should never see this
139         cprintf("Sigh....\n");
140         return 0;
141 }
142
143 int mon_showmapping(int argc, char **argv, trapframe_t *tf)
144 {
145         if (argc < 2) {
146                 cprintf("Shows virtual -> physical mappings for a virtual address range.\n");
147                 cprintf("Usage: showmappings START_ADDR [END_ADDR]\n");
148                 return 1;
149         }
150         pde_t* pgdir = (pde_t*)vpd;
151         pte_t *pte, *pde;
152         page_t* page;
153         uintptr_t start, i;
154         size_t size;
155         start = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
156         size = (argc == 2) ? 1 : strtol(argv[2], 0, 16) - start;
157         if (size/PGSIZE > 512) {
158                 cprintf("Not going to do this for more than 512 items\n");
159                 return 1;
160         }
161         cprintf("   Virtual    Physical  Ps Dr Ac CD WT U W\n");
162         cprintf("------------------------------------------\n");
163         for(i = 0; i < size; i += PGSIZE, start += PGSIZE) {
164                 page = page_lookup(pgdir, (void*)start, &pte);
165                 cprintf("%08p  ", start);
166                 if (page) {
167                         pde = &pgdir[PDX(start)];
168                         // for a jumbo, pde = pte and PTE_PS (better be) = 1
169                         cprintf("%08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", page2pa(page), 
170                                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5,
171                                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, 
172                                (*pte & *pde & PTE_U) >> 2, (*pte & *pde & PTE_W) >> 1);
173                 } else
174                         cprintf("%08p\n", 0);
175         }
176         return 0;
177 }
178
179 int mon_setmapperm(int argc, char **argv, trapframe_t *tf)
180 {
181         if (argc < 3) {
182                 cprintf("Sets VIRT_ADDR's mapping's permissions to PERMS (in hex)\n");
183                 cprintf("Only affects the lowest level PTE.  To adjust the PDE, do the math.\n");
184                 cprintf("Be careful with this around UVPT, VPT, and friends.\n");
185                 cprintf("Usage: setmapperm VIRT_ADDR PERMS\n");
186                 return 1;
187         }
188         pde_t* pgdir = (pde_t*)vpd;
189         pte_t *pte, *pde;
190         page_t* page;
191         uintptr_t va;
192         va = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
193         page = page_lookup(pgdir, (void*)va, &pte);
194         if (!page) {
195                 cprintf("No such mapping\n");
196                 return 1;
197         }
198         pde = &pgdir[PDX(va)];
199         cprintf("   Virtual    Physical  Ps Dr Ac CD WT U W\n");
200         cprintf("------------------------------------------\n");
201         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page), 
202                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5, 
203                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2, 
204                (*pte & *pde & PTE_W) >> 1);
205         *pte = PTE_ADDR(*pte) | (*pte & PTE_PS) |
206                (PGOFF(strtol(argv[2], 0, 16)) & ~PTE_PS ) | PTE_P;
207         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page), 
208                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5, 
209                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2, 
210                (*pte & *pde & PTE_W) >> 1);
211         return 0;
212 }
213
214 int mon_cpuinfo(int argc, char **argv, trapframe_t *tf)
215 {
216         extern uint8_t num_cpus;
217
218         cprintf("Number of CPUs detected: %d\n", num_cpus);     
219         cprintf("Calling CPU's LAPIC ID: 0x%08x\n", lapic_get_id());
220         if (argc < 2)
221                 smp_call_function_self(test_print_info_handler, 0, 0);
222         else
223                 smp_call_function_single(strtol(argv[1], 0, 16),
224                                          test_print_info_handler, 0, 0);
225         return 0;
226 }
227
228 int mon_nanwan(int argc, char **argv, trapframe_t *tf)
229 {
230         /* Borrowed with love from http://www.geocities.com/SoHo/7373/zoo.htm
231          * (http://www.ascii-art.com/).  Slightly modified to make it 25 lines tall.
232          */
233         printk("\n");
234         printk("             .-.  .-.\n");
235         printk("             |  \\/  |\n");
236         printk("            /,   ,_  `'-.\n");
237         printk("          .-|\\   /`\\     '. \n");
238         printk("        .'  0/   | 0\\  \\_  `\".  \n");
239         printk("     .-'  _,/    '--'.'|#''---'\n");
240         printk("      `--'  |       /   \\#\n");
241         printk("            |      /     \\#\n");
242         printk("            \\     ;|\\    .\\#\n");
243         printk("            |' ' //  \\   ::\\# \n");
244         printk("            \\   /`    \\   ':\\#\n");
245         printk("             `\"`       \\..   \\#\n");
246         printk("                        \\::.  \\#\n");
247         printk("                         \\::   \\#\n");
248         printk("                          \\'  .:\\#\n");
249         printk("                           \\  :::\\#\n");
250         printk("                            \\  '::\\#\n");
251         printk("                             \\     \\#\n");
252         printk("                              \\:.   \\#\n");
253         printk("                               \\::   \\#\n");
254         printk("                                \\'   .\\#\n");
255         printk("                             jgs \\   ::\\#\n");
256         printk("                                  \\      \n");
257         return 0;
258 }
259
260 /***** Kernel monitor command interpreter *****/
261
262 #define WHITESPACE "\t\r\n "
263 #define MAXARGS 16
264
265 static int runcmd(char *COUNT(CMDBUF_SIZE) real_buf, trapframe_t *tf) {
266         char *BND(real_buf, real_buf+CMDBUF_SIZE) buf = real_buf;
267         int argc;
268         char *NTS argv[MAXARGS];
269         int i;
270
271         // Parse the command buffer into whitespace-separated arguments
272         argc = 0;
273         argv[argc] = 0;
274         while (1) {
275                 // gobble whitespace
276                 while (*buf && strchr(WHITESPACE, *buf))
277                         *buf++ = 0;
278                 if (*buf == 0)
279                         break;
280
281                 // save and scan past next arg
282                 if (argc == MAXARGS-1) {
283                         cprintf("Too many arguments (max %d)\n", MAXARGS);
284                         return 0;
285                 }
286                 //This will get fucked at runtime..... in the ASS
287                 argv[argc++] = (char *NTS) TC(buf);
288                 while (*buf && !strchr(WHITESPACE, *buf))
289                         buf++;
290         }
291         argv[argc] = 0;
292
293         // Lookup and invoke the command
294         if (argc == 0)
295                 return 0;
296         for (i = 0; i < NCOMMANDS; i++) {
297                 if (strcmp(argv[0], commands[i].name) == 0)
298                         return commands[i].func(argc, argv, tf);
299         }
300         cprintf("Unknown command '%s'\n", argv[0]);
301         return 0;
302 }
303
304 void monitor(trapframe_t *tf) {
305         char *buf;
306
307         cprintf("Welcome to the ROS kernel monitor!\n");
308         cprintf("Type 'help' for a list of commands.\n");
309
310         if (tf != NULL)
311                 print_trapframe(tf);
312
313         while (1) {
314                 buf = readline("K> ");
315                 if (buf != NULL)
316                         if (runcmd(buf, tf) < 0)
317                                 break;
318         }
319 }