hash: fix typo in jhash comments
[dpdk.git] / lib / librte_hash / rte_jhash.h
index 1cb5c44..e230449 100644 (file)
@@ -46,6 +46,8 @@ extern "C" {
 
 #include <stdint.h>
 #include <string.h>
+
+#include <rte_log.h>
 #include <rte_byteorder.h>
 
 /* jhash.h: Jenkins hash support.
@@ -102,29 +104,20 @@ extern "C" {
 #define LOWER16b_MASK rte_le_to_cpu_32(0xffff)
 #define LOWER24b_MASK rte_le_to_cpu_32(0xffffff)
 
-/**
- * The most generic version, hashes an arbitrary sequence
- * of bytes.  No alignment or length assumptions are made about
- * the input key.
- *
- * @param key
- *   Key to calculate hash of.
- * @param length
- *   Length of key in bytes.
- * @param initval
- *   Initialising value of hash.
- * @return
- *   Calculated hash value.
- */
-static inline uint32_t
-rte_jhash(const void *key, uint32_t length, uint32_t initval)
+static inline void
+__rte_jhash_2hashes(const void *key, uint32_t length, uint32_t *pc,
+               uint32_t *pb, unsigned check_align)
 {
        uint32_t a, b, c;
 
        /* Set up the internal state */
-       a = b = c = RTE_JHASH_GOLDEN_RATIO + ((uint32_t)length) + initval;
+       a = b = c = RTE_JHASH_GOLDEN_RATIO + ((uint32_t)length) + *pc;
+       c += *pb;
 
-       /* Check key alignment. For x86 architecture, first case is always optimal */
+       /*
+        * Check key alignment. For x86 architecture, first case is always optimal
+        * If check_align is not set, first case will be used
+        */
 #if defined(RTE_ARCH_X86_64) || defined(RTE_ARCH_I686) || defined(RTE_ARCH_X86_X32)
        const uint32_t *k = key;
        const uint32_t s = 0;
@@ -132,8 +125,7 @@ rte_jhash(const void *key, uint32_t length, uint32_t initval)
        const uint32_t *k = (uint32_t *)(uintptr_t)key & (uintptr_t)~3);
        const uint32_t s = ((uintptr_t)key & 3) * CHAR_BIT;
 #endif
-
-       if (s == 0) {
+       if (!check_align || s == 0) {
                while (length > 12) {
                        a += k[0];
                        b += k[1];
@@ -172,7 +164,9 @@ rte_jhash(const void *key, uint32_t length, uint32_t initval)
                        a += k[0] & LOWER8b_MASK; break;
                /* zero length strings require no mixing */
                case 0:
-                       return c;
+                       *pc = c;
+                       *pb = b;
+                       return;
                };
        } else {
                /* all but the last block: affect some 32 bits of (a, b, c) */
@@ -238,13 +232,82 @@ rte_jhash(const void *key, uint32_t length, uint32_t initval)
                        break;
                /* zero length strings require no mixing */
                case 0:
-                       return c;
+                       *pc = c;
+                       *pb = b;
+                       return;
                }
        }
 
        __rte_jhash_final(a, b, c);
 
-       return c;
+       *pc = c;
+       *pb = b;
+}
+
+/**
+ * Same as rte_jhash, but takes two seeds and return two uint32_ts.
+ * pc and pb must be non-null, and *pc and *pb must both be initialized
+ * with seeds. If you pass in (*pb)=0, the output (*pc) will be
+ * the same as the return value from rte_jhash.
+ *
+ * @param key
+ *   Key to calculate hash of.
+ * @param length
+ *   Length of key in bytes.
+ * @param pc
+ *   IN: seed OUT: primary hash value.
+ * @param pb
+ *   IN: second seed OUT: secondary hash value.
+ */
+static inline void
+rte_jhash_2hashes(const void *key, uint32_t length, uint32_t *pc, uint32_t *pb)
+{
+       __rte_jhash_2hashes(key, length, pc, pb, 1);
+}
+
+/**
+ * Same as rte_jhash2, but takes two seeds and return two uint32_ts.
+ * pc and pb must be non-null, and *pc and *pb must both be initialized
+ * with seeds. If you pass in (*pb)=0, the output (*pc) will be
+ * the same as the return value from rte_jhash2.
+ *
+ * @param k
+ *   Key to calculate hash of.
+ * @param length
+ *   Length of key in units of 4 bytes.
+ * @param pc
+ *   IN: seed OUT: primary hash value.
+ * @param pb
+ *   IN: second seed OUT: secondary hash value.
+ */
+static inline void
+rte_jhash_32b_2hashes(const uint32_t *k, uint32_t length, uint32_t *pc, uint32_t *pb)
+{
+       __rte_jhash_2hashes((const void *) k, (length << 2), pc, pb, 0);
+}
+
+/**
+ * The most generic version, hashes an arbitrary sequence
+ * of bytes.  No alignment or length assumptions are made about
+ * the input key.
+ *
+ * @param key
+ *   Key to calculate hash of.
+ * @param length
+ *   Length of key in bytes.
+ * @param initval
+ *   Initialising value of hash.
+ * @return
+ *   Calculated hash value.
+ */
+static inline uint32_t
+rte_jhash(const void *key, uint32_t length, uint32_t initval)
+{
+       uint32_t initval2 = 0;
+
+       rte_jhash_2hashes(key, length, &initval, &initval2);
+
+       return initval;
 }
 
 /**
@@ -261,43 +324,24 @@ rte_jhash(const void *key, uint32_t length, uint32_t initval)
  *   Calculated hash value.
  */
 static inline uint32_t
