336a7d9921f399aa9e73c9c532cb4a41bc2f1593
[akaros.git] / kern / src / blockdev.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  * Block devices and generic blockdev infrastructure */
6
7 #include <devfs.h>
8 #include <blockdev.h>
9 #include <kmalloc.h>
10 #include <slab.h>
11 #include <page_alloc.h>
12 #include <pmap.h>
13 /* These two are needed for the fake interrupt */
14 #include <alarm.h>
15 #include <smp.h>
16
17 struct file_operations block_f_op;
18 struct page_map_operations block_pm_op;
19 struct kmem_cache *breq_kcache;
20
21 void block_init(void)
22 {
23         breq_kcache = kmem_cache_create("block_reqs", sizeof(struct block_request),
24                                         __alignof__(struct block_request), 0, 0, 0);
25         bh_kcache = kmem_cache_create("buffer_heads", sizeof(struct buffer_head),
26                                       __alignof__(struct buffer_head), 0, 0, 0);
27
28         #ifdef __CONFIG_EXT2FS__
29         /* Now probe for and init the block device for the ext2 ram disk */
30         extern uint8_t _binary_mnt_ext2fs_img_size[];
31         extern uint8_t _binary_mnt_ext2fs_img_start[];
32         /* Build and init the block device */
33         struct block_device *ram_bd = kmalloc(sizeof(struct block_device), 0);
34         memset(ram_bd, 0, sizeof(struct block_device));
35         ram_bd->b_id = 31337;
36         ram_bd->b_sector_sz = 512;
37         ram_bd->b_nr_sector = (unsigned int)_binary_mnt_ext2fs_img_size / 512;
38         kref_init(&ram_bd->b_kref, fake_release, 1);
39         pm_init(&ram_bd->b_pm, &block_pm_op, ram_bd);
40         ram_bd->b_data = _binary_mnt_ext2fs_img_start;
41         strncpy(ram_bd->b_name, "RAMDISK", BDEV_INLINE_NAME);
42         ram_bd->b_name[BDEV_INLINE_NAME - 1] = '\0';
43         /* Connect it to the file system */
44         struct file *ram_bf = make_device("/dev/ramdisk", S_IRUSR | S_IWUSR,
45                                           __S_IFBLK, &block_f_op);
46         /* make sure the inode tracks the right pm (not it's internal one) */
47         ram_bf->f_dentry->d_inode->i_mapping = &ram_bd->b_pm;
48         ram_bf->f_dentry->d_inode->i_bdev = ram_bd;     /* this holds the bd kref */
49         kref_put(&ram_bf->f_kref);
50         #endif /* __CONFIG_EXT2FS__ */
51 }
52
53 /* Generic helper, returns a kref'd reference out of principle. */
54 struct block_device *get_bdev(char *path)
55 {
56         struct block_device *bdev;
57         struct file *block_f;
58         block_f = do_file_open(path, O_RDWR, 0);
59         assert(block_f);
60         bdev = block_f->f_dentry->d_inode->i_bdev;
61         kref_get(&bdev->b_kref, 1);
62         kref_put(&block_f->f_kref);
63         return bdev;
64 }
65
66 /* Frees all the BHs associated with page.  There could be 0, to deal with one
67  * that wasn't UPTODATE.  Don't call this on a page that isn't a PG_BUFFER.
68  * Note, these are not a circular LL (for now). */
69 void free_bhs(struct page *page)
70 {
71         struct buffer_head *bh, *next;
72         assert(page->pg_flags & PG_BUFFER);
73         bh = (struct buffer_head*)page->pg_private;
74         while (bh) {
75                 next = bh->bh_next;
76                 bh->bh_next = 0;
77                 kmem_cache_free(bh_kcache, bh);
78                 bh = next;
79         }
80         page->pg_private = 0;           /* catch bugs */
81 }
82
83 /* This ultimately will handle the actual request processing, all the way down
84  * to the driver, and will deal with blocking.  For now, we just fulfill the
85  * request right away (RAM based block devs). */
86 int bdev_submit_request(struct block_device *bdev, struct block_request *breq)
87 {
88         void *src, *dst;
89         unsigned long first_sector;
90         unsigned int nr_sector;
91
92         for (int i = 0; i < breq->nr_bhs; i++) {
93                 first_sector = breq->bhs[i]->bh_sector;
94                 nr_sector = breq->bhs[i]->bh_nr_sector;
95                 /* Sectors are indexed starting with 0, for now. */
96                 if (first_sector + nr_sector > bdev->b_nr_sector) {
97                         warn("Exceeding the num sectors!");
98                         return -1;
99                 }
100                 if (breq->flags & BREQ_READ) {
101                         dst = breq->bhs[i]->bh_buffer;
102                         src = bdev->b_data + (first_sector << SECTOR_SZ_LOG);
103                 } else if (breq->flags & BREQ_WRITE) {
104                         dst = bdev->b_data + (first_sector << SECTOR_SZ_LOG);
105                         src = breq->bhs[i]->bh_buffer;
106                 } else {
107                         panic("Need a request type!\n");
108                 }
109                 memcpy(dst, src, nr_sector << SECTOR_SZ_LOG);
110         }
111 #ifdef __i386__         /* Sparc can't kthread yet */
112         /* Faking the device interrupt with an alarm */
113         void breq_handler(struct alarm_waiter *waiter)
114         {
115                 /* In the future, we'll need to figure out which breq this was in
116                  * response to */
117                 struct block_request *breq = (struct block_request*)waiter->data;
118                 if (breq->callback)
119                         breq->callback(breq);
120                 kfree(waiter);
121         }
122         struct timer_chain *tchain = &per_cpu_info[core_id()].tchain;
123         struct alarm_waiter *waiter = kmalloc(sizeof(struct alarm_waiter), 0);
124         init_awaiter(waiter, breq_handler);
125         /* Stitch things up, so we know how to find things later */
126         waiter->data = breq;
127         /* Set for 5ms.  The time might not be accurate in KVM. */
128         set_awaiter_rel(waiter, 5000);
129         set_alarm(tchain, waiter);
130 #else
131         if (breq->callback)
132                 breq->callback(breq);
133 #endif
134
135         return 0;
136 }
137
138 /* Helper method, unblocks someone blocked on sleep_on_breq(). */
139 void generic_breq_done(struct block_request *breq)
140 {
141 #ifdef __i386__         /* Sparc can't restart kthreads yet */
142         struct kthread *sleeper = __up_sem(&breq->sem);
143         if (!sleeper) {
144                 /* this is odd, but happened a lot with kvm, probably due to the ghetto
145                  * lack of a one-shot per-core timer.  keeping this just in case. */
146                 printk("[kernel] no one waiting on breq %08p\n", breq);
147                 return;
148         }
149         kthread_runnable(sleeper);
150         assert(TAILQ_EMPTY(&breq->sem.waiters));
151 #else
152         breq->data = (void*)1;
153 #endif
154 }
155
156 /* Helper, pairs with generic_breq_done().  Note we sleep here on a semaphore
157  * instead of faking it with an alarm.  Ideally, this code will be the same even
158  * for real block devices (that don't fake things with timer interrupts). */
159 void sleep_on_breq(struct block_request *breq)
160 {
161         /* Since printk takes a while, this may make you lose the race */
162         printd("Sleeping on breq %08p\n", breq);
163         assert(irq_is_enabled());
164 #ifdef __i386__
165         sleep_on(&breq->sem);
166 #else
167         /* Sparc can't block yet (TODO).  This only works if the completion happened
168          * first (for now) */
169         assert(breq->data);
170 #endif
171 }
172
173 /* This just tells the page cache that it is 'up to date'.  Due to the nature of
174  * the blocks in the page cache, we don't actually read the items in on
175  * readpage, we read them in when a specific block is there */
176 int block_readpage(struct page_map *pm, struct page *page)
177 {
178         page->pg_flags |= PG_UPTODATE;
179         return 0;
180 }
181
182 /* Returns a BH pointing to the buffer where blk_num from bdev is located (given
183  * blocks of size blk_sz).  This uses the page cache for the page allocations
184  * and evictions, but only caches blocks that are requested.  Check the docs for
185  * more info.  The BH isn't refcounted, but a page refcnt is returned.  Call
186  * put_block (nand/xor dirty block).
187  *
188  * Note we're using the lock_page() to sync (which is what we do with the page
189  * cache too.  It's not ideal, but keeps things simpler for now.
190  *
191  * Also note we're a little inconsistent with the use of sector sizes in certain
192  * files.  We'll sort it eventually. */
193 struct buffer_head *bdev_get_buffer(struct block_device *bdev,
194                                     unsigned long blk_num, unsigned int blk_sz)
195 {
196         struct page *page;
197         struct page_map *pm = &bdev->b_pm;
198         struct buffer_head *bh, *new, *prev, **next_loc;
199         struct block_request *breq;
200         int error;
201         unsigned int blk_per_pg = PGSIZE / blk_sz;
202         unsigned int sct_per_blk = blk_sz / bdev->b_sector_sz;
203         unsigned int blk_offset = (blk_num % blk_per_pg) * blk_sz;
204         void *my_buf;
205         assert(blk_offset < PGSIZE);
206         if (!blk_num)
207                 warn("Asking for the 0th block of a bdev...");
208         /* Make sure there's a page in the page cache.  Should always be one. */
209         error = pm_load_page(pm, blk_num / blk_per_pg, &page); 
210         if (error)
211                 panic("Failed to load page! (%d)", error);
212         my_buf = page2kva(page) + blk_offset;
213         assert(page->pg_flags & PG_BUFFER);             /* Should be part of a page map */
214 retry:
215         bh = (struct buffer_head*)page->pg_private;
216         prev = 0;
217         /* look through all the BHs for ours, stopping if we go too far. */
218         while (bh) {
219                 if (bh->bh_buffer == my_buf) {
220                         goto found;
221                 } else if (bh->bh_buffer > my_buf) {
222                         break;
223                 }
224                 prev = bh;
225                 bh = bh->bh_next;
226         }
227         /* At this point, bh points to the one beyond our space (or 0), and prev is
228          * either the one before us or 0.  We make a BH, and try to insert */
229         new = kmem_cache_alloc(bh_kcache, 0);
230         assert(new);
231         new->bh_page = page;                                    /* weak ref */
232         new->bh_buffer = my_buf;
233         new->bh_flags = 0;
234         new->bh_next = bh;
235         new->bh_bdev = bdev;                                    /* uncounted ref */
236         new->bh_sector = blk_num * sct_per_blk;
237         new->bh_nr_sector = sct_per_blk;
238         /* Try to insert the new one in place.  If it fails, retry the whole "find
239          * the bh" process.  This should be rare, so no sense optimizing it. */
240         next_loc = prev ? &prev->bh_next : (struct buffer_head**)&page->pg_private;
241         if (!atomic_comp_swap((uint32_t*)next_loc, (uint32_t)bh, (uint32_t)new)) {
242                 kmem_cache_free(bh_kcache, new);
243                 goto retry;
244         }
245         bh = new;
246 found:
247         /* At this point, we have the BH for our buf, but it might not be up to
248          * date, and there might be someone else trying to update it. */
249         /* is it already here and up to date?  if so, we're done */
250         if (bh->bh_flags & BH_UPTODATE)
251                 return bh;
252         /* if not, try to lock the page (could BLOCK).  Using this for syncing. */
253         lock_page(page);
254         /* double check, are we up to date?  if so, we're done */
255         if (bh->bh_flags & BH_UPTODATE) {
256                 unlock_page(page);
257                 return bh;
258         }
259         /* if we're here, the page is locked by us, we need to read the block */
260         breq = kmem_cache_alloc(breq_kcache, 0);
261         assert(breq);
262         breq->flags = BREQ_READ;
263         breq->callback = generic_breq_done;
264         breq->data = 0;
265         init_sem(&breq->sem, 0);
266         breq->bhs = breq->local_bhs;
267         breq->bhs[0] = bh;
268         breq->nr_bhs = 1;
269         error = bdev_submit_request(bdev, breq);
270         assert(!error);
271         sleep_on_breq(breq);
272         kmem_cache_free(breq_kcache, breq);
273         /* after the data is read, we mark it up to date and unlock the page. */
274         bh->bh_flags |= BH_UPTODATE;
275         unlock_page(page);
276         return bh;
277 }
278
279 /* Will dirty the block/BH/page for the given block/buffer.  Will have to be
280  * careful with the page reclaimer - if someone holds a reference, they can
281  * still dirty it. */
282 void bdev_dirty_buffer(struct buffer_head *bh)
283 {
284         struct page *page = bh->bh_page;
285         /* TODO: race on flag modification */
286         bh->bh_flags |= BH_DIRTY;
287         page->pg_flags |= PG_DIRTY;
288 }
289
290 /* Decrefs the buffer from bdev_get_buffer().  Call this when you no longer
291  * reference your block/buffer.  For now, we do refcnting on the page, since the
292  * reclaiming will be in page sized chunks from the page cache. */
293 void bdev_put_buffer(struct buffer_head *bh)
294 {
295         page_decref(bh->bh_page);
296 }
297
298 /* Block device page map ops: */
299 struct page_map_operations block_pm_op = {
300         block_readpage,
301 };
302
303 /* Block device file ops: for now, we don't let you do much of anything */
304 struct file_operations block_f_op = {
305         dev_c_llseek,
306         0,
307         0,
308         kfs_readdir,    /* this will fail gracefully */
309         dev_mmap,
310         kfs_open,
311         kfs_flush,
312         kfs_release,
313         0,      /* fsync - makes no sense */
314         kfs_poll,
315         0,      /* readv */
316         0,      /* writev */
317         kfs_sendpage,
318         kfs_check_flags,
319 };