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