sysutils.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_SYSUTILS_H
#define QSC_SYSUTILS_H
 
#include "qsccommon.h"
 
QSC_CPLUSPLUS_ENABLED_START

 
/* bogus winbase.h error */
QSC_SYSTEM_CONDITION_IGNORE(5105)
 

#define QSC_SYSUTILS_SYSTEM_NAME_MAX 256ULL

#define QSC_USERNAME_SYSTEM_NAME_MAX 256ULL

QSC_EXPORT_API size_t qsc_sysutils_computer_name(char* name);

QSC_EXPORT_API size_t qsc_sysutils_cpu_count(void);

QSC_EXPORT_API typedef struct
{
    uint64_t free;      
    uint64_t total;        
    uint64_t avail;        
} 
qsc_sysutils_drive_space_state;

QSC_EXPORT_API void qsc_sysutils_drive_space(const char* drive, qsc_sysutils_drive_space_state* state);

QSC_EXPORT_API typedef struct
{
    uint64_t phystotal;        
    uint64_t physavail;        
    uint64_t virttotal;        
    uint64_t virtavail;        
}
qsc_sysutils_memory_statistics_state;

QSC_EXPORT_API void qsc_sysutils_memory_statistics(qsc_sysutils_memory_statistics_state* state);

QSC_EXPORT_API char qsc_sysutils_get_os_drive_letter(void);

QSC_EXPORT_API uint32_t qsc_sysutils_process_id(void);

QSC_EXPORT_API bool qsc_sysutils_rdtsc_available(void);

QSC_EXPORT_API size_t qsc_sysutils_user_name(char* name);

QSC_EXPORT_API uint64_t qsc_sysutils_system_uptime(void);

QSC_EXPORT_API uint64_t qsc_sysutils_system_timestamp(void);

QSC_EXPORT_API void qsc_sysutils_user_identity(const char* name, char* id);
 
#if defined(QSC_DEBUG_MODE)
QSC_EXPORT_API void qsc_system_values_print(void);
#endif
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif