lwext4/ext4_dir_idx.h

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