-#include "init.h"
-#include <stdint.h>
-#include <stddef.h>
+#include "threads/init.h"
+#include <console.h>
+#include <debug.h>
#include <limits.h>
-#include "debug.h"
-#include "interrupt.h"
-#include "io.h"
-#include "kbd.h"
-#include "lib.h"
-#include "loader.h"
-#include "malloc.h"
-#include "mmu.h"
-#include "paging.h"
-#include "palloc.h"
-#include "random.h"
-#include "serial.h"
-#include "thread.h"
-#include "timer.h"
-#include "vga.h"
+#include <random.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include "devices/kbd.h"
+#include "devices/input.h"
+#include "devices/serial.h"
+#include "devices/timer.h"
+#include "devices/vga.h"
+#include "threads/interrupt.h"
+#include "threads/io.h"
+#include "threads/loader.h"
+#include "threads/malloc.h"
+#include "threads/palloc.h"
+#include "threads/pte.h"
+#include "threads/thread.h"
+#ifdef USERPROG
+#include "userprog/process.h"
+#include "userprog/exception.h"
+#include "userprog/gdt.h"
+#include "userprog/syscall.h"
+#include "userprog/tss.h"
+#else
+#include "tests/threads/tests.h"
+#endif
#ifdef FILESYS
-#include "filesys.h"
-#include "disk.h"
-#include "fsutil.h"
+#include "devices/disk.h"
+#include "filesys/filesys.h"
+#include "filesys/fsutil.h"
#endif
/* Amount of physical memory, in 4 kB pages. */
size_t ram_pages;
+/* Page directory with kernel mappings only. */
+uint32_t *base_page_dir;
+
+/* -mlfqs:
+ If false (default), use round-robin scheduler.
+ If true, use multi-level feedback queue scheduler. */
+bool enable_mlfqs;
+
#ifdef FILESYS
-/* Format the filesystem? */
+/* -f: Format the file system? */
static bool format_filesys;
#endif
-#ifdef USERPROG
-/* Initial program to run. */
-static char *initial_program;
-#endif
+/* -q: Power off after kernel tasks complete? */
+bool power_off_when_done;
static void ram_init (void);
-static void gdt_init (void);
-static void argv_init (void);
+static void paging_init (void);
-static void
-main_thread (void *aux UNUSED)
-{
-#ifdef FILESYS
- disk_init ();
- filesys_init (format_filesys);
- fsutil_run ();
-#endif
+static char **read_command_line (void);
+static char **parse_options (char **argv);
+static void run_actions (char **argv);
+static void usage (void);
+
+static void print_stats (void);
-#ifdef USERPROG
- if (initial_program != NULL)
- thread_execute (initial_program);
- else
- PANIC ("no initial program specified");
-#endif
-}
+int main (void) NO_RETURN;
+
+/* Pintos main program. */
int
main (void)
{
- /* Initialize prerequisites for calling printk(). */
+ char **argv;
+
+ /* Clear BSS and get machine's RAM size. */
ram_init ();
+
+ /* Initialize ourselves as a thread so we can use locks. */
+ thread_init ();
+
+ /* Initialize the console so we can use printf(). */
vga_init ();
- serial_init ();
+ serial_init_poll ();
+ console_init ();
/* Greet user. */
- printk ("Booting cnachos86 with %'d kB RAM...\n", ram_pages * 4);
+ printf ("Pintos booting with %'zu kB RAM...\n", ram_pages * PGSIZE / 1024);
- /* Parse command line. */
- argv_init ();
+ /* Break command line into arguments and parse options. */
+ argv = read_command_line ();
+ argv = parse_options (argv);
+
+ /* Set random seed if parse_options() didn't. */
+ random_init (0);
/* Initialize memory system. */
palloc_init ();
- paging_init ();
- gdt_init ();
malloc_init ();
+ paging_init ();
- random_init (0);
+ /* Segmentation. */
+#ifdef USERPROG
+ tss_init ();
+ gdt_init ();
+#endif
/* Initialize interrupt handlers. */
intr_init ();
timer_init ();
kbd_init ();
+ input_init ();
+#ifdef USERPROG
+ exception_init ();
+ syscall_init ();
+#endif
- /* Do everything else in a system thread. */
- thread_init ();
- thread_create ("main", main_thread, NULL);
+ /* Start thread scheduler and enable interrupts. */
thread_start ();
-}
-
-static uint64_t
-make_seg_desc (uint32_t base,
- uint32_t limit,
- enum seg_system system,
- enum seg_type type,
- int dpl,
- enum seg_granularity granularity)
-{
- uint32_t e0 = ((limit & 0xffff) /* Limit 15:0. */
- | (base << 16)); /* Base 15:0. */
- uint32_t e1 = (((base >> 16) & 0xff) /* Base 23:16. */
- | (system << 12) /* 0=system, 1=code/data. */
- | (type << 8) /* Segment type. */
- | (dpl << 13) /* Descriptor privilege. */
- | (1 << 15) /* Present. */
- | (limit & 0xf0000) /* Limit 16:19. */
- | (1 << 22) /* 32-bit segment. */
- | (granularity << 23) /* Byte/page granularity. */
- | (base & 0xff000000)); /* Base 31:24. */
- return e0 | ((uint64_t) e1 << 32);
-}
-
-static uint64_t
-make_code_desc (int dpl)
-{
- return make_seg_desc (0, 0xfffff, SYS_CODE_DATA, TYPE_CODE | TYPE_READABLE,
- dpl, GRAN_PAGE);
-}
+ serial_init_queue ();
+ timer_calibrate ();
-static uint64_t
-make_data_desc (int dpl)
-{
- return make_seg_desc (0, 0xfffff, SYS_CODE_DATA, TYPE_WRITABLE,
- dpl, GRAN_PAGE);
-}
-
-static uint64_t
-make_tss_desc (void *vaddr)
-{
- return make_seg_desc ((uint32_t) vaddr,
- 0x67, SYS_SYSTEM, TYPE_TSS_32_A, 0, GRAN_BYTE);
-}
-
-static uint64_t gdt[SEL_CNT];
+#ifdef FILESYS
+ /* Initialize file system. */
+ disk_init ();
+ filesys_init (format_filesys);
+#endif
-struct tss *tss;
+ printf ("Boot complete.\n");
+
+ /* Run actions specified on kernel command line. */
+ run_actions (argv);
-/* Sets up a proper GDT. The bootstrap loader's GDT didn't
- include user-mode selectors or a TSS. */
-static void
-gdt_init (void)
-{
- uint64_t gdtr_operand;
-
- /* Our TSS is never used in a call gate or task gate, so only a
- few fields of it are ever referenced, and those are the only
- ones we initialize. */
- tss = palloc_get (PAL_ASSERT | PAL_ZERO);
- tss->esp0 = (uint32_t) ptov(0x20000);
- tss->ss0 = SEL_KDSEG;
- tss->bitmap = 0xdfff;
-
- /* Initialize GDT. */
- gdt[SEL_NULL / sizeof *gdt] = 0;
- gdt[SEL_KCSEG / sizeof *gdt] = make_code_desc (0);
- gdt[SEL_KDSEG / sizeof *gdt] = make_data_desc (0);
- gdt[SEL_UCSEG / sizeof *gdt] = make_code_desc (3);
- gdt[SEL_UDSEG / sizeof *gdt] = make_data_desc (3);
- gdt[SEL_TSS / sizeof *gdt] = make_tss_desc (tss);
-
- /* Load GDTR, TR. */
- gdtr_operand = make_dtr_operand (sizeof gdt - 1, gdt);
- asm volatile ("lgdt %0" :: "m" (gdtr_operand));
- asm volatile ("ltr %w0" :: "r" (SEL_TSS));
+ /* Finish up. */
+ if (power_off_when_done)
+ power_off ();
+ thread_exit ();
}
-
+\f
+/* Clear BSS and obtain RAM size from loader. */
static void
ram_init (void)
{
extern char _start_bss, _end_bss;
memset (&_start_bss, 0, &_end_bss - &_start_bss);
- /* Get RAM size from loader. */
- ram_pages = *(uint32_t *) ptov (LOADER_RAM_PAGES);
+ /* Get RAM size from loader. See loader.S. */
+ ram_pages = *(uint32_t *) ptov (LOADER_RAM_PGS);
}
-\f
+
+/* Populates the base page directory and page table with the
+ kernel virtual mapping, and then sets up the CPU to use the
+ new page directory. Points base_page_dir to the page
+ directory it creates.
+
+ At the time this function is called, the active page table
+ (set up by loader.S) only maps the first 4 MB of RAM, so we
+ should not try to use extravagant amounts of memory.
+ Fortunately, there is no need to do so. */
static void
-argv_init (void)
+paging_init (void)
{
- char *cmd_line, *pos;
- char *argv[LOADER_CMD_LINE_LEN / 2 + 1];
- int argc = 0;
+ uint32_t *pd, *pt;
+ size_t page;
+
+ pd = base_page_dir = palloc_get_page (PAL_ASSERT | PAL_ZERO);
+ pt = NULL;
+ for (page = 0; page < ram_pages; page++)
+ {
+ uintptr_t paddr = page * PGSIZE;
+ void *vaddr = ptov (paddr);
+ size_t pde_idx = pd_no (vaddr);
+ size_t pte_idx = pt_no (vaddr);
+
+ if (pd[pde_idx] == 0)
+ {
+ pt = palloc_get_page (PAL_ASSERT | PAL_ZERO);
+ pd[pde_idx] = pde_create (pt);
+ }
+
+ pt[pte_idx] = pte_create_kernel (vaddr, true);
+ }
+
+ /* Store the physical address of the page directory into CR3
+ aka PDBR (page directory base register). This activates our
+ new page tables immediately. See [IA32-v2a] "MOV--Move
+ to/from Control Registers" and [IA32-v3a] 3.7.5 "Base Address
+ of the Page Directory". */
+ asm volatile ("movl %0, %%cr3" :: "r" (vtop (base_page_dir)));
+}
+
+/* Breaks the kernel command line into words and returns them as
+ an argv-like array. */
+static char **
+read_command_line (void)
+{
+ static char *argv[LOADER_ARGS_LEN / 2 + 1];
+ char *p, *end;
+ int argc;
int i;
- /* The command line is made up of null terminated strings
- followed by an empty string. Break it up into words. */
- cmd_line = pos = ptov (LOADER_CMD_LINE);
- while (pos < cmd_line + LOADER_CMD_LINE_LEN)
+ argc = *(uint32_t *) ptov (LOADER_ARG_CNT);
+ p = ptov (LOADER_ARGS);
+ end = p + LOADER_ARGS_LEN;
+ for (i = 0; i < argc; i++)
{
- ASSERT (argc < LOADER_CMD_LINE_LEN / 2);
- if (*pos == '\0')
- break;
- argv[argc++] = pos;
- pos = strchr (pos, '\0') + 1;
+ if (p >= end)
+ PANIC ("command line arguments overflow");
+
+ argv[i] = p;
+ p += strnlen (p, end - p) + 1;
}
- argv[argc] = "";
+ argv[argc] = NULL;
- /* Parse the words. */
+ /* Print kernel command line. */
+ printf ("Kernel command line:");
for (i = 0; i < argc; i++)
- if (!strcmp (argv[i], "-rs"))
- random_init (atoi (argv[++i]));
- else if (!strcmp (argv[i], "-d"))
- debug_enable (argv[++i]);
+ if (strchr (argv[i], ' ') == NULL)
+ printf (" %s", argv[i]);
+ else
+ printf (" '%s'", argv[i]);
+ printf ("\n");
+
+ return argv;
+}
+
+/* Parses options in ARGV[]
+ and returns the first non-option argument. */
+static char **
+parse_options (char **argv)
+{
+ for (; *argv != NULL && **argv == '-'; argv++)
+ {
+ char *save_ptr;
+ char *name = strtok_r (*argv, "=", &save_ptr);
+ char *value = strtok_r (NULL, "", &save_ptr);
+
+ if (!strcmp (name, "-h"))
+ usage ();
+ else if (!strcmp (name, "-q"))
+ power_off_when_done = true;
+#ifdef FILESYS
+ else if (!strcmp (name, "-f"))
+ format_filesys = true;
+#endif
+ else if (!strcmp (name, "-rs"))
+ random_init (atoi (value));
+ else if (!strcmp (name, "-mlfqs"))
+ enable_mlfqs = true;
#ifdef USERPROG
- else if (!strcmp (argv[i], "-ex"))
- initial_program = argv[++i];
+ else if (!strcmp (name, "-ul"))
+ user_page_limit = atoi (value);
#endif
+ else
+ PANIC ("unknown option `%s' (use -h for help)", name);
+ }
+
+ return argv;
+}
+
+/* Runs the task specified in ARGV[1]. */
+static void
+run_task (char **argv)
+{
+ const char *task = argv[1];
+
+ printf ("Executing '%s':\n", task);
+#ifdef USERPROG
+ process_wait (process_execute (task));
+#else
+ run_test (task);
+#endif
+ printf ("Execution of '%s' complete.\n", task);
+}
+
+/* Executes all of the actions specified in ARGV[]
+ up to the null pointer sentinel. */
+static void
+run_actions (char **argv)
+{
+ /* An action. */
+ struct action
+ {
+ char *name; /* Action name. */
+ int argc; /* # of args, including action name. */
+ void (*function) (char **argv); /* Function to execute action. */
+ };
+
+ /* Table of supported actions. */
+ static const struct action actions[] =
+ {
+ {"run", 2, run_task},
#ifdef FILESYS
- else if (!strcmp (argv[i], "-f"))
- format_filesys = true;
- else if (!strcmp (argv[i], "-cp"))
- fsutil_copy_arg = argv[++i];
- else if (!strcmp (argv[i], "-p"))
- fsutil_print_file = argv[++i];
- else if (!strcmp (argv[i], "-r"))
- fsutil_remove_file = argv[++i];
- else if (!strcmp (argv[i], "-ls"))
- fsutil_list_files = true;
- else if (!strcmp (argv[i], "-D"))
- fsutil_dump_filesys = true;
-#endif
- else if (!strcmp (argv[i], "-u"))
- {
- printk (
- "Kernel options:\n"
- " -rs SEED Seed random seed to SEED.\n"
- " -d CLASS[,...] Enable the given classes of debug messages.\n"
+ {"ls", 1, fsutil_ls},
+ {"cat", 2, fsutil_cat},
+ {"rm", 2, fsutil_rm},
+ {"put", 2, fsutil_put},
+ {"get", 2, fsutil_get},
+#endif
+ {NULL, 0, NULL},
+ };
+
+ while (*argv != NULL)
+ {
+ const struct action *a;
+ int i;
+
+ /* Find action name. */
+ for (a = actions; ; a++)
+ if (a->name == NULL)
+ PANIC ("unknown action `%s' (use -h for help)", *argv);
+ else if (!strcmp (*argv, a->name))
+ break;
+
+ /* Check for required arguments. */
+ for (i = 1; i < a->argc; i++)
+ if (argv[i] == NULL)
+ PANIC ("action `%s' requires %d argument(s)", *argv, a->argc - 1);
+
+ /* Invoke action and advance. */
+ a->function (argv);
+ argv += a->argc;
+ }
+
+}
+
+/* Prints a kernel command line help message and powers off the
+ machine. */
+static void
+usage (void)
+{
+ printf ("\nCommand line syntax: [OPTION...] [ACTION...]\n"
+ "Options must precede actions.\n"
+ "Actions are executed in the order specified.\n"
+ "\nAvailable actions:\n"
#ifdef USERPROG
- " -ex 'PROG [ARG...]' Run PROG, passing the optional arguments.\n"
+ " run 'PROG [ARG...]' Run PROG and wait for it to complete.\n"
+#else
+ " run TEST Run TEST.\n"
+#endif
+#ifdef FILESYS
+ " ls List files in the root directory.\n"
+ " cat FILE Print FILE to the console.\n"
+ " rm FILE Delete FILE.\n"
+ "Use these actions indirectly via `pintos' -g and -p options:\n"
+ " put FILE Put FILE into file system from scratch disk.\n"
+ " get FILE Get FILE from file system into scratch disk.\n"
+#endif
+ "\nOptions:\n"
+ " -h Print this help message and power off.\n"
+ " -q Power off VM after actions or on panic.\n"
+ " -f Format file system disk during startup.\n"
+ " -rs=SEED Set random number seed to SEED.\n"
+ " -mlfqs Use multi-level feedback queue scheduler.\n"
+#ifdef USERPROG
+ " -ul=COUNT Limit user memory to COUNT pages.\n"
+#endif
+ );
+ power_off ();
+}
+
+
+/* Powers down the machine we're running on,
+ as long as we're running on Bochs or QEMU. */
+void
+power_off (void)
+{
+ const char s[] = "Shutdown";
+ const char *p;
+
+#ifdef FILESYS
+ filesys_done ();
#endif
+
+ print_stats ();
+
+ printf ("Powering off...\n");
+ serial_flush ();
+
+ for (p = s; *p != '\0'; p++)
+ outb (0x8900, *p);
+ asm ("cli; hlt");
+ printf ("still running...\n");
+ for (;;);
+}
+
+/* Print statistics about Pintos execution. */
+static void
+print_stats (void)
+{
+ timer_print_stats ();
+ thread_print_stats ();
#ifdef FILESYS
- " -f Format the filesystem disk (hdb or hd0:1).\n"
- " -cp FILENAME:SIZE Copy SIZE bytes from the scratch disk (hdc\n"
- " or hd1:0) into the filesystem as FILENAME\n"
- " -p FILENAME Print the contents of FILENAME\n"
- " -r FILENAME Delete FILENAME\n"
- " -ls List the files in the filesystem\n"
- " -D Dump complete filesystem contents\n");
-#endif
- }
- else
- PANIC ("unknown option `%s'", argv[i]);
+ disk_print_stats ();
+#endif
+ console_print_stats ();
+ kbd_print_stats ();
+#ifdef USERPROG
+ exception_print_stats ();
+#endif
}