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