ec/curve448: portability fixups.
[openssl.git] / crypto / ec / curve448 / curve448utils.h
1 /*
2  * Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright 2015 Cryptography Research, Inc.
4  *
5  * Licensed under the OpenSSL license (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  *
10  * Originally written by Mike Hamburg
11  */
12
13 #ifndef HEADER_CURVE448UTILS_H
14 # define HEADER_CURVE448UTILS_H
15
16 # include <openssl/e_os2.h>
17
18 /*
19  * Internal word types. Somewhat tricky.  This could be decided separately per
20  * platform.  However, the structs do need to be all the same size and
21  * alignment on a given platform to support dynamic linking, since even if you
22  * header was built with eg arch_neon, you might end up linking a library built
23  * with arch_arm32.
24  */
25 # ifndef C448_WORD_BITS
26 #  if (defined(__SIZEOF_INT128__) && (__SIZEOF_INT128__ == 16)) \
27       && !defined(__sparc__)
28 #   define C448_WORD_BITS 64      /* The number of bits in a word */
29 #  else
30 #   define C448_WORD_BITS 32      /* The number of bits in a word */
31 #  endif
32 # endif
33
34 # if C448_WORD_BITS == 64
35 /* Word size for internal computations */
36 typedef uint64_t c448_word_t;
37 /* Signed word size for internal computations */
38 typedef int64_t c448_sword_t;
39 /* "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
40 typedef uint64_t c448_bool_t;
41 /* Double-word size for internal computations */
42 typedef __uint128_t c448_dword_t;
43 /* Signed double-word size for internal computations */
44 typedef __int128_t c448_dsword_t;
45 # elif C448_WORD_BITS == 32
46 /* Word size for internal computations */
47 typedef uint32_t c448_word_t;
48 /* Signed word size for internal computations */
49 typedef int32_t c448_sword_t;
50 /* "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
51 typedef uint32_t c448_bool_t;
52 /* Double-word size for internal computations */
53 typedef uint64_t c448_dword_t;
54 /* Signed double-word size for internal computations */
55 typedef int64_t c448_dsword_t;
56 # else
57 #  error "Only supporting C448_WORD_BITS = 32 or 64 for now"
58 # endif
59
60 /* C448_TRUE = -1 so that C448_TRUE & x = x */
61 # define C448_TRUE      (0 - (c448_bool_t)1)
62
63 /* C448_FALSE = 0 so that C448_FALSE & x = 0 */
64 # define C448_FALSE     0
65
66 /* Another boolean type used to indicate success or failure. */
67 typedef enum {
68     C448_SUCCESS = -1, /**< The operation succeeded. */
69     C448_FAILURE = 0   /**< The operation failed. */
70 } c448_error_t;
71
72 /* Return success if x is true */
73 static ossl_inline c448_error_t c448_succeed_if(c448_bool_t x)
74 {
75     return (c448_error_t) x;
76 }
77
78 #endif                          /* __C448_COMMON_H__ */