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