hkds_queue.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 HKDS_MESSAGE_QUEUE_H
#define HKDS_MESSAGE_QUEUE_H
 
#include "common.h"
#include "hkds_config.h"


#define HKDS_MESSAGE_QUEUE_TAG_SIZE 16

#define HKDS_QUEUE_ALIGNMENT 64

#define HKDS_QUEUE_MAX_DEPTH 64

HKDS_EXPORT_API typedef struct hkds_queue_state
{
    uint8_t** queue;                   
    uint64_t tags[HKDS_QUEUE_MAX_DEPTH]; 
    size_t count;                      
    size_t depth;                      
    size_t position;                   
    size_t width;                      
} hkds_queue_state;

typedef struct hkds_message_queue_state
{
    uint8_t* tag;           
    hkds_queue_state state; 
} hkds_message_queue_state;

HKDS_EXPORT_API void hkds_message_queue_destroy(hkds_message_queue_state* ctx);

HKDS_EXPORT_API void hkds_message_queue_flush(hkds_message_queue_state* ctx, uint8_t* output);

HKDS_EXPORT_API void hkds_message_queue_initialize(hkds_message_queue_state* ctx, size_t depth, size_t width, uint8_t* tag);

HKDS_EXPORT_API void hkds_message_queue_pop(hkds_message_queue_state* ctx, uint8_t* output, size_t outlen);

HKDS_EXPORT_API void hkds_message_queue_push(hkds_message_queue_state* ctx, const uint8_t* inpput, size_t inplen);

HKDS_EXPORT_API bool hkds_message_queue_full(const hkds_message_queue_state* ctx);

HKDS_EXPORT_API bool hkds_message_queue_empty(const hkds_message_queue_state* ctx);

HKDS_EXPORT_API size_t hkds_message_queue_count(const hkds_message_queue_state* ctx);
 
/* block message export */

HKDS_EXPORT_API size_t hkds_message_queue_extract_block_x8(hkds_message_queue_state* ctx, uint8_t output[HKDS_CACHX8_DEPTH][HKDS_MESSAGE_SIZE]);

HKDS_EXPORT_API size_t hkds_message_queue_extract_block_x64(hkds_message_queue_state* ctx, uint8_t output[HKDS_PARALLEL_DEPTH][HKDS_CACHX8_DEPTH][HKDS_MESSAGE_SIZE]);

HKDS_EXPORT_API size_t hkds_message_queue_extract_stream(hkds_message_queue_state* ctx, uint8_t* stream, size_t items);
 
#endif