Converts page_map for bdev usage
[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 #include <pagemap.h>
14
15 /* All block IO is done assuming a certain size sector, which is the smallest
16  * possible unit of transfer between the kernel and the block layer.  This can
17  * be bigger than what the underlying hardware can handle, but it shouldn't be
18  * smaller than any higher-level block (like an FS block, which are often 1 KB).
19  */
20 #define SECTOR_SZ_LOG 9
21 #define SECTOR_SZ (1 << SECTOR_SZ_LOG)
22
23 /* Every block device is represented by one of these, with custom methods, as
24  * applicable for the type of device.  Subject to massive changes. */
25 #define BDEV_INLINE_NAME 10
26 struct block_device {
27         int                                                     b_id;
28         unsigned int                            b_sector_size;          /* HW sector size */
29         unsigned long                           b_num_sectors;          /* Total sectors on dev */
30         struct kref                                     b_kref;
31         struct page_map                         b_pm;
32         void                                            *b_data;                        /* dev-specific use */
33         char                                            b_name[BDEV_INLINE_NAME];
34         // TODO: list or something of buffer heads (?)
35         // list of outstanding requests
36         // io scheduler
37         // callbacks for completion
38 };
39
40 /* Not sure which of these we'll need, if any */
41 #define BH_LOCKED               0x001   /* involved in an IO op */
42 #define BH_UPTODATE             0x002   /* buffer is filled with file data */
43 #define BH_DIRTY                0x004   /* buffer is dirty */
44
45 /* This maps to and from a buffer within a page to a block(s) on a bdev.  Some
46  * of it might not be needed later, etc (page, numblock). */
47 struct buffer_head {
48         struct page                                     *bh_page;                       /* redundant with buffer */
49         void                                            *bh_buffer;
50         unsigned int                            bh_flags;
51         struct buffer_head                      *bh_next;                       /* circular LL of BHs */
52         struct block_device                     *bh_bdev;
53         unsigned long                           bh_blocknum;
54         unsigned int                            bh_numblock;            /* length (in blocks) */
55 };
56 struct kmem_cache *bh_kcache;
57
58 /* This encapsulates the work of a request (instead of having a variety of
59  * slightly-different functions for things like read/write and scatter-gather
60  * ops).  Reads and writes are essentially the same, so all we need is a flag to
61  * differentiate.  This struct also serves as a tool to track the progress of a
62  * block request throughout its servicing.  This is analagous to Linux's struct
63  * bio.
64  *
65  * For now, this just holds the stuff to do some simple sector reading. */
66 struct block_request {
67         int                                                     flags;
68         void                                            *buffer;
69         unsigned int                            first_sector;
70         unsigned int                            amount;
71 };
72 struct kmem_cache *breq_kcache; /* for the block requests */
73
74 /* Block request flags */
75 #define BREQ_READ                       0x001
76 #define BREQ_WRITE                      0x002
77
78 void block_init(void);
79 struct block_device *get_bdev(char *path);
80 void free_bhs(struct page *page);
81 /* This function will probably be the one that blocks */
82 int make_request(struct block_device *bdev, struct block_request *req);
83
84 #endif /* ROS_KERN_BLOCKDEV_H */