logger.h

Go to the documentation of this file.

/* 2025-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 UDIF_LOG_H
#define UDIF_LOG_H
 
#include "udifcommon.h"
#include "commands.h"


#define UDIF_LOGGING_MESSAGE_MAX 256U

#define UDIF_LOG_STRING_DEPTH 69U

#define UDIF_LOG_STRING_SIZE 64U

static const char UDIF_LOGGER_PATH[] = "UDIF";

static const char UDIF_LOGGER_FILE[] = "udif.log";

static const char UDIF_LOGGER_HEAD[] = "UDIF Version 1.0";

UDIF_EXPORT_API void logger_default_path(char* path, size_t pathlen);

UDIF_EXPORT_API bool udif_logger_dispose(const char* path);

UDIF_EXPORT_API bool udif_logger_erase_all(const char* path);

UDIF_EXPORT_API bool udif_logger_exists(const char* path);

UDIF_EXPORT_API void udif_logger_initialize(const char* path);

UDIF_EXPORT_API size_t udif_logger_get_size(const char* path);

UDIF_EXPORT_API void udif_logger_reset(const char* path);

UDIF_EXPORT_API size_t udif_logger_write_message(const char* path, const char* line, size_t linelen);

UDIF_EXPORT_API size_t udif_logger_write_decorated_message(const char* path, udif_application_messages msgtype, const char* message, size_t msglen);

UDIF_EXPORT_API size_t udif_logger_write_time_stamped_message(const char* path, const char* message, size_t msglen);

UDIF_EXPORT_API size_t udif_logger_write_decorated_time_stamped_message(const char* path, udif_application_messages msgtype, const char* message, size_t msglen);

UDIF_EXPORT_API size_t udif_logger_read_all(const char* path, char* output, size_t outlen);

UDIF_EXPORT_API int64_t udif_logger_read_line(const char* path, char* output, size_t outlen, size_t linenum);

UDIF_EXPORT_API size_t udif_logger_time_stamp(char* output, size_t outlen);
 
#endif