Move pagedir stuff into userprog.
[pintos-anon] / src / threads / thread.c
index fed6b841aded48864edee8307fec6fb6090c87ae..a1c98a6c0564af07663b208f159026914080d728 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 "gdt.h"
-#include "mmu.h"
-#include "palloc.h"
-#include "random.h"
-#include "switch.h"
-
-#define THREAD_MAGIC 0x1234abcdu
+#include <random.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/gdt.h"
+#endif
+
+/* 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;
 
 /* Idle thread. */
-static struct thread *idle_thread;      /* Thread. */
-static void idle (void *aux UNUSED);    /* Thread function. */
+static struct thread *idle_thread;
+
+/* Initial thread, the thread running init.c:main(). */
+static struct thread *initial_thread;
+
+/* Lock used by allocate_tid(). */
+static struct lock tid_lock;
 
 /* 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. */
   };
 
-static void kernel_thread (void (*function) (void *aux), void *aux);
+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);
-static bool is_thread (struct thread *t);
-static void *alloc_frame (struct thread *t, size_t size);
-static void destroy_thread (struct thread *t);
+static void init_thread (struct thread *, const char *name);
+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);
 
-/* Initializes the threading system.  After calling, create some
-   threads with thread_create() or thread_execute(), then start
-   the scheduler with thread_start(). */
+/* 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.
+
+   After calling this function, be sure to initialize the page
+   allocator before trying to create any threads with
+   thread_create(). */
 void
 thread_init (void) 
 {
   ASSERT (intr_get_level () == INTR_OFF);
 
-  /* Initialize run queue. */
-  list_init (&run_queue);
+  lock_init (&tid_lock, "tid");
+
+  /* Set up a thread structure for the running thread. */
+  initial_thread = running_thread ();
+  init_thread (initial_thread, "main");
+  initial_thread->status = THREAD_RUNNING;
+  initial_thread->tid = allocate_tid ();
 
-  /* Create idle thread. */
-  idle_thread = thread_create ("idle", idle, NULL);
-  idle_thread->status = THREAD_BLOCKED;
+  /* Initialize run queue. */
+  list_init (&ready_list);
 }
 
-/* Starts the thread scheduler.  The caller should have created
-   some threads with thread_create() or thread_execute().  Never
-   returns to the caller. */
+/* Starts preemptive thread scheduling by enabling interrupts.
+   Also creates the idle thread. */
 void
 thread_start (void) 
 {
-  struct thread *t = next_thread_to_run ();
-  if (t->status == THREAD_READY)
-    list_remove (&t->rq_elem);
-  t->status = THREAD_RUNNING;
-  switch_threads (NULL, t);
-
-  NOT_REACHED ();
+  thread_create ("idle", idle, NULL);
+  intr_enable ();
 }
 
 /* Creates a new kernel thread named NAME, 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.  Use a
-   semaphore or some other form of synchronization if you need to
-   ensure ordering. */
-struct thread *
-thread_create (const char *name, void (*function) (void *aux), void *aux) 
+   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. */
+tid_t
+thread_create (const char *name, 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);
+  if (t == NULL)
+    return TID_ERROR;
+  tid = t->tid = allocate_tid ();
 
   /* Stack frame for kernel_thread(). */
   kf = alloc_frame (t, sizeof *kf);
@@ -102,9 +128,9 @@ thread_create (const char *name, void (*function) (void *aux), void *aux)
   sf->eip = switch_entry;
 
   /* Add to run queue. */
-  thread_wake (t);
+  thread_unblock (t);
 
-  return t;
+  return tid;
 }
 
 #ifdef USERPROG
@@ -112,7 +138,7 @@ thread_create (const char *name, void (*function) (void *aux), void *aux)
    FILENAME, and adds it to the ready queue.  If thread_start()
    has been called, then new thread may be scheduled before
    thread_execute() returns.*/
-bool
+tid_t
 thread_execute (const char *filename) 
 {
   struct thread *t;
@@ -120,12 +146,14 @@ thread_execute (const char *filename)
   struct switch_entry_frame *ef;
   struct switch_threads_frame *sf;
   void (*start) (void);
+  tid_t tid;
 
   ASSERT (filename != NULL);
 
   t = new_thread (filename);
   if (t == NULL)
-    return false;
+    return TID_ERROR;
+  tid = t->tid = allocate_tid ();
   
   if (!addrspace_load (t, filename, &start)) 
     PANIC ("%s: program load failed", filename);
@@ -149,59 +177,62 @@ thread_execute (const char *filename)
   sf->eip = switch_entry;
 
   /* Add to run queue. */
-  thread_wake (t);
+  thread_unblock (t);
 
-  return true;
+  return tid;
 }
 #endif
 
-/* Transitions T from its current state to THREAD_READY, the
-   ready-to-run state.  On entry, T must be ready or blocked.
+/* 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_wake (struct thread *t) 
+thread_unblock (struct thread *t) 
 {
+  enum intr_level old_level;
+
   ASSERT (is_thread (t));
-  ASSERT (t->status == THREAD_READY || t->status == THREAD_BLOCKED);
-  if (t->status != THREAD_READY) 
-    {
-      list_push_back (&run_queue, &t->rq_elem);
-      t->status = THREAD_READY;
-    }
+
+  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 thread T. */
+/* Returns the name of the running thread. */
 const char *
