6 * Copyright (c) 2015 Cryptography Research, Inc. \n
7 * Released under the MIT License. See LICENSE.txt for license information.
9 * @brief Common utility headers for Decaf library.
12 #ifndef __DECAF_COMMON_H__
13 #define __DECAF_COMMON_H__ 1
15 #include <openssl/e_os2.h>
21 /* Internal word types.
23 * Somewhat tricky. This could be decided separately per platform. However,
24 * the structs do need to be all the same size and alignment on a given
25 * platform to support dynamic linking, since even if you header was built
26 * with eg arch_neon, you might end up linking a library built with arch_arm32.
28 #ifndef DECAF_WORD_BITS
29 #if (defined(__ILP64__) || defined(__amd64__) || defined(__x86_64__) || (((__UINT_FAST32_MAX__)>>30)>>30))
30 #define DECAF_WORD_BITS 64 /**< The number of bits in a word */
32 #define DECAF_WORD_BITS 32 /**< The number of bits in a word */
36 #if DECAF_WORD_BITS == 64
37 typedef uint64_t decaf_word_t; /**< Word size for internal computations */
38 typedef int64_t decaf_sword_t; /**< Signed word size for internal computations */
39 typedef uint64_t decaf_bool_t; /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
40 typedef __uint128_t decaf_dword_t; /**< Double-word size for internal computations */
41 typedef __int128_t decaf_dsword_t; /**< Signed double-word size for internal computations */
42 #elif DECAF_WORD_BITS == 32 /**< The number of bits in a word */
43 typedef uint32_t decaf_word_t; /**< Word size for internal computations */
44 typedef int32_t decaf_sword_t; /**< Signed word size for internal computations */
45 typedef uint32_t decaf_bool_t; /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
46 typedef uint64_t decaf_dword_t; /**< Double-word size for internal computations */
47 typedef int64_t decaf_dsword_t; /**< Signed double-word size for internal computations */
49 #error "Only supporting DECAF_WORD_BITS = 32 or 64 for now"
52 /** DECAF_TRUE = -1 so that DECAF_TRUE & x = x */
53 static const decaf_bool_t DECAF_TRUE = -(decaf_bool_t)1;
55 /** DECAF_FALSE = 0 so that DECAF_FALSE & x = 0 */
56 static const decaf_bool_t DECAF_FALSE = 0;
58 /** Another boolean type used to indicate success or failure. */
60 DECAF_SUCCESS = -1, /**< The operation succeeded. */
61 DECAF_FAILURE = 0 /**< The operation failed. */
65 /** Return success if x is true */
66 static ossl_inline decaf_error_t
67 decaf_succeed_if(decaf_bool_t x) {
68 return (decaf_error_t)x;
71 /** Return DECAF_TRUE iff x == DECAF_SUCCESS */
72 static ossl_inline decaf_bool_t
73 decaf_successful(decaf_error_t e) {
74 decaf_dword_t w = ((decaf_word_t)e) ^ ((decaf_word_t)DECAF_SUCCESS);
75 return (w-1)>>DECAF_WORD_BITS;
82 #endif /* __DECAF_COMMON_H__ */