Use standard POSIX "ustar" format for the scratch disk.
[pintos-anon] / src / threads / init.c
index 63ec7fa94a36ffe3f0d027d21f3f1eedd1b84096..bb7e3017588db779fe8f6e13036f1499ac632769 100644 (file)
-#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 "devices/rtc.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 "devices/disk.h"
+#include "filesys/filesys.h"
+#include "filesys/fsutil.h"
 #endif
 
-/* Size of kernel static code and data, in 4 kB pages. */
-size_t kernel_pages;
-
 /* Amount of physical memory, in 4 kB pages. */
 size_t ram_pages;
 
-static void ram_init (void);
-static void gdt_init (void);
-static void argv_init (void);
-void power_off (void);
-
-static void
-main_thread (void *aux UNUSED) 
-{
-  disk_init ();
+/* Page directory with kernel mappings only. */
+uint32_t *base_page_dir;
 
 #ifdef FILESYS
-  filesys_init (true);
+/* -f: Format the file system? */
+static bool format_filesys;
 #endif
-  filesys_self_test ();
-}
 
+/* -q: Power off after kernel tasks complete? */
+bool power_off_when_done;
+
+static void ram_init (void);
+static void paging_init (void);
+
+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);
+
+
+int main (void) NO_RETURN;
+
+/* Pintos main program. */
 int
 main (void)
 {
-  struct thread *t;
-
-  /* Initialize components needed by printk() very early. */
+  char **argv;
+  
+  /* Clear BSS and get machine's RAM size. */  
   ram_init ();
-  vga_init ();
-  serial_init ();
-  printk ("Booting cnachos86...\n");
-
-  /* Calculate how much RAM the kernel uses, and find out from
-     the bootloader how much RAM this machine has. */
-  printk ("ram: detected %'d kB main memory.\n", ram_pages * 4);
-
-  /* Memory from the end of the kernel through the end of memory
-     is free.  Give it to the page allocator. */
-  palloc_init (ptov (LOADER_KERN_BASE + kernel_pages * PGSIZE),
-               ptov (ram_pages * PGSIZE));
-  paging_init ();
-  gdt_init ();
 
+  /* Break command line into arguments and parse options. */
+  argv = read_command_line ();
+  argv = parse_options (argv);
+
+  /* Initialize ourselves as a thread so we can use locks,
+     then enable console locking. */
+  thread_init ();
+  console_init ();  
+
+  /* Greet user. */
+  printf ("Pintos booting with %'zu kB RAM...\n", ram_pages * PGSIZE / 1024);
+
+  /* Initialize memory system. */
+  palloc_init ();
   malloc_init ();
-  random_init ();
+  paging_init ();
 
-  argv_init ();
+  /* 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
 
-  thread_init ();
+  /* Start thread scheduler and enable interrupts. */
+  thread_start ();
+  serial_init_queue ();
+  timer_calibrate ();
 
-  t = thread_create ("main", main_thread, NULL);
-  thread_start (t);
+#ifdef FILESYS
+  /* Initialize file system. */
+  disk_init ();
+  filesys_init (format_filesys);
+#endif
 
-  printk ("Done!\n");
-  return 0;
-}
+  printf ("Boot complete.\n");
+  
+  /* Run actions specified on kernel command line. */
+  run_actions (argv);
 
-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)
+  /* 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) 
 {
-  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);
+  /* The "BSS" is a segment that should be initialized to zeros.
+     It isn't actually stored on disk or zeroed by the kernel
+     loader, so we have to zero it ourselves.
+
+     The start and end of the BSS segment is recorded by the
+     linker as _start_bss and _end_bss.  See kernel.lds. */
+  extern char _start_bss, _end_bss;
+  memset (&_start_bss, 0, &_end_bss - &_start_bss);
+
+  /* Get RAM size from loader.  See loader.S. */
+  ram_pages = *(uint32_t *) ptov (LOADER_RAM_PGS);
 }
 
-static uint64_t
-make_code_desc (int dpl)
+/* 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
+paging_init (void)
 {
-  return make_seg_desc (0, 0xfffff, SYS_CODE_DATA, TYPE_CODE | TYPE_READABLE,
-                        dpl, GRAN_PAGE);
+  uint32_t *pd, *pt;
+  size_t page;
+  extern char _start, _end_kernel_text;
+
+  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;
+      char *vaddr = ptov (paddr);
+      size_t pde_idx = pd_no (vaddr);
+      size_t pte_idx = pt_no (vaddr);
+      bool in_kernel_text = &_start <= vaddr && vaddr < &_end_kernel_text;
+
+      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, !in_kernel_text);
+    }
+
+  /* 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)));
 }
 
-static uint64_t
-make_data_desc (int dpl)
+/* Breaks the kernel command line into words and returns them as
+   an argv-like array. */
+static char **
+read_command_line (void) 
 {
-  return make_seg_desc (0, 0xfffff, SYS_CODE_DATA, TYPE_WRITABLE,
-                        dpl, GRAN_PAGE);
+  static char *argv[LOADER_ARGS_LEN / 2 + 1];
+  char *p, *end;
+  int argc;
+  int i;
+
+  argc = *(uint32_t *) ptov (LOADER_ARG_CNT);
+  p = ptov (LOADER_ARGS);
+  end = p + LOADER_ARGS_LEN;
+  for (i = 0; i < argc; i++) 
+    {
+      if (p >= end)
+        PANIC ("command line arguments overflow");
+
+      argv[i] = p;
+      p += strnlen (p, end - p) + 1;
+    }
+  argv[argc] = NULL;
+
+  /* Print kernel command line. */
+  printf ("Kernel command line:");
+  for (i = 0; i < argc; i++)
+    if (strchr (argv[i], ' ') == NULL)
+      printf (" %s", argv[i]);
+    else
+      printf (" '%s'", argv[i]);
+  printf ("\n");
+
+  return argv;
 }
 
