<?xml version="1.0" encoding="utf-8"?>
<?xml-model href="rfc7991bis.rnc"?>  <!-- Required for schema
      validation and schema-aware editing --> 

<!DOCTYPE rfc [
  <!ENTITY filename "draft-eastlake-fnv-26">
  <!ENTITY nbsp     "&#160;">
  <!ENTITY zwsp     "&#8203;">
  <!ENTITY nbhy     "&#8209;">
  <!ENTITY wj       "&#8288;">
]>
<!-- <?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?> --> 
<!-- This third-party XSLT can be enabled for direct transformations
in XML processors, including most browsers --> 
<!-- If further character entities are required then they should be
added to the DOCTYPE above. Use of an external entity file is not
recommended. --> 
<?rfc strict="yes" ?>
<!-- give errors regarding ID-nits and DTD validation -->
<!-- control the table of contents (ToC) -->
<?rfc toc="yes"?>

<rfc
  xmlns:xi="http://www.w3.org/2001/XInclude"
  category="info"
  docName="&filename;"
  ipr="trust200902"
  obsoletes=""
  submissionType="IETF"
  xml:lang="en"
  version="3">
<!-- 
    * docName should be the name of your draft * category should be
    one of std, bcp, info, exp, historic * ipr should be one of
    trust200902, noModificationTrust200902, noDerivativesTrust200902,
    pre5378Trust200902 * updates can be an RFC number as NNNN *
    obsoletes can be an RFC number as NNNN
-->


<!-- ____________________FRONT_MATTER____________________ -->
<front>
   <title abbrev="FNV">The FNV Non-Cryptographic Hash
   Algorithm</title>
   <!--  The abbreviated title is required if the full title is
        longer than 39 characters --> 

   <seriesInfo name="Internet-Draft"
               value="&filename;"/>

   <author fullname="Glenn S. Fowler" initials="G."
           surname="Fowler">
     <organization>Google</organization>
     <address>
       <email>glenn.s.fowler@gmail.com</email>
     </address>
   </author>

   <author fullname="Landon Curt Noll" initials="L."
           surname="Noll">
     <organization>Cisco Systems</organization>
     <address>
       <postal>
         <street>170 West Tasman Drive</street>
         <city>San Jose</city>
         <region>California</region>
         <code>95134</code>
         <country>USA</country>
       </postal>
       <phone>+1-408-424-1102</phone>
       <email>fnv-ietf6-mail@asthe.com</email>
       <uri>http://www.isthe.com/chongo/index.html</uri>
     </address>
   </author>

   <author fullname="Kiem-Phong Vo" initials="K."
           surname="Vo">
     <organization>Google</organization>
     <address>
       <email>phongvo@gmail.com</email>
     </address>
   </author>

   <author fullname="Donald E. Eastlake 3rd" initials="D."
           surname="Eastlake">
     <organization>Independent</organization>
     <address>
       <postal>
         <street>2386 Panoramic Circle</street>
         <city>Apopka</city>
         <region>Florida</region>
         <code>32703</code>
         <country>USA</country>
       </postal>        
       <phone>+1-508-333-2270</phone>
       <email>d3e3e3@gmail.com</email>
     </address>
   </author>

   <author fullname="Tony Hansen" initials="T."
           surname="Hansen">
     <organization>AT&amp;T</organization>
     <address>
       <postal>
         <street>200 Laurel Avenue South</street>
         <city>Middletown</city>
         <region>New Jersey</region>
         <code>07748</code>
         <country>USA</country>
       </postal>        
      <email>tony@att.com</email>
     </address>
   </author>

   <date year="2024" month="9" day="27"/>

   <area>Security</area>
   <workgroup>Internet Engineering Task Force</workgroup>
   <!-- "Internet Engineering Task Force" is fine for individual
        submissions.  If this element is not present, the default is
        "Network Working Group", which is used by the RFC Editor as a
        nod to the history of the RFC Series. --> 

   <keyword></keyword>
   <!-- Multiple keywords are allowed.  Keywords are incorporated
        into HTML output files for use by search engines. --> 

<abstract>
  <t>FNV (Fowler/Noll/Vo) is a fast, non-cryptographic hash algorithm
  with good dispersion that is referenced in a number of standards
  documents and widely used. The purpose of this document is to make
  information on FNV and open source code performing all specified
  sizes of FNV conveniently available to the Internet community.</t>
</abstract>

</front>


<!-- ____________________MIDDLE_MATTER____________________ -->
<middle>
    
<section> <!-- 1. -->
  <name>Introduction</name>

  <t>The FNV hash algorithm originated from an idea submitted as
  reviewer comments to the <xref target="IEEE"/> POSIX P1003.2
  committee in 1991 by Glenn Fowler and Phong Vo. Subsequently, during
  a ballot round, Landon Curt Noll proposed an enhancement to their
  algorithm.  Some people tried this hash and found that it worked
  rather well. In an EMail message to Landon, they named it the
  "Fowler/Noll/Vo" or FNV hash. <xref target="FNV"/></t>

  <t>FNV hashes are designed to be fast while maintaining a low
  collision rate. Their exceptional dispersion makes them particularly
  well-suited for hashing nearly identical strings, including URLs,
  hostnames, filenames, text, and IP addresses. Their speed allows one
  to quickly hash lots of data while maintaining a reasonably low
  collision rate. They are generally not suitable for
  cryptographic use (see <xref target="noncrypto"/>).</t>

  <t>The FNV hash is widely used. For example it is referenced in the
  <xref target="RFC7357"/>, <xref target="RFC7873"/>, and <xref
  target="IEEE8021Qbp"/> standards documents. It is also used in DNS
  servers, the X (formerly Twitter) service, database indexing hashes,
  major web search / indexing engines, netnews history file Message-ID
  lookup functions, anti-spam filters, a spellchecker programmed in
  Ada 95, flatassembler's open source x86 assembler - user-defined
  symbol hashtree, non-cryptographic file fingerprints, computing
  Unique IDs in DASM (DTN (Delay Tolerant Networking) Applications for
  Symbian Mobile-phones), Microsoft's hash_map implementation for VC++
  2005, the realpath cache in PHP 5.x
  (php-5.2.3/TSRM/tsrm_virtual_cwd.c), and many other uses.</t>

  <t>A study has recommended FNV in connection with the IPv6 Flow
  Label field <xref target="IPv6flow"/>. Additionally, there was a
  proposal to use FNV for BFD sequence number generation <xref
  target="BFDseq"/>.</t>

  <t>FNV hash algorithms and source code have been released into the
  public domain. The authors took deliberate
  steps to disclose the algorithm in a public forum soon after it's
  invention. More than a year passed after this public disclosure and
  the authors deliberately took no steps to patent the FNV algorithm.
  Therefore, it is safe to say that the FNV authors have no patent
  claims on the FNV algorithm. </t>

  <t>If you use an FNV function in an application, you are kindly
  requested to send an EMail about it to: fnv-mail@asthe.com</t>

</section> <!-- end 1. Introduction -->


<section> <!-- 2. -->
  <name>FNV Basics</name>

<t>This document focuses on the FNV-1a function whose pseudo-code is
as follows:</t>

<sourcecode type="pseudocode">
  hash = offset_basis
  for each octet_of_data to be hashed
      hash = hash xor octet_of_data
      hash = hash * FNV_Prime
  return hash
</sourcecode>

<t>In the pseudo-code above, hash is a power-of-two number of bits
(32, 64, 128, 256, 512, or 1024) and offset_basis and FNV_Prime depend
on the size of hash.</t>

<t>The FNV-1 algorithm is the same, including the values of
offset_basis and FNV_Prime, except that the order of the two lines
with the "xor" and multiply operations are reversed. Operational
experience indicates better hash dispersion for small amounts of data
with FNV-1a. FNV-0 is the same as FNV-1 but with offset_basis set to
zero. FNV-1a is suggested for general use.</t>

<section> <!-- 2.1 -->
  <name>FNV Primes</name>

<t>The theory behind FNV_Prime's is beyond the scope of this document
but the basic property to look for is how an FNV_Prime would impact
dispersion. Now, consider any n-bit FNV hash where n >= 32 and is also
a power of 2, in particular n = 2**s. For each such n-bit FNV hash, an
FNV_Prime p is defined as:</t>

<ul>
  <li><t>When s is an integer and 4 &lt; s &lt; 11, then
  FNV_Prime is the smallest prime p of the form:</t>

<artwork align="center" type="ascii-art">
256**int((5 + 2**s)/12) + 2**8 + b
</artwork>
</li>

  <li><t>where b is an integer such that:</t>

<artwork align="center" type="ascii-art">
0 &lt; b &lt; 2**8
</artwork>
</li>

<li><t>The number of one-bits in b
is 4 or 5</t></li>

<li><t>and where</t>
<artwork align="center" type="ascii-art">
( p mod (2**40 - 2**24 - 1) ) &gt; (2**24 + 2**8 + 2**7)
</artwork>
</li>
</ul>

<t>Experimentally, FNV_Primes matching the above constraints tend to
have better dispersion properties. They improve the polynomial
feedback characteristic when an FNV_Prime multiplies an intermediate
hash value. As such, the hash values produced are more scattered
throughout the n-bit hash space.</t>

<t>The case where s &lt; 5 is not considered due to the resulting low
hash quality. Such small hashes can, if desired, be derived
from a 32 bit FNV hash by XOR folding (see Section 3). The case where
s &gt; 10 is not considered because of the doubtful utility of such
large FNV hashes and because the criteria for such large FNV_Primes is
more complex, due to the sparsity of such large primes, and would
needlessly clutter the criteria given above.</t>

<t>Per the above constraints, an FNV_Prime should have only 6 or 7
one-bits in it: one relatively high order one bit, the 2**9 bit, and 4
or 5 one bits in the low order byte. Therefore, some compilers may
seek to improve the performance of a multiplication with an FNV_Prime
by replacing the multiplication with shifts and adds.  However, note
that the performance of this substitution is highly hardware-dependent
and should be done with care. The selection of FNV_Primes prioritizes
the quality of the resulting hash function, not compiler optimization
considerations.</t>

</section>

<section> <!-- 2.2 -->
  <name>FNV offset_basis</name>

<t>The offset_basis values for the n-bit FNV-1a algorithms are
computed by applying the n-bit FNV-0 algorithm to the 32 octets
representing the following character string in ASCII <xref
target="RFC0020"/>:</t>

<artwork align="center" type="ascii-art">
chongo &lt;Landon Curt Noll&gt; /\../\
</artwork>

<t>The \'s in the above string are not C-style escape characters. In
C-string notation, these 32 octets are:</t>

<artwork align="center" type="ascii-art">
"chongo &lt;Landon Curt Noll&gt; /\\../\\"
</artwork>

<t>That string was used because the person testing FNV with non-zero
offset_basis values was looking at an email message from Landon and
was copying his standard email signature line; however, they couldn't
see very well and copied it incorrectly. In fact, he uses</t>

<artwork align="center" type="ascii-art">
chongo (Landon Curt Noll) /\oo/\
</artwork>

<t>but, since it doesn't matter, no effort has been made to correct
this.</t>

<t>In the general case, almost any offset_basis will serve so long as
it is non-zero. The choice of a non-standard offset_basis may be
beneficial in defending against some attacks that try to induce hash
collisions as discussed in <xref target="bang"/>.</t>

</section>

<section anchor="endian">  <!-- 2.3 -->
  <name>FNV Endianism</name>

<t>For persistent storage or interoperability between different
hardware platforms, an FNV hash shall be represented in the little
endian format. That is, the FNV hash will be stored in an array
hash[N] with N bytes such that its integer value can be retrieved as
follows:</t>

<sourcecode type="C">
  unsigned char   hash[N];
  for ( i = N-1, value = 0; i &gt;= 0; --i )
      value = ( value &lt;&lt; 8 ) + hash[i];
</sourcecode>

<t>Of course, when FNV hashes are used in a single process or a group
of processes sharing memory on processors with compatible endian-ness,
the natural endian-ness of those processors can be used, as long as it
is used consistantly, regardless of its type, little, big, or some
other exotic form.</t>

<t>The code provided in Section 6 has FNV hash functions that return a
little endian byte vector for all lengths. Because they are more
efficient, the code also provides for return of FNV hashes as 32-bit
integers or, where supported, 64-bit integers, for those sizes of FNV
hash. Such integers are compatible with the same size byte vectors on
little endian computers but use of the functions returning integers on
big endian or other non-little-endian machines will be byte-reversed
or otherwise incompatible with the byte vector return values.</t>

</section>
</section>

<section>  <!-- 3. -->
  <name>Other Hash Sizes and XOR Folding</name>

<t>Many hash uses require a hash that is not one of the FNV sizes for
which constants are provided in Section 5.  If a larger hash size is
needed, please contact the authors of this document.</t>

<t>For scenarios where a fixed-size binary field of k bits is desired
with k &lt; 1024 but not among the provided constants in Section 5,
the recommended approach involves using the smallest FNV hash of size
S where S &gt; k and employing xor folding, as shown below. The final
bit masking operation is logically unnecessary if the size of the
variable k-bit-hash is exactly k bits.</t>

<sourcecode type="pseudocode">
  temp = FNV_S ( data-to-be-hashed )
  k-bit-hash = ( temp xor temp>>k ) bitwise-and ( 2**k - 1 )
</sourcecode>

<t>Hash functions are a trade-off between speed and strength. For
example, a somewhat stronger hash may be obtained for exact FNV sizes
by calculating an FNV twice as long as the desired output ( S = 2*k )
and performing such data folding using a k equal to the size of the
desired output. However, if a much stronger hash, for example one
suitable for cryptographic applications, is wanted, algorithms
designed for that purpose, such as those in <xref target="RFC6234"/>,
should be used.</t>

<t>If it is desired to obtain a hash result that is a value between 0
and max, where max+1 is a not a power of two, simply choose an FNV
hash size S such that 2**S &gt; max. Then calculate the following:</t>

<artwork align="center" type="ascii-art">
FNV_S mod ( max+1 )
</artwork>
    
<t>The resulting remainder will be in the range desired but will
suffer from a bias against large values with the bias being larger if
2**S is only a little bigger than max. If this bias is acceptable, no
further processing is needed. If this bias is unacceptable, it can be
avoided by retrying for certain high values of hash, as follows,
before applying the mod operation above:</t>

<sourcecode type="pseudocode">
  X = ( int( ( 2**S - 1 ) / ( max+1 ) ) ) * ( max+1 )
  while ( hash >= X )
      hash = ( hash * FNV_Prime ) + offset_basis
</sourcecode>

</section> <!-- 3 -->

<section>  <!-- 4. -->
  <name>Hashing Multiple Values Together</name>
 
<t>It is common for there to be a few different component values, say
three strings X, Y, and Z, where a hash over all of them is desired.
The simplest thing to do is to concatenate them in a fixed order and
compute the hash of that concatenation, as in</t>

<artwork align="center" type="ascii-art">
hash ( X | Y | Z )
</artwork>

<t>where the vertical bar character ("|") represents string
concatenation. If the components being combined are of variable
length, some information is lost by simple concatenation. For example,
X = "12" and Y = "345" would not be distinguished from X = "123" and Y
= "45". To preserve that information, each component should be
preceded by an encoding of its length or some similar technique
used.</t>

<t>Note that, for FNV, the same hash results if X, Y, and
Z are actually concatenated and the FNV hash applied to the resulting
string or if FNV is calculated on an initial substring and the result
used as the offset_basis when calculating the FNV hash of the
remainder of the string.  This can be done several times. Assuming
FNVoffset_basis ( v, w ) is FNV of w using v as the offset_basis, then
in the example above, fnvx = FNV ( X ) could be calculated and then
fnvxy = FNVoffset_basis ( fnvx, Y ), and finally fnvxyz =
FNVoffset_basis ( fnvxy, Z). The resulting fnvxyz would be the same as
FNV ( X | Y | Z ).</t>

<t>Cases are also common where such a hash needs to be repeatedly
calculated where the component values vary but some vary more
frequently than others.  For example, assume some sort of computer
network traffic flow ID, such as the IPv6 flow ID <xref
target="RFC6437"/>, is to be calculated for network packets based on
the source and destination IPv6 address and the Traffic Class <xref
target="RFC8200"/>. If the Flow ID is calculated in the originating
host, the source IPv6 address would likely always be the same or
perhaps assume one of a very small number of values. By placing this
quasi-constant IPv6 source address first in the string being FNV
hashed, FNV ( IPv6source ) could be calculated and used as the
offset_basis for calculating FNV of the IPv6 destination address and
Traffic Class for each packet. As a result, the per packet hash would
be over 17 bytes rather than over 33 bytes saving computational
resources. The source code in this document includes functions
facilitating the use of a non-standard offset_basis.</t>

</section>  <!-- 4. -->

<section> <!-- 5. -->
  <name>FNV Constants</name>

  <t>The FNV Primes are as follows:</t>
  
<table>
  <thead>
<tr><th>Size FNV Prime = Exression</th></tr>
<tr><th align="right">= Decimal</th></tr>
<tr><th align="right">= Hexadecimal</th></tr>
  </thead>
  <tbody>
    
<tr><td>32 bit FNV_Prime = 2**24 + 2**8 + 0x93</td></tr>
<tr><td align="right">= 16,&zwsp;777,&zwsp;619</td></tr>
<tr><td align="right">= 0x01000193</td></tr>

<tr><td>64 bit FNV_Prime = 2**40 + 2**8 + 0xB3</td></tr>
<tr><td align="right">=
1,&zwsp;099,&zwsp;511,&zwsp;628,&zwsp;211</td></tr>
<tr><td align="right"> = 0x00000100 000001B3</td></tr>

<tr><td>128 bit FNV_Prime = 2**88 + 2**8 + 0x3B</td></tr>
<tr><td align="right">=
309,&zwsp;485,&zwsp;009,&zwsp;821,&zwsp;345,&zwsp;068,&zwsp;724,&zwsp;781,&zwsp;371</td></tr>
<tr><td align="right">= 0x00000000 01000000 00000000
0000013B</td></tr>

<tr><td>256 bit FNV_Prime = 2**168 + 2**8 + 0x63</td></tr>
<tr><td align="right">=
374,&zwsp;144,&zwsp;419,&zwsp;156,&zwsp;711,&zwsp;147,&zwsp;060,&zwsp;143,&zwsp;317,&zwsp;175,&zwsp;368,&zwsp;453,&zwsp;031,&zwsp;918,&zwsp;731,&zwsp;002,&zwsp;211</td></tr>
<tr><td align="right">= 0x0000000000000000
0000010000000000 0000000000000000 0000000000000163</td></tr>

<tr><td>512 bit FNV_Prime = 2**344 + 2**8 + 0x57</td></tr>
<tr><td align="right">= 35,&zwsp;835,&zwsp;915,&zwsp;874,&zwsp;844,&zwsp;867,&zwsp;368,&zwsp;919,&zwsp;076,&zwsp;489,&zwsp;095,&zwsp;108,&zwsp;449,&zwsp;946,&zwsp;327,&zwsp;955,&zwsp;754,&zwsp;392,&zwsp;558,&zwsp;399,&zwsp;825,&zwsp;615,&zwsp;420,&zwsp;669,&zwsp;938,&zwsp;882,&zwsp;575,&zwsp;126,&zwsp;094,&zwsp;039,&zwsp;892,&zwsp;345,&zwsp;713,&zwsp;852,&zwsp;759</td></tr>
<tr><td align="right">= 0x0000000000000000
0000000000000000 0000000001000000 0000000000000000 0000000000000000
0000000000000000 0000000000000000 0000000000000157</td></tr>

<tr><td>1024 bit FNV_Prime = 2**680 + 2**8 + 0x8D</td></tr>
<tr><td align="right">= 5,&zwsp;016,&zwsp;456,&zwsp;510,&zwsp;113,&zwsp;118,&zwsp;655,&zwsp;434,&zwsp;598,&zwsp;811,&zwsp;035,&zwsp;278,&zwsp;955,&zwsp;030,&zwsp;765,&zwsp;345,&zwsp;404,&zwsp;790,&zwsp;744,&zwsp;303,&zwsp;017,&zwsp;523,&zwsp;831,&zwsp;112,&zwsp;055,&zwsp;108,&zwsp;147,&zwsp;451,&zwsp;509,&zwsp;157,&zwsp;692,&zwsp;220,&zwsp;295,&zwsp;382,&zwsp;716,&zwsp;162,&zwsp;651,&zwsp;878,&zwsp;526,&zwsp;895,&zwsp;249,&zwsp;385,&zwsp;292,&zwsp;291,&zwsp;816,&zwsp;524,&zwsp;375,&zwsp;083,&zwsp;746,&zwsp;691,&zwsp;371,&zwsp;804,&zwsp;094,&zwsp;271,&zwsp;873,&zwsp;160,&zwsp;484,&zwsp;737,&zwsp;966,&zwsp;720,&zwsp;260,&zwsp;389,&zwsp;217,&zwsp;684,&zwsp;476,&zwsp;157,&zwsp;468,&zwsp;082,&zwsp;573</td></tr>
<tr><td align="right">= 0x0000000000000000
0000000000000000 0000000000000000 0000000000000000 0000000000000000
0000010000000000 0000000000000000 0000000000000000 0000000000000000
0000000000000000 0000000000000000 0000000000000000 0000000000000000
0000000000000000 0000000000000000 000000000000018D</td></tr>

  </tbody>
</table>

<t>The FNV offset_basis values are as follows:</t>

<table>
  <thead>
<tr><th>Size offset_basis</th></tr>
<tr><th align="right">= Decimal</th></tr>
<tr><th align="right">= Hexadecimal</th></tr>
  </thead>
  <tbody>

<tr><td>32 bit offset_basis</td></tr>
<tr><td align="right">= 2,&zwsp;166,&zwsp;136,&zwsp;261</td></tr>
<tr><td align="right">= 0x811C9DC5</td></tr>

<tr><td>64 bit offset_basis</td></tr>
<tr><td align="right">=
14,&zwsp;695,&zwsp;981,&zwsp;039,&zwsp;346,&zwsp;656,&zwsp;037</td></tr>
<tr><td align="right">= 0xCBF29CE4 84222325</td></tr>

<tr><td>128 bit offset_basis</td></tr>
<tr><td align="right">=
144,&zwsp;066,&zwsp;263,&zwsp;297,&zwsp;769,&zwsp;815,&zwsp;596,&zwsp;495,&zwsp;629,&zwsp;667,&zwsp;062,&zwsp;367,&zwsp;629</td></tr>
<tr><td align="right">= 0x6C62272E 07BB0142 62B82175 6295C58D</td></tr>

<tr><td>256 bit offset_basis</td></tr>
<tr><td align="right">=
100,&zwsp;029,&zwsp;257,&zwsp;958,&zwsp;052,&zwsp;580,&zwsp;907,&zwsp;070,&zwsp;968,&zwsp;620,&zwsp;625,&zwsp;704,&zwsp;837,&zwsp;092,&zwsp;796,&zwsp;014,&zwsp;241,&zwsp;193,&zwsp;945,&zwsp;225,&zwsp;284,&zwsp;501,&zwsp;741,&zwsp;471,&zwsp;925,&zwsp;557</td></tr>
<tr><td align="right">= 0xDD268DBCAAC55036 2D98C384C4E576CC
C8B1536847B6BBB3 1023B4C8CAEE0535</td></tr>

<tr><td>512 bit offset_basis</td></tr> <tr><td align="right">= 9,&zwsp;659,&zwsp;303,&zwsp;129,&zwsp;496,&zwsp;669,&zwsp;498,&zwsp;009,&zwsp;435,&zwsp;400,&zwsp;716,&zwsp;310,&zwsp;466,&zwsp;090,&zwsp;418,&zwsp;745,&zwsp;672,&zwsp;637,&zwsp;896,&zwsp;108,&zwsp;374,&zwsp;329,&zwsp;434,&zwsp;462,&zwsp;657,&zwsp;994,&zwsp;582,&zwsp;932,&zwsp;197,&zwsp;716,&zwsp;438,&zwsp;449,&zwsp;813,&zwsp;051,&zwsp;892,&zwsp;206,&zwsp;539,&zwsp;805,&zwsp;784,&zwsp;495,&zwsp;328,&zwsp;239,&zwsp;340,&zwsp;083,&zwsp;876,&zwsp;191,&zwsp;928,&zwsp;701,&zwsp;583,&zwsp;869,&zwsp;517,&zwsp;785</td></tr>
<tr><td align="right">= 0xB86DB0B1171F4416 DCA1E50F309990AC
AC87D059C9000000 0000000000000D21 E948F68A34C192F6 2EA79BC942DBE7CE
182036415F56E34B AC982AAC4AFE9FD9</td></tr>

<tr><td>1024 bit offset_basis</td></tr> <tr><td align="right">= 14,&zwsp;197,&zwsp;795,&zwsp;064,&zwsp;947,&zwsp;621,&zwsp;068,&zwsp;722,&zwsp;070,&zwsp;641,&zwsp;403,&zwsp;218,&zwsp;320,&zwsp;880,&zwsp;622,&zwsp;795,&zwsp;441,&zwsp;933,&zwsp;960,&zwsp;878,&zwsp;474,&zwsp;914,&zwsp;617,&zwsp;582,&zwsp;723,&zwsp;252,&zwsp;296,&zwsp;732,&zwsp;303,&zwsp;717,&zwsp;722,&zwsp;150,&zwsp;864,&zwsp;096,&zwsp;521,&zwsp;202,&zwsp;355,&zwsp;549,&zwsp;365,&zwsp;628,&zwsp;174,&zwsp;669,&zwsp;108,&zwsp;571,&zwsp;814,&zwsp;760,&zwsp;471,&zwsp;015,&zwsp;076,&zwsp;148,&zwsp;029,&zwsp;755,&zwsp;969,&zwsp;804,&zwsp;077,&zwsp;320,&zwsp;157,&zwsp;692,&zwsp;458,&zwsp;563,&zwsp;003,&zwsp;215,&zwsp;304,&zwsp;957,&zwsp;150,&zwsp;157,&zwsp;403,&zwsp;644,&zwsp;460,&zwsp;363,&zwsp;550,&zwsp;505,&zwsp;412,&zwsp;711,&zwsp;285,&zwsp;966,&zwsp;361,&zwsp;610,&zwsp;267,&zwsp;868,&zwsp;082,&zwsp;893,&zwsp;823,&zwsp;963,&zwsp;790,&zwsp;439,&zwsp;336,&zwsp;411,&zwsp;086,&zwsp;884,&zwsp;584,&zwsp;107,&zwsp;735,&zwsp;010,&zwsp;676,&zwsp;915</td></tr>
<tr><td align="right">= 0x0000000000000000 005F7A76758ECC4D
32E56D5A591028B7 4B29FC4223FDADA1 6C3BF34EDA3674DA 9A21D90000000000
0000000000000000 0000000000000000 0000000000000000 0000000000000000
0000000000000000 000000000004C6D7 EB6E73802734510A 555F256CC005AE55
6BDE8CC9C6A93B21 AFF4B16C71EE90B3</td></tr>

  </tbody>