-thread_name (struct thread *t
+thread_name (void
 {
-  ASSERT (is_thread (t));
-  return t->name;
+  return thread_current ()->name;
 }
 
-/* Returns the running thread. */
+/* 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;
-  struct thread *t;
-
-  /* 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));
-  t = pg_round_down (esp);
-
+  struct thread *t = running_thread ();
+  
   /* Make sure T is really a thread.
-     If this assertion fires, 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. */
+     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;
 }
 
+/* Returns the running thread's tid. */
+tid_t
+thread_tid (void) 
+{
+  return thread_current ()->tid;
+}
+
 /* Deschedules the current thread and destroys it.  Never
    returns to the caller. */
 void
@@ -209,6 +240,8 @@ thread_exit (void)
 {
   ASSERT (!intr_context ());
 
+  /* 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 ();
@@ -226,16 +259,20 @@ thread_yield (void)
   ASSERT (!intr_context ());
 
   old_level = intr_disable ();
-  list_push_back (&run_queue, &cur->rq_elem);
+  list_push_back (&ready_list, &cur->elem);
   cur->status = THREAD_READY;
   schedule ();
   intr_set_level (old_level);
 }
 
 /* Puts the current thread to sleep.  It will not be scheduled
-   again until awoken by thread_wake(). */
+   again until awoken by thread_unblock().
+
+   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_sleep (void) 
+thread_block (void) 
 {
   ASSERT (!intr_context ());
   ASSERT (intr_get_level () == INTR_OFF);
@@ -248,22 +285,23 @@ thread_sleep (void)
 static void
 idle (void *aux UNUSED) 
 {
+  idle_thread = thread_current ();
+
   for (;;) 
     {
-      /* Wait for an interrupt. */
-      DEBUG (idle, "idle");
-      asm ("hlt");
-
       /* Let someone else run. */
       intr_disable ();
-      thread_sleep ();
+      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 (void (*function) (void *aux), void *aux) 
+kernel_thread (thread_func *function, void *aux) 
 {
   ASSERT (function != NULL);
 
@@ -272,6 +310,20 @@ kernel_thread (void (*function) (void *aux), void *aux)
   thread_exit ();       /* If function() returns, kill the thread. */
 }
 \f
+/* Returns the running thread. */
+struct thread *
+running_thread (void) 
+{
+  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) 
@@ -291,16 +343,22 @@ new_thread (const char *name)
   
   t = palloc_get (PAL_ZERO);
   if (t != NULL)
-    {
-      strlcpy (t->name, name, sizeof t->name);
-      t->stack = (uint8_t *) t + PGSIZE;
-      t->status = THREAD_BLOCKED;
-      t->magic = THREAD_MAGIC;
-    }
-  
+    init_thread (t, name);
+
   return t;
 }
 
+/* Initializes T as a new, blocked thread named NAME. */
+static void
+init_thread (struct thread *t, const char *name)
+{
+  memset (t, 0, sizeof *t);
+  t->status = THREAD_BLOCKED;
+  strlcpy (t->name, name, sizeof t->name);
+  t->stack = (uint8_t *) t + PGSIZE;
+  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 *
@@ -322,10 +380,10 @@ alloc_frame (struct thread *t, size_t size)
 static struct thread *
 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);
 }
 
 /* Destroys T, which must be in the dying state and must not be
@@ -337,8 +395,11 @@ destroy_thread (struct thread *t)
   ASSERT (t->status == THREAD_DYING);
   ASSERT (t != thread_current ());
 
+#ifdef USERPROG
   addrspace_destroy (t);
-  palloc_free (t);
+#endif
+  if (t != initial_thread)
+    palloc_free (t);
 }
 
 /* Completes a thread switch by activating the new thread's page
@@ -356,17 +417,23 @@ destroy_thread (struct thread *t)
 void
 schedule_tail (struct thread *prev) 
 {
-  struct thread *cur = thread_current ();
+  struct thread *cur = running_thread ();
   
   ASSERT (intr_get_level () == INTR_OFF);
 
+  /* Mark us as running. */
   cur->status = THREAD_RUNNING;
-  if (prev != NULL && prev->status == THREAD_DYING) 
-    destroy_thread (prev);
 
 #ifdef USERPROG
+  /* Activate the new address space. */
   addrspace_activate (cur);
 #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) 
+    destroy_thread (prev);
 }
 
 /* Schedules a new process.  At entry, interrupts must be off and
@@ -376,18 +443,31 @@ schedule_tail (struct thread *prev)
 static void
 schedule (void) 
 {
-  struct thread *cur = thread_current ();
+  struct thread *cur = running_thread ();
   struct thread *next = next_thread_to_run ();
+  struct thread *prev = NULL;
 
   ASSERT (intr_get_level () == INTR_OFF);
   ASSERT (cur->status != THREAD_RUNNING);
   ASSERT (is_thread (next));
 
   if (cur != next)
-    {
-      struct thread *prev = switch_threads (cur, next);
-      schedule_tail (prev); 
-    }
+    prev = switch_threads (cur, next);
+  schedule_tail (prev); 
+}
+
+/* Returns a tid to use for a new thread. */
+static tid_t
+allocate_tid (void) 
+{
+  static tid_t next_tid = 1;
+  tid_t tid;
+
+  lock_acquire (&tid_lock);
+  tid = next_tid++;
+  lock_release (&tid_lock);
+
+  return tid;
 }
 \f
 /* Offset of `stack' member within `struct thread'.