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