-static uint64_t
-make_tss_desc (void *vaddr)
+/* Parses options in ARGV[]
+   and returns the first non-option argument. */
+static char **
+parse_options (char **argv) 
 {
-  return make_seg_desc ((uint32_t) vaddr,
-                        0x67, SYS_SYSTEM, TYPE_TSS_32_A, 0, GRAN_BYTE);
-}
+  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"))
+        thread_mlfqs = true;
+#ifdef USERPROG
+      else if (!strcmp (name, "-ul"))
+        user_page_limit = atoi (value);
+#endif
+      else
+        PANIC ("unknown option `%s' (use -h for help)", name);
+    }
 
-uint64_t gdt[SEL_CNT];
+  /* Initialize the random number generator based on the system
+     time.  This has no effect if an "-rs" option was specified.
 
-struct tss *tss;
+     When running under Bochs, this is not enough by itself to
+     get a good seed value, because the pintos script sets the
+     initial time to a predictable value, not to the local time,
+     for reproducibility.  To fix this, give the "-r" option to
+     the pintos script to request real-time execution. */
+  random_init (rtc_get_time ());
+  
+  return argv;
+}
 
-/* Sets up a proper GDT.  The bootstrap loader's GDT didn't
-   include user-mode selectors or a TSS. */
+/* Runs the task specified in ARGV[1]. */
 static void
-gdt_init (void)
+run_task (char **argv)
 {
-  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));
+  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
-ram_init (void
+run_actions (char **argv
 {
-  /* Start and end of kernel image,
-     and start and end of BSS segment.
-     These are created by kernel.lds. */
-  extern char _start, _end;
-  extern char _start_bss, _end_bss;
+  /* An action. */
+  struct action 
+    {
+      char *name;                       /* Action name. */
+      int argc;                         /* # of args, including action name. */
+      void (*function) (char **argv);   /* Function to execute action. */
+    };
 
-  /* The "BSS" is a segment that should be initialized to zeros.
-     It isn't actually stored on disk or zeroed by the kernel
-     loader, so we have to zero it ourselves. */
-  memset (&_start_bss, 0, &_end_bss - &_start_bss);
+  /* Table of supported actions. */
+  static const struct action actions[] = 
+    {
+      {"run", 2, run_task},
+#ifdef FILESYS
+      {"ls", 1, fsutil_ls},
+      {"cat", 2, fsutil_cat},
+      {"rm", 2, fsutil_rm},
+      {"extract", 1, fsutil_extract},
+      {"append", 2, fsutil_append},
+#endif
+      {NULL, 0, NULL},
+    };
+
+  while (*argv != NULL)
+    {
+      const struct action *a;
+      int i;
 
-  /* Calculate how much RAM the kernel uses, and find out from
-     the bootloader how much RAM this machine has. */
-  kernel_pages = (&_end - &_start + 4095) / 4096;
-  ram_pages = *(uint32_t *) (LOADER_BASE + LOADER_RAM_PAGES);
+      /* 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;
+    }
+  
 }
 
-void
-argv_init (void) 
+/* 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
+          "  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"
+          "  extract            Untar from scratch disk into file system.\n"
+          "  append FILE        Append FILE to tar file on 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 ();
 }
-\f
+
+
+/* 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;
 
-  printk ("Powering off...\n");
+#ifdef FILESYS
+  filesys_done ();
+#endif
+
+  print_stats ();
+
+  printf ("Powering off...\n");
+  serial_flush ();
+
   for (p = s; *p != '\0'; p++)
     outb (0x8900, *p);
+  asm volatile ("cli; hlt" : : : "memory");
+  printf ("still running...\n");
   for (;;);
 }
+
+/* Print statistics about Pintos execution. */
+static void
+print_stats (void) 
+{
+  timer_print_stats ();
+  thread_print_stats ();
+#ifdef FILESYS
+  disk_print_stats ();
+#endif
+  console_print_stats ();
+  kbd_print_stats ();
+#ifdef USERPROG
+  exception_print_stats ();
+#endif
+}