</table>

</section>

<section>  <!-- 6. -->
  <name>The Source Code</name>

<t>The following sub-sections provide reference C source code and a
test driver with command line interface for FNV-1a. Alternative source
code for 32- and 64-bit FNV-1 and FNV-1a including in x86 assembler, is
currently available at <xref target="FNV"/>.</t>
  
<t>Section 6.2 provides the C header and code source files for the FNV
functions. Section 6.3 provides the test driver. Section 6.4 provide a
simple makefile to build the test driver or a library file with all
FNV sizes.</t>

<section>  <!-- 6.1 -->
  <name>Source Code Details</name>
  
  <section>  <!-- 6.1.1 -->
    <name>FNV Functions Available</name>

  <t>The functions provided are listed below. The "xxx" in the
  function names is "32", "64", "128", "256", "512", or "1024"
  depending on the length of the FNV.  All of the FNV hash functions
  have as their return value an integer whose meaning is specified in
  FNVErrorCodes.h.</t>
 
  <t>Functions providing a byte vector hash are available for all
  lengths. For FNV-32, versions are available that provide a 32-bit
  integer and are identified by replacing "xxx" with "32INT". For
  example, FNV32string provides a 4-byte vector but FNV32INTstring
  provides a 32-bit integer. For FNV-64, if compiled with 64-bit
  integers enabled (i.e., FNV_64bitIntegers defined, see FNVconfig.h),
  versions are available that provide a 64-bit integer and are
  identified by replacing "xxx" with "64INT"`. Versions providing an
  integer hash will not be compatible between systems of different
  endian-ness (see <xref target="endian"/>).</t>

  <t>If you want to copy the source code from this document, note that
  it is indented by three spaces in the ".txt" version. It may be
  simplest to copy from the ".html" version of this document.</t>

  <dl>
    
    <dt>FNVxxxstring, FNVxxxblock, FNVxxxfile:</dt><dd/>

    <dt>FNVxxxINTstring, FNVxxxINTblock, FNVxxxINTfile:</dt><dd>These
    are simple functions for directly returning the FNV hash of a zero
    terminated byte string not including that zero byte, the FNV hash
    of a counted block of bytes, and the FNV of a file, respectively.
    Note that for applications of FNV-32 and FNV-64 where 64-bit
    integers are supported and an integer data type output is
    acceptable, the code is sufficiently simple that, to maximize
    performance, use of open coding or macros may be more appropriate
    than calling a subroutine.</dd>

    <dt>FNVxxxinit, FNVxxxinitBasis:</dt><dd/>
    
    <dt>FNVxxxINTinitBasis:</dt><dd>These functions and the next two
    sets of functions below provide facilities for incrementally
    calculating FNV hashes. They all assume a data structure of type
    FNVxxxcontext that holds the current state of the hash. FNVxxxinit
    initializes that context to the standard
    offset_basis. FNVxxxinitBasis takes an offset_basis value as a
    parameter and may be useful for hashing concatenations, as
    described in Section 4, as well as for simply using a non-standard
    offset_basis.</dd>

    <dt>FNVxxxblockin, FNVxxxstringin:</dt><dd>These functions hash a
    sequence of bytes into an FNVxxxcontext that was originally
    initialized by FNVxxxinit or FNVxxxinitBasis. FNVxxxblockin hashes
    in a counted block of bytes. FNVxxxstringin hashes in a zero
    terminated byte string not incuding the final zero byte.</dd>

    <dt>FNVxxxresult:</dt><dd/>
  
    <dt>FNVxxxINTresult:</dt><dd>This function extracts the final FNV
    hash result from an FNVxxxcontext.</dd>
  
  </dl>
  
    </section>

  <section>  <!-- 6.1.2 -->
    <name>Source Files and 64-bit Support </name>

<t>Code optimized for 64-bit integer support, that is, support of
64-bit integer addition and 32x32-bit multiplication producing a
64-bit product, is provided based on whether or not the
FNV_64bitIntegers symbol is defined. By default, this is set in
FNVconfig.h based on the compilation target; however, this can be
overridden by editing that file or by defining certain symbols in, for
example, a command line invoking compilation.</t>

<t>For support of a single FNV size, say "xxx", in an application, the
application itself needs to include the FNVxxx.h (which will, in turn,
include the FNVconfig.h and FNVErrorCodes.h) files.  To build the
particular FNVxxx code itself, compile the FNVxxx.c file with
FNVconfig.h, fnv-private.h, FNVErrorCodes.h, and FNVxxx.h
available. Since the test program in Section 6.3 uses all sizes of
FNV, all the .c and .h files are needed to compile it.</t>

  </section>
  <section>  <!-- 6.1.3 -->
    <name>Command Line Interface</name>

    <t>The test program provided in Section 6.3 has a command line
    interface. By default, with no command line arugments, it runs
    tests of all FNV lengths. Command line options are as follows:</t>
    
<artwork align="center" type="ascii-art">
FNVhash [-a] [-t nnn] [-u nnn] [-v] [-f filename] [token ...]
</artwork>

<t>The option letters have the following meaning:</t>

<dl>
  <dt>-a</dt><dd>Run tests for all lengths.</dd>

<dt>-v</dt><dd>Complement the Verbose flag which is initially off. When
the flag is on, the program prints more informaton during tests,
etc.</dd>

<dt>-t nnn</dt><dd>Run tests for length nnn which must be one of 32,
63, 128, 256, 512, or 1024.</dd>

<dt>-u nnn</dt><dd>Use hash size nnn which must be one of 32, 63, 128,
256, 512, or 1024. This is useful to set the hash size for use by the
-f option or in hashing tokens on the command line after the
options.</dd>

<dt>-f filename</dt><dd>Hash the contents of the file with name
filename. The hash size must have been set by a prior -t or -u
option in the command line.</dd>

<dt>token</dt><dd>Tokens appearing on the command line after the
options are hashed with the current hash size which must have been set
by a prior -t or -u option in the command line.</dd>

</dl>

<t>For example</t>
<artwork align="center" type="ascii-art">
FNVhash -t 128 -h -v -t 64 -v -u 256 -f foobar.txt RabOof 1234
</artwork>
<t>runs tests for FNV128, then prints a command llne help message,
then turns on Verbose, then runs the tests for FNV64, then turns off
Verbose, then sets the hash size to 256, then hashes the contents of
file foobar.txt, then hashes the token "RabOof", and finally hashes
the token "1234".</t>

  </section>
</section>

<section>  <!-- 6.2 -->
  <name>FNV-1a C Code</name>

  <t>This section provides the direct FNV-1a function for each of the
  lengths for which it is specified in this document.</t>

  <t>The following code is a private header file used by all the FNV
  functions further below and which states the terms for use and
  redistribution of all of this code.</t>

<sourcecode type="C" markers="true" name="fnv-private.h">
//********************** fnv-private.h ************************//
//**************** See RFC NNNN for details *******************//
/* Copyright (c) 2016, 2023, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 *
 * *  Neither the name of Internet Society, IETF or IETF Trust, nor
 *    the names of specific contributors, may be used to endorse or
 *    promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _FNV_PRIVATE_H_
#define _FNV_PRIVATE_H_

/*
 *      Six FNV-1a hashes are defined with these sizes:
 *              FNV32          32 bits, 4 bytes
 *              FNV64          64 bits, 8 bytes
 *              FNV128         128 bits, 16 bytes
 *              FNV256         256 bits, 32 bytes
 *              FNV512         512 bits, 64 bytes
 *              FNV1024        1024 bits, 128 bytes
 */

/* Private stuff used by this implementation of the FNV
 * (Fowler, Noll, Vo) non-cryptographic hash function FNV-1a.
 * External callers don't need to know any of this.  */

enum {  /* State value bases for context->Computed */
    FNVinited = 22,
    FNVcomputed = 76,
    FNVemptied = 220,
    FNVclobber = 122 /* known bad value for testing */
};

/* Deltas to assure distinct state values for different lengths */
enum {
   FNV32state = 1,
   FNV64state = 3,
   FNV128state = 5,
   FNV256state = 7,
   FNV512state = 11,
   FNV1024state = 13
};

#endif /* _FNV_PRIVATE_H_ */
</sourcecode>


<t>The following code is a simple header file to define the return
value error codes for the FNV routines.</t>


<sourcecode type="C" markers="true" name="FNVErrorCodes.h">
//*********************** FNVErrorCodes.h *************************//
//***************** See RFC NNNN for details. *********************//
/*
 * Copyright (c) 2016, 2023, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNV_ErrCodes_
#define _FNV_ErrCodes_
//******************************************************************
//  All FNV functions provided return as integer as follows:
//       0 -> success
//      >0 -> error as listed below
//
enum {    /* success and errors */
    fnvSuccess = 0,
    fnvNull,          /* Null pointer parameter */
    fnvStateError,    /* called Input after Result or before Init */
    fnvBadParam       /* passed a bad parameter */
};
#endif /* _FNV_ErrCodes_ */
</sourcecode>


<t>The following is a configuration header to set whether 64-bit
integers are supported.</t>


<sourcecode type="C" markers="true" name="FNVconfig.h">
<![CDATA[
//************************ FNVconfig.h **************************//
//**************** See RFC NNNN for details. ********************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 *
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNVconfig_H_
#define _FNVconfig_H_

/*  Description:
 *      This file provides configuration ifdefs for the
 *      FNV-1a non-cryptographic hash algorithms. */

/*      FNV_64bitIntegers - Define this if your system supports
 *          64-bit arithmetic including 32-bit x 32-bit
 *          multiplication producing a 64-bit product. If
 *          undefined, it will be assumed that 32-bit arithmetic
 *          is supported including 16-bit x 16-bit multiplication
 *          producing a 32-bit result.
 */

#include <stdint.h>

/* Check if 64-bit integers are supported in the target */

#if defined(__SIZEOF_LONG_LONG__) && __SIZEOF_LONG_LONG__ >= 8
    #define FNV_64bitIntegers
#elif defined(UINT64_MAX)
    #define FNV_64bitIntegers
#else
    #undef FNV_64bitIntegers
#endif

/*      The following allows overriding the
 *      above configuration setting.
 */

#ifdef FNV_TEST_PROGRAM
# ifdef TEST_FNV_64bitIntegers
#  ifndef FNV_64bitIntegers
#   define FNV_64bitIntegers
#  endif
# else
#  undef FNV_64bitIntegers
# endif
# ifndef FNV_64bitIntegers /* causes an error if uint64_t is used */
#  undef uint64_t
#  define uint64_t no_64_bit_integers
# endif
#endif

#endif /* _FNVconfig_H_ */
]]></sourcecode>


<section>
  <name>FNV32 Code</name>

<t>The header and C source for 32-bit FNV-1a providing a 32-bit
integer or 4-byte vector hash.</t>


<sourcecode type="C" markers="true" name="FNV32.h">
<![CDATA[
//*************************** FNV32.h ****************************//
//****************** See RFC NNNN for details ********************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNV32_H_
#define _FNV32_H_

/*
 *  Description:
 *      This file provides headers for the 32-bit version of
 *      the FNV-1a non-cryptographic hash algorithm.
 */

#include "FNVconfig.h"
#include "FNVErrorCodes.h"

#include <stdint.h>
#define FNV32size (32/8)
#define FNV32basis 0x811C9DC5

/* If you do not have the ISO standard stdint.h header file, then
 * you must typedef the following types:
 *
 *    type              meaning
 *  uint32_t         unsigned 32-bit integer
 *  uint8_t          unsigned 8-bit integer (i.e., unsigned char)
 */

/*
 *  This structure holds context information for an FNV32 hash
 */
typedef struct FNV32context_s {
    int Computed;  /* state */
    uint32_t Hash;
} FNV32context;

/*
 * Function Prototypes:
 *
 *    FNV32string: hash a zero-terminated string not including
 *                 the terminating zero
 *    FNV32block: hash a specified length byte vector
 *    FNV32file: hash the contents of a file
 *
 *    FNV32init:  initializes an FNV32 context
 *    FNV32initBasis: initializes an FNV32 context with a
 *                    provided 4-byte vector basis
 *    FNV32blockin:  hash in a specified length byte vector
 *    FNV32stringin: hash in a zero-terminated string not
 *                   including the terminating zero
 *    FNV32result: returns the hash value
 *
 * Hash is returned as a 4-byte vector by the functions above,
 *    and the following return a 32-bit unsigned integer:
 *
 *    FNV32INTstring: hash a zero-terminated string not including
 *                 the terminating zero
 *    FNV32INTblock: hash a specified length byte vector
 *    FNV32INTfile: hash the contents of a file
 *
 *    FNV32INTinitBasis: initializes an FNV32 context with a
 *                     provided 32-bit integer basis
 *    FNV32INTresult: returns the hash value
 */

#ifdef __cplusplus
extern "C" {
#endif

/* FNV32 */
extern int FNV32INTstring ( const char *in,
                            uint32_t * const out );
extern int FNV32string ( const char *in,
                         uint8_t out[FNV32size] );
extern int FNV32INTblock ( const void *vin,
                           long int length,
                           uint32_t * const out );
extern int FNV32block ( const void *vin,
                        long int length,
                        uint8_t out[FNV32size] );
extern int FNV32INTfile ( const char *fname,
                          uint32_t * const out );
extern int FNV32file ( const char *fname,
                       uint8_t out[FNV32size] );
extern int FNV32init ( FNV32context * const );
extern int FNV32INTinitBasis ( FNV32context * const,
                            uint32_t basis );
extern int FNV32initBasis ( FNV32context * const,
                            const uint8_t basis[FNV32size] );
extern int FNV32blockin ( FNV32context * const,
                          const void *vin,
                          long int length );
extern int FNV32stringin ( FNV32context * const,
                           const char *in );
extern int FNV32INTresult ( FNV32context * const,
                            uint32_t * const out );
extern int FNV32result ( FNV32context * const,
                         uint8_t out[FNV32size] );

#ifdef __cplusplus
}
#endif

#endif /* _FNV32_H_ */
]]></sourcecode>


<sourcecode type="C" markers="true" name="FNV32.c">
<![CDATA[
//************************** FNV32.c **************************//
//**************** See RFC NNNN for details. ******************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

/* This code implements the FNV (Fowler, Noll, Vo) non-cryptographic
 * hash function FNV-1a for 32-bit hashes.
 */

#include <stdio.h>

#include "fnv-private.h"
#include "FNV32.h"

/* 32-bit FNV_prime = 2^24 + 2^8 + 0x93 */
#define FNV32prime 0x01000193

/* FNV32 hash a zero-terminated string not including the zero
*****************************************************************/
int FNV32INTstring ( const char *in, uint32_t * const out ) {
    uint32_t    temp;
    uint8_t     ch;

    if ( !in || !out )
        return fnvNull; /* Null input pointer */
    temp = FNV32basis;
    while ( (ch = *in++) )
        temp = FNV32prime * ( temp ^ ch );
    *out = temp;
    return fnvSuccess;
}   /* end FNV32INTstring */

/* FNV32 hash a zero-terminated string not including the zero
*****************************************************************/
int FNV32string ( const char *in, uint8_t out[FNV32size] ) {
    uint32_t    temp;
    uint8_t     ch;
    int         i;

    if ( !in || !out )
        return fnvNull; /* Null input pointer */
    temp = FNV32basis;
    while ( (ch = *in++) )
        temp = FNV32prime * ( temp ^ ch );
    for ( i=0; i<FNV32size; ++i )
        out[i] = ((uint8_t *)&temp)[i];
    return fnvSuccess;
}   /* end FNV32string */

/* FNV32 hash a counted block
 ****************************************************************/
int FNV32INTblock ( const void *vin,
                 long int length,
                 uint32_t * const out ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t    temp;

    if ( !in || !out )
        return fnvNull; /* Null input pointer */
    if ( length < 0 )
        return fnvBadParam;
    for ( temp = FNV32basis; length > 0; length-- )
        temp = FNV32prime * ( temp ^ *in++ );
    *out = temp;
    return fnvSuccess;
}   /* end FNV32INTblock */

/* FNV32 hash a counted block
 ****************************************************************/
int FNV32block ( const void *vin,
                 long int length,
                 uint8_t out[FNV32size] ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t    temp;
    int         i;

    if ( !in || !out )
        return fnvNull; /* Null input pointer */
    if ( length < 0 )
        return fnvBadParam;
    for ( temp = FNV32basis; length > 0; length-- )
        temp = FNV32prime * ( temp ^ *in++ );
    for ( i=0; i<FNV32size; ++i )
        out[i] = ((uint8_t *)&temp)[i];
    return fnvSuccess;
}   /* end FNV32block */


//**************************************************************
//       Set of init, input, and output functions below
//       to incrementally compute FNV32
//**************************************************************

/* initialize context
 ***************************************************************/
int FNV32init ( FNV32context * const ctx ) {
    return FNV32INTinitBasis ( ctx, FNV32basis );
}   /* end FNV32init */

/* initialize context with a provided 32-bit integer basis
 ***************************************************************/
int FNV32INTinitBasis ( FNV32context * const ctx, uint32_t basis ) {
    if ( !ctx )
        return fnvNull;
    ctx->Hash = basis;
    ctx->Computed = FNVinited+FNV32state;
    return fnvSuccess;
}   /* end FNV32INTinitBasis */

/* initialize context with a provided 4-byte vector basis
 ***************************************************************/
int FNV32initBasis ( FNV32context * const ctx,
                    const uint8_t basis[FNV32size] ) {
    int     i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV32size; ++i )
        ((uint8_t *)&ctx->Hash)[i] = basis[i];
    ctx->Computed = FNVinited+FNV32state;
    return fnvSuccess;
}   /* end FNV32initBasis */

/* hash in a counted block
 ***************************************************************/
int FNV32blockin ( FNV32context * const ctx,
                   const void *vin,
                   long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t    temp;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV32state:
            ctx->Computed = FNVcomputed+FNV32state;
            break;
        case FNVcomputed+FNV32state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( temp = ctx->Hash; length > 0; length-- )
        temp = FNV32prime * ( temp ^ *in++ );
    ctx->Hash = temp;
    return fnvSuccess;
}   /* end FNV32blockin */

/* hash in a zero-terminated string not including the zero
 ***************************************************************/
int FNV32stringin ( FNV32context * const ctx, const char *in ) {
    uint32_t    temp;
    uint8_t     ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV32state:
            ctx->Computed = FNVcomputed+FNV32state;
            break;
        case FNVcomputed+FNV32state:
            break;
        default:
            return fnvStateError;
        }
    temp = ctx->Hash;
    while ( (ch = (uint8_t)*in++) )
        temp = FNV32prime * ( temp ^ ch );
    ctx->Hash = temp;
    return fnvSuccess;
}   /* end FNV32stringin */

/* return hash as an integer
 ***************************************************************/
int FNV32INTresult ( FNV32context * const ctx,
                     uint32_t * const out ) {
    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV32state )
        return fnvStateError;
    ctx->Computed = FNVemptied+FNV32state;
    *out = ctx->Hash;
    ctx->Hash = 0;
    return fnvSuccess;
}   /* end FNV32INTresult */

/* return hash as a 4-byte vector
 ***************************************************************/
int FNV32result ( FNV32context * const ctx,
                  uint8_t out[FNV32size] ) {
    int     i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV32state )
        return fnvStateError;
    ctx->Computed = FNVemptied+FNV32state;
    for ( i=0; i<FNV32size; ++i )
        out[i] = ((uint8_t *)&ctx->Hash)[i];
    ctx->Hash = 0;
    return fnvSuccess;
}   /* end FNV32result */

/* hash the contents of a file, return 32-bit integer
 ******************************************************************/
int FNV32INTfile ( const char *fname,
                         uint32_t * const out ) {
    FILE *fp;
    long int i;
    char buf[1024];
    FNV32context e32Context;
    int error;

    if ( !fname || !out )
        return fnvNull;

    if ( ( fp = fopen ( fname, "rb") ) == NULL )
        return fnvBadParam;

    if ( (error = FNV32init (&e32Context)) ) {
        fclose(fp);
        return error;
    }

    if ( (error = FNV32blockin ( &e32Context, "", 0)) ) {
        fclose(fp);
        return error;
    }

    while ( ( i = fread ( buf, 1, sizeof(buf), fp ) ) > 0 ) {
        if ( (error = FNV32blockin ( &e32Context, buf, i)) ) {
            fclose(fp);
            return error;
        }
    }

    error = ferror(fp);
    fclose(fp);
    if (error) {
        return fnvBadParam;
    }

    return FNV32INTresult ( &e32Context, out );
}   /* end FNV32INTfile */

/* hash the contents of a file, return 4 byte vector
 ******************************************************************/
int FNV32file ( const char *fname, uint8_t out[FNV32size] ) {
    uint32_t outINT;
    int i, err;

    if ( !out )
        return fnvNull;
    if ( (err = FNV32INTfile ( fname, &outINT )) )
        return err;
    for ( i=0; i<FNV32size; ++i )
        out[i] = ((uint8_t *)&outINT)[i];
    return fnvSuccess;
}   /* end FNV32file */
]]></sourcecode>


</section>

<section>
  <name>FNV64 Code</name>

<t>The header and C source for 64-bit FNV-1a. Provides an 8-byte
vector or, optionally, if 64-bit integers are supported, a 64-bit
integer hash.</t>


<sourcecode type="C" markers="true" name="FNV64.h">
<![CDATA[
//*************************** FNV64.h ****************************//
//***************** See RFC NNNN for details. ********************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNV64_H_
#define _FNV64_H_

/*
 *  Description:
 *      This file provides headers for the 64-bit version of
 *      the FNV-1a non-cryptographic hash algorithm.
 */

#include "FNVconfig.h"
#include "FNVErrorCodes.h"

#include <stdint.h>
#define FNV64size (64/8)
#ifdef FNV_64bitIntegers
#define FNV64basis 0xCBF29CE484222325
#endif

/* If you do not have the ISO standard stdint.h header file, then
 * you must typedef the following types:
 *
 *    type             meaning
 *  uint64_t        unsigned 64-bit integer (ifdef FNV_64bitIntegers)
 *  uint32_t        unsigned 32-bit integer
 *  uint16_t        unsigned 16-bit integer
 *  uint8_t         unsigned 8-bit integer (i.e., unsigned char)
 */

/*
 *  This structure holds context information for an FNV64 hash
 */
#ifdef FNV_64bitIntegers
    /* version if 64-bit integers supported */
typedef struct FNV64context_s {
        int Computed;  /* state */
        uint64_t Hash;
} FNV64context;

#else
    /* version if 64-bit integers NOT supported */
typedef struct FNV64context_s {
        int Computed;  /* state */
        uint16_t Hash[FNV64size/2];
} FNV64context;

#endif /* FNV_64bitIntegers */

/*
 *  Function Prototypes:
 *
 *    FNV64string: hash a zero-terminated string not including
 *                 the terminating zero
 *    FNV64block: hash a specified length byte vector
 *    FNV64file: hash the contents of a file
 *
 *    FNV64init: initializes an FNV64 context
 *    FNV64initBasis: initializes an FNV64 context with a
 *                    provided 8-byte vector basis
 *    FNV64blockin: hash in a specified length byte vector
 *    FNV64stringin: hash in a zero-terminated string not
 *                   including the terminating zero
 *    FNV64result: returns the hash value
 *
 * Hash is returned as an 8-byte vector by the functions above.
 *    If 64-bit integers are supported, the following return
 *    a 64-bit integer.
 *
 *    FNV64INTstring: hash a zero-terminated string not including
 *                 the terminating zero
 *    FNV64INTblock: hash a specified length byte vector
 *    FNV64INTfile: hash the contents of a file
 *
 *    FNV64INTinitBasis: initializes an FNV32 context with a
 *                     provided 64-bit integer basis
 *    FNV64INTresult: returns the hash value
 */

#ifdef __cplusplus
extern "C" {
#endif

/* FNV64 */
extern int FNV64init ( FNV64context * const );
extern int FNV64blockin ( FNV64context * const,
                          const void * vin,
                          long int length );
extern int FNV64stringin ( FNV64context * const,
                           const char * in );

#ifdef FNV_64bitIntegers
  extern int FNV64INTstring ( const char *in,
                           uint64_t * const out );
  extern int FNV64INTblock ( const void *vin,
                          long int length,
                          uint64_t * const out );
  extern int FNV64INTfile ( const char * fname,
                         uint64_t * const out );
  extern int FNV64INTinitBasis ( FNV64context * const,
                            uint64_t basis );
  extern int FNV64INTresult ( FNV64context * const,
                           uint64_t * const out );
#endif /* FNV_64bitIntegers */

  extern int FNV64string ( const char *in,
                           uint8_t out[FNV64size] );
  extern int FNV64block ( const void *vin,
                          long int length,
                          uint8_t out[FNV64size] );
  extern int FNV64file ( const char * fname,
                         uint8_t out[FNV64size] );
  extern int FNV64initBasis ( FNV64context * const,
                            const uint8_t basis[FNV64size] );
  extern int FNV64result ( FNV64context * const,
                           uint8_t out[FNV64size] );

#ifdef __cplusplus
}
#endif

#endif /* _FNV64_H_ */
]]></sourcecode>


<sourcecode type="C" markers="true" name="FNV64.c">
<![CDATA[
//*************************** FNV64.c ****************************//
//****************** See RFC NNNN for details ********************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

/* This file implements the FNV (Fowler, Noll, Vo) non-cryptographic
 * hash function FNV-1a for 64-bit hashes.
 */

#include <stdio.h>

#include "FNVconfig.h"
#include "fnv-private.h"
#include "FNV64.h"


//*****************************************************************
// START VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//*****************************************************************
#ifdef FNV_64bitIntegers

/* 64-bit FNV_prime = 2^40 + 2^8 + 0xb3 */
#define FNV64prime 0x00000100000001B3

/* FNV64 hash a zero-terminated string not including the zero
 * to a 64-bit integer  (64-bit)
 ******************************************************************/
int FNV64INTstring ( const char *in, uint64_t * const out ) {
    uint64_t    temp;
    uint8_t     ch;

    if ( !in || !out )
        return fnvNull; /* Null input pointer */
    temp = FNV64basis;
    while ( (ch = *in++) )
        temp = FNV64prime * ( temp ^ ch );
    *out = temp;
    return fnvSuccess;
}   /* end FNV64INTstring */

/* FNV64 hash a zero-terminated string to a 64-bit integer
 * to a byte vector  (64-bit)
 ******************************************************************/
int FNV64string ( const char *in, uint8_t out[FNV64size] ) {
    uint64_t    temp;
    uint8_t     ch;
    int         i;

    if ( !in || !out )
        return fnvNull; /* Null input pointer */
    temp = FNV64basis;
    while ( (ch = *in++) )
        temp = FNV64prime * ( temp ^ ch );
    for ( i=0; i<FNV64size; ++i )
        out[i] = ((uint8_t *)&temp)[i];
    return fnvSuccess;
}   /* end FNV64string */

/* FNV64 hash a counted block to a 64-bit integer  (64-bit)
 ******************************************************************/
int FNV64INTblock ( const void *vin,
                 long int length,
                 uint64_t * const out ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint64_t    temp;

    if ( !in || !out )
        return fnvNull; /* Null input/out pointer */
    if ( length < 0 )
        return fnvBadParam;
    for ( temp = FNV64basis; length > 0; length-- )
        temp = FNV64prime * ( temp ^ *in++ );
    *out = temp;
    return fnvSuccess;
}   /* end FNV64INTblock */

/* FNV64 hash a counted block to a byte vector  (64-bit)
 ******************************************************************/
int FNV64block ( const void *vin,
                 long int length,
                 uint8_t out[FNV64size] ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint64_t    temp;
    int         i;

    if ( !in || !out )
        return fnvNull; /* Null input/out pointer */
    if ( length < 0 )
        return fnvBadParam;
    for ( temp = FNV64basis; length > 0; length-- )
        temp = FNV64prime * ( temp ^ *in++ );
    for ( i=0; i<FNV64size; ++i )
        out[i] = ((uint8_t *)&temp)[i];
    return fnvSuccess;
}   /* end FNV64block */


//*****************************************************************
// Set of init, input, and output functions below
// to incrementally compute FNV64
//*****************************************************************

/* initialize context  (64-bit)
 ******************************************************************/
int FNV64init( FNV64context * const ctx ) {
    return FNV64INTinitBasis ( ctx, FNV64basis );
}       /* end FNV64init */

/* initialize context with a provided 64-bit integer basis  (64-bit)
 ******************************************************************/
int FNV64INTinitBasis( FNV64context * const ctx, uint64_t basis ) {
    if ( !ctx )
        return fnvNull;
    ctx->Hash = basis;
    ctx->Computed = FNVinited+FNV64state;
    return fnvSuccess;
}       /* end FNV64INTinitBasis */

/* initialize context with a provided 8-byte vector basis  (64-bit)
 ******************************************************************/
int FNV64initBasis( FNV64context * const ctx,
                    const uint8_t basis[FNV64size] ) {
    int     i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV64size; ++i )
        ((uint8_t *)&ctx->Hash)[i] = basis[i];
    ctx->Computed = FNVinited+FNV64state;
    return fnvSuccess;
}       /* end FNV64initBasis */

/* hash in a counted block  (64-bit)
 ******************************************************************/
int FNV64blockin( FNV64context * const ctx,
                   const void *vin,
                   long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint64_t    temp;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV64state:
            ctx->Computed = FNVcomputed+FNV64state;
            break;
        case FNVcomputed+FNV64state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( temp = ctx->Hash; length > 0; length-- )
        temp = FNV64prime * ( temp ^ *in++ );
    ctx->Hash = temp;
    return fnvSuccess;
}   /* end FNV64blockin */

/* hash in a zero-terminated string not including the zero (64-bit)
 ******************************************************************/
int FNV64stringin ( FNV64context * const ctx, const char *in ) {
    uint64_t        temp;
    uint8_t         ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV64state:
            ctx->Computed = FNVcomputed+FNV64state;
            break;
        case FNVcomputed+FNV64state:
            break;
        default:
             return fnvStateError;
         }
    temp = ctx->Hash;
    while ( (ch = (uint8_t)*in++) )
        temp = FNV64prime * ( temp ^ ch );
    ctx->Hash = temp;
    return fnvSuccess;
}   /* end FNV64stringin */

/* return hash as 64-bit int (64-bit)
 ******************************************************************/
int FNV64INTresult ( FNV64context * const ctx,
                     uint64_t * const out ) {
    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV64state )
        return fnvStateError;
    ctx->Computed = FNVemptied+FNV64state;
    *out = ctx->Hash;
    ctx->Hash = 0;
    return fnvSuccess;
}   /* end FNV64INTresult */

/* return hash as 8-byte vector (64-bit)
 ******************************************************************/
int FNV64result ( FNV64context * const ctx,
                 uint8_t out[FNV64size] ) {
    int     i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV64state )
        return fnvStateError;
    ctx->Computed = FNVemptied+FNV64state;
    for ( i=0; i<FNV64size; ++i )
        out[i] = ((uint8_t *)&ctx->Hash)[i];
    ctx->Hash = 0;
    return fnvSuccess;
}   /* end FNV64result */

/* hash the contents of a file, return 64-bit integer
 ******************************************************************/
int FNV64INTfile ( const char *fname,
                         uint64_t * const out ) {
    FILE *fp;
    long int i;
    char buf[1024];
    FNV64context e64Context;
    int error;

    if ( !fname || !out )
        return fnvNull;
    if ( ( fp = fopen ( fname, "rb") ) == NULL )
        return fnvBadParam;
    if ( (error = FNV64init (&e64Context)) ) {
        fclose(fp);
        return error;
    }
    if ( (error = FNV64blockin ( &e64Context, "", 0)) ) {
        fclose(fp);
        return error;
    }
    while ( ( i = fread ( buf, 1, sizeof(buf), fp ) ) > 0 )
        if ( (error = FNV64blockin ( &e64Context, buf, i)) ) {
            fclose(fp);
            return error;
        }
    error = ferror(fp);
    fclose(fp);
    if (error)
        return fnvBadParam;
    return FNV64INTresult ( &e64Context, out );
}   /* end FNV64INTfile */

/* hash the contents of a file, return 64-bit integer
 ******************************************************************/
int FNV64file ( const char *fname,
               uint8_t out[FNV64size] ) {
    uint64_t outINT;
    int i, err;

    if ( !out )
        return fnvNull;
    if ( (err = FNV64INTfile ( fname, &outINT)) )
        return err;
    for ( i=0; i<FNV64size; ++i )
        out[i] = ((uint8_t *)&outINT)[i];
    return fnvSuccess;
}   /* emd FNV64file */

//***************************************************************
// END VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//***************************************************************
#else    /*  FNV_64bitIntegers */
//***************************************************************
// START VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//***************************************************************

/* 64-bit FNV_prime = 2^40 + 2^8 + 0xb3 */
/* #define FNV64prime 0x00000100000001B3 */
#define FNV64primeX 0x01B3
#define FNV64shift 8

/* #define FNV64basis 0xCBF29CE484222325 */
#define FNV64basis0 0xCBF2
#define FNV64basis1 0x9CE4
#define FNV64basis2 0x8422
#define FNV64basis3 0x2325

/* FNV64 hash a zero-terminated string not including the zero
 ******************************************************************/
int FNV64string ( const char *in, uint8_t out[FNV64size] ) {
    FNV64context     ctx;
    int              err;

    if ( !in || !out )
        return fnvNull; /* Null input pointer */
    if ( ( err = FNV64init (&ctx) ) != fnvSuccess )
        return err;
    if ( ( err = FNV64stringin (&ctx, in) ) != fnvSuccess )
        return err;
    return FNV64result (&ctx, out);
}   /* end FNV64string */

/* FNV64 hash a counted block
 ******************************************************************/
int FNV64block ( const void *vin,
                 long int length,
                 uint8_t out[FNV64size] ) {
    FNV64context     ctx;
    int              err;

    if ( ( err = FNV64init (&ctx) ) != fnvSuccess )
        return err;
    if ( ( err = FNV64blockin (&ctx, vin, length) ) != fnvSuccess )
        return err;
    return FNV64result (&ctx, out);
}   /* end FNV64block */

//*****************************************************************
//        Set of init, input, and output functions below
//        to incrementally compute FNV64
//*****************************************************************

/* initialize context  (32-bit)
 ******************************************************************/
int FNV64init ( FNV64context * const ctx ) {
    if ( !ctx )
        return fnvNull;
    ctx->Hash[0] = FNV64basis0;
    ctx->Hash[1] = FNV64basis1;
    ctx->Hash[2] = FNV64basis2;
    ctx->Hash[3] = FNV64basis3;
    ctx->Computed = FNVinited+FNV64state;
    return fnvSuccess;
}   /* end FNV64init */

/* initialize context  (32-bit)
 ******************************************************************/
int FNV64initBasis ( FNV64context * const ctx,
                     const uint8_t basis[FNV64size] ) {
    if ( !ctx )
        return fnvNull;
    ctx->Hash[0] = basis[0] + ( basis[1]<<8 );
    ctx->Hash[1] = basis[2] + ( basis[3]<<8 );
    ctx->Hash[2] = basis[4] + ( basis[5]<<8 );
    ctx->Hash[3] = basis[6] + ( basis[7]<<8 );
    ctx->Computed = FNVinited+FNV64state;
    return fnvSuccess;
}   /* end FNV64initBasis */

/* hash in a counted block  (32-bit)
 ******************************************************************/
int FNV64blockin ( FNV64context * const ctx,
                   const void *vin,
                   long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t   temp[FNV64size/2];
    uint32_t   temp2[2];
    int        i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV64state:
            ctx->Computed = FNVcomputed+FNV64state;
            break;
        case FNVcomputed+FNV64state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV64size/2; ++i )
         temp[i] = ctx->Hash[i];
    for ( ; length > 0; length-- ) {
        /* temp = FNV64prime * ( temp ^ *in++ ); */
        temp[3] ^= *in++;
        temp2[1] = temp[3] << FNV64shift;
        temp2[0] = temp[2] << FNV64shift;
        temp[3] *= FNV64primeX;
        temp[2] *= FNV64primeX;
        temp[1] *= FNV64primeX;
        temp[0] *= FNV64primeX;
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        temp[2] += temp[3] >> 16;
        temp[1] += temp[2] >> 16;
        temp[0] += temp[1] >> 16;
        temp[3] &= 0xFFFF;
        temp[2] &= 0xFFFF;
        temp[1] &= 0xFFFF;
        }
    for ( i=0; i<FNV64size/2; ++i )
        ctx->Hash[i] = temp[i];
    return fnvSuccess;
}   /* end FNV64blockin */

/* hash in a zero-terminated string not including the zero  (32-bit)
 ******************************************************************/
int FNV64stringin ( FNV64context * const ctx, const char *in ) {
    uint32_t   temp[FNV64size/2];
    uint32_t   temp2[2];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV64state:
            ctx->Computed = FNVcomputed+FNV64state;
            break;
        case FNVcomputed+FNV64state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV64size/2; ++i )
         temp[i] = ctx->Hash[i];
    while ( ( ch = (uint8_t)*in++ ) ) {
        /* temp = FNV64prime * ( temp ^ ch ); */
        temp[3] ^= ch;
        temp2[1] = temp[3] << FNV64shift;
        temp2[0] = temp[2] << FNV64shift;
        temp[3] *= FNV64primeX;
        temp[2] *= FNV64primeX;
        temp[1] *= FNV64primeX;
        temp[0] *= FNV64primeX;
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        temp[2] += temp[3] >> 16;
        temp[1] += temp[2] >> 16;
        temp[0] += temp[1] >> 16;
        temp[3] &= 0xFFFF;
        temp[2] &= 0xFFFF;
        temp[1] &= 0xFFFF;
        }
    for ( i=0; i<FNV64size/2; ++i )
        ctx->Hash[i] = temp[i];
    return fnvSuccess;
}   /* end FNV64stringin */

/* return hash  (32-bit)
 ******************************************************************/
int FNV64result ( FNV64context * const ctx,
                  uint8_t out[FNV64size] ) {
    int    i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV64state )
        return fnvStateError;
    for ( i=0; i<FNV64size/2; ++i ) {
        out[2*i] = ctx->Hash[i] >> 8;
        out[2*i+1] = ctx->Hash[i];
        ctx -> Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV64state;
    return fnvSuccess;
}   /* end FNV64result */

/* hash the contents of a file  (32-bit)
 ******************************************************************/
int FNV64file ( const char *fname,
                      uint8_t out[FNV64size] ) {
    FILE    *fp;
    long int i;
    char buf[1024];
    FNV64context e64Context;
    int error;

    if ( !fname || !out )
        return fnvNull;
    if ( ( fp = fopen ( fname, "rb") ) == NULL )
        return fnvBadParam;
    if ( (error = FNV64init (&e64Context)) ) {
        fclose(fp);
        return error;
    }
    if ( (error = FNV64blockin ( &e64Context, "", 0)) ) {
        fclose(fp);
        return error;
    }
    while ( ( i = fread ( buf, 1, sizeof(buf), fp ) ) > 0 )
        if ( (error = FNV64blockin ( &e64Context, buf, i)) ) {
            fclose(fp);
            return error;
        }
    error = ferror(fp);
    fclose(fp);
    if (error)
        return fnvBadParam;
    return FNV64result ( &e64Context, out );
}   /* end FNV64file */

#endif    /*  FNV_64bitIntegers */
//*****************************************************************
// END VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//*****************************************************************
]]></sourcecode>


</section>

<section>
  <name>FNV128 Code</name>

<t>The header and C source for 128-bit FNV-1a providing a byte
vector hash.</t>


<sourcecode type="C" markers="true" name="FNV128.h">
<![CDATA[
//************************** FNV128.h ************************//
//*************** See RFC NNNN for details. ******************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNV128_H_
#define _FNV128_H_

/*
 *  Description:
 *      This file provides headers for the 128-bit version of
 *      the FNV-1a non-cryptographic hash algorithm.
 */

#include "FNVconfig.h"
#include "FNVErrorCodes.h"

#include <stdint.h>
#define FNV128size (128/8)

/* If you do not have the ISO standard stdint.h header file, then
 * you must typedef the following types:
 *
 *    type              meaning
 *  uint64_t    unsigned 64-bit integer (ifdef FNV_64bitIntegers)
 *  uint32_t    unsigned 32-bit integer
 *  uint16_t    unsigned 16-bit integer
 *  uint8_t     unsigned 8-bit integer (i.e., unsigned char)
 */

/*
 *  This structure holds context information for an FNV128 hash
 */
#ifdef FNV_64bitIntegers
    /* version if 64-bit integers supported */
typedef struct FNV128context_s {
        int Computed;  /* state */
        uint32_t Hash[FNV128size/4];
} FNV128context;

#else
    /* version if 64-bit integers NOT supported */

typedef struct FNV128context_s {
        int Computed;  /* state */
        uint16_t Hash[FNV128size/2];
} FNV128context;

#endif /* FNV_64bitIntegers */

/*
 *  Function Prototypes:
 *
 *    FNV128string: hash a zero-terminated string not including
 *                  the terminating zero
 *    FNV128block: hash a specified length byte vector
 *    FNV128file: hash the contents of a file
 *
 *    FNV128init: initializes an FNV128 context
 *    FNV128initBasis: initializes an FNV128 context with a
 *                     provided 16-byte vector basis
 *    FNV128blockin: hash in a specified length byte vector
 *    FNV128stringin: hash in a zero-terminated string not
 *                    including the terminating zero
 *    FNV128result: returns the hash value
 *
 *    Hash is returned as an array of 8-bit unsigned integers
 */

#ifdef __cplusplus
extern "C" {
#endif

/* FNV128 */
extern int FNV128string ( const char *in,
                          uint8_t out[FNV128size] );
extern int FNV128block ( const void *vin,
                         long int length,
                         uint8_t out[FNV128size] );
extern int FNV128file ( const char *fname,
                        uint8_t out[FNV128size] );
extern int FNV128init ( FNV128context * const );
extern int FNV128initBasis ( FNV128context * const,
                             const uint8_t basis[FNV128size] );
extern int FNV128blockin ( FNV128context * const,
                           const void *vin,
                           long int length );
extern int FNV128stringin ( FNV128context * const,
                            const char *in );
extern int FNV128result ( FNV128context * const,
                          uint8_t out[FNV128size] );

#ifdef __cplusplus
}
#endif

#endif /* _FNV128_H_ */
]]></sourcecode>


<sourcecode type="C" markers="true" name="FNV128.c">
<![CDATA[
//**************************** FNV128.c **************************//
//******************* See RFC NNNN for details *******************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

/* This file implements the FNV (Fowler, Noll, Vo) non-cryptographic
 * hash function FNV-1a for 128-bit hashes.
 */

#include <stdio.h>

#include "FNVconfig.h"
#include "fnv-private.h"
#include "FNV128.h"

//*****************************************************************
// COMMON CODE FOR 64- AND 32-BIT INTEGER MODES
//*****************************************************************

/* FNV128 hash a zero-terminated string not including the zero
 ******************************************************************/
int FNV128string ( const char *in, uint8_t out[FNV128size] ) {
    FNV128context    ctx;
    int              err;

    if ( (err = FNV128init ( &ctx )) != fnvSuccess )
        return err;
    if ( (err = FNV128stringin ( &ctx, in )) != fnvSuccess )
        return err;
    return FNV128result (&ctx, out);
}   /* end FNV128string */

/* FNV128 hash a counted block  (64/32-bit)
 ******************************************************************/
int FNV128block ( const void *vin,
                  long int length,
                  uint8_t out[FNV128size] ) {
    FNV128context    ctx;
    int              err;

    if ( (err = FNV128init ( &ctx )) != fnvSuccess )
        return err;
    if ( (err = FNV128blockin ( &ctx, vin, length )) != fnvSuccess )
        return err;
    return FNV128result ( &ctx, out );
}   /* end FNV128block */

/* hash the contents of a file
 ******************************************************************/
int FNV128file ( const char *fname,
                       uint8_t out[FNV128size] ) {
    FILE *fp;
    long int i;
    char buf[1024];
    FNV128context e128Context;
    int error;

    if ( !fname || !out )
        return fnvNull;
    if ( ( fp = fopen ( fname, "rb") ) == NULL )
        return fnvBadParam;
    if ( (error = FNV128init (&e128Context)) ) {
        fclose(fp);
        return error;
    }
    if ( (error = FNV128blockin ( &e128Context, "", 0)) ) {
        fclose(fp);
        return error;
    }
    while ( ( i = fread ( buf, 1, sizeof(buf), fp ) ) > 0 )
        if ( (error = FNV128blockin ( &e128Context, buf, i)) ) {
            fclose(fp);
            return error;
        }
    error = ferror(fp);
    fclose(fp);
    if (error)
        return fnvBadParam;
    return FNV128result ( &e128Context, out );
}   /* end FNV128file */

//*****************************************************************
//        START VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//*****************************************************************
#ifdef FNV_64bitIntegers

/* 128-bit FNV_prime = 2^88 + 2^8 + 0x3b */
/* 0x00000000 01000000 00000000 0000013B */
#define FNV128primeX 0x013B
#define FNV128shift 24

/* 0x6C62272E 07BB0142 62B82175 6295C58D */
#define FNV128basis0 0x6C62272E
#define FNV128basis1 0x07BB0142
#define FNV128basis2 0x62B82175
#define FNV128basis3 0x6295C58D

//*****************************************************************
//         Set of init, input, and output functions below
//         to incrementally compute FNV128
//*****************************************************************/

/* initialize context  (64-bit)
 ******************************************************************/
int FNV128init ( FNV128context * const ctx ) {
    if ( !ctx )
        return fnvNull;
    ctx->Hash[0] = FNV128basis0;
    ctx->Hash[1] = FNV128basis1;
    ctx->Hash[2] = FNV128basis2;
    ctx->Hash[3] = FNV128basis3;
    ctx->Computed = FNVinited+FNV128state;
    return fnvSuccess;
}   /* end FNV128init */

/* initialize context with a provided 16-byte vector basis  (64-bit)
 ******************************************************************/
int FNV128initBasis ( FNV128context * const ctx,
                      const uint8_t basis[FNV128size] ) {
    int       i;
    const uint8_t   *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + ( FNV128size/4 - 1 );
    for ( i=0; i < FNV128size/4; ++i ) {
            uint32_t  temp = (*ui8p--)<<8;
            temp = (temp + *ui8p--)<<8;
            temp = (temp + *ui8p--)<<8;
        ctx->Hash[i] = temp +  *ui8p;
        }
    ctx->Computed = FNVinited+FNV128state;
    return fnvSuccess;
}   /* end FNV128initBasis */

/* hash in a counted block  (64-bit)
 ******************************************************************/
int FNV128blockin ( FNV128context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint64_t    temp[FNV128size/4];
    uint64_t    temp2[2];
    int         i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV128state:
            ctx->Computed = FNVcomputed+FNV128state;
            break;
        case FNVcomputed+FNV128state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV128size/4; ++i )
         temp[i] = ctx->Hash[i];
    for ( ; length > 0; length-- ) {
        /* temp = FNV128prime * ( temp ^ *in++ ); */
        temp[FNV128size/4-1] ^= *in++;
        temp2[1] = temp[3] << FNV128shift;
        temp2[0] = temp[2] << FNV128shift;
        for ( i=0; i < FNV128size/4; ++i )
            temp[i] *= FNV128primeX;
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        temp[2] += temp[3] >> 32;
        temp[1] += temp[2] >> 32;
        temp[0] += temp[1] >> 32;
        temp[3] &= 0xFFFFFFFF;
        temp[2] &= 0xFFFFFFFF;
        temp[1] &= 0xFFFFFFFF;
        }
    for ( i=0; i<FNV128size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];
    return fnvSuccess;
}   /* end FNV128blockin */

/* hash in a zero-terminated string not including the zero  (64-bit)
 ******************************************************************/
int FNV128stringin ( FNV128context * const ctx, const char *in ) {
    uint64_t   temp[FNV128size/4];
    uint64_t   temp2[2];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV128state:
            ctx->Computed = FNVcomputed+FNV128state;
            break;
        case FNVcomputed+FNV128state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV128size/4; ++i )
         temp[i] = ctx->Hash[i];
    while ( ( ch = (uint8_t)*in++ ) ) {
        /* temp = FNV128prime * ( temp ^ ch ); */
        temp[3] ^= ch;
        temp2[1] = temp[3] << FNV128shift;
        temp2[0] = temp[2] << FNV128shift;
        for ( i=0; i < FNV128size/4; ++i )
            temp[i] *= FNV128primeX;
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        temp[2] += temp[3] >> 32;
        temp[1] += temp[2] >> 32;
        temp[0] += temp[1] >> 32;
        temp[3] &= 0xFFFFFFFF;
        temp[2] &= 0xFFFFFFFF;
        temp[1] &= 0xFFFFFFFF;
        }
    for ( i=0; i<FNV128size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];
    return fnvSuccess;
}   /* end FNV128stringin */

/* return hash as 16-byte vector   (64-bit)
 ******************************************************************/
int FNV128result ( FNV128context * const ctx,
                   uint8_t out[FNV128size] ) {
    int     i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV128state )
        return fnvStateError;
    for ( i=0; i<FNV128size/4; ++i ) {
        out[4*i] = ctx->Hash[i] >> 24;
        out[4*i+1] = ctx->Hash[i] >> 16;
        out[4*i+2] = ctx->Hash[i] >> 8;
        out[4*i+3] = ctx->Hash[i];
        ctx -> Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV128state;
    return fnvSuccess;
}   /* end FNV128result */

//****************************************************************
// END VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//****************************************************************
#else    /*  FNV_64bitIntegers */
//****************************************************************
// START VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//****************************************************************

/* 128-bit FNV_prime = 2^88 + 2^8 + 0x3b */
/* 0x00000000 01000000 00000000 0000013B */
#define FNV128primeX 0x013B
#define FNV128shift 8

/* 0x6C62272E 07BB0142 62B82175 6295C58D */
uint16_t FNV128basis[FNV128size/2] =
         { 0x6C62, 0x272E, 0x07BB, 0x0142,
           0x62B8, 0x2175, 0x6295, 0xC58D };

//*****************************************************************
//         Set of init, input, and output functions below
//         to incrementally compute FNV128
//*****************************************************************

/* initialize context  (32-bit)
 ******************************************************************/
int FNV128init ( FNV128context * const ctx ) {
    int     i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV128size/2; ++i )
        ctx->Hash[i] = FNV128basis[i];
    ctx->Computed = FNVinited+FNV128state;
    return fnvSuccess;
}   /* end FNV128init */

/* initialize context with a provided 16-byte vector basis  (32-bit)
 ******************************************************************/
int FNV128initBasis ( FNV128context * const ctx,
                      const uint8_t basis[FNV128size] ) {
    int      i;
    const uint8_t  *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + (FNV128size/2 - 1);
    for ( i=0; i < FNV128size/2; ++i ) {
        uint32_t temp = *ui8p--;
        ctx->Hash[i] = ( temp<<8 ) +  (*ui8p--);
        }
    ctx->Computed = FNVinited+FNV128state;
    return fnvSuccess;
}   /* end FNV128initBasis */

/* hash in a counted block  (32-bit)
 *****************************************************************/
int FNV128blockin ( FNV128context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t   temp[FNV128size/2];
    uint32_t   temp2[3];
    int        i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV128state:
            ctx->Computed = FNVcomputed+FNV128state;
            break;
        case FNVcomputed+FNV128state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i < FNV128size/2; ++i )
         temp[i] = ctx->Hash[i];
    for ( ; length > 0; length-- ) {
        /* temp = FNV128prime * ( temp ^ *in++ ); */
        temp[FNV128size/2-1] ^= *in++;
        temp2[2] = temp[7] << FNV128shift;
        temp2[1] = temp[6] << FNV128shift;
        temp2[0] = temp[5] << FNV128shift;
        for ( i=0; i < (FNV128size/2); ++i )
            temp[i] *= FNV128primeX;
        temp[2] += temp2[2];
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        for ( i=FNV128size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16;
            temp[i] &= 0xFFFF;
            }
        }
    for ( i=0; i < FNV128size/2; ++i )
        ctx->Hash[i] = temp[i];
    return fnvSuccess;
}   /* end FNV128blockin */

/* hash in a zero-terminated string not including the zero  (32-bit)
 ******************************************************************/
int FNV128stringin ( FNV128context * const ctx, const char *in ) {
    uint32_t   temp[FNV128size/2];
    uint32_t   temp2[3];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV128state:
            ctx->Computed = FNVcomputed+FNV128state;
            break;
        case FNVcomputed+FNV128state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i < FNV128size/2; ++i )
         temp[i] = ctx->Hash[i];
    while ( ( ch = (uint8_t)*in++ ) ) {
        /* temp = FNV128prime * ( temp ^ *in++ ); */
        temp[FNV128size/2-1] ^= ch;
        temp2[2] = temp[7] << FNV128shift;
        temp2[1] = temp[6] << FNV128shift;
        temp2[0] = temp[5] << FNV128shift;
        for ( i=0; i<(FNV128size/2); ++i )
            temp[i] *= FNV128primeX;
        temp[2] += temp2[2];
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        for ( i=FNV128size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16;
            temp[i] &= 0xFFFF;
            }
         }
    for ( i=0; i < FNV128size/2; ++i )
        ctx->Hash[i] = temp[i];
    return fnvSuccess;
}   /* end FNV128stringin */

/* return hash  (32-bit)
 ******************************************************************/
int FNV128result ( FNV128context * const ctx,
                   uint8_t out[FNV128size] ) {
    int    i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV128state )
        return fnvStateError;
    for ( i=0; i<FNV128size/2; ++i ) {
        out[2*i] = ctx->Hash[i] >> 8;
        out[2*i+1] = ctx->Hash[i];
        ctx -> Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV128state;
    return fnvSuccess;
}   /* end FNV128result */

#endif    /*  FNV_64bitIntegers */
//******************************************************************
//        END VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//******************************************************************
]]></sourcecode>

</section>

<section>
  <name>FNV256 Code</name>

<t>The header and C source for 256-bit FNV-1a providing a byte
vector hash.</t>

<sourcecode type="C" markers="true" name="FNV256.h">
<![CDATA[
//************************* FNV256.h ***********************//
//************** See RFC NNNN for details. *****************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNV256_H_
#define _FNV256_H_

/*
 *  Description:
 *      This file provides headers for the 256-bit version of
 *      the FNV-1a non-cryptographic hash algorithm.
 */

#include "FNVconfig.h"
#include "FNVErrorCodes.h"

#include <stdint.h>
#define FNV256size (256/8)

/* If you do not have the ISO standard stdint.h header file, then
 * you must typedef the following types:
 *
 *    type              meaning
 *  uint64_t    unsigned 64-bit integer (ifdef FNV_64bitIntegers)
 *  uint32_t    unsigned 32-bit integer
 *  uint16_t    unsigned 16-bit integer
 *  uint8_t     unsigned 8-bit integer (i.e., unsigned char)
 */

/*
 *  This structure holds context information for an FNV256 hash
 */
#ifdef FNV_64bitIntegers
    /* version if 64-bit integers supported */
typedef struct FNV256context_s {
        int Computed;  /* state */
        uint32_t Hash[FNV256size/4];
} FNV256context;

#else
    /* version if 64-bit integers NOT supported */

typedef struct FNV256context_s {
        int Computed;  /* state */
        uint16_t Hash[FNV256size/2];
} FNV256context;

#endif /* FNV_64bitIntegers */

/*
 *  Function Prototypes:
 *
 *    FNV256string: hash a zero-terminated string not including
 *                  the terminating zero
 *    FNV256block: hash a specified length byte vector
 *    FNV256file: hash the contents of a file
 *
 *    FNV256init: initializes an FNV256 context
 *    FNV256initBasis:  initializes an FNV256 context with a
 *                     provided 32-byte vector basis
 *    FNV256blockin: hash in a specified length byte vector
 *    FNV256stringin: hash in a zero-terminated string not
 *                    including the terminating zero
 *    FNV256result: returns the hash value
 *
 *    Hash is returned as an array of 8-bit unsigned integers
 */

#ifdef __cplusplus
extern "C" {
#endif

/* FNV256 */
extern int FNV256string ( const char *in,
                          uint8_t out[FNV256size] );
extern int FNV256block ( const void *vin,
                         long int length,
                         uint8_t out[FNV256size] );
extern int FNV256file ( const char *fname,
                        uint8_t out[FNV256size] );
extern int FNV256init ( FNV256context * const );
extern int FNV256initBasis ( FNV256context * const,
                             const uint8_t basis[FNV256size] );
extern int FNV256blockin ( FNV256context * const,
                           const void *vin,
                           long int length );
extern int FNV256stringin ( FNV256context * const,
                            const char *in );
extern int FNV256result ( FNV256context * const,
                          uint8_t out[FNV256size] );

#ifdef __cplusplus
}
#endif

#endif /* _FNV256_H_ */
]]></sourcecode>


<sourcecode type="C" markers="true" name="FNV256.c">
<![CDATA[
//**************************** FNV256.c **************************//
//******************* See RFC NNNN for details *******************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

/* This file implements the FNV (Fowler, Noll, Vo) non-cryptographic
 * hash function FNV-1a for 256-bit hashes.
 */

#include <stdio.h>

#include "fnv-private.h"
#include "FNV256.h"

//*****************************************************************
//  COMMON CODE FOR 64- AND 32-BIT INTEGER MODES
//*****************************************************************

/* FNV256 hash a zero-terminated string not including the zero
 ******************************************************************/
int FNV256string ( const char *in, uint8_t out[FNV256size] ) {
    FNV256context    ctx;
    int              err;

    if ( (err = FNV256init ( &ctx )) != fnvSuccess )
        return err;
    if ( (err = FNV256stringin ( &ctx, in )) != fnvSuccess )
        return err;
    return FNV256result ( &ctx, out );
}   /* end FNV256string */

/* FNV256 hash a counted block  (64/32-bit)
 ******************************************************************/
int FNV256block ( const void *vin,
                  long int length,
                  uint8_t out[FNV256size] ) {
    FNV256context    ctx;
    int              err;

    if ( (err = FNV256init ( &ctx )) != fnvSuccess )
        return err;
    if ( (err = FNV256blockin ( &ctx, vin, length)) != fnvSuccess )
        return err;
    return FNV256result ( &ctx, out );
}   /* end FNV256block */

/* hash the contents of a file
 ******************************************************************/
int FNV256file ( const char *fname,
                        uint8_t out[FNV256size] ) {
    FILE *fp;
    long int i;
    char buf[1024];
    FNV256context e256Context;
    int error;

    if ( !fname || !out )
        return fnvNull;
    if ( ( fp = fopen ( fname, "rb") ) == NULL )
        return fnvBadParam;
    if ( (error=FNV256init (&e256Context)) ) {
        fclose(fp);
        return error;
    }
    if ( (error = FNV256blockin ( &e256Context, "", 0)) ) {
        fclose(fp);
        return error;
    }
    while ( ( i = fread ( buf, 1, sizeof(buf), fp ) ) > 0 )
        if ( (error = FNV256blockin ( &e256Context, buf, i)) ) {
            fclose(fp);
            return error;
        }
    error = ferror(fp);
    fclose(fp);
    if (error)
        return fnvBadParam;
    return FNV256result ( &e256Context, out );
}   /* end FNV256file */

//*****************************************************************
//        START VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//*****************************************************************
#ifdef FNV_64bitIntegers

/* 256-bit FNV_prime = 2^168 + 2^8 + 0x63 */
/* 0x0000000000000000 0000010000000000
     0000000000000000 0000000000000163 */
#define FNV256primeX 0x0163
#define FNV256shift 8

uint32_t FNV256basis[FNV256size/4] = {
         0xDD268DBC, 0xAAC55036, 0x2D98C384, 0xC4E576CC,
         0xC8B15368, 0x47B6BBB3, 0x1023B4C8, 0xCAEE0535 };

//*****************************************************************
//         Set of init, input, and output functions below
//         to incrementally compute FNV256
//*****************************************************************

/* initialize context  (64-bit)
 ******************************************************************/
int FNV256init ( FNV256context * const ctx ) {
    int      i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV256size/4; ++i )
        ctx->Hash[i] = FNV256basis[i];
    ctx->Computed = FNVinited+FNV256state;
    return fnvSuccess;
}   /* end FNV256init */

/* initialize context with a provided 32-byte vector basis  (64-bit)
 ******************************************************************/
int FNV256initBasis ( FNV256context * const ctx,
                      const uint8_t basis[FNV256size] ) {
    int      i;
    const uint8_t  *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + (FNV256size/4 - 1);
    for ( i=0; i < FNV256size/4; ++i ) {
        uint32_t  temp = (*ui8p--)<<8;
        temp = (temp + *ui8p--)<<8;
        temp = (temp + *ui8p--)<<8;
        ctx->Hash[i] = temp +  *ui8p;
        }
    ctx->Computed = FNVinited+FNV256state;
    return fnvSuccess;
}   /* end FNV256initBasis */

/* hash in a counted block  (64-bit)
 ******************************************************************/
int FNV256blockin ( FNV256context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint64_t    temp[FNV256size/4];
    uint64_t    temp2[3];
    int         i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV256state:
            ctx->Computed = FNVcomputed+FNV256state;
            break;
        case FNVcomputed+FNV256state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV256size/4; ++i )
         temp[i] = ctx->Hash[i];
    for ( ; length > 0; length-- ) {
        /* temp = FNV256prime * ( temp ^ *in++ ); */
        temp[FNV256size/4-1] ^= *in++;
        temp2[2] = temp[7] << FNV256shift;
        temp2[1] = temp[6] << FNV256shift;
        temp2[0] = temp[5] << FNV256shift;
        for ( i=0; i < FNV256size/4; ++i )
            temp[i] *= FNV256primeX;
        temp[2] += temp2[2];
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        for ( i=FNV256size/4-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 32;
            temp[i] &= 0xFFFFFFFF;
            }
       }
    for ( i=0; i<FNV256size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];
    return fnvSuccess;
}   /* end FNV256blockin */

/* hash in a zero-terminated string not including the zero  (64-bit)
 ******************************************************************/
int FNV256stringin ( FNV256context * const ctx, const char *in ) {
    uint64_t   temp[FNV256size/4];
    uint64_t   temp2[3];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV256state:
            ctx->Computed = FNVcomputed+FNV256state;
            break;
        case FNVcomputed+FNV256state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV256size/4; ++i )
         temp[i] = ctx->Hash[i];
    while ( (ch = (uint8_t)*in++) ) {
        /* temp = FNV256prime * ( temp ^ ch ); */
        temp[FNV256size/4-1] ^= ch;
        temp2[2] = temp[7] << FNV256shift;
        temp2[1] = temp[6] << FNV256shift;
        temp2[0] = temp[5] << FNV256shift;
        for ( i=0; i<FNV256size/4; ++i )
            temp[i] *= FNV256primeX;
        temp[2] += temp2[2];
        temp[1] += temp2[1];
        temp[0] += temp2[0];
        for ( i=FNV256size/4-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 32;
            temp[i] &= 0xFFFFFFFF;
            }
       }
    for ( i=0; i<FNV256size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];
    return fnvSuccess;
}   /* end FNV256stringin */

/* return hash as 8-byte vector  (64-bit)
 ******************************************************************/
int FNV256result ( FNV256context * const ctx,
                   uint8_t out[FNV256size] ) {
    int     i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV256state )
        return fnvStateError;
    for ( i=0; i<FNV256size/4; ++i ) {
        out[4*i] = ctx->Hash[i] >> 24;
        out[4*i+1] = ctx->Hash[i] >> 16;
        out[4*i+2] = ctx->Hash[i] >> 8;
        out[4*i+3] = ctx->Hash[i];
        ctx -> Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV256state;
    return fnvSuccess;
}   /* end FNV256result */

//****************************************************************
//       END VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//****************************************************************
#else    /*  FNV_64bitIntegers */
//****************************************************************
//       START VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//****************************************************************

/* version for when you only have 32-bit arithmetic
 *****************************************************************/

/* 256-bit FNV_prime = 2^168 + 2^8 + 0x63 */
/* 0x00000000 00000000 00000100 00000000
     00000000 00000000 00000000 00000163 */
#define FNV256primeX 0x0163
#define FNV256shift 8

/* 0xDD268DBCAAC55036 2D98C384C4E576CC
     C8B1536847B6BBB3 1023B4C8CAEE0535 */
uint16_t FNV256basis[FNV256size/2] = {
         0xDD26, 0x8DBC, 0xAAC5, 0x5036,
         0x2D98, 0xC384, 0xC4E5, 0x76CC,
         0xC8B1, 0x5368, 0x47B6, 0xBBB3,
         0x1023, 0xB4C8, 0xCAEE, 0x0535 };

//****************************************************************
//       Set of init, input, and output functions below
//       to incrementally compute FNV256
//****************************************************************

/* initialize context  (32-bit)
 *****************************************************************/
int FNV256init ( FNV256context * const ctx ) {
    int     i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV256size/2; ++i )
        ctx->Hash[i] = FNV256basis[i];
    ctx->Computed = FNVinited+FNV256state;
    return fnvSuccess;
}   /* end FNV256init */

/* initialize context with a provided 32-byte vector basis  (32-bit)
 *****************************************************************/
int FNV256initBasis ( FNV256context * const ctx,
                      const uint8_t basis[FNV256size] ) {
    int      i;
    const uint8_t  *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + FNV256size/2 -1;
    for ( i=0; i < FNV256size/2; ++i ) {
        uint32_t temp = *ui8p--;
        ctx->Hash[i] = ( temp<<8 ) +  (*ui8p--);
        }
    ctx->Computed = FNVinited+FNV256state;
    return fnvSuccess;
}   /* end FNV256initBasis */

/* hash in a counted block  (32-bit)
 *****************************************************************/
int FNV256blockin ( FNV256context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t   temp[FNV256size/2];
    uint32_t   temp2[6];
    int        i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV256state:
            ctx->Computed = FNVcomputed+FNV256state;
            break;
        case FNVcomputed+FNV256state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV256size/2; ++i )
        temp[i] = ctx->Hash[i];
    for ( ; length > 0; length-- ) {
        /* temp = FNV256prime * ( temp ^ *in++ ); */
        temp[FNV256size/2-1] ^= *in++;
        for ( i=0; i<6; ++i )
            temp2[5-i] = temp[FNV256size/2-1-i] << FNV256shift;
        for ( i=0; i<FNV256size/2; ++i )
            temp[i] *= FNV256primeX;
        for ( i=0; i<6; ++i )
            temp[i] += temp2[i];
        for ( i=FNV256size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16;
            temp[i] &= 0xFFFF;
            }
        }
    for ( i=0; i<FNV256size/2; ++i )
        ctx->Hash[i] = temp[i];
    return fnvSuccess;
}   /* end FNV256blockin */

/* hash in a zero-terminated string not including the zero  (32-bit)
 *****************************************************************/
int FNV256stringin ( FNV256context * const ctx, const char *in ) {
    uint32_t   temp[FNV256size/2];
    uint32_t   temp2[6];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV256state:
            ctx->Computed = FNVcomputed+FNV256state;
            break;
        case FNVcomputed+FNV256state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV256size/2; ++i )
         temp[i] = ctx->Hash[i];
    while ( ( ch = (uint8_t)*in++ ) ) {
        /* temp = FNV256prime * ( temp ^ *in++ ); */
        temp[FNV256size/2-1] ^= ch;
        for ( i=0; i<6; ++i )
            temp2[5-i] = temp[FNV256size/2-1-i] << FNV256shift;
        for ( i=0; i<FNV256size/2; ++i )
            temp[i] *= FNV256primeX;
        for ( i=0; i<6; ++i )
            temp[i] += temp2[i];
        for ( i=FNV256size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16;
            temp[i] &= 0xFFFF;
            }
         }
    for ( i=0; i<FNV256size/2; ++i )
        ctx->Hash[i] = temp[i];
    return fnvSuccess;
}   /* end FNV256stringin */

/* return hash  (32-bit)
 *****************************************************************/
int FNV256result ( FNV256context * const ctx,
                   uint8_t out[FNV256size] ) {
    int    i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV256state )
        return fnvStateError;
    for ( i=0; i<FNV256size/2; ++i ) {
        out[2*i] = ctx->Hash[i] >> 8;
        out[2*i+1] = ctx->Hash[i];
        ctx->Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV256state;
    return fnvSuccess;
}   /* end FNV256result */

#endif    /*  FNV_64bitIntegers */
//****************************************************************
//        END VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//****************************************************************
]]></sourcecode>

</section>

<section>
  <name>FNV512 Code</name>

<t>The header and C source for 512-bit FNV-1a providing a byte
vector hash.</t>


<sourcecode type="C" markers="true" name="FNV512.h">
<![CDATA[
//************************* FNV512.h ***********************//
//************** See RFC NNNN for details. *****************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNV512_H_
#define _FNV512_H_

/*
 *  Description:
 *      This file provides headers for the 512-bit version of
 *      the FNV-1a non-cryptographic hash algorithm.
 */

#include "FNVconfig.h"
#include "FNVErrorCodes.h"

#include <stdint.h>
#define FNV512size (512/8)

/* If you do not have the ISO standard stdint.h header file, then
 * you must typedef the following types:
 *
 *    type              meaning
 *  uint64_t    unsigned 64-bit integer (ifdef FNV_64bitIntegers)
 *  uint32_t    unsigned 32-bit integer
 *  uint16_t    unsigned 16-bit integer
 *  uint8_t     unsigned 8-bit integer (i.e., unsigned char)
 */

/*
 *  This structure holds context information for an FNV512 hash
 */
#ifdef FNV_64bitIntegers
    /* version if 64-bit integers supported */
typedef struct FNV512context_s {
        int Computed;  /* state */
        uint32_t Hash[FNV512size/4];
} FNV512context;

#else
    /* version if 64-bit integers NOT supported */

typedef struct FNV512context_s {
        int Computed;  /* state */
        uint16_t Hash[FNV512size/2];
} FNV512context;

#endif /* FNV_64bitIntegers */

/*
 *  Function Prototypes:
 *
 *    FNV512string: hash a zero-terminated string not including
 *                  the terminating zero
 *    FNV512block: hash a specified length byte vector
 *    FNV512file: hash the contents of a file
 *
 *    FNV512init: initializes an FNV512 context
 *    FNV512initBasis: initializes an FNV512 context with a
 *                     provided 64-byte vector basis
 *    FNV512blockin: hash in a specified length byte vector
 *    FNV512stringin: hash in a zero-terminated string not
 *                    including the terminating zero
 *    FNV512result: returns the hash value
 *
 *    Hash is returned as an array of 8-bit unsigned integers
 */

#ifdef __cplusplus
extern "C" {
#endif

/* FNV512 */
extern int FNV512string ( const char *in,
                          uint8_t out[FNV512size] );
extern int FNV512block ( const void *vin,
                         long int length,
                         uint8_t out[FNV512size] );
extern int FNV512file ( const char *fname,
                        uint8_t out[FNV512size] );
extern int FNV512init ( FNV512context * const );
extern int FNV512initBasis ( FNV512context * const,
                             const uint8_t basis[FNV512size] );
extern int FNV512blockin ( FNV512context * const,
                           const void *vin,
                           long int length );
extern int FNV512stringin ( FNV512context * const,
                            const char *in );
extern int FNV512result ( FNV512context * const,
                          uint8_t out[FNV512size] );

#ifdef __cplusplus
}
#endif

#endif /* _FNV512_H_ */
]]></sourcecode>


<sourcecode type="C" markers="true" name="FNV512.c">
<![CDATA[
//**************************** FNV512.c **************************//
//******************* See RFC NNNN for details *******************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

/* This file implements the FNV (Fowler, Noll, Vo) non-cryptographic
 * hash function FNV-1a for 512-bit hashes.
 */

#include <stdio.h>

#include "fnv-private.h"
#include "FNV512.h"

//*****************************************************************
//  COMMON CODE FOR 64- AND 32-BIT INTEGER MODES
//*****************************************************************

/* FNV512 hash a zero-terminated string not including the zero
 ******************************************************************/
int FNV512string ( const char *in, uint8_t out[FNV512size] ) {
    FNV512context    ctx;
    int              err;

    if ( (err = FNV512init ( &ctx )) != fnvSuccess )
        return err;
    if ( (err = FNV512stringin ( &ctx, in )) != fnvSuccess )
        return err;
    return FNV512result ( &ctx, out );
}   /* end FNV512string */

/* FNV512 hash a counted block  (64/32-bit)
 ******************************************************************/
int FNV512block ( const void *vin,
                  long int length,
                  uint8_t out[FNV512size] ) {
    FNV512context    ctx;
    int              err;

    if ( (err = FNV512init ( &ctx )) != fnvSuccess )
        return err;
    if ( (err = FNV512blockin ( &ctx, vin, length)) != fnvSuccess )
        return err;
    return FNV512result ( &ctx, out );
}   /* end FNV512block */

/* hash the contents of a file
 ******************************************************************/
int FNV512file ( const char *fname,
                       uint8_t out[FNV512size] ) {
    FILE *fp;
    long int i;
    char buf[1024];
    FNV512context e512Context;
    int error;

    if ( !fname || !out )
        return fnvNull;
    if ( ( fp = fopen ( fname, "rb") ) == NULL )
        return fnvBadParam;
    if ( (error = FNV512init (&e512Context)) ) {
        fclose(fp);
        return error;
    }
    if ( (error = FNV512blockin ( &e512Context, "", 0)) ) {
        fclose(fp);
        return error;
    }
    while ( ( i = fread ( buf, 1, sizeof(buf), fp ) ) > 0 )
        if ( (error=FNV512blockin ( &e512Context, buf, i)) ) {
            fclose(fp);
            return error;
        }
    error = ferror(fp);
    fclose(fp);
    if (error)
        return fnvBadParam;
    return FNV512result ( &e512Context, out );
}   /* end FNV512file */

//*****************************************************************
//        START VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//*****************************************************************
#ifdef FNV_64bitIntegers

/*
  512-bit FNV_prime = 2^344 + 2^8 + 0x57 =
   0x0000000000000000 0000000000000000
     0000000001000000 0000000000000000
     0000000000000000 0000000000000000
     0000000000000000 0000000000000157 */
#define FNV512primeX 0x0157
#define FNV512shift 24

/* 0xB86DB0B1171F4416 DCA1E50F309990AC
     AC87D059C9000000 0000000000000D21
     E948F68A34C192F6 2EA79BC942DBE7CE
     182036415F56E34B AC982AAC4AFE9FD9 */

uint32_t FNV512basis[FNV512size/4] = {
     0xB86DB0B1, 0x171F4416, 0xDCA1E50F, 0x309990AC,
     0xAC87D059, 0xC9000000, 0x00000000, 0x00000D21,
     0xE948F68A, 0x34C192F6, 0x2EA79BC9, 0x42DBE7CE,
     0x18203641, 0x5F56E34B, 0xAC982AAC, 0x4AFE9FD9 };


//*****************************************************************
//         Set of init, input, and output functions below
//         to incrementally compute FNV512
//*****************************************************************

/* initialize context  (64-bit)
 ******************************************************************/
int FNV512init ( FNV512context * const ctx ) {
    int i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV512size/4; ++i )
        ctx->Hash[i] = FNV512basis[i];
    ctx->Computed = FNVinited+FNV512state;
    return fnvSuccess;
}   /* end FNV512init */

/* initialize context with a provided 64-byte vector basis  (64-bit)
 ******************************************************************/
int FNV512initBasis ( FNV512context * const ctx,
                      const uint8_t basis[FNV512size] ) {
    int      i;
    const uint8_t  *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + (FNV512size/4 - 1);
    for ( i=0; i < FNV512size/4; ++i ) {
        uint32_t  temp = (*ui8p--)<<8;
        temp = (temp + *ui8p--)<<8;
        temp = (temp + *ui8p--)<<8;
        ctx->Hash[i] = temp +  *ui8p;
        }
    ctx->Computed = FNVinited+FNV512state;
    return fnvSuccess;
}   /* end FNV512initBasis */

/* hash in a counted block  (64-bit)
 ******************************************************************/
int FNV512blockin ( FNV512context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint64_t    temp[FNV512size/4];
    uint64_t    temp2[6];
    int         i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV512state:
            ctx->Computed = FNVcomputed+FNV512state;
            break;
        case FNVcomputed+FNV512state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV512size/4; ++i )
         temp[i] = ctx->Hash[i];  // copy into temp
    for ( ; length > 0; length-- ) {
        /* temp = FNV512prime * ( temp ^ *in++ ); */
        temp[FNV512size/4-1] ^= *in++;
        for ( i=0; i<6; ++i )
            temp2[5-i] = temp[FNV512size/4-1-i] << FNV512shift;
        for ( i=0; i<FNV512size/4; ++i )
            temp[i] *= FNV512primeX;
        for ( i=0; i<6; ++i )
            temp[i] += temp2[i];
        for ( i=FNV512size/4-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 32; // propagate carries
            temp[i] &= 0xFFFFFFFF;
            }
       }   /* end for length */
    for ( i=0; i<FNV512size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV512blockin */

/* hash in a zero-terminated string not including the zero  (64-bit)
 ******************************************************************/
int FNV512stringin ( FNV512context * const ctx, const char *in ) {
    uint64_t   temp[FNV512size/4];
    uint64_t   temp2[6];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV512state:
            ctx->Computed = FNVcomputed+FNV512state;
            break;
        case FNVcomputed+FNV512state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV512size/4; ++i )
         temp[i] = ctx->Hash[i];  // copy into temp
    while ( (ch = (uint8_t)*in++) ) {
        /* temp = FNV512prime * ( temp ^ ch ); */
        temp[FNV512size/4-1] ^= ch;
        for ( i=0; i<6; ++i )
            temp2[5-i] = temp[FNV512size/4-1-i] << FNV512shift;
        for ( i=0; i<FNV512size/4; ++i )
            temp[i] *= FNV512primeX;
        for ( i=0; i<6; ++i )
            temp[i] += temp2[i];
        for ( i=FNV512size/4-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 32; // propagate carries
            temp[i] &= 0xFFFFFFFF;
            }
       }
    for ( i=0; i<FNV512size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV512stringin */

/* return hash  (64-bit)
 ******************************************************************/
int FNV512result ( FNV512context * const ctx,
                   uint8_t out[FNV512size] ) {
    int i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV512state )
        return fnvStateError;
    for ( i=0; i<FNV512size/4; ++i ) {
        out[4*i] = ctx->Hash[i] >> 24;
        out[4*i+1] = ctx->Hash[i] >> 16;
        out[4*i+2] = ctx->Hash[i] >> 8;
        out[4*i+3] = ctx->Hash[i];
        ctx -> Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV512state;
    return fnvSuccess;
}   /* end FNV512result */

//*****************************************************************
//        END VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//*****************************************************************
#else    /*  FNV_64bitIntegers */
//*****************************************************************
//      START VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//*****************************************************************

/*
  512-bit FNV_prime = 2^344 + 2^8 + 0x57 =
   0x00000000 00000000 00000000 00000000
     00000000 01000000 00000000 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000000 00000157 */
#define FNV512primeX 0x0157
#define FNV512shift 8

/* 0xB86DB0B1 171F4416 DCA1E50F 309990AC
     AC87D059 C9000000 00000000 00000D21
     E948F68A 34C192F6 2EA79BC9 42DBE7CE
     18203641 5F56E34B AC982AAC 4AFE9FD9 */

uint16_t FNV512basis[FNV512size/2] = {
     0xB86D, 0xB0B1, 0x171F, 0x4416, 0xDCA1, 0xE50F, 0x3099, 0x90AC,
     0xAC87, 0xD059, 0xC900, 0x0000, 0x0000, 0x0000, 0x0000, 0x0D21,
     0xE948, 0xF68A, 0x34C1, 0x92F6, 0x2EA7, 0x9BC9, 0x42DB, 0xE7CE,
     0x1820, 0x3641, 0x5F56, 0xE34B, 0xAC98, 0x2AAC, 0x4AFE, 0x9FD9
     };


//*****************************************************************
//         Set of init, input, and output functions below
//         to incrementally compute FNV512
//*****************************************************************

/* initialize context  (32-bit)
 ******************************************************************/
int FNV512init ( FNV512context * const ctx ) {
    int     i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV512size/2; ++i )
        ctx->Hash[i] = FNV512basis[i];
    ctx->Computed = FNVinited+FNV512state;
    return fnvSuccess;
}   /* end FNV512init */

/* initialize context with a provided 64-byte vector basis  (32-bit)
 ******************************************************************/
int FNV512initBasis ( FNV512context * const ctx,
                      const uint8_t basis[FNV512size] ) {
    int      i;
    const uint8_t  *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + ( FNV512size/2 - 1 );
    for ( i=0; i < FNV512size/2; ++i ) {
        uint32_t temp = *ui8p--;
        ctx->Hash[i] = ( temp<<8 ) + (*ui8p--);
        }
    ctx->Computed = FNVinited+FNV512state;
    return fnvSuccess;
}   /* end FNV512initBasis */

/* hash in a counted block  (32-bit)
 ******************************************************************/
int FNV512blockin ( FNV512context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t   temp[FNV512size/2];
    uint32_t   temp2[11];
    int        i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV512state:
            ctx->Computed = FNVcomputed+FNV512state;
            break;
        case FNVcomputed+FNV512state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV512size/2; ++i )
        temp[i] = ctx->Hash[i];  // copy into temp
    for ( ; length > 0; length-- ) {
        /* temp = FNV512prime * ( temp ^ *in++ ); */
        temp[FNV512size/2-1] ^= *in++;
        for ( i=0; i<11; ++i )
            temp2[10-i] = temp[FNV512size/2-1-i] << FNV512shift;
        for ( i=0; i<FNV512size/2; ++i )
            temp[i] *= FNV512primeX;
        for ( i=0; i<11; ++i )
            temp[i] += temp2[i];
        for ( i=FNV512size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16; // propagate carries
            temp[i] &= 0xFFFF;
            }
        }   /* end for length */
    for ( i=0; i<FNV512size/2; ++i )
        ctx->Hash[i] = (uint16_t)temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV512blockin */

/* hash in a zero-terminated string not including the zero  (32-bit)
 ******************************************************************/
int FNV512stringin ( FNV512context * const ctx, const char *in ) {
    uint32_t   temp[FNV512size/2];
    uint32_t   temp2[11];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV512state:
            ctx->Computed = FNVcomputed+FNV512state;
            break;
        case FNVcomputed+FNV512state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV512size/2; ++i )
         temp[i] = ctx->Hash[i];  // copy into temp
    while ( (ch = (uint8_t)*in++) ) {
        /* temp = FNV512prime * ( temp ^ *in++ ); */
        temp[FNV512size/2-1] ^= ch;
        for ( i=0; i<11; ++i )
            temp2[10-i] = temp[FNV512size/2-1-i] << FNV512shift;
        for ( i=0; i<FNV512size/2; ++i )
            temp[i] *= FNV512primeX;
        for ( i=0; i<11; ++i )
            temp[i] += temp2[i];
        for ( i=FNV512size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16; // propagate carries
            temp[i] &= 0xFFFF;
            }
         }
    for ( i=0; i<FNV512size/2; ++i )
        ctx->Hash[i] = temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV512stringin */

/* return hash  (32-bit)
 ******************************************************************/
int FNV512result ( FNV512context * const ctx,
                   uint8_t out[FNV512size] ) {
    int    i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV512state )
        return fnvStateError;
    for ( i=0; i<FNV512size/2; ++i ) {
        out[2*i] = ctx->Hash[i] >> 8;
        out[2*i+1] = ctx->Hash[i];
        ctx->Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV512state;
    return fnvSuccess;
}   /* end FNV512result */

#endif    /*  FNV_64bitIntegers */
//*****************************************************************
//        END VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//*****************************************************************
]]></sourcecode>

</section>

<section>
  <name>FNV1024 Code</name>

<t>The header and C source for 1024-bit FNV-1a providing a byte
vector hash.</t>


<sourcecode type="C" markers="true" name="FNV1024.h">
<![CDATA[
//*********************** FNV1024.h ***********************//
//************* See RFC NNNN for details. *****************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#ifndef _FNV1024_H_
#define _FNV1024_H_

/*
 *  Description:
 *      This file provides headers for the 1024-bit version of
 *      the FNV-1a non-cryptographic hash algorithm.
 */

#include "FNVconfig.h"
#include "FNVErrorCodes.h"

#include <stdint.h>
#define FNV1024size (1024/8)

/* If you do not have the ISO standard stdint.h header file, then
 * you must typedef the following types:
 *
 *    type              meaning
 *  uint64_t    unsigned 64-bit integer (ifdef FNV_64bitIntegers)
 *  uint32_t    unsigned 32-bit integer
 *  uint16_t    unsigned 16-bit integer
 *  uint8_t     unsigned 8-bit integer (i.e., unsigned char)
 */

/*
 *  This structure holds context information for an FNV1024 hash
 */
#ifdef FNV_64bitIntegers
    /* version if 64-bit integers supported */
typedef struct FNV1024context_s {
        int Computed;  /* state */
        uint32_t Hash[FNV1024size/4];
} FNV1024context;

#else
    /* version if 64-bit integers NOT supported */

typedef struct FNV1024context_s {
        int Computed;  /* state */
        uint16_t Hash[FNV1024size/2];
} FNV1024context;

#endif /* FNV_64bitIntegers */

/*
 *  Function Prototypes:
 *
 *    FNV1024string: hash a zero-terminated string not including
 *                   the terminating zero
 *    FNV1024block: hash a specified length byte vector
 *    FNV1024file: hash the contents of a file
 *
 *    FNV1024init: initializes an FNV1024 context
 *    FNV1024initBasis: initializes an FNV1024 context with a
 *                      provided 128-byte vector basis
 *    FNV1024blockin: hash in a specified length byte vector
 *    FNV1024stringin: hash in a zero-terminated string not
 *                     including the terminating zero
 *    FNV1024result: returns the hash value
 *
 *    Hash is returned as an array of 8-bit unsigned integers
 */

#ifdef __cplusplus
extern "C" {
#endif

/* FNV1024 */
extern int FNV1024string ( const char *in,
                           uint8_t out[FNV1024size] );
extern int FNV1024block ( const void *vin,
                          long int length,
                          uint8_t out[FNV1024size] );
extern int FNV1024file ( const char *fname,
                         uint8_t out[FNV1024size] );
extern int FNV1024init ( FNV1024context * const );
extern int FNV1024initBasis ( FNV1024context * const,
                              const uint8_t basis[FNV1024size] );
extern int FNV1024blockin ( FNV1024context * const,
                            const void *vin,
                            long int length );
extern int FNV1024stringin ( FNV1024context * const,
                            const char *in );
extern int FNV1024result ( FNV1024context * const,
                           uint8_t out[FNV1024size] );

#ifdef __cplusplus
}
#endif

#endif /* _FNV1024_H_ */
]]></sourcecode>


<sourcecode type="C" markers="true" name="FNV1024.c">
<![CDATA[
//************************** FNV1024.c **************************//
//****************** See RFC NNNN for details *******************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

/* This file implements the FNV (Fowler, Noll, Vo) non-cryptographic
 * hash function FNV-1a for 1024-bit hashes.
 */

#include <stdio.h>

#include "fnv-private.h"
#include "FNV1024.h"

//*****************************************************************
//  COMMON CODE FOR 64- AND 32-BIT INTEGER MODES
//*****************************************************************

/* FNV1024 hash a zero-terminated string not including the zero
 ******************************************************************/
int FNV1024string ( const char *in, uint8_t out[FNV1024size] ) {
    FNV1024context    ctx;
    int              err;

    if ( (err = FNV1024init ( &ctx )) != fnvSuccess)
        return err;
    if ( (err = FNV1024stringin ( &ctx, in )) != fnvSuccess)
        return err;
    return FNV1024result ( &ctx, out );
}   /* end FNV1024string */

/* FNV1024 hash a counted block  (64/32-bit)
 ******************************************************************/
int FNV1024block ( const void *vin,
                  long int length,
                  uint8_t out[FNV1024size] ) {
    FNV1024context   ctx;
    int              err;

    if ( (err = FNV1024init ( &ctx )) != fnvSuccess)
        return err;
    if ( (err = FNV1024blockin ( &ctx, vin, length)) != fnvSuccess)
        return err;
    return FNV1024result ( &ctx, out );
}   /* end FNV1024block */


/* hash the contents of a file
 ******************************************************************/
int FNV1024file ( const char *fname,
                        uint8_t out[FNV1024size] ) {
    FILE *fp;
    long int i;
    char buf[1024];
    FNV1024context e1024Context;
    int error;

    if ( !fname || !out )
        return fnvNull;
    if ( ( fp = fopen ( fname, "rb") ) == NULL )
        return fnvBadParam;
    if ( (error = FNV1024init (&e1024Context)) ) {
        fclose(fp);
        return error;
    }
    if ( (error = FNV1024blockin ( &e1024Context, "", 0)) ) {
        fclose(fp);
        return error;
    }
    while ( ( i = fread ( buf, 1, sizeof(buf), fp ) ) > 0 )
        if ( (error = FNV1024blockin ( &e1024Context, buf, i)) ) {
            fclose(fp);
            return error;
        }
    error = ferror(fp);
    fclose(fp);
    if (error)
        return fnvBadParam;
    return FNV1024result ( &e1024Context, out );
}   /* end FNV1024file */

//****************************************************************//
// START VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//****************************************************************//
#ifdef FNV_64bitIntegers

/*
 1024-bit FNV_prime = 2^680 + 2^8 + 0x8d =
   0x0000000000000000 0000000000000000
     0000000000000000 0000000000000000
     0000000000000000 0000010000000000
     0000000000000000 0000000000000000
     0000000000000000 0000000000000000
     0000000000000000 0000000000000000
     0000000000000000 0000000000000000
     0000000000000000 000000000000018D */
#define FNV1024primeX 0x018D
#define FNV1024shift 8

/* 0x0000000000000000 005F7A76758ECC4D
     32E56D5A591028B7 4B29FC4223FDADA1
     6C3BF34EDA3674DA 9A21D90000000000
     0000000000000000 0000000000000000
     0000000000000000 0000000000000000
     0000000000000000 000000000004C6D7
     EB6E73802734510A 555F256CC005AE55
     6BDE8CC9C6A93B21 AFF4B16C71EE90B3 */

uint32_t FNV1024basis[FNV1024size/4] = {
  0x00000000, 0x00000000, 0x005F7A76, 0x758ECC4D,
  0x32E56D5A, 0x591028B7, 0x4B29FC42, 0x23FDADA1,
  0x6C3BF34E, 0xDA3674DA, 0x9A21D900, 0x00000000,
  0x00000000, 0x00000000, 0x00000000, 0x00000000,
  0x00000000, 0x00000000, 0x00000000, 0x00000000,
  0x00000000, 0x00000000, 0x00000000, 0x0004C6D7,
  0xEB6E7380, 0x2734510A, 0x555F256C, 0xC005AE55,
  0x6BDE8CC9, 0xC6A93B21, 0xAFF4B16C, 0x71EE90B3
 };


//***************************************************************//
//         Set of init, input, and output functions below
//         to incrementally compute FNV1024
//**************************************************************//

/* initialize context  (64-bit)
 ******************************************************************/
int FNV1024init ( FNV1024context * const ctx ) {
    int i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV1024size/4; ++i )
        ctx->Hash[i] = FNV1024basis[i];
    ctx->Computed = FNVinited+FNV1024state;
    return fnvSuccess;
}   /* end FNV1024init */

/* initialize context with a provided 128-byte vector basis  (64-bit)
 ******************************************************************/
int FNV1024initBasis ( FNV1024context * const ctx,
                       const uint8_t basis[FNV1024size] ) {
    int            i;
    const uint8_t  *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + (FNV1024size/4 - 1);
    for ( i=0; i < FNV1024size/4; ++i ) {
            uint32_t temp = (*ui8p--)<<8;
            temp = (temp + *ui8p--)<<8;
            temp = (temp + *ui8p--)<<8;
            ctx->Hash[i] = temp +  *ui8p;
        }
    ctx->Computed = FNVinited+FNV1024state;
    return fnvSuccess;
}   /* end FNV1024initBasis */

/* hash in a counted block  (64-bit)
 ******************************************************************/
int FNV1024blockin ( FNV1024context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint64_t    temp[FNV1024size/4];
    uint64_t    temp2[11];
    int         i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV1024state:
            ctx->Computed = FNVcomputed+FNV1024state;
            break;
        case FNVcomputed+FNV1024state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV1024size/4; ++i )
         temp[i] = ctx->Hash[i];  // copy into temp
    for ( ; length > 0; length-- ) {
        /* temp = FNV1024prime * ( temp ^ *in++ ); */
        temp[FNV1024size/4-1] ^= *in++;
        for ( i=0; i<11; ++i )
            temp2[10-i] = temp[FNV1024size/4-1-i] << FNV1024shift;
        for ( i=0; i<FNV1024size/4; ++i )
            temp[i] *= FNV1024primeX;
        for ( i=0; i<11; ++i )
            temp[i] += temp2[i];
        for ( i=FNV1024size/4-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 32;  // propagate carries
            temp[i] &= 0xFFFFFFFF;
            }
       }   /* end for length */
    for ( i=0; i<FNV1024size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV1024blockin */

/* hash in a zero-terminated string not including the zero  (64-bit)
 ******************************************************************/
int FNV1024stringin ( FNV1024context * const ctx, const char *in ) {
    uint64_t   temp[FNV1024size/4];
    uint64_t   temp2[11];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV1024state:
            ctx->Computed = FNVcomputed+FNV1024state;
            break;
        case FNVcomputed+FNV1024state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV1024size/4; ++i )
         temp[i] = ctx->Hash[i];  // copy into temp
    while ( (ch = (uint8_t)*in++) ) {
        /* temp = FNV1024prime * ( temp ^ ch ); */
        temp[FNV1024size/4-1] ^= ch;
        for ( i=0; i<11; ++i )
            temp2[10-i] = temp[FNV1024size/4-1-i] << FNV1024shift;
        for ( i=0; i<FNV1024size/4; ++i )
            temp[i] *= FNV1024primeX;
        for ( i=0; i<11; ++i )
                temp[i] += temp2[i];
        for ( i=FNV1024size/4-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 32;
            temp[i] &= 0xFFFFFFFF;
            }
       }
    for ( i=0; i<FNV1024size/4; ++i )
        ctx->Hash[i] = (uint32_t)temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV1024stringin */

/* return hash  (64-bit)
 ******************************************************************/
int FNV1024result ( FNV1024context * const ctx,
                    uint8_t out[FNV1024size] ) {
    int i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV1024state )
        return fnvStateError;
    for ( i=0; i<FNV1024size/4; ++i ) {
        out[4*i] = ctx->Hash[i] >> 24;
        out[4*i+1] = ctx->Hash[i] >> 16;
        out[4*i+2] = ctx->Hash[i] >> 8;
        out[4*i+3] = ctx->Hash[i];
        ctx -> Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV1024state;
    return fnvSuccess;
}   /* end FNV1024result */

//****************************************************************//
//        END VERSION FOR WHEN YOU HAVE 64-BIT ARITHMETIC
//***************************************************************//
#else    /*  FNV_64bitIntegers */
//***************************************************************//
//      START VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//***************************************************************//

/* version for when you only have 32-bit arithmetic
 ******************************************************************/

/*
 1024-bit FNV_prime = 2^680 + 2^8 + 0x8d =
   0x00000000 00000000 00000000 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000100 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000000 0000018D */
#define FNV1024primeX 0x018D
#define FNV1024shift 8

/* 0x00000000 00000000 005F7A767 58ECC4D
     32E56D5A 591028B7 4B29FC42 23FDADA1
     6C3BF34E DA3674DA 9A21D900 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000000 00000000
     00000000 00000000 00000000 0004C6D7
     EB6E7380 2734510A 555F256C C005AE55
     6BDE8CC9 C6A93B21 AFF4B16C 71EE90B3 */

uint16_t FNV1024basis[FNV1024size/2] = {
  0x0000, 0x0000, 0x0000, 0x0000, 0x005F, 0x7A76, 0x758E, 0xCC4D,
  0x32E5, 0x6D5A, 0x5910, 0x28B7, 0x4B29, 0xFC42, 0x23FD, 0xADA1,
  0x6C3B, 0xF34E, 0xDA36, 0x74DA, 0x9A21, 0xD900, 0x0000, 0x0000,
  0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000,
  0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000,
  0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0004, 0xC6D7,
  0xEB6E, 0x7380, 0x2734, 0x510A, 0x555F, 0x256C, 0xC005, 0xAE55,
  0x6BDE, 0x8CC9, 0xC6A9, 0x3B21, 0xAFF4, 0xB16C, 0x71EE, 0x90B3
};


//*****************************************************************
//         Set of init, input, and output functions below
//         to incrementally compute FNV1024
//*****************************************************************

/* initialize context  (32-bit)
 ******************************************************************/
int FNV1024init ( FNV1024context * const ctx ) {
    int     i;

    if ( !ctx )
        return fnvNull;
    for ( i=0; i<FNV1024size/2; ++i )
        ctx->Hash[i] = FNV1024basis[i];
    ctx->Computed = FNVinited+FNV1024state;
    return fnvSuccess;
}   /* end FNV1024init */

/* initialize context with a provided 128-byte vector basis  (32-bit)
 ******************************************************************/
int FNV1024initBasis ( FNV1024context * const ctx,
                       const uint8_t basis[FNV1024size] ) {
    int      i;
    const uint8_t  *ui8p;

    if ( !ctx )
        return fnvNull;
    ui8p = basis + ( FNV1024size/2 - 1 );
    for ( i=0; i < FNV1024size/2; ++i ) {
        uint32_t temp = *ui8p--;
        ctx->Hash[i] = ( temp<<8 ) + (*ui8p--);
        }
    ctx->Computed = FNVinited+FNV1024state;
    return fnvSuccess;
}   /* end FNV1024initBasis */

/* hash in a counted block  (32-bit)
 ******************************************************************/
int FNV1024blockin ( FNV1024context * const ctx,
                    const void *vin,
                    long int length ) {
    const uint8_t *in = (const uint8_t*)vin;
    uint32_t   temp[FNV1024size/2];
    uint32_t   temp2[22];
    int        i;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV1024state:
            ctx->Computed = FNVcomputed+FNV1024state;
            break;
        case FNVcomputed+FNV1024state:
            break;
        default:
            return fnvStateError;
        }
    if ( length < 0 )
        return fnvBadParam;
    for ( i=0; i<FNV1024size/2; ++i )
        temp[i] = ctx->Hash[i];  // copy into temp
    for ( ; length > 0; length-- ) {
        /* temp = FNV1024prime * ( temp ^ *in++ ); */
        temp[FNV1024size/2-1] ^= *in++;
        for ( i=0; i<22; ++i )
            temp2[21-i] = temp[FNV1024size/2-1-i] << FNV1024shift;
        for ( i=0; i<FNV1024size/2; ++i )
            temp[i] *= FNV1024primeX;
        for ( i=0; i<22; ++i )
            temp[i] += temp2[i];
        for ( i=FNV1024size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16; // propagate carries
            temp[i] &= 0xFFFF;
            }
        }
    for ( i=0; i<FNV1024size/2; ++i )
        ctx->Hash[i] = temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV1024blockin */

/* hash in a zero-terminated string not including the zero  (32-bit)
 ******************************************************************/
int FNV1024stringin ( FNV1024context * const ctx, const char *in ) {
    uint32_t   temp[FNV1024size/2];
    uint32_t   temp2[22];
    int        i;
    uint8_t    ch;

    if ( !ctx || !in )
        return fnvNull;
    switch ( ctx->Computed ) {
        case FNVinited+FNV1024state:
            ctx->Computed = FNVcomputed+FNV1024state;
            break;
        case FNVcomputed+FNV1024state:
            break;
        default:
             return fnvStateError;
         }
    for ( i=0; i<FNV1024size/2; ++i )
         temp[i] = ctx->Hash[i];  // copy into temp
    while ( (ch = (uint8_t)*in++) ) {
        /* temp = FNV1024prime * ( temp ^ *in++ ); */
        temp[FNV1024size/2-1] ^= ch;
        for ( i=0; i<22; ++i )
            temp2[21-i] = temp[FNV1024size/2-1-i] << FNV1024shift;
        for ( i=0; i<FNV1024size/2; ++i )
            temp[i] *= FNV1024primeX;
        for ( i=0; i<22; ++i )
             temp[i] += temp2[i];
        for ( i=FNV1024size/2-1; i>0; --i ) {
            temp[i-1] += temp[i] >> 16; // propagate carries
            temp[i] &= 0xFFFF;
            }
         }
    for ( i=0; i<FNV1024size/2; ++i )
        ctx->Hash[i] = temp[i];  // store back into hash
    return fnvSuccess;
}   /* end FNV1024stringin */

/* return hash  (32-bit)
 ******************************************************************/
int FNV1024result ( FNV1024context * const ctx,
                    uint8_t out[FNV1024size] ) {
    int    i;

    if ( !ctx || !out )
        return fnvNull;
    if ( ctx->Computed != FNVcomputed+FNV1024state )
        return fnvStateError;
    for ( i=0; i<FNV1024size/2; ++i ) {
        out[2*i] = ctx->Hash[i] >> 8;
        out[2*i+1] = ctx->Hash[i];
        ctx->Hash[i] = 0;
        }
    ctx->Computed = FNVemptied+FNV1024state;
    return fnvSuccess;
}   /* end FNV1024result */

#endif    /*  FNV_64bitIntegers */
//****************************************************************//
//        END VERSION FOR WHEN YOU ONLY HAVE 32-BIT ARITHMETIC
//****************************************************************//
]]></sourcecode>

</section>

</section>

<section>  <!-- 6.3 -->
  <name>FNV Test Code</name>

<t>Below is source code for a test driver with a command line
interface documented in Section 6.1.3. By default, with no command
line arugments, it runs tests of all FNV lengths.</t>


<sourcecode type="C" markers="true" name="main.c">
<![CDATA[
//************************* Main.c **************************//
//*************** See RFC NNNN for details. *****************//
/* Copyright (c) 2016, 2024 IETF Trust and the persons
 * identified as authors of the code.  All rights reserved.
 * See fnv-private.h for terms of use and redistribution.
 */

#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <unistd.h>
#include <errno.h>

/* To do a thorough test you need to run with
 * FNV_64bitIntegers defined and with it undefined
 */
#include "FNVconfig.h"

#include "fnv-private.h"
#include "FNV32.h"
#include "FNV64.h"
#include "FNV128.h"
#include "FNV256.h"
#include "FNV512.h"
#include "FNV1024.h"

/* global variables */
char    *funcName = "funcName not set?";
char    *errteststring = "foo";
int     Terr = -1; /* Total errors */
int     verbose = 0; /* verbose flag */
enum { FNV32selected = 0, FNV64selected, FNV128selected,
       FNV256selected, FNV512selected, FNV1024selected,
       FNVnone = -1 } selected = FNVnone;
#define NTestBytes 3
uint8_t errtestbytes[NTestBytes] = { (uint8_t)1,
    (uint8_t)2, (uint8_t)3 };
char    *teststring[] = {
        "",
        "a",
        "foobar",
        "Hello!\x01\xFF\xED"
};
#define NTstrings (sizeof(teststring)/sizeof(char *))

FNV32context    e32Context;
uint32_t        eUint32 = 42;
#ifdef FNV_64bitIntegers
uint64_t        eUint64 = 42;
#endif
FNV64context    e64Context;
FNV128context   e128Context;
FNV256context   e256Context;
FNV512context   e512Context;
FNV1024context  e1024Context;
uint8_t hash[FNV1024size];  /* largest size needed */
char             tempFileNameTemplate[] = "tmp.XXXXXXXXXX";
const char      *tempFileName = 0;


//****************************************************************
// local prototypes in alphabetic order
//****************************************************************
void CommonTest ( void );
void ErrTestReport ( void );
int find_selected(const char *optarg);
void HexPrint ( int count, const uint8_t *ptr );
void TestAll ( void );
void Test32 ( void );
void Test64 ( void );
void Test128 ( void );
void Test256 ( void );
void Test512 ( void );
void Test1024 ( void );
void TestNValue ( const char *subfunc,  // test calculated value
                  const char *string,
                  int N,  // size
                  const uint8_t *was,
                  const uint8_t should[N] );
int TestR ( const char *,
            int expect,
            int actual ); // test return code
void usage( const char *argv0 ); // print help message
void ValueTestReport ( void );      // print test results

#ifndef FNV_64bitIntegers
# undef uint64
# define uint64_t no_64_bit_integers
#endif /* FNV_64bitIntegers */

struct {    // indexed into by the enum variable "selected"
    int length;
    void (*Testfunc)( void );
    int (*Stringfunc)( const char *, uint8_t *);
    int (*Blockfunc)( const void *, long int, uint8_t *);
    int (*Filefunc)( const char *, uint8_t *);
} funcmap[] = {  // valid sizes
    { 32, Test32, FNV32string, FNV32block, FNV32file },
    { 64, Test64, FNV64string, FNV64block, FNV64file },
    { 128, Test128, FNV128string, FNV128block, FNV128file },
    { 256, Test256, FNV256string, FNV256block, FNV256file },
    { 512, Test512, FNV512string, FNV512block, FNV512file },
    { 1024, Test1024, FNV1024string, FNV1024block, FNV1024file },
    { 0, Test32, FNV32string, FNV32block }  // fence post
};


//****************************************************************
//  main
//****************************************************************
int main( int argc, const char **argv ) {
    int     i,
    option;  // command line option letter
    uint16_t    endianness = 5*256 + 11;

    mkstemp(tempFileNameTemplate);
    tempFileName = tempFileNameTemplate;

    if ( ((uint8_t *)&endianness)[0] != 11 )
        printf ("Coded for Little Endian but computer seems\n"
                " to be Big Endian! Multi-byte integer results\n"
                " may be incorrect!\n");
    if ( argc == 1 ) {  // if no arguments
        TestAll();
        if ( tempFileName )
            unlink(tempFileName);
        exit(0);
    }

// process command line options
// *****************************************************************
    while ((option = getopt(argc, (char *const *)argv, ":af:ht:u:v"))
           != -1) {
        if ( verbose )
            printf ( "Got option %c\n", option );
        switch ( option ) {
            case 'a':  // run all tests
                TestAll();
                break;
            case 'f':   // followed by name of file to hash
                if ( selected == FNVnone ) {
                    printf ( "No hash size selected.\n" );
                    break;
                }
                printf ( "FNV-%i Hash of contents of file '%s':\n",
                         funcmap[selected].length, optarg );
                switch ( selected ) {
                  case FNV32selected:
                      if (FNV32INTfile( optarg, &eUint32 )
                              == fnvSuccess)
                          HexPrint ( FNV32size,
                                     (uint8_t *)&eUint32 );
                      else
                          printf( "Hashing file '%s' fails: %s.\n",
                                   optarg, strerror(errno) );
                      break;
                  case FNV64selected:
#ifdef FNV_64bitIntegers
                      if (FNV64INTfile( optarg, &eUint64 )
                              == fnvSuccess)
                          HexPrint ( FNV64size,
                                     (uint8_t *)&eUint64 );
#else
                      if ( FNV64file(optarg, hash) == fnvSuccess)
                          HexPrint ( FNV64size, hash );
#endif
                      else
                          printf( "Hashing file '%s' fails: %s.\n",
                                   optarg, strerror(errno) );
                      break;
                  case FNV128selected:
                      if ( FNV128file( optarg, hash ) == fnvSuccess)
                          HexPrint ( FNV128size, hash );
                      else
                          printf( "Hashing file '%s' fails: %s.\n",
                                   optarg, strerror(errno) );
                      break;
                  case FNV256selected:
                      if ( FNV256file( optarg, hash ) == fnvSuccess)
                          HexPrint ( FNV256size, hash );
                      else
                          printf( "Hashing file '%s' fails: %s.\n",
                                   optarg, strerror(errno) );
                      break;
                  case FNV512selected:
                      if ( FNV512file( optarg, hash ) == fnvSuccess)
                          HexPrint ( FNV512size, hash );
                      else
                          printf( "Hashing file '%s' fails: %s.\n",
                                   optarg, strerror(errno) );
                      break;
                  case FNV1024selected:
                      if ( FNV1024file( optarg, hash ) == fnvSuccess)
                          HexPrint ( FNV1024size, hash );
                      else
                          printf( "Hashing file '%s' fails: %s.\n",
                                  optarg, strerror(errno) );
                    break;
                  default:
                    return 1;  // internal error
                }  // end switch funcmap[selected].length
                printf ( "\n" );
                break;
            case 'h':   // help
                usage( argv[0] );
                break;
            case 't':   // follow by size of FNV to test, 0->all
                selected = find_selected(optarg);
                if (selected == FNVnone)
                    printf ( "Bad argument to option -t\n"
                             "Valid sizes are 32, 64, 128,"
                             " 256, 512, and 1024\n");
                else
                    funcmap[selected].Testfunc();   // invoke test
                break;
            case 'u':   // follow by size of FNV to use
                selected = find_selected(optarg);
                if ( selected == FNVnone )
                    printf ( "Bad argument to option -u\n"
                             "Valid sizes are 32, 64, 128,"
                             "256, 512, and 1024\n" );
                break;
            case 'v':   // toggle Verbose flag
                if ( (verbose ^= 1) ) {
                    printf ( "Verbose on.\n" );
#ifdef FNV_64bitIntegers
                    printf ("Has 64-bit Integers. ");
#else
                    printf ("Does not have 64-bit integers. ");
#endif
                    // also tests the TestR function
                    funcName = "Testing TestR";
                    TestR ( "should fail", 1, 2 );
                    TestR ( "should not have failed", 3, 3 );
                }
                else
                    printf ( "Verbose off.\n" );
                break;
            case '?':   //
                printf ( "Unknown option %c\n", optopt );
                usage( argv[0] );
                return 1;
        }  /* end switch */
    }  /* end while */
    if ( ( option == -1 ) && verbose )
        printf ( "No more options.\n" );

// Through all the options, now, if a size is set, encrypt any
//   other tokens on the command line
//******************************************************
    for ( i = optind; i < argc; ++i ) {
        int     rc; // return code

        if ( selected == FNVnone ) {
            printf ( "No hash size selected.\n" );
            break;  // out of for
        }
        rc = funcmap[selected].Stringfunc(argv[i], hash);
        if ( rc )
            printf ( "FNV-%i of '%s' returns error %i\n",
                    funcmap[selected].length,
                    argv[i], rc );
        else {
            printf ( "FNV-%i of '%s' is ",
                    funcmap[selected].length, argv[i] );
            HexPrint ( funcmap[selected].length/8, hash );
            printf ( "\n" );
        }
    }
    if ( tempFileName )
        unlink(tempFileName);
    return 0;
}     /* end main */

/* Write to a temp file
 ******************************************************************/
const char *WriteTemp( const char *str, long int iLen ) {
    FILE *fp = fopen( tempFileName, "w" );
    if (!fp) {
        printf( "Cannot open tempfile: %s: %s\n",
                tempFileName, strerror(errno) );
        return 0;
    }
    long int ret = fwrite( str, 1, iLen, fp );
    fclose(fp);
    if ( ret != iLen ) {
        printf( "Cannot open tempfile: %s: %s\n",
                tempFileName, strerror(errno) );
        return 0;
    }
    return tempFileName;
}

//****************************************************************
//  Test status return code
//****************************************************************
int TestR ( const char *name, int expect, int actual ) {
    if ( expect != actual ) {
        printf ( "%s %s returned %i instead of %i.\n",
                 funcName, name, actual, expect );
        ++Terr;  /* increment  error count */
        }
    return actual;
}    /* end TestR */

//****************************************************************
//  General byte vector return value test
//****************************************************************
void TestNValue ( const char *subfunc,
                  const char *string,
                  int N,
                  const uint8_t was[N],
                  const uint8_t should[N] ) {
    if ( memcmp ( was, should, N) != 0 ) {
        ++Terr;
        printf ( "%s %s of '%s'",
                funcName, subfunc, string );
        printf ( " computed " );
        HexPrint ( N, was );
        printf ( ", expected " );
        HexPrint ( N, should );
        printf ( ".\n" );
    }
    else if ( verbose ) {
        printf ( "%s %s of '%s' computed ",
                funcName, subfunc, string );
        HexPrint ( N, was );
        printf ( " as expected.\n" );
    }
}   /* end TestNValue */

//****************************************************************
//  Report on status/value returns
//****************************************************************
void ErrTestReport ( void ) {
    if ( Terr )
        printf ( "%s test of error checks failed %i times.\n",
                funcName, Terr );
    else if ( verbose )
        printf ( "%s test of error checks passed.\n",
                funcName );
}  /* end ErrTestReport */

void ValueTestReport ( void ) {
    if ( Terr )
        printf ( "%s test of return values failed %i times.\n",
                funcName, Terr );
    else
        printf ( "%s test of return values passed.\n", funcName );
}  /* end ValueTestReport */

//****************************************************************
//  Verify the size of hash as a command line option argument
//    and return the index in funcmap[], -1 if not found.
//****************************************************************
int find_selected(const char *optarg) {
    int argval, count;

    count = sscanf ( optarg, "%i", &argval );
    if ( count > 0 ) {
      int i;
        for ( i = 0; funcmap[i].length; ++i ) {
            if ( funcmap[i].length == argval ) {
                return i;
            }  /* end if */
        }  /* end for */
    }
    return FNVnone;
}   /* end find_selected */

//****************************************************************
//  Print some bytes as hexadecimal
//****************************************************************
void HexPrint( int count, const uint8_t *ptr ) {
    int   i;

    for ( i = 0; i < count; ++i )
        printf ( "%02X", ptr[i] );
}   /* end HexPrint */

//****************************************************************
//  Test all sizes
//****************************************************************
void TestAll ( void ) {
    Test32();
    Test64();
    Test128();
    Test256();
    Test512();
    Test1024();
}   /* end TestAll */

//****************************************************************
//  Common error check tests
//****************************************************************
void CommonTest ( void ) {

    TestR ( "string1b", fnvNull,
        funcmap[selected].Stringfunc ( (char *)0, hash ) );
    TestR ( "string2b", fnvNull,
        funcmap[selected].Stringfunc ( errteststring,
                                      (uint8_t *)0 ) );
    TestR ( "block1b", fnvNull,
        funcmap[selected].Blockfunc ( (uint8_t *)0, 1, hash ) );
    TestR ( "block2b", fnvBadParam,
        funcmap[selected].Blockfunc ( errtestbytes, -1, hash ) );
    TestR ( "block3b", fnvNull,
        funcmap[selected].Blockfunc ( errtestbytes, 1,
                                     (uint8_t *)0 ) );
    TestR ( "file1", fnvNull,
        funcmap[selected].Filefunc ( (char *)0, hash ));
    TestR ( "file2", fnvNull,
        funcmap[selected].Filefunc ( "foo.txt", (uint8_t *)0 ));
}   /* end CommonTest */

//****************************************************************
//  Print command line help
//****************************************************************
void usage( const char *argv0 ) {
    printf (
        "%s [-a] [-t nnn] [-u nnn] [-v] [-f filename] [token ...]\n"
        "  -a = run all tests\n"
        "  -f filename = hash file contents\n"
        "  -h = help, print this message\n"
        "  -t nnn = Test hash size nnn\n"
        "  -u nnn = Use hash size nnn\n"
        "  -v = toggle Verbose flag\n"
        "  Each token is hashed.\n", argv0 );
}   /* end usage */

//****************************************************************
//  FNV32 Test
//****************************************************************
void Test32 ( void ) {
    int         i, err;
    long int    iLen;
    uint32_t    FNV32basisT = FNV32basis;
    uint32_t    FNV32svalues[NTstrings] = {
        0x811c9dc5, 0xe40c292c, 0xbf9cf968, 0xfd9d3881 };
    uint32_t    FNV32bvalues[NTstrings] = {
        0x050c5d1f, 0x2b24d044, 0x0c1c9eb8, 0xbf7ff313 };

    funcName = "FNV-32";
    selected = FNV32selected;
/* test error checks */
    Terr = 0;
    TestR ( "init1", fnvSuccess, FNV32init (&e32Context) );
    CommonTest();
    TestR ( "string1i", fnvNull,
            FNV32INTstring ( (char *)0, &eUint32 ) );
    TestR ( "string2i", fnvNull,
            FNV32INTstring ( errteststring, (uint32_t *)0 ) );
    TestR ( "block1i", fnvNull,
            FNV32INTblock ( (uint8_t *)0, 1, &eUint32 ) );
    TestR ( "block2i", fnvBadParam,
            FNV32INTblock ( errtestbytes, -1, &eUint32 ) );
    TestR ( "block3i", fnvNull,
            FNV32INTblock ( errtestbytes, 1, (uint32_t *)0 ) );
    TestR ( "init2", fnvNull,
            FNV32init ( (FNV32context *)0 ) );
    TestR ( "initBasis1i", fnvNull,
            FNV32INTinitBasis ( (FNV32context *)0, eUint32 ) );
    TestR ( "initBasis1b", fnvNull,
            FNV32initBasis ( (FNV32context *)0, hash ) );
    TestR ( "blockin1", fnvNull,
            FNV32blockin ( (FNV32context *)0,
                           errtestbytes, NTestBytes ) );
    TestR ( "blockin2", fnvNull,
            FNV32blockin ( &e32Context, (uint8_t *)0,
                           NTestBytes ) );
    TestR ( "blockin3", fnvBadParam,
            FNV32blockin ( &e32Context, errtestbytes, -1 ) );
    e32Context.Computed = FNVclobber+FNV32state;
    TestR ( "blockin4", fnvStateError,
            FNV32blockin ( &e32Context, errtestbytes,
                           NTestBytes ) );
    TestR ( "stringin1", fnvNull,
            FNV32stringin ( (FNV32context *)0, errteststring ) );
    TestR ( "stringin2", fnvNull,
            FNV32stringin ( &e32Context, (char *)0 ) );
    TestR ( "stringin3", fnvStateError,
            FNV32stringin ( &e32Context, errteststring ) );
    TestR ( "result1i", fnvNull,
            FNV32INTresult ( (FNV32context *)0, &eUint32 ) );
    TestR ( "result2i", fnvNull,
            FNV32INTresult ( &e32Context, (uint32_t *)0  ) );
    TestR ( "result3i", fnvStateError,
            FNV32INTresult ( &e32Context, &eUint32  ) );
    TestR ( "result1b", fnvNull,
            FNV32result ( (FNV32context *)0, hash ) );
    TestR ( "result2b", fnvNull,
            FNV32result ( &e32Context, (uint8_t *)0  ) );
    TestR ( "result3b", fnvStateError,
            FNV32result ( &e32Context, hash  ) );
    TestR ( "file1i", fnvNull,
            FNV32INTfile ( (char *)0, &eUint32 ));
    TestR ( "file2i", fnvNull,
            FNV32INTfile ( "foo.txt", (uint32_t *)0 ));
    ErrTestReport ();
/* test actual results int */
    Terr = 0;
    for ( i = 0; i < NTstrings; ++i ) {
        err = TestR ( "stringai", fnvSuccess,
                      FNV32INTstring ( teststring[i], &eUint32 ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringbi", teststring[i], FNV32size,
                         (uint8_t *)&eUint32,
                         (uint8_t *)&FNV32svalues[i] );
        err = TestR ( "blockai", fnvSuccess,
                      FNV32INTblock ( (uint8_t *)teststring[i],
                           (unsigned long)(strlen(teststring[i])+1),
                           &eUint32 ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockbi", teststring[i], FNV32size,
                         (uint8_t *)&eUint32,
                         (uint8_t *)&FNV32bvalues[i] );
/* test actual results byte */
        err = TestR ( "stringab", fnvSuccess,
                      FNV32string ( teststring[i], hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringbb", teststring[i], FNV32size,
                         hash, (uint8_t *)&FNV32svalues[i] );
        err = TestR ( "blockab", fnvSuccess,
                      FNV32block ( (uint8_t *)teststring[i],
                           (unsigned long)(strlen(teststring[i])+1),
                           hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockbb", teststring[i], FNV32size,
                         hash, (uint8_t *)&FNV32bvalues[i] );
/* now try testing the incremental stuff int */
        err = TestR ( "inita", fnvSuccess,
                      FNV32init (&e32Context) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockinai", fnvSuccess,
                      FNV32blockin ( &e32Context,
                                     (uint8_t *)teststring[i],
                                     iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringinai", fnvSuccess,
                      FNV32stringin ( &e32Context,
                                    teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resultai", fnvSuccess,
                      FNV32INTresult ( &e32Context, &eUint32 ) );
        if ( err ) break;
        TestNValue ( "incrementalai", teststring[i], FNV32size,
                     (uint8_t *)&eUint32,
                     (uint8_t *)&FNV32svalues[i] );
/* now try testing the incremental stuff byte */
        err = TestR ( "initabb", fnvSuccess,
                      FNV32initBasis (&e32Context,
                                      (uint8_t *)&FNV32basisT) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockinab", fnvSuccess,
                      FNV32blockin ( &e32Context,
                                     (uint8_t *)teststring[i],
                                     iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringinab", fnvSuccess,
                      FNV32stringin ( &e32Context,
                                    teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resultab", fnvSuccess,
                      FNV32result ( &e32Context, hash ) );
        if ( err ) break;
        TestNValue ( "incrementalab", teststring[i], FNV32size,
                     hash, (uint8_t *)&FNV32svalues[i] );

/* now try testing file int */
        err = TestR ( "fileafi", fnvSuccess,
                      FNV32INTfile (
                                    WriteTemp(teststring[i], iLen),
                                    &eUint32 )
                      );
        if ( err ) break;
        TestNValue ( "filebfi", teststring[i], FNV32size,
                         (uint8_t *)&eUint32,
                         (uint8_t *)&FNV32svalues[i] );

/* now try testing file hash */
        err = TestR ( "fileafh", fnvSuccess,
                      FNV32file (
                                 WriteTemp(teststring[i], iLen),
                                 hash )
                      );
        if ( err ) break;
        TestNValue ( "filebfh", teststring[i], FNV32size,
                     hash,
                     (uint8_t *)&FNV32svalues[i] );

    }   // end for i
    ValueTestReport ();
}    /* end Test32 */

#ifdef FNV_64bitIntegers
//****************************************************************
//  Code for testing FNV64 using 64-bit integers
//****************************************************************
void Test64 ( void ) { /* with 64-bit integers */
    int        i, err;
    long int   iLen;
    uint64_t   FNV64basisT = FNV64basis;
    uint64_t   FNV64svalues[NTstrings] = {
        0xcbf29ce484222325, 0xaf63dc4c8601ec8c, 0x85944171f73967e8,
        0xbd51ea7094ee6fa1 };
    uint64_t   FNV64bvalues[NTstrings] = {
        0xaf63bd4c8601b7df, 0x089be207b544f1e4, 0x34531ca7168b8f38,
        0xa0a0fe4d1127ae93 };

    funcName = "FNV-64";
    selected = FNV64selected;
/* test error checks */
    Terr = 0;
    TestR ( "init1", fnvSuccess, FNV64init (&e64Context) );
    CommonTest();
    TestR ( "string1i", fnvNull,
           FNV64INTstring ( (char *)0, &eUint64 ) );
    TestR ( "string2i", fnvNull,
           FNV64INTstring ( errteststring, (uint64_t *)0 ) );
    TestR ( "block1i", fnvNull,
           FNV64INTblock ( (uint8_t *)0, 1, &eUint64 ) );
    TestR ( "block2i", fnvBadParam,
           FNV64INTblock ( errtestbytes, -1, &eUint64 ) );
    TestR ( "block3i", fnvNull,
           FNV64INTblock ( errtestbytes, 1, (uint64_t *)0 ) );
    TestR ( "init2", fnvNull,
           FNV64init ( (FNV64context *)0 ) );
    TestR ( "initBasis1i", fnvNull,
           FNV64INTinitBasis ( (FNV64context *)0, eUint64 ) );
    TestR ( "initBasis1b", fnvNull,
           FNV64initBasis ( (FNV64context *)0, hash ) );
    TestR ( "blockin1", fnvNull,
           FNV64blockin ( (FNV64context *)0,
                         errtestbytes, NTestBytes ) );
    TestR ( "blockin2", fnvNull,
           FNV64blockin ( &e64Context, (uint8_t *)0,
                         NTestBytes ) );
    TestR ( "blockin3", fnvBadParam,
           FNV64blockin ( &e64Context, errtestbytes, -1 ) );
    e64Context.Computed = FNVclobber+FNV64state;
    TestR ( "blockin4", fnvStateError,
           FNV64blockin ( &e64Context, errtestbytes,
                         NTestBytes ) );
    TestR ( "stringin1", fnvNull,
           FNV64stringin ( (FNV64context *)0, errteststring ) );
    TestR ( "stringin2", fnvNull,
           FNV64stringin ( &e64Context, (char *)0 ) );
    TestR ( "stringin3", fnvStateError,
           FNV64stringin ( &e64Context, errteststring ) );
    TestR ( "result1i", fnvNull,
           FNV64INTresult ( (FNV64context *)0, &eUint64 ) );
    TestR ( "result2i", fnvNull,
           FNV64INTresult ( &e64Context, (uint64_t *)0  ) );
    TestR ( "result3i", fnvStateError,
           FNV64INTresult ( &e64Context, &eUint64  ) );
    TestR ( "result1b", fnvNull,
           FNV64INTresult ( (FNV64context *)0, &eUint64 ) );
    TestR ( "result2b", fnvNull,
           FNV64INTresult ( &e64Context, (uint64_t *)0  ) );
    TestR ( "result3b", fnvStateError,
           FNV64INTresult ( &e64Context, &eUint64  ) );
    TestR ( "file1i", fnvNull,
            FNV64INTfile ( (char *)0, &eUint64 ));
    TestR ( "file2i", fnvNull,
            FNV64INTfile ( "foo.txt", (uint64_t *)0 ));
    ErrTestReport ();
/* test actual results int */
    Terr = 0;
    for ( i = 0; i < NTstrings; ++i ) {
        err = TestR ( "stringai", fnvSuccess,
                     FNV64INTstring ( teststring[i], &eUint64 ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringbi", teststring[i], FNV64size,
                        (uint8_t *)&eUint64,
                        (uint8_t *)&FNV64svalues[i] );
        err = TestR ( "blockai", fnvSuccess,
                     FNV64INTblock ( (uint8_t *)teststring[i],
                          (unsigned long)(strlen(teststring[i])+1),
                                    &eUint64 ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockbi", teststring[i], FNV64size,
                        (uint8_t *)&eUint64,
                        (uint8_t *)&FNV64bvalues[i] );
/* test actual results byte */
        err = TestR ( "stringab", fnvSuccess,
                     FNV64string ( teststring[i], hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringbb", teststring[i], FNV64size,
                        hash, (uint8_t *)&FNV64svalues[i] );
        err = TestR ( "blockab", fnvSuccess,
                     FNV64block ( (uint8_t *)teststring[i],
                          (unsigned long)(strlen(teststring[i])+1),
                                 hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockb", teststring[i], FNV64size,
                        hash, (uint8_t *)&FNV64bvalues[i] );
/* now try testing the incremental stuff int */
        err = TestR ( "initai", fnvSuccess,
                     FNV64init (&e64Context) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockinai", fnvSuccess,
                     FNV64blockin ( &e64Context,
                                   (uint8_t *)teststring[i],
                                   iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringinai", fnvSuccess,
                     FNV64stringin ( &e64Context,
                                    teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resultai", fnvSuccess,
                     FNV64INTresult ( &e64Context, &eUint64 ) );
        if ( err ) break;
        TestNValue ( "incrementalai", teststring[i], FNV64size,
                    (uint8_t *)&eUint64,
                    (uint8_t *)&FNV64svalues[i] );
/* now try testing the incremental stuff byte */
        err = TestR ( "initab", fnvSuccess,
                     FNV64initBasis (&e64Context,
                                     (uint8_t *)&FNV64basisT) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockinab", fnvSuccess,
                     FNV64blockin ( &e64Context,
                                   (uint8_t *)teststring[i],
                                   iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringinab", fnvSuccess,
                     FNV64stringin ( &e64Context,
                                    teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resultab", fnvSuccess,
                     FNV64result ( &e64Context, hash ) );
        if ( err ) break;
        TestNValue ( "incrementala", teststring[i], FNV64size,
                    hash, (uint8_t *)&FNV64svalues[i] );

/* now try testing file int */
        err = TestR ( "fileafi", fnvSuccess,
                      FNV64INTfile (
                                    WriteTemp(teststring[i], iLen),
                                    &eUint64 )
                      );
        if ( err ) break;
        TestNValue ( "filebfi", teststring[i], FNV64size,
                         (uint8_t *)&eUint64,
                         (uint8_t *)&FNV64svalues[i] );

/* now try testing file hash */
        err = TestR ( "fileafh", fnvSuccess,
                      FNV64file (
                                 WriteTemp(teststring[i], iLen),
                                 hash )
                      );
        if ( err ) break;
        TestNValue ( "filebfh", teststring[i], FNV64size,
                     hash,
                     (uint8_t *)&FNV64svalues[i] );

    }
    ValueTestReport ();
}   /* end Test64 */

#else

//****************************************************************
//  Code for testing FNV64 without 64-bit integers
//****************************************************************
void Test64 ( void ) { /* without 64-bit integers */
    int    i, err;
    long int   iLen;
    uint8_t   FNV64svalues[NTstrings][FNV64size] = {
        { 0xcb, 0xf2, 0x9c, 0xe4, 0x84, 0x22, 0x23, 0x25 },
        { 0xaf, 0x63, 0xdc, 0x4c, 0x86, 0x01, 0xec, 0x8c },
        { 0x85, 0x94, 0x41, 0x71, 0xf7, 0x39, 0x67, 0xe8 },
        { 0xbd, 0x51, 0xea, 0x70, 0x94, 0xee, 0x6f, 0xa1 } };
    uint8_t   FNV64bvalues[NTstrings][FNV64size] = {
        { 0xaf, 0x63, 0xbd, 0x4c, 0x86, 0x01, 0xb7, 0xdf },
        { 0x08, 0x9b, 0xe2, 0x07, 0xb5, 0x44, 0xf1, 0xe4 },
        { 0x34, 0x53, 0x1c, 0xa7, 0x16, 0x8b, 0x8f, 0x38 },
        { 0xa0, 0xa0, 0xfe, 0x4d, 0x11, 0x27, 0xae, 0x93 } };

    funcName = "FNV-64";
    selected = FNV64selected;
/* test error checks */
    Terr = 0;
    TestR ( "init1", fnvSuccess, FNV64init (&e64Context) );
    CommonTest();
    TestR ( "init2", fnvNull,
            FNV64init ( (FNV64context *)0 ) );
    TestR ( "initBasis1", fnvNull,
            FNV64initBasis ( (FNV64context *)0, hash ) );
    TestR ( "blockin1", fnvNull,
            FNV64blockin ( (FNV64context *)0,
                           errtestbytes, NTestBytes ) );
    TestR ( "blockin2", fnvNull,
            FNV64blockin ( &e64Context, (uint8_t *)0,
                           NTestBytes ) );
    TestR ( "blockin3", fnvBadParam,
            FNV64blockin ( &e64Context, errtestbytes, -1 ) );
    e64Context.Computed = FNVclobber+FNV64state;
    TestR ( "blockin4", fnvStateError,
            FNV64blockin ( &e64Context, errtestbytes,
                           NTestBytes ) );
    TestR ( "stringin1", fnvNull,
            FNV64stringin ( (FNV64context *)0, errteststring ) );
    TestR ( "stringin2", fnvNull,
            FNV64stringin ( &e64Context, (char *)0 ) );
    TestR ( "stringin3", fnvStateError,
            FNV64stringin ( &e64Context, errteststring ) );
    TestR ( "result1", fnvNull,
            FNV64result ( (FNV64context *)0, hash ) );
    TestR ( "result2", fnvNull,
            FNV64result ( &e64Context, (uint8_t *)0  ) );
    TestR ( "result3", fnvStateError,
            FNV64result ( &e64Context, hash ) );
    ErrTestReport ();
/* test actual results */
    Terr = 0;
    for ( i = 0; i < NTstrings; ++i ) {
        err = TestR ( "stringa", fnvSuccess,
                      FNV64string ( teststring[i], hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringb", teststring[i], FNV64size,
                         hash, FNV64svalues[i] );
        err = TestR ( "blocka", fnvSuccess,
                      FNV64block ( (uint8_t *)teststring[i],
                          (unsigned long)(strlen(teststring[i])+1),
                          hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockb", teststring[i], FNV64size,
                         hash,
                         FNV64bvalues[i] );
/* now try testing the incremental stuff */
        err = TestR ( "inita", fnvSuccess,
                      FNV64init ( &e64Context ) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockina", fnvSuccess,
                      FNV64blockin ( &e64Context,
                                     (uint8_t *)teststring[i],
                                     iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringina", fnvSuccess,
                      FNV64stringin ( &e64Context,
                                      teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resulta", fnvSuccess,
                      FNV64result ( &e64Context, hash ) );
        if ( err ) break;
        TestNValue ( "incrementala", teststring[i], FNV64size,
                     hash, (uint8_t *)&FNV64svalues[i] );

/* now try testing file hash */
        err = TestR ( "fileafh", fnvSuccess,
                      FNV64file (
                                 WriteTemp(teststring[i], iLen),
                                 hash )
                      );
        if ( err ) break;
        TestNValue ( "filebfh", teststring[i], FNV64size,
                     hash,
                     (uint8_t *)&FNV64svalues[i] );

    }
    ValueTestReport ();
}   /* end Test64 */
#endif /* FNV_64bitIntegers */

//****************************************************************
//  Code for testing FNV128
//****************************************************************
void Test128 ( void ) {
    int        i, err;
    long int   iLen;
    uint8_t   FNV128svalues[NTstrings][FNV128size] = {
        { 0x6c, 0x62, 0x27, 0x2e, 0x07, 0xbb, 0x01, 0x42,
          0x62, 0xb8, 0x21, 0x75, 0x62, 0x95, 0xc5, 0x8d },
        { 0xd2, 0x28, 0xcb, 0x69, 0x6f, 0x1a, 0x8c, 0xaf,
          0x78, 0x91, 0x2b, 0x70, 0x4e, 0x4a, 0x89, 0x64 },
        { 0x34, 0x3e, 0x16, 0x62, 0x79, 0x3c, 0x64, 0xbf,
          0x6f, 0x0d, 0x35, 0x97, 0xba, 0x44, 0x6f, 0x18 },
        { 0x74, 0x20, 0x2c, 0x60, 0x0b, 0x05, 0x1c, 0x16,
          0x5b, 0x1a, 0xca, 0xfe, 0xd1, 0x0d, 0x14, 0x19 } };
    uint8_t   FNV128bvalues[NTstrings][FNV128size] = {
        { 0xd2, 0x28, 0xcb, 0x69, 0x10, 0x1a, 0x8c, 0xaf,
          0x78, 0x91, 0x2b, 0x70, 0x4e, 0x4a, 0x14, 0x7f },
        { 0x08, 0x80, 0x95, 0x45, 0x19, 0xab, 0x1b, 0xe9,
          0x5a, 0xa0, 0x73, 0x30, 0x55, 0xb7, 0x0e, 0x0c },
        { 0xe0, 0x1f, 0xcf, 0x9a, 0x45, 0x4f, 0xf7, 0x8d,
          0xa5, 0x40, 0xf1, 0xb2, 0x32, 0x34, 0xb2, 0x88 },
        { 0xe2, 0x67, 0xa7, 0x41, 0xa8, 0x49, 0x8f, 0x82,
          0x19, 0xf7, 0xc7, 0x8b, 0x3b, 0x17, 0xba, 0xc3 } };

    funcName = "FNV-128";
    selected = FNV128selected;
/* test error checks */
    Terr = 0;
    TestR ( "init1", fnvSuccess, FNV128init (&e128Context) );
    CommonTest();
    TestR ( "init2", fnvNull,
            FNV128init ( (FNV128context *)0 ) );
    TestR ( "initBasis1", fnvNull,
            FNV128initBasis ( (FNV128context *)0, hash ) );
    TestR ( "blockin1", fnvNull,
            FNV128blockin ( (FNV128context *)0,
                           errtestbytes, NTestBytes ) );
    TestR ( "blockin2", fnvNull,
            FNV128blockin ( &e128Context, (uint8_t *)0,
                           NTestBytes ) );
    TestR ( "blockin3", fnvBadParam,
            FNV128blockin ( &e128Context, errtestbytes, -1 ) );
    e128Context.Computed = FNVclobber+FNV128state;
    TestR ( "blockin4", fnvStateError,
            FNV128blockin ( &e128Context, errtestbytes,
                           NTestBytes ) );
    TestR ( "stringin1", fnvNull,
            FNV128stringin ( (FNV128context *)0, errteststring ) );
    TestR ( "stringin2", fnvNull,
            FNV128stringin ( &e128Context, (char *)0 ) );
    TestR ( "stringin3", fnvStateError,
            FNV128stringin ( &e128Context, errteststring ) );
    TestR ( "result1", fnvNull,
            FNV128result ( (FNV128context *)0, hash ) );
    TestR ( "result2", fnvNull,
            FNV128result ( &e128Context, (uint8_t *)0  ) );
    TestR ( "result3", fnvStateError,
            FNV128result ( &e128Context, hash  ) );
    ErrTestReport ();
/* test actual results */
    Terr = 0;
    for ( i = 0; i < NTstrings; ++i ) {
        err = TestR ( "stringa", fnvSuccess,
                      FNV128string ( teststring[i], hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringb", teststring[i], FNV128size,
                             hash,
                     FNV128svalues[i] );
        err = TestR ( "blocka", fnvSuccess,
                      FNV128block ( (uint8_t *)teststring[i],
                          (unsigned long)(strlen(teststring[i])+1),
                          hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockb", teststring[i], FNV128size,
                         hash,
                         FNV128bvalues[i] );
/* now try testing the incremental stuff */
        err = TestR ( "inita", fnvSuccess,
                      FNV128init ( &e128Context ) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockina", fnvSuccess,
                      FNV128blockin ( &e128Context,
                      (uint8_t *)teststring[i],
                      iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringina", fnvSuccess,
                      FNV128stringin ( &e128Context,
                      teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resulta", fnvSuccess,
                      FNV128result ( &e128Context, hash ) );
        if ( err ) break;
        TestNValue ( "incrementala", teststring[i], FNV128size,
                     hash,
                     (uint8_t *)&FNV128svalues[i] );

/* now try testing file hash */
        err = TestR ( "fileafh", fnvSuccess,
                      FNV128file (
                                 WriteTemp(teststring[i], iLen),
                                 hash )
                      );
        if ( err ) break;
        TestNValue ( "filebfh", teststring[i], FNV128size,
                     hash,
                     (uint8_t *)&FNV128svalues[i] );

     }
    ValueTestReport ();
}    /* end Test128 */

//****************************************************************
//  Code for testing FNV256
//****************************************************************
void Test256 ( void ) {
    int        i, err;
    long int   iLen;
    uint8_t   FNV256svalues[NTstrings][FNV256size] = {
        { 0xdd, 0x26, 0x8d, 0xbc, 0xaa, 0xc5, 0x50, 0x36,
          0x2d, 0x98, 0xc3, 0x84, 0xc4, 0xe5, 0x76, 0xcc,
          0xc8, 0xb1, 0x53, 0x68, 0x47, 0xb6, 0xbb, 0xb3,
          0x10, 0x23, 0xb4, 0xc8, 0xca, 0xee, 0x05, 0x35 },
        { 0x63, 0x32, 0x3f, 0xb0, 0xf3, 0x53, 0x03, 0xec,
          0x28, 0xdc, 0x75, 0x1d, 0x0a, 0x33, 0xbd, 0xfa,
          0x4d, 0xe6, 0xa9, 0x9b, 0x72, 0x66, 0x49, 0x4f,
          0x61, 0x83, 0xb2, 0x71, 0x68, 0x11, 0x63, 0x7c },
        { 0xb0, 0x55, 0xea, 0x2f, 0x30, 0x6c, 0xad, 0xad,
          0x4f, 0x0f, 0x81, 0xc0, 0x2d, 0x38, 0x89, 0xdc,
          0x32, 0x45, 0x3d, 0xad, 0x5a, 0xe3, 0x5b, 0x75,
          0x3b, 0xa1, 0xa9, 0x10, 0x84, 0xaf, 0x34, 0x28 },
        { 0x0c, 0x5a, 0x44, 0x40, 0x2c, 0x65, 0x38, 0xcf,
          0x98, 0xef, 0x20, 0xc4, 0x03, 0xa8, 0x0f, 0x65,
          0x9b, 0x80, 0xc9, 0xa5, 0xb0, 0x1a, 0x6a, 0x87,
          0x34, 0x2e, 0x26, 0x72, 0x64, 0x45, 0x67, 0xb1 } };
    uint8_t   FNV256bvalues[NTstrings][FNV256size] = {
        { 0x63, 0x32, 0x3f, 0xb0, 0xf3, 0x53, 0x03, 0xec,
          0x28, 0xdc, 0x56, 0x1d, 0x0a, 0x33, 0xbd, 0xfa,
          0x4d, 0xe6, 0xa9, 0x9b, 0x72, 0x66, 0x49, 0x4f,
          0x61, 0x83, 0xb2, 0x71, 0x68, 0x11, 0x38, 0x7f },
        { 0xf4, 0xf7, 0xa1, 0xc2, 0xef, 0xd0, 0xe1, 0xe4,
          0xbb, 0x19, 0xe3, 0x45, 0x25, 0xc0, 0x72, 0x1a,
          0x06, 0xdd, 0x32, 0x8f, 0xa3, 0xd7, 0xa9, 0x14,
          0x39, 0xa0, 0x73, 0x43, 0x50, 0x1c, 0xf4, 0xf4 },
        { 0x6a, 0x7f, 0x34, 0xab, 0xc8, 0x5d, 0xe7, 0xd9,
          0x51, 0xb5, 0x15, 0x7e, 0xb5, 0x67, 0x2c, 0x59,
          0xb6, 0x04, 0x87, 0x65, 0x09, 0x47, 0xd3, 0x91,
          0xb1, 0x2d, 0x71, 0xe7, 0xfe, 0xf5, 0x53, 0x78 },
        { 0x3b, 0x97, 0x2c, 0x31, 0xbe, 0x84, 0x3a, 0x45,
          0x59, 0x02, 0x20, 0xd1, 0x12, 0x0d, 0x59, 0xe6,
          0xa3, 0x97, 0xa0, 0xc3, 0x34, 0xa1, 0xb9, 0x7d,
          0x5b, 0xff, 0x50, 0xa1, 0x0c, 0x3e, 0xca, 0x73 } };

    funcName = "FNV-256";
    selected = FNV256selected;
/* test error checks */
    Terr = 0;
    TestR ( "init1", fnvSuccess, FNV256init (&e256Context) );
    CommonTest();
    TestR ( "init2", fnvNull,
            FNV256init ( (FNV256context *)0 ) );
    TestR ( "initBasis1", fnvNull,
            FNV256initBasis ( (FNV256context *)0, hash ) );
    TestR ( "blockin1", fnvNull,
            FNV256blockin ( (FNV256context *)0,
                           errtestbytes, NTestBytes ) );
    TestR ( "blockin2", fnvNull,
            FNV256blockin ( &e256Context, (uint8_t *)0,
                           NTestBytes ) );
    TestR ( "blockin3", fnvBadParam,
            FNV256blockin ( &e256Context, errtestbytes, -1 ) );
    e256Context.Computed = FNVclobber+FNV256state;
    TestR ( "blockin4", fnvStateError,
            FNV256blockin ( &e256Context, errtestbytes,
                            NTestBytes ) );
    TestR ( "stringin1", fnvNull,
            FNV256stringin ( (FNV256context *)0, errteststring ) );
    TestR ( "stringin2", fnvNull,
            FNV256stringin ( &e256Context, (char *)0 ) );
    TestR ( "stringin3", fnvStateError,
            FNV256stringin ( &e256Context, errteststring ) );
    TestR ( "result1", fnvNull,
            FNV256result ( (FNV256context *)0, hash ) );
    TestR ( "result2", fnvNull,
            FNV256result ( &e256Context, (uint8_t *)0  ) );
    TestR ( "result3", fnvStateError,
            FNV256result ( &e256Context, hash  ) );
    ErrTestReport ();
/* test actual results */
    Terr = 0;
    for ( i = 0; i < NTstrings; ++i ) {
        err = TestR ( "stringa", fnvSuccess,
                      FNV256string ( teststring[i], hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringb", teststring[i], FNV256size,
                             hash,
                     FNV256svalues[i] );
        err = TestR ( "blocka", fnvSuccess,
                      FNV256block ( (uint8_t *)teststring[i],
                          (unsigned long)(strlen(teststring[i])+1),
                          hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockb", teststring[i], FNV256size,
                     hash,
                     FNV256bvalues[i] );
/* now try testing the incremental stuff */
        err = TestR ( "inita", fnvSuccess,
                      FNV256init ( &e256Context ) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockina", fnvSuccess,
                      FNV256blockin ( &e256Context,
                      (uint8_t *)teststring[i],
                      iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringina", fnvSuccess,
                      FNV256stringin ( &e256Context,
                      teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resulta", fnvSuccess,
                      FNV256result ( &e256Context, hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "incrementala", teststring[i], FNV256size,
                     hash,
                     (uint8_t *)&FNV256svalues[i] );

/* now try testing file hash */
        err = TestR ( "fileafh", fnvSuccess,
                      FNV256file (
                                 WriteTemp(teststring[i], iLen),
                                 hash )
                      );
        if ( err ) break;
        TestNValue ( "filebfh", teststring[i], FNV256size,
                     hash,
                     (uint8_t *)&FNV256svalues[i] );

    }
    ValueTestReport ();
}    /* end Test256 */

//****************************************************************
//  Code for testing FNV512
//****************************************************************
void Test512 ( void ) {
    int        i, err;
    long int   iLen;
    uint8_t   FNV512svalues[NTstrings][FNV512size] = {
        { 0xb8, 0x6d, 0xb0, 0xb1, 0x17, 0x1f, 0x44, 0x16,
          0xdc, 0xa1, 0xe5, 0x0f, 0x30, 0x99, 0x90, 0xac,
          0xac, 0x87, 0xd0, 0x59, 0xc9, 0x00, 0x00, 0x00,
          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0d, 0x21,
          0xe9, 0x48, 0xf6, 0x8a, 0x34, 0xc1, 0x92, 0xf6,
          0x2e, 0xa7, 0x9b, 0xc9, 0x42, 0xdb, 0xe7, 0xce,
          0x18, 0x20, 0x36, 0x41, 0x5f, 0x56, 0xe3, 0x4b,
          0xac, 0x98, 0x2a, 0xac, 0x4a, 0xfe, 0x9f, 0xd9 },
        { 0xe4, 0x3a, 0x99, 0x2d, 0xc8, 0xfc, 0x5a, 0xd7,
          0xde, 0x49, 0x3e, 0x3d, 0x69, 0x6d, 0x6f, 0x85,
          0xd6, 0x43, 0x26, 0xec, 0x07, 0x00, 0x00, 0x00,
          0x00, 0x00, 0x00, 0x00, 0x00, 0x11, 0x98, 0x6f,
          0x90, 0xc2, 0x53, 0x2c, 0xaf, 0x5b, 0xe7, 0xd8,
          0x82, 0x91, 0xba, 0xa8, 0x94, 0xa3, 0x95, 0x22,
          0x53, 0x28, 0xb1, 0x96, 0xbd, 0x6a, 0x8a, 0x64,
          0x3f, 0xe1, 0x2c, 0xd8, 0x7b, 0x27, 0xff, 0x88 },
        { 0xb0, 0xec, 0x73, 0x8d, 0x9c, 0x6f, 0xd9, 0x69,
          0xd0, 0x5f, 0x0b, 0x35, 0xf6, 0xc0, 0xed, 0x53,
          0xad, 0xca, 0xcc, 0xcd, 0x8e, 0x00, 0x00, 0x00,
          0x4b, 0xf9, 0x9f, 0x58, 0xee, 0x41, 0x96, 0xaf,
          0xb9, 0x70, 0x0e, 0x20, 0x11, 0x08, 0x30, 0xfe,
          0xa5, 0x39, 0x6b, 0x76, 0x28, 0x0e, 0x47, 0xfd,
          0x02, 0x2b, 0x6e, 0x81, 0x33, 0x1c, 0xa1, 0xa9,
          0xce, 0xd7, 0x29, 0xc3, 0x64, 0xbe, 0x77, 0x88 },
        { 0x4f, 0xdf, 0x00, 0xec, 0xb9, 0xbc, 0x04, 0xdd,
          0x19, 0x38, 0x61, 0x8f, 0xe5, 0xc4, 0xfb, 0xb8,
          0x80, 0xa8, 0x2b, 0x15, 0xf5, 0xb6, 0xbd, 0x72,
          0x1e, 0xc2, 0xea, 0xfe, 0x03, 0xc4, 0x62, 0x48,
          0xf7, 0xa6, 0xc2, 0x47, 0x89, 0x92, 0x80, 0xd6,
          0xd2, 0xf4, 0x2f, 0xf6, 0xb4, 0x7b, 0xf2, 0x20,
          0x79, 0xdf, 0xd4, 0xbf, 0xe8, 0x7b, 0xf0, 0xbb,
          0x4e, 0x71, 0xea, 0xcb, 0x1e, 0x28, 0x77, 0x35 } };
    uint8_t   FNV512bvalues[NTstrings][FNV512size] = {
        { 0xe4, 0x3a, 0x99, 0x2d, 0xc8, 0xfc, 0x5a, 0xd7,
          0xde, 0x49, 0x3e, 0x3d, 0x69, 0x6d, 0x6f, 0x85,
          0xd6, 0x43, 0x26, 0xec, 0x28, 0x00, 0x00, 0x00,
          0x00, 0x00, 0x00, 0x00, 0x00, 0x11, 0x98, 0x6f,
          0x90, 0xc2, 0x53, 0x2c, 0xaf, 0x5b, 0xe7, 0xd8,
          0x82, 0x91, 0xba, 0xa8, 0x94, 0xa3, 0x95, 0x22,
          0x53, 0x28, 0xb1, 0x96, 0xbd, 0x6a, 0x8a, 0x64,
          0x3f, 0xe1, 0x2c, 0xd8, 0x7b, 0x28, 0x2b, 0xbf },
        { 0x73, 0x17, 0xdf, 0xed, 0x6c, 0x70, 0xdf, 0xec,
          0x6a, 0xdf, 0xce, 0xd2, 0xa5, 0xe0, 0x4d, 0x7e,
          0xec, 0x74, 0x4e, 0x3c, 0xe9, 0x00, 0x00, 0x00,
          0x00, 0x00, 0x00, 0x00, 0x17, 0x93, 0x3d, 0x7a,
          0xf4, 0x5d, 0x70, 0xde, 0xf4, 0x23, 0xa3, 0x16,
          0xf1, 0x41, 0x17, 0xdf, 0x27, 0x2c, 0xd0, 0xfd,
          0x6b, 0x85, 0xf0, 0xf7, 0xc9, 0xbf, 0x6c, 0x51,
          0x96, 0xb3, 0x16, 0x0d, 0x02, 0x97, 0x5f, 0x38 },
        { 0x82, 0xf6, 0xe1, 0x04, 0x96, 0xde, 0x78, 0x34,
          0xb0, 0x8b, 0x21, 0xef, 0x46, 0x4c, 0xd2, 0x47,
          0x9e, 0x1d, 0x25, 0xe0, 0xca, 0x00, 0x00, 0x65,
          0xcb, 0x74, 0x80, 0x27, 0x39, 0xe0, 0xe5, 0x71,
          0x75, 0x22, 0xec, 0xf6, 0xd1, 0xf9, 0xa5, 0x2f,
          0x5f, 0xee, 0xfb, 0x4f, 0xab, 0x22, 0x73, 0xfd,
          0xe8, 0x31, 0x0f, 0x1b, 0x7b, 0x5c, 0x9a, 0x84,
          0x22, 0x48, 0xf4, 0xcb, 0xfb, 0x32, 0x27, 0x38 },
        { 0xfa, 0x7e, 0xb9, 0x1e, 0xfb, 0x64, 0x64, 0x11,
          0x8a, 0x73, 0x33, 0xbd, 0x96, 0x3b, 0xb6, 0x1f,
          0x2c, 0x6f, 0xe2, 0xe3, 0x6c, 0xd7, 0xd3, 0xe7,
          0x37, 0x28, 0xda, 0x57, 0x0c, 0x1f, 0xaf, 0xc3,
          0xd0, 0x6e, 0x4d, 0xd9, 0x53, 0x4a, 0x9f, 0xd4,
          0xa5, 0x2c, 0x43, 0x8b, 0xd2, 0x11, 0x69, 0x83,
          0x4a, 0xe6, 0x0d, 0x20, 0x7e, 0x0f, 0x8a, 0xf6,
          0x1a, 0xa1, 0x96, 0x25, 0x68, 0x37, 0xb8, 0x03 } };

    funcName = "FNV-512";
    selected = FNV512selected;
/* test error checks */
    Terr = 0;
    TestR ( "init1", fnvSuccess, FNV512init (&e512Context) );
    CommonTest();
    TestR ( "init2", fnvNull,
            FNV512init ( (FNV512context *)0 ) );
    TestR ( "initBasis1", fnvNull,
            FNV512initBasis ( (FNV512context *)0, hash ) );
    TestR ( "blockin1", fnvNull,
            FNV512blockin ( (FNV512context *)0,
                           errtestbytes, NTestBytes ) );
    TestR ( "blockin2", fnvNull,
            FNV512blockin ( &e512Context, (uint8_t *)0,
                           NTestBytes ) );
    TestR ( "blockin3", fnvBadParam,
            FNV512blockin ( &e512Context, errtestbytes, -1 ) );
    e512Context.Computed = FNVclobber+FNV512state;
    TestR ( "blockin4", fnvStateError,
            FNV512blockin ( &e512Context, errtestbytes,
                           NTestBytes ) );
    TestR ( "stringin1", fnvNull,
            FNV512stringin ( (FNV512context *)0, errteststring ) );
    TestR ( "stringin2", fnvNull,
            FNV512stringin ( &e512Context, (char *)0 ) );
    TestR ( "stringin3", fnvStateError,
            FNV512stringin ( &e512Context, errteststring ) );
    TestR ( "result1", fnvNull,
            FNV512result ( (FNV512context *)0, hash ) );
    TestR ( "result2", fnvNull,
            FNV512result ( &e512Context, (uint8_t *)0  ) );
    TestR ( "result3", fnvStateError,
            FNV512result ( &e512Context, hash  ) );
    ErrTestReport ();
/* test actual results */
    Terr = 0;
    for ( i = 0; i < NTstrings; ++i ) {
        err = TestR ( "stringa", fnvSuccess,
                      FNV512string ( teststring[i], hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringb", teststring[i], FNV512size,
                             hash,
                     FNV512svalues[i] );
        err = TestR ( "blocka", fnvSuccess,
                      FNV512block ( (uint8_t *)teststring[i],
                      (unsigned long)(strlen(teststring[i])+1),
                      hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockb", teststring[i], FNV512size,
                     hash,
                     FNV512bvalues[i] );
/* now try testing the incremental stuff */
        err = TestR ( "inita", fnvSuccess,
                      FNV512init ( &e512Context ) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockina", fnvSuccess,
                      FNV512blockin ( &e512Context,
                      (uint8_t *)teststring[i],
                      iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringina", fnvSuccess,
                      FNV512stringin ( &e512Context,
                      teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resulta", fnvSuccess,
                      FNV512result ( &e512Context, hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "incrementala", teststring[i], FNV512size,
                     hash,
                     (uint8_t *)&FNV512svalues[i] );

/* now try testing file hash */
        err = TestR ( "fileafh", fnvSuccess,
                      FNV512file (
                                 WriteTemp(teststring[i], iLen),
                                 hash )
                      );
        if ( err ) break;
        TestNValue ( "filebfh", teststring[i], FNV512size,
                     hash,
                     (uint8_t *)&FNV512svalues[i] );

    }
    ValueTestReport ();
}    /* end Test512 */

//****************************************************************
//  Code for testing FNV1024
//****************************************************************
void Test1024 ( void ) {
    int        i, err;
    long int   iLen;
    uint8_t   FNV1024svalues[NTstrings][FNV1024size] = {
      { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x5f, 0x7a, 0x76, 0x75, 0x8e, 0xcc, 0x4d,
        0x32, 0xe5, 0x6d, 0x5a, 0x59, 0x10, 0x28, 0xb7,
        0x4b, 0x29, 0xfc, 0x42, 0x23, 0xfd, 0xad, 0xa1,
        0x6c, 0x3b, 0xf3, 0x4e, 0xda, 0x36, 0x74, 0xda,
        0x9a, 0x21, 0xd9, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0xc6, 0xd7,
        0xeb, 0x6e, 0x73, 0x80, 0x27, 0x34, 0x51, 0x0a,
        0x55, 0x5f, 0x25, 0x6c, 0xc0, 0x05, 0xae, 0x55,
        0x6b, 0xde, 0x8c, 0xc9, 0xc6, 0xa9, 0x3b, 0x21,
        0xaf, 0xf4, 0xb1, 0x6c, 0x71, 0xee, 0x90, 0xb3 },
      { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x98, 0xd7, 0xc1, 0x9f, 0xbc, 0xe6, 0x53, 0xdf,
        0x22, 0x1b, 0x9f, 0x71, 0x7d, 0x34, 0x90, 0xff,
        0x95, 0xca, 0x87, 0xfd, 0xae, 0xf3, 0x0d, 0x1b,
        0x82, 0x33, 0x72, 0xf8, 0x5b, 0x24, 0xa3, 0x72,
        0xf5, 0x0e, 0x57, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x07, 0x68, 0x5c, 0xd8,
        0x1a, 0x49, 0x1d, 0xbc, 0xcc, 0x21, 0xad, 0x06,
        0x64, 0x8d, 0x09, 0xa5, 0xc8, 0xcf, 0x5a, 0x78,
        0x48, 0x20, 0x54, 0xe9, 0x14, 0x70, 0xb3, 0x3d,
        0xde, 0x77, 0x25, 0x2c, 0xae, 0xf6, 0x95, 0xaa },
      { 0x00, 0x00, 0x06, 0x31, 0x17, 0x5f, 0xa7, 0xae,
        0x64, 0x3a, 0xd0, 0x87, 0x23, 0xd3, 0x12, 0xc9,
        0xfd, 0x02, 0x4a, 0xdb, 0x91, 0xf7, 0x7f, 0x6b,
        0x19, 0x58, 0x71, 0x97, 0xa2, 0x2b, 0xcd, 0xf2,
        0x37, 0x27, 0x16, 0x6c, 0x45, 0x72, 0xd0, 0xb9,
        0x85, 0xd5, 0xae, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x42,
        0x70, 0xd1, 0x1e, 0xf4, 0x18, 0xef, 0x08, 0xb8,
        0xa4, 0x9e, 0x1e, 0x82, 0x5e, 0x54, 0x7e, 0xb3,
        0x99, 0x37, 0xf8, 0x19, 0x22, 0x2f, 0x3b, 0x7f,
        0xc9, 0x2a, 0x0e, 0x47, 0x07, 0x90, 0x08, 0x88,
        0x84, 0x7a, 0x55, 0x4b, 0xac, 0xec, 0x98, 0xb0 },
      { 0xf6, 0xf7, 0x47, 0xaf, 0x25, 0xa9, 0xde, 0x26,
        0xe8, 0xa4, 0x93, 0x43, 0x1e, 0x31, 0xb4, 0xa1,
        0xed, 0x2a, 0x92, 0x30, 0x4a, 0xf6, 0xca, 0x97,
        0x6b, 0xc1, 0xd9, 0x6f, 0xfc, 0xad, 0x35, 0x24,
        0x4e, 0x8d, 0x38, 0x5d, 0x55, 0xf4, 0x2f, 0xdc,
        0xc8, 0xf2, 0x99, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0xf7, 0xca, 0x87, 0xce,
        0x43, 0x22, 0x7b, 0x98, 0xc1, 0x44, 0x60, 0x7e,
        0x67, 0xcc, 0x50, 0xaf, 0x99, 0xbc, 0xc5, 0xd1,
        0x51, 0x4b, 0xb0, 0xd9, 0x23, 0xee, 0xde, 0xdd,
        0x69, 0xe8, 0xe7, 0x47, 0x02, 0x05, 0x08, 0x3a,
        0x0c, 0x02, 0x27, 0xd0, 0xcc, 0x69, 0xde, 0x23 } };
    uint8_t   FNV1024bvalues[NTstrings][FNV1024size] = {
      { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x98, 0xd7, 0xc1, 0x9f, 0xbc, 0xe6, 0x53, 0xdf,
        0x22, 0x1b, 0x9f, 0x71, 0x7d, 0x34, 0x90, 0xff,
        0x95, 0xca, 0x87, 0xfd, 0xae, 0xf3, 0x0d, 0x1b,
        0x82, 0x33, 0x72, 0xf8, 0x5b, 0x24, 0xa3, 0x72,
        0xf5, 0x0e, 0x38, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x07, 0x68, 0x5c, 0xd8,
        0x1a, 0x49, 0x1d, 0xbc, 0xcc, 0x21, 0xad, 0x06,
        0x64, 0x8d, 0x09, 0xa5, 0xc8, 0xcf, 0x5a, 0x78,
        0x48, 0x20, 0x54, 0xe9, 0x14, 0x70, 0xb3, 0x3d,
        0xde, 0x77, 0x25, 0x2c, 0xae, 0xf6, 0x65, 0x97 },
      { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf4,
        0x6e, 0xf4, 0x1c, 0xd2, 0x3a, 0x4d, 0xcd, 0xd4,
        0x06, 0x83, 0x49, 0x63, 0xb7, 0x8e, 0x82, 0x24,
        0x1a, 0x6f, 0x5c, 0xb0, 0x6f, 0x40, 0x3c, 0xbd,
        0x5a, 0x7c, 0x89, 0x03, 0xce, 0xf6, 0xa5, 0xf4,
        0xfd, 0xd2, 0x95, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x0b, 0x7c, 0xd7, 0xfb, 0x20,
        0xc3, 0x63, 0x1d, 0xc8, 0x90, 0x39, 0x52, 0xe9,
        0xee, 0xb7, 0xf6, 0x18, 0x69, 0x8f, 0x4c, 0x87,
        0xda, 0x23, 0xad, 0x74, 0xb2, 0xc5, 0xf6, 0xf1,
        0xfe, 0xc4, 0xa6, 0x4b, 0x54, 0x66, 0x18, 0xa2 },
      { 0x00, 0x09, 0xdc, 0x92, 0x10, 0x75, 0xfd, 0x8a,
        0x5e, 0x3e, 0x1a, 0x37, 0x2c, 0x72, 0xa5, 0x9b,
        0xb1, 0x0c, 0xca, 0x1a, 0x94, 0xc8, 0xb2, 0x38,
        0x7d, 0x63, 0xa7, 0xef, 0xa7, 0xfc, 0xa7, 0xa7,
        0x17, 0xa6, 0x4e, 0x6c, 0x2d, 0x62, 0xfb, 0x61,
        0x78, 0xf7, 0x86, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x67, 0x08,
        0xf4, 0x4d, 0x00, 0x8a, 0xaa, 0xb0, 0x86, 0x57,
        0x49, 0x35, 0x50, 0x2c, 0x49, 0x08, 0x7c, 0x84,
        0x9b, 0xcb, 0xbe, 0xfa, 0x03, 0x3f, 0x45, 0x2a,
        0xf6, 0x38, 0x24, 0x26, 0xba, 0x5d, 0x3b, 0xb5,
        0x71, 0xb6, 0x46, 0x5b, 0x2a, 0xe8, 0xc8, 0xf0 },
      { 0xc8, 0x01, 0xf8, 0xe0, 0x8a, 0xe9, 0x1b, 0x18,
        0x0b, 0x98, 0xdd, 0x7d, 0x9f, 0x65, 0xce, 0xb6,
        0x87, 0xca, 0x86, 0x35, 0x8c, 0x69, 0x05, 0xf6,
        0x0a, 0x7d, 0x10, 0x14, 0xc1, 0x82, 0xb0, 0x4f,
        0xd6, 0x08, 0xa2, 0xca, 0x4d, 0xd6, 0x0a, 0x30,
        0x0a, 0x15, 0x68, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x01, 0x80, 0x45, 0x14, 0x9a, 0xde,
        0x1c, 0x79, 0xab, 0xe3, 0xb7, 0x09, 0xa4, 0x06,
        0xf7, 0xd9, 0x20, 0x51, 0x69, 0xbe, 0xc5, 0x9b,
        0x12, 0x61, 0x40, 0xbc, 0xb9, 0x6f, 0x9d, 0x5d,
        0x3e, 0x2e, 0xa9, 0x1e, 0x21, 0xcd, 0xc2, 0x04,
        0x9f, 0x57, 0xbe, 0xcd, 0x00, 0x2d, 0x7c, 0x47 } };

    funcName = "FNV-1024";
    selected = FNV1024selected;
    /* test error checks */
    Terr = 0;
    TestR ( "init1", fnvSuccess, FNV1024init (&e1024Context) );
    CommonTest();
    TestR ( "init2", fnvNull,
            FNV1024init ( (FNV1024context *)0 ) );
    TestR ( "initBasis1", fnvNull,
            FNV1024initBasis ( (FNV1024context *)0, hash ) );
    TestR ( "blockin1", fnvNull,
            FNV1024blockin ( (FNV1024context *)0,
                           errtestbytes, NTestBytes ) );
    TestR ( "blockin2", fnvNull,
            FNV1024blockin ( &e1024Context, (uint8_t *)0,
                           NTestBytes ) );
    TestR ( "blockin3", fnvBadParam,
            FNV1024blockin ( &e1024Context, errtestbytes, -1 ) );
    e1024Context.Computed = FNVclobber+FNV1024state;
    TestR ( "blockin4", fnvStateError,
            FNV1024blockin ( &e1024Context, errtestbytes,
                           NTestBytes ) );
    TestR ( "stringin1", fnvNull,
            FNV1024stringin ( (FNV1024context *)0, errteststring ) );
    TestR ( "stringin2", fnvNull,
            FNV1024stringin ( &e1024Context, (char *)0 ) );
    TestR ( "stringin3", fnvStateError,
            FNV1024stringin ( &e1024Context, errteststring ) );
    TestR ( "result1", fnvNull,
            FNV1024result ( (FNV1024context *)0, hash ) );
    TestR ( "result2", fnvNull,
            FNV1024result ( &e1024Context, (uint8_t *)0  ) );
    TestR ( "result3", fnvStateError,
            FNV1024result ( &e1024Context, hash  ) );
    ErrTestReport ();
/* test actual results */
    Terr = 0;
    for ( i = 0; i < NTstrings; ++i ) {
        err = TestR ( "stringa", fnvSuccess,
                      FNV1024string ( teststring[i], hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "stringb", teststring[i], FNV1024size,
                             hash,
                     FNV1024svalues[i] );
        err = TestR ( "blocka", fnvSuccess,
                      FNV1024block ( (uint8_t *)teststring[i],
                          (unsigned long)(strlen(teststring[i])+1),
                          hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "blockb", teststring[i], FNV1024size,
                     hash,
                     FNV1024bvalues[i] );
/* now try testing the incremental stuff */
        err = TestR ( "inita", fnvSuccess,
                      FNV1024init ( &e1024Context ) );
        if ( err ) break;
        iLen = strlen ( teststring[i] );
        err = TestR ( "blockina", fnvSuccess,
                      FNV1024blockin ( &e1024Context,
                      (uint8_t *)teststring[i],
                      iLen/2 ) );
        if ( err ) break;
        err = TestR ( "stringina", fnvSuccess,
                      FNV1024stringin ( &e1024Context,
                      teststring[i] + iLen/2 ) );
        if ( err ) break;
        err = TestR ( "resulta", fnvSuccess,
                      FNV1024result ( &e1024Context, hash ) );
        if ( err == fnvSuccess )
            TestNValue ( "incrementala", teststring[i], FNV1024size,
                     hash,
                     (uint8_t *)&FNV1024svalues[i] );

/* now try testing file hash */
        err = TestR ( "fileafh", fnvSuccess,
                      FNV1024file (
                                 WriteTemp(teststring[i], iLen),
                                 hash )
                      );
        if ( err ) break;
        TestNValue ( "filebfh", teststring[i], FNV1024size,
                     hash,
                     (uint8_t *)&FNV1024svalues[i] );

    }
    ValueTestReport ();
}    /* end Test1024 */
]]></sourcecode>

</section>

<section>  <!-- 6.4 -->
  <name>Makefile</name>

  <t>Below is a simple makefile to produce and run the test program or
  to provide a library with all the FNV functions supplied in it.</t>

  <t>WARNING: When actually using the following as a makefile, the
  five character sequence "&lt;TAB&gt;" must be changed to a tab (0x09)
  character!</t>

  <sourcecode type="makefile" markers="true" name="makefile">
<![CDATA[
# Makefile for fnv
# If you extract this file from RFC NNNN, the five character sequence
#     &lt;TAB&gt; below must be replace with a tab (0x09) character.

explanation:
&lt;TAB&gt;@echo Choose one of the following make targets:
&lt;TAB&gt;@echo make FNVhash -- test program
&lt;TAB&gt;@echo make libfnv.a -- library you can use
&lt;TAB&gt;@echo make clean -- removes all of the built targets

SRC=FNV1024.c FNV128.c FNV256.c FNV32.c FNV512.c FNV64.c
HDR=FNV32.h FNV64.h FNV128.h FNV256.h FNV512.h FNV1024.h \
&lt;TAB&gt;FNVErrorCodes.h FNVconfig.h fnv-private.h
OBJ=$(SRC:.c=.o)
CFLAGS=-Wall
AR=ar
ARFLAGS= rcs

FNVhash: libfnv.a main.c
&lt;TAB&gt;$(CC) $(CFLAGS) -o FNVhash main.c libfnv.a

libfnv.a: $(SRC) $(HDR)
&lt;TAB&gt;rm -f libfnv.a *.o
&lt;TAB&gt;$(CC) $(CFLAGS) -c $(SRC)
&lt;TAB&gt;$(AR) $(ARFLAGS) libfnv.a $(OBJ)

clean:
&lt;TAB&gt;rm -rf libfnv.a FNVhash *.o
]]></sourcecode>

</section>

</section>

<section>  <!-- 7. -->
  <name>Security Considerations</name>

<t>This document is intended to provide convenient open source access
by the Internet community to the FNV non-cryptographic hash. No
assertion of suitability for cryptographic applications is made for
the FNV hash algorithms.</t>

<section anchor="noncrypto">
  <name>Why is FNV Non-Cryptographic?</name>

<t>A full discussion of cryptographic hash requirements and strength
is beyond the scope of this document. However, here are three
characteristics of FNV that would generally be considered to make it
non-cryptographic:</t>

<ol>
  <li>Sticky State - A cryptographic hash should not have a state in
  which it can stick for a plausible input pattern. But, in the very
  unlikely event that the FNV hash variable becomes zero and the input
  is a sequence of zeros, the hash variable will remain at zero until
  there is a non-zero input byte and the final hash value will be
  unaffected by the length of that sequence of zero input bytes. Of
  course, for the common case of fixed length input, this would
  usually not be significant because the number of non-zero bytes
  would vary inversely with the number of zero bytes and for some
  types of input, runs of zeros do not occur. Furthermore, the use of
  a different offset_basis or the inclusion of even a little
  unpredictable input may be sufficient to stop an adversary from
  inducing a zero hash variable.</li>
  
  <li>Diffusion - Every output bit of a cryptographic hash should be
  an equally complex function of every input bit. But it is easy to
  see that the least significant bit of a direct FNV hash is the XOR
  of the least significant bits of every input byte and does not
  depend on any other input bits. While more complex, the second
  through seventh least significant bits of an FNV hash have a similar
  weakness; only the top bit of the bottom byte of output, and higher
  order bits, depend on all input bits. If these properties are
  considered a problem, they can be easily fixed by XOR folding (see
  Section 3).</li>

  <li>Work Factor - Depending on intended use, it is frequently
  desirable that a hash function should be computationally expensive
  for general purpose and graphics processors since these may be
  profusely available through elastic cloud services or botnets.  This
  is to slow down testing of possible inputs if the output is
  known. But FNV is designed to be inexpensive on a general-purpose
  processor. (See Appendix A.)</li>
</ol>

<t>Nevertheless, none of the above have proven to be a problem in
actual practice for the many non-cryptographic applications of
FNV.</t>

</section>

<section anchor="bang">
  <name>Inducing Collisions</name>

<t>While use of a cryptographic hash should be considered when active
adversaries are a factor, the following attack can be made much more
difficult with very minor changes in the use of FNV:</t>

<t>If FNV is being used in a known way for hash tables in a network
server or the like, for example some part of a web server, an
adversary could send requests calculated to cause hash table
collisions and induce substantial processing delays. As mentioned in
Section 2.2, use of an offset_basis not known by the adversary will
substantially reduce or eliminate this problem.</t>

</section>

</section>

<section>  <!-- 8. -->
  <name>IANA Considerations</name>

<t>This document requires no IANA Actions.</t>

</section>  <!-- 8. -->
        
</middle>


<!-- ____________________BACK_MATTER____________________ -->
<back>

<references>
  <name>Normative References</name>

<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.0020.xml"/>

</references>
 
<references> 
  <name>Informative References</name>

<reference anchor="BFDseq"
           target="draft-ietf-bfd-secure-sequence-numbers-09.txt">
  <front>
    <title>Secure BFD Sequence Numbers</title>
    <author fullname="Mahesh Jethanandani" initials="M."
            surname="Jethanandani">
      <organization>Kloud Services</organization>
      <address>
        <email>mjethanandani@gmail.com</email>
      </address>
    </author>
    <author fullname="Sonal Agarwal" initials="S."
            surname="Agarwal">
      <organization>Cisco Systems, Inc</organization>
      <address>
         <email>agarwaso@cisco.com</email>
        <uri>www.cisco.com</uri>
      </address>
    </author>
    <author fullname="Ashesh Mishra" initials="A."
            surname="Mishra">
      <organization>O3b Networks</organization>
      <address>
        <email>mishra.ashesh@gmail.com</email>
      </address>
    </author>
    <author fullname="Ankur Saxena" initials="A."
            surname="Saxena">
      <organization>Ciena Corporation</organization>
      <address>
        <email>ankurpsaxena@gmail.com</email>
      </address>
    </author>
    <author fullname="Alan DeKok" initials="A."
            surname="DeKok">
      <organization>Network RADIUS SARL</organization>
      <address>
        <email>aland@freeradius.org</email>
      </address>
    </author>
    <date year="2022" month="March" day="22"/>
  </front>
</reference>

<reference anchor="FNV"
           target="http://www.isthe.com/chongo/tech/comp/fnv/index.html">
  <front>
    <title>FNV website</title>
    <author>
      <organization>Fowler-Noll-Vo</organization>
    </author>
  </front>
</reference>

<reference anchor="IEEE" target="http:www.ieee.org">
  <front>
    <title>IEEE website</title>
    <author>
      <organization>Institute for Electrical and Electronics
      Engineers</organization>
    </author>
  </front>
</reference>
  
<reference anchor="IEEE8021Qbp">
  <front>
    <title>Media Access Control (MAC) Bridges and Virtual Bridged
    Local Area Networks - Equal Cost Multiple Path (ECMP)</title>
    <author surname="IEEE 802.1"/>
    <date year="2014" month="April" day="7"/>
  </front>
  <seriesInfo name="IEEE Std" value="802.1Qbp-2014"/>
</reference>

<reference anchor="IPv6flow"
target="https://researchspace.auckland.ac.nz/bitstream/handle/2292/13240/flowhashRep.pdf">
  <front>
    <title>Comparing Hash Function Algorithms for the IPv6 Flow
    Label</title>
    <author fullname="Lewis Anderson" initials="L."
            surname="Anderson">
      <organization>The University of Auckland</organization>
      <address>
        <email>land062@auckland.ac.nz</email>
      </address>
    </author>
    <author fullname="Nevil Brownlee" initials="N."
            surname="Brownlee">
      <organization>The University of Auckland</organization>
      <address>
        <email>n.brownlee@auckland.ac.nz</email>
      </address>
    </author>
    <author fullname="Brian E. Carpenter" initials="B."
            surname="Carpenter">
      <organization>The University of Auckland, Department of Computer
      Science</organization>
      <address>
        <email>brain@cs.auckland.ac.nz</email>
      </address>
    </author>
    <date year="2012" month="March"/>
  </front>
  <seriesInfo name="University of Auckland Department of Computer
    Science Technical Report" value="2012-002"/>
  <seriesInfo name="ISSN" value="1173-3500"/>
</reference>


<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.3174.xml"/>
<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.6194.xml"/>
<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.6234.xml"/>
<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.6437.xml"/>
<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.7357.xml"/>
<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.7873.xml"/>
<xi:include
  href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.8200.xml"/>

</references>

<section>  <!-- Appendix A -->
  <name>Work Comparison with SHA-1</name>

<t>This section provides a simplistic rough comparison of the level of
effort required per input byte to compute FNV-1a and SHA-1
<xref target="RFC3174"/>.</t>

<t>Ignoring transfer of control and conditional tests and equating all
logical and arithmetic operations, FNV requires 2 operations per byte,
an XOR and a multiply.</t>

<t>SHA-1 is a relatively weak cryptographic hash producing a 160-bit
hash. It has been partially broken <xref target="RFC6194"/>. It is
actually designed to accept a bit vector input although almost all
computer uses apply it to an integer number of bytes. It processes
blocks of 512 bits (64 bytes) and we estimate the effort involved in
SHA-1 processing a full block. Ignoring SHA-1 initial set up, transfer
of control, and conditional tests, but counting all logical and
arithmetic operations, including counting indexing as an addition,
SHA-1 requires 1,744 operations per 64 bytes block or 27.25 operations
per byte. So by this rough measure, it is a little over 13 times the
effort of FNV for large amounts of data. However, FNV is commonly used
for small inputs. Using the above comparison method, for inputs of N
bytes, where N is &lt;= 55 so SHA-1 will take one block (SHA-1
includes padding and an 8-byte length at the end of the data in the
last block), the ratio of the effort for SHA-1 to the effort for FNV
will be 872/N. For example, with a 4-byte input such as an IPv4
address, SHA-1 will take 218 times as much effort as FNV, and wih a
6-byte input such as a MAC address, SHA-1 will take a little over 145
times as much effort as FNV.</t>

<t>Stronger cryptographic functions than SHA-1 generally have an even
higher work factor.</t>

</section> <!-- Appendix A -->

<section>  <!-- Appendix B -->
  <name>Previous IETF FNV Code</name>

<t>FNV-1a was referenced in draft-ietf-tls-cached-info-08.txt that has
since expired. Below is the Java code for FNV64 from that TLS draft
included with the kind permission of the author:</t>

<sourcecode type="java" markers="true">
 /*
 * Java code sample, implementing 64 bit FNV-1a
 * By Stefan Santesson
 */

import java.math.BigInteger;

public class FNV {

   static public BigInteger getFNV1aToByte(byte[] inp) {

       BigInteger m = new BigInteger("2").pow(64);
       BigInteger fnvPrime = new BigInteger("1099511628211");
       BigInteger fnvOffsetBasis =
               new BigInteger("14695981039346656037");

       BigInteger digest = fnvOffsetBasis;

       for (byte b : inp) {
           digest = digest.xor(BigInteger.valueOf((int) b &amp; 255));
           digest = digest.multiply(fnvPrime).mod(m);
       }
       return digest;

   }
}
</sourcecode>

</section>

<section>
  <name>Change History</name>

<t>RFC Editor Note: Please delete this appendix on publication.</t>

<section>
  <name>From -00 to -01</name>

<ol>
  <li>Add Security Considerations section on why FNV is
non-cryptographic.</li>
  <li>Add Appendix A on a work factor comparison with SHA-1.</li>
  <li>Add Appendix B concerning previous IETF draft referenced to
  FNV.</li>
  <li>Minor editorial changes.</li>
</ol>

</section>
<section>
  <name>From -01 to -02</name>

<ol>
  <li>Correct FNV_Prime determination criteria and add note as to why
  s &lt; 5 and s &gt; 10 are not considered.</li>
  <li>Add acknowledgements list.</li>
  <li>Add a couple of references.</li>
  <li>Minor editorial changes.</li>
</ol>
  
</section>
<section>
  <name>From -02 to -05</name>

<ol>
  <li>Minor addition to Section 6, point 3.</li>
  <li>Add Twitter as a use example and IPv6 flow hash study
  reference.</li>
  <li>Minor editorial changes.</li>
</ol>
  
</section>
<section>
  <name>From -05 to -08</name>

<ol>
  <li>Add code subsections.</li>
  <li>Update Author info.</li>
  <li>Minor edits.</li>
</ol>
  
</section>
<section>
  <name>From -08 to -09</name>

<ol>
  <li>Change reference for ASCII to <xref target="RFC0020"/>.</li>
  <li>Add more details on history of the string used to compute
  offset_basis.</li>
  <li>Re-write "Work Factor" part of Section 6 to be more
  precise.</li>
  <li>Minor editorial changes.</li>
</ol>
  
</section>
<section>
  <name>From -09 to -10</name>

<ol>
  <li>Inclusion of initial partial version of code and some
  documentation about the code, Section 6.</li>
  <li>Insertion of new Section 4 on hashing values.</li>
</ol>
  
</section>
<section>
  <name>From -10 to -11</name>

  <t>Changes based on code improvements primarily from Tony Hansen who
  has been added as an author. Changes based on comments from Mukund
  Sivaraman and Roman Donchenko.</t>
  
</section>
<section>
  <name>From -11 to -12</name>

  <t>Keep alive update.</t>
  
</section>
<section>
  <name>From -12 to -13</name>

  <t>Fixed bug in pseudocode in Section 2.3.</t>

  <t>Change code to eliminate the BigEndian flag and so there are
  separate byte vector output routines for FNV32 and FNV64, equivalent
  to the other routines, and integer output routines for cases where
  Endianness consistency is not required.</t>

</section>
<section>
  <name>From -13 to -17</name>

<ol>
  <li>Update an author address</li>
  <li>Update an author affiliation.</li>
</ol>
  
</section>
<section>
  <name>From -17 to -19</name>

<ol>
    <li>Add reference to draft-ietf-bfd-secure-sequence-numbers.</li>
    <li>Add references to the following, each of which uses FNV: RFC
    7357, RFC 7873, and IEEE Std. 802.1Qbp-2014</li>
    <li>Update author information</li>
    <li>Minor editorial changes.</li>
</ol>

</section>
<section>
  <name>From -19 to -20</name>

  <t>Convert to XML v3. Fix code for longer FNV hashes.</t>
  
</section>
<section>
  <name>From -20 to -21</name>
  
  <t>Update Twitter to X. Minor Editorial changes.</t>
  
</section>
<section>
  <name>From -21 to -22</name>

  <t>Update Landon's email. Minor Editorial changes. Update to
  substantially improved code.</t>

</section>
<section>
  <name>From -22 to -23</name>
  
<ol>
    <li>Author info update.</li>
    <li>Make byte vector returning versions of
    functions available for all sizes.</li>
    <li>Remove big endian code due to difficulty in finding someone to
    test it. This only affects multi-byte integer returns and correct
    results can always be obtained by using the byte vector return
    versions of functions.</li>
</ol>

</section>
<section>
  <name>From -23 to -25</name>

<ol>
    <li>Correct some errors in comments in the code, fix some
    omissions and add testing for the file hashing code, and other
    code polishing</li>
    <li>Minor editorial changes.</li>
</ol>

</section>
<section>
  <name>From -25 to -26</name>

<ol>
    <li>Add autodetect in FNVconfig.h of target support for 64-bit
    integers.</li>
    <li>Add discussion of what source files are needed for particular
    uses.</li>
    <li>Fix code so it compiles properly if all .c files are
    concatenated as well as when they are compiled separately.</li>
    <li>Add makefile section.</li>
    <li>Minor editorial changes.</li>
</ol>

</section>
</section>

<section anchor="Acknowledgements" numbered="false">
  <name>Acknowledgements</name>

  <t>The contributions of the following are gratefully
  acknowledged:</t>

  <t>Roman Donchenko, Frank Ellermann, Tony Finch, Bob Moskowitz,
  Gayle Noble, Stefan Santesson, Mukund Sivaraman, Paul Hoffman, and
  Paul Wouters.</t>
    
</section>

</back>

</rfc>
