Implement a proper block layer with partition support.
[pintos-anon] / doc / vm.texi
1 @node Project 3--Virtual Memory
2 @chapter Project 3: Virtual Memory
3
4 By now you should have some familiarity with the inner workings of
5 Pintos.  Your
6 OS can properly handle multiple threads of execution with proper
7 synchronization, and can load multiple user programs at once.  However,
8 the number and size of programs that can run is limited by the machine's
9 main memory size.  In this assignment, you will remove that limitation.
10
11 You will build this assignment on top of the last one.  Test programs
12 from project 2 should also work with project 3.  You should take care to
13 fix any bugs in your project 2 submission before you start work on
14 project 3, because those bugs will most likely cause the same problems
15 in project 3.
16
17 You will continue to handle Pintos disks and file systems the same way
18 you did in the previous assignment (@pxref{Using the File System}).
19
20 @menu
21 * Project 3 Background::        
22 * Project 3 Suggested Order of Implementation::  
23 * Project 3 Requirements::      
24 * Project 3 FAQ::               
25 @end menu
26
27 @node Project 3 Background
28 @section Background
29
30 @menu
31 * Project 3 Source Files::      
32 * Memory Terminology::          
33 * Resource Management Overview::  
34 * Managing the Supplemental Page Table::  
35 * Managing the Frame Table::    
36 * Managing the Swap Table::     
37 * Managing Memory Mapped Files Back::  
38 @end menu
39
40 @node Project 3 Source Files
41 @subsection Source Files
42
43 You will work in the @file{vm} directory for this project.  The
44 @file{vm} directory contains only @file{Makefile}s.  The only
45 change from @file{userprog} is that this new @file{Makefile} turns on
46 the setting @option{-DVM}.  All code you write will be in new
47 files or in files introduced in earlier projects.
48
49 You will probably be encountering just a few files for the first time:
50
51 @table @file
52 @item devices/block.h
53 @itemx devices/block.c
54 Provides sector-based read and write access to block device.  You will
55 use this interface to access the swap partition as a block device.
56 @end table
57
58 @node Memory Terminology
59 @subsection Memory Terminology
60
61 Careful definitions are needed to keep discussion of virtual memory from
62 being confusing.  Thus, we begin by presenting some terminology for
63 memory and storage.  Some of these terms should be familiar from project
64 2 (@pxref{Virtual Memory Layout}), but much of it is new.
65
66 @menu
67 * Pages::                       
68 * Frames::                      
69 * Page Tables::                 
70 * Swap Slots::                  
71 @end menu
72
73 @node Pages
74 @subsubsection Pages
75
76 A @dfn{page}, sometimes called a @dfn{virtual page}, is a continuous
77 region of virtual memory 4,096 bytes (the @dfn{page size}) in length.  A
78 page must be @dfn{page-aligned}, that is, start on a virtual address
79 evenly divisible by the page size.  Thus, a 32-bit virtual address can
80 be divided into a 20-bit @dfn{page number} and a 12-bit @dfn{page
81 offset} (or just @dfn{offset}), like this:
82
83 @example
84 @group
85                31               12 11        0
86               +-------------------+-----------+
87               |    Page Number    |   Offset  |
88               +-------------------+-----------+
89                        Virtual Address
90 @end group
91 @end example
92
93 Each process has an independent set of @dfn{user (virtual) pages}, which
94 are those pages below virtual address @code{PHYS_BASE}, typically
95 @t{0xc0000000} (3 GB).  The set of @dfn{kernel (virtual) pages}, on the
96 other hand, is global, remaining the same regardless of what thread or
97 process is active.  The kernel may access both user and kernel pages,
98 but a user process may access only its own user pages.  @xref{Virtual
99 Memory Layout}, for more information.
100
101 Pintos provides several useful functions for working with virtual
102 addresses.  @xref{Virtual Addresses}, for details.
103
104 @node Frames
105 @subsubsection Frames
106
107 A @dfn{frame}, sometimes called a @dfn{physical frame} or a @dfn{page
108 frame}, is a continuous region of physical memory.  Like pages, frames
109 must be page-size and page-aligned.  Thus, a 32-bit physical address can
110 be divided into a 20-bit @dfn{frame number} and a 12-bit @dfn{frame
111 offset} (or just @dfn{offset}), like this:
112
113 @example
114 @group
115                31               12 11        0
116               +-------------------+-----------+
117               |    Frame Number   |   Offset  |
118               +-------------------+-----------+
119                        Physical Address
120 @end group
121 @end example
122
123 The 80@var{x}86 doesn't provide any way to directly access memory at a
124 physical address.  Pintos works around this by mapping kernel virtual
125 memory directly to physical memory: the first page of kernel virtual
126 memory is mapped to the first frame of physical memory, the second page
127 to the second frame, and so on.  Thus, frames can be accessed through
128 kernel virtual memory.  
129
130 Pintos provides functions for translating between physical addresses and
131 kernel virtual addresses.  @xref{Virtual Addresses}, for details.
132
133 @node Page Tables
134 @subsubsection Page Tables
135
136 In Pintos, a @dfn{page table} is a data structure that the CPU uses to
137 translate a virtual address to a physical address, that is, from a page
138 to a frame.  The page table format is dictated by the 80@var{x}86
139 architecture.  Pintos provides page table management code in
140 @file{pagedir.c} (@pxref{Page Table}).
141
142 The diagram below illustrates the relationship between pages and frames.
143 The virtual address, on the left, consists of a page number and an
144 offset.  The page table translates the page number into a frame number,
145 which is combined with the unmodified offset to obtain the physical
146 address, on the right.
147
148 @example
149 @group
150                          +----------+
151         .--------------->|Page Table|-----------.
152        /                 +----------+            |
153    0   |  12 11 0                            0   V  12 11 0
154   +---------+----+                          +---------+----+
155   |Page Nr  | Ofs|                          |Frame Nr | Ofs|
156   +---------+----+                          +---------+----+
157    Virt Addr   |                             Phys Addr   ^
158                 \_______________________________________/
159 @end group
160 @end example
161
162 @node Swap Slots
163 @subsubsection Swap Slots
164
165 A @dfn{swap slot} is a continuous, page-size region of disk space in the
166 swap partition.  Although hardware limitations dictating the placement of
167 slots are looser than for pages and frames, swap slots should be
168 page-aligned because there is no downside in doing so.
169
170 @node Resource Management Overview
171 @subsection Resource Management Overview
172
173 You will need to design the following data structures:
174
175 @table @asis
176 @item Supplemental page table
177
178 Enables page fault handling by supplementing the page table.
179 @xref{Managing the Supplemental Page Table}.
180
181 @item Frame table
182
183 Allows efficient implementation of eviction policy.
184 @xref{Managing the Frame Table}.
185
186 @item Swap table
187
188 Tracks usage of swap slots.
189 @xref{Managing the Swap Table}.
190
191 @item Table of file mappings
192
193 Processes may map files into their virtual memory space.  You need a
194 table to track which files are mapped into which pages.
195 @end table
196
197 You do not necessarily need to implement four completely distinct data
198 structures: it may be convenient to wholly or partially merge related
199 resources into a unified data structure.
200
201 For each data structure, you need to determine what information each
202 element should contain.  You also need to decide on the data structure's
203 scope, either local (per-process) or global (applying to the whole
204 system), and how many instances are required within its scope.
205
206 To simplify your design, you may store these data structures in
207 non-pageable memory.  That means that you can be sure that pointers
208 among them will remain valid.
209
210 Possible choices of data structures include arrays, lists, bitmaps, and
211 hash tables.  An array is often the simplest approach, but a sparsely
212 populated array wastes memory.  Lists are also simple, but traversing a
213 long list to find a particular position wastes time.  Both arrays and
214 lists can be resized, but lists more efficiently support insertion and
215 deletion in the middle.
216
217 Pintos includes a bitmap data structure in @file{lib/kernel/bitmap.c}
218 and @file{lib/kernel/bitmap.h}.  A bitmap is an array of bits, each of
219 which can be true or false.  Bitmaps are typically used to track usage
220 in a set of (identical) resources: if resource @var{n} is in use, then
221 bit @var{n} of the bitmap is true.  Pintos bitmaps are fixed in size,
222 although you could extend their implementation to support resizing.
223
224 Pintos also includes a hash table data structure (@pxref{Hash Table}).
225 Pintos hash tables efficiently support insertions and deletions over a
226 wide range of table sizes.
227
228 Although more complex data structures may yield performance or other
229 benefits, they may also needlessly complicate your implementation.
230 Thus, we do not recommend implementing any advanced data structure
231 (e.g.@: a balanced binary tree) as part of your design.
232
233 @node Managing the Supplemental Page Table
234 @subsection Managing the Supplemental Page Table
235
236 The @dfn{supplemental page table} supplements the page table with
237 additional data about each page.  It is needed because of the
238 limitations imposed by the page table's format.  Such a data structure
239 is often called a ``page table'' also; we add the word ``supplemental''
240 to reduce confusion.
241
242 The supplemental page table is used for at least two purposes.  Most
243 importantly, on a page fault, the kernel looks up the virtual page that
244 faulted in the supplemental page table to find out what data should be
245 there.  Second, the kernel consults the supplemental page table when a
246 process terminates, to decide what resources to free.
247
248 You may organize the supplemental page table as you wish.  There are at
249 least two basic approaches to its organization: in terms of segments or
250 in terms of pages.  Optionally, you may use the page table itself as an
251 index to track the members of the supplemental page table.  You will
252 have to modify the Pintos page table implementation in @file{pagedir.c}
253 to do so.  We recommend this approach for advanced students only.
254 @xref{Page Table Entry Format}, for more information.
255
256 The most important user of the supplemental page table is the page fault
257 handler.  In project 2, a page fault always indicated a bug in the
258 kernel or a user program.  In project 3, this is no longer true.  Now, a
259 page fault might only indicate that the page must be brought in from a
260 file or swap.  You will have to implement a more sophisticated page
261 fault handler to handle these cases.  Your page fault handler, which you
262 should implement by modifying @func{page_fault} in
263 @file{userprog/exception.c}, needs to do roughly the following:
264
265 @enumerate 1
266 @item
267 Locate the page that faulted in the supplemental page table.  If the
268 memory reference is valid, use the supplemental page table entry to
269 locate the data that goes in the page, which might be in the file
270 system, or in a swap slot, or it might simply be an all-zero page.  If
271 you implement sharing, the page's data might even already be in a page
272 frame, but not in the page table.
273
274 If the page is unmapped, that is, if there's no data there, or if the
275 page lies within kernel virtual memory, or if the access is an attempt
276 to write to a read-only page, then the access is invalid.  Any invalid
277 access terminates the process and thereby frees all of its resources.
278
279 @item
280 Obtain a frame to store the page.  @xref{Managing the Frame Table}, for
281 details.
282
283 If you implement sharing, the data you need may already be in a frame,
284 in which case you must be able to locate that frame.
285
286 @item
287 Fetch the data into the frame, by reading it from the file system or
288 swap, zeroing it, etc.
289
290 If you implement sharing, the page you need may already be in a frame,
291 in which case no action is necessary in this step.
292
293 @item
294 Point the page table entry for the faulting virtual address to the
295 physical page.  You can use the functions in @file{userprog/pagedir.c}.
296 @end enumerate
297
298 @node Managing the Frame Table
299 @subsection Managing the Frame Table
300
301 The @dfn{frame table} contains one entry for each frame that contains a
302 user page.  Each entry in the frame table contains a pointer to the
303 page, if any, that currently occupies it, and other data of your choice.
304 The frame table allows Pintos to efficiently implement an eviction
305 policy, by choosing a page to evict when no frames are free.
306
307 The frames used for user pages should be obtained from the ``user
308 pool,'' by calling @code{palloc_get_page(PAL_USER)}.  You must use
309 @code{PAL_USER} to avoid allocating from the ``kernel pool,'' which
310 could cause some test cases to fail unexpectedly (@pxref{Why
311 PAL_USER?}).  If you modify @file{palloc.c} as part of your frame table
312 implementation, be sure to retain the distinction between the two pools.
313
314 The most important operation on the frame table is obtaining an unused
315 frame.  This is easy when a frame is free.  When none is free, a frame
316 must be made free by evicting some page from its frame.
317
318 If no frame can be evicted without allocating a swap slot, but swap is
319 full, panic the kernel.  Real OSes apply a wide range of policies to
320 recover from or prevent such situations, but these policies are beyond
321 the scope of this project.
322
323 The process of eviction comprises roughly the following steps:
324
325 @enumerate 1
326 @item
327 Choose a frame to evict, using your page replacement algorithm.  The
328 ``accessed'' and ``dirty'' bits in the page table, described below, will
329 come in handy.
330
331 @item
332 Remove references to the frame from any page table that refers to it.
333
334 Unless you have implemented sharing, only a single page should refer to
335 a frame at any given time.
336
337 @item
338 If necessary, write the page to the file system or to swap.
339 @end enumerate
340
341 The evicted frame may then be used to store a different page.
342
343 @menu
344 * Accessed and Dirty Bits::     
345 @end menu
346
347 @node Accessed and Dirty Bits
348 @subsubsection Accessed and Dirty Bits
349
350 80@var{x}86 hardware provides some assistance for implementing page
351 replacement algorithms, through a pair of bits in the page table entry
352 (PTE) for each page.  On any read or write to a page, the CPU sets the
353 @dfn{accessed bit} to 1 in the page's PTE, and on any write, the CPU
354 sets the @dfn{dirty bit} to 1.  The CPU never resets these bits to 0,
355 but the OS may do so.
356
357 You need to be aware of @dfn{aliases}, that is, two (or more) pages that
358 refer to the same frame.  When an aliased frame is accessed, the
359 accessed and dirty bits are updated in only one page table entry (the
360 one for the page used for access).  The accessed and dirty bits for the
361 other aliases are not updated.
362
363 In Pintos, every user virtual page is aliased to its kernel virtual
364 page.  You must manage these aliases somehow.  For example, your code
365 could check and update the accessed and dirty bits for both addresses.
366 Alternatively, the kernel could avoid the problem by only accessing user
367 data through the user virtual address.
368
369 Other aliases should only arise if you implement sharing for extra
370 credit (@pxref{VM Extra Credit}), or if there is a bug in your code.
371
372 @xref{Page Table Accessed and Dirty Bits}, for details of the functions
373 to work with accessed and dirty bits.
374
375 @node Managing the Swap Table
376 @subsection Managing the Swap Table
377
378 The swap table tracks in-use and free swap slots.  It should allow
379 picking an unused swap slot for evicting a page from its frame to the
380 swap partition.  It should allow freeing a swap slot when its page is read
381 back or the process whose page was swapped is terminated.
382
383 You may use the @code{BLOCK_SWAP} block device for swapping, obtaining
384 the @struct{block} that represents it by calling @func{block_get_role}.
385 From the
386 @file{vm/build} directory, use the command @code{pintos-mkdisk swap.dsk
387 --swap-size=@var{n}} to create an disk named @file{swap.dsk} that
388 contains a @var{n}-MB swap partition.
389 Afterward, @file{swap.dsk} will automatically be attached as an extra disk
390 when you run @command{pintos}.  Alternatively, you can tell
391 @command{pintos} to use a temporary @var{n}-MB swap disk for a single
392 run with @option{--swap-size=@var{n}}.
393
394 Swap slots should be allocated lazily, that is, only when they are
395 actually required by eviction.  Reading data pages from the executable
396 and writing them to swap immediately at process startup is not lazy.
397 Swap slots should not be reserved to store particular pages.
398
399 Free a swap slot when its contents are read back into a frame.
400
401 @node Managing Memory Mapped Files Back
402 @subsection Managing Memory Mapped Files
403
404 The file system is most commonly accessed with @code{read} and
405 @code{write} system calls.  A secondary interface is to ``map'' the file
406 into virtual pages, using the @code{mmap} system call.  The program can
407 then use memory instructions directly on the file data.
408
409 Suppose file @file{foo} is @t{0x1000} bytes (4 kB, or one page) long.
410 If @file{foo} is mapped into memory starting at address @t{0x5000}, then
411 any memory accesses to locations @t{0x5000}@dots{}@t{0x5fff} will access
412 the corresponding bytes of @file{foo}.
413
414 Here's a program that uses @code{mmap} to print a file to the console.
415 It opens the file specified on the command line, maps it at virtual
416 address @t{0x10000000}, writes the mapped data to the console (fd 1),
417 and unmaps the file.
418
419 @example
420 #include <stdio.h>
421 #include <syscall.h>
422 int main (int argc UNUSED, char *argv[]) 
423 @{
424   void *data = (void *) 0x10000000;     /* @r{Address at which to map.} */
425
426   int fd = open (argv[1]);              /* @r{Open file.} */
427   mapid_t map = mmap (fd, data);        /* @r{Map file.} */
428   write (1, data, filesize (fd));       /* @r{Write file to console.} */
429   munmap (map);                         /* @r{Unmap file (optional).} */
430   return 0;
431 @}
432 @end example
433
434 A similar program with full error handling is included as @file{mcat.c}
435 in the @file{examples} directory, which also contains @file{mcp.c} as a
436 second example of @code{mmap}.
437
438 Your submission must be able to track what memory is used by memory
439 mapped files.  This is necessary to properly handle page faults in the
440 mapped regions and to ensure that mapped files do not overlap any other
441 segments within the process.
442
443 @node Project 3 Suggested Order of Implementation
444 @section Suggested Order of Implementation
445
446 We suggest the following initial order of implementation:
447
448 @enumerate 1
449 @item
450 Frame table (@pxref{Managing the Frame Table}).  Change @file{process.c}
451 to use your frame table allocator.
452
453 Do not implement swapping yet.  If you run out of frames, fail the
454 allocator or panic the kernel.
455
456 After this step, your kernel should still pass all the project 2 test
457 cases.
458
459 @item
460 Supplemental page table and page fault handler (@pxref{Managing the
461 Supplemental Page Table}).  Change @file{process.c} to record the
462 necessary information in the supplemental page table when loading an
463 executable and setting up its stack.  Implement loading of code and data
464 segments in the page fault handler.  For now, consider only valid
465 accesses.
466
467 After this step, your kernel should pass all of the project 2
468 functionality test cases, but only some of the robustness tests.
469 @end enumerate
470
471 From here, you can implement stack growth, mapped files, and page
472 reclamation on process exit in parallel.
473
474 The next step is to implement eviction (@pxref{Managing the Frame
475 Table}).  Initially you could choose the page to evict randomly.  At
476 this point, you need to consider how to manage accessed and dirty bits
477 and aliasing of user and kernel pages.  Synchronization is also a
478 concern: how do you deal with it if process A faults on a page whose
479 frame process B is in the process of evicting?  Finally, implement a
480 eviction strategy such as the clock algorithm.
481
482 @node Project 3 Requirements
483 @section Requirements
484
485 This assignment is an open-ended design problem.  We are going to say as
486 little as possible about how to do things.  Instead we will focus on
487 what functionality we require your OS to support.  We will expect
488 you to come up with a design that makes sense.  You will have the
489 freedom to choose how to handle page faults, how to organize the swap
490 partition, how to implement paging, etc.
491
492 @menu
493 * Project 3 Design Document::   
494 * Paging::                      
495 * Stack Growth::                
496 * Memory Mapped Files::         
497 @end menu
498
499 @node Project 3 Design Document
500 @subsection Design Document
501
502 Before you turn in your project, you must copy @uref{vm.tmpl, , the
503 project 3 design document template} into your source tree under the name
504 @file{pintos/src/vm/DESIGNDOC} and fill it in.  We recommend that you
505 read the design document template before you start working on the
506 project.  @xref{Project Documentation}, for a sample design document
507 that goes along with a fictitious project.
508
509 @node Paging
510 @subsection Paging
511
512 Implement paging for segments loaded from executables.  All of these
513 pages should be loaded lazily, that is, only as the kernel intercepts
514 page faults for them.  Upon eviction, pages modified since load (e.g.@:
515 as indicated by the ``dirty bit'') should be written to swap.
516 Unmodified pages, including read-only pages, should never be written to
517 swap because they can always be read back from the executable.
518
519 Implement a global page replacement algorithm that approximates LRU.
520 Your algorithm should perform at least as well as the ``second chance''
521 or ``clock'' algorithm.
522
523 Your design should allow for parallelism.  If one page fault requires
524 I/O, in the meantime processes that do not fault should continue
525 executing and other page faults that do not require I/O should be able
526 to complete.  This will require some synchronization effort.
527
528 You'll need to modify the core of the program loader, which is the loop
529 in @func{load_segment} in @file{userprog/process.c}.  Each time around
530 the loop, @code{page_read_bytes} receives the number of bytes to read
531 from the executable file and @code{page_zero_bytes} receives the number
532 of bytes to initialize to zero following the bytes read.  The two always
533 sum to @code{PGSIZE} (4,096).  The handling of a page depends on these
534 variables' values:
535
536 @itemize @bullet
537 @item
538 If @code{page_read_bytes} equals @code{PGSIZE}, the page should be demand
539 paged from the underlying file on its first access.
540
541 @item
542 If @code{page_zero_bytes} equals @code{PGSIZE}, the page does not need to
543 be read from disk at all because it is all zeroes.  You should handle
544 such pages by creating a new page consisting of all zeroes at the
545 first page fault.
546
547 @item
548 Otherwise, neither @code{page_read_bytes} nor @code{page_zero_bytes}
549 equals @code{PGSIZE}.  In this case, an initial part of the page is to
550 be read from the underlying file and the remainder zeroed.
551 @end itemize
552
553 @node Stack Growth
554 @subsection Stack Growth
555
556 Implement stack growth.  In project 2, the stack was a single page at
557 the top of the user virtual address space, and programs were limited to
558 that much stack.  Now, if the stack grows past its current size,
559 allocate additional pages as necessary.
560
561 Allocate additional pages only if they ``appear'' to be stack accesses.
562 Devise a heuristic that attempts to distinguish stack accesses from
563 other accesses.
564
565 User programs are buggy if they write to the stack below the stack
566 pointer, because typical real OSes may interrupt a process at any time
567 to deliver a ``signal,'' which pushes data on the stack.@footnote{This rule is
568 common but not universal.  One modern exception is the
569 @uref{http://www.x86-64.org/documentation/abi.pdf, @var{x}86-64 System V
570 ABI}, which designates 128 bytes below the stack pointer as a ``red
571 zone'' that may not be modified by signal or interrupt handlers.}
572 However, the 80@var{x}86 @code{PUSH} instruction checks access
573 permissions before it adjusts the stack pointer, so it may cause a page
574 fault 4 bytes below the stack pointer.  (Otherwise, @code{PUSH} would
575 not be restartable in a straightforward fashion.)  Similarly, the
576 @code{PUSHA} instruction pushes 32 bytes at once, so it can fault 32
577 bytes below the stack pointer.
578
579 You will need to be able to obtain the current value of the user
580 program's stack pointer.  Within a system call or a page fault generated
581 by a user program, you can retrieve it from the @code{esp} member of the
582 @struct{intr_frame} passed to @func{syscall_handler} or
583 @func{page_fault}, respectively.  If you verify user pointers before
584 accessing them (@pxref{Accessing User Memory}), these are the only cases
585 you need to handle.  On the other hand, if you depend on page faults to
586 detect invalid memory access, you will need to handle another case,
587 where a page fault occurs in the kernel.  Since the processor only 
588 saves the stack pointer when an exception causes a switch from user
589 to kernel mode, reading @code{esp} out of the @struct{intr_frame} 
590 passed to @func{page_fault} would yield an undefined value, not the 
591 user stack pointer.  You will need to arrange another way, such as 
592 saving @code{esp} into @struct{thread} on the initial transition 
593 from user to kernel mode.
594
595 You should impose some absolute limit on stack size, as do most OSes.
596 Some OSes make the limit user-adjustable, e.g.@: with the
597 @command{ulimit} command on many Unix systems.  On many GNU/Linux systems,
598 the default limit is 8 MB.
599
600 The first stack page need not be allocated lazily.  You can allocate
601 and initialize it with the command line arguments at load time, with 
602 no need to wait for it to be faulted in.
603
604 All stack pages should be candidates for eviction.  An evicted stack
605 page should be written to swap.
606
607 @node Memory Mapped Files
608 @subsection Memory Mapped Files
609
610 Implement memory mapped files, including the following system calls.
611
612 @deftypefn {System Call} mapid_t mmap (int @var{fd}, void *@var{addr})
613 Maps the file open as @var{fd} into the process's virtual address
614 space.  The entire file is mapped into consecutive virtual pages
615 starting at @var{addr}.
616
617 Your VM system must lazily load pages in @code{mmap} regions and use the
618 @code{mmap}ed file itself as backing store for the mapping.  That is,
619 evicting a page mapped by @code{mmap} writes it back to the file it was
620 mapped from.
621
622 If the file's length is not a multiple of @code{PGSIZE}, then some
623 bytes in the final mapped page ``stick out'' beyond the end of the
624 file.  Set these bytes to zero when the page is faulted in from the
625 file system,
626 and discard them when the page is written back to disk.
627
628 If successful, this function returns a ``mapping ID'' that
629 uniquely identifies the mapping within the process.  On failure,
630 it must return -1, which otherwise should not be a valid mapping id,
631 and the process's mappings must be unchanged.
632
633 A call to @code{mmap} may fail if the file open as @var{fd} has a
634 length of zero bytes.  It must fail if @var{addr} is not page-aligned
635 or if the range of pages mapped overlaps any existing set of mapped
636 pages, including the stack or pages mapped at executable load time.
637 It must also fail if @var{addr} is 0, because some Pintos code assumes
638 virtual page 0 is not mapped.  Finally, file descriptors 0 and 1,
639 representing console input and output, are not mappable.
640 @end deftypefn
641
642 @deftypefn {System Call} void munmap (mapid_t @var{mapping})
643 Unmaps the mapping designated by @var{mapping}, which must be a
644 mapping ID returned by a previous call to @code{mmap} by the same
645 process that has not yet been unmapped.
646 @end deftypefn
647
648 All mappings are implicitly unmapped when a process exits, whether via
649 @code{exit} or by any other means.  When a mapping is unmapped, whether
650 implicitly or explicitly, all pages written to by the process are
651 written back to the file, and pages not written must not be.  The pages
652 are then removed from the process's list of virtual pages.
653
654 Closing or removing a file does not unmap any of its mappings.  Once
655 created, a mapping is valid until @code{munmap} is called or the process
656 exits, following the Unix convention.  @xref{Removing an Open File}, for
657 more information.
658
659 If two or more processes map the same file, there is no requirement that
660 they see consistent data.  Unix handles this by making the two mappings
661 share the same physical page, but the @code{mmap} system call also has
662 an argument allowing the client to specify whether the page is shared or
663 private (i.e.@: copy-on-write).
664
665 @node Project 3 FAQ
666 @section FAQ
667
668 @table @b
669 @item How much code will I need to write?
670
671 Here's a summary of our reference solution, produced by the
672 @command{diffstat} program.  The final row gives total lines inserted
673 and deleted; a changed line counts as both an insertion and a deletion.
674
675 This summary is relative to the Pintos base code, but the reference
676 solution for project 3 starts from the reference solution to project 2.
677 @xref{Project 2 FAQ}, for the summary of project 2.
678
679 The reference solution represents just one possible solution.  Many
680 other solutions are also possible and many of those differ greatly from
681 the reference solution.  Some excellent solutions may not modify all the
682 files modified by the reference solution, and some may modify files not
683 modified by the reference solution.
684
685 @verbatim
686  Makefile.build       |    4
687  devices/timer.c      |   42 ++
688  threads/init.c       |    5
689  threads/interrupt.c  |    2
690  threads/thread.c     |   31 +
691  threads/thread.h     |   37 +-
692  userprog/exception.c |   12
693  userprog/pagedir.c   |   10
694  userprog/process.c   |  319 +++++++++++++-----
695  userprog/syscall.c   |  545 ++++++++++++++++++++++++++++++-
696  userprog/syscall.h   |    1
697  vm/frame.c           |  162 +++++++++
698  vm/frame.h           |   23 +
699  vm/page.c            |  297 ++++++++++++++++
700  vm/page.h            |   50 ++
701  vm/swap.c            |   85 ++++
702  vm/swap.h            |   11
703  17 files changed, 1532 insertions(+), 104 deletions(-)
704 @end verbatim
705
706 @item Do we need a working Project 2 to implement Project 3?
707
708 Yes.
709
710 @item What extra credit is available?
711 @anchor{VM Extra Credit}
712
713 You may implement sharing: when multiple processes are created that use
714 the same executable file, share read-only pages among those processes
715 instead of creating separate copies of read-only segments for each
716 process.  If you carefully designed your data structures,
717 sharing of read-only pages should not make this part significantly
718 harder.
719
720 @item How do we resume a process after we have handled a page fault?
721
722 Returning from @func{page_fault} resumes the current user process
723 (@pxref{Internal Interrupt Handling}).
724 It will then retry the instruction to which the instruction pointer points.
725
726 @item Does the virtual memory system need to support data segment growth?
727
728 No.  The size of the data segment is determined by the linker.  We still
729 have no dynamic allocation in Pintos (although it is possible to
730 ``fake'' it at the user level by using memory-mapped files).  Supporting
731 data segment growth should add little additional complexity to a
732 well-designed system.
733
734 @item Why should I use @code{PAL_USER} for allocating page frames?
735 @anchor{Why PAL_USER?}
736
737 Passing @code{PAL_USER} to @func{palloc_get_page} causes it to allocate
738 memory from the user pool, instead of the main kernel pool.  Running out
739 of pages in the user pool just causes user programs to page, but running
740 out of pages in the kernel pool will cause many failures because so many
741 kernel functions need to obtain memory.
742 You can layer some other allocator on top of @func{palloc_get_page} if
743 you like, but it should be the underlying mechanism.
744
745 Also, you can use the @option{-ul} kernel command-line option to limit
746 the size of the user pool, which makes it easy to test your VM
747 implementation with various user memory sizes.
748 @end table