Some more cleanups of curve448 code
[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 #   define C448_WORD_BITS 64      /* The number of bits in a word */
28 #  else
29 #   define C448_WORD_BITS 32      /* The number of bits in a word */
30 #  endif
31 # endif
32
33 # if C448_WORD_BITS == 64
34 /* Word size for internal computations */
35 typedef uint64_t c448_word_t;
36 /* Signed word size for internal computations */
37 typedef int64_t c448_sword_t;
38 /* "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
39 typedef uint64_t c448_bool_t;
40 /* Double-word size for internal computations */
41 typedef __uint128_t c448_dword_t;
42 /* Signed double-word size for internal computations */
43 typedef __int128_t c448_dsword_t;
44 # elif C448_WORD_BITS == 32
45 /* Word size for internal computations */
46 typedef uint32_t c448_word_t;
47 /* Signed word size for internal computations */
48 typedef int32_t c448_sword_t;
49 /* "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
50 typedef uint32_t c448_bool_t;
51 /* Double-word size for internal computations */
52 typedef uint64_t c448_dword_t;
53 /* Signed double-word size for internal computations */
54 typedef int64_t c448_dsword_t;
55 # else
56 #  error "Only supporting C448_WORD_BITS = 32 or 64 for now"
57 # endif
58
59 /* C448_TRUE = -1 so that C448_TRUE & x = x */
60 # define C448_TRUE      (0 - (c448_bool_t)1)
61
62 /* C448_FALSE = 0 so that C448_FALSE & x = 0 */
63 # define C448_FALSE     0
64
65 /* Another boolean type used to indicate success or failure. */
66 typedef enum {
67     C448_SUCCESS = -1, /**< The operation succeeded. */
68     C448_FAILURE = 0   /**< The operation failed. */
69 } c448_error_t;
70
71 /* Return success if x is true */
72 static ossl_inline c448_error_t c448_succeed_if(c448_bool_t x)
73 {
74     return (c448_error_t) x;
75 }
76
77 #endif                          /* __C448_COMMON_H__ */