xnu-3789.1.32.tar.gz

[apple/xnu.git] / EXTERNAL_HEADERS / corecrypto / cc.h

diff --git a/EXTERNAL_HEADERS/corecrypto/cc.h b/EXTERNAL_HEADERS/corecrypto/cc.h
index 6a05f106c8a5181070b925ce629004e3f0a57355..6b01e33c1add48e10094d541384968a6cbce8323 100644 (file)
--- a/EXTERNAL_HEADERS/corecrypto/cc.h
+++ b/EXTERNAL_HEADERS/corecrypto/cc.h
@@ -29,9 +29,9 @@
    The resulting struct can be used to create arrays that are aligned by
    a certain amount.  */
 #define cc_aligned_struct(_alignment_)  \
-    typedef struct { \
-        uint8_t b[_alignment_]; \
-    } __attribute__((aligned(_alignment_)))
+typedef struct { \
+uint8_t b[_alignment_]; \
+} CC_ALIGNED(_alignment_)
 
 /* number of array elements used in a cc_ctx_decl */
 #define cc_ctx_n(_type_, _size_) ((_size_ + sizeof(_type_) - 1) / sizeof(_type_))
@@ -39,16 +39,21 @@
 /* sizeof of a context declared with cc_ctx_decl */
 #define cc_ctx_sizeof(_type_, _size_) sizeof(_type_[cc_ctx_n(_type_, _size_)])
 
-#define cc_ctx_decl(_type_, _size_, _name_)  \
-    _type_ _name_[cc_ctx_n(_type_, _size_)]
-
-#if CC_HAS_BZERO
-#define cc_zero(_size_,_data_) bzero((_data_), (_size_))
+//- WARNING: The _MSC_VER version of cc_ctx_decl() is not compatible with the way *_decl macros are used in CommonCrypto, AppleKeyStore and SecurityFrameworks
+//  to observe the incompatibilities and errors, use below definition. Corecrypto itself, accepts both deinitions
+//  #define cc_ctx_decl(_type_, _size_, _name_)  _type_ _name_ ## _array[cc_ctx_n(_type_, (_size_))]; _type_ *_name_ = _name_ ## _array
+//- Never use sizeof() operator for the variables declared with cc_ctx_decl(), because it is not be compatible with the _MSC_VER version of cc_ctx_decl().
+#if defined(_MSC_VER)
+ #define UNIQUE_ARRAY(data_type, _var_, total_count) data_type* _var_ = (data_type*)_alloca(sizeof(data_type)*(total_count));
+ #define cc_ctx_decl(_type_, _size_, _name_)  UNIQUE_ARRAY(_type_, _name_,cc_ctx_n(_type_, (_size_)))
 #else
-/* Alternate version if you don't have bzero. */
-#define cc_zero(_size_,_data_) memset((_data_),0 ,(_size_))
+ #define cc_ctx_decl(_type_, _size_, _name_)  _type_ _name_ [cc_ctx_n(_type_, _size_)]
 #endif
 
+/* bzero is deprecated. memset is the way to go */
+/* FWIW, L4, HEXAGON and ARMCC even with gnu compatibility mode don't have bzero */
+#define cc_zero(_size_,_data_) memset((_data_),0 ,(_size_))
+
 /* cc_clear:
  Set "len" bytes of memory to zero at address "dst".
  cc_clear has been developed so that it won't be optimized out.
@@ -69,19 +74,17 @@ void cc_xor(size_t size, void *r, const void *s, const void *t) {
     }
 }
 
-/* cc_cmp_safe:
- Compare "num" pointed by ptr1 and ptr2, array of identical size.
- Functional behavior: Returns 0 if the "num" bytes starting at ptr1 are identical to the "num"
-    bytes starting at ptr2.
-    Return !=0 if they are different or if "num" is 0 (empty arrays)
- Security: The execution time/cycles is *independent* of the data and therefore guarantees
-    no leak about the data.
-    However, the execution time depends on "num".
-*/
+/*!
+ @brief cc_cmp_safe(num, pt1, pt2) compares two array ptr1 and ptr2 of num bytes.
+ @discussion The execution time/cycles is independent of the data and therefore guarantees no leak about the data. However, the execution time depends on num.
+ @param num  number of bytes in each array
+ @param ptr1 input array
+ @param ptr2 input array
+ @return  returns 0 if the num bytes starting at ptr1 are identical to the num bytes starting at ptr2 and 1 if they are different or if num is 0 (empty arrays).
+ */
 CC_NONNULL2 CC_NONNULL3
 int cc_cmp_safe (size_t num, const void * ptr1, const void * ptr2);
 
-
 /* Exchange S and T of any type.  NOTE: Both and S and T are evaluated
    mutliple times and MUST NOT be expressions. */
 #define CC_SWAP(S,T)  do { \