Add support for attempting returns from panic
[akaros.git] / kern / src / ext2fs.c
1 /* Copyright (c) 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Ext2, VFS required functions, internal functions, life, the universe, and
6  * everything! */
7
8 #include <vfs.h>
9 #include <ext2fs.h>
10 #include <blockdev.h>
11 #include <kmalloc.h>
12 #include <assert.h>
13 #include <kref.h>
14 #include <endian.h>
15 #include <error.h>
16 #include <pmap.h>
17 #include <bitmask.h>
18
19 /* These structs are declared again and initialized farther down */
20 struct page_map_operations ext2_pm_op;
21 struct super_operations ext2_s_op;
22 struct inode_operations ext2_i_op;
23 struct dentry_operations ext2_d_op;
24 struct file_operations ext2_f_op_file;
25 struct file_operations ext2_f_op_dir;
26 struct file_operations ext2_f_op_sym;
27
28 /* EXT2 Internal Functions */
29
30 /* Useful helper functions. */
31
32 /* Returns the block group ID of the BG containing the inode.  BGs start with 0,
33  * inodes are indexed starting at 1. */
34 static struct ext2_block_group *ext2_inode2bg(struct inode *inode)
35 {
36         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)inode->i_sb->s_fs_info;
37         unsigned int bg_num = (inode->i_ino - 1) /
38                               le32_to_cpu(e2sbi->e2sb->s_inodes_per_group);
39         return &e2sbi->e2bg[bg_num];
40 }
41
42 /* This returns the inode's 0-index within a block group */
43 static unsigned int ext2_inode2bgidx(struct inode *inode)
44 {
45         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)inode->i_sb->s_fs_info;
46         return (inode->i_ino - 1) % le32_to_cpu(e2sbi->e2sb->s_inodes_per_group);
47 }
48
49 /* Returns the inode number given a 0-index of an inode within a block group */
50 static unsigned long ext2_bgidx2ino(struct super_block *sb,
51                                     struct ext2_block_group *bg,
52                                     unsigned int ino_idx)
53 {
54         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)sb->s_fs_info;
55         struct ext2_sb *e2sb = e2sbi->e2sb;
56         struct ext2_block_group *e2bg = e2sbi->e2bg;
57         return (bg - e2bg) * le32_to_cpu(e2sb->s_inodes_per_group) + ino_idx + 1;
58 }
59
60 /* Returns an uncounted reference to the BG in the BG table, which is pinned,
61  * hanging off the sb.  Note, the BGs cover the blocks starting from the first
62  * data block, not from 0.  So if the FDB is 1, BG 0 covers 1 through 1024, and
63  * not 0 through 1023. */
64 static struct ext2_block_group *ext2_block2bg(struct super_block *sb,
65                                               uint32_t blk_num)
66 {
67         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)sb->s_fs_info;
68         unsigned int bg_num;
69         bg_num = (blk_num - le32_to_cpu(e2sbi->e2sb->s_first_data_block)) /
70                  le32_to_cpu(e2sbi->e2sb->s_blocks_per_group);
71         return &e2sbi->e2bg[bg_num];
72 }
73
74 /* This returns the block's 0-index within a block group.  Note all blocks are
75  * offset by FDB when dealing with BG membership. */
76 static unsigned int ext2_block2bgidx(struct super_block *sb, uint32_t blk_num)
77 {
78         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)sb->s_fs_info;
79         return (blk_num - le32_to_cpu(e2sbi->e2sb->s_first_data_block)) %
80                le32_to_cpu(e2sbi->e2sb->s_blocks_per_group);
81 }
82
83 /* Returns the FS block for the given BG's idx block */
84 static uint32_t ext2_bgidx2block(struct super_block *sb,
85                                  struct ext2_block_group *bg,
86                                  unsigned int blk_idx)
87 {
88         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)sb->s_fs_info;
89         struct ext2_sb *e2sb = e2sbi->e2sb;
90         struct ext2_block_group *e2bg = e2sbi->e2bg;
91         return (bg - e2bg) * le32_to_cpu(e2sb->s_blocks_per_group) + blk_idx +
92                le32_to_cpu(e2sb->s_first_data_block);
93 }
94
95 /* Slabs for ext2 specific info chunks */
96 struct kmem_cache *ext2_i_kcache;
97
98 /* One-time init for all ext2 instances */
99 void ext2_init(void)
100 {
101         ext2_i_kcache = kmem_cache_create("ext2_i_info",
102                                           sizeof(struct ext2_i_info),
103                                           __alignof__(struct ext2_i_info), 0,
104                                           NULL, 0, 0, NULL);
105 }
106
107 /* Block management */
108
109 /* TODO: pull these metablock functions out of ext2 */
110 /* Makes sure the FS block of metadata is in memory.  This returns a pointer to
111  * the beginning of the requested block.  Release it with put_metablock().
112  * Internally, the kreffing is done on the page. */
113 void *__ext2_get_metablock(struct block_device *bdev, unsigned long blk_num,
114                            unsigned int blk_sz)
115 {
116         return bdev_get_buffer(bdev, blk_num, blk_sz)->bh_buffer;
117 }
118
119 /* Convenience wrapper */
120 void *ext2_get_metablock(struct super_block *sb, unsigned long block_num)
121 {
122         return __ext2_get_metablock(sb->s_bdev, block_num, sb->s_blocksize);
123 }
124
125 /* Helper to figure out the BH for any address within it's buffer */
126 static struct buffer_head *ext2_my_bh(struct super_block *sb, void *addr)
127 {
128         struct page *page = kva2page(addr);
129         struct buffer_head *bh = (struct buffer_head*)page->pg_private;
130         /* This case is for when we try do decref a non-BH'd 'metablock'.  It's tied
131          * to e2ii->i_block[]. */
132         if (!bh)
133                 return 0;
134         void *my_buf = (void*)ROUNDDOWN((uintptr_t)addr, sb->s_blocksize);
135         while (bh) {
136                 if (bh->bh_buffer == my_buf)
137                         break;
138                 bh = bh->bh_next;
139         }
140         assert(bh && bh->bh_buffer == my_buf);
141         return bh;
142 }
143
144 /* Decrefs the buffer from get_metablock().  Call this when you no longer
145  * reference your metadata block/buffer.  Yes, we could just decref the page,
146  * but this will work if we end up changing how bdev_put_buffer() works. */
147 void ext2_put_metablock(struct super_block *sb, void *buffer)
148 {
149         struct buffer_head *bh = ext2_my_bh(sb, buffer);
150         if (bh)
151                 bdev_put_buffer(bh);
152 }
153
154 /* Will dirty the block/BH/page for the given metadata block/buffer. */
155 void ext2_dirty_metablock(struct super_block *sb, void *buffer)
156 {
157         struct buffer_head *bh = ext2_my_bh(sb, buffer);
158         if (bh)
159                 bdev_dirty_buffer(bh);
160 }
161
162 /* Helper for alloc_block.  It will try to alloc a block from the BG, starting
163  * with blk_idx (relative number within the BG).   If successful, it will return
164  * the FS block number via *block_num.  TODO: concurrency protection */
165 static bool ext2_tryalloc(struct super_block *sb, struct ext2_block_group *bg,
166                           unsigned int blk_idx, uint32_t *block_num)
167 {
168         uint8_t *blk_bitmap;
169         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)sb->s_fs_info;
170         unsigned int blks_per_bg = le32_to_cpu(e2sbi->e2sb->s_blocks_per_group);
171         bool found = FALSE;
172
173         /* Check to see if there are any free blocks */
174         if (!le32_to_cpu(bg->bg_free_blocks_cnt))
175                 return FALSE;
176         /* Check the bitmap for your desired block.  We'll loop through the whole
177          * BG, starting with the one we want first. */
178         blk_bitmap = ext2_get_metablock(sb, bg->bg_block_bitmap);
179         for (int i = 0; i < blks_per_bg; i++) {
180                 if (!(GET_BITMASK_BIT(blk_bitmap, blk_idx))) {
181                         SET_BITMASK_BIT(blk_bitmap, blk_idx);
182                         bg->bg_free_blocks_cnt--;
183                         ext2_dirty_metablock(sb, blk_bitmap);
184                         found = TRUE;
185                         break;
186                 }
187                 /* Note: the wrap-around hasn't been tested yet */
188                 blk_idx = (blk_idx + 1) % blks_per_bg;
189         }
190         ext2_put_metablock(sb, blk_bitmap);
191         if (found)
192                 *block_num = ext2_bgidx2block(sb, bg, blk_idx);
193         return found;
194 }
195
196 /* This allocates a fresh block for the inode, preferably 'fetish' (name
197  * courtesy of L.F.), returning the FS block number that's been allocated.
198  * Note, Linux does some block preallocation here.  Consider doing the same (off
199  * the in-memory inode).  Note the lack of concurrency protections here. */
200 uint32_t ext2_alloc_block(struct inode *inode, uint32_t fetish)
201 {
202         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)inode->i_sb->s_fs_info;
203         struct ext2_block_group *fetish_bg, *bg_i = e2sbi->e2bg;
204         unsigned int blk_idx;
205         bool found = FALSE;
206         uint32_t retval = 0;
207
208         /* Get our ideal starting point */
209         fetish_bg = ext2_block2bg(inode->i_sb, fetish);
210         blk_idx = ext2_block2bgidx(inode->i_sb, fetish);
211         /* Try to find a free block in the BG of the one we desire */
212         found = ext2_tryalloc(inode->i_sb, fetish_bg, blk_idx, &retval);
213         if (found)
214                 return retval;
215
216         warn("This part hasn't been tested yet.");
217         /* Find a block anywhere else (perhaps using the log trick, but for now just
218          * linearly scanning). */
219         for (int i = 0; i < e2sbi->nr_bgs; i++, bg_i++) {
220                 if (bg_i == fetish_bg)
221                         continue;
222                 found = ext2_tryalloc(inode->i_sb, bg_i, 0, &retval);
223                 if (found)
224                         break;
225         }
226         if (!found)
227                 panic("Ran out of blocks! (probably a bug)");
228         return retval;
229 }
230
231 /* Inode Management */
232
233 /* Helper for alloc_diskinode.  It will try to alloc a disk inode from the BG.
234  * If successful, it will return the inode number in *ino_num.  TODO:
235  * concurrency protection */
236 static bool ext2_tryalloc_diskinode(struct super_block *sb,
237                                     struct ext2_block_group *bg,
238                                     unsigned long *ino_num)
239 {
240         uint8_t *ino_bitmap;
241         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)sb->s_fs_info;
242         unsigned int i, ino_per_bg = le32_to_cpu(e2sbi->e2sb->s_inodes_per_group);
243         bool found = FALSE;
244
245         /* Check to see if there are any free inodes */
246         if (!le32_to_cpu(bg->bg_free_inodes_cnt))
247                 return FALSE;
248         /* Check the bitmap for the free inode */
249         ino_bitmap = ext2_get_metablock(sb, bg->bg_inode_bitmap);
250         for (i = 0; i < ino_per_bg; i++) {
251                 if (!(GET_BITMASK_BIT(ino_bitmap, i))) {
252                         SET_BITMASK_BIT(ino_bitmap, i);
253                         bg->bg_free_inodes_cnt--;
254                         ext2_dirty_metablock(sb, ino_bitmap);
255                         found = TRUE;
256                         break;
257                 }
258         }
259         ext2_put_metablock(sb, ino_bitmap);
260         /* Convert the i (a 0-index bit)  within the BG to a real inode number. */
261         if (found)
262                 *ino_num = ext2_bgidx2ino(sb, bg, i);
263         return found;
264 }
265
266 /* This allocates a fresh ino number for inode, given the parent's BG.  Make
267  * sure you set the inode's type before calling this, since it matters if we a
268  * making a directory or not.  This disk inode is reserved on disk in the bitmap
269  * (at least the bitmap is changed and dirtied).  Note the lack of concurrency
270  * protections here.  Consider returning the BG too. */
271 unsigned long ext2_alloc_diskinode(struct inode *inode,
272                                    struct ext2_block_group *dir_bg)
273 {
274         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)inode->i_sb->s_fs_info;
275         struct ext2_block_group *bg = dir_bg;
276         struct ext2_block_group *bg_i = e2sbi->e2bg;
277         bool found = FALSE;
278         unsigned long retval = 0;
279
280         if (S_ISDIR(inode->i_mode)) {
281                 /* TODO: intelligently pick a different bg to use than the current one.
282                  * Right now, we just jump to the next one, though you should do things
283                  * like take into account the ratio of directories to files. */
284                 bg += 1;
285         }
286         /* Try to find a free inode in the chosen BG */
287         found = ext2_tryalloc_diskinode(inode->i_sb, bg, &retval);
288         if (found)
289                 return retval;
290
291         warn("This part hasn't been tested yet.");
292         /* Find an inode anywhere else (perhaps using the log trick, but for now just
293          * linearly scanning). */
294         for (int i = 0; i < e2sbi->nr_bgs; i++, bg_i++) {
295                 if (bg_i == bg)
296                         continue;
297                 found = ext2_tryalloc_diskinode(inode->i_sb, bg_i, &retval);
298                 if (found)
299                         break;
300         }
301         if (!found)
302                 panic("Ran out of inodes! (probably a bug)");
303         return retval;
304 }
305
306 /* Helper for ino table management.  blkid is the inode table block we are
307  * looking in, rel_blkid is the block we want, relative to the current
308  * threshhold for a level of indirection, and reach is how many items a given
309  * slot indexes.  Returns a pointer to the slot for the given block. */
310 static uint32_t *ext2_find_inotable_slot(struct inode *inode, uint32_t blkid,
311                                          uint32_t rel_blkid,
312                                          unsigned int reach)
313 {
314         uint32_t *blk_buf = ext2_get_metablock(inode->i_sb, blkid);
315         assert(blk_buf);
316         return &blk_buf[rel_blkid / reach];
317 }
318
319 /* If blk_slot is empty (no block mapped there) it will alloc and link a new
320  * block.  This is only used for allocating a block to be an indirect table
321  * (it's grabbing a metablock, we have no hint, and it handles the buffer
322  * differently than for a file page/buffer). */
323 static void ext2_fill_inotable_slot(struct inode *inode, uint32_t *blk_slot)
324 {
325         uint32_t new_blkid, hint_blk;
326         void *new_blk;
327
328         if (le32_to_cpu(*blk_slot))
329                 return;
330         /* Use any block in our inode's BG as a hint for the indirect block */
331         hint_blk = ext2_bgidx2block(inode->i_sb, ext2_inode2bg(inode), 0);
332         new_blkid = ext2_alloc_block(inode, hint_blk);
333         /* Actually read in the block we alloc'd */
334         new_blk = ext2_get_metablock(inode->i_sb, new_blkid);
335         memset(new_blk, 0, inode->i_sb->s_blocksize);
336         ext2_dirty_metablock(inode->i_sb, new_blk);
337         /* We put it, despite it getting relooked up in the next walk */
338         ext2_put_metablock(inode->i_sb, new_blk);
339         /* Now write the new block into its slot */
340         *blk_slot = cpu_to_le32(new_blkid);
341         ext2_dirty_metablock(inode->i_sb, blk_slot);
342 }
343
344 /* This walks a table stored at block 'blkid', returning which block you should
345  * walk next in 'blkid'.  rel_inoblk is where you are given the current level of
346  * indirection tables, and returns where you should be for the next one.  Reach
347  * is how many items the current table's *items* can index (so if we're on a
348  * 3x indir block, reach should be for the doubly-indirect entries, and
349  * rel_inoblk will tell you where within that double block you want).
350  *
351  * This will also alloc intermediate tables if there isn't one already (TODO:
352  * concurrency protection on modifying the table). */
353 static void ext2_walk_inotable(struct inode *inode, uint32_t *blkid,
354                                uint32_t *rel_inoblk, unsigned int reach)
355 {
356         uint32_t *blk_slot;
357         blk_slot = ext2_find_inotable_slot(inode, *blkid, *rel_inoblk, reach);
358         /* We could only do this based on a bool, but if we're trying to walk it,
359          * we ought to want to alloc if there is no block. */
360         ext2_fill_inotable_slot(inode, blk_slot);
361         *blkid = le32_to_cpu(*blk_slot);
362         *rel_inoblk = *rel_inoblk % reach;
363         ext2_put_metablock(inode->i_sb, blk_slot);      /* ref for the one looked in */
364 }
365
366 /* Finds the slot of the FS block corresponding to a specific block number of an
367  * inode.  It does this by walking the inode's tables.  The general idea is that
368  * if the ino_block num is above a threshold, we'll need to go into indirect
369  * tables (1x, 2x, or 3x (triply indirect) tables).  Block numbers start at 0.
370  *
371  * This returns a pointer within a metablock, which needs to be decref'd (and
372  * possibly dirtied) when you are done.  Note, it can return a pointer to
373  * something that is NOT in a metablock (e2ii->i_block[]), but put_metablock can
374  * handle it for now.
375  *
376  * Horrendously untested, btw. */
377 uint32_t *ext2_lookup_inotable_slot(struct inode *inode, uint32_t ino_block)
378 {
379         struct ext2_i_info *e2ii = (struct ext2_i_info*)inode->i_fs_info;
380
381         uint32_t blkid, *blk_slot;
382         /* The 'reach' is how many blocks a given table can 'address' */
383         int ptrs_per_blk = inode->i_sb->s_blocksize / sizeof(uint32_t);
384         int reach_1xblk = ptrs_per_blk;
385         int reach_2xblk = ptrs_per_blk * ptrs_per_blk;
386         /* thresholds are the first blocks that require a level of indirection */
387         int single_threshold = 12;
388         int double_threshold = single_threshold + reach_1xblk;
389         int triple_threshold = double_threshold + reach_2xblk;
390         /* this is the desired block num lookup within a level of indirection.  It
391          * will need to be offset based on what level of lookups we want (try it in
392          * your head with 12 first). */
393         uint32_t rel_inoblk;
394
395         if (ino_block >= triple_threshold) {
396                 /* ino_block requires a triply-indirect lookup */
397                 rel_inoblk = ino_block - triple_threshold;
398                 /* Make sure a 14 block (3x indirect) is there */
399                 ext2_fill_inotable_slot(inode, &e2ii->i_block[14]);
400                 blkid = e2ii->i_block[14];
401                 ext2_walk_inotable(inode, &blkid, &rel_inoblk, reach_2xblk);
402                 ext2_walk_inotable(inode, &blkid, &rel_inoblk, reach_1xblk);
403                 blk_slot = ext2_find_inotable_slot(inode, blkid, rel_inoblk, 1);
404         } else if (ino_block >= double_threshold) {
405                 /* ino_block requires a doubly-indirect lookup  */
406                 rel_inoblk = ino_block - double_threshold;
407                 ext2_fill_inotable_slot(inode, &e2ii->i_block[13]);
408                 blkid = e2ii->i_block[13];
409                 ext2_walk_inotable(inode, &blkid, &rel_inoblk, reach_1xblk);
410                 blk_slot = ext2_find_inotable_slot(inode, blkid, rel_inoblk, 1);
411         } else if (ino_block >= single_threshold) {
412                 /* ino_block requires a singly-indirect lookup */
413                 rel_inoblk = ino_block - single_threshold;
414                 ext2_fill_inotable_slot(inode, &e2ii->i_block[12]);
415                 blkid = e2ii->i_block[12];
416                 blk_slot = ext2_find_inotable_slot(inode, blkid, rel_inoblk, 1);
417         } else {
418                 /* Direct block, straight out of the inode */
419                 blk_slot = &e2ii->i_block[ino_block];
420         }
421         return blk_slot;
422 }
423
424 /* Determines the FS block id for a given inode block id.  Convenience wrapper
425  * that may go away soon. */
426 uint32_t ext2_find_inoblock(struct inode *inode, unsigned int ino_block)
427 {
428         uint32_t retval, *buf = ext2_lookup_inotable_slot(inode, ino_block);
429         retval = *buf;
430         ext2_put_metablock(inode->i_sb, buf);
431         return retval;
432 }
433
434 /* Returns an incref'd metadata block for the contents of the ino block.  Don't
435  * use this for regular files - use their inode's page cache instead (used for
436  * directories for now).  If there isn't a block allocated yet, it will provide
437  * a zeroed one. */
438 void *ext2_get_ino_metablock(struct inode *inode, unsigned long ino_block)
439 {
440         uint32_t blkid, *retval, *blk_slot;
441         blk_slot = ext2_lookup_inotable_slot(inode, ino_block);
442         blkid = le32_to_cpu(*blk_slot);
443         if (blkid) {
444                 ext2_put_metablock(inode->i_sb, blk_slot);
445                 return ext2_get_metablock(inode->i_sb, blkid);
446         }
447         /* If there isn't a block there, alloc and insert one.  This block will be
448          * the next big chunk of "file" data for this inode. */
449         blkid = ext2_alloc_block(inode, ext2_bgidx2block(inode->i_sb,
450                                                          ext2_inode2bg(inode),
451                                                          0));
452         *blk_slot = cpu_to_le32(blkid);
453         ext2_dirty_metablock(inode->i_sb, blk_slot);
454         ext2_put_metablock(inode->i_sb, blk_slot);
455         inode->i_blocks += inode->i_sb->s_blocksize >> 9;       /* inc by 1 FS block */
456         inode->i_size += inode->i_sb->s_blocksize;
457         retval = ext2_get_metablock(inode->i_sb, blkid);
458         memset(retval, 0, inode->i_sb->s_blocksize);            /* 0 the new block */
459         return retval;
460 }
461
462 /* This should help with degubbing.  In read_inode(), print out the i_block, and
463  * consider manually (via memory inspection) examining those blocks.  Odds are,
464  * the 2x and 3x walks are jacked up. */
465 void ext2_print_ino_blocks(struct inode *inode)
466 {
467         printk("Inode %p, Size: %d, 512B 'blocks': %d\n-------------\n", inode,
468                inode->i_size, inode->i_blocks);
469         for (int i = 0; i < inode->i_blocks * (inode->i_sb->s_blocksize / 512); i++)
470                 printk("# %03d, Block %03d\n", i, ext2_find_inoblock(inode, i));
471 }
472
473 /* Misc Functions */
474
475 /* This checks an ext2 disc SB for consistency, optionally printing out its
476  * stats.  It also will also read in a copy of the block group descriptor table
477  * from its first location (right after the primary SB copy) */
478 void ext2_check_sb(struct ext2_sb *e2sb, struct ext2_block_group *bg,
479                    bool print)
480 {
481         int retval;
482         unsigned int blksize, blks_per_group, num_blk_group, num_blks;
483         unsigned int inodes_per_grp, inode_size;
484         unsigned int sum_blks = 0, sum_inodes = 0;
485
486         assert(le16_to_cpu(e2sb->s_magic) == EXT2_SUPER_MAGIC);
487         num_blks = le32_to_cpu(e2sb->s_blocks_cnt);
488         blksize = 1024 << le32_to_cpu(e2sb->s_log_block_size);
489         blks_per_group = le32_to_cpu(e2sb->s_blocks_per_group);
490         num_blk_group = num_blks / blks_per_group + (num_blks % blks_per_group ? 1 : 0);
491
492         if (print) {
493                 printk("EXT2 info:\n-------------------------\n");
494                 printk("Total Inodes:     %8d\n", le32_to_cpu(e2sb->s_inodes_cnt));
495                 printk("Total Blocks:     %8d\n", le32_to_cpu(e2sb->s_blocks_cnt));
496                 printk("Num R-Blocks:     %8d\n", le32_to_cpu(e2sb->s_rblocks_cnt));
497                 printk("Num Free Blocks:  %8d\n", le32_to_cpu(e2sb->s_free_blocks_cnt));
498                 printk("Num Free Inodes:  %8d\n", le32_to_cpu(e2sb->s_free_inodes_cnt));
499                 printk("First Data Block: %8d\n",
500                        le32_to_cpu(e2sb->s_first_data_block));
501                 printk("Block Size:       %8d\n",
502                        1024 << le32_to_cpu(e2sb->s_log_block_size));
503                 printk("Fragment Size:    %8d\n",
504                        1024 << le32_to_cpu(e2sb->s_log_frag_size));
505                 printk("Blocks per group: %8d\n",
506                        le32_to_cpu(e2sb->s_blocks_per_group));
507                 printk("Inodes per group: %8d\n",
508                        le32_to_cpu(e2sb->s_inodes_per_group));
509                 printk("Block groups:     %8d\n", num_blk_group);
510                 printk("Mount state:      %8d\n", le16_to_cpu(e2sb->s_state));
511                 printk("Rev Level:        %8d\n", le32_to_cpu(e2sb->s_minor_rev_level));
512                 printk("Minor Rev Level:  %8d\n", le16_to_cpu(e2sb->s_minor_rev_level));
513                 printk("Creator OS:       %8d\n", le32_to_cpu(e2sb->s_creator_os));
514                 printk("First Inode:      %8d\n", le32_to_cpu(e2sb->s_first_ino));
515                 printk("Inode size:       %8d\n", le16_to_cpu(e2sb->s_inode_size));
516                 printk("This block group: %8d\n", le16_to_cpu(e2sb->s_block_group_nr));
517                 printk("BG ID of 1st meta:%8d\n", le16_to_cpu(e2sb->s_first_meta_bg));
518                 printk("Volume name:      %s\n", e2sb->s_volume_name);
519                 printk("\nBlock Group Info:\n----------------------\n");
520         }
521
522         for (int i = 0; i < num_blk_group; i++) {
523                 sum_blks += le16_to_cpu(bg[i].bg_free_blocks_cnt);
524                 sum_inodes += le16_to_cpu(bg[i].bg_free_inodes_cnt);
525                 if (print) {
526                         printk("*** BG %d at %p\n", i, &bg[i]);
527                         printk("Block bitmap:%8d\n", le32_to_cpu(bg[i].bg_block_bitmap));
528                         printk("Inode bitmap:%8d\n", le32_to_cpu(bg[i].bg_inode_bitmap));
529                         printk("Inode table: %8d\n", le32_to_cpu(bg[i].bg_inode_table));
530                         printk("Free blocks: %8d\n", le16_to_cpu(bg[i].bg_free_blocks_cnt));
531                         printk("Free inodes: %8d\n", le16_to_cpu(bg[i].bg_free_inodes_cnt));
532                         printk("Used Dirs:   %8d\n", le16_to_cpu(bg[i].bg_used_dirs_cnt));
533                 }
534         }
535
536         /* Sanity Assertions.  A good ext2 will always pass these. */
537         inodes_per_grp = le32_to_cpu(e2sb->s_inodes_per_group);
538         blks_per_group = le32_to_cpu(e2sb->s_blocks_per_group);
539         inode_size = le32_to_cpu(e2sb->s_inode_size);
540         assert(le32_to_cpu(e2sb->s_inodes_cnt) <= inodes_per_grp * num_blk_group);
541         assert(le32_to_cpu(e2sb->s_free_inodes_cnt) == sum_inodes);
542         assert(le32_to_cpu(e2sb->s_blocks_cnt) <= blks_per_group * num_blk_group);
543         assert(le32_to_cpu(e2sb->s_free_blocks_cnt) == sum_blks);
544         if (blksize == 1024)
545                 assert(le32_to_cpu(e2sb->s_first_data_block) == 1);
546         else
547                 assert(le32_to_cpu(e2sb->s_first_data_block) == 0);
548         assert(inode_size <= blksize);
549         assert(inode_size == 1 << LOG2_UP(inode_size));
550         assert(blksize * 8 >= inodes_per_grp);
551         assert(inodes_per_grp % (blksize / inode_size) == 0);
552         if (print)
553                 printk("Passed EXT2 Checks\n");
554 }
555
556 /* VFS required Misc Functions */
557
558 /* Creates the SB.  Like with Ext2's, we should consider pulling out the
559  * FS-independent stuff, if possible. */
560 struct super_block *ext2_get_sb(struct fs_type *fs, int flags,
561                                char *dev_name, struct vfsmount *vmnt)
562 {
563         struct block_device *bdev;
564         struct ext2_sb *e2sb;
565         struct ext2_block_group *e2bg;
566         unsigned int blks_per_group, num_blk_group, num_blks;
567
568         static bool ran_once = FALSE;
569         if (!ran_once) {
570                 ran_once = TRUE;
571                 ext2_init();
572         }
573         bdev = get_bdev(dev_name);
574         assert(bdev);
575         /* Read the SB.  It's always at byte 1024 and 1024 bytes long.  Note we do
576          * not put the metablock (we pin it off the sb later).  Same with e2bg. */
577         e2sb = (struct ext2_sb*)__ext2_get_metablock(bdev, 1, 1024);
578         if (!(le16_to_cpu(e2sb->s_magic) == EXT2_SUPER_MAGIC)) {
579                 warn("EXT2 Not detected when it was expected!");
580                 return 0;
581         }
582         /* Read in the block group descriptor table.  Which block the BG table is on
583          * depends on the blocksize */
584         unsigned int blksize = 1024 << le32_to_cpu(e2sb->s_log_block_size);
585         e2bg = __ext2_get_metablock(bdev, blksize == 1024 ? 2 : 1, blksize);
586         assert(e2bg);
587         ext2_check_sb(e2sb, e2bg, FALSE);
588
589         /* Now we build and init the VFS SB */
590         struct super_block *sb = get_sb();
591         sb->s_dev = 0;                  /* what do we really want here? */
592         sb->s_blocksize = blksize;
593         /* max file size for a 1024 blocksize FS.  good enough for now (TODO) */
594         sb->s_maxbytes = 17247252480;
595         sb->s_type = &ext2_fs_type;
596         sb->s_op = &ext2_s_op;
597         sb->s_flags = flags;    /* from the disc too?  which flags are these? */
598         sb->s_magic = EXT2_SUPER_MAGIC;
599         sb->s_mount = vmnt;     /* Kref?  also in KFS */
600         sb->s_syncing = FALSE;
601         kref_get(&bdev->b_kref, 1);
602         sb->s_bdev = bdev;
603         strlcpy(sb->s_name, "EXT2", 32);
604         sb->s_fs_info = kmalloc(sizeof(struct ext2_sb_info), 0);
605         assert(sb->s_fs_info);
606         /* store the in-memory copy of the disk SB and bg desc table */
607         ((struct ext2_sb_info*)sb->s_fs_info)->e2sb = e2sb;
608         ((struct ext2_sb_info*)sb->s_fs_info)->e2bg = e2bg;
609         /* Precompute the number of BGs */
610         num_blks = le32_to_cpu(e2sb->s_blocks_cnt);
611         blks_per_group = le32_to_cpu(e2sb->s_blocks_per_group);
612         ((struct ext2_sb_info*)sb->s_fs_info)->nr_bgs = num_blks / blks_per_group +
613                                                (num_blks % blks_per_group ? 1 : 0);
614
615         /* Final stages of initializing the sb, mostly FS-independent */
616         init_sb(sb, vmnt, &ext2_d_op, EXT2_ROOT_INO, 0);
617
618         printk("EXT2 superblock loaded\n");
619         kref_put(&bdev->b_kref);
620         return sb;
621 }
622
623 void ext2_kill_sb(struct super_block *sb)
624 {
625         /* don't forget to kfree the s_fs_info and its two members */
626         panic("Killing an EXT2 SB is not supported!");
627 }
628
629 /* Every FS must have a static FS Type, with which the VFS code can bootstrap */
630 struct fs_type ext2_fs_type = {"EXT2", 0, ext2_get_sb, ext2_kill_sb, {0, 0},
631                                TAILQ_HEAD_INITIALIZER(ext2_fs_type.fs_supers)};
632
633 /* Page Map Operations */
634
635 /* Sets up the bidirectional mapping between the page and its buffer heads.  As
636  * a future optimization, we could try and detect if all of the blocks are
637  * contiguous (either before or after making them) and compact them to one BH.
638  * Note there is an assumption that the file has at least one block in it. */
639 int ext2_mappage(struct page_map *pm, struct page *page)
640 {
641         struct buffer_head *bh;
642         struct inode *inode = (struct inode*)pm->pm_host;
643         assert(!page->pg_private);              /* double check that we aren't bh-mapped */
644         assert(inode->i_mapping == pm); /* double check we are the inode for pm */
645         struct block_device *bdev = inode->i_sb->s_bdev;
646         unsigned int blk_per_pg = PGSIZE / inode->i_sb->s_blocksize;
647         unsigned int sct_per_blk = inode->i_sb->s_blocksize / bdev->b_sector_sz;
648         uint32_t ino_blk_num, fs_blk_num = 0, *fs_blk_slot;
649
650         bh = kmem_cache_alloc(bh_kcache, 0);
651         page->pg_private = bh;
652         for (int i = 0; i < blk_per_pg; i++) {
653                 /* free_bh() can handle having a halfway aborted mappage() */
654                 if (!bh)
655                         return -ENOMEM;
656                 bh->bh_page = page;                                                     /* weak ref */
657                 bh->bh_buffer = page2kva(page) + i * inode->i_sb->s_blocksize;
658                 bh->bh_flags = 0;                                                       /* whatever... */
659                 bh->bh_bdev = bdev;                                                     /* uncounted ref */
660                 /* compute the first sector of the FS block for the ith buf in the pg */
661                 ino_blk_num = page->pg_index * blk_per_pg + i;
662                 fs_blk_slot = ext2_lookup_inotable_slot(inode, ino_blk_num);
663                 /* If there isn't a block there, lets get one.  The previous fs_blk_num
664                  * is our hint (or we have to compute one). */
665                 if (!*fs_blk_slot) {
666                         if (!fs_blk_num) {
667                                 fs_blk_num = ext2_bgidx2block(inode->i_sb,
668                                                               ext2_inode2bg(inode), 0);
669                         }
670                         fs_blk_num = ext2_alloc_block(inode, fs_blk_num + 1);
671                         /* Link it, and dirty the inode indirect block */
672                         *fs_blk_slot = cpu_to_le32(fs_blk_num);
673                         ext2_dirty_metablock(inode->i_sb, fs_blk_slot);
674                         /* the block is still on disk, and we don't want its contents */
675                         bh->bh_flags = BH_NEEDS_ZEROED;                 /* talking to readpage */
676                         /* update our num blocks, with 512B each "block" (ext2-style) */
677                         inode->i_blocks += inode->i_sb->s_blocksize >> 9;
678                 } else {        /* there is a block there already */
679                         fs_blk_num = *fs_blk_slot;
680                 }
681                 ext2_put_metablock(inode->i_sb, fs_blk_slot);
682                 bh->bh_sector = fs_blk_num * sct_per_blk;
683                 bh->bh_nr_sector = sct_per_blk;
684                 /* Stop if we're the last block in the page.  We could be going beyond
685                  * the end of the file, in which case the next BHs will be zeroed. */
686                 if (i == blk_per_pg - 1) {
687                         bh->bh_next = 0;
688                         break;
689                 } else {
690                         /* get and link to the next BH. */
691                         bh->bh_next = kmem_cache_alloc(bh_kcache, 0);
692                         bh = bh->bh_next;
693                 }
694         }
695         return 0;
696 }
697
698 /* Fills page with its contents from its backing store file.  Note that we do
699  * the zero padding here, instead of higher in the VFS.  Might change in the
700  * future.  TODO: make this a block FS generic call. */
701 int ext2_readpage(struct page_map *pm, struct page *page)
702 {
703         int retval;
704         struct block_device *bdev = pm->pm_host->i_sb->s_bdev;
705         struct buffer_head *bh;
706         struct block_request *breq;
707         void *eobh;
708
709         atomic_or(&page->pg_flags, PG_BUFFER);
710         retval = ext2_mappage(pm, page);
711         if (retval)
712                 return retval;
713         /* Build and submit the request */
714         breq = kmem_cache_alloc(breq_kcache, 0);
715         if (!breq)
716                 return -ENOMEM;
717         breq->flags = BREQ_READ;
718         breq->callback = generic_breq_done;
719         breq->data = 0;
720         sem_init_irqsave(&breq->sem, 0);
721         breq->bhs = breq->local_bhs;
722         breq->nr_bhs = 0;
723         /* Pack the BH pointers in the block request */
724         bh = (struct buffer_head*)page->pg_private;
725         assert(bh);
726         /* Either read the block in, or zero the buffer.  If we wanted to ensure no
727          * data is leaked after a crash, we'd write a 0 block too. */
728         for (int i = 0; bh; bh = bh->bh_next) {
729                 if (!(bh->bh_flags & BH_NEEDS_ZEROED)) {
730                         breq->bhs[i] = bh;
731                         breq->nr_bhs++;
732                         i++;
733                 } else {
734                         memset(bh->bh_buffer, 0, pm->pm_host->i_sb->s_blocksize);
735                         bh->bh_flags |= BH_DIRTY;
736                         atomic_or(&bh->bh_page->pg_flags, PG_DIRTY);
737                 }
738         }
739         retval = bdev_submit_request(bdev, breq);
740         assert(!retval);
741         sleep_on_breq(breq);
742         kmem_cache_free(breq_kcache, breq);
743         /* zero out whatever is beyond the EOF.  we could do this by figuring out
744          * where the BHs end and zeroing from there, but I'd rather zero from where
745          * the file ends (which could be in the middle of an FS block */
746         uintptr_t eof_off;
747         eof_off = (pm->pm_host->i_size - page->pg_index * PGSIZE);
748         eof_off = MIN(eof_off, PGSIZE) % PGSIZE;
749         /* at this point, eof_off is the offset into the page of the EOF, or 0 */
750         if (eof_off)
751                 memset(eof_off + page2kva(page), 0, PGSIZE - eof_off);
752         /* Now the page is up to date */
753         atomic_or(&page->pg_flags, PG_UPTODATE);
754         /* Useful debugging.  Put one higher up if the page is not getting mapped */
755         //print_pageinfo(page);
756         return 0;
757 }
758
759 int ext2_writepage(struct page_map *pm, struct page *page)
760 {
761         return -1;
762 }
763
764 /* Super Operations */
765
766 /* Creates and initializes a new inode.  FS specific, yet inode-generic fields
767  * are filled in.  inode-specific fields are filled in in read_inode() based on
768  * what's on the disk for a given i_no.  i_no and i_fop are set by the caller.
769  *
770  * Note that this means this inode can be for an inode that is already on disk,
771  * or it can be used when creating.  The i_fop depends on the type of file
772  * (file, directory, symlink, etc). */
773 struct inode *ext2_alloc_inode(struct super_block *sb)
774 {
775         struct inode *inode = kmem_cache_alloc(inode_kcache, 0);
776         memset(inode, 0, sizeof(struct inode));
777         inode->i_op = &ext2_i_op;
778         inode->i_pm.pm_op = &ext2_pm_op;
779         return inode;
780 }
781
782 /* FS-specific clean up when an inode is dealloced.  this is just cleaning up
783  * the in-memory version, and only the FS-specific parts.  whether or not the
784  * inode is still on disc is irrelevant. */
785 void ext2_dealloc_inode(struct inode *inode)
786 {
787         kmem_cache_free(ext2_i_kcache, inode->i_fs_info);
788 }
789
790 /* Returns a pointer within a metablock for the disk inode specified by inode.
791  * Be sure to 'put' your reference (and/or dirty it). */
792 struct ext2_inode *ext2_get_diskinode(struct inode *inode)
793 {
794         uint32_t my_bg_idx, ino_per_blk, my_ino_blk;
795         struct ext2_sb_info *e2sbi = (struct ext2_sb_info*)inode->i_sb->s_fs_info;
796         struct ext2_block_group *my_bg;
797         struct ext2_inode *ino_tbl_chunk;
798
799         assert(inode->i_ino);                                   /* ino == 0 is a bug */
800         /* Need to compute the blockgroup and index of the requested inode */
801         ino_per_blk = inode->i_sb->s_blocksize /
802                       le16_to_cpu(e2sbi->e2sb->s_inode_size);
803         my_bg_idx = ext2_inode2bgidx(inode);
804         my_bg = ext2_inode2bg(inode);
805         /* Figure out which FS block of the inode table we want and read in that
806          * chunk */
807         my_ino_blk = le32_to_cpu(my_bg->bg_inode_table) + my_bg_idx / ino_per_blk;
808         ino_tbl_chunk = ext2_get_metablock(inode->i_sb, my_ino_blk);
809         return &ino_tbl_chunk[my_bg_idx % ino_per_blk];
810 }
811
812 /* reads the inode data on disk specified by inode->i_ino into the inode.
813  * basically, it's a "make this inode the one for i_ino (i number)" */
814 void ext2_read_inode(struct inode *inode)
815 {
816         struct ext2_inode *my_ino;
817         my_ino = ext2_get_diskinode(inode);
818
819         /* Have the disk inode now, let's put its info into the VFS inode: */
820         inode->i_mode = le16_to_cpu(my_ino->i_mode);
821         switch (inode->i_mode & __S_IFMT) {
822                 case (__S_IFDIR):
823                         inode->i_fop = &ext2_f_op_dir;
824                         break;
825                 case (__S_IFREG):
826                         inode->i_fop = &ext2_f_op_file;
827                         break;
828                 case (__S_IFLNK):
829                         inode->i_fop = &ext2_f_op_sym;
830                         break;
831                 case (__S_IFCHR):
832                 case (__S_IFBLK):
833                 default:
834                         inode->i_fop = &ext2_f_op_file;
835                         warn("[Calm British Accent] Look around you.  Unhandled filetype.");
836         }
837         inode->i_nlink = le16_to_cpu(my_ino->i_links_cnt);
838         inode->i_uid = le16_to_cpu(my_ino->i_uid);
839         inode->i_gid = le16_to_cpu(my_ino->i_gid);
840         /* technically, for large F_REG, we should | with i_dir_acl */
841         inode->i_size = le32_to_cpu(my_ino->i_size);
842         inode->i_atime.tv_sec = le32_to_cpu(my_ino->i_atime);
843         inode->i_atime.tv_nsec = 0;
844         inode->i_mtime.tv_sec = le32_to_cpu(my_ino->i_mtime);
845         inode->i_mtime.tv_nsec = 0;
846         inode->i_ctime.tv_sec = le32_to_cpu(my_ino->i_ctime);
847         inode->i_ctime.tv_nsec = 0;
848         inode->i_blocks = le32_to_cpu(my_ino->i_blocks);
849         inode->i_flags = le32_to_cpu(my_ino->i_flags);
850         inode->i_socket = FALSE;                /* for now */
851         /* Copy over the other inode stuff that isn't in the VFS inode.  For now,
852          * it's just the block pointers */
853         inode->i_fs_info = kmem_cache_alloc(ext2_i_kcache, 0);
854         struct ext2_i_info *e2ii = (struct ext2_i_info*)inode->i_fs_info;
855         for (int i = 0; i < 15; i++)
856                 e2ii->i_block[i] = le32_to_cpu(my_ino->i_block[i]);
857         /* TODO: (HASH) unused: inode->i_hash add to hash (saves on disc reading) */
858         /* TODO: we could consider saving a pointer to the disk inode and pinning
859          * its buffer in memory, but for now we'll just free it. */
860         ext2_put_metablock(inode->i_sb, my_ino);
861 }
862
863 /* called when an inode in memory is modified (journalling FS's care) */
864 void ext2_dirty_inode(struct inode *inode)
865 {
866         // presumably we'll ext2_dirty_metablock(void *buffer) here
867 }
868
869 /* write the inode to disk (specifically, to inode inode->i_ino), synchronously
870  * if we're asked to wait */
871 void ext2_write_inode(struct inode *inode, bool wait)
872 {
873 I_AM_HERE;
874 }
875
876 /* called when an inode is decref'd, to do any FS specific work */
877 void ext2_put_inode(struct inode *inode)
878 {
879 I_AM_HERE;
880 }
881
882 /* Unused for now, will get rid of this if inode_release is sufficient */
883 void ext2_drop_inode(struct inode *inode)
884 {
885 I_AM_HERE;
886 }
887
888 /* delete the inode from disk (all data) */
889 void ext2_delete_inode(struct inode *inode)
890 {
891 I_AM_HERE;
892         // would remove from "disk" here
893         /* TODO: give up our i_ino */
894 }
895
896 /* unmount and release the super block */
897 void ext2_put_super(struct super_block *sb)
898 {
899         panic("Shazbot! Ext2 can't be unmounted yet!");
900 }
901
902 /* updates the on-disk SB with the in-memory SB */
903 void ext2_write_super(struct super_block *sb)
904 {
905 I_AM_HERE;
906 }
907
908 /* syncs FS metadata with the disc, synchronously if we're waiting.  this info
909  * also includes anything pointed to by s_fs_info. */
910 int ext2_sync_fs(struct super_block *sb, bool wait)
911 {
912 I_AM_HERE;
913         return 0;
914 }
915
916 /* remount the FS with the new flags */
917 int ext2_remount_fs(struct super_block *sb, int flags, char *data)
918 {
919         warn("Ext2 will not remount.");
920         return -1; // can't remount
921 }
922
923 /* interrupts a mount operation - used by NFS and friends */
924 void ext2_umount_begin(struct super_block *sb)
925 {
926         panic("Cannot abort a Ext2 mount, and why would you?");
927 }
928
929 /* inode_operations */
930
931 /* Little helper, used for initializing new inodes for file-like objects (files,
932  * symlinks, etc).  We pass the dentry, since we need to up it. */
933 static void ext2_init_inode(struct inode *dir, struct dentry *dentry)
934 {
935 #if 0
936         struct inode *inode = dentry->d_inode;
937         inode->i_ino = ext2_get_free_ino();
938 #endif
939 }
940
941 /* Initializes a new/empty disk inode, according to inode.  If you end up not
942  * zeroing this stuff, be careful of endianness. */
943 static void ext2_init_diskinode(struct ext2_inode *e2i, struct inode *inode)
944 {
945         assert(inode->i_size == 0);
946         e2i->i_mode = cpu_to_le16(inode->i_mode);
947         e2i->i_uid = cpu_to_le16(inode->i_uid);
948         e2i->i_size = 0;
949         e2i->i_atime = cpu_to_le32(inode->i_atime.tv_sec);
950         e2i->i_ctime = cpu_to_le32(inode->i_ctime.tv_sec);
951         e2i->i_mtime = cpu_to_le32(inode->i_mtime.tv_sec);
952         e2i->i_dtime = 0;
953         e2i->i_gid = cpu_to_le16(inode->i_gid);
954         e2i->i_links_cnt = cpu_to_le16(inode->i_nlink);
955         e2i->i_blocks = 0;
956         e2i->i_flags = cpu_to_le32(inode->i_flags);
957         e2i->i_osd1 = 0;
958         e2i->i_generation = 0;
959         e2i->i_file_acl = 0;
960         e2i->i_dir_acl = 0;
961         e2i->i_faddr = 0;
962         for (int i = 0; i < 15; i++)
963                 e2i->i_block[i] = 0;
964         for (int i = 0; i < 12; i++)
965                 e2i->i_osd2[i] = 0;
966 }
967
968 /* These should return true if foreach_dirent should stop working on the
969  * dirents. */
970 typedef bool (*each_func_t) (struct ext2_dirent *dir_i, long a1, long a2,
971                              long a3);
972
973 /* Loads the buffer and performs my_work on each dirent, stopping and returning
974  * 0 if one of the calls succeeded, or returning the dir block num of what would
975  * be the next dir block otherwise (aka, how many blocks we went through). */
976 static uint32_t ext2_foreach_dirent(struct inode *dir, each_func_t my_work,
977                                     long a1, long a2, long a3)
978 {
979         struct ext2_dirent *dir_buf, *dir_i;
980         uint32_t dir_block = 0;
981         dir_buf = ext2_get_ino_metablock(dir, dir_block++);
982         dir_i = dir_buf;
983         /* now we have the first block worth of dirents.  We'll get another block if
984          * dir_i hits a block boundary */
985         for (unsigned int bytes = 0; bytes < dir->i_size; ) {
986                 /* On subsequent loops, we might need to advance to the next block.
987                  * This is where a file abstraction for a dir might be easier. */
988                 if ((void*)dir_i >= (void*)dir_buf + dir->i_sb->s_blocksize) {
989                         ext2_put_metablock(dir->i_sb, dir_buf);
990                         dir_buf = ext2_get_ino_metablock(dir, dir_block++);
991                         dir_i = dir_buf;
992                         assert(dir_buf);
993                 }
994                 if (my_work(dir_i, a1, a2, a3)) {
995                         ext2_put_metablock(dir->i_sb, dir_buf);
996                         return 0;
997                 }
998                 /* Get ready for the next loop */
999                 bytes += dir_i->dir_reclen;
1000                 dir_i = (void*)dir_i + dir_i->dir_reclen;
1001         }
1002         ext2_put_metablock(dir->i_sb, dir_buf);
1003         return dir_block;
1004 }
1005
1006 /* Returns the actual length of a dirent, not just how far to the next entry.
1007  * If there is no inode, the entry is unused, and it has no length (as far as
1008  * users of this should care). */
1009 static unsigned int ext2_dirent_len(struct ext2_dirent *e2dir)
1010 {
1011         /* arguably, we don't need the le32_to_cpu */
1012         if (le32_to_cpu(e2dir->dir_inode))
1013                 return ROUNDUP(e2dir->dir_namelen + 8, 4);              /* no such le8_to_cpu */
1014         else
1015                 return 0;
1016 }
1017
1018 /* Helper for writing the contents of a dentry to a disk dirent. Zeroes the
1019  * contents of the dirent so that we don't write random data to disk. */
1020 static void ext2_write_dirent(struct ext2_dirent *e2dir, struct dentry *dentry,
1021                               unsigned int rec_len)
1022 {
1023         memset(e2dir, 0, sizeof(*e2dir));
1024         e2dir->dir_inode = cpu_to_le32(dentry->d_inode->i_ino);
1025         e2dir->dir_reclen = cpu_to_le16(rec_len);
1026         e2dir->dir_namelen = dentry->d_name.len;
1027         switch (dentry->d_inode->i_mode & __S_IFMT) {
1028                 case (__S_IFDIR):
1029                         e2dir->dir_filetype = EXT2_FT_DIR;
1030                         break;
1031                 case (__S_IFREG):
1032                         e2dir->dir_filetype = EXT2_FT_REG_FILE;
1033                         break;
1034                 case (__S_IFLNK):
1035                         e2dir->dir_filetype = EXT2_FT_SYMLINK;
1036                         break;
1037                 case (__S_IFCHR):
1038                         e2dir->dir_filetype = EXT2_FT_CHRDEV;
1039                         break;
1040                 case (__S_IFBLK):
1041                         e2dir->dir_filetype = EXT2_FT_BLKDEV;
1042                         break;
1043                 case (__S_IFSOCK):
1044                         e2dir->dir_filetype = EXT2_FT_SOCK;
1045                         break;
1046                 default:
1047                         warn("[Calm British Accent] Look around you: Unknown filetype.");
1048                         e2dir->dir_filetype = EXT2_FT_UNKNOWN;
1049         }
1050         assert(dentry->d_name.len <= 255);
1051         strlcpy((char*)e2dir->dir_name, dentry->d_name.name,
1052                 sizeof(e2dir->dir_name));
1053 }
1054
1055 /* Helper for ext2_create().  This tries to squeeze a dirent in the slack space
1056  * after an existing dirent, returning TRUE if it succeeded (to break out). */
1057 static bool create_each_func(struct ext2_dirent *dir_i, long a1, long a2,
1058                              long a3)
1059 {
1060         struct dentry *dentry = (struct dentry*)a1;
1061         unsigned int our_rec_len = (unsigned int)a2;
1062         unsigned int mode = (unsigned int)a3;
1063         struct ext2_dirent *dir_new;
1064         unsigned int real_len = ext2_dirent_len(dir_i);
1065         /* How much room is available after this dir_i before the next one */
1066         unsigned int record_slack = le16_to_cpu(dir_i->dir_reclen) - real_len;
1067         /* TODO: Note that this technique will clobber any directory indexing.  They
1068          * exist after the .. entry with an inode of 0.  Check the docs for
1069          * specifics and think up a nice way to tell the diff between a reserved
1070          * entry and an unused one, when inode == 0. */
1071         if (record_slack < our_rec_len)
1072                 return FALSE;
1073         /* At this point, there is enough room for us.  Stick our new one in right
1074          * after the real len, making sure our reclen goes to the old end.  Note
1075          * that it is possible to have a real_len of 0 (an unused entry).  In this
1076          * case, we just end up taking over the spot in the dir_blk.  Be sure to set
1077          * dir_i's reclen before dir_new's (in case they are the same). */
1078         dir_new = ((void*)dir_i + real_len);
1079         dir_i->dir_reclen = cpu_to_le16(real_len);
1080         ext2_write_dirent(dir_new, dentry, record_slack);
1081         ext2_dirty_metablock(dentry->d_sb, dir_new);
1082         return TRUE;
1083 }
1084
1085 /* Called when creating a new disk inode in dir associated with dentry.  We need
1086  * to fill out the i_ino, set the type, and do whatever else we need */
1087 int ext2_create(struct inode *dir, struct dentry *dentry, int mode,
1088                struct nameidata *nd)
1089 {
1090         struct inode *inode = dentry->d_inode;
1091         struct ext2_block_group *dir_bg = ext2_inode2bg(dir);
1092         struct ext2_inode *disk_inode;
1093         struct ext2_i_info *e2ii;
1094         uint32_t dir_block;
1095         unsigned int our_rec_len;
1096         struct ext2_dirent *new_dirent;
1097         /* Set basic inode stuff for files, get a disk inode, etc */
1098         SET_FTYPE(inode->i_mode, __S_IFREG);
1099         inode->i_fop = &ext2_f_op_file;
1100         inode->i_ino = ext2_alloc_diskinode(inode, dir_bg);
1101         /* Initialize disk inode (this will be different for short symlinks) */
1102         disk_inode = ext2_get_diskinode(inode);
1103         ext2_init_diskinode(disk_inode, inode);
1104         /* Initialize the e2ii (might get rid of this cache of block info) */
1105         inode->i_fs_info = kmem_cache_alloc(ext2_i_kcache, 0);
1106         e2ii = (struct ext2_i_info*)inode->i_fs_info;
1107         for (int i = 0; i < 15; i++)
1108                 e2ii->i_block[i] = le32_to_cpu(disk_inode->i_block[i]);
1109         /* Dirty and put the disk inode */
1110         ext2_dirty_metablock(dentry->d_sb, disk_inode);
1111         ext2_put_metablock(dentry->d_sb, disk_inode);
1112         /* Insert it in the directory (make a dirent, might expand the dir too) */
1113         /* Note the disk dir_name is not null terminated */
1114         our_rec_len = ROUNDUP(8 + dentry->d_name.len, 4);
1115         assert(our_rec_len <= 8 + 256);
1116         /* Consider caching the start point for future dirent ops.  Or even using
1117          * the indexed directory.... */
1118         dir_block = ext2_foreach_dirent(dir, create_each_func, (long)dentry,
1119                                         (long)our_rec_len, (long)mode);
1120         /* If this returned a block number, we didn't find room in any of the
1121          * existing directory blocks, so we need to make a new one, stick it in the
1122          * dir inode, and stick our dirent at the beginning.  The reclen is the
1123          * whole blocksize (since it's the last entry in this block) */
1124         if (dir_block) {
1125                 new_dirent = ext2_get_ino_metablock(dir, dir_block);
1126                 ext2_write_dirent(new_dirent, dentry, dentry->d_sb->s_blocksize);
1127                 ext2_dirty_metablock(dentry->d_sb, new_dirent);
1128                 ext2_put_metablock(dentry->d_sb, new_dirent);
1129         }
1130         return 0;
1131 }
1132
1133 /* If we match, this loads the inode for the dentry and returns true (so we
1134  * break out) */
1135 static bool lookup_each_func(struct ext2_dirent *dir_i, long a1, long a2,
1136                              long a3)
1137 {
1138         struct dentry *dentry = (struct dentry*)a1;
1139         /* Test if we're the one (TODO: use d_compare).  Note, dir_name is not
1140          * null terminated, hence the && test. */
1141         if (!strncmp((char*)dir_i->dir_name, dentry->d_name.name,
1142                      dir_i->dir_namelen) &&
1143                     (dentry->d_name.name[dir_i->dir_namelen] == '\0')) {
1144                 load_inode(dentry, (long)le32_to_cpu(dir_i->dir_inode));
1145                 /* TODO: (HASH) add dentry to dcache (maybe the caller should) */
1146                 return TRUE;
1147         }
1148         return FALSE;
1149 }
1150
1151 /* Searches the directory for the filename in the dentry, filling in the dentry
1152  * with the FS specific info of this file.  If it succeeds, it will pass back
1153  * the *dentry you should use (which might be the same as the one you passed in).
1154  * If this fails, it will return 0, but not free the memory of "dentry."
1155  *
1156  * Callers, make sure you alloc and fill out the name parts of the dentry.  We
1157  * don't currently use the ND.  Might remove it in the future.  */
1158 struct dentry *ext2_lookup(struct inode *dir, struct dentry *dentry,
1159                            struct nameidata *nd)
1160 {
1161         assert(S_ISDIR(dir->i_mode));
1162         struct ext2_dirent *dir_buf, *dir_i;
1163         if (!ext2_foreach_dirent(dir, lookup_each_func, (long)dentry, 0, 0))
1164                 return dentry;
1165         printd("EXT2: Not Found, %s\n", dentry->d_name.name);
1166         return 0;
1167 }
1168
1169 /* Hard link to old_dentry in directory dir with a name specified by new_dentry.
1170  * At the very least, set the new_dentry's FS-specific fields. */
1171 int ext2_link(struct dentry *old_dentry, struct inode *dir,
1172              struct dentry *new_dentry)
1173 {
1174 I_AM_HERE;
1175         assert(new_dentry->d_op = &ext2_d_op);
1176         return 0;
1177 }
1178
1179 /* Removes the link from the dentry in the directory */
1180 int ext2_unlink(struct inode *dir, struct dentry *dentry)
1181 {
1182 I_AM_HERE;
1183         return 0;
1184 }
1185
1186 /* Creates a new inode for a symlink dir, linking to / containing the name
1187  * symname.  dentry is the controlling dentry of the inode. */
1188 int ext2_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
1189 {
1190 I_AM_HERE;
1191         #if 0
1192         struct inode *inode = dentry->d_inode;
1193         SET_FTYPE(inode->i_mode, __S_IFLNK);
1194         inode->i_fop = &ext2_f_op_sym;
1195         strlcpy(string, symname, len + 1);
1196         #endif
1197         return 0;
1198 }
1199
1200 /* Called when creating a new inode for a directory associated with dentry in
1201  * dir with the given mode.  Note, we might (later) need to track subdirs within
1202  * the parent inode, like we do with regular files.  I'd rather not, so we'll
1203  * see if we need it. */
1204 int ext2_mkdir(struct inode *dir, struct dentry *dentry, int mode)
1205 {
1206 I_AM_HERE;
1207         #if 0
1208         struct inode *inode = dentry->d_inode;
1209         inode->i_ino = ext2_get_free_ino();
1210         SET_FTYPE(inode->i_mode, __S_IFDIR);
1211         inode->i_fop = &ext2_f_op_dir;
1212         #endif
1213         return 0;
1214 }
1215
1216 /* Removes from dir the directory 'dentry.'  Ext2 doesn't store anything in the
1217  * inode for which children it has.  It probably should, but since everything is
1218  * pinned, it just relies on the dentry connections. */
1219 int ext2_rmdir(struct inode *dir, struct dentry *dentry)
1220 {
1221 I_AM_HERE;
1222         return 0;
1223 }
1224
1225 /* Used to make a generic file, based on the type and the major/minor numbers
1226  * (in rdev), with the given mode.  As with others, this creates a new disk
1227  * inode for the file */
1228 int ext2_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
1229 {
1230 I_AM_HERE;
1231         return -1;
1232 }
1233
1234 /* Moves old_dentry from old_dir to new_dentry in new_dir */
1235 int ext2_rename(struct inode *old_dir, struct dentry *old_dentry,
1236                struct inode *new_dir, struct dentry *new_dentry)
1237 {
1238 I_AM_HERE;
1239         return -1;
1240 }
1241
1242 /* Returns the char* for the symname for the given dentry.  The VFS code that
1243  * calls this for real FS's might assume it's already read in, so if the char *
1244  * isn't already in memory, we'd need to read it in here.  Regarding the char*
1245  * storage, the char* only will last as long as the dentry and inode are in
1246  * memory. */
1247 char *ext2_readlink(struct dentry *dentry)
1248 {
1249 I_AM_HERE;
1250         struct inode *inode = dentry->d_inode;
1251         if (!S_ISLNK(inode->i_mode))
1252                 return 0;
1253         return 0;
1254 }
1255
1256 /* Modifies the size of the file of inode to whatever its i_size is set to */
1257 void ext2_truncate(struct inode *inode)
1258 {
1259 }
1260
1261 /* Checks whether the the access mode is allowed for the file belonging to the
1262  * inode.  Implies that the permissions are on the file, and not the hardlink */
1263 int ext2_permission(struct inode *inode, int mode, struct nameidata *nd)
1264 {
1265         return -1;
1266 }
1267
1268
1269 /* dentry_operations */
1270 /* Determines if the dentry is still valid before using it to translate a path.
1271  * Network FS's need to deal with this. */
1272 int ext2_d_revalidate(struct dentry *dir, struct nameidata *nd)
1273 { // default, nothing
1274         return -1;
1275 }
1276
1277 /* Compares name1 and name2.  name1 should be a member of dir. */
1278 int ext2_d_compare(struct dentry *dir, struct qstr *name1, struct qstr *name2)
1279 { // default, string comp (case sensitive)
1280         return -1;
1281 }
1282
1283 /* Called when the last ref is deleted (refcnt == 0) */
1284 int ext2_d_delete(struct dentry *dentry)
1285 { // default, nothin
1286         return -1;
1287 }
1288
1289 /* Called when it's about to be slab-freed */
1290 int ext2_d_release(struct dentry *dentry)
1291 {
1292         return -1;
1293 }
1294
1295 /* Called when the dentry loses it's inode (becomes "negative") */
1296 void ext2_d_iput(struct dentry *dentry, struct inode *inode)
1297 { // default, call i_put to release the inode object
1298 }
1299
1300
1301 /* file_operations */
1302
1303 /* Updates the file pointer.  TODO: think about locking, and putting this in the
1304  * VFS. */
1305 #include <syscall.h>    /* just for set_errno, may go away later */
1306 int ext2_llseek(struct file *file, off64_t offset, off64_t *ret, int whence)
1307 {
1308         off64_t temp_off = 0;
1309         switch (whence) {
1310                 case SEEK_SET:
1311                         temp_off = offset;
1312                         break;
1313                 case SEEK_CUR:
1314                         temp_off = file->f_pos + offset;
1315                         break;
1316                 case SEEK_END:
1317                         temp_off = file->f_dentry->d_inode->i_size + offset;
1318                         break;
1319                 default:
1320                         set_errno(EINVAL);
1321                         warn("Unknown 'whence' in llseek()!\n");
1322                         return -1;
1323         }
1324         file->f_pos = temp_off;
1325         *ret = temp_off;
1326         return 0;
1327 }
1328
1329 /* Fills in the next directory entry (dirent), starting with d_off.  Like with
1330  * read and write, there will be issues with userspace and the *dirent buf.
1331  * TODO: (UMEM) */
1332 int ext2_readdir(struct file *dir, struct dirent *dirent)
1333 {
1334         void *blk_buf;
1335         /* Not enough data at the end of the directory */
1336         if (dir->f_dentry->d_inode->i_size < dirent->d_off + 8)
1337                 return -ENOENT;
1338         /* Figure out which block we need to read in for dirent->d_off */
1339         int block = dirent->d_off / dir->f_dentry->d_sb->s_blocksize;
1340         blk_buf = ext2_get_ino_metablock(dir->f_dentry->d_inode, block);
1341         assert(blk_buf);
1342         off64_t f_off = dirent->d_off % dir->f_dentry->d_sb->s_blocksize;
1343         /* Copy out the dirent info */
1344         struct ext2_dirent *e2dir = (struct ext2_dirent*)(blk_buf + f_off);
1345         dirent->d_ino = le32_to_cpu(e2dir->dir_inode);
1346         dirent->d_off += le16_to_cpu(e2dir->dir_reclen);
1347         if (dir->f_dentry->d_inode->i_size < dirent->d_off)
1348                 panic("Something is jacked with the dirent going beyond the dir/file");
1349         /* note, dir_namelen doesn't include the \0 */
1350         dirent->d_reclen = e2dir->dir_namelen;
1351         assert(e2dir->dir_namelen <= MAX_FILENAME_SZ);
1352         strlcpy(dirent->d_name, (char*)e2dir->dir_name, e2dir->dir_namelen + 1);
1353         ext2_put_metablock(dir->f_dentry->d_sb, blk_buf);
1354
1355         /* At the end of the directory, sort of.  ext2 often preallocates blocks, so
1356          * this will cause us to walk along til the end, which isn't quite right. */
1357         if (dir->f_dentry->d_inode->i_size == dirent->d_off)
1358                 return 0;
1359         if (dir->f_dentry->d_inode->i_size < dirent->d_off) {
1360                 warn("Issues reaching the end of an ext2 directory!");
1361                 return 0;
1362         }
1363         return 1;                                                       /* normal success for readdir */
1364 }
1365
1366 /* This is called when a VMR is mapping a particular file.  The FS needs to do
1367  * whatever it needs so that faults can be handled by read_page(), and handle all
1368  * of the cases of MAP_SHARED, MAP_PRIVATE, whatever.  It also needs to ensure
1369  * the file is not being mmaped in a way that conflicts with the manner in which
1370  * the file was opened or the file type. */
1371 int ext2_mmap(struct file *file, struct vm_region *vmr)
1372 {
1373         if (S_ISREG(file->f_dentry->d_inode->i_mode))
1374                 return 0;
1375         return -1;
1376 }
1377
1378 /* Called by the VFS while opening the file, which corresponds to inode,  for
1379  * the FS to do whatever it needs. */
1380 int ext2_open(struct inode *inode, struct file *file)
1381 {
1382         /* TODO: check to make sure the file is openable, and maybe do some checks
1383          * for the open mode (like did we want to truncate, append, etc) */
1384         return 0;
1385 }
1386
1387 /* Called when a file descriptor is closed. */
1388 int ext2_flush(struct file *file)
1389 {
1390 I_AM_HERE;
1391         return -1;
1392 }
1393
1394 /* Called when the file is about to be closed (file obj freed) */
1395 int ext2_release(struct inode *inode, struct file *file)
1396 {
1397         return 0;
1398 }
1399
1400 /* Flushes the file's dirty contents to disc */
1401 int ext2_fsync(struct file *file, struct dentry *dentry, int datasync)
1402 {
1403         return -1;
1404 }
1405
1406 /* Traditionally, sleeps until there is file activity.  We probably won't
1407  * support this, or we'll handle it differently. */
1408 unsigned int ext2_poll(struct file *file, struct poll_table_struct *poll_table)
1409 {
1410         return -1;
1411 }
1412
1413 /* Reads count bytes from a file, starting from (and modifiying) offset, and
1414  * putting the bytes into buffers described by vector */
1415 ssize_t ext2_readv(struct file *file, const struct iovec *vector,
1416                   unsigned long count, off64_t *offset)
1417 {
1418         return -1;
1419 }
1420
1421 /* Writes count bytes to a file, starting from (and modifiying) offset, and
1422  * taking the bytes from buffers described by vector */
1423 ssize_t ext2_writev(struct file *file, const struct iovec *vector,
1424                   unsigned long count, off64_t *offset)
1425 {
1426         return -1;
1427 }
1428
1429 /* Write the contents of file to the page.  Will sort the params later */
1430 ssize_t ext2_sendpage(struct file *file, struct page *page, int offset,
1431                      size_t size, off64_t pos, int more)
1432 {
1433         return -1;
1434 }
1435
1436 /* Checks random FS flags.  Used by NFS. */
1437 int ext2_check_flags(int flags)
1438 { // default, nothing
1439         return -1;
1440 }
1441
1442 /* Redeclaration and initialization of the FS ops structures */
1443 struct page_map_operations ext2_pm_op = {
1444         ext2_readpage,
1445         ext2_writepage,
1446 };
1447
1448 struct super_operations ext2_s_op = {
1449         ext2_alloc_inode,
1450         ext2_dealloc_inode,
1451         ext2_read_inode,
1452         ext2_dirty_inode,
1453         ext2_write_inode,
1454         ext2_put_inode,
1455         ext2_drop_inode,
1456         ext2_delete_inode,
1457         ext2_put_super,
1458         ext2_write_super,
1459         ext2_sync_fs,
1460         ext2_remount_fs,
1461         ext2_umount_begin,
1462 };
1463
1464 struct inode_operations ext2_i_op = {
1465         ext2_create,
1466         ext2_lookup,
1467         ext2_link,
1468         ext2_unlink,
1469         ext2_symlink,
1470         ext2_mkdir,
1471         ext2_rmdir,
1472         ext2_mknod,
1473         ext2_rename,
1474         ext2_readlink,
1475         ext2_truncate,
1476         ext2_permission,
1477 };
1478
1479 struct dentry_operations ext2_d_op = {
1480         ext2_d_revalidate,
1481         generic_dentry_hash,
1482         ext2_d_compare,
1483         ext2_d_delete,
1484         ext2_d_release,
1485         ext2_d_iput,
1486 };
1487
1488 struct file_operations ext2_f_op_file = {
1489         ext2_llseek,
1490         generic_file_read,
1491         generic_file_write,
1492         ext2_readdir,
1493         ext2_mmap,
1494         ext2_open,
1495         ext2_flush,
1496         ext2_release,
1497         ext2_fsync,
1498         ext2_poll,
1499         ext2_readv,
1500         ext2_writev,
1501         ext2_sendpage,
1502         ext2_check_flags,
1503 };
1504
1505 struct file_operations ext2_f_op_dir = {
1506         ext2_llseek,
1507         generic_dir_read,
1508         0,
1509         ext2_readdir,
1510         ext2_mmap,
1511         ext2_open,
1512         ext2_flush,
1513         ext2_release,
1514         ext2_fsync,
1515         ext2_poll,
1516         ext2_readv,
1517         ext2_writev,
1518         ext2_sendpage,
1519         ext2_check_flags,
1520 };
1521
1522 struct file_operations ext2_f_op_sym = {
1523         ext2_llseek,
1524         generic_file_read,
1525         generic_file_write,
1526         ext2_readdir,
1527         ext2_mmap,
1528         ext2_open,
1529         ext2_flush,
1530         ext2_release,
1531         ext2_fsync,
1532         ext2_poll,
1533         ext2_readv,
1534         ext2_writev,
1535         ext2_sendpage,
1536         ext2_check_flags,
1537 };