Remove DECAF_NONNULL
[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 #include <openssl/e_os2.h>
18
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22
23 /** @cond internal */
24 #if defined(DOXYGEN) && !defined(__attribute__)
25 #define __attribute__((x))
26 #endif
27 #define DECAF_NOINLINE  __attribute__((noinline))
28 /** @endcond */
29
30 /* Internal word types.
31  *
32  * Somewhat tricky.  This could be decided separately per platform.  However,
33  * the structs do need to be all the same size and alignment on a given
34  * platform to support dynamic linking, since even if you header was built
35  * with eg arch_neon, you might end up linking a library built with arch_arm32.
36  */
37 #ifndef DECAF_WORD_BITS
38     #if (defined(__ILP64__) || defined(__amd64__) || defined(__x86_64__) || (((__UINT_FAST32_MAX__)>>30)>>30))
39         #define DECAF_WORD_BITS 64 /**< The number of bits in a word */
40     #else
41         #define DECAF_WORD_BITS 32 /**< The number of bits in a word */
42     #endif
43 #endif
44     
45 #if DECAF_WORD_BITS == 64
46 typedef uint64_t decaf_word_t;      /**< Word size for internal computations */
47 typedef int64_t decaf_sword_t;      /**< Signed word size for internal computations */
48 typedef uint64_t decaf_bool_t;      /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
49 typedef __uint128_t decaf_dword_t;  /**< Double-word size for internal computations */
50 typedef __int128_t decaf_dsword_t;  /**< Signed double-word size for internal computations */
51 #elif DECAF_WORD_BITS == 32         /**< The number of bits in a word */
52 typedef uint32_t decaf_word_t;      /**< Word size for internal computations */
53 typedef int32_t decaf_sword_t;      /**< Signed word size for internal computations */
54 typedef uint32_t decaf_bool_t;      /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
55 typedef uint64_t decaf_dword_t;     /**< Double-word size for internal computations */
56 typedef int64_t decaf_dsword_t;     /**< Signed double-word size for internal computations */
57 #else
58 #error "Only supporting DECAF_WORD_BITS = 32 or 64 for now"
59 #endif
60     
61 /** DECAF_TRUE = -1 so that DECAF_TRUE & x = x */
62 static const decaf_bool_t DECAF_TRUE = -(decaf_bool_t)1;
63
64 /** DECAF_FALSE = 0 so that DECAF_FALSE & x = 0 */
65 static const decaf_bool_t DECAF_FALSE = 0;
66
67 /** Another boolean type used to indicate success or failure. */
68 typedef enum {
69     DECAF_SUCCESS = -1, /**< The operation succeeded. */
70     DECAF_FAILURE = 0   /**< The operation failed. */
71 } decaf_error_t;
72
73
74 /** Return success if x is true */
75 static ossl_inline decaf_error_t
76 decaf_succeed_if(decaf_bool_t x) {
77     return (decaf_error_t)x;
78 }
79
80 /** Return DECAF_TRUE iff x == DECAF_SUCCESS */
81 static ossl_inline decaf_bool_t
82 decaf_successful(decaf_error_t e) {
83     decaf_dword_t w = ((decaf_word_t)e) ^  ((decaf_word_t)DECAF_SUCCESS);
84     return (w-1)>>DECAF_WORD_BITS;
85 }
86     
87 #ifdef __cplusplus
88 } /* extern "C" */
89 #endif
90     
91 #endif /* __DECAF_COMMON_H__ */