Merge branch 'master' into proc-work
[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/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
24 #include <ros/memlayout.h>
25
26 #define CMDBUF_SIZE     80      // enough for one VGA text line
27
28 typedef struct command {
29         const char *NTS name;
30         const char *NTS desc;
31         // return -1 to force monitor to exit
32         int (*func)(int argc, char *NTS *NT COUNT(argc) argv, trapframe_t *tf);
33 } command_t;
34
35 static command_t commands[] = {
36         { "help", "Display this list of commands", mon_help },
37         { "kerninfo", "Display information about the kernel", mon_kerninfo },
38         { "backtrace", "Dump a backtrace", mon_backtrace },
39         { "reboot", "Take a ride to the South Bay", mon_reboot },
40         { "showmapping", "Shows VA->PA mappings between two virtual addresses (parameters)", mon_showmapping},
41         { "setmapperm", "Sets permissions on a VA->PA mapping", mon_setmapperm},
42         { "cpuinfo", "Prints CPU diagnostics", mon_cpuinfo},
43         { "nanwan", "Meet Nanwan!!", mon_nanwan},
44         { "kfs_ls", "List files in KFS", mon_kfs_ls},
45         { "kfs_run", "Create and run a program from KFS", mon_kfs_run},
46         { "manager", "Run the manager", mon_manager},
47 };
48 #define NCOMMANDS (sizeof(commands)/sizeof(commands[0]))
49
50 /***** Implementations of basic kernel monitor commands *****/
51
52 int mon_help(int argc, char **argv, trapframe_t *tf)
53 {
54         int i;
55
56         for (i = 0; i < NCOMMANDS; i++)
57                 cprintf("%s - %s\n", commands[i].name, commands[i].desc);
58         return 0;
59 }
60
61 int mon_kerninfo(int argc, char **argv, trapframe_t *tf)
62 {
63         extern char (SNT _start)[], (SNT etext)[], (SNT edata)[], (SNT end)[];
64
65         cprintf("Special kernel symbols:\n");
66         cprintf("  _start %08x (virt)  %08x (phys)\n", _start, (uint32_t)(_start - KERNBASE));
67         cprintf("  etext  %08x (virt)  %08x (phys)\n", etext, (uint32_t)(etext - KERNBASE));
68         cprintf("  edata  %08x (virt)  %08x (phys)\n", edata, (uint32_t)(edata - KERNBASE));
69         cprintf("  end    %08x (virt)  %08x (phys)\n", end, (uint32_t)(end - KERNBASE));
70         cprintf("Kernel executable memory footprint: %dKB\n",
71                 (uint32_t)(end-_start+1023)/1024);
72         return 0;
73 }
74
75 static char* function_of(uint32_t address) 
76 {
77         extern stab_t stab[], estab[];
78         extern char stabstr[];
79         stab_t* symtab;
80         stab_t* best_symtab = 0;
81         uint32_t best_func = 0;
82         
83         // ugly and unsorted
84         for (symtab = stab; symtab < estab; symtab++) {
85                 // only consider functions, type = N_FUN
86                 if ((symtab->n_type == N_FUN) && 
87                     (symtab->n_value <= address) && 
88                         (symtab->n_value > best_func)) {
89                         best_func = symtab->n_value;
90                         best_symtab = symtab;
91                 }
92         }
93         // maybe the first stab really is the right one...  we'll see.
94         if (best_symtab == 0)
95                 return "Function not found!";
96         return stabstr + best_symtab->n_strx;
97 }
98
99 int mon_backtrace(int argc, char **argv, trapframe_t *tf)
100 {
101         backtrace();
102         return 0;
103 }
104
105 int mon_reboot(int argc, char **argv, trapframe_t *tf)
106 {
107         cprintf("[Irish Accent]: She's goin' down, Cap'n!\n");
108         reboot();
109
110         // really, should never see this
111         cprintf("Sigh....\n");
112         return 0;
113 }
114
115 int mon_showmapping(int argc, char **argv, trapframe_t *tf)
116 {
117         if (argc < 2) {
118                 cprintf("Shows virtual -> physical mappings for a virtual address range.\n");
119                 cprintf("Usage: showmappings START_ADDR [END_ADDR]\n");
120                 return 1;
121         }
122         pde_t* pgdir = (pde_t*)vpd;
123         pte_t *pte, *pde;
124         page_t* page;
125         uintptr_t start, i;
126         size_t size;
127         start = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
128         size = (argc == 2) ? 1 : strtol(argv[2], 0, 16) - start;
129         if (size/PGSIZE > 512) {
130                 cprintf("Not going to do this for more than 512 items\n");
131                 return 1;
132         }
133
134         show_mapping(start,size);
135         return 0;
136 }
137
138 int mon_setmapperm(int argc, char **argv, trapframe_t *tf)
139 {
140 #ifndef __i386__
141         cprintf("I don't support this call yet!\n");
142         return 1;
143 #else
144         if (argc < 3) {
145                 cprintf("Sets VIRT_ADDR's mapping's permissions to PERMS (in hex)\n");
146                 cprintf("Only affects the lowest level PTE.  To adjust the PDE, do the math.\n");
147                 cprintf("Be careful with this around UVPT, VPT, and friends.\n");
148                 cprintf("Usage: setmapperm VIRT_ADDR PERMS\n");
149                 return 1;
150         }
151         pde_t* pgdir = (pde_t*)vpd;
152         pte_t *pte, *pde;
153         page_t* page;
154         uintptr_t va;
155         va = ROUNDDOWN(strtol(argv[1], 0, 16), PGSIZE);
156         page = page_lookup(pgdir, (void*)va, &pte);
157         if (!page) {
158                 cprintf("No such mapping\n");
159                 return 1;
160         }
161         pde = &pgdir[PDX(va)];
162         cprintf("   Virtual    Physical  Ps Dr Ac CD WT U W\n");
163         cprintf("------------------------------------------\n");
164         cprintf("%08p  %08p  %1d  %1d  %1d  %1d  %1d  %1d %1d\n", va, page2pa(page), 
165                (*pte & PTE_PS) >> 7, (*pte & PTE_D) >> 6, (*pte & PTE_A) >> 5, 
166                (*pte & PTE_PCD) >> 4, (*pte & PTE_PWT) >> 3, (*pte & *pde & PTE_U) >> 2, 
167                (*pte & *pde & PTE_W) >> 1);
168         *pte = PTE_ADDR(*pte) | (*pte & PTE_PS) |
169                (PGOFF(strtol(argv[2], 0, 16)) & ~PTE_PS ) | PTE_P;
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         return 0;
175 #endif
176 }
177
178 int mon_cpuinfo(int argc, char **argv, trapframe_t *tf)
179 {
180         extern uint8_t num_cpus;
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, 0, 0);
188         else
189                 smp_call_function_single(strtol(argv[1], 0, 16),
190                                          test_print_info_handler, 0, 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         proc_set_state(p, PROC_RUNNABLE_S);
257         // Should never return from schedule (env_pop in there)
258         // also note you may not get the process you created, in the event there
259         // are others floating around that are runnable
260         schedule();
261         return 0;
262 }
263
264 /***** Kernel monitor command interpreter *****/
265
266 #define WHITESPACE "\t\r\n "
267 #define MAXARGS 16
268
269 static int runcmd(char *COUNT(CMDBUF_SIZE) real_buf, trapframe_t *tf) {
270         char *BND(real_buf, real_buf+CMDBUF_SIZE) buf = real_buf;
271         int argc;
272         char *NTS argv[MAXARGS];
273         int i;
274
275         // Parse the command buffer into whitespace-separated arguments
276         argc = 0;
277         argv[argc] = 0;
278         while (1) {
279                 // gobble whitespace
280                 while (*buf && strchr(WHITESPACE, *buf))
281                         *buf++ = 0;
282                 if (*buf == 0)
283                         break;
284
285                 // save and scan past next arg
286                 if (argc == MAXARGS-1) {
287                         cprintf("Too many arguments (max %d)\n", MAXARGS);
288                         return 0;
289                 }
290                 //This will get fucked at runtime..... in the ASS
291                 argv[argc++] = (char *NTS) TC(buf);
292                 while (*buf && !strchr(WHITESPACE, *buf))
293                         buf++;
294         }
295         argv[argc] = 0;
296
297         // Lookup and invoke the command
298         if (argc == 0)
299                 return 0;
300         for (i = 0; i < NCOMMANDS; i++) {
301                 if (strcmp(argv[0], commands[i].name) == 0)
302                         return commands[i].func(argc, argv, tf);
303         }
304         cprintf("Unknown command '%s'\n", argv[0]);
305         return 0;
306 }
307
308 void monitor(trapframe_t *tf) {
309         char *buf;
310
311         printk("Welcome to the ROS kernel monitor on core %d!\n", core_id());
312         printk("Type 'help' for a list of commands.\n");
313
314         if (tf != NULL)
315                 print_trapframe(tf);
316
317         while (1) {
318                 buf = readline("K> ");
319                 if (buf != NULL)
320                         if (runcmd(buf, tf) < 0)
321                                 break;
322         }
323 }