layers/sync/sync_stats.h

/* Copyright (c) 2025-2026 The Khronos Group Inc.
 * Copyright (c) 2025-2026 Valve Corporation
 * Copyright (c) 2025-2026 LunarG, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <string>
#include <cstdint>

#ifndef VVL_ENABLE_SYNCVAL_STATS
#define VVL_ENABLE_SYNCVAL_STATS 0
#endif

#if VVL_ENABLE_SYNCVAL_STATS != 0
#include <atomic>
#include <mutex>

// NOTE: mimalloc should be built with MI_STAT=1 to enable stats module
#if defined(USE_MIMALLOC)
#include <mimalloc.h>
#if MI_MALLOC_VERSION >= 300
#define USE_MIMALLOC_STATS
#include "mimalloc-stats.h"
#endif
#endif  // defined(USE_MIMALLOC)

#endif  // VVL_ENABLE_SYNCVAL_STATS != 0

namespace syncval {

class SyncValidator;

#if VVL_ENABLE_SYNCVAL_STATS != 0

struct Value32 {
    std::atomic_uint32_t u32;
    void Update(uint32_t new_value);
    uint32_t Add(uint32_t n);  // Returns new counter value
    uint32_t Sub(uint32_t n);  // Returns new counter value
};

struct Value64 {
    std::atomic_uint64_t u64;
    void Update(uint64_t new_value);
    uint64_t Add(uint64_t n);  // Returns new counter value
    uint64_t Sub(uint64_t n);  // Returns new counter value
};

struct ValueMax32 {
    Value32 value;
    Value32 max_value;
    void Update(uint32_t new_value);
    void Add(uint32_t n);
    void Sub(uint32_t n);
};

struct ValueMax64 {
    Value64 value;
    Value64 max_value;
    void Update(uint64_t new_value);
    void Add(uint64_t n);
    void Sub(uint64_t n);
};

// NOTE: Update of AccessContextStats counters is not thread-safe but it is fine until it works for development purposes.
// Thread-safe version will need to inject atomic counters in various places to track all relevant state.
// Current non-thread-safe implementation is very simple: iterate over everything and collect data.
struct AccessContextStats {
    uint32_t access_contexts = 0;
    uint32_t access_states = 0;
    uint32_t read_states = 0;
    uint32_t write_states = 0;
    uint32_t first_accesses = 0;

    uint32_t access_states_with_multiple_reads = 0;
    uint32_t access_states_with_multiple_firsts = 0;
    uint32_t access_states_with_dynamic_allocations = 0;
    uint64_t access_states_dynamic_allocation_size = 0;

    // The largest first accesses array
    uint32_t max_first_accesses_size = 0;
    // The largest last reads array
    uint32_t max_last_reads_count = 0;

    void UpdateMax(const AccessContextStats& cur_stats);
};

struct AccessStats {
    AccessContextStats cb_access_stats;
    AccessContextStats max_cb_access_stats;

    AccessContextStats queue_access_stats;
    AccessContextStats max_queue_access_stats;

    AccessContextStats subpass_access_stats;
    AccessContextStats max_subpass_access_stats;

    void Update(SyncValidator& validator);
    std::mutex access_stats_mutex;
};

struct BarrierStats {
    Value32 memory_barriers;
    Value32 buffer_barriers;
    Value32 image_barriers;
    Value32 execution_dependencies;

    Value32 single_barrier_commands;
    Value32 multi_barrier_commands;
    Value32 multi_barrier_commands_only_memory;
    Value32 multi_barrier_commands_only_buffer;
    Value32 multi_barrier_commands_only_image;
};

struct Stats {
    ~Stats();
    bool report_on_destruction = false;

#if defined(USE_MIMALLOC_STATS)
    mi_stats_t mi_stats;
    std::mutex mi_stats_mutex;
#endif

    ValueMax32 command_buffer_contexts;
    void AddCommandBufferContext();
    void RemoveCommandBufferContext();

    ValueMax32 queue_batch_contexts;
    void AddQueueBatchContext();
    void RemoveQueueBatchContext();

    ValueMax32 timeline_signals;
    void AddTimelineSignals(uint32_t count);
    void RemoveTimelineSignals(uint32_t count);

    ValueMax32 unresolved_batches;
    void AddUnresolvedBatch();
    void RemoveUnresolvedBatch();

    ValueMax32 handle_records;
    void AddHandleRecord(uint32_t count = 1);
    void RemoveHandleRecord(uint32_t count = 1);

    AccessStats access_stats;
    void UpdateAccessStats(SyncValidator& validator);

    BarrierStats barrier_stats;
    void OnBarrierCommand(uint32_t memory_barrier_count, uint32_t buffer_barrier_count, uint32_t image_barrier_count,
                          uint32_t execution_dependencies_count);

    void UpdateMemoryStats();
    void ReportOnDestruction();
    std::string CreateReport();
};

#else
struct Stats {
    void AddHandleRecord(uint32_t count = 1) {}
    void RemoveHandleRecord(uint32_t count = 1) {}
    void AddCommandBufferContext() {}
    void RemoveCommandBufferContext() {}
    void AddQueueBatchContext() {}
    void RemoveQueueBatchContext() {}
    void AddTimelineSignals(uint32_t count) {}
    void RemoveTimelineSignals(uint32_t count) {}
    void AddUnresolvedBatch() {}
    void RemoveUnresolvedBatch() {}

    void UpdateAccessStats(SyncValidator& validator) {}

    void OnBarrierCommand(uint32_t memory_barrier_count, uint32_t buffer_barrier_count, uint32_t image_barrier_count,
                          uint32_t execution_dependencies_count) {}

    void UpdateMemoryStats() {}
    void ReportOnDestruction() {}
    std::string CreateReport() { return "SyncVal stats are disabled in the current build configuration\n"; }
};
#endif  // VVL_ENABLE_SYNCVAL_STATS != 0
}  // namespace syncval