Major revisions to documentation.
[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 Segment 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/disk.h
53 @itemx devices/disk.c
54 Provides access to the physical disk, abstracting away the rather awful
55 IDE interface.  You will use this interface to access the swap disk.
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 contiguous
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 contiguous 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 contiguous, page-size region of disk space on the
166 swap disk.  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 Segment table
177
178 Enables page fault handling by supplementing the page table.
179 @xref{Managing the Segment 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 Segment Table
234 @subsection Managing the Segment Table
235
236 The @dfn{segment table} supplements the page table with additional data
237 about each page.  It is required because of the limitations imposed by
238 the page table's format.  Such a supplementary data structure is often
239 called a ``page table'' also; we call it a segment table to avoid
240 confusion.
241
242 The segment table is used for at least two purposes.  Most importantly,
243 on a page fault, the kernel looks up the virtual page that faulted in
244 the segment table to find out what data should be there.  Second, the
245 kernel consults the segment table when a process terminates, to decide
246 what resources to free.
247
248 You may organize the segment table as you wish.  There are at least two
249 basic approaches to its organization: in terms of segments or in terms
250 of pages.  Optionally, you may use the page table as part of your
251 segment table design.  You will have to modify the Pintos page table
252 implementation in @file{pagedir.c} to do so.  We recommend this approach
253 for advanced students only.  @xref{Page Table Entry Format}, for more
254 information.
255
256 The most important user of the segment table is the page fault handler.
257 In project 2, a page fault always indicated a bug in the kernel or a
258 user program.  In project 3, this is no longer true.  Now, a page fault
259 might only indicate that the page must be brought in from a file or
260 swap.  You will have to implement a more sophisticated page fault
261 handler to handle these cases.  Your page fault handler, which you
262 should implement by modifying @func{page_fault} in
263 @file{threads/exception.c}, needs to do roughly the following:
264
265 @enumerate 1
266 @item
267 Locate the page that faulted in the segment table.  If the memory
268 reference is valid, use the segment table entry to locate the data that
269 goes in the page, which might be in the file system, or in a swap slot,
270 or it might simply be an all-zero page.  If you implement sharing, the
271 page's data might even already be in a page frame, but not in the page
272 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.  If no frame can
317 be evicted without allocating a swap slot, but swap is full, some
318 process must be killed to free memory (the choice of process to kill is
319 up to you).
320
321 The process of eviction comprises roughly the following steps:
322
323 @enumerate 1
324 @item
325 Choose a frame to evict, using your page replacement algorithm.  The
326 ``accessed'' and ``dirty'' bits in the page table, described below, will
327 come in handy.
328
329 @item
330 Remove references to the frame from any page table that refers to it.
331
332 Unless you have implemented sharing, only a single page should refer to
333 a frame at any given time.
334
335 @item
336 If necessary, write the page to the file system or to swap.
337 @end enumerate
338
339 The evicted frame may then be used to store a different page.
340
341 @menu
342 * Accessed and Dirty Bits::     
343 @end menu
344
345 @node Accessed and Dirty Bits
346 @subsubsection Accessed and Dirty Bits
347
348 80@var{x}86 hardware provides some assistance for implementing page
349 replacement algorithms, through a pair of bits in the page table entry
350 (PTE) for each page.  On any read or write to a page, the CPU sets the
351 @dfn{accessed bit} to 1 in the page's PTE, and on any write, the CPU
352 sets the @dfn{dirty bit} to 1.  The CPU never resets these bits to 0,
353 but the OS may do so.
354
355 You need to be aware of @dfn{aliases}, that is, two (or more) pages that
356 refer to the same frame.  When an aliased frame is accessed, the
357 accessed and dirty bits are updated in only one page table entry (the
358 one for the page used for access).  The accessed and dirty bits for the
359 other aliases are not updated.
360
361 In Pintos, every user virtual page is aliased to its kernel virtual
362 page.  You must manage these aliases somehow.  For example, your code
363 could check and update the accessed and dirty bits for both addresses.
364 Alternatively, the kernel could avoid the problem by only accessing user
365 data through the user virtual address.
366
367 Other aliases should only arise if you implement sharing for extra
368 credit (@pxref{VM Extra Credit}), or if there is a bug in your code.
369
370 @xref{Page Table Accessed and Dirty Bits}, for details of the functions
371 to work with accessed and dirty bits.
372
373 @node Managing the Swap Table
374 @subsection Managing the Swap Table
375
376 The swap table tracks in-use and free swap slots.  It should allow
377 picking an unused swap slot for evicting a page from its frame to the
378 swap disk.  It should allow freeing a swap slot when its page is read
379 back or the process whose page was swapped is terminated.
380
381 You may use the disk on interface @code{hd1:1} as the swap disk, using
382 the disk interface prototyped in @code{devices/disk.h}.  From the
383 @file{vm/build} directory, use the command @code{pintos-mkdisk swap.dsk
384 @var{n}} to create an @var{n} MB swap disk named @file{swap.dsk}.
385 Afterward, @file{swap.dsk} will automatically be attached as
386 @code{hd1:1} when you run @command{pintos}.  Alternatively, you can tell
387 @command{pintos} to use a temporary @var{n}-MB swap disk for a single
388 run with @option{--swap-disk=@var{n}}.
389
390 Swap slots should be allocated lazily, that is, only when they are
391 actually required by eviction.  Reading data pages from the executable
392 and writing them to swap immediately at process startup is not lazy.
393 Swap slots should not be reserved to store particular pages.
394
395 Free a swap slot when its contents are read back into a frame.
396
397 @node Managing Memory Mapped Files Back
398 @subsection Managing Memory Mapped Files
399
400 The file system is most commonly accessed with @code{read} and
401 @code{write} system calls.  A secondary interface is to ``map'' the file
402 into virtual pages, using the @code{mmap} system call.  The program can
403 then use memory instructions directly on the file data.
404
405 Suppose file @file{foo} is @t{0x1000} bytes (4 kB, or one page) long.
406 If @file{foo} is mapped into memory starting at address @t{0x5000}, then
407 any memory accesses to locations @t{0x5000}@dots{}@t{0x5fff} will access
408 the corresponding bytes of @file{foo}.
409
410 Here's a program that uses @code{mmap} to print a file to the console.
411 It opens the file specified on the command line, maps it at virtual
412 address @t{0x10000000}, writes the mapped data to the console (fd 1),
413 and unmaps the file.
414
415 @example
416 #include <stdio.h>
417 #include <syscall.h>
418 int main (int argc UNUSED, char *argv[]) 
419 @{
420   void *data = (void *) 0x10000000;     /* @r{Address at which to map.} */
421
422   int fd = open (argv[1]);              /* @r{Open file.} */
423   mapid_t map = mmap (fd, data);        /* @r{Map file.} */
424   write (1, data, filesize (fd));       /* @r{Write file to console.} */
425   munmap (map);                         /* @r{Unmap file (optional).} */
426   return 0;
427 @}
428 @end example
429
430 A similar program with full error handling is included as @file{mcat.c}
431 in the @file{examples} directory, which also contains @file{mcp.c} as a
432 second example of @code{mmap}.
433
434 Your submission must be able to track what memory is used by memory
435 mapped files.  This is necessary to properly handle page faults in the
436 mapped regions and to ensure that mapped files do not overlap any other
437 segments within the process.
438
439 @node Project 3 Suggested Order of Implementation
440 @section Suggested Order of Implementation
441
442 We suggest the following initial order of implementation:
443
444 @enumerate 1
445 @item
446 Frame table (@pxref{Managing the Frame Table}).  Change @file{process.c}
447 to use your frame table allocator.
448
449 Do not implement swapping yet.  If you run out of frames, fail the
450 allocator or panic the kernel.
451
452 After this step, your kernel should still pass all the project 2 test
453 cases.
454
455 @item
456 Segment table and page fault handler (@pxref{Managing the Segment
457 Table}).  Change @file{process.c} to record the necessary information in
458 the segment table when loading an executable and setting up its stack.
459 Implement loading of code and data segments in the page fault handler.
460 For now, consider only valid accesses.
461
462 After this step, your kernel should pass all of the project 2
463 functionality test cases, but only some of the robustness tests.
464 @end enumerate
465
466 From here, you can implement stack growth, mapped files, and page
467 reclamation on process exit in parallel.
468
469 The next step is to implement eviction (@pxref{Managing the Frame
470 Table}).  Initially you could choose the page to evict randomly.  At
471 this point, you need to consider how to manage accessed and dirty bits
472 and aliasing of user and kernel pages.  Synchronization is also a
473 concern: how do you deal with it if process A faults on a page whose
474 frame process B is in the process of evicting?  Finally, implement a
475 eviction strategy such as the clock algorithm.
476
477 @node Project 3 Requirements
478 @section Requirements
479
480 This assignment is an open-ended design problem.  We are going to say as
481 little as possible about how to do things.  Instead we will focus on
482 what functionality we require your OS to support.  We will expect
483 you to come up with a design that makes sense.  You will have the
484 freedom to choose how to handle page faults, how to organize the swap
485 disk, how to implement paging, etc.
486
487 @menu
488 * Project 3 Design Document::   
489 * Paging::                      
490 * Stack Growth::                
491 * Memory Mapped Files::         
492 @end menu
493
494 @node Project 3 Design Document
495 @subsection Design Document
496
497 Before you turn in your project, you must copy @uref{vm.tmpl, , the
498 project 3 design document template} into your source tree under the name
499 @file{pintos/src/vm/DESIGNDOC} and fill it in.  We recommend that you
500 read the design document template before you start working on the
501 project.  @xref{Project Documentation}, for a sample design document
502 that goes along with a fictitious project.
503
504 @node Paging
505 @subsection Paging
506
507 Implement paging for segments loaded from executables.  All of these
508 pages should be loaded lazily, that is, only as the kernel intercepts
509 page faults for them.  Upon eviction, pages modified since load (e.g.@:
510 as indicated by the ``dirty bit'') should be written to swap.
511 Unmodified pages, including read-only pages, should never be written to
512 swap because they can always be read back from the executable.
513
514 Implement a global page replacement algorithm that approximates LRU.
515 Your algorithm should perform at least as well as the ``second chance''
516 or ``clock'' algorithm.
517
518 Your design should allow for parallelism.  If one page fault requires
519 I/O, in the meantime processes that do not fault should continue
520 executing and other page faults that do not require I/O should be able
521 to complete.  This will require some synchronization effort.
522
523 You'll need to modify the core of the program loader, which is the loop
524 in @func{load_segment} in @file{userprog/process.c}.  Each time around
525 the loop, @code{page_read_bytes} receives the number of bytes to read
526 from the executable file and @code{page_zero_bytes} receives the number
527 of bytes to initialize to zero following the bytes read.  The two always
528 sum to @code{PGSIZE} (4,096).  The handling of a page depends on these
529 variables' values:
530
531 @itemize @bullet
532 @item
533 If @code{page_read_bytes} equals @code{PGSIZE}, the page should be demand
534 paged from disk on its first access.
535
536 @item
537 If @code{page_zero_bytes} equals @code{PGSIZE}, the page does not need to
538 be read from disk at all because it is all zeroes.  You should handle
539 such pages by creating a new page consisting of all zeroes at the
540 first page fault.
541
542 @item
543 Otherwise, neither @code{page_read_bytes} nor @code{page_zero_bytes}
544 equals @code{PGSIZE}.  In this case, an initial part of the page is to
545 be read from disk and the remainder zeroed.
546 @end itemize
547
548 @node Stack Growth
549 @subsection Stack Growth
550
551 Implement stack growth.  In project 2, the stack was a single page at
552 the top of the user virtual address space, and programs were limited to
553 that much stack.  Now, if the stack grows past its current size,
554 allocate additional pages as necessary.
555
556 Allocate additional pages only if they ``appear'' to be stack accesses.
557 Devise a heuristic that attempts to distinguish stack accesses from
558 other accesses.
559
560 User programs are buggy if they write to the stack below the stack
561 pointer, because typical real OSes may interrupt a process at any time
562 to deliver a ``signal,'' which pushes data on the stack.@footnote{This rule is
563 common but not universal.  One modern exception is the
564 @uref{http://www.x86-64.org/documentation/abi.pdf, @var{x}86-64 System V
565 ABI}, which designates 128 bytes below the stack pointer as a ``red
566 zone'' that may not be modified by signal or interrupt handlers.}
567 However, the 80@var{x}86 @code{PUSH} instruction checks access
568 permissions before it adjusts the stack pointer, so it may cause a page
569 fault 4 bytes below the stack pointer.  (Otherwise, @code{PUSH} would
570 not be restartable in a straightforward fashion.)  Similarly, the
571 @code{PUSHA} instruction pushes 32 bytes at once, so it can fault 32
572 bytes below the stack pointer.
573
574 You will need to be able to obtain the current value of the user
575 program's stack pointer.  Within a system call or a page fault generated
576 by a user program, you can retrieve it from @code{esp} member of the
577 @struct{intr_frame} passed to @func{syscall_handler} or
578 @func{page_fault}, respectively.  If you verify user pointers before
579 accessing them (@pxref{Accessing User Memory}), these are the only cases
580 you need to handle.  On the other hand, if you depend on page faults to
581 detect invalid memory access, you will need to handle another case,
582 where a page fault occurs in the kernel.  Reading @code{esp} out of the
583 @struct{intr_frame} passed to @func{page_fault} in that case will obtain
584 the kernel stack pointer, not the user stack pointer.  You will need to
585 arrange another way, e.g.@: by saving @code{esp} into @struct{thread} on
586 the initial transition from user to kernel mode.
587
588 You may impose some absolute limit on stack size, as do most OSes.
589 Some OSes make the limit user-adjustable, e.g.@: with the
590 @command{ulimit} command on many Unix systems.  On many GNU/Linux systems,
591 the default limit is 8 MB.
592
593 The first stack page need not be allocated lazily.  You can initialize
594 it with the command line arguments at load time, with no need to wait
595 for it to be faulted in.  (Even if you did wait, the very first
596 instruction in the user program is likely to be one that faults in the
597 page.)
598
599 All stack pages should be candidates for eviction.  An evicted stack
600 page should be written to swap.
601
602 @node Memory Mapped Files
603 @subsection Memory Mapped Files
604
605 Implement memory mapped files, including the following system calls.
606
607 @deftypefn {System Call} mapid_t mmap (int @var{fd}, void *@var{addr})
608 Maps the file open as @var{fd} into the process's virtual address
609 space.  The entire file is mapped into consecutive virtual pages
610 starting at @var{addr}.
611
612 Your VM system must lazily load pages in @code{mmap} regions and use the
613 @code{mmap}'d file itself as backing store for the mapping.  That is,
614 evicting a page mapped by @code{mmap} writes it back to the file it was
615 mapped from.
616
617 If the file's length is not a multiple of @code{PGSIZE}, then some
618 bytes in the final mapped page ``stick out'' beyond the end of the
619 file.  Set these bytes to zero when the page is faulted in from disk,
620 and discard them when the page is written back to disk.
621
622 If successful, this function returns a ``mapping ID'' that
623 uniquely identifies the mapping within the process.  On failure,
624 it must return -1, which otherwise should not be a valid mapping id,
625 and the process's mappings must be unchanged.
626
627 A call to @code{mmap} may fail if the file open as @var{fd} has a
628 length of zero bytes.  It must fail if @var{addr} is not page-aligned
629 or if the range of pages mapped overlaps any existing set of mapped
630 pages, including the stack or pages mapped at executable load time.
631 It must also fail if @var{addr} is 0, because some Pintos code assumes
632 virtual page 0 is not mapped.  Finally, file descriptors 0 and 1,
633 representing console input and output, are not mappable.
634 @end deftypefn
635
636 @deftypefn {System Call} void munmap (mapid_t @var{mapping})
637 Unmaps the mapping designated by @var{mapping}, which must be a
638 mapping ID returned by a previous call to @code{mmap} by the same
639 process that has not yet been unmapped.
640 @end deftypefn
641
642 All mappings are implicitly unmapped when a process exits, whether via
643 @code{exit} or by any other means.  When a mapping is unmapped, whether
644 implicitly or explicitly, all pages written to by the process are
645 written back to the file, and pages not written must not be.  The pages
646 are then removed from the process's list of virtual pages.
647
648 Closing or removing a file does not unmap any of its mappings.  Once
649 created, a mapping is valid until @code{munmap} is called or the process
650 exits, following the Unix convention.  @xref{Removing an Open File}, for
651 more information.
652
653 If two or more processes map the same file, there is no requirement that
654 they see consistent data.  Unix handles this by making the two mappings
655 share the same physical page, but the @code{mmap} system call also has
656 an argument allowing the client to specify whether the page is shared or
657 private (i.e.@: copy-on-write).
658
659 @node Project 3 FAQ
660 @section FAQ
661
662 @table @b
663 @item How much code will I need to write?
664
665 Here's a summary of our reference solution, produced by the
666 @command{diffstat} program.  The final row gives total lines inserted
667 and deleted; a changed line counts as both an insertion and a deletion.
668
669 This summary is relative to the Pintos base code, but the reference
670 solution for project 3 starts from the reference solution to project 2.
671 @xref{Project 2 FAQ}, for the summary of project 2.
672
673 The reference solution represents just one possible solution.  Many
674 other solutions are also possible and many of those differ greatly from
675 the reference solution.  Some excellent solutions may not modify all the
676 files modified by the reference solution, and some may modify files not
677 modified by the reference solution.
678
679 @verbatim
680  Makefile.build       |    4
681  devices/timer.c      |   42 ++
682  threads/init.c       |    5
683  threads/interrupt.c  |    2
684  threads/thread.c     |   31 +
685  threads/thread.h     |   37 +-
686  userprog/exception.c |   12
687  userprog/pagedir.c   |   10
688  userprog/process.c   |  319 +++++++++++++-----
689  userprog/syscall.c   |  545 ++++++++++++++++++++++++++++++-
690  userprog/syscall.h   |    1
691  vm/frame.c           |  162 +++++++++
692  vm/frame.h           |   23 +
693  vm/page.c            |  297 ++++++++++++++++
694  vm/page.h            |   50 ++
695  vm/swap.c            |   85 ++++
696  vm/swap.h            |   11
697  17 files changed, 1532 insertions(+), 104 deletions(-)
698 @end verbatim
699
700 @item Do we need a working Project 2 to implement Project 3?
701
702 Yes.
703
704 @item What extra credit is available?
705 @anchor{VM Extra Credit}
706
707 You may implement sharing: when multiple processes are created that use
708 the same executable file, share read-only pages among those processes
709 instead of creating separate copies of read-only segments for each
710 process.  If you carefully designed your page table data structures,
711 sharing of read-only pages should not make this part significantly
712 harder.
713
714 @item Does the virtual memory system need to support data segment growth?
715
716 No.  The size of the data segment is determined by the linker.  We still
717 have no dynamic allocation in Pintos (although it is possible to
718 ``fake'' it at the user level by using memory-mapped files).  Supporting
719 data segment growth should add little additional complexity to a
720 well-designed system.
721
722 @item Why should I use @code{PAL_USER} for allocating page frames?
723 @anchor{Why PAL_USER?}
724
725 Passing @code{PAL_USER} to @func{palloc_get_page} causes it to allocate
726 memory from the user pool, instead of the main kernel pool.  Running out
727 of pages in the user pool just causes user programs to page, but running
728 out of pages in the kernel pool will cause many failures because so many
729 kernel functions need to obtain memory.
730 You can layer some other allocator on top of @func{palloc_get_page} if
731 you like, but it should be the underlying mechanism.
732
733 Also, you can use the @option{-ul} option to @command{pintos} to limit
734 the size of the user pool, which makes it easy to test your VM
735 implementation with various user memory sizes.
736 @end table