util.h File Reference

#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <limits.h>

Include dependency graph for util.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	secp256k1_callback

Macros
#define	TEST_FAILURE(msg)
#define	EXPECT(x, c)   (x)
#define	CHECK(cond)
#define	VERIFY_CHECK(cond)   do { (void)(cond); } while(0)
#define	VERIFY_SETUP(stmt)
#define	VG_UNDEF(x, y)
#define	VG_CHECK(x, y)
#define	VG_CHECK_VERIFY(x, y)
#define	ALIGNMENT   16
#define	ROUND_TO_ALIGN(size)   ((((size) + ALIGNMENT - 1) / ALIGNMENT) * ALIGNMENT)
#define	SECP256K1_RESTRICT
#define	I64FORMAT   "lld"
#define	I64uFORMAT   "llu"
#define	SECP256K1_GNUC_EXT
#define	SECP256K1_WIDEMUL_INT64   1
#define	__has_builtin(x)   0

Functions
static SECP256K1_INLINE void	secp256k1_callback_call (const secp256k1_callback *const cb, const char *const text)
static SECP256K1_INLINE void *	checked_malloc (const secp256k1_callback *cb, size_t size)
static SECP256K1_INLINE void *	checked_realloc (const secp256k1_callback *cb, void *ptr, size_t size)
static SECP256K1_INLINE void *	manual_alloc (void **prealloc_ptr, size_t alloc_size, void *base, size_t max_size)
static SECP256K1_INLINE void	secp256k1_memczero (void *s, size_t len, int flag)
static SECP256K1_INLINE int	secp256k1_memcmp_var (const void *s1, const void *s2, size_t n)
	Semantics like memcmp.
static SECP256K1_INLINE void	secp256k1_int_cmov (int *r, const int *a, int flag)
	If flag is true, set *r equal to *a; otherwise leave it.
static SECP256K1_INLINE int	secp256k1_ctz32_var_debruijn (uint32_t x)
static SECP256K1_INLINE int	secp256k1_ctz64_var_debruijn (uint64_t x)
static SECP256K1_INLINE int	secp256k1_ctz32_var (uint32_t x)
static SECP256K1_INLINE int	secp256k1_ctz64_var (uint64_t x)

Macro Definition Documentation

__has_builtin

#define __has_builtin

(

x

)

0

Definition at line 280 of file util.h.

ALIGNMENT

#define ALIGNMENT   16

Definition at line 113 of file util.h.

CHECK

#define CHECK

(

cond

)

Value:

    do { \
    if (EXPECT(!(cond), 0)) { \
        TEST_FAILURE("test condition failed: " #cond); \
    } \
} while(0)

Definition at line 53 of file util.h.

EXPECT

#define EXPECT	(		x,
			c
	)		(x)

Definition at line 43 of file util.h.

I64FORMAT

#define I64FORMAT   "lld"

Definition at line 169 of file util.h.

I64uFORMAT

#define I64uFORMAT   "llu"

Definition at line 170 of file util.h.

ROUND_TO_ALIGN

#define ROUND_TO_ALIGN

(

size

)

((((size) + ALIGNMENT - 1) / ALIGNMENT) * ALIGNMENT)

Definition at line 116 of file util.h.

SECP256K1_GNUC_EXT

#define SECP256K1_GNUC_EXT

Definition at line 176 of file util.h.

SECP256K1_RESTRICT

#define SECP256K1_RESTRICT

Definition at line 158 of file util.h.

SECP256K1_WIDEMUL_INT64

#define SECP256K1_WIDEMUL_INT64   1

Definition at line 266 of file util.h.

TEST_FAILURE

#define TEST_FAILURE

(

msg

)

Value:

    do { \
    fprintf(stderr, "%s:%d: %s\n", __FILE__, __LINE__, msg); \
    abort(); \
} while(0)

Definition at line 34 of file util.h.

VERIFY_CHECK

#define VERIFY_CHECK

(

cond

)

do { (void)(cond); } while(0)

Definition at line 68 of file util.h.

VERIFY_SETUP

#define VERIFY_SETUP

(

stmt

)

Definition at line 69 of file util.h.

VG_CHECK

#define VG_CHECK	(		x,
			y
	)

Definition at line 80 of file util.h.

VG_CHECK_VERIFY

#define VG_CHECK_VERIFY	(		x,
			y
	)

Definition at line 88 of file util.h.

VG_UNDEF

#define VG_UNDEF	(		x,
			y
	)

Definition at line 79 of file util.h.

Function Documentation

checked_malloc()

static SECP256K1_INLINE void * checked_malloc ( const secp256k1_callback *  cb, size_t  size  )

static

Definition at line 91 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

checked_realloc()

static SECP256K1_INLINE void * checked_realloc ( const secp256k1_callback *  cb, void *  ptr, size_t  size  )

static

Definition at line 99 of file util.h.

Here is the call graph for this function:

manual_alloc()

static SECP256K1_INLINE void * manual_alloc ( void **  prealloc_ptr, size_t  alloc_size, void *  base, size_t  max_size  )

static

Definition at line 134 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_callback_call()

static SECP256K1_INLINE void secp256k1_callback_call ( const secp256k1_callback *const  cb, const char *const  text  )

static

Definition at line 24 of file util.h.

Here is the caller graph for this function:

secp256k1_ctz32_var()

static SECP256K1_INLINE int secp256k1_ctz32_var ( uint32_t  x )

static

Definition at line 309 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_ctz32_var_debruijn()

static SECP256K1_INLINE int secp256k1_ctz32_var_debruijn ( uint32_t  x )

static

Definition at line 286 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_ctz64_var()

static SECP256K1_INLINE int secp256k1_ctz64_var ( uint64_t  x )

static

Definition at line 327 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_ctz64_var_debruijn()

static SECP256K1_INLINE int secp256k1_ctz64_var_debruijn ( uint64_t  x )

static

Definition at line 298 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_int_cmov()

static SECP256K1_INLINE void secp256k1_int_cmov ( int *  r, const int *  a, int  flag  )

static

If flag is true, set *r equal to *a; otherwise leave it.

Constant-time. Both *r and *a must be initialized and non-negative.

Definition at line 238 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_memcmp_var()

static SECP256K1_INLINE int secp256k1_memcmp_var ( const void *  s1, const void *  s2, size_t  n  )

static

Semantics like memcmp.

Variable-time.

We use this to avoid possible compiler bugs with memcmp, e.g. https://gcc.gnu.org/bugzilla/show_bug.cgi?id=95189

Definition at line 224 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_memczero()

static SECP256K1_INLINE void secp256k1_memczero ( void *  s, size_t  len, int  flag  )

static

Definition at line 205 of file util.h.

Here is the call graph for this function:

Here is the caller graph for this function: