lwext4/ext4_blockdev.c

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup lwext4
  30  * @{
  31  */
  32 /**
  33  * @file  ext4_blockdev.c
  34  * @brief Block device module.
  35  */
  36
  37 #include <ext4_config.h>
  38 #include <ext4_blockdev.h>
  39 #include <ext4_errno.h>
  40 #include <ext4_debug.h>
  41
  42 #include <string.h>
  43 #include <stdlib.h>
  44
  45
  46
  47 int     ext4_block_init(struct  ext4_blockdev *bdev)
  48 {
  49     int rc;
  50     ext4_assert(bdev);
  51
  52     ext4_assert(bdev->open && bdev->close && bdev->bread  && bdev->bwrite);
  53
  54     /*Low level block init*/
  55     rc = bdev->open(bdev);
  56     if(rc != EOK)
  57         return rc;
  58
  59     bdev->flags |= EXT4_BDEV_INITIALIZED;
  60
  61     return      EOK;
  62 }
  63
  64 int ext4_block_bind_bcache(struct ext4_blockdev *bdev, struct ext4_bcache *bc)
  65 {
  66     ext4_assert(bdev && bc);
  67     bdev->bc = bc;
  68     return EOK;
  69 }
  70
  71 void ext4_block_set_lb_size(struct      ext4_blockdev *bdev, uint64_t   lb_bsize)
  72 {
  73     /*Logical block size has to be multiply of physical */
  74     ext4_assert(!(lb_bsize % bdev->ph_bsize));
  75
  76     bdev->lg_bsize = lb_bsize;
  77     bdev->lg_bcnt = (bdev->ph_bcnt * bdev->ph_bsize) / lb_bsize;
  78
  79 }
  80
  81 int ext4_block_fini(struct      ext4_blockdev *bdev)
  82 {
  83     ext4_assert(bdev);
  84
  85     bdev->flags &= ~(EXT4_BDEV_INITIALIZED);
  86
  87     /*Low level block fini*/
  88     return bdev->close(bdev);
  89 }
  90
  91
  92 int ext4_block_get(struct       ext4_blockdev *bdev, struct     ext4_block *b,
  93     uint64_t lba)
  94 {
  95     uint64_t pba;
  96     uint32_t pb_cnt;
  97     uint32_t i;
  98     bool is_new;
  99     int r;
 100
 101     ext4_assert(bdev && b);
 102
 103     if(!(bdev->flags & EXT4_BDEV_INITIALIZED))
 104         return EIO;
 105
 106     if(!(lba < bdev->lg_bcnt))
 107         return ERANGE;
 108
 109     b->dirty = 0;
 110     b->lb_id = lba;
 111
 112     /*If cache is full we have to flush it anyway :(*/
 113     if(ext4_bcache_is_full(bdev->bc) && bdev->cache_flush_delay){
 114         for (i = 0; i < bdev->bc->cnt; ++i) {
 115             /*Check if buffer free was delayed.*/
 116             if(!bdev->bc->free_delay[i])
 117                 continue;
 118
 119             /*Check reference counter.*/
 120             if(bdev->bc->refctr[i])
 121                 continue;
 122
 123             /*Buffer free was delayed and have no reference. Flush it.*/
 124             r = ext4_blocks_set_direct(bdev,
 125                     bdev->bc->data + bdev->bc->itemsize * i,
 126                     bdev->bc->lba[i], 1);
 127             if(r != EOK)
 128                 return r;
 129
 130             /*No delayed anymore*/
 131             bdev->bc->free_delay[i] = 0;
 132
 133             /*Reduce refered block count*/
 134             bdev->bc->ref_blocks--;
 135         }
 136     }
 137
 138
 139     r = ext4_bcache_alloc(bdev->bc, b, &is_new);
 140     if(r != EOK)
 141         return r;
 142
 143
 144     if(!is_new){
 145         /*Block is in cache. Read from physical device is not required*/
 146         return EOK;
 147     }
 148
 149     if(!b->data)
 150         return ENOMEM;
 151
 152     pba = (lba * bdev->lg_bsize) / bdev->ph_bsize;
 153     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 154
 155     r = bdev->bread(bdev, b->data, pba, pb_cnt);
 156
 157     if(r != EOK){
 158         ext4_bcache_free(bdev->bc, b, 0);
 159         b->lb_id = 0;
 160         return r;
 161     }
 162
 163     bdev->bread_ctr++;
 164     return EOK;
 165 }
 166
 167 int ext4_block_set(struct       ext4_blockdev *bdev, struct     ext4_block *b)
 168 {
 169     uint64_t pba;
 170     uint32_t pb_cnt;
 171     int r;
 172
 173     ext4_assert(bdev && b);
 174
 175     if(!(bdev->flags & EXT4_BDEV_INITIALIZED))
 176         return EIO;
 177
 178     /*Doesn,t need to write.*/
 179     if(b->dirty == false){
 180         ext4_bcache_free(bdev->bc, b, 0);
 181         return EOK;
 182     }
 183
 184     /*Free cache delay mode*/
 185     if(bdev->cache_flush_delay){
 186
 187         /*Free cahe block and mark as free delayed*/
 188         return ext4_bcache_free(bdev->bc, b, bdev->cache_flush_delay);
 189     }
 190
 191     pba = (b->lb_id * bdev->lg_bsize) / bdev->ph_bsize;
 192     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 193
 194
 195     r = bdev->bwrite(bdev, b->data, pba, pb_cnt);
 196
 197     if(r != EOK){
 198         b->dirty = false;
 199         ext4_bcache_free(bdev->bc, b, 0);
 200         return r;
 201     }
 202
 203     bdev->bwrite_ctr++;
 204     b->dirty = false;
 205     ext4_bcache_free(bdev->bc, b, 0);
 206     return EOK;
 207 }
 208
 209 int ext4_blocks_get_direct(struct       ext4_blockdev *bdev, void *buf,
 210     uint64_t lba, uint32_t cnt)
 211 {
 212     uint64_t pba;
 213     uint32_t pb_cnt;
 214
 215     ext4_assert(bdev && buf);
 216
 217     pba = (lba * bdev->lg_bsize) / bdev->ph_bsize;
 218     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 219
 220     bdev->bread_ctr++;
 221     return bdev->bread(bdev, buf, pba, pb_cnt * cnt);
 222 }
 223
 224 int ext4_blocks_set_direct(struct       ext4_blockdev *bdev, const void *buf,
 225     uint64_t lba, uint32_t cnt)
 226 {
 227     uint64_t pba;
 228     uint32_t pb_cnt;
 229
 230     ext4_assert(bdev && buf);
 231
 232     pba = (lba * bdev->lg_bsize) / bdev->ph_bsize;
 233     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 234
 235     bdev->bwrite_ctr++;
 236
 237     return bdev->bwrite(bdev, buf, pba, pb_cnt * cnt);
 238 }
 239
 240
 241 int     ext4_block_writebytes(struct    ext4_blockdev *bdev, uint64_t off,
 242     const void *buf, uint32_t len)
 243 {
 244     uint64_t block_idx;
 245     uint64_t block_end;
 246     uint32_t blen;
 247     uint32_t unalg;
 248     int r = EOK;
 249
 250     const uint8_t       *p = (void *)buf;
 251
 252     ext4_assert(bdev && buf);
 253
 254     if(!(bdev->flags & EXT4_BDEV_INITIALIZED))
 255         return EIO;
 256
 257     block_idx =  off / bdev->ph_bsize;
 258     block_end   =  block_idx + len / bdev->ph_bsize;
 259
 260     if(!(block_end < bdev->ph_bcnt))
 261         return EINVAL;                          /*Ups. Out of range operation*/
 262
 263     /*OK lets deal with the first possible unaligned block*/
 264     unalg = (off & (bdev->ph_bsize - 1));
 265     if(unalg){
 266
 267         uint32_t wlen = (bdev->ph_bsize - unalg) > len ?
 268                 len : (bdev->ph_bsize - unalg);
 269
 270         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 271
 272         if(r != EOK)
 273             return r;
 274
 275         memcpy(bdev->ph_bbuf + unalg, p, wlen);
 276
 277         r = bdev->bwrite(bdev, bdev->ph_bbuf, block_idx, 1);
 278         if(r != EOK)
 279             return r;
 280
 281         p   += wlen;
 282         len -= wlen;
 283         block_idx++;
 284     }
 285
 286
 287     /*Aligned data*/
 288     blen = len / bdev->ph_bsize;
 289     r = bdev->bwrite(bdev, p, block_idx, blen);
 290
 291     if(r != EOK)
 292         return r;
 293
 294     p += bdev->ph_bsize * blen;
 295     len -= bdev->ph_bsize * blen;
 296
 297     block_idx += blen;
 298
 299
 300     /*Rest of the data*/
 301     if(len){
 302         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 303         if(r != EOK)
 304             return r;
 305
 306         memcpy(bdev->ph_bbuf, p, len);
 307
 308         r = bdev->bwrite(bdev, bdev->ph_bbuf, block_idx, 1);
 309
 310         if(r != EOK)
 311             return r;
 312     }
 313
 314     return r;
 315 }
 316
 317
 318
 319
 320 int ext4_block_readbytes(struct ext4_blockdev *bdev, uint64_t off, void *buf,
 321     uint32_t len)
 322 {
 323     uint64_t block_idx;
 324     uint64_t block_end;
 325     uint32_t blen;
 326     uint32_t unalg;
 327     int r = EOK;
 328
 329     uint8_t     *p = (void *)buf;
 330
 331     ext4_assert(bdev && buf);
 332
 333     if(!(bdev->flags & EXT4_BDEV_INITIALIZED))
 334         return EIO;
 335
 336     block_idx = off / bdev->ph_bsize;
 337     block_end = block_idx + len / bdev->ph_bsize;
 338
 339     if(!(block_end < bdev->ph_bcnt))
 340         return EINVAL;                          /*Ups. Out of range operation*/
 341
 342     /*OK lets deal with the first possible unaligned block*/
 343     unalg = (off & (bdev->ph_bsize - 1));
 344     if(unalg){
 345
 346         uint32_t rlen = (bdev->ph_bsize - unalg) > len ?
 347                 len : (bdev->ph_bsize - unalg);
 348
 349         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 350         if(r != EOK)
 351             return r;
 352
 353         memcpy(p, bdev->ph_bbuf + unalg, rlen);
 354
 355         p   += rlen;
 356         len -= rlen;
 357         block_idx++;
 358     }
 359
 360     /*Aligned data*/
 361     blen = len / bdev->ph_bsize;
 362
 363     r = bdev->bread(bdev, p, block_idx, blen);
 364
 365     if(r != EOK)
 366         return r;
 367
 368     p   += bdev->ph_bsize * blen;
 369     len -= bdev->ph_bsize * blen;
 370
 371     block_idx += blen;
 372
 373
 374     /*Rest of the data*/
 375     if(len){
 376         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 377         if(r != EOK)
 378             return r;
 379
 380         memcpy(p, bdev->ph_bbuf, len);
 381     }
 382
 383     return r;
 384 }
 385
 386 int     ext4_block_delay_cache_flush(struct     ext4_blockdev *bdev,
 387     uint8_t on_off)
 388 {
 389     int r;
 390     uint32_t i;
 391     bdev->cache_flush_delay = on_off;
 392
 393     /*Flush all delayed cache blocks*/
 394     if(!on_off){
 395         for (i = 0; i < bdev->bc->cnt; ++i) {
 396
 397             /*Check if buffer free was delayed.*/
 398             if(!bdev->bc->free_delay[i])
 399                 continue;
 400
 401             /*Check reference counter.*/
 402             if(bdev->bc->refctr[i])
 403                 continue;
 404
 405             /*Buffer free was delayed and have no reference. Flush it.*/
 406             r = ext4_blocks_set_direct(bdev,
 407                     bdev->bc->data + bdev->bc->itemsize * i,
 408                     bdev->bc->lba[i], 1);
 409             if(r != EOK)
 410                 return r;
 411
 412             /*No delayed anymore*/
 413             bdev->bc->free_delay[i] = 0;
 414
 415             /*Reduce refered block count*/
 416             bdev->bc->ref_blocks--;
 417         }
 418     }
 419     return EOK;
 420 }
 421
 422 /**
 423  * @}
 424  */
 425