Revise.
[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 Your submission should define @code{THREAD_JOIN_IMPLEMENTED} in
39 @file{constants.h} (@pxref{Conditional Compilation}).
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 didn't own, 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.
212
213 @node Memory Mapped Files
214 @section Memory Mapped Files
215
216 The traditional way to access the file system is via @code{read} and
217 @code{write} system calls, but that requires an extra level of copying
218 between the kernel and the user level.  A secondary interface is
219 simply to ``map'' the file into the virtual address space.  The
220 program can then use load and store instructions directly on the file
221 data.  (An alternative way of viewing the file system is as ``durable
222 memory.''  Files just store data structures.  If you access data
223 structures in memory using load and store instructions, why not access
224 data structures in files the same way?)
225
226 Memory mapped files are typically implemented using system calls.  One
227 system call maps the file to a particular part of the address space.
228 For example, one might map the file @file{foo}, which is 1000 bytes
229 long, starting at address 5000.  Assuming that nothing else is already
230 at virtual addresses 5000@dots{}6000, any memory accesses to these
231 locations will access the corresponding bytes of @file{foo}.
232
233 A consequence of memory mapped files is that address spaces are
234 sparsely populated with lots of segments, one for each memory mapped
235 file (plus one each for code, data, and stack).  You will implement
236 memory mapped files for problem 3 of this assignment, but you should
237 design your solutions to problems 1 and 2 to account for this.
238
239 @node Stack
240 @section Stack
241
242 In project 2, the stack was a single page at the top of the user
243 virtual address space.  The stack's location does not change in this
244 project, but your kernel should allocate additional pages to the stack
245 on demand.  That is, if the stack grows past its current bottom, the
246 system should allocate additional pages for the stack as necessary
247 (unless those pages are unavailable because they are in use by another
248 segment).
249
250 It is impossible to predict how large the stack will grow at compile
251 time, so we must allocate pages as necessary.  You should only
252 allocate additional pages if they ``appear'' to be stack accesses.
253 You must devise a heuristic that attempts to distinguish stack
254 accesses from other accesses.  Document and explain the heuristic in
255 your design documentation.
256
257 The first stack page need not be loaded lazily.  You can initialize it
258 with the command line at load time, with no need to wait for it to be
259 faulted in.  Even if you did wait, the very first instruction in the
260 user program is likely to be one that faults in the page.
261
262 @node Problem 3-1 Page Table Management
263 @section Problem 3-1: Page Table Management
264
265 Implement page directory and page table management to support virtual
266 memory.  You will need data structures to accomplish the following
267 tasks:
268
269 @itemize @bullet
270 @item
271 Some way of translating in software from virtual page frames to
272 physical page frames.  Consider using a hash table (@pxref{Hash
273 Table}).
274
275 @item
276 Some way of translating from physical page frames back to virtual page
277 frames, so that when you evict a physical page from its frame, you can
278 invalidate its translation(s).
279
280 @item
281 Some way of finding a page on disk if it is not in memory.  You won't
282 need this data structure until problem 3-2, but planning ahead is a
283 good idea.
284 @end itemize
285
286 The page fault handler, @func{page_fault} in
287 @file{threads/exception.c}, needs to do roughly the following:
288
289 @enumerate 1
290 @item
291 Locate the page backing the virtual
292 address that faulted.  It might be in the file system, in swap,
293 already be in physical memory and just not set up in the page table,
294 or it might be an invalid virtual address.
295
296 If the virtual address is invalid, that is, if there's nothing
297 assigned to go there, or if the virtual address is above
298 @code{PHYS_BASE}, meaning that it belongs to the kernel instead of the
299 user, then the process's memory access must be disallowed.  You should
300 terminate the process at this point, being sure to free all of its
301 resources.
302
303 @item
304 If the page is not in physical memory, fetch it by appropriate means.
305 If necessary to make room, first evict some other page from memory.
306 (When you do that you need to first remove references to the page from
307 any page table that refers to it.)
308
309 @item
310 Point the page table entry for the faulting virtual address to the
311 physical page.  You can use the functions in @file{userprog/pagedir.c}.
312 @end enumerate
313
314 You'll need to modify the ELF loader in @file{userprog/process.c} to
315 do page table management according to your new design.  As supplied,
316 it reads all the process's pages from disk and initializes the page
317 tables for them at the same time.  For testing purposes, you'll
318 probably want to leave the code that reads the pages from disk, but
319 use your new page table management code to construct the page tables
320 only as page faults occur for them.
321
322 You should use the @func{palloc_get_page} function to get the page
323 frames that you use for storing user virtual pages.  Be sure to pass
324 the @code{PAL_USER} flag to this function when you do so, because that
325 allocates pages from a ``user pool'' separate from the ``kernel pool''
326 that other calls to @func{palloc_get_page} make.
327
328 There are many possible ways to implement virtual memory.  The above
329 is simply an outline of our suggested implementation.
330
331 @node Problem 3-2 Paging To and From Disk
332 @section Problem 3-2: Paging To and From Disk
333
334 Implement paging to and from files and the swap disk.  You may use the
335 disk on interface @code{hd1:1} as the swap disk, using the disk
336 interface prototyped in @code{devices/disk.h}.
337
338 You will need routines to move a page from memory to disk and from
339 disk to memory, where ``disk'' is either a file or the swap disk.  If
340 you do everything correctly, your VM should still work when you
341 implement your own file system for the next assignment.
342
343 You will need a way to track pages which are used by a process but
344 which are not in physical memory, to fully handle page faults.  Pages
345 that you write to swap should not be constrained to be in sequential
346 order.  You will also need a way to track all of the physical memory
347 pages, to find an unused one when needed, or to evict a page
348 when memory is needed but no empty pages are available.  The data
349 structures that you designed for problem 3-1 should do most of the work for
350 you.
351
352 You will need a page replacement algorithm.  The hardware sets the
353 accessed and dirty bits when it accesses memory.  You can gain access
354 to this information using the functions prototyped in
355 @file{userprog/pagedir.h}.  You should be able to take advantage of
356 this information to implement some algorithm which attempts to achieve
357 LRU-type behavior.  We expect that your algorithm perform at least as
358 well as a reasonable implementation of the second-chance (clock)
359 algorithm.  You will need to show in your test cases the value of your
360 page replacement algorithm by demonstrating for some workload that it
361 pages less frequently using your algorithm than using some inferior
362 page replacement policy.  The canonical example of a poor page
363 replacement policy is random replacement.
364
365 Since you will already be paging from disk, you should implement a
366 ``lazy'' loading scheme for new processes.  When a process is created,
367 it will not run immediately.  Therefore, it doesn't make sense to load
368 all its code, data, and stack into memory when the process is created,
369 since it might incur additional disk accesses to do so (if it gets
370 paged out before it runs).  When loading a new process, you should
371 leave most pages on disk, and bring them in as demanded when the
372 program begins running.  Your VM system should also use the executable
373 file itself as backing store for read-only segments, since these
374 segments won't change.
375
376 There are a few special cases.  Look at the loop in
377 @func{load_segment} in @file{userprog/process.c}.  Each time
378 around the loop, @code{read_bytes} represents the number of bytes to
379 read from the executable file and @code{zero_bytes} represents the number
380 of bytes to initialize to zero following the bytes read.  The two
381 always sum to @code{PGSIZE}.  The page handling depends on these
382 variables' values:
383
384 @itemize @bullet
385 @item
386 If @code{read_bytes} equals @code{PGSIZE}, the page should be demand
387 paged from disk on its first access.
388
389 @item 
390 If @code{zero_bytes} equals @code{PGSIZE}, the page does not need to
391 be read from disk at all because it is all zeroes.  You should handle
392 such pages by creating a new page consisting of all zeroes at the
393 first page fault.
394
395 @item
396 If neither @code{read_bytes} nor @code{zero_bytes} equals
397 @code{PGSIZE}, then part of the page is to be read from disk and the
398 remainder zeroed.  This is a special case.  You are allowed to handle
399 it by reading the partial page from disk at executable load time and
400 zeroing the rest of the page.  This is the only case in which we will
401 allow you to load a page in a non-``lazy'' fashion.  Many real OSes
402 such as Linux do not load partial pages lazily.
403 @end itemize
404
405 Incidentally, if you have trouble handling the third case above, you
406 can eliminate it temporarily by linking the test programs with a
407 special ``linker script.''  Read @file{tests/userprog/Makefile} for
408 details.  We will not test your submission with this special linker
409 script, so the code you turn in must properly handle all cases.
410
411 For extra credit, you may implement sharing: when multiple processes
412 are created that use the same executable file, share read-only pages
413 among those processes instead of creating separate copies of read-only
414 segments for each process.  If you carefully designed your data
415 structures in problem 3-1, sharing of read-only pages should not make this
416 part significantly harder.
417
418 @node Problem 3-3 Memory Mapped Files
419 @section Problem 3-3: Memory Mapped Files
420
421 Implement memory mapped files.
422
423 You will need to implement the following system calls:
424
425 @table @code
426 @item SYS_mmap
427 @itemx bool mmap (int @var{fd}, void *@var{addr}, unsigned @var{length})
428
429 Maps the file open as @var{fd} into the process's address space
430 starting at @var{addr} for @var{length} bytes.  Returns true if
431 successful, false on failure.  Failure cases include the following:
432
433 @itemize @bullet
434 @item
435 @var{addr} is not page-aligned.
436
437 @item
438 @var{length} is not positive.
439
440 @item
441 The range of pages mapped overlaps any existing set of mapped pages,
442 including the stack or pages mapped at executable load time.
443 @end itemize
444
445 @var{length} is treated as if it were rounded up to the nearest
446 multiple of the page size, that is, as if the first statement in the
447 system call's implementation were
448 @example
449 length = ROUND_UP (length, PGSIZE);
450 @end example
451 The remainder of this description assumes that this has been done.
452
453 If @var{length} is less than @var{fd}'s length, you should only map
454 the first part of the file.  If @var{length} is greater than
455 @var{fd}'s length, when the file's length is also rounded up to the
456 nearest multiple of the page size, the call should fail.  Ideally it
457 would extend the file, but our file system does not yet support
458 growing files.
459
460 If @var{length} is greater than @var{fd}'s unrounded length, then some
461 bytes in the final mapped page ``stick out'' beyond the end of the
462 file.  These bytes are set to zero when the page is faulted in from
463 disk.  They are discarded when the page is written back to disk.
464
465 Your VM system should be able to use the @code{mmap}'d file itself as
466 backing store for the mapped segment.  That is, if a page mapped by
467 @code{mmap} must be evicted, write it to the file it was mapped from.
468 (In fact, you may choose to implement executable mappings as a special
469 case of file mappings.)
470
471 @item SYS_munmap
472 @itemx bool munmap (void *addr, unsigned length)
473
474 Unmaps @var{length} bytes starting at @var{addr}.  Returns true on
475 success, false on failure.  Failure cases include the following:
476
477 @itemize @bullet
478 @item
479 @var{addr} is not page-aligned.
480
481 @item
482 @var{length} is not positive.
483
484 @item
485 One or more pages within the range to be unmapped were not mapped
486 using the @code{mmap} system call.
487 @end itemize
488
489 As with @code{mmap}, @var{length} is treated as if it were rounded up
490 to the nearest multiple of the page size
491
492 It is valid to unmap only some of the pages that were mapped in a
493 previous system call.
494 @end table
495
496 All mappings are implicitly unmapped when a process exits, whether via
497 @code{exit} or by any other means.  When a file is unmapped, whether
498 implicitly or explicitly, all outstanding changes are written to the
499 file, and the pages are removed from the process's list of used
500 virtual pages.
501
502 @node Virtual Memory FAQ
503 @section FAQ
504
505 @enumerate 1
506 @item
507 @b{Do we need a working HW 2 to implement HW 3?}
508
509 Yes.
510
511 @item
512 @anchor{Hash Table}
513 @b{How do I use the hash table provided in @file{lib/kernel/hash.c}?}
514
515 First, you need to embed a @code{hash_elem} object as a member of the
516 object that the hash table will contain.  Each @code{hash_elem} allows
517 the object to a member of at most one hash table at a given time.  All
518 the hash table functions that deal with hash table items actually use
519 the address of a @code{hash_elem}.  You can convert a pointer to a
520 @code{hash_elem} member into a pointer to the structure in which
521 member is embedded using the @code{hash_entry} macro.
522
523 Second, you need to decide on a key type.  The key should be something
524 that is unique for each object, because a given hash table may not
525 contain two objects with equal keys.  Then you need to write two
526 functions.  The first is a @dfn{hash function} that converts a key
527 into an integer.  Some sample hash functions that you can use or just
528 examine are given in @file{lib/kernel/hash.c}.  The second function
529 needed is a @dfn{comparison function} that compares a pair and returns
530 true if the first is less than the second.  These two functions have
531 to be compatible with the prototypes for @code{hash_hash_func} and
532 @code{hash_less_func} in @file{lib/kernel/hash.h}.
533
534 Here's a quick example.  Suppose you want to put @struct{thread}s
535 in a hash table.  First, add a @code{hash_elem} to the thread
536 structure by adding a line to its definition:
537
538 @example
539 hash_elem h_elem;               /* Hash table element. */
540 @end example
541
542 We'll choose the @code{tid} member in @struct{thread} as the key,
543 and write a hash function and a comparison function:
544
545 @example
546 /* Returns a hash for E. */
547 unsigned
548 thread_hash (const hash_elem *e, void *aux UNUSED)
549 @{
550   struct thread *t = hash_entry (e, struct thread, h_elem);
551   return hash_int (t->tid);
552 @}
553
554 /* Returns true if A's tid is less than B's tid. */
555 bool
556 thread_less (const hash_elem *a_, const hash_elem *b_, 
557              void *aux UNUSED)
558 @{
559   struct thread *a = hash_entry (a_, struct thread, h_elem);
560   struct thread *b = hash_entry (b_, struct thread, h_elem);
561   return a->tid < b->tid;
562 @}
563 @end example
564
565 Then we can create a hash table like this:
566
567 @example
568 struct hash threads;
569
570 hash_init (&threads, thread_hash, thread_less, NULL);
571 @end example
572
573 Finally, if @code{@var{t}} is a pointer to a @struct{thread},
574 then we can insert it into the hash table with:
575
576 @example
577 hash_insert (&threads, &@var{t}->h_elem);
578 @end example
579
580 If you have any other questions about hash tables, the CS109
581 and CS161 textbooks have good chapters on them, or you can come
582 to any of the TA's office hours for further clarification.
583
584 @item
585 @b{What are the @var{aux} parameters to the hash table functions good
586 for?}
587
588 In simple cases you won't have any need for the @var{aux} parameters.
589 In these cases you can just pass a null pointer to @func{hash_init}
590 for @var{aux} and ignore the values passed to the hash function and
591 comparison functions.  (You'll get a compiler warning if you don't use
592 the @var{aux} parameter, but you can turn that off with the
593 @code{UNUSED} macro, as shown above, or you can just ignore it.)
594
595 @var{aux} is useful when you have some property of the data in the
596 hash table that's both constant and needed for hashing or comparisons,
597 but which is not stored in the data items themselves.  For example, if
598 the items in a hash table contain fixed-length strings, but the items
599 themselves don't indicate what that fixed length is, you could pass
600 the length as an @var{aux} parameter.
601
602 @item
603 @b{The current implementation of the hash table does not do something
604 that we need it to do. What gives?}
605
606 You are welcome to modify it.  It is not used by any of the code we
607 provided, so modifying it won't affect any code but yours.  Do
608 whatever it takes to make it work the way you want.
609
610 @item
611 @b{What controls the layout of user programs?}
612
613 The linker is responsible for the layout of a user program in
614 memory. The linker is directed by a ``linker script'' which tells it
615 the names and locations of the various program segments.  You can
616 learn more about linker scripts by reading the ``Scripts'' chapter in
617 the linker manual, accessible via @samp{info ld}.
618 @end enumerate
619
620 @menu
621 * Problem 3-1 and 3-2 FAQ::    
622 * Problem 3-3 Memory Mapped File FAQ::  
623 @end menu
624
625 @node Problem 3-1 and 3-2 FAQ
626 @subsection Problem 3-1 and 3-2 FAQ
627
628 @enumerate 1
629 @item
630 @b{Does the virtual memory system need to support growth of the data
631 segment?}
632
633 No.  The size of the data segment is determined by the linker.  We
634 still have no dynamic allocation in Pintos (although it is possible to
635 ``fake'' it at the user level by using memory-mapped files).  However,
636 implementing it would add little additional complexity to a
637 well-designed system.
638
639 @item
640 @b{Why do I need to pass @code{PAL_USER} to @func{palloc_get_page}
641 when I allocate physical page frames?}@anchor{Why PAL_USER?}
642
643 You can layer some other allocator on top of @func{palloc_get_page}
644 if you like, but it should be the underlying mechanism, directly or
645 indirectly, for two reasons.  First, running out of pages in the user
646 pool just causes user programs to page, but running out of pages in
647 the kernel pool will cause all kinds of problems, because many kernel
648 functions depend on being able to allocate memory.  Second, you can
649 use the @option{-ul} option to @command{pintos} to limit the size of
650 the user pool, which makes it easy to test your VM implementation with
651 various user memory sizes.
652 @end enumerate
653
654 @node Problem 3-3 Memory Mapped File FAQ
655 @subsection Problem 3-3: Memory Mapped File FAQ
656
657 @enumerate 1
658 @item
659 @b{How do we interact with memory-mapped files?}
660
661 Let's say you want to map a file called @file{foo} into your address
662 space at address @t{0x10000000}. You open the file, determine its
663 length, and then use @code{mmap}:
664
665 @example
666 #include <stdio.h>
667 #include <syscall.h>
668
669 int main (void)
670 @{
671     void *addr = (void *) 0x10000000;
672     int fd = open ("foo");
673     int length = filesize (fd);
674     if (mmap (fd, addr, length))
675         printf ("success!\n");
676 @}
677 @end example
678
679 Suppose @file{foo} is a text file and you want to print the first 64
680 bytes on the screen (assuming, of course, that the length of the file
681 is at least 64).  Without @code{mmap}, you'd need to allocate a
682 buffer, use @code{read} to get the data from the file into the buffer,
683 and finally use @code{write} to put the buffer out to the display. But
684 with the file mapped into your address space, you can directly address
685 it like so:
686
687 @example
688 write (addr, 64, STDOUT_FILENO);
689 @end example
690
691 Similarly, if you wanted to replace the first byte of the file,
692 all you need to do is:
693
694 @example
695 addr[0] = 'b';
696 @end example
697
698 When you're done using the memory-mapped file, you simply unmap
699 it:
700
701 @example
702 munmap (addr, length);
703 @end example
704
705 @item
706 @b{What if two processes memory-map the same file?}
707
708 There is no requirement in Pintos that the two processes see
709 consistent data.  Unix handles this by making the processes share the
710 same physical page, but the @code{mmap} system call also has an
711 argument allowing the client to specify whether the page is shared or
712 private (i.e.@: copy-on-write).
713
714 @item
715 @b{What happens if a user removes a @code{mmap}'d file?}
716
717 You should follow the Unix convention and the mapping should still be
718 valid.  @xref{Removing an Open File}, for more information.
719
720 @item
721 @b{What if a process writes to a page that is memory-mapped, but the
722 location written to in the memory-mapped page is past the end
723 of the memory-mapped file?}
724
725 Can't happen.  @code{mmap} checks that the mapped region is within the
726 file's length and Pintos provides no way to shorten a file.  (Until
727 project 4, there's no way to extend a file either.)  You can remove a
728 file, but the mapping remains valid (see the previous question).
729
730 @item
731 @b{Do we have to handle memory mapping @code{stdin} or @code{stdout}?}
732
733 No.  Memory mapping implies that a file has a length and that a user
734 can seek to any location in the file.  Since the console device has
735 neither of these properties, @code{mmap} should return false when the
736 user attempts to memory map a file descriptor for the console device.
737
738 @item
739 @b{What happens when a process exits with mapped files?}
740
741 When a process finishes, each of its mapped files is implicitly
742 unmapped.  When a process @code{mmap}s a file and then writes into the
743 area for the file it is making the assumption the changes will be
744 written to the file.
745
746 @item
747 @b{If a user closes a mapped file, should it be automatically
748 unmapped?}
749
750 No, once created the mapping is valid until @code{munmap} is called
751 or the process exits.
752 @end enumerate