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