From dcc3b1bc434d3c91e9a7d4728d120797b522b59d Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Wed, 22 Sep 2004 00:26:04 +0000 Subject: [PATCH] Update docs. --- doc/debug.texi | 1 + doc/filesys.texi | 3 ++ doc/standards.texi | 5 +++ doc/threads.texi | 4 +++ doc/userprog.texi | 80 +++++++++++++++++++++++++++++++++++----------- doc/vm.texi | 3 ++ 6 files changed, 78 insertions(+), 18 deletions(-) diff --git a/doc/debug.texi b/doc/debug.texi index 01abcda..754f5bc 100644 --- a/doc/debug.texi +++ b/doc/debug.texi @@ -11,6 +11,7 @@ introduces you to a few of them. * Backtraces:: * i386-elf-gdb:: * Modifying Bochs:: +* Debugging Tips:: @end menu @node printf diff --git a/doc/filesys.texi b/doc/filesys.texi index 804c5a7..7f739bf 100644 --- a/doc/filesys.texi +++ b/doc/filesys.texi @@ -21,6 +21,9 @@ parts work together so that you can run VM and your filesystem at the same time. Plus, keeping VM is a great way to stress-test your filesystem implementation. +Your submission should define @code{THREAD_JOIN_IMPLEMENTED} in +@file{constants.h} (@pxref{Conditional Compilation}). + FIXME FIXME FIXME The first step is to understand the default filesystem provided by the base code. diff --git a/doc/standards.texi b/doc/standards.texi index 1434a63..60aa21a 100644 --- a/doc/standards.texi +++ b/doc/standards.texi @@ -64,6 +64,11 @@ compile properly without the need for any new macros to be defined. There are a few exceptions: @itemize @bullet +@item +Problem 1-2, @code{thread_join()}. Some other code expects +@code{THREAD_JOIN_IMPLEMENTED} to be defined once you've implemented +this function. + @item Problem 1-4, the advanced scheduler. We must be able to turn this on and off with a compile time directive. You must use the macro name we diff --git a/doc/threads.texi b/doc/threads.texi index 2e779ee..5aaa732 100644 --- a/doc/threads.texi +++ b/doc/threads.texi @@ -321,6 +321,10 @@ join works for. Don't overdo the output volume, please! Be careful to program this function correctly. You will need its functionality for project 2. +Once you've implemented @code{thread_join()}, define +@code{THREAD_JOIN_IMPLEMENTED} in @file{constants.h}. +@xref{Conditional Compilation}, for more information. + @node Problem 1-3 Priority Scheduling @section Problem 1-3: Priority Scheduling diff --git a/doc/userprog.texi b/doc/userprog.texi index 14fa118..a729418 100644 --- a/doc/userprog.texi +++ b/doc/userprog.texi @@ -15,7 +15,9 @@ other part of the code for this assignment. We will describe the relevant parts below. If you are confident in your HW1 code, you can build on top of it. However, if you wish you can start with a fresh copy of the code and re-implement @code{thread_join()}, which is the -only part of project #1 required for this assignment. +only part of project #1 required for this assignment. Your submission +should define @code{THREAD_JOIN_IMPLEMENTED} in @file{constants.h} +(@pxref{Conditional Compilation}). Up to now, all of the code you have written for Pintos has been part of the operating system kernel. This means, for example, that all the @@ -39,6 +41,7 @@ in place. This will stop the tests from being run. * Project 2 Code:: * Using the File System:: * How User Programs Work:: +* Virtual Memory Layout:: * Global Requirements:: * Problem 2-1 Argument Passing:: * Problem 2-2 System Calls:: @@ -444,23 +447,64 @@ same process, or you can use a more complex mapping. It's up to you. @b{I can't seem to figure out how to read from and write to user memory. What should I do?} -The kernel must treat user memory delicately. The user can pass a -null pointer or an invalid pointer (one that doesn't point to any -memory at all), or a kernel pointer (above @code{PHYS_BASE}). All of -these must be rejected without harm to the kernel or other running -processes. - -There are at least two reasonable ways to access user memory. First, -you can translate user addresses (below @code{PHYS_BASE}) into kernel -addresses (above @code{PHYS_BASE}) using the functions in -@file{pagedir.c}, and then access kernel memory. Second, you can -dereference user pointers directly and handle page faults by -terminating the process. In either case, you'll need to reject kernel -pointers as a special case. - -If you choose to translate user addresses into kernel addresses, -you'll want to look at @file{threads/mmu.h}, which has all kinds of -useful functions for manipulating virtual addresses. +The kernel must treat user memory delicately. As part of a system +call, the user can pass to the kernel a null pointer, a pointer to +unmapped virtual memory, or a pointer to kernel virtual address space +(above @code{PHYS_BASE}). All of these types of invalid pointers must +be rejected without harm to the kernel or other running processes. At +your option, the kernel may handle invalid pointers by terminating the +process or returning from the system call with an error. + +There are at least two reasonable ways to do this correctly. The +first method is to ``verify then access'':@footnote{These terms are +made up for this document. They are not standard terminology.} verify +the validity of a user-provided pointer, then dereference it. If you +choose this route, you'll want to look at the functions in +@file{userprog/pagedir.c} and in @file{threads/mmu.h}. This is the +simplest way to handle user memory access. + +The second method is to ``assume and react'': directly dereference +user pointers, after checking that they point below @code{PHYS_BASE}. +Invalid user pointers will then cause a ``page fault'' that you can +handle by modifying the code for @code{page_fault()} in +@file{userprog/exception.cc}. This technique is normally faster +because it takes advantage of the processor's MMU, so it tends to be +used in real kernels (including Linux). + +In either case, you need to make sure not to ``leak'' resources. For +example, suppose that your system call has acquired a lock or +allocated a page of memory. If you encounter an invalid user pointer +afterward, you must still be sure to release the lock or free the page +of memory. If you choose to ``verify then access,'' then this should +be straightforward, but for ``assume and react'' it's more difficult, +because there's no way to return an error code from a memory access. +Therefore, for those who want to try the latter technique, we'll +provide a little bit of helpful code: + +@example +/* Tries to copy a byte from user address USRC to kernel address DST. + Returns true if successful, false if USRC is invalid. */ +static inline bool get_user (uint8_t *dst, const uint8_t *usrc) @{ + int eax; + asm ("movl $1f, %%eax; movb %2, %%al; movb %%al, %0; 1:" + : "=m" (*dst), "=&a" (eax) : "m" (*usrc)); + return eax != 0; +@} + +/* Tries write BYTE to user address UDST. + Returns true if successful, false if UDST is invalid. */ +static inline bool put_user (uint8_t *udst, uint8_t byte) @{ + int eax; + asm ("movl $1f, %%eax; movb %b2, %0; 1:" + : "=m" (*udst), "=&a" (eax) : "r" (byte)); + return eax != 0; +@} +@end example + +Each of these functions assumes that the user address has already been +verified to be below @code{PHYS_BASE}. They also assume that you've +modified @code{page_fault()} so that a page fault in the kernel causes +@code{eax} to be set to 0 and its former value copied into @code{eip}. @item @b{I'm also confused about reading from and writing to the stack. Can diff --git a/doc/vm.texi b/doc/vm.texi index 85605cc..5226e63 100644 --- a/doc/vm.texi +++ b/doc/vm.texi @@ -25,6 +25,9 @@ All the test programs from the previous project should also work with this project. You should also write programs to test the new features introduced in this project. +Your submission should define @code{THREAD_JOIN_IMPLEMENTED} in +@file{constants.h} (@pxref{Conditional Compilation}). + @menu * VM Design:: * Page Faults:: -- 2.30.2