-rte_jhash2(const uint32_t *k, uint32_t length, uint32_t initval)
+rte_jhash_32b(const uint32_t *k, uint32_t length, uint32_t initval)
 {
-       uint32_t a, b, c;
+       uint32_t initval2 = 0;
 
-       /* Set up the internal state */
-       a = b = c = RTE_JHASH_GOLDEN_RATIO + (((uint32_t)length) << 2) + initval;
-
-       /* Handle most of the key */
-       while (length > 3) {
-               a += k[0];
-               b += k[1];
-               c += k[2];
+       rte_jhash_32b_2hashes(k, length, &initval, &initval2);
 
-               __rte_jhash_mix(a, b, c);
+       return initval;
+}
 
-               k += 3;
-               length -= 3;
-       }
+static inline uint32_t
+__attribute__ ((deprecated))
+rte_jhash2(const uint32_t *k, uint32_t length, uint32_t initval)
+{
+       uint32_t initval2 = 0;
 
-       /* Handle the last 3 uint32_t's */
-       switch (length) {
-       case 3:
-               c += k[2];
-               /* Fallthrough */
-       case 2:
-               b += k[1];
-               /* Fallthrough */
-       case 1:
-               a += k[0];
-               __rte_jhash_final(a, b, c);
-               /* Fallthrough */
-       /* case 0: nothing left to add */
-       case 0:
-               break;
-       };
+       rte_jhash_32b_2hashes(k, length, &initval, &initval2);
 
-       return c;
+       return initval;
 }
 
 static inline uint32_t
@@ -317,11 +361,11 @@ __rte_jhash_3words(uint32_t a, uint32_t b, uint32_t c, uint32_t initval)
  * 3 words.
  *
  * @param a
- *   First word to calcuate hash of.
+ *   First word to calculate hash of.
  * @param b
- *   Second word to calcuate hash of.
+ *   Second word to calculate hash of.
  * @param c
- *   Third word to calcuate hash of.
+ *   Third word to calculate hash of.
  * @param initval
  *   Initialising value of hash.
  * @return
@@ -338,9 +382,9 @@ rte_jhash_3words(uint32_t a, uint32_t b, uint32_t c, uint32_t initval)
  * 2 words.
  *
  * @param a
- *   First word to calcuate hash of.
+ *   First word to calculate hash of.
  * @param b
- *   Second word to calcuate hash of.
+ *   Second word to calculate hash of.
  * @param initval
  *   Initialising value of hash.
  * @return
@@ -357,7 +401,7 @@ rte_jhash_2words(uint32_t a, uint32_t b, uint32_t initval)
  * 1 word.
  *
  * @param a
- *   Word to calcuate hash of.
+ *   Word to calculate hash of.
  * @param initval
  *   Initialising value of hash.
  * @return