Make processes responsible for loading themselves.
[pintos-anon] / src / threads / thread.c
index bae893d5f872d70f1cce8803fe03bf9e2fc62846..fc358de69a4fe6a3cab2dff5dc594d43515d242c 100644 (file)
-#include "thread.h"
+#include "threads/thread.h"
+#include <debug.h>
 #include <stddef.h>
-#include "debug.h"
-#include "interrupt.h"
-#include "intr-stubs.h"
-#include "lib.h"
-#include "mmu.h"
-#include "palloc.h"
-#include "random.h"
-#include "switch.h"
+#include <random.h>
+#include <stdio.h>
+#include <string.h>
+#include "threads/flags.h"
+#include "threads/interrupt.h"
+#include "threads/intr-stubs.h"
+#include "threads/mmu.h"
+#include "threads/palloc.h"
+#include "threads/switch.h"
+#include "threads/synch.h"
+#ifdef USERPROG
+#include "userprog/addrspace.h"
+#include "userprog/gdt.h"
+#endif
 
-/* Offset of `stack' member within `struct thread'.
-   Used by switch.S, which can't figure it out on its own. */
-uint32_t thread_stack_ofs = offsetof (struct thread, stack);
+/* Random value for struct thread's `magic' member.
+   Used to detect stack overflow.  See the big comment at the top
+   of thread.h for details. */
+#define THREAD_MAGIC 0xcd6abf4b
 
 /* List of processes in THREAD_READY state, that is, processes
    that are ready to run but not actually running. */
-static struct list run_queue;
+static struct list ready_list;
 
-/* Thread to run when nothing else is ready. */
+/* Idle thread. */
 static struct thread *idle_thread;
 
-static struct thread *find_next_to_run (void);
-
-/* Idle thread.  Executes when no other thread is ready to run. */
-static void
-idle (void *aux UNUSED) 
-{
-  for (;;) 
-    {
-      /* Wait for an interrupt. */
-      DEBUG (idle, "idle");
-      asm ("hlt");
-
-      /* Let someone else run. */
-      intr_disable ();
-      thread_sleep ();
-      intr_enable ();
-    }
-}
-
-/* Initializes the threading system and starts an initial thread
-   which is immediately scheduled.  Never returns to the caller.
-   The initial thread is named NAME and executes FUNCTION passing
-   AUX as the argument. */
-void
-thread_init (void) 
-{
-  ASSERT (intr_get_level () == IF_OFF);
-
-  /* Initialize run queue. */
-  list_init (&run_queue);
-
-  /* Create idle thread. */
-  idle_thread = thread_create ("idle", idle, NULL);
-  idle_thread->status = THREAD_BLOCKED;
-}
+/* Initial thread, the thread running init.c:main(). */
+static struct thread *initial_thread;
 
-void
-thread_start (void) 
-{
-  struct thread *t = find_next_to_run ();
-  if (t->status == THREAD_READY)
-    list_remove (&t->rq_elem);
-  t->status = THREAD_RUNNING;
-  switch_threads (NULL, t);
+/* Lock used by allocate_tid(). */
+static struct lock tid_lock;
 
-  NOT_REACHED ();
-}
-\f
 /* Stack frame for kernel_thread(). */
 struct kernel_thread_frame 
   {
     void *eip;                  /* Return address. */
-    void (*function) (void *);  /* Function to call. */
+    thread_func *function;      /* Function to call. */
     void *aux;                  /* Auxiliary data for function. */
   };
 
