lwext4/ext4_dir_idx.h

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  *
   4  *
   5  * HelenOS:
   6  * Copyright (c) 2012 Martin Sucha
   7  * Copyright (c) 2012 Frantisek Princ
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  * - Redistributions of source code must retain the above copyright
  15  *   notice, this list of conditions and the following disclaimer.
  16  * - Redistributions in binary form must reproduce the above copyright
  17  *   notice, this list of conditions and the following disclaimer in the
  18  *   documentation and/or other materials provided with the distribution.
  19  * - The name of the author may not be used to endorse or promote products
  20  *   derived from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /** @addtogroup lwext4
  35  * @{
  36  */
  37 /**
  38  * @file  ext4_dir_idx.h
  39  * @brief Directory indexing procedures.
  40  */
  41
  42 #ifndef EXT4_DIR_IDX_H_
  43 #define EXT4_DIR_IDX_H_
  44
  45 #include "ext4_config.h"
  46 #include "ext4_types.h"
  47
  48 #include <stdint.h>
  49 #include <stdbool.h>
  50
  51 /**@brief Initialize index structure of new directory.
  52  * @param dir Pointer to directory i-node
  53  * @param dir Pointer to parent directory i-node
  54  * @return Error code
  55  */
  56 int ext4_dir_dx_init(struct ext4_inode_ref *dir,
  57                      struct ext4_inode_ref *parent);
  58
  59 /**@brief Try to find directory entry using directory index.
  60  * @param result    Output value - if entry will be found,
  61  *                  than will be passed through this parameter
  62  * @param inode_ref Directory i-node
  63  * @param name_len  Length of name to be found
  64  * @param name      Name to be found
  65  * @return Error code
  66  */
  67 int ext4_dir_dx_find_entry(struct ext4_dir_search_result *result,
  68                            struct ext4_inode_ref *inode_ref, size_t name_len,
  69                            const char *name);
  70
  71 /**@brief Add new entry to indexed directory
  72  * @param parent Directory i-node
  73  * @param child  I-node to be referenced from directory entry
  74  * @param name   Name of new directory entry
  75  * @return Error code
  76  */
  77 int ext4_dir_dx_add_entry(struct ext4_inode_ref *parent,
  78                           struct ext4_inode_ref *child, const char *name);
  79
  80 /**@brief Add new entry to indexed directory
  81  * @param dir           Directory i-node
  82  * @param parent_inode  parent inode index
  83  * @return Error code
  84  */
  85 int ext4_dir_dx_reset_parent_inode(struct ext4_inode_ref *dir,
  86                                    uint32_t parent_inode);
  87
  88 #endif /* EXT4_DIR_IDX_H_ */
  89
  90 /**
  91  * @}
  92  */