intutils.h

Go to the documentation of this file.

/* 2020-2026 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 herein are proprietary to QRCS and are
 * protected under applicable Canadian, U.S., and international copyright,
 * patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
 * - This software includes implementations of cryptographic primitives and
 *   algorithms that are standardized or in the public domain, such as AES
 *   and SHA-3, which are not proprietary to QRCS.
 * - This software also includes cryptographic primitives, constructions, and
 *   algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
 *   related components, which are proprietary to QRCS.
 * - All source code, implementations, protocol compositions, optimizations,
 *   parameter selections, and engineering work contained in this software are
 *   original works of QRCS and are protected under this license.
 *
 * LICENSE AND USE RESTRICTIONS:
 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
 *   Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 * - Permission is granted solely for non-commercial evaluation, academic research,
 *   cryptographic analysis, interoperability testing, and feasibility assessment.
 * - Commercial use, production deployment, commercial redistribution, or
 *   integration into products or services is strictly prohibited without a
 *   separate written license agreement executed with QRCS.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 *
 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
 * Portions of this software may include experimental, novel, or evolving
 * cryptographic designs. Use of this software is entirely at the user's risk.
 *
 * DISCLAIMER:
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef QSC_INTUTILS_H
#define QSC_INTUTILS_H
 
#include "qsccommon.h"
#include "intrinsics.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_INTUTILS_KB_SIZE 1000ULL

#define QSC_INTUTILS_KIB_SIZE 1024ULL

#define QSC_INTUTILS_MB_SIZE 1000000ULL

#define QSC_INTUTILS_MIB_SIZE 1048576ULL

#define QSC_INTUTILS_GB_SIZE 1000000000ULL

#define QSC_INTUTILS_GIB_SIZE 1073741824ULL

#define QSC_INTUTILS_TB_SIZE 1000000000000ULL

#define QSC_INTUTILS_TIB_SIZE 1099511627776ULL

#define QSC_INTUTILS_PB_SIZE 1000000000000000ULL

#define QSC_INTUTILS_PIB_SIZE 1125899906842624ULL

#define QSC_INTUTILS_EB_SIZE 1000000000000000000ULL

#define QSC_INTUTILS_EIB_SIZE 1152921504606846976ULL

QSC_EXPORT_API bool qsc_intutils_are_equal(size_t x, size_t y);

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

QSC_EXPORT_API uint16_t qsc_intutils_be8to16(const uint8_t* input);

QSC_EXPORT_API uint32_t qsc_intutils_be8to32(const uint8_t* input);

QSC_EXPORT_API uint64_t qsc_intutils_be8to64(const uint8_t* input);

QSC_EXPORT_API void qsc_intutils_be16to8(uint8_t* output, uint16_t value);

QSC_EXPORT_API void qsc_intutils_be32to8(uint8_t* output, uint32_t value);

QSC_EXPORT_API void qsc_intutils_be64to8(uint8_t* output, uint64_t value);

QSC_EXPORT_API void qsc_intutils_be8increment(uint8_t* output, size_t otplen);

void qsc_intutils_be8increment_rfc3686(uint8_t* output, size_t otplen);

QSC_EXPORT_API size_t qsc_intutils_bit_reverse(size_t x, uint32_t bits);

QSC_EXPORT_API uint64_t qsc_intutils_bit_reverse_u64(uint64_t x);

QSC_EXPORT_API uint32_t qsc_intutils_bit_reverse_u32(uint32_t x);

QSC_EXPORT_API uint16_t qsc_intutils_bit_reverse_u16(uint16_t x);
 
#if defined(QSC_SYSTEM_HAS_AVX)
QSC_EXPORT_API void qsc_intutils_bswap32(uint32_t* dest, const uint32_t* source, size_t length);

QSC_EXPORT_API void qsc_intutils_bswap64(uint64_t* dest, const uint64_t* source, size_t length);
#endif

QSC_EXPORT_API double qsc_intutils_calculate_abs(double a);

QSC_EXPORT_API double qsc_intutils_calculate_exp(double x);

QSC_EXPORT_API double qsc_intutils_calculate_fabs(double x);

QSC_EXPORT_API double qsc_intutils_calculate_log(double x);

QSC_EXPORT_API double qsc_intutils_calculate_sqrt(double x);

QSC_EXPORT_API void qsc_intutils_clear8(uint8_t* a, size_t count);

QSC_EXPORT_API void qsc_intutils_clear16(uint16_t* a, size_t count);

QSC_EXPORT_API void qsc_intutils_clear32(uint32_t* a, size_t count);

QSC_EXPORT_API void qsc_intutils_clear64(uint64_t* a, size_t count);

QSC_EXPORT_API void qsc_intutils_cmov(uint8_t* dest, const uint8_t* source, size_t length, uint8_t cond);

QSC_EXPORT_API size_t qsc_intutils_expand_mask(size_t x);

QSC_EXPORT_API bool qsc_intutils_is_gte(size_t x, size_t y);

QSC_EXPORT_API bool qsc_intutils_is_power_of_two(size_t x);

QSC_EXPORT_API size_t qsc_intutils_next_power_of_2(size_t x);

QSC_EXPORT_API void qsc_intutils_hex_to_bin(const char* hexstr, uint8_t* output, size_t otplen);

QSC_EXPORT_API void qsc_intutils_bin_to_hex(const uint8_t* input, char* hexstr, size_t inplen);

QSC_EXPORT_API void qsc_intutils_le8increment(uint8_t* output, size_t otplen);
 
#if defined(QSC_SYSTEM_HAS_AVX)
QSC_EXPORT_API void qsc_intutils_leincrement_x128(__m128i* counter);
#endif
 
#if defined(QSC_SYSTEM_HAS_AVX512)
QSC_EXPORT_API void qsc_intutils_leincrement_x512(__m512i* counter);
#endif

QSC_EXPORT_API uint16_t qsc_intutils_le8to16(const uint8_t* input);

QSC_EXPORT_API uint32_t qsc_intutils_le8to32(const uint8_t* input);

QSC_EXPORT_API uint64_t qsc_intutils_le8to64(const uint8_t* input);

QSC_EXPORT_API void qsc_intutils_le16to8(uint8_t* output, uint16_t value);

QSC_EXPORT_API void qsc_intutils_le32to8(uint8_t* output, uint32_t value);

QSC_EXPORT_API void qsc_intutils_le64to8(uint8_t* output, uint64_t value);

QSC_EXPORT_API bool qsc_intutils_lsb_is_set(size_t x);

QSC_EXPORT_API size_t qsc_intutils_max(size_t a, size_t b);

QSC_EXPORT_API size_t qsc_intutils_min(size_t a, size_t b);

QSC_EXPORT_API uint32_t qsc_intutils_popcount32(uint32_t v);
 
#if defined(QSC_SYSTEM_HAS_AVX)
QSC_EXPORT_API void qsc_intutils_reverse_bytes_x128(const __m128i* input, __m128i* output);
#endif
 
#if defined(QSC_SYSTEM_HAS_AVX512)
QSC_EXPORT_API void qsc_intutils_reverse_bytes_x512(const __m512i* input, __m512i* output);
#endif

QSC_EXPORT_API uint32_t qsc_intutils_rotl32(uint32_t value, size_t shift);

QSC_EXPORT_API uint64_t qsc_intutils_rotl64(uint64_t value, size_t shift);

QSC_EXPORT_API uint32_t qsc_intutils_rotr32(uint32_t value, size_t shift);

QSC_EXPORT_API uint64_t qsc_intutils_rotr64(uint64_t value, size_t shift);

QSC_EXPORT_API int32_t qsc_intutils_verify(const uint8_t* a, const uint8_t* b, size_t length);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif