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_write_back){
 114
 115         uint32_t free_candidate = bdev->bc->cnt;
 116         uint32_t min_lru = 0xFFFFFFFF;
 117
 118         for (i = 0; i < bdev->bc->cnt; ++i) {
 119             /*Check if buffer free was delayed.*/
 120             if(!bdev->bc->free_delay[i])
 121                 continue;
 122
 123             /*Check reference counter.*/
 124             if(bdev->bc->refctr[i])
 125                 continue;
 126
 127             if(bdev->bc->lru_id[i] < min_lru){
 128                 min_lru = bdev->bc->lru_id[i];
 129                 free_candidate = i;
 130                 continue;
 131             }
 132         }
 133
 134         if(free_candidate < bdev->bc->cnt){
 135             /*Buffer free was delayed and have no reference. Flush it.*/
 136             r = ext4_blocks_set_direct(bdev,
 137                     bdev->bc->data + bdev->bc->itemsize * free_candidate,
 138                     bdev->bc->lba[free_candidate], 1);
 139             if(r != EOK)
 140                 return r;
 141
 142             /*No delayed anymore*/
 143             bdev->bc->free_delay[free_candidate] = 0;
 144
 145             /*Reduce refered block count*/
 146             bdev->bc->ref_blocks--;
 147         }
 148     }
 149
 150
 151     r = ext4_bcache_alloc(bdev->bc, b, &is_new);
 152     if(r != EOK)
 153         return r;
 154
 155
 156     if(!is_new){
 157         /*Block is in cache. Read from physical device is not required*/
 158         return EOK;
 159     }
 160
 161     if(!b->data)
 162         return ENOMEM;
 163
 164     pba = (lba * bdev->lg_bsize) / bdev->ph_bsize;
 165     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 166
 167     r = bdev->bread(bdev, b->data, pba, pb_cnt);
 168
 169     if(r != EOK){
 170         ext4_bcache_free(bdev->bc, b, 0);
 171         b->lb_id = 0;
 172         return r;
 173     }
 174
 175     bdev->bread_ctr++;
 176     return EOK;
 177 }
 178
 179 int ext4_block_set(struct ext4_blockdev *bdev, struct ext4_block *b)
 180 {
 181     uint64_t pba;
 182     uint32_t pb_cnt;
 183     int r;
 184
 185     ext4_assert(bdev && b);
 186
 187     if(!(bdev->flags & EXT4_BDEV_INITIALIZED))
 188         return EIO;
 189
 190     /*Doesn,t need to write.*/
 191     if(!b->dirty && !bdev->bc->dirty[b->cache_id]){
 192         ext4_bcache_free(bdev->bc, b, 0);
 193         return EOK;
 194     }
 195
 196     /*Free cache delay mode*/
 197     if(bdev->cache_write_back){
 198
 199         /*Free cahe block and mark as free delayed*/
 200         return ext4_bcache_free(bdev->bc, b, bdev->cache_write_back);
 201     }
 202
 203     if(bdev->bc->refctr[b->cache_id] > 1){
 204         bdev->bc->dirty[b->cache_id] = true;
 205         return ext4_bcache_free(bdev->bc, b, 0);
 206     }
 207
 208
 209     pba = (b->lb_id * bdev->lg_bsize) / bdev->ph_bsize;
 210     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 211
 212     r = bdev->bwrite(bdev, b->data, pba, pb_cnt);
 213     bdev->bc->dirty[b->cache_id] = false;
 214     if(r != EOK){
 215         b->dirty = false;
 216         ext4_bcache_free(bdev->bc, b, 0);
 217         return r;
 218     }
 219
 220     bdev->bwrite_ctr++;
 221     b->dirty = false;
 222     ext4_bcache_free(bdev->bc, b, 0);
 223     return EOK;
 224 }
 225
 226 int ext4_blocks_get_direct(struct ext4_blockdev *bdev, void *buf,
 227     uint64_t lba, uint32_t cnt)
 228 {
 229     uint64_t pba;
 230     uint32_t pb_cnt;
 231
 232     ext4_assert(bdev && buf);
 233
 234     pba = (lba * bdev->lg_bsize) / bdev->ph_bsize;
 235     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 236
 237     bdev->bread_ctr++;
 238     return bdev->bread(bdev, buf, pba, pb_cnt * cnt);
 239 }
 240
 241 int ext4_blocks_set_direct(struct ext4_blockdev *bdev, const void *buf,
 242     uint64_t lba, uint32_t cnt)
 243 {
 244     uint64_t pba;
 245     uint32_t pb_cnt;
 246
 247     ext4_assert(bdev && buf);
 248
 249     pba = (lba * bdev->lg_bsize) / bdev->ph_bsize;
 250     pb_cnt = bdev->lg_bsize / bdev->ph_bsize;
 251
 252     bdev->bwrite_ctr++;
 253
 254     return bdev->bwrite(bdev, buf, pba, pb_cnt * cnt);
 255 }
 256
 257
 258 int ext4_block_writebytes(struct ext4_blockdev *bdev, uint64_t off,
 259     const void *buf, uint32_t len)
 260 {
 261     uint64_t block_idx;
 262     uint64_t block_end;
 263     uint32_t blen;
 264     uint32_t unalg;
 265     int r = EOK;
 266
 267     const uint8_t *p = (void *)buf;
 268
 269     ext4_assert(bdev && buf);
 270
 271     if(!(bdev->flags & EXT4_BDEV_INITIALIZED))
 272         return EIO;
 273
 274     block_idx =  off / bdev->ph_bsize;
 275     block_end   =  block_idx + len / bdev->ph_bsize;
 276
 277     if(!(block_end < bdev->ph_bcnt))
 278         return EINVAL;  /*Ups. Out of range operation*/
 279
 280     /*OK lets deal with the first possible unaligned block*/
 281     unalg = (off & (bdev->ph_bsize - 1));
 282     if(unalg){
 283
 284         uint32_t wlen = (bdev->ph_bsize - unalg) > len ?
 285                 len : (bdev->ph_bsize - unalg);
 286
 287         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 288
 289         if(r != EOK)
 290             return r;
 291
 292         memcpy(bdev->ph_bbuf + unalg, p, wlen);
 293
 294         r = bdev->bwrite(bdev, bdev->ph_bbuf, block_idx, 1);
 295         if(r != EOK)
 296             return r;
 297
 298         p   += wlen;
 299         len -= wlen;
 300         block_idx++;
 301     }
 302
 303
 304     /*Aligned data*/
 305     blen = len / bdev->ph_bsize;
 306     r = bdev->bwrite(bdev, p, block_idx, blen);
 307
 308     if(r != EOK)
 309         return r;
 310
 311     p += bdev->ph_bsize * blen;
 312     len -= bdev->ph_bsize * blen;
 313
 314     block_idx += blen;
 315
 316
 317     /*Rest of the data*/
 318     if(len){
 319         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 320         if(r != EOK)
 321             return r;
 322
 323         memcpy(bdev->ph_bbuf, p, len);
 324
 325         r = bdev->bwrite(bdev, bdev->ph_bbuf, block_idx, 1);
 326
 327         if(r != EOK)
 328             return r;
 329     }
 330
 331     return r;
 332 }
 333
 334
 335 int ext4_block_readbytes(struct ext4_blockdev *bdev, uint64_t off, void *buf,
 336     uint32_t len)
 337 {
 338     uint64_t block_idx;
 339     uint64_t block_end;
 340     uint32_t blen;
 341     uint32_t unalg;
 342     int r = EOK;
 343
 344     uint8_t *p = (void *)buf;
 345
 346     ext4_assert(bdev && buf);
 347
 348     if(!(bdev->flags & EXT4_BDEV_INITIALIZED))
 349         return EIO;
 350
 351     block_idx = off / bdev->ph_bsize;
 352     block_end = block_idx + len / bdev->ph_bsize;
 353
 354     if(!(block_end < bdev->ph_bcnt))
 355         return EINVAL;      /*Ups. Out of range operation*/
 356
 357     /*OK lets deal with the first possible unaligned block*/
 358     unalg = (off & (bdev->ph_bsize - 1));
 359     if(unalg){
 360
 361         uint32_t rlen = (bdev->ph_bsize - unalg) > len ?
 362                 len : (bdev->ph_bsize - unalg);
 363
 364         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 365         if(r != EOK)
 366             return r;
 367
 368         memcpy(p, bdev->ph_bbuf + unalg, rlen);
 369
 370         p   += rlen;
 371         len -= rlen;
 372         block_idx++;
 373     }
 374
 375     /*Aligned data*/
 376     blen = len / bdev->ph_bsize;
 377
 378     r = bdev->bread(bdev, p, block_idx, blen);
 379
 380     if(r != EOK)
 381         return r;
 382
 383     p += bdev->ph_bsize * blen;
 384     len -= bdev->ph_bsize * blen;
 385
 386     block_idx += blen;
 387
 388
 389     /*Rest of the data*/
 390     if(len){
 391         r = bdev->bread(bdev, bdev->ph_bbuf, block_idx, 1);
 392         if(r != EOK)
 393             return r;
 394
 395         memcpy(p, bdev->ph_bbuf, len);
 396     }
 397
 398     return r;
 399 }
 400
 401 int ext4_block_cache_write_back(struct ext4_blockdev *bdev,
 402     uint8_t on_off)
 403 {
 404     int r;
 405     uint32_t i;
 406
 407     if(on_off)
 408         bdev->cache_write_back++;
 409
 410     if(!on_off && bdev->cache_write_back)
 411         bdev->cache_write_back--;
 412
 413     /*Flush all delayed cache blocks*/
 414     if(!bdev->cache_write_back){
 415         for (i = 0; i < bdev->bc->cnt; ++i) {
 416
 417             /*Check if buffer free was delayed.*/
 418             if(!bdev->bc->free_delay[i])
 419                 continue;
 420
 421             /*Check reference counter.*/
 422             if(bdev->bc->refctr[i])
 423                 continue;
 424
 425             /*Buffer free was delayed and have no reference. Flush it.*/
 426             r = ext4_blocks_set_direct(bdev,
 427                     bdev->bc->data + bdev->bc->itemsize * i,
 428                     bdev->bc->lba[i], 1);
 429             if(r != EOK)
 430                 return r;
 431
 432             /*No delayed anymore*/
 433             bdev->bc->free_delay[i] = 0;
 434
 435             /*Reduce refered block count*/
 436             bdev->bc->ref_blocks--;
 437         }
 438     }
 439     return EOK;
 440 }
 441
 442 /**
 443  * @}
 444  */
 445