ethminer/ethash.h

/*
  This file is part of ethash.

  ethash is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  ethash is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with ethash.  If not, see <http://www.gnu.org/licenses/>.
*/

/** @file ethash.h
* @date 2015
*/
#pragma once

#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <stddef.h>
#include "compiler.h"

#define REVISION 23
#define DATASET_BYTES_INIT 1073741824U // 2**30
#define DATASET_BYTES_GROWTH 8388608U  // 2**23
#define CACHE_BYTES_INIT 1073741824U // 2**24
#define CACHE_BYTES_GROWTH 131072U  // 2**17
#define EPOCH_LENGTH 30000U
#define MIX_BYTES 128
#define HASH_BYTES 64
#define DATASET_PARENTS 256
#define CACHE_ROUNDS 3
#define ACCESSES 64

#ifdef __cplusplus
extern "C" {
#endif

// LTODO: for consistency's sake maybe use ethash_params_t?
typedef struct ethash_params {
    /// Size of full data set (in bytes, multiple of mix size (128)).
    int64_t full_size;
    /// Size of compute cache (in bytes, multiple of node size (64)).
    uint64_t cache_size;
} ethash_params;

/// Type of a seedhash/blockhash e.t.c.
typedef struct ethash_h256 { uint8_t b[32]; } ethash_h256_t;
static inline uint8_t ethash_h256_get(ethash_h256_t const* hash, unsigned int i)
{
    return hash->b[i];
}

static inline void ethash_h256_set(ethash_h256_t *hash, unsigned int i, uint8_t v)
{
    hash->b[i] = v;
}

static inline void ethash_h256_reset(ethash_h256_t *hash)
{
    memset(hash, 0, 32);
}

struct ethash_light;
typedef struct ethash_light* ethash_light_t;
struct ethash_full;
typedef struct ethash_full* ethash_full_t;
typedef int(*ethash_callback_t)(unsigned);

// LTODO: for consistency's sake maybe use ethash_return_value_t?
typedef struct ethash_return_value {
    ethash_h256_t result;
    ethash_h256_t mix_hash;
} ethash_return_value;

uint64_t ethash_get_datasize(const uint32_t block_number);
uint64_t ethash_get_cachesize(const uint32_t block_number);

// initialize the parameters
static inline void ethash_params_init(ethash_params *params, const uint32_t block_number) {
    params->full_size = ethash_get_datasize(block_number);
    params->cache_size = ethash_get_cachesize(block_number);
}

// LTODO: for consistency's sake maybe use ethash_cache_t?
typedef struct ethash_cache {
    void *mem;
} ethash_cache;

/**
 * Allocate and initialize a new ethash_cache object
 *
 * @param params    The parameters to initialize it with. We are interested in
 *                  the cache_size from here
 * @param seed      Block seedhash to be used during the computation of the
 *                  cache nodes
 * @return          Newly allocated ethash_cache on success or NULL in case of
 *                  ERRNOMEM or invalid parameters used for @ref ethash_compute_cache_nodes()
 */
ethash_cache *ethash_cache_new(ethash_params const *params, ethash_h256_t const *seed);
/**
 * Frees a previously allocated ethash_cache
 * @param c        The object to free
 */
void ethash_cache_delete(ethash_cache *c);
bool ethash_compute_full_data(void *mem, ethash_params const *params, ethash_cache const *cache);

/**
 * Allocate and initialize a new ethash_light handler
 *
 * @param params    The parameters to initialize it with. We are interested in
 *                  the cache_size from here
 * @param seed      Block seedhash to be used during the computation of the
 *                  cache nodes
 * @return          Newly allocated ethash_light handler or NULL in case of
 *                  ERRNOMEM or invalid parameters used for @ref ethash_compute_cache_nodes()
 */
ethash_light_t ethash_light_new(ethash_params const *params, ethash_h256_t const *seed);
/**
 * Frees a previously allocated ethash_light handler
 * @param light    The light handler to free
 */
void ethash_light_delete(ethash_light_t light);
void ethash_light_compute(ethash_return_value *ret,
                          ethash_light_t light,
                          ethash_params const *params,
                          const ethash_h256_t *header_hash,
                          const uint64_t nonce);
/**
 * Allocate and initialize a new ethash_full handler
 *
 * @param params    The parameters to initialize it with. We are interested in
 *                  the full_size from here
 * @param cache     A cache object to use that was allocated with @ref ethash_cache_new().
 *                  Iff this function succeeds the ethash_full_t will take memory
 *                  ownership of the cache and free it at deletion. If not then the user
 *                  still has to handle freeing of the cache himself.
 * @param seed      Block seedhash. TODO: Do we really need this in this function?
 * @return          Newly allocated ethash_full handler or NULL in case of
 *                  ERRNOMEM or invalid parameters used for @ref ethash_compute_full_data()
 */
ethash_full_t ethash_full_new(ethash_params const* params,
                              ethash_cache const* cache,
                              const ethash_h256_t *seed,
                              ethash_callback_t callback);
/**
 * Frees a previously allocated ethash_full handler
 * @param full    The light handler to free
 */
void ethash_full_delete(ethash_full_t full);
void ethash_full_compute(ethash_return_value *ret,
                         ethash_full_t full,
                         ethash_params const *params,
                         const ethash_h256_t *header_hash,
                         const uint64_t nonce);

void ethash_get_seedhash(ethash_h256_t *seedhash, const uint32_t block_number);

// Returns if hash is less than or equal to difficulty
static inline int ethash_check_difficulty(ethash_h256_t const *hash,
                                          ethash_h256_t const *difficulty)
{
    // Difficulty is big endian
    for (int i = 0; i < 32; i++) {
        if (ethash_h256_get(hash, i) == ethash_h256_get(difficulty, i)) {
            continue;
        }
        return ethash_h256_get(hash, i) < ethash_h256_get(difficulty, i);
    }
    return 1;
}

int ethash_quick_check_difficulty(ethash_h256_t const *header_hash,
                                  const uint64_t nonce,
                                  ethash_h256_t const *mix_hash,
                                  ethash_h256_t const *difficulty);

#ifdef __cplusplus
}
#endif