checkasm.h

Go to the documentation of this file.

/*
 * Copyright © 2025, Niklas Haas
 * Copyright © 2018, VideoLAN and dav1d authors
 * Copyright © 2018, Two Orioles, LLC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

 
#ifndef CHECKASM_CHECKASM_H
#define CHECKASM_CHECKASM_H
 
#include <stdint.h>
 
#include "checkasm/attributes.h"


#ifndef CHECKASM_HAVE_GENERIC
  #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
    #define CHECKASM_HAVE_GENERIC 1
  #else
    #define CHECKASM_HAVE_GENERIC 0
  #endif
#endif
 /* end of config group */

typedef uint64_t CheckasmCpu;

typedef uintptr_t CheckasmKey;

typedef struct CheckasmCpuInfo {
    const char *name;   
    const char *suffix; 
    CheckasmCpu flag;   

    CheckasmCpu mask;
} CheckasmCpuInfo;

typedef struct CheckasmTest {
    const char *name;   
    void (*func)(void); 

    void (*init)(void);
    void (*uninit)(void);
} CheckasmTest;

typedef enum CheckasmFormat {
    CHECKASM_FORMAT_PRETTY, 
    CHECKASM_FORMAT_CSV,    
    CHECKASM_FORMAT_TSV,    
    CHECKASM_FORMAT_JSON,   
    CHECKASM_FORMAT_HTML,   
} CheckasmFormat;

typedef struct CheckasmConfig {
    const CheckasmCpuInfo *cpu_flags;

    const CheckasmTest *tests;

    CheckasmCpu cpu;

    void (*set_cpu_flags)(CheckasmCpu new_flags);

    const char *test_pattern;

    const char *function_pattern;

    int bench;

    unsigned bench_usec;

    CheckasmFormat format;

    int verbose;

    int seed_set;

    unsigned seed;

    unsigned repeat;

    int cpu_affinity_set;

    unsigned cpu_affinity;
} CheckasmConfig;

CHECKASM_API CheckasmCpu checkasm_get_cpu_flags(void);

CHECKASM_API const CheckasmCpuInfo *checkasm_get_cpu_info(void);

static inline const char *checkasm_get_cpu_suffix(void)
{
    const CheckasmCpuInfo *info = checkasm_get_cpu_info();
    return info ? info->suffix : "c";
}

CHECKASM_API void checkasm_list_cpu_flags(const CheckasmConfig *config);

CHECKASM_API void checkasm_list_tests(const CheckasmConfig *config);

CHECKASM_API void checkasm_list_functions(const CheckasmConfig *config);

CHECKASM_API int checkasm_run(const CheckasmConfig *config);

CHECKASM_API int checkasm_main(CheckasmConfig *config, int argc, const char *argv[]);
 
#endif /* CHECKASM_CHECKASM_H */