Goose  Artifact [2375355a10]

Artifact 2375355a104c2ca6143ef2cecca7aee52b16d01b449ec10d0cb337ec92bda902:

  • File bs/cir/helpers.h — part of check-in [1793989d05] at 2024-02-09 18:05:28 on branch trunk — Lowering: completely reworked all lowering to happen in the same two unified extension points upstream of all three CIR consumers (user: zlodo size: 6123)

#ifndef GOOSE_CIR_HELPERS_H
#define GOOSE_CIR_HELPERS_H

namespace goose::cir
{
    class Instruction;
    using InstrSeq = list< Instruction >;

    extern bool IsValueConstantOrExecutable( const eir::Value& val );
    extern bool CanValueBeEagerlyEvaluated( const eir::Value& val );

    extern bool DoesInstrSeqHaveSideEffects( const InstrSeq& is );

    extern void AppendInstrSeq( InstrSeq& is, InstrSeq&& isToAppend );
    extern void AppendInstrSeq( InstrSeq& is, const InstrSeq& isToAppend );

    extern void AppendValue( InstrSeq& is, Value&& v );
    extern void AppendValue( InstrSeq& is, const Value& v );

    template< typename I >
    void AppendToInstrSeq( InstrSeq& is, I&& instr )
    {
        using II = remove_cvref_t< I >;

        if constexpr( is_same_v< II, InstrSeq > )
        {
            AppendInstrSeq( is, forward< I >( instr ) );
        }
        else if constexpr( is_same_v< II, Value > )
        {
            AppendValue( is, forward< I >( instr ) );
        }
        else
        {
            is.emplace_back( Instruction( forward< I >( instr ) ) );
        }
    }

    static inline void AppendToInstrSeq( InstrSeq& is, const ptr< InstrSeq >& instr )
    {
        AppendToInstrSeq( is, *instr );
    }

    static inline void AppendToInstrSeq( InstrSeq& is, ptr< InstrSeq >&& instr )
    {
        AppendToInstrSeq( is, move( *instr ) );
    }

    template< typename HI, typename... TI >
    void AppendToInstrSeq( InstrSeq& is, HI&& headInstr, TI&&... tailInstrs )
    {
        AppendToInstrSeq( is, forward< HI >( headInstr ) );
        AppendToInstrSeq( is, forward< TI >( tailInstrs )... );
    }

    template< typename T, typename... I >
    auto BuildComputedValue( T&& type, I&&... instrs )
    {
        auto is = make_shared< InstrSeq >();
        AppendToInstrSeq( *is, forward< I >( instrs )... );

        return eir::Value( forward< T >( type ), move( is ) );
    }

    template< size_t popCount, bool pushesResult >
    class BaseInstr
    {
        public:
            BaseInstr( LocationId loc ) :
                m_loc( loc )
            {}

            void setLocationId( LocationId loc ) { m_loc = loc; }

            auto locationId() const { return m_loc; }

            static constexpr size_t PopCount = popCount;
            static constexpr bool PushesResult = pushesResult;

        private:
            LocationId m_loc;
    };

    template< typename T >
    class TempStorage
    {
        public:
            TempStorage( size_t size = 0 ) :
                m_storage( size )
            {}

            template< typename TT >
            T& set( uint32_t index, TT&& x )
            {
                if( IsUid( index ) )
                {
                    auto [it,_] = m_uidStorage.emplace( index, forward< TT >( x ) );
                    return it->second;
                }

                if( index >= m_storage.size() )
                    m_storage.resize( index + 1 );
                m_storage[index] = forward< TT >( x );
                return m_storage[index];
            }

            const T* get( uint32_t index ) const
            {
                if( IsUid( index ) )
                {
                    auto it = m_uidStorage.find( index );
                    if( it == m_uidStorage.end() )
                        return nullptr;
                    return &it->second;
                }

                if( index < m_storage.size() )
                    return &m_storage[index];

                return nullptr;
            }

            T* get( uint32_t index )
            {
                if( IsUid( index ) )
                    return nullptr;

                if( index < m_storage.size() )
                    return &m_storage[index];

                return nullptr;
            }

        private:
            llvm::SmallVector< T, 16 > m_storage;
            unordered_map< uint32_t, T > m_uidStorage;
    };

    // We need to lower types before consuming them from the CIR. Ideally we'd do this while building the CIR
    // but as things are now it would involve enormous refactoring to store lowered types in a bunch of high level
    // objects, and all the code to round trip them to EIR would have to deal with them, while also making sure
    // they aren't actually participating in pattern matching.
    // A significant redesign will probably allow for an elegant solution, but that's for the rewrite.
    // In the mean time we use this ugly helper that lowers the type when reading it from the CIR, if not previously done.
    // Since it needs the context we have to store the current context as a static member. This will have to do for
    // the BS compiler...
    class LowerableType
    {
        public:
            template< typename T >
            LowerableType( T&& type ) :
                m_type( forward< T >( type ) )
            {}

            const auto& type() const { return m_type; }
            const eir::Term& get() const;

            auto operator<( const LowerableType& other ) const
            {
                return m_type < other.m_type;
            }

            auto operator==( const LowerableType& other ) const
            {
                return m_type == other.m_type;
            }

        private:
            eir::Term m_type;
            mutable optional< eir::Term > m_loweredType;
    };

    // Same as above for values
    class LowerableValue
    {
        public:
            template< typename T >
            LowerableValue( T&& val ) :
                m_val( forward< T >( val ) )
            {}

            const auto& val() const { return m_val; }
            const eir::Value& get() const;
            eir::Value& modify();

            auto operator<( const LowerableValue& other ) const
            {
                return m_val < other.m_val;
            }

            auto operator==( const LowerableValue& other ) const
            {
                return m_val == other.m_val;
            }

        private:
            eir::Value m_val;
            mutable optional< eir::Value > m_loweredVal;
    };
}

#endif