1ef3d736726598e66a3bceada80b6b9c8a4f6d9c
[openssl.git] / crypto / ec / curve448 / curve448utils.h
1 /**
2  * @file decaf/common.h
3  * @author Mike Hamburg
4  *
5  * @copyright
6  *   Copyright (c) 2015 Cryptography Research, Inc.  \n
7  *   Released under the MIT License.  See LICENSE.txt for license information.
8  *
9  * @brief Common utility headers for Decaf library.
10  */
11
12 #ifndef __DECAF_COMMON_H__
13 #define __DECAF_COMMON_H__ 1
14
15 #include <stdint.h>
16 #include <sys/types.h>
17
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21
22 /* Goldilocks' build flags default to hidden and stripping executables. */
23 /** @cond internal */
24 #if defined(DOXYGEN) && !defined(__attribute__)
25 #define __attribute__((x))
26 #endif
27 #define DECAF_API_VIS __attribute__((visibility("default")))
28 #define DECAF_NOINLINE  __attribute__((noinline))
29 #define DECAF_WARN_UNUSED __attribute__((warn_unused_result))
30 #define DECAF_NONNULL __attribute__((nonnull))
31 #define DECAF_INLINE inline __attribute__((always_inline,unused))
32 /** @endcond */
33
34 /* Internal word types.
35  *
36  * Somewhat tricky.  This could be decided separately per platform.  However,
37  * the structs do need to be all the same size and alignment on a given
38  * platform to support dynamic linking, since even if you header was built
39  * with eg arch_neon, you might end up linking a library built with arch_arm32.
40  */
41 #ifndef DECAF_WORD_BITS
42     #if (defined(__ILP64__) || defined(__amd64__) || defined(__x86_64__) || (((__UINT_FAST32_MAX__)>>30)>>30))
43         #define DECAF_WORD_BITS 64 /**< The number of bits in a word */
44     #else
45         #define DECAF_WORD_BITS 32 /**< The number of bits in a word */
46     #endif
47 #endif
48     
49 #if DECAF_WORD_BITS == 64
50 typedef uint64_t decaf_word_t;      /**< Word size for internal computations */
51 typedef int64_t decaf_sword_t;      /**< Signed word size for internal computations */
52 typedef uint64_t decaf_bool_t;      /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
53 typedef __uint128_t decaf_dword_t;  /**< Double-word size for internal computations */
54 typedef __int128_t decaf_dsword_t;  /**< Signed double-word size for internal computations */
55 #elif DECAF_WORD_BITS == 32         /**< The number of bits in a word */
56 typedef uint32_t decaf_word_t;      /**< Word size for internal computations */
57 typedef int32_t decaf_sword_t;      /**< Signed word size for internal computations */
58 typedef uint32_t decaf_bool_t;      /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
59 typedef uint64_t decaf_dword_t;     /**< Double-word size for internal computations */
60 typedef int64_t decaf_dsword_t;     /**< Signed double-word size for internal computations */
61 #else
62 #error "Only supporting DECAF_WORD_BITS = 32 or 64 for now"
63 #endif
64     
65 /** DECAF_TRUE = -1 so that DECAF_TRUE & x = x */
66 static const decaf_bool_t DECAF_TRUE = -(decaf_bool_t)1;
67
68 /** DECAF_FALSE = 0 so that DECAF_FALSE & x = 0 */
69 static const decaf_bool_t DECAF_FALSE = 0;
70
71 /** Another boolean type used to indicate success or failure. */
72 typedef enum {
73     DECAF_SUCCESS = -1, /**< The operation succeeded. */
74     DECAF_FAILURE = 0   /**< The operation failed. */
75 } decaf_error_t;
76
77
78 /** Return success if x is true */
79 static DECAF_INLINE decaf_error_t
80 decaf_succeed_if(decaf_bool_t x) {
81     return (decaf_error_t)x;
82 }
83
84 /** Return DECAF_TRUE iff x == DECAF_SUCCESS */
85 static DECAF_INLINE decaf_bool_t
86 decaf_successful(decaf_error_t e) {
87     decaf_dword_t w = ((decaf_word_t)e) ^  ((decaf_word_t)DECAF_SUCCESS);
88     return (w-1)>>DECAF_WORD_BITS;
89 }
90     
91 #ifdef __cplusplus
92 } /* extern "C" */
93 #endif
94     
95 #endif /* __DECAF_COMMON_H__ */