Buffer Comparison Utilities

Functions and macros for comparing multi-dimensional buffers. More...

Collaboration diagram for Buffer Comparison Utilities:

Macros
#define	CHECKASM_ALIGN(x)
	Declare a variable with platform-specific alignment requirements.
#define	checkasm_check(type, ...)
	Compare two 2D buffers and fail test if different.
#define	checkasm_check_padded(type, ...)
	Compare two 2D buffers, including padding regions (detect over-write).

Detailed Description

Functions and macros for comparing multi-dimensional buffers.

These utilities compare 2D buffers (with stride support) and detect differences, including in padding regions. Used to verify that optimized implementations produce bit-identical output to reference implementations.

Macro Definition Documentation

CHECKASM_ALIGN

#define CHECKASM_ALIGN

(

x

)

Value:

x __attribute__((aligned(CHECKASM_ALIGNMENT)))

Declare a variable with platform-specific alignment requirements.

Parameters

x	Variable declaration

Note

This must be applied to each buffer individually!

// correct
CHECKASM_ALIGN(uint8_t buf1[64*64]);
CHECKASM_ALIGN(uint8_t buf2[64*64]);
 
// wrong
CHECKASM_ALIGN(uint8_t buf1[64*64], buf2[64*64]);

checkasm_check

#define checkasm_check	(		type,
			... )

Value:

checkasm_check2(type, __VA_ARGS__, 0, 0, 0)

Compare two 2D buffers and fail test if different.

Parameters

type	Element type (e.g., uint8_t, int, float)
buf1	First buffer pointer to compare
stride1	First buffer stride in bytes
buf2	Second buffer pointer to compare
stride2	Second buffer stride in bytes
w	Width of the buffers in elements
h	Height of the buffers in lines
name	Name of the buffer (for error reporting)
...	Extra parameters (e.g. max_ulp for checkasm_check(float_ulp, ...))

Note

This will automatically print a hexdump of the differing regions on failure, if verbose mode is enabled.

CHECKASM_ALIGN(uint8_t buf1[128]);
CHECKASM_ALIGN(uint8_t buf2[128]);
 
for (int w = 8; w <= 128; w <<= 1) {
    if (checkasm_check_func(..., "myfunc_w%d", w)) {
        checkasm_call_ref(buf1, w);
        checkasm_call_new(buf2, w);
        checkasm_check(uint8_t, buf1, 0, buf2, 0, w, 1, "buffer");
    }
}

checkasm_check_padded

#define checkasm_check_padded	(		type,
			... )

Value:

checkasm_check2(type, __VA_ARGS__)

Compare two 2D buffers, including padding regions (detect over-write).

Parameters

type	Element type (e.g., uint8_t, int, float)
buf1	First buffer pointer to compare
stride1	First buffer stride in bytes
buf2	Second buffer pointer to compare
stride2	Second buffer stride in bytes
w	Width of the buffers in elements
h	Height of the buffers in lines
name	Name of the buffer (for error reporting)
...	Extra parameters (e.g. max_ulp for checkasm_check(float_ulp, ...))
align_w	Horizontal alignment of the allowed over-write (elements)
align_h	Vertical alignment of the allowed over-write (lines)
padding	Number of extra elements/lines of padding to check (past the alignment boundaries)

See also

checkasm_check(), checkasm_check_rect_padded()