1 // Boost CRC library crc.hpp header file -----------------------------------//
3 // Copyright 2001, 2004 Daryle Walker. Use, modification, and distribution are
4 // subject to the Boost Software License, Version 1.0. (See accompanying file
5 // LICENSE_1_0.txt or a copy at <http://www.boost.org/LICENSE_1_0.txt>.)
7 // See <http://www.boost.org/libs/crc/> for the library's home page.
12 #include <boost/config.hpp> // for BOOST_STATIC_CONSTANT, etc.
13 #include <boost/integer.hpp> // for boost::uint_t
15 #include <climits> // for CHAR_BIT, etc.
16 #include <cstddef> // for std::size_t
18 #include <boost/limits.hpp> // for std::numeric_limits
21 // The type of CRC parameters that can go in a template should be related
22 // on the CRC's bit count. This macro expresses that type in a compact
23 // form, but also allows an alternate type for compilers that don't support
24 // dependent types (in template value-parameters).
25 #if !(defined(BOOST_NO_DEPENDENT_TYPES_IN_TEMPLATE_VALUE_PARAMETERS) || (defined(BOOST_MSVC) && (BOOST_MSVC <= 1300)))
26 #define BOOST_CRC_PARM_TYPE typename ::boost::uint_t<Bits>::fast
28 #define BOOST_CRC_PARM_TYPE unsigned long
31 // Some compilers [MS VC++ 6] cannot correctly set up several versions of a
32 // function template unless every template argument can be unambiguously
33 // deduced from the function arguments. (The bug is hidden if only one version
34 // is needed.) Since all of the CRC function templates have this problem, the
35 // workaround is to make up a dummy function argument that encodes the template
36 // arguments. Calls to such template functions need all their template
37 // arguments explicitly specified. At least one compiler that needs this
38 // workaround also needs the default value for the dummy argument to be
39 // specified in the definition.
40 #if defined(__GNUC__) || !defined(BOOST_NO_EXPLICIT_FUNCTION_TEMPLATE_ARGUMENTS)
41 #define BOOST_CRC_DUMMY_PARM_TYPE
42 #define BOOST_CRC_DUMMY_INIT
43 #define BOOST_ACRC_DUMMY_PARM_TYPE
44 #define BOOST_ACRC_DUMMY_INIT
46 namespace boost
{ namespace detail
{
47 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
48 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
49 bool ReflectIn
, bool ReflectRem
>
50 struct dummy_crc_argument
{ };
52 #define BOOST_CRC_DUMMY_PARM_TYPE , detail::dummy_crc_argument<Bits, \
53 TruncPoly, InitRem, FinalXor, ReflectIn, ReflectRem> *p_
54 #define BOOST_CRC_DUMMY_INIT BOOST_CRC_DUMMY_PARM_TYPE = 0
55 #define BOOST_ACRC_DUMMY_PARM_TYPE , detail::dummy_crc_argument<Bits, \
56 TruncPoly, 0, 0, false, false> *p_
57 #define BOOST_ACRC_DUMMY_INIT BOOST_ACRC_DUMMY_PARM_TYPE = 0
65 // Forward declarations ----------------------------------------------------//
67 template < std::size_t Bits
>
70 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
= 0u,
71 BOOST_CRC_PARM_TYPE InitRem
= 0u,
72 BOOST_CRC_PARM_TYPE FinalXor
= 0u, bool ReflectIn
= false,
73 bool ReflectRem
= false >
76 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
77 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
78 bool ReflectIn
, bool ReflectRem
>
79 typename uint_t
<Bits
>::fast
crc( void const *buffer
,
80 std::size_t byte_count
81 BOOST_CRC_DUMMY_PARM_TYPE
);
83 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
>
84 typename uint_t
<Bits
>::fast
augmented_crc( void const *buffer
,
85 std::size_t byte_count
, typename uint_t
<Bits
>::fast initial_remainder
86 BOOST_ACRC_DUMMY_PARM_TYPE
);
88 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
>
89 typename uint_t
<Bits
>::fast
augmented_crc( void const *buffer
,
90 std::size_t byte_count
91 BOOST_ACRC_DUMMY_PARM_TYPE
);
93 typedef crc_optimal
<16, 0x8005, 0, 0, true, true> crc_16_type
;
94 typedef crc_optimal
<16, 0x1021, 0xFFFF, 0, false, false> crc_ccitt_type
;
95 typedef crc_optimal
<16, 0x8408, 0, 0, true, true> crc_xmodem_type
;
97 typedef crc_optimal
<32, 0x04C11DB7, 0xFFFFFFFF, 0xFFFFFFFF, true, true>
101 // Forward declarations for implementation detail stuff --------------------//
102 // (Just for the stuff that will be needed for the next two sections)
106 template < std::size_t Bits
>
110 struct mask_uint_t
< std::numeric_limits
<unsigned char>::digits
>;
112 #if USHRT_MAX > UCHAR_MAX
114 struct mask_uint_t
< std::numeric_limits
<unsigned short>::digits
>;
117 #if UINT_MAX > USHRT_MAX
119 struct mask_uint_t
< std::numeric_limits
<unsigned int>::digits
>;
122 #if ULONG_MAX > UINT_MAX
124 struct mask_uint_t
< std::numeric_limits
<unsigned long>::digits
>;
127 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
, bool Reflect
>
130 template < std::size_t Bits
, bool DoReflect
>
133 #ifndef BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
134 template < std::size_t Bits
>
135 class crc_helper
< Bits
, false >;
138 } // namespace detail
141 // Simple cyclic redundancy code (CRC) class declaration -------------------//
143 template < std::size_t Bits
>
146 // Implementation type
147 typedef detail::mask_uint_t
<Bits
> masking_type
;
151 typedef typename
masking_type::least value_type
;
153 // Constant for the template parameter
154 BOOST_STATIC_CONSTANT( std::size_t, bit_count
= Bits
);
157 explicit crc_basic( value_type truncated_polynominal
,
158 value_type initial_remainder
= 0, value_type final_xor_value
= 0,
159 bool reflect_input
= false, bool reflect_remainder
= false );
161 // Internal Operations
162 value_type
get_truncated_polynominal() const;
163 value_type
get_initial_remainder() const;
164 value_type
get_final_xor_value() const;
165 bool get_reflect_input() const;
166 bool get_reflect_remainder() const;
168 value_type
get_interim_remainder() const;
169 void reset( value_type new_rem
);
172 // External Operations
173 void process_bit( bool bit
);
174 void process_bits( unsigned char bits
, std::size_t bit_count
);
175 void process_byte( unsigned char byte
);
176 void process_block( void const *bytes_begin
, void const *bytes_end
);
177 void process_bytes( void const *buffer
, std::size_t byte_count
);
179 value_type
checksum() const;
184 value_type poly_
, init_
, final_
; // non-const to allow assignability
185 bool rft_in_
, rft_out_
; // non-const to allow assignability
187 }; // boost::crc_basic
190 // Optimized cyclic redundancy code (CRC) class declaration ----------------//
192 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
193 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
194 bool ReflectIn
, bool ReflectRem
>
197 // Implementation type
198 typedef detail::mask_uint_t
<Bits
> masking_type
;
202 typedef typename
masking_type::fast value_type
;
204 // Constants for the template parameters
205 BOOST_STATIC_CONSTANT( std::size_t, bit_count
= Bits
);
206 BOOST_STATIC_CONSTANT( value_type
, truncated_polynominal
= TruncPoly
);
207 BOOST_STATIC_CONSTANT( value_type
, initial_remainder
= InitRem
);
208 BOOST_STATIC_CONSTANT( value_type
, final_xor_value
= FinalXor
);
209 BOOST_STATIC_CONSTANT( bool, reflect_input
= ReflectIn
);
210 BOOST_STATIC_CONSTANT( bool, reflect_remainder
= ReflectRem
);
213 explicit crc_optimal( value_type init_rem
= InitRem
);
215 // Internal Operations
216 value_type
get_truncated_polynominal() const;
217 value_type
get_initial_remainder() const;
218 value_type
get_final_xor_value() const;
219 bool get_reflect_input() const;
220 bool get_reflect_remainder() const;
222 value_type
get_interim_remainder() const;
223 void reset( value_type new_rem
= InitRem
);
225 // External Operations
226 void process_byte( unsigned char byte
);
227 void process_block( void const *bytes_begin
, void const *bytes_end
);
228 void process_bytes( void const *buffer
, std::size_t byte_count
);
230 value_type
checksum() const;
233 void operator ()( unsigned char byte
);
234 value_type
operator ()() const;
237 // The implementation of output reflection depends on both reflect states.
238 BOOST_STATIC_CONSTANT( bool, reflect_output
= (ReflectRem
!= ReflectIn
) );
241 #define BOOST_CRC_REF_OUT_VAL reflect_output
243 typedef crc_optimal self_type
;
244 #define BOOST_CRC_REF_OUT_VAL (self_type::reflect_output)
247 // More implementation types
248 typedef detail::crc_table_t
<Bits
, TruncPoly
, ReflectIn
> crc_table_type
;
249 typedef detail::crc_helper
<Bits
, ReflectIn
> helper_type
;
250 typedef detail::crc_helper
<Bits
, BOOST_CRC_REF_OUT_VAL
> reflect_out_type
;
252 #undef BOOST_CRC_REF_OUT_VAL
257 }; // boost::crc_optimal
260 // Implementation detail stuff ---------------------------------------------//
264 // Forward declarations for more implementation details
265 template < std::size_t Bits
>
268 template < std::size_t Bits
>
272 // Traits class for mask; given the bit number
273 // (1-based), get the mask for that bit by itself.
274 template < std::size_t Bits
>
276 : boost::uint_t
< Bits
>
278 typedef boost::uint_t
<Bits
> base_type
;
279 typedef typename
base_type::least least
;
280 typedef typename
base_type::fast fast
;
282 #if defined(__EDG_VERSION__) && __EDG_VERSION__ <= 243
283 static const least high_bit
= 1ul << ( Bits
- 1u );
284 static const fast high_bit_fast
= 1ul << ( Bits
- 1u );
286 BOOST_STATIC_CONSTANT( least
, high_bit
= (least( 1u ) << ( Bits
288 BOOST_STATIC_CONSTANT( fast
, high_bit_fast
= (fast( 1u ) << ( Bits
292 }; // boost::detail::high_uint_t
295 // Reflection routine class wrapper
296 // (since MS VC++ 6 couldn't handle the unwrapped version)
297 template < std::size_t Bits
>
300 typedef typename
boost::uint_t
<Bits
>::fast value_type
;
302 static value_type
reflect( value_type x
);
304 }; // boost::detail::reflector
306 // Function that reflects its argument
307 template < std::size_t Bits
>
308 typename reflector
<Bits
>::value_type
309 reflector
<Bits
>::reflect
311 typename reflector
<Bits
>::value_type x
314 value_type reflection
= 0;
315 value_type
const one
= 1;
317 for ( std::size_t i
= 0 ; i
< Bits
; ++i
, x
>>= 1 )
321 reflection
|= ( one
<< (Bits
- 1u - i
) );
329 // Traits class for masks; given the bit number (1-based),
330 // get the mask for that bit and its lower bits.
331 template < std::size_t Bits
>
333 : high_uint_t
< Bits
>
335 typedef high_uint_t
<Bits
> base_type
;
336 typedef typename
base_type::least least
;
337 typedef typename
base_type::fast fast
;
340 using base_type::high_bit
;
341 using base_type::high_bit_fast
;
343 BOOST_STATIC_CONSTANT( least
, high_bit
= base_type::high_bit
);
344 BOOST_STATIC_CONSTANT( fast
, high_bit_fast
= base_type::high_bit_fast
);
347 #if defined(__EDG_VERSION__) && __EDG_VERSION__ <= 243
348 static const least sig_bits
= (~( ~( 0ul ) << Bits
)) ;
350 BOOST_STATIC_CONSTANT( least
, sig_bits
= (~( ~(least( 0u )) << Bits
)) );
352 #if defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ == 0 && __GNUC_PATCHLEVEL__ == 2
353 // Work around a weird bug that ICEs the compiler in build_c_cast
354 BOOST_STATIC_CONSTANT( fast
, sig_bits_fast
= static_cast<fast
>(sig_bits
) );
356 BOOST_STATIC_CONSTANT( fast
, sig_bits_fast
= fast(sig_bits
) );
358 }; // boost::detail::mask_uint_t
361 struct mask_uint_t
< std::numeric_limits
<unsigned char>::digits
>
362 : high_uint_t
< std::numeric_limits
<unsigned char>::digits
>
364 typedef high_uint_t
<std::numeric_limits
<unsigned char>::digits
>
366 typedef base_type::least least
;
367 typedef base_type::fast fast
;
370 using base_type::high_bit
;
371 using base_type::high_bit_fast
;
373 BOOST_STATIC_CONSTANT( least
, high_bit
= base_type::high_bit
);
374 BOOST_STATIC_CONSTANT( fast
, high_bit_fast
= base_type::high_bit_fast
);
377 BOOST_STATIC_CONSTANT( least
, sig_bits
= (~( least(0u) )) );
378 BOOST_STATIC_CONSTANT( fast
, sig_bits_fast
= fast(sig_bits
) );
380 }; // boost::detail::mask_uint_t
382 #if USHRT_MAX > UCHAR_MAX
384 struct mask_uint_t
< std::numeric_limits
<unsigned short>::digits
>
385 : high_uint_t
< std::numeric_limits
<unsigned short>::digits
>
387 typedef high_uint_t
<std::numeric_limits
<unsigned short>::digits
>
389 typedef base_type::least least
;
390 typedef base_type::fast fast
;
393 using base_type::high_bit
;
394 using base_type::high_bit_fast
;
396 BOOST_STATIC_CONSTANT( least
, high_bit
= base_type::high_bit
);
397 BOOST_STATIC_CONSTANT( fast
, high_bit_fast
= base_type::high_bit_fast
);
400 BOOST_STATIC_CONSTANT( least
, sig_bits
= (~( least(0u) )) );
401 BOOST_STATIC_CONSTANT( fast
, sig_bits_fast
= fast(sig_bits
) );
403 }; // boost::detail::mask_uint_t
406 #if UINT_MAX > USHRT_MAX
408 struct mask_uint_t
< std::numeric_limits
<unsigned int>::digits
>
409 : high_uint_t
< std::numeric_limits
<unsigned int>::digits
>
411 typedef high_uint_t
<std::numeric_limits
<unsigned int>::digits
>
413 typedef base_type::least least
;
414 typedef base_type::fast fast
;
417 using base_type::high_bit
;
418 using base_type::high_bit_fast
;
420 BOOST_STATIC_CONSTANT( least
, high_bit
= base_type::high_bit
);
421 BOOST_STATIC_CONSTANT( fast
, high_bit_fast
= base_type::high_bit_fast
);
424 BOOST_STATIC_CONSTANT( least
, sig_bits
= (~( least(0u) )) );
425 BOOST_STATIC_CONSTANT( fast
, sig_bits_fast
= fast(sig_bits
) );
427 }; // boost::detail::mask_uint_t
430 #if ULONG_MAX > UINT_MAX
432 struct mask_uint_t
< std::numeric_limits
<unsigned long>::digits
>
433 : high_uint_t
< std::numeric_limits
<unsigned long>::digits
>
435 typedef high_uint_t
<std::numeric_limits
<unsigned long>::digits
>
437 typedef base_type::least least
;
438 typedef base_type::fast fast
;
441 using base_type::high_bit
;
442 using base_type::high_bit_fast
;
444 BOOST_STATIC_CONSTANT( least
, high_bit
= base_type::high_bit
);
445 BOOST_STATIC_CONSTANT( fast
, high_bit_fast
= base_type::high_bit_fast
);
448 BOOST_STATIC_CONSTANT( least
, sig_bits
= (~( least(0u) )) );
449 BOOST_STATIC_CONSTANT( fast
, sig_bits_fast
= fast(sig_bits
) );
451 }; // boost::detail::mask_uint_t
455 // CRC table generator
456 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
, bool Reflect
>
459 BOOST_STATIC_CONSTANT( std::size_t, byte_combos
= (1ul << CHAR_BIT
) );
461 typedef mask_uint_t
<Bits
> masking_type
;
462 typedef typename
masking_type::fast value_type
;
463 #if defined(__BORLANDC__) && defined(_M_IX86) && (__BORLANDC__ == 0x560)
464 // for some reason Borland's command line compiler (version 0x560)
465 // chokes over this unless we do the calculation for it:
466 typedef value_type table_type
[ 0x100 ];
468 typedef value_type table_type
[ byte_combos
];
471 static void init_table();
473 static table_type table_
;
475 }; // boost::detail::crc_table_t
477 // CRC table generator static data member definition
478 // (Some compilers [Borland C++] require the initializer to be present.)
479 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
, bool Reflect
>
480 typename crc_table_t
<Bits
, TruncPoly
, Reflect
>::table_type
481 crc_table_t
<Bits
, TruncPoly
, Reflect
>::table_
484 // Populate CRC lookup table
485 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
, bool Reflect
>
487 crc_table_t
<Bits
, TruncPoly
, Reflect
>::init_table
491 // compute table only on the first run
492 static bool did_init
= false;
493 if ( did_init
) return;
495 // factor-out constants to avoid recalculation
496 value_type
const fast_hi_bit
= masking_type::high_bit_fast
;
497 unsigned char const byte_hi_bit
= 1u << (CHAR_BIT
- 1u);
499 // loop over every possible dividend value
500 unsigned char dividend
= 0;
503 value_type remainder
= 0;
505 // go through all the dividend's bits
506 for ( unsigned char mask
= byte_hi_bit
; mask
; mask
>>= 1 )
508 // check if divisor fits
509 if ( dividend
& mask
)
511 remainder
^= fast_hi_bit
;
514 // do polynominal division
515 if ( remainder
& fast_hi_bit
)
518 remainder
^= TruncPoly
;
526 table_
[ crc_helper
<CHAR_BIT
, Reflect
>::reflect(dividend
) ]
527 = crc_helper
<Bits
, Reflect
>::reflect( remainder
);
529 while ( ++dividend
);
534 #ifndef BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
535 // Align the msb of the remainder to a byte
536 template < std::size_t Bits
, bool RightShift
>
540 typedef typename uint_t
<Bits
>::fast value_type
;
542 static unsigned char align_msb( value_type rem
)
543 { return rem
>> (Bits
- CHAR_BIT
); }
546 // Specialization for the case that the remainder has less
547 // bits than a byte: align the remainder msb to the byte msb
548 template < std::size_t Bits
>
549 class remainder
< Bits
, false >
552 typedef typename uint_t
<Bits
>::fast value_type
;
554 static unsigned char align_msb( value_type rem
)
555 { return rem
<< (CHAR_BIT
- Bits
); }
559 // CRC helper routines
560 template < std::size_t Bits
, bool DoReflect
>
565 typedef typename uint_t
<Bits
>::fast value_type
;
567 #ifndef BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
568 // Possibly reflect a remainder
569 static value_type
reflect( value_type x
)
570 { return detail::reflector
<Bits
>::reflect( x
); }
572 // Compare a byte to the remainder's highest byte
573 static unsigned char index( value_type rem
, unsigned char x
)
576 // Shift out the remainder's highest byte
577 static value_type
shift( value_type rem
)
578 { return rem
>> CHAR_BIT
; }
580 // Possibly reflect a remainder
581 static value_type
reflect( value_type x
)
582 { return DoReflect
? detail::reflector
<Bits
>::reflect( x
) : x
; }
584 // Compare a byte to the remainder's highest byte
585 static unsigned char index( value_type rem
, unsigned char x
)
586 { return x
^ ( DoReflect
? rem
:
587 ((Bits
>CHAR_BIT
)?( rem
>> (Bits
- CHAR_BIT
) ) :
588 ( rem
<< (CHAR_BIT
- Bits
) ))); }
590 // Shift out the remainder's highest byte
591 static value_type
shift( value_type rem
)
592 { return DoReflect
? rem
>> CHAR_BIT
: rem
<< CHAR_BIT
; }
595 }; // boost::detail::crc_helper
597 #ifndef BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
598 template < std::size_t Bits
>
599 class crc_helper
<Bits
, false>
603 typedef typename uint_t
<Bits
>::fast value_type
;
605 // Possibly reflect a remainder
606 static value_type
reflect( value_type x
)
609 // Compare a byte to the remainder's highest byte
610 static unsigned char index( value_type rem
, unsigned char x
)
611 { return x
^ remainder
<Bits
,(Bits
>CHAR_BIT
)>::align_msb( rem
); }
613 // Shift out the remainder's highest byte
614 static value_type
shift( value_type rem
)
615 { return rem
<< CHAR_BIT
; }
617 }; // boost::detail::crc_helper
621 } // namespace detail
624 // Simple CRC class function definitions -----------------------------------//
626 template < std::size_t Bits
>
628 crc_basic
<Bits
>::crc_basic
630 typename crc_basic
<Bits
>::value_type truncated_polynominal
,
631 typename crc_basic
<Bits
>::value_type initial_remainder
, // = 0
632 typename crc_basic
<Bits
>::value_type final_xor_value
, // = 0
633 bool reflect_input
, // = false
634 bool reflect_remainder
// = false
636 : rem_( initial_remainder
), poly_( truncated_polynominal
)
637 , init_( initial_remainder
), final_( final_xor_value
)
638 , rft_in_( reflect_input
), rft_out_( reflect_remainder
)
642 template < std::size_t Bits
>
644 typename crc_basic
<Bits
>::value_type
645 crc_basic
<Bits
>::get_truncated_polynominal
652 template < std::size_t Bits
>
654 typename crc_basic
<Bits
>::value_type
655 crc_basic
<Bits
>::get_initial_remainder
662 template < std::size_t Bits
>
664 typename crc_basic
<Bits
>::value_type
665 crc_basic
<Bits
>::get_final_xor_value
672 template < std::size_t Bits
>
675 crc_basic
<Bits
>::get_reflect_input
682 template < std::size_t Bits
>
685 crc_basic
<Bits
>::get_reflect_remainder
692 template < std::size_t Bits
>
694 typename crc_basic
<Bits
>::value_type
695 crc_basic
<Bits
>::get_interim_remainder
699 return rem_
& masking_type::sig_bits
;
702 template < std::size_t Bits
>
705 crc_basic
<Bits
>::reset
707 typename crc_basic
<Bits
>::value_type new_rem
713 template < std::size_t Bits
>
716 crc_basic
<Bits
>::reset
720 this->reset( this->get_initial_remainder() );
723 template < std::size_t Bits
>
726 crc_basic
<Bits
>::process_bit
731 value_type
const high_bit_mask
= masking_type::high_bit
;
733 // compare the new bit with the remainder's highest
734 rem_
^= ( bit
? high_bit_mask
: 0u );
736 // a full polynominal division step is done when the highest bit is one
737 bool const do_poly_div
= static_cast<bool>( rem_
& high_bit_mask
);
739 // shift out the highest bit
742 // carry out the division, if needed
749 template < std::size_t Bits
>
751 crc_basic
<Bits
>::process_bits
754 std::size_t bit_count
757 // ignore the bits above the ones we want
758 bits
<<= CHAR_BIT
- bit_count
;
760 // compute the CRC for each bit, starting with the upper ones
761 unsigned char const high_bit_mask
= 1u << ( CHAR_BIT
- 1u );
762 for ( std::size_t i
= bit_count
; i
> 0u ; --i
, bits
<<= 1u )
764 process_bit( static_cast<bool>(bits
& high_bit_mask
) );
768 template < std::size_t Bits
>
771 crc_basic
<Bits
>::process_byte
776 process_bits( (rft_in_
? detail::reflector
<CHAR_BIT
>::reflect(byte
)
780 template < std::size_t Bits
>
782 crc_basic
<Bits
>::process_block
784 void const * bytes_begin
,
785 void const * bytes_end
788 for ( unsigned char const * p
789 = static_cast<unsigned char const *>(bytes_begin
) ; p
< bytes_end
; ++p
)
795 template < std::size_t Bits
>
798 crc_basic
<Bits
>::process_bytes
801 std::size_t byte_count
804 unsigned char const * const b
= static_cast<unsigned char const *>(
807 process_block( b
, b
+ byte_count
);
810 template < std::size_t Bits
>
812 typename crc_basic
<Bits
>::value_type
813 crc_basic
<Bits
>::checksum
817 return ( (rft_out_
? detail::reflector
<Bits
>::reflect( rem_
) : rem_
)
818 ^ final_
) & masking_type::sig_bits
;
822 // Optimized CRC class function definitions --------------------------------//
824 // Macro to compact code
825 #define BOOST_CRC_OPTIMAL_NAME crc_optimal<Bits, TruncPoly, InitRem, \
826 FinalXor, ReflectIn, ReflectRem>
828 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
829 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
830 bool ReflectIn
, bool ReflectRem
>
832 BOOST_CRC_OPTIMAL_NAME::crc_optimal
834 typename
BOOST_CRC_OPTIMAL_NAME::value_type init_rem
// = InitRem
836 : rem_( helper_type::reflect(init_rem
) )
838 crc_table_type::init_table();
841 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
842 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
843 bool ReflectIn
, bool ReflectRem
>
845 typename
BOOST_CRC_OPTIMAL_NAME::value_type
846 BOOST_CRC_OPTIMAL_NAME::get_truncated_polynominal
853 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
854 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
855 bool ReflectIn
, bool ReflectRem
>
857 typename
BOOST_CRC_OPTIMAL_NAME::value_type
858 BOOST_CRC_OPTIMAL_NAME::get_initial_remainder
865 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
866 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
867 bool ReflectIn
, bool ReflectRem
>
869 typename
BOOST_CRC_OPTIMAL_NAME::value_type
870 BOOST_CRC_OPTIMAL_NAME::get_final_xor_value
877 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
878 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
879 bool ReflectIn
, bool ReflectRem
>
882 BOOST_CRC_OPTIMAL_NAME::get_reflect_input
889 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
890 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
891 bool ReflectIn
, bool ReflectRem
>
894 BOOST_CRC_OPTIMAL_NAME::get_reflect_remainder
901 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
902 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
903 bool ReflectIn
, bool ReflectRem
>
905 typename
BOOST_CRC_OPTIMAL_NAME::value_type
906 BOOST_CRC_OPTIMAL_NAME::get_interim_remainder
910 // Interim remainder should be _un_-reflected, so we have to undo it.
911 return helper_type::reflect( rem_
) & masking_type::sig_bits_fast
;
914 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
915 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
916 bool ReflectIn
, bool ReflectRem
>
919 BOOST_CRC_OPTIMAL_NAME::reset
921 typename
BOOST_CRC_OPTIMAL_NAME::value_type new_rem
// = InitRem
924 rem_
= helper_type::reflect( new_rem
);
927 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
928 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
929 bool ReflectIn
, bool ReflectRem
>
932 BOOST_CRC_OPTIMAL_NAME::process_byte
937 process_bytes( &byte
, sizeof(byte
) );
940 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
941 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
942 bool ReflectIn
, bool ReflectRem
>
944 BOOST_CRC_OPTIMAL_NAME::process_block
946 void const * bytes_begin
,
947 void const * bytes_end
950 // Recompute the CRC for each byte passed
951 for ( unsigned char const * p
952 = static_cast<unsigned char const *>(bytes_begin
) ; p
< bytes_end
; ++p
)
954 // Compare the new byte with the remainder's higher bits to
955 // get the new bits, shift out the remainder's current higher
956 // bits, and update the remainder with the polynominal division
958 unsigned char const byte_index
= helper_type::index( rem_
, *p
);
959 rem_
= helper_type::shift( rem_
);
960 rem_
^= crc_table_type::table_
[ byte_index
];
964 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
965 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
966 bool ReflectIn
, bool ReflectRem
>
969 BOOST_CRC_OPTIMAL_NAME::process_bytes
972 std::size_t byte_count
975 unsigned char const * const b
= static_cast<unsigned char const *>(
977 process_block( b
, b
+ byte_count
);
980 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
981 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
982 bool ReflectIn
, bool ReflectRem
>
984 typename
BOOST_CRC_OPTIMAL_NAME::value_type
985 BOOST_CRC_OPTIMAL_NAME::checksum
989 return ( reflect_out_type::reflect(rem_
) ^ get_final_xor_value() )
990 & masking_type::sig_bits_fast
;
993 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
994 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
995 bool ReflectIn
, bool ReflectRem
>
998 BOOST_CRC_OPTIMAL_NAME::operator ()
1003 process_byte( byte
);
1006 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
1007 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
1008 bool ReflectIn
, bool ReflectRem
>
1010 typename
BOOST_CRC_OPTIMAL_NAME::value_type
1011 BOOST_CRC_OPTIMAL_NAME::operator ()
1019 // CRC computation function definition -------------------------------------//
1021 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
,
1022 BOOST_CRC_PARM_TYPE InitRem
, BOOST_CRC_PARM_TYPE FinalXor
,
1023 bool ReflectIn
, bool ReflectRem
>
1025 typename uint_t
<Bits
>::fast
1028 void const * buffer
,
1029 std::size_t byte_count
1030 BOOST_CRC_DUMMY_INIT
1033 BOOST_CRC_OPTIMAL_NAME computer
;
1034 computer
.process_bytes( buffer
, byte_count
);
1035 return computer
.checksum();
1039 // Augmented-message CRC computation function definitions ------------------//
1041 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
>
1042 typename uint_t
<Bits
>::fast
1045 void const * buffer
,
1046 std::size_t byte_count
,
1047 typename uint_t
<Bits
>::fast initial_remainder
1048 BOOST_ACRC_DUMMY_INIT
1051 typedef unsigned char byte_type
;
1052 typedef detail::mask_uint_t
<Bits
> masking_type
;
1053 typedef detail::crc_table_t
<Bits
, TruncPoly
, false> crc_table_type
;
1055 typename
masking_type::fast rem
= initial_remainder
;
1056 byte_type
const * const b
= static_cast<byte_type
const *>( buffer
);
1057 byte_type
const * const e
= b
+ byte_count
;
1059 crc_table_type::init_table();
1060 for ( byte_type
const * p
= b
; p
< e
; ++p
)
1062 // Use the current top byte as the table index to the next
1063 // "partial product." Shift out that top byte, shifting in
1064 // the next augmented-message byte. Complete the division.
1065 byte_type
const byte_index
= rem
>> ( Bits
- CHAR_BIT
);
1068 rem
^= crc_table_type::table_
[ byte_index
];
1071 return rem
& masking_type::sig_bits_fast
;
1074 template < std::size_t Bits
, BOOST_CRC_PARM_TYPE TruncPoly
>
1076 typename uint_t
<Bits
>::fast
1079 void const * buffer
,
1080 std::size_t byte_count
1081 BOOST_ACRC_DUMMY_INIT
1084 // The last function argument has its type specified so the other version of
1085 // augmented_crc will be called. If the cast wasn't in place, and the
1086 // BOOST_ACRC_DUMMY_INIT added a third argument (for a workaround), the "0"
1087 // would match as that third argument, leading to infinite recursion.
1088 return augmented_crc
<Bits
, TruncPoly
>( buffer
, byte_count
,
1089 static_cast<typename uint_t
<Bits
>::fast
>(0) );
1093 } // namespace boost
1096 // Undo header-private macros
1097 #undef BOOST_CRC_OPTIMAL_NAME
1098 #undef BOOST_ACRC_DUMMY_INIT
1099 #undef BOOST_ACRC_DUMMY_PARM_TYPE
1100 #undef BOOST_CRC_DUMMY_INIT
1101 #undef BOOST_CRC_DUMMY_PARM_TYPE
1102 #undef BOOST_CRC_PARM_TYPE
1105 #endif // BOOST_CRC_HPP