include/ext4_trans.h

   1 /*
   2  * Copyright (c) 2015 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  * Copyright (c) 2015 Kaho Ng (ngkaho1234@gmail.com)
   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_trans.h
  34  * @brief Transaction handle functions
  35  */
  36
  37 #ifndef EXT4_TRANS_H
  38 #define EXT4_TRANS_H
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #include "ext4_config.h"
  45 #include "ext4_types.h"
  46
  47
  48 /**@brief   Mark a buffer dirty and add it to the current transaction.
  49  * @param   buf buffer
  50  * @return  standard error code*/
  51 int ext4_trans_set_block_dirty(struct ext4_buf *buf);
  52
  53 /**@brief   Block get function (through cache, don't read).
  54  *          jbd_trans_get_access would be called in order to
  55  *          get write access to the buffer.
  56  * @param   bdev block device descriptor
  57  * @param   b block descriptor
  58  * @param   lba logical block address
  59  * @return  standard error code*/
  60 int ext4_trans_block_get_noread(struct ext4_blockdev *bdev,
  61                           struct ext4_block *b,
  62                           uint64_t lba);
  63
  64 /**@brief   Block get function (through cache).
  65  *          jbd_trans_get_access would be called in order to
  66  *          get write access to the buffer.
  67  * @param   bdev block device descriptor
  68  * @param   b block descriptor
  69  * @param   lba logical block address
  70  * @return  standard error code*/
  71 int ext4_trans_block_get(struct ext4_blockdev *bdev,
  72                    struct ext4_block *b,
  73                    uint64_t lba);
  74
  75 /**@brief  Try to add block to be revoked to the current transaction.
  76  * @param  bdev block device descriptor
  77  * @param  lba logical block address
  78  * @return standard error code*/
  79 int ext4_trans_try_revoke_block(struct ext4_blockdev *bdev,
  80                                uint64_t lba);
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif /* EXT4_TRANS_H */
  87
  88 /**
  89  * @}
  90  */