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