include/ext4_hash.h

   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_hash.h
  34  * @brief Directory indexing hash functions.
  35  */
  36
  37 #ifndef EXT4_HASH_H_
  38 #define EXT4_HASH_H_
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #include "ext4_config.h"
  45
  46 #include <stdint.h>
  47
  48 struct ext4_hash_info {
  49         uint32_t hash;
  50         uint32_t minor_hash;
  51         uint32_t hash_version;
  52         const uint32_t *seed;
  53 };
  54
  55
  56 /**@brief   Directory entry name hash function.
  57  * @param   name entry name
  58  * @param   len entry name length
  59  * @param   hash_seed (from superblock)
  60  * @param   hash version (from superblock)
  61  * @param   hash_minor output value
  62  * @param   hash_major output value
  63  * @return  standard error code*/
  64 int ext2_htree_hash(const char *name, int len, const uint32_t *hash_seed,
  65                     int hash_version, uint32_t *hash_major,
  66                     uint32_t *hash_minor);
  67
  68 #ifdef __cplusplus
  69 }
  70 #endif
  71
  72 #endif /* EXT4_HASH_H_ */
  73
  74 /**
  75  * @}
  76  */