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