Main recio: Allow rec_io_(start|stop)_read from the read_handler

[libucw.git] / ucw / hashfunc.h

diff --git a/ucw/hashfunc.h b/ucw/hashfunc.h
index b67321c14cf54093fb3191a38afcb46f20f416bb..355acd48cf10c8b857b6e3fafe3666023a0532f1 100644 (file)
--- a/ucw/hashfunc.h
+++ b/ucw/hashfunc.h
@@ -13,32 +13,32 @@
 
 #include "ucw/lib.h"
 
-/*** == String hashes [[strhash]] ***/
+/*** === String hashes [[strhash]] ***/
 
-/* The following functions need str to be aligned to uns.  */
-uns str_len_aligned(const char *str) PURE; /** Get the string length (actually hash function too). The string must be aligned to uns. For unaligned see str_len(). **/
-uns hash_string_aligned(const char *str) PURE; /** Hash the string. The string must be aligned to uns. For unaligned see hash_string(). **/
-uns hash_block_aligned(const byte *str, uns len) PURE; /** Hash arbitrary data. They must be aligned to uns. For unaligned see hash_block(). **/
+/* The following functions need str to be aligned to sizeof(uns).  */
+uns str_len_aligned(const char *str) PURE; /** Get the string length (not a really useful hash function, but there is no better place for it). The string must be aligned to sizeof(uns). For unaligned see @str_len(). **/
+uns hash_string_aligned(const char *str) PURE; /** Hash the string. The string must be aligned to sizeof(uns). For unaligned see @hash_string(). **/
+uns hash_block_aligned(const byte *buf, uns len) PURE; /** Hash arbitrary data. They must be aligned to sizeof(uns). For unaligned see @hash_block(). **/
 
 #ifdef CPU_ALLOW_UNALIGNED
 #define        str_len(str)            str_len_aligned(str)
 #define        hash_string(str)        hash_string_aligned(str)
 #define        hash_block(str, len)    hash_block_aligned(str, len)
 #else
-uns str_len(const char *str) PURE; /** Get the string length (actually a hash function too). If you know it is aligned to uns, you can use faster str_len_aligned(). **/
-uns hash_string(const char *str) PURE; /** Hash the string. If it is aligned to uns, you can use faster hash_string_aligned(). **/
-uns hash_block(const byte *str, uns len) PURE; /** Hash arbitrary data. If they are aligned to uns, use faster hash_block_aligned(). **/
+uns str_len(const char *str) PURE; /** Get the string length. If you know it is aligned to sizeof(uns), you can use faster @str_len_aligned(). **/
+uns hash_string(const char *str) PURE; /** Hash the string. If it is aligned to sizeof(uns), you can use faster @hash_string_aligned(). **/
+uns hash_block(const byte *buf, uns len) PURE; /** Hash arbitrary data. If they are aligned to sizeof(uns), use faster @hash_block_aligned(). **/
 #endif
 
-uns hash_string_nocase(const char *str) PURE; /** Hash the string in a case insensitive way. **/
+uns hash_string_nocase(const char *str) PURE; /** Hash the string in a case insensitive way. Works only with ASCII characters. **/
 
-/*** == Integer hashes [[inthash]] ***/
+/*** === Integer hashes [[inthash]] ***/
 
-/*
- *  We hash integers by multiplying by a reasonably large prime with
- *  few ones in its binary form (to gave the compiler the possibility
- *  of using shifts and adds on architectures where multiplication
- *  instructions are slow).
+/***
+ * We hash integers by multiplying by a reasonably large prime with
+ * few ones in its binary form (to give the compiler the possibility
+ * of using shifts and adds on architectures where multiplication
+ * instructions are slow).
  */
 static inline uns CONST hash_u32(uns x) { return 0x01008041*x; } /** Hash a 32 bit unsigned integer. **/
 static inline uns CONST hash_u64(u64 x) { return hash_u32((uns)x ^ (uns)(x >> 32)); } /** Hash a 64 bit unsigned integer. **/