Fix up header guards.
[pintos-anon] / src / threads / interrupt.h
index a40276a5852340ef5dd54f969c9346ba5dcca281..5060b9d90bf7d2764b2e1d4e00e785212bca3f7e 100644 (file)
@@ -1,51 +1,62 @@
-#ifndef HEADER_INTERRUPT_H
-#define HEADER_INTERRUPT_H 1
+#ifndef THREADS_INTERRUPT_H
+#define THREADS_INTERRUPT_H
 
 #include <stdbool.h>
 #include <stdint.h>
 
-enum if_level 
+/* Interrupts on or off? */
+enum intr_level 
   {
-    IF_OFF,             /* Interrupts disabled. */
-    IF_ON               /* Interrupts enabled. */
+    INTR_OFF,             /* Interrupts disabled. */
+    INTR_ON               /* Interrupts enabled. */
   };
 
-enum if_level intr_get_level (void);
-enum if_level intr_set_level (enum if_level);
-enum if_level intr_enable (void);
-enum if_level intr_disable (void);
+enum intr_level intr_get_level (void);
+enum intr_level intr_set_level (enum intr_level);
+enum intr_level intr_enable (void);
+enum intr_level intr_disable (void);
 \f
+/* Interrupt stack frame. */
 struct intr_frame
   {
-    /* Pushed by the stubs. */
-    uint32_t edi;
-    uint32_t esi;
-    uint32_t ebp;
-    uint32_t esp_dummy;
-    uint32_t ebx;
-    uint32_t edx;
-    uint32_t ecx;
-    uint32_t eax;
-    uint16_t es, :16;
-    uint16_t ds, :16;
-    uint32_t vec_no;
-
-    /* Sometimes pushed by the CPU, otherwise by the stubs. */
-    uint32_t error_code;
-
-    /* Pushed by the CPU. */
-    void (*eip) (void);
-    uint16_t cs, :16;
-    uint32_t eflags;
-    void *esp;
-    uint16_t ss, :16;
+    /* Pushed by intr_entry in intr-stubs.S (see intr-stubs.pl).
+       These are the interrupted task's saved registers. */
+    uint32_t edi;               /* Saved EDI. */
+    uint32_t esi;               /* Saved ESI. */
+    uint32_t ebp;               /* Saved EBP. */
+    uint32_t esp_dummy;         /* Not used. */
+    uint32_t ebx;               /* Saved EBX. */
+    uint32_t edx;               /* Saved EDX. */
+    uint32_t ecx;               /* Saved ECX. */
+    uint32_t eax;               /* Saved EAX. */
+    uint16_t es, :16;           /* Saved ES segment register. */
+    uint16_t ds, :16;           /* Saved DS segment register. */
+
+    /* Pushed by intrXX_stub in intr-stubs.S (see intr-stubs.pl). */
+    uint32_t vec_no;            /* Interrupt vector number. */
+
+    /* Sometimes pushed by the CPU,
+       otherwise by intrXX_stub for consistency. */
+    uint32_t error_code;        /* Error code. */
+
+    /* Pushed by the CPU.
+       These are the interrupted task's saved registers. */
+    void (*eip) (void);         /* Current or next instruction. */
+    uint16_t cs, :16;           /* Code segment for eip. */
+    uint32_t eflags;            /* Saved CPU flags. */
+    void *esp;                  /* Saved stack pointer. */
+    uint16_t ss, :16;           /* Data segment for esp. */
   };
 
 typedef void intr_handler_func (struct intr_frame *);
 
 void intr_init (void);
-void intr_register (uint8_t vec, int dpl, enum if_level, intr_handler_func *);
+void intr_register (uint8_t vec, int dpl, enum intr_level, intr_handler_func *,
+                    const char *name);
 bool intr_context (void);
 void intr_yield_on_return (void);
 
-#endif /* interrupt.h */
+void intr_dump_frame (const struct intr_frame *);
+const char *intr_name (uint8_t vec);
+
+#endif /* threads/interrupt.h */