_M procs start up at _start/hart_entry for vcore0
[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 #include <kdebug.h>
26
27 #include <ros/memlayout.h>
28
29 #define CMDBUF_SIZE     80      // enough for one VGA text line
30
31 typedef struct command {
32         const char *NTS name;
33         const char *NTS desc;
34         // return -1 to force monitor to exit
35         int (*func)(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf);
36 } command_t;
37
38 static command_t (RO commands)[] = {
39         { "help", "Display this list of commands", mon_help },
40         { "kerninfo", "Display information about the kernel", mon_kerninfo },
41         { "backtrace", "Dump a backtrace", mon_backtrace },
42         { "reboot", "Take a ride to the South Bay", mon_reboot },
43         { "showmapping", "Shows VA->PA mappings between two virtual addresses (parameters)", mon_showmapping},
44         { "setmapperm", "Sets permissions on a VA->PA mapping", mon_setmapperm},
45         { "cpuinfo", "Prints CPU diagnostics", mon_cpuinfo},
46         { "ps", "Prints process list", mon_ps},
47         { "nanwan", "Meet Nanwan!!", mon_nanwan},
48         { "kfs_ls", "List files in KFS", mon_kfs_ls},
49         { "kfs_run", "Create and run a program from KFS", mon_kfs_run},
50         { "kfs_cat", "Dumps text from a file from KFS", mon_kfs_cat},
51         { "manager", "Run the manager", mon_manager},
52         { "procinfo", "Show information about processes", mon_procinfo},
53         { "exit", "Leave the monitor", mon_exit},
54         { "kfunc", "Run a kernel function directly (!!!)", mon_kfunc},
55 };
56 #define NCOMMANDS (sizeof(commands)/sizeof(commands[0]))
57
58 /***** Implementations of basic kernel monitor commands *****/
59
60 int mon_help(int argc, char **argv, trapframe_t *tf)
61 {
62         int i;
63
64         for (i = 0; i < NCOMMANDS; i++)
65                 cprintf("%s - %s\n", commands[i].name, commands[i].desc);
66         return 0;
67 }
68
69 int mon_ps(int argc, char** argv, trapframe_t *tf)
70 {
71         print_allpids();
72         return 0;
73 }
74
75 int mon_kerninfo(int argc, char **argv, trapframe_t *tf)
76 {
77         extern char (RO SNT _start)[], (RO SNT etext)[], (RO SNT edata)[], (RO SNT end)[];
78
79         cprintf("Special kernel symbols:\n");
80         cprintf("  _start %08x (virt)  %08x (phys)\n", _start, (uint32_t)(_start - KERNBASE));
81         cprintf("  etext  %08x (virt)  %08x (phys)\n", etext, (uint32_t)(etext - KERNBASE));
82         cprintf("  edata  %08x (virt)  %08x (phys)\n", edata, (uint32_t)(edata - KERNBASE));
83         cprintf("  end    %08x (virt)  %08x (phys)\n", end, (uint32_t)(end - KERNBASE));
84         cprintf("Kernel executable memory footprint: %dKB\n",
85                 (uint32_t)(end-_start+1023)/1024);
86         return 0;
87 }
88
89 #if 0
90 zra: not called
91 static char RO* function_of(uint32_t address)
92 {
93         extern stab_t (RO stab)[], (RO estab)[];
94         extern char (RO stabstr)[];
95         stab_t* symtab;
96         stab_t* best_symtab = 0;
97         uint32_t best_func = 0;
98
99         // ugly and unsorted
100         for (symtab = stab; symtab < estab; symtab++) {
101                 // only consider functions, type = N_FUN
102                 if ((symtab->n_type == N_FUN) &&
103                     (symtab->n_value <= address) &&
104                         (symtab->n_value > best_func)) {
105                         best_func = symtab->n_value;
106                         best_symtab = symtab;
107                 }
108         }
109         // maybe the first stab really is the right one...  we'll see.
110         if (best_symtab == 0)
111                 return "Function not found!";
112         return stabstr + best_symtab->n_strx;
113 }
114 #endif
115
116 int mon_backtrace(int argc, char **argv, trapframe_t *tf)
117 {
118         backtrace();
119         return 0;
120 }
121
122 int mon_reboot(int argc, char **argv, trapframe_t *tf)
123 {
124         cprintf("[Irish Accent]: She's goin' down, Cap'n!\n");
125         reboot();
126
127         // really, should never see this
128         cprintf("Sigh....\n");
129         return 0;
130 }
131
132 int mon_showmapping(int argc, char **argv, trapframe_t *tf)
133 {
134         if (argc < 2) {
135                 cprintf("Shows virtual -> physical mappings for a virtual address range.\n");
136                 cprintf("Usage: showmapping START_ADDR [END_ADDR]\n");
137                 return 1;
138         }
139         pde_t* pgdir = (pde_t*)vpd;
140         pte_t *pte, *pde;
141         page_t* page;
142         uintptr_t start, i;
143         size_t size;
144         start = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
145         size = (argc == 2) ? 1 : strtol(argv[2], 0, 16) - start;
146         if (size/PGSIZE > 512) {
147                 cprintf("Not going to do this for more than 512 items\n");
148                 return 1;
149         }
150
151         show_mapping(start,size);
152         return 0;
153 }
154
155 int mon_setmapperm(int argc, char **argv, trapframe_t *tf)
156 {
157 #ifndef __i386__
158         cprintf("I don't support this call yet!\n");
159         return 1;
160 #else
161         if (argc < 3) {
162                 cprintf("Sets VIRT_ADDR's mapping's permissions to PERMS (in hex)\n");
163                 cprintf("Only affects the lowest level PTE.  To adjust the PDE, do the math.\n");
164                 cprintf("Be careful with this around UVPT, VPT, and friends.\n");
165                 cprintf("Usage: setmapperm VIRT_ADDR PERMS\n");
166                 return 1;
167         }
168         pde_t*COUNT(PTSIZE) pgdir = (pde_t*COUNT(PTSIZE))vpd;
169         pte_t *pte, *pde;
170         page_t* page;
171         uintptr_t va;
172         va = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
173         page = page_lookup(pgdir, (void*SNT)va, &pte);
174         if (!page) {
175                 cprintf("No such mapping\n");
176                 return 1;
177         }
178         pde = &pgdir[PDX(va)];
179         cprintf("   Virtual    Physical  Ps Dr Ac CD WT U W\n");
180         cprintf("------------------------------------------\n");
181         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page),
182                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5,
183                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2,
184                (*pte & *pde & PTE_W) >> 1);
185         *pte = PTE_ADDR(*pte) | (*pte & PTE_PS) |
186                (PGOFF(strtol(argv[2], 0, 16)) & ~PTE_PS ) | PTE_P;
187         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page),
188                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5,
189                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2,
190                (*pte & *pde & PTE_W) >> 1);
191         return 0;
192 #endif
193 }
194
195 int mon_cpuinfo(int argc, char **argv, trapframe_t *tf)
196 {
197         cprintf("Number of CPUs detected: %d\n", num_cpus);
198         cprintf("Calling CPU's ID: 0x%08x\n", core_id());
199
200         if (argc < 2)
201                 smp_call_function_self(test_print_info_handler, NULL, 0);
202         else
203                 smp_call_function_single(strtol(argv[1], 0, 10),
204                                          test_print_info_handler, NULL, 0);
205         return 0;
206 }
207
208 int mon_manager(int argc, char** argv, trapframe_t *tf)
209 {
210         manager();
211         panic("should never get here");
212         return 0;
213 }
214
215 int mon_nanwan(int argc, char **argv, trapframe_t *tf)
216 {
217         /* Borrowed with love from http://www.geocities.com/SoHo/7373/zoo.htm
218          * (http://www.ascii-art.com/).  Slightly modified to make it 25 lines tall.
219          */
220         printk("\n");
221         printk("             .-.  .-.\n");
222         printk("             |  \\/  |\n");
223         printk("            /,   ,_  `'-.\n");
224         printk("          .-|\\   /`\\     '. \n");
225         printk("        .'  0/   | 0\\  \\_  `\".  \n");
226         printk("     .-'  _,/    '--'.'|#''---'\n");
227         printk("      `--'  |       /   \\#\n");
228         printk("            |      /     \\#\n");
229         printk("            \\     ;|\\    .\\#\n");
230         printk("            |' ' //  \\   ::\\# \n");
231         printk("            \\   /`    \\   ':\\#\n");
232         printk("             `\"`       \\..   \\#\n");
233         printk("                        \\::.  \\#\n");
234         printk("                         \\::   \\#\n");
235         printk("                          \\'  .:\\#\n");
236         printk("                           \\  :::\\#\n");
237         printk("                            \\  '::\\#\n");
238         printk("                             \\     \\#\n");
239         printk("                              \\:.   \\#\n");
240         printk("                               \\::   \\#\n");
241         printk("                                \\'   .\\#\n");
242         printk("                             jgs \\   ::\\#\n");
243         printk("                                  \\      \n");
244         return 0;
245 }
246
247 int mon_kfs_ls(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
248 {
249         printk("Files in KFS:\n-------------------------------\n");
250         for (int i = 0; i < MAX_KFS_FILES; i++)
251                 if (kfs[i].name[0])
252                         printk("%s\n", kfs[i].name);
253         return 0;
254 }
255
256 int mon_kfs_run(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
257 {
258         if (argc != 2) {
259                 printk("Usage: kfs_run FILENAME\n");
260                 return 1;
261         }
262         int kfs_inode = kfs_lookup_path(argv[1]);
263         if (kfs_inode < 0) {
264                 printk("Bad filename!\n");
265                 return 1;
266         }
267         struct proc *p = kfs_proc_create(kfs_inode);
268         // go from PROC_CREATED->PROC_RUNNABLE_S
269         spin_lock_irqsave(&p->proc_lock); // might not be necessary for a mon function
270         __proc_set_state(p, PROC_RUNNABLE_S);
271         schedule_proc(p);
272         spin_unlock_irqsave(&p->proc_lock);
273         proc_decref(p, 1); // let go of the reference created in proc_create()
274         // Should never return from schedule (env_pop in there)
275         // also note you may not get the process you created, in the event there
276         // are others floating around that are runnable
277         schedule();
278         return 0;
279 }
280
281 int mon_kfs_cat(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
282 {
283         if (argc != 2) {
284                 printk("Usage: kfs_cat FILENAME\n");
285                 return 1;
286         }
287         int kfs_inode = kfs_lookup_path(argv[1]);
288         if (kfs_inode < 0) {
289                 printk("Bad filename!\n");
290                 return 1;
291         }
292         kfs_cat(kfs_inode);
293         return 0;
294 }
295
296 int mon_procinfo(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
297 {
298         if (argc < 2) {
299                 printk("Usage: procinfo OPTION\n");
300                 printk("\tidlecores: show idle core map\n");
301                 printk("\tall: show all active pids\n");
302                 printk("\trunnable: show proc_runnablelist\n");
303                 printk("\tresources: show resources wanted/granted for all procs\n");
304                 printk("\tpid NUM: show a lot of info for proc NUM\n");
305                 printk("\tunlock NUM: unlock the lock for proc NUM (OMG!!!)\n");
306                 printk("\tkill NUM: destroy proc NUM\n");
307                 return 1;
308         }
309         if (!strcmp(argv[1], "idlecores")) {
310                 print_idlecoremap();
311         } else if (!strcmp(argv[1], "all")) {
312                 print_allpids();
313         } else if (!strcmp(argv[1], "runnable")) {
314                 dump_proclist(&proc_runnablelist);
315         } else if (!strcmp(argv[1], "resources")) {
316                 print_all_resources();
317         } else if (!strcmp(argv[1], "pid")) {
318                 if (argc != 3) {
319                         printk("Give me a pid number.\n");
320                         return 1;
321                 }
322                 print_proc_info(strtol(argv[2], 0, 0));
323         } else if (!strcmp(argv[1], "unlock")) {
324                 if (argc != 3) {
325                         printk("Give me a pid number.\n");
326                         return 1;
327                 }
328                 struct proc *p = pid2proc(strtol(argv[2], 0, 0));
329                 if (!p) {
330                         printk("No such proc\n");
331                         return 1;
332                 }
333                 spin_unlock_irqsave(&p->proc_lock);
334                 proc_decref(p, 1);
335         } else if (!strcmp(argv[1], "kill")) {
336                 if (argc != 3) {
337                         printk("Give me a pid number.\n");
338                         return 1;
339                 }
340                 struct proc *p = pid2proc(strtol(argv[2], 0, 0));
341                 if (!p) {
342                         printk("No such proc\n");
343                         return 1;
344                 }
345                 proc_destroy(p);
346                 proc_decref(p, 1);
347         } else {
348                 printk("Bad option\n");
349                 return 1;
350         }
351         return 0;
352 }
353
354 int mon_exit(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
355 {
356         return -1;
357 }
358
359 int mon_kfunc(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf)
360 {
361         #ifndef __i386__
362         printk("Only supported on x86 for now.  =(\n");
363         return -1;
364         #endif
365
366         void (*func)(void *arg, ...);
367
368         if (argc < 2) {
369                 printk("Usage: kfunc FUNCTION [arg1] [arg2] [etc]\n");
370                 printk("Arguments must be in hex.  Can take 6 args.\n");
371                 return 1;
372         }
373         func = debug_get_fn_addr(argv[1]);
374         if (!func) {
375                 printk("Function not found.\n");
376                 return 1;
377         }
378         /* Not elegant, but whatever.  maybe there's a better syntax, or we can do
379          * it with asm magic. */
380         switch (argc) {
381                 case 2: /* have to fake one arg */
382                         func((void*)0);
383                         break;
384                 case 3: /* the real first arg */
385                         func((void*)strtol(argv[2], 0, 16));
386                         break;
387                 case 4:
388                         func((void*)strtol(argv[2], 0, 16),
389                                     strtol(argv[3], 0, 16));
390                         break;
391                 case 5:
392                         func((void*)strtol(argv[2], 0, 16),
393                                     strtol(argv[3], 0, 16),
394                                     strtol(argv[4], 0, 16));
395                         break;
396                 case 6:
397                         func((void*)strtol(argv[2], 0, 16),
398                                     strtol(argv[3], 0, 16),
399                                     strtol(argv[4], 0, 16),
400                                     strtol(argv[5], 0, 16));
401                         break;
402                 case 7:
403                         func((void*)strtol(argv[2], 0, 16),
404                                     strtol(argv[3], 0, 16),
405                                     strtol(argv[4], 0, 16),
406                                     strtol(argv[5], 0, 16),
407                                     strtol(argv[6], 0, 16));
408                         break;
409                 case 8:
410                         func((void*)strtol(argv[2], 0, 16),
411                                     strtol(argv[3], 0, 16),
412                                     strtol(argv[4], 0, 16),
413                                     strtol(argv[5], 0, 16),
414                                     strtol(argv[6], 0, 16),
415                                     strtol(argv[7], 0, 16));
416                         break;
417                 default:
418                         printk("Bad number of arguments.\n");
419                         return -1;
420         }
421         return 0;
422 }
423
424 /***** Kernel monitor command interpreter *****/
425
426 #define WHITESPACE "\t\r\n "
427 #define MAXARGS 16
428
429 static int runcmd(char *NTS real_buf, trapframe_t *tf) {
430         char * buf = NTEXPAND(real_buf);
431         int argc;
432         char *NTS argv[MAXARGS];
433         int i;
434
435         // Parse the command buffer into whitespace-separated arguments
436         argc = 0;
437         argv[argc] = 0;
438         while (1) {
439                 // gobble whitespace
440                 while (*buf && strchr(WHITESPACE, *buf))
441                         *buf++ = 0;
442                 if (*buf == 0)
443                         break;
444
445                 // save and scan past next arg
446                 if (argc == MAXARGS-1) {
447                         cprintf("Too many arguments (max %d)\n", MAXARGS);
448                         return 0;
449                 }
450                 //This will get fucked at runtime..... in the ASS
451                 argv[argc++] = buf;
452                 while (*buf && !strchr(WHITESPACE, *buf))
453                         buf++;
454         }
455         argv[argc] = 0;
456
457         // Lookup and invoke the command
458         if (argc == 0)
459                 return 0;
460         for (i = 0; i < NCOMMANDS; i++) {
461                 if (strcmp(argv[0], commands[i].name) == 0)
462                         return commands[i].func(argc, argv, tf);
463         }
464         cprintf("Unknown command '%s'\n", argv[0]);
465         return 0;
466 }
467
468 void monitor(trapframe_t *tf) {
469         char *buf;
470
471         printk("Welcome to the ROS kernel monitor on core %d!\n", core_id());
472         printk("Type 'help' for a list of commands.\n");
473
474         if (tf != NULL)
475                 print_trapframe(tf);
476
477         while (1) {
478                 buf = readline("K> ");
479                 if (buf != NULL)
480                         if (runcmd(buf, tf) < 0)
481                                 break;
482         }
483 }