TheRock/rocm-systems/projects/rocprof-trace-decoder/source/mi400/mi400parser.h

// MIT License
//
// Copyright (c) 2024-2026 Advanced Micro Devices, Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#pragma once
#include <cstring>
#include "gfx12/gfx12parser.h"
#include "mi400token.h"

namespace mi400
{

class TokenLookupTable : public gfx12::TokenLookupTable
{
public:
    TokenLookupTable();

    int64_t getTime(const token_info_t& info, uint64_t contents, int64_t cur_time, bool& PL, int64_t& rt)
    {
        if (info.type == RdnaType::TIMESTAMP)
        {
            gfx12::timestamp_type stamp{.raw = contents};
            PL |= bool(stamp.pl && !stamp.rt);
            if (stamp.rt == 0) return stamp.time + cur_time;

            if (stamp.pl == 0) rt = stamp.time;
            return cur_time;
        }
        else if (info.type == RdnaType::TIME) { cur_time += 1; }
        return getDelta(info, contents) + cur_time;
    };

private:
    // MI400 omits the +4 cycle adjustment that gfx10/11/12 apply to TIME tokens; the
    // +1 above already covers it. Hides gfx12::TokenLookupTable::getDelta via name lookup.
    static int64_t getDelta(const token_info_t& info, uint64_t contents)
    {
        uint64_t mask = (1ull << (info.time_end - info.time_begin)) - 1;
        return ((contents >> info.time_begin) & mask);
    };
};

class TokenGenerator : public NaviTokenGenerator
{
public:
    TokenGenerator(const uint8_t* _buffer, size_t size, int64_t _globaltime, int64_t _base_time);
    gfx10::Token next() final;

    inline uint64_t getBuffer400() { return buffer[byte_ptr]; };

    inline void advanceByte(uint64_t value)
    {
        current = (current >> 8) | (value << 56);
        byte_ptr++;
        bits_toread -= 8;
    }

    inline void readOne_unsafe400()
    {
        while (bits_toread > 0) advanceByte(getBuffer400());
    }

    inline void readOne_safe400()
    {
        while (bits_toread > 0) advanceByte(byte_ptr < BUFFER_SIZE ? getBuffer400() : 0);
    }

    void update_fifo(int wave);
    int get_valu_inst_mi400();

    // The rare-token cluster lives at positions 0..4 in RdnaType
    // (gfx10/token_types.h): UNKNOWN, EVENT, EVENT_SYNC, REG, REG_INIT.
    // The check then reduces to `unsigned(type) < RARE_END` — a single
    // unsigned compare, with no subtract.
    static constexpr unsigned RARE_END = 5;
    static_assert(
        RdnaType::UNKNOWN == 0 && RdnaType::EVENT == 1 && RdnaType::EVENT_SYNC == 2 && RdnaType::REG == 3 &&
            RdnaType::REG_INIT == 4,
        "Rare-token cluster must occupy positions 0..4 — update if enum reordered"
    );

protected:
    std::array<int, 6> FIFO = {-1, -1, -1, -1, -1, -1};

private:
    size_t byte_ptr = 0;
    bool bIsExt = false;
    TokenLookupTable lookupbits{};
};

} // namespace mi400