crypto/ec/curve448/curve448utils.h

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