Block layer and ext2 headers
[akaros.git] / kern / include / blockdev.h
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 device interfaces and structures */
6
7 #ifndef ROS_KERN_BLOCKDEV_H
8 #define ROS_KERN_BLOCKDEV_H
9
10 #include <ros/common.h>
11 #include <kref.h>
12 #include <slab.h>
13
14 /* All block IO is done assuming a certain size sector, which is the smallest
15  * possible unit of transfer between the kernel and the block layer.  This can
16  * be bigger than what the underlying hardware can handle, but it shouldn't be
17  * smaller than any higher-level block (like an FS block, which are often 1 KB).
18  */
19 #define SECTOR_SIZE 512
20
21 /* Every block device is represented by one of these, with custom methods, as
22  * applicable for the type of device.  Subject to massive changes. */
23 #define BDEV_INLINE_NAME 10
24 struct block_device {
25         int                                                     b_id;
26         unsigned int                            b_sector_size;          /* HW sector size */
27         unsigned int                            b_num_sectors;          /* Total sectors on dev */
28         struct kref                                     b_kref;
29         void                                            *b_data;                        /* dev-specific use */
30         char                                            b_name[BDEV_INLINE_NAME];
31         // TODO: list or something of buffer heads (?)
32         // list of outstanding requests
33         // io scheduler
34         // callbacks for completion
35 };
36
37 /* This encapsulates the work of a request (instead of having a variety of
38  * slightly-different functions for things like read/write and scatter-gather
39  * ops).  Reads and writes are essentially the same, so all we need is a flag to
40  * differentiate.  This struct also serves as a tool to track the progress of a
41  * block request throughout its servicing.  This is analagous to Linux's struct
42  * bio.
43  *
44  * For now, this just holds the stuff to do some simple sector reading. */
45 struct block_request {
46         int                                                     flags;
47         void                                            *buffer;
48         unsigned int                            first_sector;
49         unsigned int                            amount;
50 };
51 struct kmem_cache *breq_kcache; /* for the block requests */
52
53 /* Block request flags */
54 #define BREQ_READ                       0x001
55 #define BREQ_WRITE                      0x002
56
57 void block_init(void);
58 /* This function will probably be the one that blocks */
59 int make_request(struct block_device *bdev, struct block_request *req);
60
61 #endif /* ROS_KERN_BLOCKDEV_H */