Always use a custom linker script, to avoid oddities in the default.
[pintos-anon] / doc / vm.texi
1 @node Project 3--Virtual Memory, Project 4--File Systems, Project 2--User Programs, Top
2 @chapter Project 3: Virtual Memory
3
4 By now you should be familiar with the inner workings of Pintos.
5 You've already come a long way: your OS can properly handle multiple
6 threads of execution with proper synchronization, and can load
7 multiple user programs at once.  However, when loading user programs,
8 your OS is limited by how much main memory the simulated machine has.
9 In this assignment, you will remove that limitation.
10
11 You will be using the @file{vm} directory for this project.  The
12 @file{vm} directory contains only the @file{Makefile}s.  The only
13 change from @file{userprog} is that this new @file{Makefile} turns on
14 the setting @option{-DVM}.  All code you write will either be newly
15 generated files (e.g.@: if you choose to implement your paging code in
16 their own source files), or will be modifications to pre-existing code
17 (e.g.@: you will change the behavior of @file{process.c}
18 significantly).
19
20 There are only a couple of source files you will probably be
21 encountering for the first time:
22
23 @table @file
24 @item devices/disk.h
25 @itemx devices/disk.c
26 Provides access to the physical disk, abstracting away the rather
27 awful IDE interface.
28 @end table
29
30 You will be building this assignment on the last one.  It will benefit
31 you to get your project 2 in good working order before this assignment
32 so those bugs don't keep haunting you.
33
34 All the test programs from the previous project should also work with
35 this project.  You should also write programs to test the new features
36 introduced in this project.
37
38 You will continue to handle Pintos disks and file systems the same way
39 you did in the previous assignment (@pxref{Using the File System}).
40
41 @menu
42 * VM Design::                   
43 * Page Faults::                 
44 * Disk as Backing Store::       
45 * Memory Mapped Files::         
46 * Stack::                       
47 * Problem 3-1 Page Table Management::  
48 * Problem 3-2 Paging To and From Disk::  
49 * Problem 3-3 Memory Mapped Files::  
50 * Virtual Memory FAQ::          
51 @end menu
52
53 @node VM Design
54 @section A Word about Design
55
56 It is important for you to note that in addition to getting virtual
57 memory working, this assignment is also meant to be an open-ended
58 design problem.  We will expect you to come up with a design that
59 makes sense.  You will have the freedom to choose how to handle page
60 faults, how to organize the swap disk, how to implement paging, etc.
61 In each case, we will expect you to provide a defensible justification
62 in your design documentation as to why your choices are reasonable.
63 You should evaluate your design on all the available criteria: speed
64 of handling a page fault, space overhead in memory, minimizing the
65 number of page faults, simplicity, etc.
66
67 In keeping with this, you will find that we are going to say as little
68 as possible about how to do things.  Instead we will focus on what end
69 functionality we require your OS to support.
70
71 @node Page Faults
72 @section Page Faults
73
74 For the last assignment, whenever a context switch occurred, the new
75 process would install its own page table into the machine.  The page
76 table contained all the virtual-to-physical translations for the
77 process.  Whenever the processor needed to look up a translation, it
78 consulted the page table.  As long as the process only accessed
79 memory that it owned, all was well.  If the process accessed
80 memory it didn't own, it ``page faulted'' and @func{page_fault}
81 terminated the process.
82
83 When we implement virtual memory, the rules have to change.  A page
84 fault is no longer necessarily an error, since it might only indicate
85 that the page must be brought in from a disk file or from swap.  You
86 will have to implement a more sophisticated page fault handler to
87 handle these cases.
88
89 On the 80@var{x}86, the page table format is fixed by hardware.  We
90 have provided code for managing page tables for you to use in
91 @file{userprog/pagedir.c}.  The functions in there should provide an
92 abstract interface to all the page table functionality that you need
93 to complete the project.  However, you may still find it worthwhile to
94 understand a little about the hardware page table format, so we'll go
95 into a little of detail about that in this section.
96
97 The top-level paging data structure is a 4 kB page called the ``page
98 directory'' (PD) arranged as an array of 1,024 32-bit page directory
99 entries (PDEs), each of which represents 4 MB of virtual memory.  Each
100 PDE may point to the physical address of another 4 kB page called a
101 ``page table'' (PT) arranged in the same fashion as an array of 1,024
102 32-bit page table entries (PTEs), each of which translates a single 4
103 kB virtual page into physical memory.
104
105 Thus, translation of a virtual address into a physical address follows
106 the three-step process illustrated in the diagram
107 below:@footnote{Actually, virtual to physical translation on the
108 80@var{x}86 architecture happens via an intermediate ``linear
109 address,'' but Pintos (and most other 80@var{x}86 OSes) set up the CPU
110 so that linear and virtual addresses are one and the same, so that you
111 can effectively ignore this CPU feature.}
112
113 @enumerate 1
114 @item
115 The top 10 bits of the virtual address (bits 22:32) are used to index
116 into the page directory.  If the PDE is marked ``present,'' the
117 physical address of a page table is read from the PDE thus obtained.
118 If the PDE is marked ``not present'' then a page fault occurs.
119
120 @item
121 The next 10 bits of the virtual address (bits 12:22) are used to index
122 into the page table.  If the PTE is marked ``present,'' the physical
123 address of a data page is read from the PTE thus obtained.  If the PTE
124 is marked ``not present'' then a page fault occurs.
125
126
127 @item
128 The bottom 12 bits of the virtual address (bits 0:12) are added to the
129 data page's physical base address, producing the final physical
130 address.
131 @end enumerate
132
133 @example
134 @group
135 32                    22                     12                      0
136 +--------------------------------------------------------------------+
137 | Page Directory Index |   Page Table Index   |    Page Offset       |
138 +--------------------------------------------------------------------+
139              |                    |                     |
140      _______/             _______/                _____/
141     /                    /                       /
142    /    Page Directory  /      Page Table       /    Data Page
143   /     .____________. /     .____________.    /   .____________.
144   |1,023|____________| |1,023|____________|    |   |____________|
145   |1,022|____________| |1,022|____________|    |   |____________|
146   |1,021|____________| |1,021|____________|    \__\|____________|
147   |1,020|____________| |1,020|____________|       /|____________|
148   |     |            | |     |            |        |            |
149   |     |            | \____\|            |_       |            |
150   |     |      .     |      /|      .     | \      |      .     |
151   \____\|      .     |_      |      .     |  |     |      .     |
152        /|      .     | \     |      .     |  |     |      .     |
153         |      .     |  |    |      .     |  |     |      .     |
154         |            |  |    |            |  |     |            |
155         |____________|  |    |____________|  |     |____________|
156        4|____________|  |   4|____________|  |     |____________|
157        3|____________|  |   3|____________|  |     |____________|
158        2|____________|  |   2|____________|  |     |____________|
159        1|____________|  |   1|____________|  |     |____________|
160        0|____________|  \__\0|____________|  \____\|____________|
161                            /                      /
162 @end group
163 @end example
164
165 Header @file{threads/mmu.h} has useful functions for various
166 operations on virtual addresses.  You should look over the header
167 yourself, but its most important functions include these:
168
169 @table @code
170 @item pd_no(@var{va})
171 Returns the page directory index in virtual address @var{va}.
172
173 @item pt_no(@var{va})
174 Returns the page table index in virtual address @var{va}.
175
176 @item pg_ofs(@var{va})
177 Returns the page offset in virtual address @var{va}.
178
179 @item pg_round_down(@var{va})
180 Returns @var{va} rounded down to the nearest page boundary, that is,
181 @var{va} but with its page offset set to 0.
182
183 @item pg_round_up(@var{va})
184 Returns @var{va} rounded up to the nearest page boundary.
185 @end table
186
187 @node Disk as Backing Store
188 @section Disk as Backing Store
189
190 In VM systems, since memory is less plentiful than disk, you will
191 effectively use memory as a cache for disk.  Looking at it from
192 another angle, you will use disk as a backing store for memory.  This
193 provides the abstraction of an (almost) unlimited virtual memory size.
194 Part of your task in this project is to do this, with the additional
195 constraint that your performance should be close to that provided by
196 physical memory.  You will use the page tables' ``dirty'' bits to
197 denote whether pages need to be written back to disk when they're
198 evicted from main memory and the ``accessed'' bit for page replacement
199 algorithms.  Whenever the hardware writes memory, it sets the dirty
200 bit, and if it reads or writes to the page, it sets the accessed bit.
201
202 As with any caching system, performance depends on the policy used to
203 decide which things are kept in memory and which are only stored on
204 disk.  On a page fault, the kernel must decide which page to replace.
205 Ideally, it will throw out a page that will not be referenced for a
206 long time, keeping in memory those pages that are soon to be
207 referenced.  Another consideration is that if the replaced page has
208 been modified, the page must be first saved to disk before the needed
209 page can be brought in.  Many virtual memory systems avoid this extra
210 overhead by writing modified pages to disk in advance, so that later
211 page faults can be completed more quickly (but you do not have to
212 implement this optimization).
213
214 @node Memory Mapped Files
215 @section Memory Mapped Files
216
217 The traditional way to access the file system is via @code{read} and
218 @code{write} system calls, but that requires an extra level of copying
219 between the kernel and the user level.  A secondary interface is
220 simply to ``map'' the file into the virtual address space.  The
221 program can then use load and store instructions directly on the file
222 data.  (An alternative way of viewing the file system is as ``durable
223 memory.''  Files just store data structures.  If you access data
224 structures in memory using load and store instructions, why not access
225 data structures in files the same way?)
226
227 Memory mapped files are typically implemented using system calls.  One
228 system call maps the file to a particular part of the address space.
229 For example, one might conceptually map the file @file{foo}, which is
230 1000 bytes
231 long, starting at address 5000.  Assuming that nothing else is already
232 at virtual addresses 5000@dots{}6000, any memory accesses to these
233 locations will access the corresponding bytes of @file{foo}.
234
235 A consequence of memory mapped files is that address spaces are
236 sparsely populated with lots of segments, one for each memory mapped
237 file (plus one each for code, data, and stack).  You will implement
238 memory mapped files in problem 3-3.  You should
239 design your solutions to problems 3-1 and 3-2 to anticipate this.
240
241 @node Stack
242 @section Stack
243
244 In project 2, the stack was a single page at the top of the user
245 virtual address space.  The stack's location does not change in this
246 project, but your kernel should allocate additional pages to the stack
247 on demand.  That is, if the stack grows past its current bottom, the
248 system should allocate additional pages for the stack as necessary
249 (unless those pages are unavailable because they are in use by another
250 segment).
251
252 It is impossible to predict how large the stack will grow at compile
253 time, so we must allocate pages as necessary.  You should only allocate
254 additional pages if they ``appear'' to be stack accesses.  You must
255 devise a heuristic that attempts to distinguish stack accesses from
256 other accesses.  Document and explain the heuristic in your
257 design documentation.
258
259 The first stack page need not be loaded lazily.  You can initialize it
260 with the command line at load time, with no need to wait for it to be
261 faulted in.  Even if you did wait, the very first instruction in the
262 user program is likely to be one that faults in the page.
263
264 Stack facts:
265
266 @itemize
267 @item
268 The user program's current stack pointer is in the @struct{intr_frame}'s
269 @code{esp} member.
270
271 @item
272 Only buggy 80@var{x}86 user programs write to memory within the
273 stack but below the stack pointer.  This is because more advanced OSes
274 may interrupt a process at any time to deliver a ``signal'' and this
275 uses the stack.@footnote{This rule is common but not universal.  One
276 modern exception is the
277 @uref{http://www.x86-64.org/documentation/abi.pdf, @var{x}86-64 System
278 V ABI}, which designates 128 bytes below the stack pointer as a ``red
279 zone'' that may not be modified by signal or interrupt handlers.}
280
281 @item
282 The 80@var{x}86 @code{push} instruction may cause a page fault 4 bytes
283 below the stack pointer, because it checks access permissions before it
284 adjusts the stack pointer.  (Otherwise, the instruction would not be
285 restartable in a straightforward fashion.)
286
287 @item
288 Similarly, the 80@var{x}86 @code{pusha} instruction, which pushes all 32
289 bytes of the 8 general-purpose registers at once, may cause a page fault
290 32 bytes below the stack pointer.
291
292 @item
293 Most OSes impose some sort of limit on the stack size.  Sometimes it is
294 user-adjustable.
295 @end itemize
296
297 @node Problem 3-1 Page Table Management
298 @section Problem 3-1: Page Table Management
299
300 Implement page directory and page table management to support virtual
301 memory.  You will need data structures to accomplish the following
302 tasks:
303
304 @itemize @bullet
305 @item
306 Some way of translating in software from virtual page frames to
307 physical page frames.  Consider using a hash table (@pxref{Hash
308 Table}).
309
310 It is possible to do this translation without adding a new data
311 structure, by modifying the code in @file{userprog/pagedir.c}.  However,
312 if you do that you'll need to carefully study and understand section 3.7
313 in @bibref{IA32-v3}, and in practice it is probably easier to add a new
314 data structure.
315
316 @item
317 Some way of finding a page on disk if it is not in memory.  You won't
318 need this data structure until problem 3-2, but planning ahead is a
319 good idea.
320
321 You can generalize the virtual-to-physical page table, so that it allows
322 you to locate a page wherever it is in physical memory or on disk, or
323 you can make this a separate table.
324
325 @item
326 Some way of translating from physical page frames back to virtual page
327 frames, so that when you evict a physical page from its frame, you can
328 invalidate its translation(s).
329 @end itemize
330
331 The page fault handler, @func{page_fault} in
332 @file{threads/exception.c}, needs to do roughly the following:
333
334 @enumerate 1
335 @item
336 Locate the page backing the virtual
337 address that faulted.  It might be in the file system, in swap,
338 or it might be an invalid virtual address.
339 If you implement sharing, it might even
340 already be in physical memory and just not set up in the page table,
341
342 If the virtual address is invalid, that is, if there's nothing
343 assigned to go there, or if the virtual address is above
344 @code{PHYS_BASE}, meaning that it belongs to the kernel instead of the
345 user, then the process's memory access must be disallowed.  You should
346 terminate the process at this point, being sure to free all of its
347 resources.
348
349 @item
350 If the page is not in physical memory, fetch it by appropriate means.
351 If necessary to make room, first evict some other page from memory.
352 (When you do that you need to first remove references to the page from
353 any page table that refers to it.)
354
355 @item
356 Point the page table entry for the faulting virtual address to the
357 physical page.  You can use the functions in @file{userprog/pagedir.c}.
358 @end enumerate
359
360 You'll need to modify the ELF loader in @file{userprog/process.c} to
361 do page table management according to your new design.  As supplied,
362 it reads all the process's pages from disk and initializes the page
363 tables for them at the same time.  For testing purposes, you'll
364 probably want to leave the code that reads the pages from disk, but
365 use your new page table management code to construct the page tables
366 only as page faults occur for them.
367
368 You should use the @func{palloc_get_page} function to get the page
369 frames that you use for storing user virtual pages.  Be sure to pass
370 the @code{PAL_USER} flag to this function when you do so, because that
371 allocates pages from a ``user pool'' separate from the ``kernel pool''
372 that other calls to @func{palloc_get_page} make.
373
374 There are many possible ways to implement virtual memory.  The above
375 is simply an outline of our suggested implementation.
376
377 @node Problem 3-2 Paging To and From Disk
378 @section Problem 3-2: Paging To and From Disk
379
380 Implement paging to and from files and the swap disk.  You may use the
381 disk on interface @code{hd1:1} as the swap disk, using the disk
382 interface prototyped in @code{devices/disk.h}.  From the @file{vm/build}
383 directory, use the command @code{pintos make-disk swap.dsk @var{n}} to
384 create an @var{n} MB swap disk named @file{swap.dsk}.  Afterward,
385 @file{swap.dsk} will automatically be attached when you run
386 @command{pintos}.
387
388 You will need routines to move a page from memory to disk and from
389 disk to memory, where ``disk'' is either a file or the swap disk.  If
390 you do everything correctly, your VM should still work when you
391 implement your own file system for the next assignment.
392
393 You will need a way to track pages which are used by a process but
394 which are not in physical memory, to fully handle page faults.  Pages
395 that you write to swap should not be constrained to be in sequential
396 order.  You will also need a way to track all of the physical memory
397 pages, to find an unused one when needed, or to evict a page
398 when memory is needed but no empty pages are available.  The data
399 structures that you designed for problem 3-1 should do most of the work for
400 you.
401
402 You will need a page replacement algorithm.  The hardware sets the
403 accessed and dirty bits when it accesses memory.  You can gain access
404 to this information using the functions prototyped in
405 @file{userprog/pagedir.h}.  You should be able to take advantage of
406 this information to implement some algorithm which attempts to achieve
407 LRU-type behavior.  We expect that your algorithm perform at least as
408 well as a reasonable implementation of the second-chance (clock)
409 algorithm.  You will need to show in your test cases the value of your
410 page replacement algorithm by demonstrating for some workload that it
411 pages less frequently using your algorithm than using some inferior
412 page replacement policy.  The canonical example of a poor page
413 replacement policy is random replacement.
414
415 You must write your code so that we can choose a page replacement policy
416 at compile time.  By default, the LRU-like algorithm must be in effect,
417 but we must be able to choose random replacement by inserting the line
418 @code{#define RANDOM_REPLACEMENT 1} in @file{constants.h}.
419 @xref{Conditional Compilation}, for details.
420
421 Since you will already be paging from disk, you should implement a
422 ``lazy'' loading scheme for new processes.  When a process is created,
423 it will not run immediately.  Therefore, it doesn't make sense to load
424 all its code, data, and stack into memory when the process is created,
425 since it might incur additional disk accesses to do so (if it gets
426 paged out before it runs).  When loading a new process, you should
427 leave most pages on disk, and bring them in as demanded when the
428 program begins running.  Your VM system should also use the executable
429 file itself as backing store for read-only segments, since these
430 segments won't change.
431
432 There are a few special cases.  Look at the loop in
433 @func{load_segment} in @file{userprog/process.c}.  Each time
434 around the loop, @code{read_bytes} represents the number of bytes to
435 read from the executable file and @code{zero_bytes} represents the number
436 of bytes to initialize to zero following the bytes read.  The two
437 always sum to @code{PGSIZE}.  The page handling depends on these
438 variables' values:
439
440 @itemize @bullet
441 @item
442 If @code{read_bytes} equals @code{PGSIZE}, the page should be demand
443 paged from disk on its first access.
444
445 @item 
446 If @code{zero_bytes} equals @code{PGSIZE}, the page does not need to
447 be read from disk at all because it is all zeroes.  You should handle
448 such pages by creating a new page consisting of all zeroes at the
449 first page fault.
450
451 @item
452 If neither @code{read_bytes} nor @code{zero_bytes} equals
453 @code{PGSIZE}, then part of the page is to be read from disk and the
454 remainder zeroed.  This is a special case.  You are allowed to handle
455 it by reading the partial page from disk at executable load time and
456 zeroing the rest of the page.  This is the only case in which we will
457 allow you to load a page in a non-``lazy'' fashion.  Many real OSes
458 such as Linux do not load partial pages lazily.
459 @end itemize
460
461 Incidentally, if you have trouble handling the third case above, you
462 can eliminate it temporarily by linking the test programs with a
463 special ``linker script.''  Read @file{Makefile.userprog} for
464 details.  We will not test your submission with this special linker
465 script, so the code you turn in must properly handle all cases.
466
467 For extra credit, you may implement sharing: when multiple processes
468 are created that use the same executable file, share read-only pages
469 among those processes instead of creating separate copies of read-only
470 segments for each process.  If you carefully designed your data
471 structures in problem 3-1, sharing of read-only pages should not make this
472 part significantly harder.
473
474 @node Problem 3-3 Memory Mapped Files
475 @section Problem 3-3: Memory Mapped Files
476
477 Implement memory mapped files.
478
479 You will need to implement the following system calls:
480
481 @table @code
482 @item SYS_mmap
483 @itemx mapid_t mmap (int @var{fd}, void *@var{addr})
484
485 Maps the file open as @var{fd} into the process's virtual address
486 space.  The entire file is mapped into consecutive virtual pages
487 starting at @var{addr}.
488
489 If the file's length is not a multiple of @code{PGSIZE}, then some
490 bytes in the final mapped page ``stick out'' beyond the end of the
491 file.  Set these bytes to zero when the page is faulted in from disk,
492 and discard them when the page is written back to disk.
493
494 If successful, this function returns a ``mapping ID'' that must
495 uniquely identify the mapping within the given process.  On failure,
496 it must return -1, which otherwise should not be a valid mapping id.
497
498 A call to @code{mmap} may fail if the file open as @var{fd} has a
499 length of zero bytes.  It must fail if @var{addr} is not page-aligned
500 or if the range of pages mapped overlaps any existing set of mapped
501 pages, including the stack or pages mapped at executable load time.
502
503 Your VM system should use the @code{mmap}'d file itself as backing
504 store for the mapping.  That is, to evict a page mapped by
505 @code{mmap}, write it to the file it was mapped from.  (In fact, you
506 may choose to implement executable mappings as a special case of file
507 mappings.)
508
509 @item SYS_munmap
510 @itemx bool munmap (mapid_t @var{mapping})
511
512 Unmaps the mapping designated by @var{mapping}, which must be a
513 mapping ID returned by a previous call to @code{mmap} by the same
514 process that has not yet been unmapped.
515 @end table
516
517 All mappings are implicitly unmapped when a process exits, whether via
518 @code{exit} or by any other means.  When a mapping is unmapped, whether
519 implicitly or explicitly, all outstanding changes are written to the
520 file, and the pages are removed from the process's list of used
521 virtual pages.
522
523 @node Virtual Memory FAQ
524 @section FAQ
525
526 @enumerate 1
527 @item
528 @b{Do we need a working HW 2 to implement HW 3?}
529
530 Yes.
531
532 @item
533 @anchor{Hash Table}
534 @b{How do I use the hash table provided in @file{lib/kernel/hash.c}?}
535
536 First, you need to embed a @struct{hash_elem} as a member of the
537 object that the hash table will contain.  Each @struct{hash_elem} allows
538 the object to a member of at most one hash table at a given time.  All
539 the hash table functions that deal with hash table items actually use
540 the address of a @struct{hash_elem}.  You can convert a pointer to a
541 @struct{hash_elem} member into a pointer to the structure in which
542 member is embedded using the @code{hash_entry} macro.
543
544 Second, you need to decide on a key type.  The key should be something
545 that is unique for each object, because a given hash table may not
546 contain two objects with equal keys.  Then you need to write two
547 functions.  The first is a @dfn{hash function} that converts a key
548 into an integer.  Some sample hash functions that you can use or just
549 examine are given in @file{lib/kernel/hash.c}.  The second function
550 needed is a @dfn{comparison function} that compares a pair and returns
551 true if the first is less than the second.  These two functions have
552 to be compatible with the prototypes for @code{hash_hash_func} and
553 @code{hash_less_func} in @file{lib/kernel/hash.h}.
554
555 Here's a quick example.  Suppose you want to put @struct{thread}s
556 in a hash table.  First, add a @struct{hash_elem} to the thread
557 structure by adding a line to its definition:
558
559 @example
560 struct hash_elem h_elem;                /* Hash table element. */
561 @end example
562
563 We'll choose the @code{tid} member in @struct{thread} as the key,
564 and write a hash function and a comparison function:
565
566 @example
567 /* Returns a hash for E. */
568 unsigned
569 thread_hash (const struct hash_elem *e, void *aux UNUSED)
570 @{
571   struct thread *t = hash_entry (e, struct thread, h_elem);
572   return hash_int (t->tid);
573 @}
574
575 /* Returns true if A's tid is less than B's tid. */
576 bool
577 thread_less (const struct hash_elem *a_, const struct hash_elem *b_, 
578              void *aux UNUSED)
579 @{
580   struct thread *a = hash_entry (a_, struct thread, h_elem);
581   struct thread *b = hash_entry (b_, struct thread, h_elem);
582   return a->tid < b->tid;
583 @}
584 @end example
585
586 Then we can create a hash table like this:
587
588 @example
589 struct hash threads;
590
591 hash_init (&threads, thread_hash, thread_less, NULL);
592 @end example
593
594 Finally, if @code{@var{t}} is a pointer to a @struct{thread},
595 then we can insert it into the hash table with:
596
597 @example
598 hash_insert (&threads, &@var{t}->h_elem);
599 @end example
600
601 If you have any other questions about hash tables, the CS109
602 and CS161 textbooks have good chapters on them, or you can come
603 to any of the TA's office hours for further clarification.
604
605 @item
606 @b{What are the @var{aux} parameters to the hash table functions good
607 for?}
608
609 In simple cases you won't have any need for the @var{aux} parameters.
610 In these cases you can just pass a null pointer to @func{hash_init}
611 for @var{aux} and ignore the values passed to the hash function and
612 comparison functions.  (You'll get a compiler warning if you don't use
613 the @var{aux} parameter, but you can turn that off with the
614 @code{UNUSED} macro, as shown above, or you can just ignore it.)
615
616 @var{aux} is useful when you have some property of the data in the
617 hash table that's both constant and needed for hashing or comparisons,
618 but which is not stored in the data items themselves.  For example, if
619 the items in a hash table contain fixed-length strings, but the items
620 themselves don't indicate what that fixed length is, you could pass
621 the length as an @var{aux} parameter.
622
623 @item
624 @b{The current implementation of the hash table does not do something
625 that we need it to do. What gives?}
626
627 You are welcome to modify it.  It is not used by any of the code we
628 provided, so modifying it won't affect any code but yours.  Do
629 whatever it takes to make it work the way you want.
630
631 @item
632 @b{What controls the layout of user programs?}
633
634 The linker is responsible for the layout of a user program in
635 memory. The linker is directed by a ``linker script'' which tells it
636 the names and locations of the various program segments.  You can
637 learn more about linker scripts by reading the ``Scripts'' chapter in
638 the linker manual, accessible via @samp{info ld}.
639 @end enumerate
640
641 @menu
642 * Problem 3-1 and 3-2 FAQ::    
643 * Problem 3-3 Memory Mapped File FAQ::  
644 @end menu
645
646 @node Problem 3-1 and 3-2 FAQ
647 @subsection Problem 3-1 and 3-2 FAQ
648
649 @enumerate 1
650 @item
651 @b{Does the virtual memory system need to support growth of the data
652 segment?}
653
654 No.  The size of the data segment is determined by the linker.  We
655 still have no dynamic allocation in Pintos (although it is possible to
656 ``fake'' it at the user level by using memory-mapped files).  However,
657 implementing it would add little additional complexity to a
658 well-designed system.
659
660 @item
661 @b{Why do I need to pass @code{PAL_USER} to @func{palloc_get_page}
662 when I allocate physical page frames?}@anchor{Why PAL_USER?}
663
664 You can layer some other allocator on top of @func{palloc_get_page}
665 if you like, but it should be the underlying mechanism, directly or
666 indirectly, for two reasons.  First, running out of pages in the user
667 pool just causes user programs to page, but running out of pages in
668 the kernel pool will cause all kinds of problems, because many kernel
669 functions depend on being able to allocate memory.  Second, you can
670 use the @option{-ul} option to @command{pintos} to limit the size of
671 the user pool, which makes it easy to test your VM implementation with
672 various user memory sizes.
673 @end enumerate
674
675 @node Problem 3-3 Memory Mapped File FAQ
676 @subsection Problem 3-3: Memory Mapped File FAQ
677
678 @enumerate 1
679 @item
680 @b{How do we interact with memory-mapped files?}
681
682 Let's say you want to map a file called @file{foo} into your address
683 space at address @t{0x10000000}. You open the file then use @code{mmap}:
684
685 @example
686 #include <stdio.h>
687 #include <syscall.h>
688
689 int main (void)
690 @{
691     void *addr = (void *) 0x10000000;
692     int fd = open ("foo");
693     mapid_t map = mmap (fd, addr);
694     if (map != -1)
695         printf ("success!\n");
696 @}
697 @end example
698
699 Suppose @file{foo} is a text file and you want to print the first 64
700 bytes on the screen (assuming, of course, that the length of the file
701 is at least 64).  Without @code{mmap}, you'd need to allocate a
702 buffer, use @code{read} to get the data from the file into the buffer,
703 and finally use @code{write} to put the buffer out to the display. But
704 with the file mapped into your address space, you can directly address
705 it like so:
706
707 @example
708 write (addr, 64, STDOUT_FILENO);
709 @end example
710
711 Similarly, if you wanted to replace the first byte of the file,
712 all you need to do is:
713
714 @example
715 addr[0] = 'b';
716 @end example
717
718 When you're done using the memory-mapped file, you simply unmap
719 it:
720
721 @example
722 munmap (map);
723 @end example
724
725 @item
726 @b{What if two processes map the same file into memory?}
727
728 There is no requirement in Pintos that the two processes see
729 consistent data.  Unix handles this by making the two mappings share the
730 same physical page, but the @code{mmap} system call also has an
731 argument allowing the client to specify whether the page is shared or
732 private (i.e.@: copy-on-write).
733
734 @item
735 @b{What happens if a user removes a @code{mmap}'d file?}
736
737 The mapping should remain valid, following the Unix convention.
738 @xref{Removing an Open File}, for more information.
739
740 @item
741 @b{What if a process writes to a page that is memory-mapped, but the
742 location written to in the memory-mapped page is past the end
743 of the memory-mapped file?}
744
745 Can't happen.  @code{mmap} maps an entire file and Pintos provides no
746 way to shorten a file.  (Until project 4, there's no way to extend a
747 file either.)  You can remove a file, but the mapping remains valid
748 (see the previous question).
749
750 @item
751 @b{Do we have to handle memory mapping @code{stdin} or @code{stdout}?}
752
753 No.  Memory mapping implies that a file has a length and that a user
754 can seek to any location in the file.  Since the console device has
755 neither of these properties, @code{mmap} should return false when the
756 user attempts to memory map a file descriptor for the console device.
757
758 @item
759 @b{If a user closes a mapped file, should it be automatically
760 unmapped?}
761
762 No.  Once created the mapping is valid until @code{munmap} is called
763 or the process exits.
764 @end enumerate