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