elf: limit the number of argc/envc
[akaros.git] / Documentation / vfs.txt
1 Unorganized Notes on the Virtual File System
2 -------------------------------------
3 Our VFS is built similarly to Linux's, mostly because I'd like to have somewhat
4 easy integration with ext2 (or at the very least have our own FS that can
5 integrate into Linux easily).
6
7 There are four main objects in a filesystem: superblock, inode, dentry, and a
8 file.  
9         - Superblock: Specific instance of a mounted filesystem.  All
10           synchronization is done with the one spinlock.
11         - Inode: represents a specific file
12         - Dentry: in memory object, corresponding to an element of a path.
13           E.g. /, usr, bin, and vim are all dentries.  All have inodes.  Vim
14           happens to be a
15           file instead of a directory.
16         - File: represents a file opened by a process.
17
18 So far, dentries are the most complicated, so here are some notes about them.
19 These are probably self-consistent, but may be a bit old (or just wrong) because
20 I wrote them as I put the VFS together:
21
22 A dentry is just a connection between a part of a path and an inode.  We just
23 want to walk from dentry to dentry, asking each to find the next part in the
24 path.  When you hit a dentry that's not the end of the desired path, you ask its
25 inode for the next dentry by using it's operation (lookup).
26
27 lookup() takes the inode of the directory (or 0 for the root) and a dentry
28 (already allocated, with the d_name and i_name filled in), and it will find the
29 correct inode for the given dentry, as well as filling out any specific FS
30 things in the dentry (like d_ops).  It will return 0 on failure, or the dentry
31 pointer passed in on success.  Somehow the nameidata bit will be used too.  This
32 will probably change a bit...  Note that lookup() needs to read the actual
33 directory file and also lookup the inode off the disc, which means it will
34 block.
35
36 When the next dentry is a mountpoint, (e.g. /mnt/cdrom), when you ask mnt for
37 cdrom, lookup() will parse it's file (a directory) and see 'cdrom' there as a child
38 entry.  Then it will return cdrom's dentry, like always.
39
40 But since cdrom was a mountpoint, (which you can see from the d_mount_point),
41 you need to walk through the structures a bit to get the dentry of the FS rooted
42 at that mountpoint to keep walking.  The VFS can handle that, so lookup()
43 doesn't need to worry about it.
44
45 Why are there two dentries associated with a vfsmount?  Normally, a dentry for a
46 directory points to an inode that contains its members.  When a FS is mounted
47 over it, we don't want to destroy that.  Instead, we mark it as a mountpoint,
48 and when following, we walk into the next FS.  The mountpoint is the dentry in
49 the parent mount (using the parent mount's FS superblock), and the root is the
50 dentry of the mounted FS, using the FS superblock of the mounted FS.
51
52 Sometimes lookup() will not be called at all.  We want to look for present
53 dentries first (ones that exist in memory already, including all of those with a
54 refcnt).  So we can look in the cache (currently just an SLIST, but will
55 eventually be a hash table).  When hitting in the cache (hashed by dentry name,
56 and probably the parent dir), we need to verify that the dentry's parent is our
57 own (handled by the VFS code).  All vfsmount dentries will be in the cache,
58 since they all have a refcnt (the vfsmount struct points to them).
59
60 Dentries for / and pwd and whatnot have a refcnt (pointed to by fs_struct,
61 vfsmounts, etc).  Anything with a pointer to it has a refcnt, so it never goes
62 away.  So if we have an inode in memory, it's entire dentry path is cached,
63 (just follow the parent pointers back).  Note that when a dentry's refcnt hits
64 0, we do *not* deallocate (like we do with many other structures).  It will just
65 be on the LRU list in the dcache system.  Likewise, every dentry points to its
66 inode, which pins that inode in memory.
67
68 Other refcnts: just about everything has a refcnt, and we need to be careful
69 about when we want to use them and dealloc.  Some things would be a pain in the
70 ass, like with the super_block refcnt.  Every dentry has a ref to the SB, but
71 changing that ref every time we add or remove a dentry will probably be an
72 unnecessary penalty if we can ensure all dentries of that FS are gone before
73 removing the superblock through another mechanism.  We'll see.  Mostly, this
74 just means we need to think about what we really want from a refcnt, and whether
75 or not we want the kref / process style refcnting.
76
77 Mounting:
78 -------------------------------------------
79 When you mount, you need to read in the super block and connect the relevant
80 data structures together.  The SB is connected to the vfsmount, which is
81 connected to the dentry of the mount point and the dentry of the root of the FS.
82 This means when mounting the FS, we need to create the dentry for "/", which
83 means we also need the inode, which needs to be read_inode()'d in.  Actually, we
84 might not need to read the inode in right away - we might be able to get away
85 with reading them in on-demand.
86
87 All of this means that for every mount point, the SB, vfsmount, dentry, and
88 inode are in memory.  Due to the way dentries link, every dentry and inode back
89 up to the real root are all in memory too.  Having a mount point is like having
90 a process working in that directory - the chain back up is pinned.
91
92 d_subdirs:
93 -------------------------------------------
94 Tracking the links between objects can be tricky.  One pain is d_subdirs. Linux
95 only tracks subdirectories.  We also do this.  I think the reason they do it is
96 since you should be using the dcache to cache lookups, and not scan the linked
97 list of children of a dentry for a specific file.  Though it is handy to know
98 all of your *directory* children.  In KFS, we also track all children in a list.
99 This is to make our lookups work - instead of having an actual directory file
100 with name->ino mappings.
101
102 KFS and metadata pinning:
103 -------------------------------------------
104 KFS pins all metadata ("all paths pinned").  This means that from the root mnt
105 down to the lowest inode, all dentries and corresponding inodes are pinned in
106 memory from creation time.   Yeah, this means we have chunks of metadata for
107 files we aren't using sitting around in RAM.  We also have the *files* sitting
108 around in RAM too.  Not that concerned, for now.  Plus, I don't want to reparse
109 the CPIO backing store to figure out inode fields, directory names, etc.
110
111 Page Cache:
112 -------------------------------------------
113 Every object that has pages, like an inode or the swap (or even direct block
114 devices) has a page_map tracking which of its pages are currently in memory.
115 This is called a struct address_space in linux, which is a confusing name.  We
116 don't have all of the same fields yet, and may be doing things slightly
117 differently, but the basics are the same.  Together, the page_maps and the
118 functions to manipulate them make up the Page Cache.  Every page frame that is
119 in a page mapping can be traced back to its page_map, via pointers in the struct
120 page.  Note the page_mapping is tracked twice for a file, the f_mapping and the
121 i_mapping.  We really only need the i_mapping, but this saves a couple cache
122 misses.  Might go away later.
123
124 As a side note, Linux's "address_space" has a great example of the power of
125 their linked lists.  Their struct has a private_list head.  Due to their list
126 implementation, they are able to have a generic list head for a list of any
127 type (it's a struct list_head), and don't need to declare in a generic object
128 (like the page_map) a specific list type (that would get used by specific
129 FS's).
130
131 Just because a page is in a page_map, it doesn't mean it actually has the
132 data from the disc in it.  It just means that there is a physical frame
133 dedicated/mapped to be a page_map's holder for a specific page of an object
134 (usually a file on disc).  readpage() is called to fill that page in with what
135 it is supposed to have from its backing store.
136
137 This interpretation makes the meaning of "address space" make more sense.  It's
138 the "address space" of the device, mapping from (file,index) -> page_frame.
139 Still, calling it an address space just confuses things with the virtual memory
140 address space.
141
142 One of the reasons pages can be in the map without up-to-date data is due to
143 concurrency issues and outstanding I/O requests.  When the page is first being
144 filled up, the mapping exists but the data hasn't been brought in yet.  Other
145 processes can be trying to access the same block/page/byte, and they need to
146 block but to not try and schedule the operation.  
147
148 So here's how a typical page fault (__handle_page_fault(), either on demand or
149 populated) works on an mmap'd file at a high level.
150 1. PF is on a virt address -> translated by the vm_region to a file/offset (page).
151 1b. Weird permission issues?  See below!
152 2. Look it up in the page_map.
153 3. If the page is already there, and up-to-date, then great.  Skip to 6.  If
154 there is one, but it's not up to date, skip to 5.
155 4. If there is no page, get a free page, tie it (bidirectionally) to the inode
156 in the page_map.
157 5. Now there is a page, but it is not up to date, so call readpage().  This will
158 usually block.
159 6. Map that page (which has the current contents) into the address space of the
160 calling process (with the appropriate permissions, RO (MAP_PRIVATE, CoW), or
161 RW (MAP_SHARED).
162 Below: Now if in step 1 you had a permissions issue, such as a RW fault on a CoW
163 MAP_PRIVATE, you'll have to notice the type of error and the type of memory
164 region, then go through a separate path: get a new page, copy the contents, and
165 change the mapping.  Note, the page backing that mapping is not backed by the
166 file - it's just sitting around in the virtual memory of the process.
167
168 Also, if we want to use the PG_DIRTY flag, we'll need mark the regions as RO
169 until we write fault, at which point we dirty the page and change it to RW.
170
171 We could have multiple threads trying to fill a page in the page cache at once.
172 This is handled in file_load_page().  All threads check the page cache.  If two
173 threads try to add it to the page cache, only one will succeed, and the page
174 will be locked (PG_LOCKED).  The one who succeeds will readpage().  The one that
175 didn't will be like any other thread that is checking the page cache - it will
176 see a page is there, and will check it the page is up to date.  If it isn't, it
177 will try to lock the page so it can do the IO, with a few extra checks in case
178 the page had been removed or was filled in while it slept.
179
180 A big aspect of this is the use of lock_page() to block.  If the page is locked,
181 you block until it is unlocked.  (implementation and other issues still
182 pending).  Even the caller of readpage will lock after submitting the IO
183 request.  This will cause the caller to sleep until the IO is done.  When the IO
184 is done, that interrupt handler/thread will mark the page as up-to-date, and
185 unlock the page, which will wake up any of the waiters.  The caller of
186 readpage() may not be the first to wake up either.  This all means the IO system
187 needs to know about marking pages as up-to-date and unlocking them.  This
188 currently (Jul10) is just sitting in KFS, but can be done later either directly
189 or with a callback made by
190 whoever starts the IO.
191
192 A note on refcnting.  When a page is added to the page cache, that's a stored
193 reference.  When you lookup a page in the page cache, you get a refcnt'd
194 reference back.  When you pull a page from the page cache, you also get a
195 refcnt'd reference back - specifically it is the ref that was in the page map.
196
197 Files with Holes
198 --------------------------
199 If a file has a hole, we'll still try to look up the page in the page cache.
200 When that doesn't happen, we'll create and add a page, then call readpage().
201 Readpage will realize there is no page on disk/backing store for that part of
202 the file (since it was a hole) and just memset the page to 0.  In the future, we
203 can consider getting a CoW 0-page, but that's a bit premature and a bookkeeping
204 pain.
205
206 This also applies to trying to write to a block beyond the EOF.  If the request
207 hits the page cache and readpage(), it's because it was already checked and
208 cleared in another part of the VFS, such as in generic_file_write().
209
210 Files That End Before a Page Boundary
211 --------------------------
212 So what if we have a file that is only 1024 bytes.  When we read it in, we'll
213 have a whole page added to the page cache, with the extra 3K 0'd.  When we go to
214 write it back, it will write back the 1K, and ignore the rest.  But what if we
215 extend the file later?  That page is already in the page cache, but the buffer
216 heads aren't tracking the new 3K.  When that page gets evicted, only the 1K will
217 write back.
218
219 There are two ways to deal with this: 1) When we extend the file, check and see
220 if it is in the middle of a page, and if so, alloc the blocks (all FS
221 specific!), and adjust the BHs to map the new data.  2) Preallocate the
222 remaining blocks and stitch up the BH mapping at readpage (which is in the
223 specific FS).  This way, we reserve the blocks (but don't have to actually read
224 them in - we just mark the buffer as dirty).  When we grow a file, we don't need
225 to worry about any of these details.  We just make sure the page map has the
226 page, and not whether or not it's a half-page that needs a FS-specific solution.
227 I'm going with #2 for now.  Note that while the blocks are allocated, the file's
228 size is still 1024B.
229
230 Kref, Dentries, Inodes, and Files (or "I don't see why it's like X, but..."
231 --------------------------
232 There are multiple dentries pointing to an inode.  The dentries are (or will be)
233 cached too, but that is irrelevant.  The dentries pin the inodes in memory.
234 However, files pin inodes in memory (or they did) briefly.  After running around
235 in circles a bit, I asked, why doesn't the file pin the dentry instead of the
236 inode?  The answer: it is supposed to.  Linux does that, and I didn't because
237 pinning the inode made more sense at the time.
238
239 The heart of the issue is about understanding what files are and how they
240 relate to the rest of the VFS.  A 'file' in the OS is a structure to track an
241 open FS-disk-file, which is managed by the inode.  Given this, it makes sense
242 that a dentry (which is a name on a path) would be pinned by the corresponding
243 inode, and the file would pin the inode.  It doesn't, but it is believable.  In
244 reality, there are many names (dentries) for a given disk file, and the OS file
245 that you open corresponds to *one* of those names, and thus a dentry, and not to
246 the inode/specific file.  You need to go through the dentry to pin the inode.
247
248 In short, it's not: file -> inode -> dentry -> parent_dentry -> ...
249 It's file -> dentry -> parent_dentry ->
250              |-> inode      |-> parent_inode
251 Another dentry and file (both OS and disk) can point to the same inode.  If you
252 don't do it this way, you can't pin up past the multi-dentry-point in the inode,
253 and your system doesn't really make sense.
254
255 So here is how it works: files pin dentries.  Dentries can pin other dentries,
256 on up the directory hierarchy.  Independently of the files, dentries pin their
257 inode.  There are many dentries per inode (or can be).  Since each dentry
258 doesn't know if it is the last dentry to decref the inode, we use a kref on
259 i_kref.  The inodes are storing references to the dentries, but they are the
260 kref "internal" / weak references.  Even if we did decref them, we don't trigger
261 anything with it.
262
263 The moral of the story is that if you don't fully understand something, you are
264 not in as good of a position to recommend changes or criticize as if you did
265 your homework.  Not that you can't, just that you should 'do your homework.'
266
267 Musings on path_lookup()
268 --------------------------
269 Things can get tricky with path lookup, especially with ., .., and symlinks.
270 When doing a LOOKUP_PARENT on a . or .., we give the parent of whatever the path
271 would have resolved too.  So /dir1/dir2/dir3/.'s parent is dir2.
272 /dir1/dir2/dir3/..'s parent is dir1.  I don't think Linux does this (note the
273 parent lookup is for internal kernel stuff, like when you want to edit
274 metadata).  When you try to make a . or .. file, you should get some sort of
275 error anyways.  We'll see how this works out.
276
277 Symlinks can be a bit tricky.  We handle ours a bit differently too, especially
278 regarding PARENT lookups.  Ultimately, you can do the same things in ROS that
279 you can do in Linux - if you try to create a file that is a dangling symlink,
280 you'll correctly create the destination file.  We handle this in
281 link_path_walk().  It will return the PARENT of whatever you would resolve to -
282 instead of trying to handle this in do_file_open() (which I think linux does).
283
284 Also, our handling of symlinks differs a bit from linux.  Eventually, it has
285 become clear we're going to need to manually port ext2, and we do some things
286 differently in our core VFS already.  Might as well do more thing differently -
287 like getting rid of follow_link and put_link from the FS specific sections.  Our
288 FSs just need to know how to return a char* for a symname - and not do any of
289 the actual link following.  Or any of the other stuff they do.  We'll see if
290 that turns out to be an issue or not...
291
292 Unlinking and other Link Stuff
293 -------------------------
294 Unlinking is just disconnecting a dentry-inode pair from the directory tree, and
295 decreasing the inode's i_nlink.  Nothing else happens yet, since we need to keep
296 the FS-file (controlled by the dentry/inode) so long as any OS-files have it
297 open.  They have it opened via open or mmap - any way that there is a reference
298 to a file, which then pins the dentry and inode.  When the OS-files close,
299 eventually the dentry's refcnt hits 0.  When it does, it normally would be up
300 for caching, but we can check nlinks and just drop it.  When that happens, it
301 releases the inode, which will see its nlinks is 0.  That will trigger the
302 underlying FS to clear out the FS-file.
303
304 For directories, you can only have one hardlink to a directory - meaning you are
305 only in the directory tree in one place.  However, all of your children can get
306 to you by going '../'.  We'll count these as hardlinks too.  This means that
307 every child increments its parent-dir's nlink.  This is the on-disk links, not
308 to be confused with the dentry->d_parent and kref() business that goes on for
309 the in-memory objects.  A directory cannot be removed if nlinks > 1.  If it is
310 1, then you can rmdir it, which will set its nlinks to 0.  Then its inode's
311 storage space will get freed when it is deleted, like any other inode.  In
312 theory.
313
314 Inodes: drop? delete? dealloc?
315 --------------------------
316 Inodes exist both in memory and on disk, but in different manners.  When a file
317 (F_WHATEVER, could be DIR) exists in an FS, it'll have an inode on disk.  When
318 it is time to delete that file, we call _delete_inode().  When we want to free
319 the memory associated with an in-memory (VFS) inode, we call _dealloc_inode().
320
321 What about drop_inode?  For now, we don't use it.  We have inode_release() in
322 the VFS.  If we need an FS specific one (like for ext2), or have FS-specific
323 work that needs to be done in inode_release(), we'll use it later.
324
325 Either way, inode_release() is called when we no longer use the in-memory inode.
326 If there are no hard links, it will delete the inode.  Either way, it will just
327 free the in-memory inode (after deleting the disc version).
328
329 Example: I want to unlink (rm) a file.  There are two cases: the file is already
330 open (with a dentry and the inode in memory) or the file is not.  Both cases are
331 handled the same way!  In either case, we eventually call do_lookup on the item
332 in question, getting both a dentry and its inode read in.  (We read it in for a
333 couple reasons: convenient to check the type, and we need to manipulate the
334 nlink).  If a process has the file open, or even if it is sitting in the cache,
335 we will get the same inode (from the inode cache, might not be implemented yet).
336 When we decref the dentry and it is done, it will decref the inode.  This
337 dentry's final decref will be deferred until any open files are closed.  Note,
338 this requires a working dentry/inode-cache - otherwise we'll have multiple
339 copies of the same FS/disk-inode (and possibly dentry).  Anyway, when this is
340 done, the release function will delete the inode, then dealloc it.
341
342 Another example:  We simply close a file.  When that happens, we decref the
343 dentry, which decrefs the inode.  It may remain cached for a bit - not a big
344 deal.  When it is finally removed, nlinks is positive, so the inode's in memory
345 copy is written back (if it was dirty) and the structure is deallocated.
346
347 Side notes: dentry cached inodes should be removed after their lookup in unlink.
348 Also, since multiple dentries point to the same inode, it's not enough to just
349 cache dentries - we need to be able to find inodes too so that we get the one
350 inode regardless of which dentry we use (which may be uncached).
351
352 Dentry and Inode Caches
353 --------------------------
354 The dentry caches dentry lookups - we need the parent and a hash of the name to
355 do a lookup.  The dcache consists of a hash table for the lookups, as well as an
356 extra list of entries that are unused (their kref is 0).  The dcache also caches
357 negative entries - entries that were wrong.  This still speeds up future
358 requests.  Most uses of the system just need to use dcache_get and dcache put.
359 Not all of this is implemented yet.
360
361 The inode cache is similar, though we can't just have the inodes hang off the
362 dentry cache (more than one dentry points to the same inode).  We don't need to
363 worry about unused lists or anything like that - once the kref hits 0, we're
364 done and we can rip it out of the hash.
365
366 Both hashes hang off the superblock, with concurrent access protected by locks
367 in the SB.
368
369 The dentry cache is the weirdest of them all - for normal entries, its key and
370 value are the same thing.  The actual hashing of a dentry is done by the qstr
371 value, and to determine equality, we need to compare parents (compared to the
372 inode cache, where the only thing that matters is the i_ino).  Put another way,
373 we need elements of the whole dentry to get a unique key (d_parent and d_name).
374
375 As stated above, the dcache also caches negative entries.  This is to prevent a
376 lookup on disk.  These negative entries are in the dcache and on the LRU list
377 (their refcnt is 0, the are not USED).  When we dcache_get, we don't bother with
378 returning the actual dentry (after increffing) and then decref it again.
379 Instead, we just return the negative result (via the query dentry,
380 incidentally).
381
382 Freeing of dentries happens in one of two ways: call __dentry_free() directly,
383 which is appropriate when you have the only copy (like in do_lookup()), or it
384 will get freed when the dcache gets reaped (the LRU entries are freed).  When it
385 is decref'd, it simply goes into a state where it is ready to be reaped, but
386 kept around for future lookups - most usages throughout the vfs can just decref
387 when they are done using it.
388
389 One complication is cached negative dentries.  These are only referenced once
390 (in the dcache), so they can get __dentry_free()d directly.  This gets tricky
391 with rmdir and unlink.  Initially, those functions marked the dentry as negative
392 and unused, and would let them stay in the dcache (returning negative results on
393 future lookups).  The problem with this is that now the dcache could have a
394 negative dentry that was a real, formerly used dentry - one with a refcnt that
395 needs to be decref'd and released.  
396
397 There are two solutions: one is to change the dcache to not assume that negative
398 entries are unreferenced (which also means on the LRU).  The other is to just
399 remove the dentry from the dcache on rmdir/unlink.  It won't be negative - and
400 that won't matter, since it is un-lookup-able.  And it will die nicely when it
401 gets decref'd.  All we'll do is add a DENTRY_DYING flag, and dentry_release()
402 will avoid LRU and unusing it.  The dcache can continue to assume that negative
403 entries are unused/LRU/dentry_freeable/ref==0, and not worry about calling
404 kref_put().
405
406 X: Buffer Cache, Page Cache, Buffer Heads, WTH?
407 -------------------------------
408 X.1: Page vs Buffer Cache
409 --------------------
410 So we discussed the page cache, but as described, it does not satisfy all of
411 our disk caching needs.  Traditionally, there would also be a 'buffer cache.'
412 Buffers usually refer to memory used to hold data from the disk (or network).
413 I can think of a couple different ways someone could think of the buffer
414 cache, and to understand them, we first need to understand what we need to be
415 caching.
416
417 There are two main types of FS data: file data and metadata.  This metadata
418 is FS-specific data accessed by the VFS to get to a file's contents.  For
419 example, the superblock, inodes, inode indirect blocks, and to a certain
420 extent the directory's contents are all metadata.  There isn't an FS file (not
421 to be confused with an OS file) that corresponds to this data, but it needs to
422 be read in and cached.  Furthermore, this cache needs to be managed and
423 written back when dirty.  Note that file data can be broken up into two
424 different types: read()/write() data and mmap'd data.  When people talk about
425 buffer caches versus page caches, they are talking about these two different
426 types of file data (at least NetBSD did
427 http://www.usenix.org/event/usenix2000/freenix/full_papers/silvers/silvers_html/).
428
429 A very simple buffer cache would include anything *ever* read from disk.  It
430 would then get copied into the page cache in PGSIZE chunks for the page cache.
431 This would suck, since we now have two or three copies.  We obviously want to
432 use the page cache for both mmap() and read/write().  It's not clear about the
433 metadata.
434
435 Another usage of a buffer cache would be to cache only the disk blocks needed
436 for metadata.  I think this is what Linux did before it unified its buffer and
437 page caches (implied in UTLK).  The main issue with this is that you have two
438 different systems for managing essentially similar data - we only want to deal
439 with flushing, syncing, and writebacks of one subsystem, not in multiple
440 different subsystems.
441
442 The solution is to use the page cache to cache the metadata blocks' buffers.
443 We do this by having the block device be 'mapped' (but not read) in PGSIZE
444 chunks through its own struct page_mapping (a.k.a. struct address_space in
445 Linux).  This way, both files and the block device are mapped in PGSIZE chunks
446 via the same page_mapping structure, and will be managed by the same code.
447
448 Sort of.  We don't actually read in PGSIZE chunks for the block buffer cache.
449 If blocks will be in the bdev's cache, then they will be adjacent and on the
450 same page.  It is possible some adjacent blocks (which would be on the same
451 page) are not both metadata.
452
453 A more accurate way to describe what we do is that metadata blocks are copied
454 into a 'buffer cache' that is mapped and managed similarly to the page cache.
455 Pages are made of buffer heads, which hold data, and the reclaiming of pages of
456 memory from either the page cache or the buffer cache will use the same code -
457 since they are both just made of buffer pages.
458
459 X.2: Mapping Blockdev Data vs File Data
460 --------------------
461 An important distinction between file data (as managed by an inode) and the
462 bdev is that PGSIZE chunks of data for the bdev *must* be made of contiguous
463 disk blocks.  Ideally, file data is also contiguous/sequential, but that is
464 not always the case - hence the need for the inode's block pointers.  This
465 means that the chunk at the bottom of the page_mapping radix tree is a page,
466 and on that page there may be several buffers, holding the data of
467 nonsequential disk blocks - but that not all pages are like this.  The bdev
468 pages are made up of sequential blocks due to the very nature of what we are
469 mapping; there's no inode abstraction in between.
470
471 There are a couple ways we could handle this.  We adopt the Linux approach of
472 using something called a buffer head (BH), which describes the mapping from
473 in-memory buffer to block device / block number.  These are slab-allocated,
474 and exist for each buffer of a page.  The page itself points to the first of
475 its BHs, all of which exist in a LL.  The maximum number of them is determined
476 by PGSIZE / blocksize.  Whenever there is a page in the page cache (meaning, in
477 a page_mapping), that is up to date, it will have a BH.
478
479 Another way would be to not have BHs at all, and just figure out (at
480 operation-time) what the n blocks on disk are for any given page, and submit
481 the IO operations for those blocks.  The BHs serve as a cache of that info.
482 They also serve as a location to store data about the mapping, such as whether
483 it is dirty or not, whether the data is up to date or not (has it been read
484 in), etc.  The caching ought to be rather beneficial, since it means we do not
485 need to access the disk-inode and indirect blocks whenever we want to perform
486 an operation (which may be frequent - imagine the periodic writeback of an
487 mmap'd file undergoing writes).  The per-buffer dirty tracking will also help:
488 no need to write unrelated blocks if only one is edited (though this will not
489 help with mmap(), since we don't usually know which part of the page is
490 written).
491
492 X.4: Do we always need BHs?
493 ------------------
494 But what about those pages made up of contiguous blocks?  We don't have a
495 bunch of independent, non-sequential blocks that we need to map.  Do we need a
496 bunch of BHs for that?  Do we need any?  It really seems excessive to break it
497 up into separate buffers for no reason.  At the other extreme, we could get by
498 without having a BH at all, though this gets back to the other issue of
499 caching.  What we do (or will do) is have one BH for the entire page of
500 contiguous blocks.  If the page is a "buffer page," in Linux terms (meaning it
501 has separate buffers), it will have n BHs in a LL.  Either way, we'll always
502 have the mapping handy.  We wouldn't need to re-verify the contiguous nature of
503 the blocks anyways, since the fact that the page was up to date and didn't need
504 a BH would mean it was contiguous.  Further benefits to using the one BH
505 include: 1) we are likely to make BHs be the unit of IO *submission*, and having
506 one handy will simplify that code. 2) some code paths within the VFS may get BHs
507 as a return value, which they can then dirty.  Always having a BH makes this
508 easier (no need to find out if it's a buffer page, then decide how to dirty it).
509
510 Another compliation with this is certain code will want a block in the middle
511 of a page (very common for metadata).  That code will get the BH for the
512 entire page back.  It will need to determine the starting block and then the
513 offset of the block it wants.  Note, this usage of the BHs is finding the
514 buffer corresponding to a block number.  The BH is a bidirectional mapping
515 between buffers and blockdev:blocknum.  These calculations are a minor
516 complication, but easy enough to do, and will probably be worth it.  The
517 tradeoff is against having multiple BHs, which would mean multiple block IO
518 requests for writing a single page (and writing the whole page may be a common
519 operation).
520
521 X.3: What about opening a blockdev as a file?
522 --------------------
523 Basically, don't do it for now.  The way we actually do things is a buffer cache
524 page is "up to date", but has no BHs or data until a specific block is
525 requested.  This is because we don't always know if all the blocks mapped by a
526 page are actually metadata blocks.  If they aren't we'll have issues where we
527 read in extra blocks that exist in both a file's page cache and the block
528 device's buffer cache.
529
530 A safe invariant is that a given block will only ever be in one cache: either a
531 file's page mapping or the buffer cache's page mapping.  When these blocks are
532 freed, we'll need to rip them out of their mapping (and possibly flush them).
533
534 There is one easy way to avoid this: don't open a bdev file if a file system is
535 mounted on top of it.  If you do, don't be surprised about inconsistencies.
536 Ideally, the FS will never leave the actual disk in an inconsistent state, but
537 the bdev's page cache could read things at different times and get some weird
538 results.  Just don't do this (for now - not like I plan to make this possible
539 any time soon).
540
541 Could we use the same buffers for both the blockdev-file page mapping and the
542 inode-file page mapping?  No - because the inode-file has the inode
543 indirection in between, which means a PGSIZE chunk of the file might not be
544 contiguous (as mentioned above).
545
546 We could have tried to avoid this bdev file problem by having the page mapping
547 radix trees point to a set of BHs that describes that page worth of buffers,
548 so that the bdev and an inode pointing to the same data will use the same
549 buffers and BHs.  That won't work, since the files buffers/blocks aren't in
550 the same order as they are on disk within a page.  Instead, we'd need to have
551 the page mapping go down to the FS's blocksize granularity, not to PGSIZE, so
552 that we could have independent leaves point to wherever they want.  This would
553 push the specific block device's blocksize into the VFS (which I don't like).
554
555 But the blocksize-infecting-the-VFS alone isn't too bad.  The real issue is
556 what is at the end of the page mapping.  Is it a page or a buffer/BH?  We want
557 pages for two related reasons: higher levels of the kernel's IO systems deal
558 with pages:
559 1. mmap().  Good old mmap() requires at least a page of contiguous block
560 buffers, so that the physical page frame can be mapped directly into a
561 process's address space.
562 2. Fast IO.  We want to use page remapping for fast IO.  This means that IO
563 has to be in PGSIZE chunks - not blocksize chunks.
564
565 x.4: Managing Dirty Buffers
566 --------------------
567 Many (some/all?) of the block functions will return a BH to describe the
568 mapping.  One reason for doing this (mentioned above) is to allow the caller
569 to manage if a buffer is dirty or not.  The tracking of dirty pages is done by
570 the page cache.  The dirtying is done by the caller; it can simply mark the BH
571 dirty and forget about it.  The writeback is handled usually by the page cache
572 or is triggered by an FS event.  Eventually, we'll have a kernel thread that
573 periodically writes dirty buffers back to disk.  Processes can also do this by
574 calling fsync.  FSs themselves will trigger syncs of metadata.  This will come
575 from having dirty SBs and inodes in the VFS.
576
577 Note, the issue of whether or not we pin metadata blocks, such as the inode's
578 indirect blocks (or other related blocks), in the page cache is independent of
579 all these issues.  If they are not cached / pinned, we would just have to
580 block and reread the inode's structures back into memory and proceed (for
581 instance, we'd do this when identifying blocks for a page mapping on a file
582 read).  The reason we wouldn't want to pin them is to save memory.
583
584 x.5: Reference Counting BHs and Pages
585 --------------------
586 There are a lot of complications with this, and if there is a good reason,
587 we'll change this later.
588
589 x.5.1: Basics
590 -----------
591 So we talk about passing around BHs, both when submitting IO ops and when
592 returning from things like get_buffer().  However, currently, we do not kref
593 or reference count BHs in any way.  Instead, we kref pages.  We do this (for
594 now) for a couple reasons:
595 1) Pages are the unit of memory management in the kernel.  Higher levels of
596 the kernel will pin/incref the page (such as in an mmap()).
597 2) BHs hang off of a page, but exist only to be expressive about the
598 management of the buffers on the page.  It's not like how a file hangs off a
599 dentry, where the dentry doesn't know (or care) about the file.
600 3) We already refcount pages.  While we could do the same for the BHs, it is a
601 bit redundant.  Any place that would be kreffing the BH can just kref the
602 whole page.  Code that receives a BH as a return value is actually getting a
603 page under the covers (though should use put_buffer() to drop its reference).
604
605 x.5.2: How we refcnt pages in a page mapping
606 -----------
607 When a page is in the page cache, we give it one kref.  Whenever a function or
608 subsystem is using one of these pages (IO, using the data, etc), there needs
609 to be a kref.  When it is time to remove the page from the page mapping, the
610 code needs to remove it from the radix tree, then kref_put it.  When the final
611 user is done with it (ideally, there is none, but we need to handle the case)
612 the release function will clean up the page - including freeing its BHs.
613
614 This does suck in that we could be removing an item from the page cache while
615 it is being used, violating some LRU policy.  The actual decision to remove it
616 should use those policies (when possible); the kreffing is simply to avoid
617 issues from race conditions.  (A reader starts using a page right before it is
618 ripped from the mapping).
619
620 x.5.3: More issues with Evictions
621 -----------
622 One issue with this is that dirty pages/buffers will need to be written back.
623 If someone tries to read while the page is removed from the page_mapping, but
624 before it is written back, they could get an old version if the read happens
625 before the write.  This is only an issue if the page is dirty.  One option
626 would be to writeback the page/buffer, then later remove it from the page
627 cache when it is read.  There's issues with concurrent writers, though if that
628 happens, we probably don't really want to remove it (it was LRU).  Note this
629 is an issue regardless of whether or not BHs are refcounted.  Also, this is
630 not an issue for when we kick a dentry/inode out of the cache - there should
631 be no one else trying to use it (since their refcnt was 0).  This is just a
632 concern when the system runs low on memory and wants to reclaim potentially
633 memory held by caches.
634
635 Also note that writeback of pages will happen regardless of eviction plans
636 (fsync, every n sec, etc).
637
638 This refcounting pattern is very similar to unlinking, where you can continue
639 to access a file once it is removed from the directory.  The difference here
640 is that future requests will get the same object (the page), unlike in the FS,
641 where you get ENOENT.  The page mapping is a cache, and you need to get the
642 same old data that was in there before the eviction.
643
644 A final issue is when the VFS aggressively pins blockdev (metadata) buffers.
645 Ideally, we'd like to be able to expel pages/buffers even if they are
646 refcnt'd.  The subsystems will always want to keep stuff in RAM.  This
647 also/especially applies to mmap().  One solution would be to keep them in RAM,
648 but have the BH keep track of who is holding its reference.  Then we could
649 unmap the page, which would need to get read back in on its next access.  We'd
650 need (or ought to have) some sort of callbacks.  This will get solved later
651 when we deal with unmapping mmap'd files, since it is the same problem - just
652 with different code and actors.
653
654 x.5.4: What about buffers inside pages?
655 -----------
656 For a while, I thought about refcounting BHs/buffers.  The issue that drives
657 it is the buffer cache (block dev page mapping holding metadata blocks of a
658 FS).  We had been operating on the cache in page-sized chunks, which
659 erroneously was reading in blocks adjacent to metadata blocks.  This would
660 have been an issue when we write back pages that have dirty blocks; blocks
661 were erroneously in the metadata cache and would overwrite potentially
662 file-realted blocks that were in an incoherent cache (the file/inode's page
663 mapping).
664
665 We broke the bdev's buffer cache up into smaller BHs, so that only metadata
666 blocks get read in, but we eventually will have to get rid of a metadata block
667 (and not the entire page from the cache) (ex: an inode is removed from the
668 disk - its indirect blocks need to go, and they could be next to anything on
669 disk).  The desire for the BH refcnt came from wanting to rip the BHs out of
670 the list when it was time to evict them from the cache (in case they became
671 file blocks later).  It isn't clear what the best way to do this is.  Probably
672 we'd have all users refcnt the BHs, which refcnt the pages.  However, some
673 users (like mmap and the file page cache) operate in page chunks - so this
674 would require them to incref and decref the BHs.  Triggering the page reclaim
675 might also be tricky.  One option would be to just rip a page from the cache,
676 callback to whoever has it loaded so they fault it back in later, and
677 sleep-block everyone who interferes with the operation.  Yikes.
678
679 Another option was to forget about the BH <-> page crap for the buffer cache,
680 and just have a standalone buffer cache with BHs as its unit of operation
681 (instead of a page), and replicate the algorithms/code for the buffer cache.
682 There is still a notion of BHs in a page, and page_release() / page_free()
683 would probably have to be a little different since its page isn't really a
684 PG_BUFFER (but it really is).
685
686 Instead, here's what we do: we refcnt at page granularity, since all users can
687 be considered users of a page.  While it's not fine-grained, it does represent
688 the idea that someone doesn't want the page to be freed.  It's similar to
689 having a dentry be the refcnt source when someone really wants the inode/file.
690 When we want to remove a page from the block buffer cache, all we do is mark
691 it as not dirty and not up-to-date.  Now, whenever the page gets evicted from
692 the cache, we only write back those block buffers that are dirty, so the
693 recently evicted block will not be written back.  If we attempt to read the
694 block in the future (perhaps it is reallocated as a metablock), then the BH is
695 still there for the mapping, but is simply not up to date.  The code already
696 knows how to handle this (since it could happen during a race condition), and
697 it will simply read the buffer back in.  This new reading is necessary, since
698 it is possible that the block was used for file IO in between the uses of it
699 as a metablock.
700
701 If there are more than one thread operating on a block buffer in the page
702 cache, then at the level of the cache, there is a race.  One could be marking
703 it as not dirty while another is dirtying it, etc.  However, no one should be
704 removing a buffer (aka, deallocating a block) while it is in use.  This sort
705 of concurrency problem should be sorted higher in the software stack (like at
706 the inode).
707
708 On a similar note, no one should ever remove a block's buffer from the
709 metadata buffer cache if it is dirty.  When those removals happen, it means
710 the block should be dealloced on the block device - meaning no one cares what
711 happens to it.  It's not meant to have data preserved.
712
713 x.6: What about Directories?  Inodes or metadata?
714 --------------------
715 Directories have inodes that have blocks scattered around the disk.  The blocks
716 making up the body of a directory are not sequential, like when you read blocks
717 from a bdev.  If you wanted a "page" of a directory, then you'd need to use the
718 i_mapping (page cache of a file) to access it, like any other file.
719
720 However, we don't want a page of a directory - at least not yet.  The main
721 reason we can get away with this is due to the lack of a mmap() or a desire to
722 page-remap for directory-contents IO.  It's all for the kernel's internal use.
723 At no point does anyone call generic_file_read() or _write() on it.
724
725 That being said, we treat the blocks of a directory as metadata blocks.  We do
726 figure out which blocks they are by walking the inode (also made of metadata
727 blocks), but don't bother to set up a page map for the directory itself.  We
728 just use the inode to figure out which metadata blocks we want, then read them
729 in (out of the blockdev's page cache).
730
731 Note that userspace issues reads on the directory.  This is mostly a convenience
732 thing (or an inconvenience thing), which just ends up being a wrapper around
733 readdir() (via generic_dir_read()).