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