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