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