ordering-table.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2024 PCSX-Redux authors
 
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 <EASTL/algorithm.h>
#include <stdint.h>
 
#include "psyqo/fragment-concept.hh"
#include "psyqo/fragments.hh"
#include "psyqo/kernel.hh"
#include "psyqo/shared.hh"
 
namespace psyqo {
 
class GPU;
 
class OrderingTableBase {
  public:
    static void clear(psyqo::Fragments::ChainEntry* table, size_t size);
};
 
template <size_t N = 4096, Safe safety = Safe::Yes>
class OrderingTable : public OrderingTableBase {
  public:
    OrderingTable() { clear(); }
 
    void clear() { OrderingTableBase::clear(m_table, N); }
 
    template <Fragment Frag>
    void insert(Frag& frag, int32_t z) {
        // Ordering tables sort individual polygons, so a packet large enough to need the oversized
        // encoding is nonsense here and deliberately unsupported. Catch it at the definition site
        // instead: past the chain entry, sizeof(Frag) covers the payload (plus count, on the fixed
        // variants), so it is a conservative upper bound, and it costs nothing at runtime.
        static_assert((sizeof(Frag) - sizeof(Fragments::ChainEntry)) / sizeof(uint32_t) <= 255,
                      "Fragment too big to be inserted into an ordering table");
        auto* table = m_table + 1;
        if constexpr (safety == Safe::Yes) {
            z = eastl::clamp(z, int32_t(0), int32_t(N - 1));
        }
#ifdef PS1_PC_PORT
        frag.set(table[z].next, frag.getActualFragmentSize());
        table[z].set(&frag, 0);
#else
        frag.set(&table[z], frag.getActualFragmentSize());
        table[z].head = reinterpret_cast<uint32_t>(&frag) & 0xffffff;
#endif
    }
 
    // NOTE: can't use from other classes (PCGPU) otherwise
    psyqo::Fragments::ChainEntry m_table[N + 1];
 
  private:
    friend class GPU;
};
template <Safe safety = Safe::Yes>
class DynamicOrderingTable : public OrderingTableBase {
  public:
    DynamicOrderingTable(psyqo::Fragments::ChainEntry* storage, size_t buckets) : m_table(storage), m_size(buckets) {
        if constexpr (safety == Safe::Yes) {
            psyqo::Kernel::assert(storage && buckets > 0,
                                  "DynamicOrderingTable: needs storage and at least one bucket");
        }
        clear();
    }
    void clear() { OrderingTableBase::clear(m_table, m_size); }
 
    template <Fragment Frag>
    void insert(Frag& frag, int32_t z) {
        static_assert((sizeof(Frag) - sizeof(Fragments::ChainEntry)) / sizeof(uint32_t) <= 255,
                      "Fragment too big to be inserted into an ordering table");
        auto* table = m_table + 1;
        if constexpr (safety == Safe::Yes) {
            z = eastl::clamp(z, int32_t(0), int32_t(m_size - 1));
        }
#ifdef PS1_PC_PORT
        frag.set(table[z].next, frag.getActualFragmentSize());
        table[z].set(&frag, 0);
#else
        frag.set(&table[z], frag.getActualFragmentSize());
        table[z].head = reinterpret_cast<uint32_t>(&frag) & 0xffffff;
#endif
    }
    size_t size() const { return m_size; }
 
    // NOTE: can't use from other classes (PCGPU) otherwise
    psyqo::Fragments::ChainEntry* m_table;
 
  private:
    size_t m_size;
    friend class GPU;
};
 
}  // namespace psyqo