annotate gcc/ada/libgnat/s-crc32.ads @ 145:1830386684a0

gcc-9.2.0
author anatofuz
date Thu, 13 Feb 2020 11:34:05 +0900
parents 84e7813d76e9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 ------------------------------------------------------------------------------
kono
parents:
diff changeset
2 -- --
kono
parents:
diff changeset
3 -- GNAT LIBRARY COMPONENTS --
kono
parents:
diff changeset
4 -- --
kono
parents:
diff changeset
5 -- S Y S T E M . C R C 3 2 --
kono
parents:
diff changeset
6 -- --
kono
parents:
diff changeset
7 -- S p e c --
kono
parents:
diff changeset
8 -- --
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
9 -- Copyright (C) 2001-2019, Free Software Foundation, Inc. --
111
kono
parents:
diff changeset
10 -- --
kono
parents:
diff changeset
11 -- GNAT is free software; you can redistribute it and/or modify it under --
kono
parents:
diff changeset
12 -- terms of the GNU General Public License as published by the Free Soft- --
kono
parents:
diff changeset
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
kono
parents:
diff changeset
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
kono
parents:
diff changeset
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
kono
parents:
diff changeset
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
kono
parents:
diff changeset
17 -- --
kono
parents:
diff changeset
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
kono
parents:
diff changeset
19 -- additional permissions described in the GCC Runtime Library Exception, --
kono
parents:
diff changeset
20 -- version 3.1, as published by the Free Software Foundation. --
kono
parents:
diff changeset
21 -- --
kono
parents:
diff changeset
22 -- You should have received a copy of the GNU General Public License and --
kono
parents:
diff changeset
23 -- a copy of the GCC Runtime Library Exception along with this program; --
kono
parents:
diff changeset
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
kono
parents:
diff changeset
25 -- <http://www.gnu.org/licenses/>. --
kono
parents:
diff changeset
26 -- --
kono
parents:
diff changeset
27 -- GNAT was originally developed by the GNAT team at New York University. --
kono
parents:
diff changeset
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
kono
parents:
diff changeset
29 -- --
kono
parents:
diff changeset
30 ------------------------------------------------------------------------------
kono
parents:
diff changeset
31
kono
parents:
diff changeset
32 -- This package provides routines for computing a commonly used checksum
kono
parents:
diff changeset
33 -- called CRC-32. This is a checksum based on treating the binary data
kono
parents:
diff changeset
34 -- as a polynomial over a binary field, and the exact specifications of
kono
parents:
diff changeset
35 -- the CRC-32 algorithm are as follows:
kono
parents:
diff changeset
36 --
kono
parents:
diff changeset
37 -- Name : "CRC-32"
kono
parents:
diff changeset
38 -- Width : 32
kono
parents:
diff changeset
39 -- Poly : 04C11DB7
kono
parents:
diff changeset
40 -- Init : FFFFFFFF
kono
parents:
diff changeset
41 -- RefIn : True
kono
parents:
diff changeset
42 -- RefOut : True
kono
parents:
diff changeset
43 -- XorOut : FFFFFFFF
kono
parents:
diff changeset
44 -- Check : CBF43926
kono
parents:
diff changeset
45 --
kono
parents:
diff changeset
46 -- Note that this is the algorithm used by PKZip, Ethernet and FDDI.
kono
parents:
diff changeset
47 --
kono
parents:
diff changeset
48 -- For more information about this algorithm see:
kono
parents:
diff changeset
49 --
kono
parents:
diff changeset
50 -- ftp://ftp.rocksoft.com/papers/crc_v3.txt
kono
parents:
diff changeset
51
kono
parents:
diff changeset
52 -- "A Painless Guide to CRC Error Detection Algorithms", Ross N. Williams
kono
parents:
diff changeset
53 --
kono
parents:
diff changeset
54 -- "Computation of Cyclic Redundancy Checks via Table Look-Up", Communications
kono
parents:
diff changeset
55 -- of the ACM, Vol. 31 No. 8, pp.1008-1013 Aug. 1988. Sarwate, D.V.
kono
parents:
diff changeset
56
kono
parents:
diff changeset
57 pragma Compiler_Unit_Warning;
kono
parents:
diff changeset
58
kono
parents:
diff changeset
59 with Interfaces;
kono
parents:
diff changeset
60
kono
parents:
diff changeset
61 package System.CRC32 is
kono
parents:
diff changeset
62
kono
parents:
diff changeset
63 type CRC32 is new Interfaces.Unsigned_32;
kono
parents:
diff changeset
64 -- Used to represent CRC32 values, which are 32 bit bit-strings
kono
parents:
diff changeset
65
kono
parents:
diff changeset
66 procedure Initialize (C : out CRC32);
kono
parents:
diff changeset
67 pragma Inline (Initialize);
kono
parents:
diff changeset
68 -- Initialize CRC value by assigning the standard Init value (16#FFFF_FFFF)
kono
parents:
diff changeset
69
kono
parents:
diff changeset
70 procedure Update
kono
parents:
diff changeset
71 (C : in out CRC32;
kono
parents:
diff changeset
72 Value : Character);
kono
parents:
diff changeset
73 pragma Inline (Update);
kono
parents:
diff changeset
74 -- Evolve CRC by including the contribution from Character'Pos (Value)
kono
parents:
diff changeset
75
kono
parents:
diff changeset
76 function Get_Value (C : CRC32) return Interfaces.Unsigned_32;
kono
parents:
diff changeset
77 pragma Inline (Get_Value);
kono
parents:
diff changeset
78 -- Get_Value computes the CRC32 value by performing an XOR with the
kono
parents:
diff changeset
79 -- standard XorOut value (16#FFFF_FFFF). Note that this does not
kono
parents:
diff changeset
80 -- change the value of C, so it may be used to retrieve intermediate
kono
parents:
diff changeset
81 -- values of the CRC32 value during a sequence of Update calls.
kono
parents:
diff changeset
82
kono
parents:
diff changeset
83 end System.CRC32;