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