VirtualBox

source: vbox/trunk/include/iprt/crc.h@ 25299

Last change on this file since 25299 was 21914, checked in by vboxsync, 15 years ago

iprt: combined crc32.h and crc64.h into crc.h. Added Adler-32.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.3 KB
Line 
1/** @file
2 * IPRT - CRCs and Checksums.
3 */
4
5/*
6 * Copyright (C) 2006-2009 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___iprt_crc_h
31#define ___iprt_crc_h
32
33#include <iprt/cdefs.h>
34#include <iprt/types.h>
35
36
37RT_C_DECLS_BEGIN
38
39/** @defgroup grp_rt_crc RTCrc - Checksums and CRCs.
40 * @ingroup grp_rt
41 * @{
42 */
43
44
45/** @defgroup grp_rt_crc32 CRC-32
46 * @{ */
47/**
48 * Calculate CRC-32 for a memory block.
49 *
50 * @returns CRC-32 for the memory block.
51 * @param pv Pointer to the memory block.
52 * @param cb Size of the memory block in bytes.
53 */
54RTDECL(uint32_t) RTCrc32(const void *pv, size_t cb);
55
56/**
57 * Start a multiblock CRC-32 calculation.
58 *
59 * @returns Start CRC-32.
60 */
61RTDECL(uint32_t) RTCrc32Start(void);
62
63/**
64 * Processes a multiblock of a CRC-32 calculation.
65 *
66 * @returns Intermediate CRC-32 value.
67 * @param uCRC32 Current CRC-32 intermediate value.
68 * @param pv The data block to process.
69 * @param cb The size of the data block in bytes.
70 */
71RTDECL(uint32_t) RTCrc32Process(uint32_t uCRC32, const void *pv, size_t cb);
72
73/**
74 * Complete a multiblock CRC-32 calculation.
75 *
76 * @returns CRC-32 value.
77 * @param uCRC32 Current CRC-32 intermediate value.
78 */
79RTDECL(uint32_t) RTCrc32Finish(uint32_t uCRC32);
80/** @} */
81
82
83/** @defgroup grp_rt_crc64 CRC-64 Calculation
84 * @{ */
85/**
86 * Calculate CRC-64 for a memory block.
87 *
88 * @returns CRC-64 for the memory block.
89 * @param pv Pointer to the memory block.
90 * @param cb Size of the memory block in bytes.
91 */
92RTDECL(uint64_t) RTCrc64(const void *pv, size_t cb);
93
94/**
95 * Start a multiblock CRC-64 calculation.
96 *
97 * @returns Start CRC-64.
98 */
99RTDECL(uint64_t) RTCrc64Start(void);
100
101/**
102 * Processes a multiblock of a CRC-64 calculation.
103 *
104 * @returns Intermediate CRC-64 value.
105 * @param uCRC64 Current CRC-64 intermediate value.
106 * @param pv The data block to process.
107 * @param cb The size of the data block in bytes.
108 */
109RTDECL(uint64_t) RTCrc64Process(uint64_t uCRC64, const void *pv, size_t cb);
110
111/**
112 * Complete a multiblock CRC-64 calculation.
113 *
114 * @returns CRC-64 value.
115 * @param uCRC64 Current CRC-64 intermediate value.
116 */
117RTDECL(uint64_t) RTCrc64Finish(uint64_t uCRC64);
118/** @} */
119
120
121/** @defgroup grp_rt_crc_adler32 Adler-32
122 * @{ */
123/**
124 * Calculate Adler-32 for a memory block.
125 *
126 * @returns Adler-32 for the memory block.
127 * @param pv Pointer to the memory block.
128 * @param cb Size of the memory block in bytes.
129 */
130RTDECL(uint32_t) RTCrcAdler32(void const *pv, size_t cb);
131
132/**
133 * Start a multiblock Adler-32 calculation.
134 *
135 * @returns Start Adler-32.
136 */
137RTDECL(uint32_t) RTCrcAdler32Start(void);
138
139/**
140 * Processes a multiblock of a Adler-32 calculation.
141 *
142 * @returns Intermediate Adler-32 value.
143 * @param uCrc Current Adler-32 intermediate value.
144 * @param pv The data block to process.
145 * @param cb The size of the data block in bytes.
146 */
147RTDECL(uint32_t) RTCrcAdler32Process(uint32_t uCrc, void const *pv, size_t cb);
148
149/**
150 * Complete a multiblock Adler-32 calculation.
151 *
152 * @returns Adler-32 value.
153 * @param uCrc Current Adler-32 intermediate value.
154 */
155RTDECL(uint32_t) RTCrcAdler32Finish(uint32_t uCrc);
156
157/** @} */
158
159/** @} */
160
161RT_C_DECLS_END
162
163#endif
164
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette