crypto/ec/curve448/decaf/common.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
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 /* Goldilocks' build flags default to hidden and stripping executables. */
  23 /** @cond internal */
  24 #if defined(DOXYGEN) && !defined(__attribute__)
  25 #define __attribute__((x))
  26 #endif
  27 #define DECAF_API_VIS __attribute__((visibility("default")))
  28 #define DECAF_NOINLINE  __attribute__((noinline))
  29 #define DECAF_WARN_UNUSED __attribute__((warn_unused_result))
  30 #define DECAF_NONNULL __attribute__((nonnull))
  31 #define DECAF_INLINE inline __attribute__((always_inline,unused))
  32 // Cribbed from libnotmuch
  33 #if defined (__clang_major__) && __clang_major__ >= 3 \
  34     || defined (__GNUC__) && __GNUC__ >= 5 \
  35     || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
  36 #define DECAF_DEPRECATED(msg) __attribute__ ((deprecated(msg)))
  37 #else
  38 #define DECAF_DEPRECATED(msg) __attribute__ ((deprecated))
  39 #endif
  40 /** @endcond */
  41
  42 /* Internal word types.
  43  *
  44  * Somewhat tricky.  This could be decided separately per platform.  However,
  45  * the structs do need to be all the same size and alignment on a given
  46  * platform to support dynamic linking, since even if you header was built
  47  * with eg arch_neon, you might end up linking a library built with arch_arm32.
  48  */
  49 #ifndef DECAF_WORD_BITS
  50     #if (defined(__ILP64__) || defined(__amd64__) || defined(__x86_64__) || (((__UINT_FAST32_MAX__)>>30)>>30))
  51         #define DECAF_WORD_BITS 64 /**< The number of bits in a word */
  52     #else
  53         #define DECAF_WORD_BITS 32 /**< The number of bits in a word */
  54     #endif
  55 #endif
  56
  57 #if DECAF_WORD_BITS == 64
  58 typedef uint64_t decaf_word_t;      /**< Word size for internal computations */
  59 typedef int64_t decaf_sword_t;      /**< Signed word size for internal computations */
  60 typedef uint64_t decaf_bool_t;      /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
  61 typedef __uint128_t decaf_dword_t;  /**< Double-word size for internal computations */
  62 typedef __int128_t decaf_dsword_t;  /**< Signed double-word size for internal computations */
  63 #elif DECAF_WORD_BITS == 32         /**< The number of bits in a word */
  64 typedef uint32_t decaf_word_t;      /**< Word size for internal computations */
  65 typedef int32_t decaf_sword_t;      /**< Signed word size for internal computations */
  66 typedef uint32_t decaf_bool_t;      /**< "Boolean" type, will be set to all-zero or all-one (i.e. -1u) */
  67 typedef uint64_t decaf_dword_t;     /**< Double-word size for internal computations */
  68 typedef int64_t decaf_dsword_t;     /**< Signed double-word size for internal computations */
  69 #else
  70 #error "Only supporting DECAF_WORD_BITS = 32 or 64 for now"
  71 #endif
  72
  73 /** DECAF_TRUE = -1 so that DECAF_TRUE & x = x */
  74 static const decaf_bool_t DECAF_TRUE = -(decaf_bool_t)1;
  75
  76 /** DECAF_FALSE = 0 so that DECAF_FALSE & x = 0 */
  77 static const decaf_bool_t DECAF_FALSE = 0;
  78
  79 /** Another boolean type used to indicate success or failure. */
  80 typedef enum {
  81     DECAF_SUCCESS = -1, /**< The operation succeeded. */
  82     DECAF_FAILURE = 0   /**< The operation failed. */
  83 } decaf_error_t;
  84
  85
  86 /** Return success if x is true */
  87 static DECAF_INLINE decaf_error_t
  88 decaf_succeed_if(decaf_bool_t x) {
  89     return (decaf_error_t)x;
  90 }
  91
  92 /** Return DECAF_TRUE iff x == DECAF_SUCCESS */
  93 static DECAF_INLINE decaf_bool_t
  94 decaf_successful(decaf_error_t e) {
  95     decaf_dword_t w = ((decaf_word_t)e) ^  ((decaf_word_t)DECAF_SUCCESS);
  96     return (w-1)>>DECAF_WORD_BITS;
  97 }
  98
  99 /** Overwrite data with zeros.  Uses memset_s if available. */
 100 void decaf_bzero (
 101     void *data,
 102     size_t size
 103 ) DECAF_NONNULL DECAF_API_VIS;
 104
 105 /** Compare two buffers, returning DECAF_TRUE if they are equal. */
 106 decaf_bool_t decaf_memeq (
 107     const void *data1,
 108     const void *data2,
 109     size_t size
 110 ) DECAF_NONNULL DECAF_WARN_UNUSED DECAF_API_VIS;
 111
 112 #ifdef __cplusplus
 113 } /* extern "C" */
 114 #endif
 115
 116 #endif /* __DECAF_COMMON_H__ */