/usr/include/ns3.27/ns3/hash-function.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2012 Lawrence Livermore National Laboratory
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Peter D. Barnes, Jr. <pdbarnes@llnl.gov>
*/
#ifndef HASHFUNCTION_H
#define HASHFUNCTION_H
#include <cstring> // memcpy
#include "simple-ref-count.h"
/**
* \file
* \ingroup hash
* \brief ns3::Hash::Implementation, ns3::Hash::Function::Hash32 and
* ns3::Hash::Function::Hash64 declarations.
*/
namespace ns3 {
/**
* \ingroup hash
* Hash function implementations
*/
namespace Hash {
/**
* \ingroup hash
*
* \brief Hash function implementation base class.
*/
class Implementation : public SimpleRefCount<Implementation>
{
public:
/**
* Compute 32-bit hash of a byte buffer
*
* Call clear() between calls to GetHash32() to reset the
* internal state and hash each buffer separately.
*
* If you don't call clear() between calls to GetHash32,
* you can hash successive buffers. The final return value
* will be the cumulative hash across all calls.
*
* \param [in] buffer Pointer to the beginning of the buffer.
* \param [in] size Length of the buffer, in bytes.
* \return 32-bit hash of the buffer.
*/
virtual uint32_t GetHash32 (const char * buffer, const size_t size) = 0;
/**
* Compute 64-bit hash of a byte buffer.
*
* Default implementation returns 32-bit hash, with a warning.
*
* Call clear() between calls to GetHash64() to reset the
* internal state and hash each buffer separately.
*
* If you don't call clear() between calls to GetHash64,
* you can hash successive buffers. The final return value
* will be the cumulative hash across all calls.
*
* \param [in] buffer Pointer to the beginning of the buffer.
* \param [in] size Length of the buffer, in bytes.
* \return 64-bit hash of the buffer.
*/
virtual uint64_t GetHash64 (const char * buffer, const size_t size);
/**
* Restore initial state.
*/
virtual void clear (void) = 0;
/**
* Constructor.
*/
Implementation () { };
/**
* Destructor.
*/
virtual ~Implementation () { };
}; // Hashfunction
/*--------------------------------------
* Hash function implementation
* by function pointers and templates
*/
/**
*
* \ingroup hash
*
* \brief Function pointer signatures for basic hash functions.
*
* See Hash::Function::Hash32 or Hash::Function::Hash64
* @{
*/
typedef uint32_t (*Hash32Function_ptr) (const char *, const size_t);
typedef uint64_t (*Hash64Function_ptr) (const char *, const size_t);
/**@}*/
/**
* \ingroup hash
* Hash functions.
*/
namespace Function {
/**
* \ingroup hash
*
* \brief Template for creating a Hash::Implementation from
* a 32-bit hash function.
*/
class Hash32 : public Implementation
{
public:
/**
* Constructor from a 32-bit hash function pointer.
*
* \param [in] hp Function pointer to a 32-bit hash function.
*/
Hash32 (Hash32Function_ptr hp) : m_fp (hp) { };
uint32_t GetHash32 (const char * buffer, const size_t size)
{
return (*m_fp) (buffer, size);
}
void clear () { };
private:
Hash32Function_ptr m_fp; /**< The hash function. */
}; // Hash32
/**
* \ingroup hash
*
* \brief Template for creating a Hash::Implemetation from
* a 64-bit hash function.
*/
class Hash64 : public Implementation
{
public:
/**
* Constructor from a 64-bit hash function pointer.
*
* \param [in] hp Function pointer to a 64-bit hash function.
*/
Hash64 (Hash64Function_ptr hp) : m_fp (hp) { };
uint64_t GetHash64 (const char * buffer, const size_t size)
{
return (*m_fp) (buffer, size);
}
uint32_t GetHash32 (const char * buffer, const size_t size)
{
uint32_t hash32;
uint64_t hash64 = GetHash64 (buffer, size);
memcpy (&hash32, &hash64, sizeof (hash32));
return hash32;
}
void clear () { };
private:
Hash64Function_ptr m_fp; /**< The hash function. */
}; // Hash64<Hash64Function_ptr>
} // namespace Function
} // namespace Hash
} // namespace ns3
#endif /* HASHFUNCTION_H */
|