memutils.h

Go to the documentation of this file.

/*
 * 2025 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE: This software and all accompanying materials are the exclusive 
 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
 * The intellectual and technical concepts contained within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDARDS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the **Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL)**. The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: john.underhill@protonmail.com
 */
 
#ifndef QSC_MEMUTILS_H
#define QSC_MEMUTILS_H
 
#include "common.h"
#include "intrinsics.h"
 
QSC_CPLUSPLUS_ENABLED_START


#if defined(QSC_SYSTEM_COMPILER_MSC)
    #include <intrin.h>
    #define QSC_MEMUTILS_MEMORY_FENCE() _ReadWriteBarrier()
#elif defined(QSC_SYSTEM_COMPILER_GCC)
    #define QSC_MEMUTILS_MEMORY_FENCE() __asm__ __volatile__ ("" ::: "memory")
#else
    #define QSC_MEMUTILS_MEMORY_FENCE()
#endif

#define QSC_MEMUTILS_CACHE_LINE_SIZE 64ULL

#define QSC_MEMUTILS_MEMORY_PAGE_SIZE 4096ULL

QSC_EXPORT_API void qsc_memutils_flush_cache_line(void *address);

QSC_EXPORT_API void qsc_memutils_prefetch_l1(uint8_t* address, size_t length);

QSC_EXPORT_API void qsc_memutils_prefetch_l2(uint8_t* address, size_t length);

QSC_EXPORT_API void qsc_memutils_prefetch_l3(uint8_t* address, size_t length);

QSC_EXPORT_API void* qsc_memutils_malloc(size_t length);

QSC_EXPORT_API void* qsc_memutils_realloc(void* block, size_t length);

QSC_EXPORT_API void qsc_memutils_alloc_free(void* block);

QSC_EXPORT_API void* qsc_memutils_aligned_alloc(int32_t align, size_t length);

QSC_EXPORT_API void* qsc_memutils_aligned_realloc(void* block, size_t length);

QSC_EXPORT_API void qsc_memutils_aligned_free(void* block);

QSC_EXPORT_API void qsc_memutils_clear(void* output, size_t length);

QSC_EXPORT_API bool qsc_memutils_array_uniform(const uint8_t* input, size_t length);

QSC_EXPORT_API bool qsc_memutils_are_equal(const uint8_t* a, const uint8_t* b, size_t length);

QSC_EXPORT_API bool qsc_memutils_are_equal_128(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API bool qsc_memutils_are_equal_256(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API bool qsc_memutils_are_equal_512(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API void qsc_memutils_copy(void* output, const void* input, size_t length);

QSC_EXPORT_API void qsc_memutils_clmulepi64_si128(uint64_t r[2], const uint64_t a[2], const uint64_t b[2], int32_t imm8);

QSC_EXPORT_API void qsc_memutils_clmulepi64_si256_avx(__m128i r[4], const __m128i a[2], const __m128i b[2]);

QSC_EXPORT_API void qsc_memutils_clmulepi64_si256(uint64_t r[8], const uint64_t a[4], const uint64_t b[4]);

QSC_EXPORT_API bool qsc_memutils_greater_than_be128(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API bool qsc_memutils_greater_than_be256(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API bool qsc_memutils_greater_than_be512(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API bool qsc_memutils_greater_than_le128(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API bool qsc_memutils_greater_than_le256(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API bool qsc_memutils_greater_than_le512(const uint8_t* a, const uint8_t* b);

QSC_EXPORT_API void qsc_memutils_move(void* output, const void* input, size_t length);

QSC_EXPORT_API void qsc_memutils_secure_erase(void* block, size_t length);

QSC_EXPORT_API void qsc_memutils_secure_free(void* block, size_t length);

QSC_EXPORT_API void* qsc_memutils_secure_malloc(size_t length);

QSC_EXPORT_API void qsc_memutils_set_value(void* output, size_t length, uint8_t value);

QSC_EXPORT_API void qsc_memutils_xor(uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_memutils_xorv(uint8_t* output, const uint8_t value, size_t length);

QSC_EXPORT_API bool qsc_memutils_zeroed(const void* input, size_t length);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif