secp256k1_preallocated.h File Reference

#include "secp256k1.h"

Include dependency graph for secp256k1_preallocated.h:

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

Go to the source code of this file.

Functions
SECP256K1_API size_t	secp256k1_context_preallocated_size (unsigned int flags) SECP256K1_WARN_UNUSED_RESULT
	Determine the memory size of a secp256k1 context object to be created in caller-provided memory. More...
SECP256K1_API secp256k1_context *	secp256k1_context_preallocated_create (void *prealloc, unsigned int flags) SECP256K1_ARG_NONNULL(1) SECP256K1_WARN_UNUSED_RESULT
	Create a secp256k1 context object in caller-provided memory. More...
SECP256K1_API size_t	secp256k1_context_preallocated_clone_size (const secp256k1_context *ctx) SECP256K1_ARG_NONNULL(1) SECP256K1_WARN_UNUSED_RESULT
	Determine the memory size of a secp256k1 context object to be copied into caller-provided memory. More...
SECP256K1_API secp256k1_context *	secp256k1_context_preallocated_clone (const secp256k1_context *ctx, void *prealloc) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_WARN_UNUSED_RESULT
	Copy a secp256k1 context object into caller-provided memory. More...
SECP256K1_API void	secp256k1_context_preallocated_destroy (secp256k1_context *ctx) SECP256K1_ARG_NONNULL(1)
	Destroy a secp256k1 context object that has been created in caller-provided memory. More...

Function Documentation

secp256k1_context_preallocated_clone()

SECP256K1_API secp256k1_context * secp256k1_context_preallocated_clone	(	const secp256k1_context *	ctx,
		void *	prealloc
	)

Copy a secp256k1 context object into caller-provided memory.

The caller must provide a pointer to a rewritable contiguous block of memory of size at least secp256k1_context_preallocated_size(flags) bytes, suitably aligned to hold an object of any type.

The block of memory is exclusively owned by the created context object during the lifetime of this context object, see the description of secp256k1_context_preallocated_create for details.

Cloning secp256k1_context_static is not possible, and should not be emulated by the caller (e.g., using memcpy). Create a new context instead.

Returns: pointer to a newly created context object. Args: ctx: pointer to a context to copy (not secp256k1_context_static). In: prealloc: pointer to a rewritable contiguous block of memory of size at least secp256k1_context_preallocated_size(flags) bytes, as detailed above.

Definition at line 152 of file secp256k1.c.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_context_preallocated_clone_size()

SECP256K1_API size_t secp256k1_context_preallocated_clone_size

(

const secp256k1_context *

ctx

)

Determine the memory size of a secp256k1 context object to be copied into caller-provided memory.

Returns: the required size of the caller-provided memory block. In: ctx: pointer to a context to copy.

Definition at line 112 of file secp256k1.c.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_context_preallocated_create()

SECP256K1_API secp256k1_context * secp256k1_context_preallocated_create	(	void *	prealloc,
		unsigned int	flags
	)

Create a secp256k1 context object in caller-provided memory.

The caller must provide a pointer to a rewritable contiguous block of memory of size at least secp256k1_context_preallocated_size(flags) bytes, suitably aligned to hold an object of any type.

The block of memory is exclusively owned by the created context object during the lifetime of this context object, which begins with the call to this function and ends when a call to secp256k1_context_preallocated_destroy (which destroys the context object again) returns. During the lifetime of the context object, the caller is obligated not to access this block of memory, i.e., the caller may not read or write the memory, e.g., by copying the memory contents to a different location or trying to create a second context object in the memory. In simpler words, the prealloc pointer (or any pointer derived from it) should not be used during the lifetime of the context object.

Returns: pointer to newly created context object. In: prealloc: pointer to a rewritable contiguous block of memory of size at least secp256k1_context_preallocated_size(flags) bytes, as detailed above. flags: which parts of the context to initialize.

See secp256k1_context_create (in secp256k1.h) for further details.

See also secp256k1_context_randomize (in secp256k1.h) and secp256k1_context_preallocated_destroy.

Definition at line 118 of file secp256k1.c.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_context_preallocated_destroy()

SECP256K1_API void secp256k1_context_preallocated_destroy

(

secp256k1_context *

ctx

)

Destroy a secp256k1 context object that has been created in caller-provided memory.

The context pointer may not be used afterwards.

The context to destroy must have been created using secp256k1_context_preallocated_create or secp256k1_context_preallocated_clone. If the context has instead been created using secp256k1_context_create or secp256k1_context_clone, the behaviour is undefined. In that case, secp256k1_context_destroy must be used instead.

If required, it is the responsibility of the caller to deallocate the block of memory properly after this function returns, e.g., by calling free on the preallocated pointer given to secp256k1_context_preallocated_create or secp256k1_context_preallocated_clone.

Args: ctx: pointer to a context to destroy, constructed using secp256k1_context_preallocated_create or secp256k1_context_preallocated_clone (i.e., not secp256k1_context_static).

Definition at line 176 of file secp256k1.c.

Here is the call graph for this function:

Here is the caller graph for this function:

secp256k1_context_preallocated_size()

SECP256K1_API size_t secp256k1_context_preallocated_size

(

unsigned int

flags

)

Determine the memory size of a secp256k1 context object to be created in caller-provided memory.

The purpose of this function is to determine how much memory must be provided to secp256k1_context_preallocated_create.

Returns: the required size of the caller-provided memory block In: flags: which parts of the context to initialize.

Definition at line 92 of file secp256k1.c.

Here is the call graph for this function:

Here is the caller graph for this function: