summaryrefslogtreecommitdiff
path: root/rdrand.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-05-09 15:13:11 -0400
committerJeffrey Walton <noloader@gmail.com>2017-05-09 15:13:11 -0400
commitbc29f1b5b8e93ccbde3a7445beada67e1fdb1d37 (patch)
tree4450547de34126aae4c092d178b34fa2497f27f9 /rdrand.h
parent4f7fee38d6acd63eafc86fd9bdb5bee7e27548d2 (diff)
downloadcryptopp-git-bc29f1b5b8e93ccbde3a7445beada67e1fdb1d37.tar.gz
Updated documentation
Diffstat (limited to 'rdrand.h')
-rw-r--r--rdrand.h13
1 files changed, 6 insertions, 7 deletions
diff --git a/rdrand.h b/rdrand.h
index 03a186f4..33309017 100644
--- a/rdrand.h
+++ b/rdrand.h
@@ -9,12 +9,11 @@
#include "cryptlib.h"
-// This file (and friends) provides both RDRAND and RDSEED. They were added at
+// This class file provides both RDRAND and RDSEED. They were added at
// Crypto++ 5.6.3. At compile time, it uses CRYPTOPP_BOOL_{X86|X32|X64}
-// to select an implementation or "throw NotImplemented". The class does not
-// use CPUID to determine if RDRAND or RDSEED are available. If not available,
-// then a SIGILL will result. Users of the classes should call HasRDRAND() or
-// HasRDSEED() to determine if a generator is available.
+// to select an implementation or "throw NotImplemented". At runtime the
+// constructor will throw RDRAND_Err or RDSEED_Err if a generator is
+// is not available.
// The original classes accepted a retry count. Retries were superflous for
// RDRAND, and RDSEED encountered a failure about 1 in 256 bytes depending
// on the processor. Retries were removed at Crypto++ 6.0 because
@@ -28,8 +27,8 @@
// during testing with Athlon X4 845. The Bulldozer v4 only performed at 1 MiB/s.
// Microsoft added RDRAND in August 2012, VS2012; RDSEED in October 2013, VS2013.
-// GCC added RDRAND in December 2010, GCC 4.6. LLVM added RDRAND in July 2012, Clang 3.2.
-// Intel added RDRAND in September 2011, ICC 12.1.
+// GCC added RDRAND in December 2010, GCC 4.6. LLVM added RDRAND in July 2012,
+// Clang 3.2. Intel added RDRAND in September 2011, ICC 12.1.
NAMESPACE_BEGIN(CryptoPP)