This file is indexed.

/usr/include/ns3.26/ns3/hash.h is in libns3-dev 3.26+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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/* -*- 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 HASH_H
#define HASH_H

#include <string>

#include "assert.h"
#include "ptr.h"

#include "hash-function.h"
#include "hash-murmur3.h"
#include "hash-fnv.h"

/**
 * \file
 * \ingroup hash
 * \brief ns3::Hasher, ns3::Hash32() and ns3::Hash64() function declarations.
 */

namespace ns3 {

/**
 * \ingroup core
 * \defgroup hash Hash Functions
 *
 *  \brief Generic Hash function interface.
 *
 * See \ref Hasher for main entry point.
 * See \ref hash-example.cc for example usage.
 */
/**
 *  \ingroup hash
 *
 *  \brief Generic Hash function interface.
 *
 *  This class provides a generic interface for computing hashes
 *  of buffers.  Various getters return hashes of different lengths.
 *
 *  Call clear() between calls to the getter to reset the
 *  internal state and hash each buffer separately.
 *
 *  If you don't call clear() between calls to the getter
 *  you can hash successive buffers.  The final return value
 *  will be the cumulative hash across all calls.
 *
 *  The choice of hash function can be made at construction by
 *    \code
 *    Hasher hasher = Hasher ( Create<Hash::Function::Fnv1a> () );
 *    uint32_t hash = Hasher.GetHash32 (data);
 *    \endcode
 *
 *  The available implementations are documented in \ref hash.
 *  The default implementation is Murmur3.  FNV1a is also available.
 *
 *  In addition to this class interface, global functions are
 *  defined which use the default hash implementation.
 *
 * \internal
 *
 *  Would be nice to offer longer hashes.  \c uint128_t looks doable,
 *  except that our fallback \c int64x64_t implementation doesn't
 *  offer \c unsigned.
 *
 *  Longer hashes require returning a byte buffer of some sort,
 *  but our \ref Buffer class seems a bit overkill for this case.
 *
 */
class Hasher
{
public:
  /**
   * Constructor using the default implementation.
   */
  Hasher ();
  /**
   * Constructor using the supplied implementation.
   *
   * \param [in] hp Ptr<Hash::Implementation> to the desired implementation.
   */
  Hasher (Ptr<Hash::Implementation> hp);
  /**
   * 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..
   */
  uint32_t  GetHash32  (const char * buffer, const size_t size);
  /**
   * Compute 64-bit hash of a byte buffer.
   *
   * 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.
   */
  uint64_t  GetHash64  (const char * buffer, const size_t size);

  /**
   * Compute 32-bit hash of a string.
   *
   * Call clear () between calls to GetHash32() to reset the
   * internal state and hash each string separately.
   *
   * If you don't call clear() between calls to GetHash32,
   * you can hash successive strings.  The final return value
   * will be the cumulative hash across all calls.
   *
   * \param [in] s String to hash.
   * \return 32-bit hash of the string.
   */
  uint32_t  GetHash32  (const std::string s);
  /**
   * Compute 64-bit hash of a string.
   *
   * Call clear () between calls to GetHash64() to reset the
   * internal state and hash each string separately.
   *
   * If you don't call clear() between calls to GetHash64,
   * you can hash successive strings.  The final return value
   * will be the cumulative hash across all calls.
   *
   * \param [in] s String to hash.
   * \return 64-bit hash of the string.
   */
  uint64_t  GetHash64  (const std::string s);
  /**
   * Restore initial state.
   *
   * Returning this Hasher allows code like this:
   *
   * \code
   *   Hasher h;
   *   h.GetHash32 (...);
   *   ...
   *   h.clear ().GetHash64 (...);
   * \endcode
   *
   * \return This hasher.
   */
  Hasher & clear (void);

private:
  Ptr<Hash::Implementation> m_impl;  /**< Hash implementation. */
};  // Hasher


/*************************************************
 **  Global functions declarations
 ************************************************/

/**
 * \ingroup hash
 *
 * Compute 32-bit hash of a byte buffer, using the default hash function.
 *
 * \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.
 */
uint32_t Hash32 (const char * buffer, const size_t size);
/**
 * \ingroup hash
 *
 * Compute 64-bit hash of a byte buffer, using the default hash function.
 *
 * \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.
 */
uint64_t Hash64 (const char * buffer, const size_t size);

/**
 * \ingroup hash
 *
 * Compute 32-bit hash of a string, using the default hash function.
 *
 * \param [in] s String to hash.
 * \return 32-bit hash of the string.
 */
uint32_t Hash32 (const std::string s);
/**
 * \ingroup hash
 *
 * Compute 64-bit hash of a string, using the default hash function.
 *
 * \param [in] s String to hash.
 * \return 64-bit hash of the string.
 */
uint64_t Hash64 (const std::string s);

}  // namespace ns3


/*************************************************
 **  Inline implementations for rvo
 ************************************************/

namespace ns3 {

/*************************************************
 class Hasher implementation, inlined for rvo
*/

inline
uint32_t
Hasher::GetHash32  (const char * buffer, const size_t size)
{
  NS_ASSERT (m_impl != 0);
  return m_impl->GetHash32  (buffer, size);
}

inline
uint64_t
Hasher::GetHash64  (const char * buffer, const size_t size)
{
  NS_ASSERT (m_impl != 0);
  return m_impl->GetHash64  (buffer, size);
}

inline
uint32_t
Hasher::GetHash32  (const std::string s)
{
  NS_ASSERT (m_impl != 0);
  return m_impl->GetHash32  (s.c_str (), s.size ());
}

inline
uint64_t
Hasher::GetHash64  (const std::string s)
{
  NS_ASSERT (m_impl != 0);
  return m_impl->GetHash64  (s.c_str (), s.size ());
}


/*************************************************
  Global hash functions, inlined for rvo
*/

inline
uint32_t
Hash32 (const char * buffer, const size_t size)
{
  return Hasher ().GetHash32 (buffer, size);
}

inline
uint64_t
Hash64 (const char * buffer, const size_t size)
{
  return Hasher ().GetHash64 (buffer, size);
}

inline
uint32_t
Hash32 (const std::string s)
{
  return Hasher ().GetHash32 (s);
}

inline
uint64_t
Hash64 (const std::string s)
{
  return Hasher ().GetHash64 (s);
}


}  // namespace ns3

#endif /* HASH_H */