More verbose multicore debugging
[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 __SHARC__
5 #pragma nosharc
6 #endif
7
8 #include <arch/arch.h>
9 #include <stab.h>
10 #include <smp.h>
11 #include <arch/console.h>
12
13 #include <stdio.h>
14 #include <string.h>
15 #include <assert.h>
16 #include <monitor.h>
17 #include <trap.h>
18 #include <pmap.h>
19 #include <kdebug.h>
20 #include <testing.h>
21 #include <kfs.h>
22 #include <manager.h>
23 #include <schedule.h>
24 #include <resource.h>
25
26 #include <ros/memlayout.h>
27
28 #define CMDBUF_SIZE     80      // enough for one VGA text line
29
30 typedef struct command {
31         const char *NTS name;
32         const char *NTS desc;
33         // return -1 to force monitor to exit
34         int (*func)(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf);
35 } command_t;
36
37 static command_t (RO commands)[] = {
38         { "help", "Display this list of commands", mon_help },
39         { "kerninfo", "Display information about the kernel", mon_kerninfo },
40         { "backtrace", "Dump a backtrace", mon_backtrace },
41         { "reboot", "Take a ride to the South Bay", mon_reboot },
42         { "showmapping", "Shows VA->PA mappings between two virtual addresses (parameters)", mon_showmapping},
43         { "setmapperm", "Sets permissions on a VA->PA mapping", mon_setmapperm},
44         { "cpuinfo", "Prints CPU diagnostics", mon_cpuinfo},
45         { "nanwan", "Meet Nanwan!!", mon_nanwan},
46         { "kfs_ls", "List files in KFS", mon_kfs_ls},
47         { "kfs_run", "Create and run a program from KFS", mon_kfs_run},
48         { "manager", "Run the manager", mon_manager},
49         { "procinfo", "Show information about processes", mon_procinfo},
50 };
51 #define NCOMMANDS (sizeof(commands)/sizeof(commands[0]))
52
53 /***** Implementations of basic kernel monitor commands *****/
54
55 int mon_help(int argc, char **argv, trapframe_t *tf)
56 {
57         int i;
58
59         for (i = 0; i < NCOMMANDS; i++)
60                 cprintf("%s - %s\n", commands[i].name, commands[i].desc);
61         return 0;
62 }
63
64 int mon_kerninfo(int argc, char **argv, trapframe_t *tf)
65 {
66         extern char (RO SNT _start)[], (RO SNT etext)[], (RO SNT edata)[], (RO SNT end)[];
67
68         cprintf("Special kernel symbols:\n");
69         cprintf("  _start %08x (virt)  %08x (phys)\n", _start, (uint32_t)(_start - KERNBASE));
70         cprintf("  etext  %08x (virt)  %08x (phys)\n", etext, (uint32_t)(etext - KERNBASE));
71         cprintf("  edata  %08x (virt)  %08x (phys)\n", edata, (uint32_t)(edata - KERNBASE));
72         cprintf("  end    %08x (virt)  %08x (phys)\n", end, (uint32_t)(end - KERNBASE));
73         cprintf("Kernel executable memory footprint: %dKB\n",
74                 (uint32_t)(end-_start+1023)/1024);
75         return 0;
76 }
77
78 #if 0
79 zra: not called
80 static char RO* function_of(uint32_t address)
81 {
82         extern stab_t (RO stab)[], (RO estab)[];
83         extern char (RO stabstr)[];
84         stab_t* symtab;
85         stab_t* best_symtab = 0;
86         uint32_t best_func = 0;
87
88         // ugly and unsorted
89         for (symtab = stab; symtab < estab; symtab++) {
90                 // only consider functions, type = N_FUN
91                 if ((symtab->n_type == N_FUN) &&
92                     (symtab->n_value <= address) &&
93                         (symtab->n_value > best_func)) {
94                         best_func = symtab->n_value;
95                         best_symtab = symtab;
96                 }
97         }
98         // maybe the first stab really is the right one...  we'll see.
99         if (best_symtab == 0)
100                 return "Function not found!";
101         return stabstr + best_symtab->n_strx;
102 }
103 #endif
104
105 int mon_backtrace(int argc, char **argv, trapframe_t *tf)
106 {
107         backtrace();
108         return 0;
109 }
110
111 int mon_reboot(int argc, char **argv, trapframe_t *tf)
112 {
113         cprintf("[Irish Accent]: She's goin' down, Cap'n!\n");
114         reboot();
115
116         // really, should never see this
117         cprintf("Sigh....\n");
118         return 0;
119 }
120
121 int mon_showmapping(int argc, char **argv, trapframe_t *tf)
122 {
123         if (argc < 2) {
124                 cprintf("Shows virtual -> physical mappings for a virtual address range.\n");
125                 cprintf("Usage: showmapping START_ADDR [END_ADDR]\n");
126                 return 1;
127         }
128         pde_t* pgdir = (pde_t*)vpd;
129         pte_t *pte, *pde;
130         page_t* page;
131         uintptr_t start, i;
132         size_t size;
133         start = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
134         size = (argc == 2) ? 1 : strtol(argv[2], 0, 16) - start;
135         if (size/PGSIZE > 512) {
136                 cprintf("Not going to do this for more than 512 items\n");
137                 return 1;
138         }
139
140         show_mapping(start,size);
141         return 0;
142 }
143
144 int mon_setmapperm(int argc, char **argv, trapframe_t *tf)
145 {
146 #ifndef __i386__
147         cprintf("I don't support this call yet!\n");
148         return 1;
149 #else
150         if (argc < 3) {
151                 cprintf("Sets VIRT_ADDR's mapping's permissions to PERMS (in hex)\n");
152                 cprintf("Only affects the lowest level PTE.  To adjust the PDE, do the math.\n");
153                 cprintf("Be careful with this around UVPT, VPT, and friends.\n");
154                 cprintf("Usage: setmapperm VIRT_ADDR PERMS\n");
155                 return 1;
156         }
157         pde_t*COUNT(PTSIZE) pgdir = (pde_t*COUNT(PTSIZE))vpd;
158         pte_t *pte, *pde;
159         page_t* page;
160         uintptr_t va;
161         va = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
162         page = page_lookup(pgdir, (void*SNT)va, &pte);
163         if (!page) {
164                 cprintf("No such mapping\n");
165                 return 1;
166         }
167         pde = &pgdir[PDX(va)];
168         cprintf("   Virtual    Physical  Ps Dr Ac CD WT U W\n");
169         cprintf("------------------------------------------\n");
170         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page),
171                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5,
172                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2,
173                (*pte & *pde & PTE_W) >> 1);
174         *pte = PTE_ADDR(*pte) | (*pte & PTE_PS) |
175                (PGOFF(strtol(argv[2], 0, 16)) & ~PTE_PS ) | PTE_P;
176         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page),
177                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5,
178                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2,
179                (*pte & *pde & PTE_W) >> 1);
180         return 0;
181 #endif
182 }
183
184 int mon_cpuinfo(int argc, char **argv, trapframe_t *tf)
185 {
186         cprintf("Number of CPUs detected: %d\n", num_cpus);
187         cprintf("Calling CPU's ID: 0x%08x\n", core_id());
188
189 #ifdef __i386__
190         if (argc < 2)
191                 smp_call_function_self(test_print_info_handler, NULL, 0);
192         else
193                 smp_call_function_single(strtol(argv[1], 0, 16),
194                                          test_print_info_handler, NULL, 0);
195 #endif
196         return 0;
197 }
198
199 int mon_manager(int argc, char** argv, trapframe_t *tf)
200 {
201         manager();
202         panic("should never get here");
203         return 0;
204 }
205
206 int mon_nanwan(int argc, char **argv, trapframe_t *tf)
207 {
208         /* Borrowed with love from http://www.geocities.com/SoHo/7373/zoo.htm
209          * (http://www.ascii-art.com/).  Slightly modified to make it 25 lines tall.
210          */
211         printk("\n");
212         printk("             .-.  .-.\n");
213         printk("             |  \\/  |\n");
214         printk("            /,   ,_  `'-.\n");
215         printk("          .-|\\   /`\\     '. \n");
216         printk("        .'  0/   | 0\\  \\_  `\".  \n");
217         printk("     .-'  _,/    '--'.'|#''---'\n");
218         printk("      `--'  |       /   \\#\n");
219         printk("            |      /     \\#\n");
220         printk("            \\     ;|\\    .\\#\n");
221         printk("            |' ' //  \\   ::\\# \n");
222         printk("            \\   /`    \\   ':\\#\n");
223         printk("             `\"`       \\..   \\#\n");
224         printk("                        \\::.  \\#\n");
225         printk("                         \\::   \\#\n");
226         printk("                          \\'  .:\\#\n");
227         printk("                           \\  :::\\#\n");
228         printk("                            \\  '::\\#\n");
229         printk("                             \\     \\#\n");
230         printk("                              \\:.   \\#\n");
231         printk("                               \\::   \\#\n");
232         printk("                                \\'   .\\#\n");
233         printk("                             jgs \\   ::\\#\n");
234         printk("                                  \\      \n");
235         return 0;
236 }
237
238 int mon_kfs_ls(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
239 {
240         printk("Files in KFS:\n-------------------------------\n");
241         for (int i = 0; i < MAX_KFS_FILES; i++)
242                 if (kfs[i].name[0])
243                         printk("%s\n", kfs[i].name);
244         return 0;
245 }
246
247 int mon_kfs_run(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
248 {
249         if (argc != 2) {
250                 printk("Usage: kfs_run FILENAME\n");
251                 return 1;
252         }
253         int kfs_inode = kfs_lookup_path(argv[1]);
254         if (kfs_inode < 0) {
255                 printk("Bad filename!\n");
256                 return 1;
257         }
258         struct proc *p = kfs_proc_create(kfs_inode);
259         // go from PROC_CREATED->PROC_RUNNABLE_S
260         spin_lock_irqsave(&p->proc_lock); // might not be necessary for a mon function
261         proc_set_state(p, PROC_RUNNABLE_S);
262         schedule_proc(p);
263         spin_unlock_irqsave(&p->proc_lock);
264         // Should never return from schedule (env_pop in there)
265         // also note you may not get the process you created, in the event there
266         // are others floating around that are runnable
267         schedule();
268         return 0;
269 }
270
271 int mon_procinfo(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
272 {
273         if (argc < 2) {
274                 printk("Usage: procinfo OPTION\n");
275                 printk("\tidle_cores: show idle core map\n");
276                 printk("\trunnable: show proc_runnablelist\n");
277                 printk("\tresources: show resources wanted/granted for all procs\n");
278                 printk("\tpid NUM: show a lot of info for proc NUM\n");
279                 return 1;
280         }
281         if (!strcmp(argv[1], "idle_cores")) {
282                 print_idlecoremap();
283         } else if (!strcmp(argv[1], "runnable")) {
284                 dump_proclist(&proc_runnablelist);
285         } else if (!strcmp(argv[1], "resources")) {
286                 print_all_resources();
287         } else if (!strcmp(argv[1], "pid")) {
288                 if (argc != 3) {
289                         printk("Give me a pid number.\n");
290                         return 1;
291                 }
292                 print_proc_info(strtol(argv[2], 0, 0));
293         } else {
294                 printk("Bad option\n");
295                 return 1;
296         }
297         return 0;
298 }
299
300 /***** Kernel monitor command interpreter *****/
301
302 #define WHITESPACE "\t\r\n "
303 #define MAXARGS 16
304
305 static int runcmd(char *NTS real_buf, trapframe_t *tf) {
306         char * buf = NTEXPAND(real_buf);
307         int argc;
308         char *NTS argv[MAXARGS];
309         int i;
310
311         // Parse the command buffer into whitespace-separated arguments
312         argc = 0;
313         argv[argc] = 0;
314         while (1) {
315                 // gobble whitespace
316                 while (*buf && strchr(WHITESPACE, *buf))
317                         *buf++ = 0;
318                 if (*buf == 0)
319                         break;
320
321                 // save and scan past next arg
322                 if (argc == MAXARGS-1) {
323                         cprintf("Too many arguments (max %d)\n", MAXARGS);
324                         return 0;
325                 }
326                 //This will get fucked at runtime..... in the ASS
327                 argv[argc++] = buf;
328                 while (*buf && !strchr(WHITESPACE, *buf))
329                         buf++;
330         }
331         argv[argc] = 0;
332
333         // Lookup and invoke the command
334         if (argc == 0)
335                 return 0;
336         for (i = 0; i < NCOMMANDS; i++) {
337                 if (strcmp(argv[0], commands[i].name) == 0)
338                         return commands[i].func(argc, argv, tf);
339         }
340         cprintf("Unknown command '%s'\n", argv[0]);
341         return 0;
342 }
343
344 void monitor(trapframe_t *tf) {
345         char *buf;
346
347         printk("Welcome to the ROS kernel monitor on core %d!\n", core_id());
348         printk("Type 'help' for a list of commands.\n");
349
350         if (tf != NULL)
351                 print_trapframe(tf);
352
353         while (1) {
354                 buf = readline("K> ");
355                 if (buf != NULL)
356                         if (runcmd(buf, tf) < 0)
357                                 break;
358         }
359 }