Second Extended Filesystem (ext2) and other improvements (#33)

[lunaix-os.git] / lunaix-os / includes / lunaix / blkio.h

diff --git a/lunaix-os/includes/lunaix/blkio.h b/lunaix-os/includes/lunaix/blkio.h
index a189a4de8f70735273be3f15aeec889a1c184b7c..6470194904d75c3b026bf422de748e21289d42aa 100644 (file)
--- a/lunaix-os/includes/lunaix/blkio.h
+++ b/lunaix-os/includes/lunaix/blkio.h
@@ -1,9 +1,11 @@
 #ifndef __LUNAIX_BLKIO_H
 #define __LUNAIX_BLKIO_H
 
+#include <lunaix/buffer.h>
 #include <lunaix/buffer.h>
 #include <lunaix/ds/llist.h>
 #include <lunaix/ds/waitq.h>
+#include <lunaix/ds/mutex.h>
 #include <lunaix/types.h>
 
 #define BLKIO_WRITE 0x1
@@ -11,11 +13,13 @@
 
 #define BLKIO_BUSY 0x4
 #define BLKIO_PENDING 0x8
-
-#define BLKIO_WAIT 0x1
-
 // Free on complete
 #define BLKIO_FOC 0x10
+#define BLKIO_SHOULD_WAIT 0x20
+
+#define BLKIO_WAIT 0x1
+#define BLKIO_NOWAIT 0
+#define BLKIO_NOASYNC 0x2
 
 #define BLKIO_SCHED_IDEL 0x1
 
@@ -40,17 +44,39 @@ struct blkio_req
 struct blkio_context
 {
     struct llist_header queue;
+
     struct
     {
         u32_t seektime;
         u32_t rotdelay;
     } metrics;
+
     req_handler handle_one;
     u32_t state;
     u32_t busy;
     void* driver;
+
+    mutex_t lock;
 };
 
+static inline void
+blkio_lock(struct blkio_context* contex)
+{
+    mutex_lock(&contex->lock);
+}
+
+static inline void
+blkio_unlock(struct blkio_context* contex)
+{
+    mutex_unlock(&contex->lock);
+}
+
+static inline bool
+blkio_stalled(struct blkio_context* contex)
+{
+    return !contex->busy;
+}
+
 void
 blkio_init();
 
@@ -88,6 +114,131 @@ blkio_vwr(struct vecbuf* vbuf,
           void* evt_args,
           u32_t options);
 
+/**
+ * @brief Vectorized request (no write/read preference)
+ *
+ * @param vbuf
+ * @param start_lba
+ * @param completed
+ * @param evt_args
+ * @param options
+ * @return struct blkio_req*
+ */
+static inline struct blkio_req*
+blkio_vreq(struct vecbuf* buffer,
+          u64_t start_lba,
+          blkio_cb completed,
+          void* evt_args,
+          u32_t options) {
+    /*
+        This is currently aliased to blkio_vrd. Although `no preference`
+        does essentially mean `default read`, the blkio_vreq just used
+        to enhance readability
+    */
+    return blkio_vrd(buffer, start_lba, completed, evt_args, options);
+}
+
+
+/**
+ * @brief Bind a block IO context to request
+ *
+ * @param ctx
+ * @param req
+ */
+static inline void
+blkio_bindctx(struct blkio_req* req, struct blkio_context* ctx)
+{
+    req->io_ctx = ctx;
+}
+
+/**
+ * @brief Set block IO request to read
+ *
+ * @param ctx
+ * @param req
+ */
+static inline void
+blkio_setread(struct blkio_req* req)
+{
+    if ((req->flags & BLKIO_PENDING)) {
+        return;
+    }
+    
+    req->flags &= ~BLKIO_WRITE;
+}
+
+/**
+ * @brief Set block IO request to write
+ *
+ * @param ctx
+ * @param req
+ */
+static inline void
+blkio_setwrite(struct blkio_req* req)
+{
+    if ((req->flags & BLKIO_PENDING)) {
+        return;
+    }
+
+    req->flags |= BLKIO_WRITE;
+}
+
+/**
+ * @brief Set callback when request complete
+ * 
+ * @param req 
+ * @param on_completed 
+ */
+static inline void
+blkio_when_completed(struct blkio_req* req, blkio_cb on_completed)
+{
+    req->completed = on_completed;
+}
+
+static inline bool
+blkio_is_pending(struct blkio_req* req)
+{
+    return (req->flags & BLKIO_PENDING);
+}
+
+/**
+ * @brief Mark request to be freed-on-completion (FOC)
+ * 
+ * @param req 
+ */
+static inline void
+blkio_mark_foc(struct blkio_req* req)
+{
+    req->flags |= BLKIO_FOC;
+}
+
+/**
+ * @brief Mark request to be not-freed-on-completion (nFOC)
+ * 
+ * @param req 
+ */
+static inline void
+blkio_mark_nfoc(struct blkio_req* req)
+{
+    req->flags &= ~BLKIO_FOC;
+}
+
+int
+blkio_read_aligned(struct blkio_context* ctx, 
+                   unsigned long lba, void* block, size_t n_blk);
+
+int
+blkio_read(struct blkio_context* ctx, 
+           unsigned long offset, void* block, size_t len);
+
+int
+blkio_write_aligned(struct blkio_context* ctx, 
+                    unsigned long lba, void* block, size_t n_blk);
+
+int
+blkio_read(struct blkio_context* ctx, 
+           unsigned long offset, void* block, size_t len);
+
 void
 blkio_free_req(struct blkio_req* req);
 
@@ -98,7 +249,8 @@ blkio_free_req(struct blkio_req* req);
  * @param req
  */
 void
-blkio_commit(struct blkio_context* ctx, struct blkio_req* req, int options);
+blkio_commit(struct blkio_req* req, int options);
+
 
 /**
  * @brief Schedule an IO request to be handled.