Doc fixes.
[bertos.git] / mware / hashtable.c
old mode 100755 (executable)
new mode 100644 (file)
index bfc8bc0..d379733
@@ -1,6 +1,31 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2004 Giovanni Bajo
  * All Rights Reserved.
 
 /*#*
  *#* $Log$
- *#* Revision 1.5  2005/04/11 19:10:28  bernie
- *#* Include top-level headers from cfg/ subdir.
- *#*
- *#* Revision 1.4  2004/12/08 09:42:30  bernie
- *#* Suppress warning.
- *#*
- *#* Revision 1.3  2004/10/03 20:43:22  bernie
- *#* Import changes from sc/firmware.
- *#*
- *#* Revision 1.12  2004/06/14 15:15:24  rasky
- *#* Cambiato key_data in un union invece di castare
- *#* Aggiunto un ASSERT sull'indice calcolata nella key_internal_get_ptr
- *#*
- *#* Revision 1.11  2004/06/14 15:09:04  rasky
- *#* Cambiati i messaggi di assert (è inutile citare il nome della funzione)
- *#*
- *#* Revision 1.10  2004/06/14 15:07:38  rasky
- *#* Convertito il loop di calc_hash a interi (per farlo ottimizzare maggiormente)
- *#*
- *#* Revision 1.9  2004/06/14 14:59:40  rasky
- *#* Rinominanta la macro di configurazione per rispettare il namespace, e aggiunta in un punto in cui mancava
- *#*
- *#* Revision 1.8  2004/06/12 15:18:05  rasky
- *#* Nuova hashtable con chiave esterna o interna a scelta, come discusso
- *#*
- *#* Revision 1.7  2004/06/04 17:16:31  rasky
- *#* Fixato un bug nel caso in cui la chiave ecceda la dimensione massima: il clamp non può essere fatto dentro la perform_lookup perché anche la ht_insert deve avere il valore clampato a disposizione per fare la memcpy
+ *#* Revision 1.8  2007/02/06 16:05:01  asterix
+ *#* Replaced ROTATE_* with ROT* defined in macros.h
  *#*
- *#* Revision 1.6  2004/05/26 16:36:50  rasky
- *#* Aggiunto il rationale per l'interfaccia degli iteratori
+ *#* Revision 1.7  2006/07/19 12:56:27  bernie
+ *#* Convert to new Doxygen style.
  *#*
- *#* Revision 1.5  2004/05/24 15:28:20  rasky
- *#* Sistemata la documentazione, rimossa keycmp in favore della memcmp
+ *#* Revision 1.6  2006/06/01 12:27:39  marco
+ *#* Added utilities for protocols
  *#*
  *#*/
 
 #include "hashtable.h"
 #include <cfg/debug.h>
 #include <cfg/compiler.h>
+#include <cfg/macros.h> //ROTL(), ROTR();
 
 #include <string.h>
 
 
-#define ROTATE_LEFT_16(num, count)     (((num) << (count)) | ((num) >> (16-(count))))
-#define ROTATE_RIGHT_16(num, count)    ROTATE_LEFT_16(num, 16-(count))
 
 typedef const void** HashNodePtr;
 #define NODE_EMPTY(node)               (!*(node))
 #define HT_HAS_INTERNAL_KEY(ht)        (CONFIG_HT_OPTIONAL_INTERNAL_KEY && ht->flags.key_internal)
 
-/*! For hash tables with internal keys, compute the pointer to the internal key for a given \a node. */
-INLINE uint8_t* key_internal_get_ptr(struct HashTable* ht, HashNodePtr node)
+/** For hash tables with internal keys, compute the pointer to the internal key for a given \a node. */
+INLINE uint8_t *key_internal_get_ptr(struct HashTable *ht, HashNodePtr node)
 {
        uint8_t* key_buf = ht->key_data.mem;
        size_t index;
 
        // Compute the index of the node and use it to move within the whole key buffer
        index = node - &ht->mem[0];
-       ASSERT(index < (1 << ht->max_elts_log2));
+       ASSERT(index < (size_t)(1 << ht->max_elts_log2));
        key_buf += index * (INTERNAL_KEY_MAX_LENGTH + 1);
 
        return key_buf;
@@ -160,7 +159,7 @@ static uint16_t calc_hash(const void* _key, uint8_t key_length)
        int len = (int)key_length;
 
        for (i = 0; i < len; ++i)
-               hash = ROTATE_LEFT_16(hash, 4) ^ key[i];
+               hash = ROTL(hash, 4) ^ key[i];
 
        return hash ^ (hash >> 6) ^ (hash >> 13);
 }
@@ -192,7 +191,7 @@ static HashNodePtr perform_lookup(struct HashTable* ht,
        //  is traversed. Actually MCD(table_size, step) must be 1, but
        //  table_size is always a power of 2, so we just ensure that step is
        //  never a multiple of 2.
-       step = (ROTATE_RIGHT_16(hash, ht->max_elts_log2) & mask) | 1;
+       step = (ROTR(hash, ht->max_elts_log2) & mask) | 1;
 
        do
        {