algos/rotating_hash.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  * All Rights Reserved.
  31  * -->
  32  *
  33  * \brief Rotating Hash algorithm (interface).
  34  *
  35  * This is a simple yet powerfull checksum algorithm.
  36  * Instead of just xor-ing the data, rotating hash
  37  * circular shift the checksum 4 place left before xoring.
  38  * This is a bit more stronger than simply sum the data.
  39  *
  40  * \version $Id$
  41  *
  42  * \author Francesco Sacchi <batt@develer.com>
  43  */
  44
  45 /*#*
  46  *#* $Log$
  47  *#* Revision 1.2  2007/10/01 10:46:33  batt
  48  *#* Add rotating hash init function.
  49  *#*
  50  *#* Revision 1.1  2007/06/07 09:11:17  batt
  51  *#* Add rotating hash algorithm.
  52  *#*
  53  *#* Revision 1.1  2007/01/12 20:30:49  batt
  54  *#* Add right Rotating hash file.
  55  *#*
  56  *#*/
  57
  58 #ifndef ALGOS_ROTATING_H
  59 #define ALGOS_ROTATING_H
  60
  61 #include <cfg/compiler.h>
  62
  63 typedef uint16_t rotating_t;
  64
  65
  66 /**
  67  * Init rotating checksum.
  68  */
  69 INLINE void rotating_init(rotating_t *rot)
  70 {
  71         *rot = 0;
  72 }
  73
  74 /**
  75  * Update checksum pointed by \c rot with \c c data.
  76  */
  77 INLINE void rotating_update1(uint8_t c, rotating_t *rot)
  78 {
  79         *rot = (*rot << 4) ^ (*rot >> 12) ^ c;
  80 }
  81
  82 /**
  83  * Update checksum pointed by \c rot with data supplied in \c buf.
  84  */
  85 INLINE void rotating_update(const void *_buf, size_t len, rotating_t *rot)
  86 {
  87         const uint8_t *buf = (const uint8_t *)_buf;
  88
  89         while (len--)
  90                 rotating_update1(*buf++, rot);
  91 }
  92
  93
  94 #endif // ALGOS_ROTATING_H