-/* Function used as the basis for a kernel thread. */
-static void
-kernel_thread (void (*function) (void *aux), void *aux) 
-{
-  ASSERT (function != NULL);
+static void kernel_thread (thread_func *, void *aux);
+
+static void idle (void *aux UNUSED);
+static struct thread *running_thread (void);
+static struct thread *next_thread_to_run (void);
+static struct thread *new_thread (const char *name, int priority);
+static void init_thread (struct thread *, const char *name, int priority);
+static bool is_thread (struct thread *);
+static void *alloc_frame (struct thread *, size_t size);
+static void destroy_thread (struct thread *);
+static void schedule (void);
+void schedule_tail (struct thread *prev);
+static tid_t allocate_tid (void);
 
-  intr_enable ();       /* The scheduler runs with interrupts off. */
-  function (aux);       /* Execute the thread function. */
-  thread_exit ();       /* If function() returns, kill the thread. */
-}
+/* Initializes the threading system by transforming the code
+   that's currently running into a thread.  Note that this is
+   possible only because the loader was careful to put the bottom
+   of the stack at a page boundary; it won't work in general.
+   Also initializes the run queue.
 
-/* Creates a new thread named NAME and initializes its fields.
-   Returns the new thread if successful or a null pointer on
-   failure. */
-static struct thread *
-new_thread (const char *name
+   After calling this function, be sure to initialize the page
+   allocator before trying to create any threads with
+   thread_create(). */
+void
+thread_init (void
 {
-  struct thread *t;
+  ASSERT (intr_get_level () == INTR_OFF);
 
-  ASSERT (name != NULL);
-  
-  t = palloc_get (PAL_ZERO);
-  if (t != NULL)
-    {
-      strlcpy (t->name, name, sizeof t->name);
-      t->stack = (uint8_t *) t + PGSIZE;
-      t->status = THREAD_INITIALIZING;
-    }
-  
-  return t;
+  lock_init (&tid_lock, "tid");
+
+  /* Set up a thread structure for the running thread. */
+  initial_thread = running_thread ();
+  init_thread (initial_thread, "main", PRI_DEFAULT);
+  initial_thread->status = THREAD_RUNNING;
+  initial_thread->tid = allocate_tid ();
+
+  /* Initialize run queue. */
+  list_init (&ready_list);
 }
 
-/* Allocates a SIZE-byte frame within thread T's stack and
-   returns a pointer to the frame's base. */
-static void *
-alloc_frame (struct thread *t, size_t size
+/* Starts preemptive thread scheduling by enabling interrupts.
+   Also creates the idle thread. */
+void
+thread_start (void
 {
-  /* Stack data is always allocated in word-size units. */
-  ASSERT (size % sizeof (uint32_t) == 0);
-
-  t->stack -= size;
-  return t->stack;
+  thread_create ("idle", PRI_DEFAULT, idle, NULL);
+  intr_enable ();
 }
 
-/* Creates a new kernel thread named NAME, which executes
-   FUNCTION passing AUX as the argument.  The thread is added to
-   the ready queue.  Thus, it may be scheduled even before
-   thread_create() returns.  If you need to ensure ordering, then
-   use synchronization, such as a semaphore. */
-struct thread *
-thread_create (const char *name, void (*function) (void *aux), void *aux) 
+/* Creates a new kernel thread named NAME with the given initial
+   PRIORITY, which executes FUNCTION passing AUX as the argument,
+   and adds it to the ready queue.  If thread_start() has been
+   called, then the new thread may be scheduled before
+   thread_create() returns.  It could even exit before
+   thread_create() returns.  Use a semaphore or some other form
+   of synchronization if you need to ensure ordering.  Returns
+   the thread identifier for the new thread, or TID_ERROR if
+   creation fails.
+
+   The code provided sets the new thread's `priority' member to
+   PRIORITY, but no actual priority scheduling is implemented.
+   Priority scheduling is the goal of Problem 1-3. */
+tid_t
+thread_create (const char *name, int priority,
+               thread_func *function, void *aux) 
 {
   struct thread *t;
   struct kernel_thread_frame *kf;
   struct switch_entry_frame *ef;
   struct switch_threads_frame *sf;
+  tid_t tid;
 
   ASSERT (function != NULL);
 
-  t = new_thread (name);
+  t = new_thread (name, priority);
+  if (t == NULL)
+    return TID_ERROR;
+  tid = t->tid;
 
   /* Stack frame for kernel_thread(). */
   kf = alloc_frame (t, sizeof *kf);
@@ -152,161 +136,301 @@ thread_create (const char *name, void (*function) (void *aux), void *aux)
   sf->eip = switch_entry;
 
   /* Add to run queue. */
-  thread_ready (t);
+  thread_unblock (t);
 
-  return t;
+  return tid;
 }
 
+/* Transitions a blocked thread T from its current state to the
+   ready-to-run state.  This is an error if T is not blocked.
+   (Use thread_yield() to make the running thread ready.) */
+void
+thread_unblock (struct thread *t) 
+{
+  enum intr_level old_level;
+
+  ASSERT (is_thread (t));
+
+  old_level = intr_disable ();
+  ASSERT (t->status == THREAD_BLOCKED);
+  list_push_back (&ready_list, &t->elem);
+  t->status = THREAD_READY;
+  intr_set_level (old_level);
+}
+
+/* Returns the name of the running thread. */
+const char *
+thread_name (void) 
+{
+  return thread_current ()->name;
+}
+
+/* Returns the running thread.
+   This is running_thread() plus a couple of sanity checks.
+   See the big comment at the top of thread.h for details. */
 struct thread *
 thread_current (void) 
 {
-  uint32_t *esp;
-  asm ("movl %%esp, %0\n" : "=g" (esp));
-  return pg_round_down (esp);
+  struct thread *t = running_thread ();
+  
+  /* Make sure T is really a thread.
+     If either of these assertions fire, then your thread may
+     have overflowed its stack.  Each thread has less than 4 kB
+     of stack, so a few big automatic arrays or moderate
+     recursion can cause stack overflow. */
+  ASSERT (is_thread (t));
+  ASSERT (t->status == THREAD_RUNNING);
+
+  return t;
 }
 
-#ifdef USERPROG
-bool
-thread_execute (const char *filename
+/* Returns the running thread's tid. */
+tid_t
+thread_tid (void
 {
-  struct thread *t;
-  struct intr_frame *if_;
-  struct switch_entry_frame *ef;
-  struct switch_threads_frame *sf;
-  void (*start) (void);
+  return thread_current ()->tid;
+}
 
-  ASSERT (filename != NULL);
+/* Deschedules the current thread and destroys it.  Never
+   returns to the caller. */
+void
+thread_exit (void) 
+{
+  ASSERT (!intr_context ());
 
-  t = new_thread (filename);
-  if (t == NULL)
-    return false;
+  /* Just set our status to dying and schedule another process.
+     We will be destroyed during the call to schedule_tail(). */
+  intr_disable ();
+  thread_current ()->status = THREAD_DYING;
+  schedule ();
+  NOT_REACHED ();
+}
+
+/* Yields the CPU.  The current thread is not put to sleep and
+   may be scheduled again immediately at the scheduler's whim. */
+void
+thread_yield (void) 
+{
+  struct thread *cur = thread_current ();
+  enum intr_level old_level;
   
-  if (!addrspace_load (&t->addrspace, filename, &start)) 
-    PANIC ("%s: program load failed", filename);
-
-  /* Interrupt frame. */
-  if_ = alloc_frame (t, sizeof *if_);
-  if_->es = SEL_UDSEG;
-  if_->ds = SEL_UDSEG;
-  if_->eip = start;
-  if_->cs = SEL_UCSEG;
-  if_->eflags = FLAG_IF | 2;
-  if_->esp = PHYS_BASE;
-  if_->ss = SEL_UDSEG;
+  ASSERT (!intr_context ());
 
-  /* Stack frame for switch_entry(). */
-  ef = alloc_frame (t, sizeof *ef);
-  ef->eip = intr_exit;
+  old_level = intr_disable ();
+  list_push_back (&ready_list, &cur->elem);
+  cur->status = THREAD_READY;
+  schedule ();
+  intr_set_level (old_level);
+}
 
-  /* Stack frame for switch_threads(). */
-  sf = alloc_frame (t, sizeof *sf);
-  sf->eip = switch_entry;
+/* Puts the current thread to sleep.  It will not be scheduled
+   again until awoken by thread_unblock().
 
-  /* Add to run queue. */
-  thread_ready (t);
+   This function must be called with interrupts turned off.  It
+   is usually a better idea to use one of the synchronization
+   primitives in synch.h. */
+void
+thread_block (void) 
+{
+  ASSERT (!intr_context ());
+  ASSERT (intr_get_level () == INTR_OFF);
 
-  return true;
+  thread_current ()->status = THREAD_BLOCKED;
+  schedule ();
 }
-#endif
+\f
+/* Idle thread.  Executes when no other thread is ready to run. */
+static void
+idle (void *aux UNUSED) 
+{
+  idle_thread = thread_current ();
 
-void
-thread_ready (struct thread *t) 
+  for (;;) 
+    {
+      /* Let someone else run. */
+      intr_disable ();
+      thread_block ();
+      intr_enable ();
+
+      /* Use CPU `hlt' instruction to wait for interrupt. */
+      asm ("hlt");
+    }
+}
+
+/* Function used as the basis for a kernel thread. */
+static void
+kernel_thread (thread_func *function, void *aux) 
+{
+  ASSERT (function != NULL);
+
+  intr_enable ();       /* The scheduler runs with interrupts off. */
+  function (aux);       /* Execute the thread function. */
+  thread_exit ();       /* If function() returns, kill the thread. */
+}
+\f
+/* Returns the running thread. */
+struct thread *
+running_thread (void) 
 {
-  if (t->status != THREAD_READY) 
+  uint32_t *esp;
+
+  /* Copy the CPU's stack pointer into `esp', and then round that
+     down to the start of a page.  Because `struct thread' is
+     always at the beginning of a page and the stack pointer is
+     somewhere in the middle, this locates the curent thread. */
+  asm ("movl %%esp, %0\n" : "=g" (esp));
+  return pg_round_down (esp);
+}
+
+/* Returns true if T appears to point to a valid thread. */
+static bool
+is_thread (struct thread *t) 
+{
+  return t != NULL && t->magic == THREAD_MAGIC;
+}
+
+/* Creates a new thread named NAME as a child of the running
+   thread.  Returns the new thread if successful or a null
+   pointer on failure. */
+static struct thread *
+new_thread (const char *name, int priority)
+{
+  struct thread *t = palloc_get (PAL_ZERO);
+  if (t != NULL) 
     {
-      list_push_back (&run_queue, &t->rq_elem);
-      t->status = THREAD_READY;
+      init_thread (t, name, priority);
+      t->tid = allocate_tid ();
     }
+
+  return t;
 }
 
+/* Does basic initialization of T as a blocked thread named
+   NAME. */
+static void
+init_thread (struct thread *t, const char *name, int priority)
+{
+  ASSERT (t != NULL);
+  ASSERT (PRI_MIN <= priority && priority <= PRI_MAX);
+  ASSERT (name != NULL);
+
+  memset (t, 0, sizeof *t);
+  t->status = THREAD_BLOCKED;
+  strlcpy (t->name, name, sizeof t->name);
+  t->stack = (uint8_t *) t + PGSIZE;
+  t->priority = priority;
+  t->magic = THREAD_MAGIC;
+}
+
+/* Allocates a SIZE-byte frame at the top of thread T's stack and
+   returns a pointer to the frame's base. */
+static void *
+alloc_frame (struct thread *t, size_t size) 
+{
+  /* Stack data is always allocated in word-size units. */
+  ASSERT (is_thread (t));
+  ASSERT (size % sizeof (uint32_t) == 0);
+
+  t->stack -= size;
+  return t->stack;
+}
+
+/* Chooses and returns the next thread to be scheduled.  Should
+   return a thread from the run queue, unless the run queue is
+   empty.  (If the running thread can continue running, then it
+   will be in the run queue.)  If the run queue is empty, return
+   idle_thread. */
 static struct thread *
-find_next_to_run (void) 
+next_thread_to_run (void) 
 {
-  if (list_empty (&run_queue))
+  if (list_empty (&ready_list))
     return idle_thread;
   else
-    return list_entry (list_pop_front (&run_queue), struct thread, rq_elem);
+    return list_entry (list_pop_front (&ready_list), struct thread, elem);
 }
 
-void
-thread_destroy (struct thread *t) 
+/* Destroys T, which must not be the running thread. */
+static void
+destroy_thread (struct thread *t) 
 {
-  ASSERT (t->status == THREAD_DYING);
+  ASSERT (is_thread (t));
   ASSERT (t != thread_current ());
 
-  palloc_free (t);
+#ifdef USERPROG
+  addrspace_destroy (t);
+#endif
+  if (t != initial_thread)
+    palloc_free (t);
 }
 
-void schedule_tail (struct thread *prev);
+/* Completes a thread switch by activating the new thread's page
+   tables, and, if the previous thread is dying, destroying it.
 
+   At this function's invocation, we just switched from thread
+   PREV, the new thread is already running, and interrupts are
+   still disabled.  This function is normally invoked by
+   thread_schedule() as its final action before returning, but
+   the first time a thread is scheduled it is called by
+   switch_entry() (see switch.S).
+
+   After this function and its caller returns, the thread switch
+   is complete. */
 void
 schedule_tail (struct thread *prev) 
 {
-  ASSERT (intr_get_level () == IF_OFF);
+  struct thread *cur = running_thread ();
+  
+  ASSERT (intr_get_level () == INTR_OFF);
+
+  /* Mark us as running. */
+  cur->status = THREAD_RUNNING;
 
 #ifdef USERPROG
-  addrspace_activate (&thread_current ()->addrspace);
+  /* Activate the new address space. */
+  addrspace_activate ();
 #endif
 
+  /* If the thread we switched from is dying, destroy it.
+     This must happen late because it's not a good idea to
+     e.g. destroy the page table you're currently using. */
   if (prev != NULL && prev->status == THREAD_DYING) 
-    thread_destroy (prev);
+    destroy_thread (prev);
 }
 
+/* Schedules a new process.  At entry, interrupts must be off and
+   the running process's state must have been changed from
+   running to some other state.  This function finds another
+   thread to run and switches to it. */
 static void
-thread_schedule (void) 
+schedule (void) 
 {
-  struct thread *cur, *next, *prev;
+  struct thread *cur = running_thread ();
+  struct thread *next = next_thread_to_run ();
+  struct thread *prev = NULL;
 
-  ASSERT (intr_get_level () == IF_OFF);
-
-  cur = thread_current ();
+  ASSERT (intr_get_level () == INTR_OFF);
   ASSERT (cur->status != THREAD_RUNNING);
+  ASSERT (is_thread (next));
 
-  next = find_next_to_run ();
-
-  next->status = THREAD_RUNNING;
   if (cur != next)
-    {
-      prev = switch_threads (cur, next);
-
-      /* Prevent GCC from reordering anything around the thread
-         switch. */
-      asm volatile ("" : : : "memory");
-
-      schedule_tail (prev); 
-    }
+    prev = switch_threads (cur, next);
+  schedule_tail (prev); 
 }
 
-void
-thread_yield (void) 
+/* Returns a tid to use for a new thread. */
+static tid_t
+allocate_tid (void) 
 {
-  enum if_level old_level;
-  
-  ASSERT (!intr_context ());
-
-  old_level = intr_disable ();
-  thread_ready (thread_current ());
-  thread_schedule ();
-  intr_set_level (old_level);
-}
-
-void
-thread_exit (void) 
-{
-  ASSERT (!intr_context ());
+  static tid_t next_tid = 1;
+  tid_t tid;
 
-  intr_disable ();
-  thread_current ()->status = THREAD_DYING;
-  thread_schedule ();
-  NOT_REACHED ();
-}
+  lock_acquire (&tid_lock);
+  tid = next_tid++;
+  lock_release (&tid_lock);
 
-void
-thread_sleep (void) 
-{
-  ASSERT (!intr_context ());
-  ASSERT (intr_get_level () == IF_OFF);
-
-  thread_current ()->status = THREAD_BLOCKED;
-  thread_schedule ();
+  return tid;
 }
+\f
+/* Offset of `stack' member within `struct thread'.
+   Used by switch.S, which can't figure it out on its own. */
+uint32_t thread_stack_ofs = offsetof (struct thread, stack);