tm_instr_base.g.hh

Go to the documentation of this file.

// This file is automatically generated, do not edit.

/*!
        \file
        \author jaz
*/

#ifndef lestes__md__instructions__tm_instr_base_g_hh__included
#define lestes__md__instructions__tm_instr_base_g_hh__included

#include <lestes/std/vector.hh>
#include <lestes/std/set.hh>
#include <lestes/std/map.hh>
#include <lestes/md/common.hh>
#include <lestes/md/registers/tm_register_base.g.hh>
#include <lestes/md/types/tm_data_type_base.g.hh>

#include <lestes/std/objectize_macros.hh>
package(lestes);
package(std);
class object;
end_package(std);
end_package(lestes);

package(lestes);
package(md);
package(types);
class tm_data_type_base;
end_package(types);
end_package(md);
end_package(lestes);

package(lestes);
package(backend_v2);
package(intercode);
class ge_operand;
end_package(intercode);
end_package(backend_v2);
end_package(lestes);

package(lestes);
package(md);
package(instructions);
class execution_info;
end_package(instructions);
end_package(md);
end_package(lestes);

package(lestes);
package(md);
package(instructions);

//! tm_instr_base flags.
enum intr_flag_type {
        IF_JUMP=1,
        IF_LOAD=2,
        IF_STORE=4,
        IF_SYS=8,
        IF_COPY=16
};


class tm_instr_base;
class tm_instr_op_base;
class tm_instr_op_mem_base;
class tm_instr_op_reg_base;
class tm_instr_op_imm_base;


/*! \brief A description of target machine instruction.

Machine description generates instances of this class for instructions of a target architecture.
                
Note: A concrete derived class is target dependent and it is placed in 
/target/machine/${TARGET_CPU}/lestes/md/instructions/ directory. 
*/
class tm_instr_base : public ::lestes::std::object {
public:
        //! The method id_get returns the value of the field tm_instr_base::id.
        ulint id_get() const;

        //! The method id_set sets the field tm_instr_base::id to the given value.
        void id_set(ulint);

        //! The method operands_input_get returns the value of the field tm_instr_base::operands_input.
        ptr< ::lestes::std::vector< srp< tm_instr_op_base > > > operands_input_get() const;

        //! The method operands_input_set sets the field tm_instr_base::operands_input to the given value.
        void operands_input_set(const ptr< ::lestes::std::vector< srp< tm_instr_op_base > > > & );

        //! The method operands_output_get returns the value of the field tm_instr_base::operands_output.
        ptr< ::lestes::std::vector< srp< tm_instr_op_base > > > operands_output_get() const;

        //! The method operands_output_set sets the field tm_instr_base::operands_output to the given value.
        void operands_output_set(const ptr< ::lestes::std::vector< srp< tm_instr_op_base > > > & );

        //! The method asm_output_get returns the value of the field tm_instr_base::asm_output.
        lstring asm_output_get() const;

        //! The method asm_output_set sets the field tm_instr_base::asm_output to the given value.
        void asm_output_set(lstring);

        //! The method properties_get returns the value of the field tm_instr_base::properties.
        ptr< ::lestes::std::map< ulint, lstring > > properties_get() const;

        //! The method properties_set sets the field tm_instr_base::properties to the given value.
        void properties_set(const ptr< ::lestes::std::map< ulint, lstring > > & );

        //! The method versions_get returns the value of the field tm_instr_base::versions.
        ptr< ::lestes::std::set< ulint > > versions_get() const;

        //! The method versions_set sets the field tm_instr_base::versions to the given value.
        void versions_set(const ptr< ::lestes::std::set< ulint > > & );

        //! The method flags_get returns the value of the field tm_instr_base::flags.
        ulint flags_get() const;

        //! The method flags_set sets the field tm_instr_base::flags to the given value.
        void flags_set(ulint);

        //! The method exec_info_get returns the value of the field tm_instr_base::exec_info.
        ptr< ::lestes::md::instructions::execution_info > exec_info_get() const;

        //! The method exec_info_set sets the field tm_instr_base::exec_info to the given value.
        void exec_info_set(const ptr< ::lestes::md::instructions::execution_info > &);

        bool is_jump();

        bool is_load();

        bool is_store();

        bool is_system();

        bool is_copy();

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class tm_instr_base.
        tm_instr_base (
                ulint a__tm_instr_base__id,
                ptr< ::lestes::std::vector< srp< tm_instr_op_base > > > a__tm_instr_base__operands_input,
                ptr< ::lestes::std::vector< srp< tm_instr_op_base > > > a__tm_instr_base__operands_output,
                lstring a__tm_instr_base__asm_output,
                ptr< ::lestes::std::map< ulint, lstring > > a__tm_instr_base__properties,
                ptr< ::lestes::std::set< ulint > > a__tm_instr_base__versions,
                ulint a__tm_instr_base__flags,
                ptr< ::lestes::md::instructions::execution_info > a__tm_instr_base__exec_info);

        //! Marking routine for class tm_instr_base. 
        virtual void gc_mark();

private:
        //! The instruction's id.
        ulint id;
        //! The instruction's input operands.
        srp< ::lestes::std::vector< srp< tm_instr_op_base > > >  operands_input;
        //! The instruction's output operands.
        srp< ::lestes::std::vector< srp< tm_instr_op_base > > >  operands_output;
        /*! \brief Assembly code template for the instruction.

        This template is assembly code with tagged substitutions for operands. These tags are replaced with asm code 
for operand during code-generation phase.
        */
        lstring asm_output;
        //! User defined properties.
        srp< ::lestes::std::map< ulint, lstring > >  properties;
        //! Set of ids of instructions that perform the same operation as current one does but they differ in operand types and execution.
        srp< ::lestes::std::set< ulint > >  versions;
        //! The instruction's flags.
        ulint flags;
        //! A description of the instruction's execution parameters.
        srp< ::lestes::md::instructions::execution_info > exec_info;
        static ptr<reflection_list> reflection;
        
}; // tm_instr_base


//! Operand of tm_instr instruction.
class tm_instr_op_base : public ::lestes::std::object {
public:
        //! Operand kinds.
        enum kind_type {
                REGISTER,
                MEMORY,
                IMMEDIATE
        };

        //! The method id_get returns the value of the field tm_instr_op_base::id.
        ulint id_get() const;

        //! The method id_set sets the field tm_instr_op_base::id to the given value.
        void id_set(ulint);

        //! The method allowed_types_get returns the value of the field tm_instr_op_base::allowed_types.
        ptr< ::lestes::std::set< ::lestes::md::types::tm_data_type_base::id_type > > allowed_types_get() const;

        //! The method allowed_types_set sets the field tm_instr_op_base::allowed_types to the given value.
        void allowed_types_set(const ptr< ::lestes::std::set< ::lestes::md::types::tm_data_type_base::id_type > > & );

        //! The method destroyed_by_get returns the value of the field tm_instr_op_base::destroyed_by.
        ptr< ::lestes::std::vector< ulint > > destroyed_by_get() const;

        //! The method destroyed_by_set sets the field tm_instr_op_base::destroyed_by to the given value.
        void destroyed_by_set(const ptr< ::lestes::std::vector< ulint > > & );

        //! The method destroys_get returns the value of the field tm_instr_op_base::destroys.
        ulint destroys_get() const;

        //! The method destroys_set sets the field tm_instr_op_base::destroys to the given value.
        void destroys_set(ulint);

        virtual tm_instr_op_base::kind_type kind_get() abstract;

        virtual ptr< ::lestes::backend_v2::intercode::ge_operand > convert_to_ge(ptr< ::lestes::md::types::tm_data_type_base > type) abstract;

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class tm_instr_op_base.
        tm_instr_op_base (
                ulint a__tm_instr_op_base__id,
                ptr< ::lestes::std::set< ::lestes::md::types::tm_data_type_base::id_type > > a__tm_instr_op_base__allowed_types,
                ptr< ::lestes::std::vector< ulint > > a__tm_instr_op_base__destroyed_by,
                ulint a__tm_instr_op_base__destroys);

        //! Marking routine for class tm_instr_op_base. 
        virtual void gc_mark();

private:
        //! The operand's id.
        ulint id;
        //! A list of types that can be used by current operand.
        srp< ::lestes::std::set< ::lestes::md::types::tm_data_type_base::id_type > >  allowed_types;
        //! If the current operand is input operand, it is an id list of output operands of the parent instruction that destroy value of the current operand (i.e. register overwrite ).
        srp< ::lestes::std::vector< ulint > >  destroyed_by;
        //! If the current operand if output one, it is id of an input operand that is destroyed by the current operand.
        ulint destroys;
        static ptr<reflection_list> reflection;
        
}; // tm_instr_op_base


/*! \brief Memory operand.

Note: A concrete derived class is target dependent and it is placed in 
/target/machine/${TARGET_CPU}/lestes/md/instructions/ directory. 
*/
class tm_instr_op_mem_base : public tm_instr_op_base {
public:
        virtual tm_instr_op_base::kind_type kind_get();

        virtual ptr< ::lestes::backend_v2::intercode::ge_operand > convert_to_ge(ptr< ::lestes::md::types::tm_data_type_base > type);

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class tm_instr_op_mem_base.
        tm_instr_op_mem_base (
                ulint a__tm_instr_op_base__id,
                ptr< ::lestes::std::set< ::lestes::md::types::tm_data_type_base::id_type > > a__tm_instr_op_base__allowed_types,
                ptr< ::lestes::std::vector< ulint > > a__tm_instr_op_base__destroyed_by,
                ulint a__tm_instr_op_base__destroys);

        //! Marking routine for class tm_instr_op_mem_base. 
        virtual void gc_mark();

private:
        static ptr<reflection_list> reflection;
        
}; // tm_instr_op_mem_base


/*! \brief Register operand.

Note: A concrete derived class is target dependent and it is placed in 
/target/machine/${TARGET_CPU}/lestes/md/instructions/ directory. 
*/
class tm_instr_op_reg_base : public tm_instr_op_base {
public:
        //! The method allowed_registers_get returns the value of the field tm_instr_op_reg_base::allowed_registers.
        ptr< ::lestes::std::set< ::lestes::md::registers::tm_register_base::id_type > > allowed_registers_get() const;

        //! The method allowed_registers_set sets the field tm_instr_op_reg_base::allowed_registers to the given value.
        void allowed_registers_set(const ptr< ::lestes::std::set< ::lestes::md::registers::tm_register_base::id_type > > & );

        virtual tm_instr_op_base::kind_type kind_get();

        virtual ptr< ::lestes::backend_v2::intercode::ge_operand > convert_to_ge(ptr< ::lestes::md::types::tm_data_type_base > type);

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class tm_instr_op_reg_base.
        tm_instr_op_reg_base (
                ulint a__tm_instr_op_base__id,
                ptr< ::lestes::std::set< ::lestes::md::types::tm_data_type_base::id_type > > a__tm_instr_op_base__allowed_types,
                ptr< ::lestes::std::vector< ulint > > a__tm_instr_op_base__destroyed_by,
                ulint a__tm_instr_op_base__destroys,
                ptr< ::lestes::std::set< ::lestes::md::registers::tm_register_base::id_type > > a__tm_instr_op_reg_base__allowed_registers);

        //! Marking routine for class tm_instr_op_reg_base. 
        virtual void gc_mark();

private:
        //! A list of registers that can be used by the current operand.
        srp< ::lestes::std::set< ::lestes::md::registers::tm_register_base::id_type > >  allowed_registers;
        static ptr<reflection_list> reflection;
        
}; // tm_instr_op_reg_base


/*! \brief Immediate operand.

Note: A concrete derived class is target dependent and it is placed in 
/target/machine/${TARGET_CPU}/lestes/md/instructions/ directory. 
*/
class tm_instr_op_imm_base : public tm_instr_op_base {
public:
        virtual tm_instr_op_base::kind_type kind_get();

        virtual ptr< ::lestes::backend_v2::intercode::ge_operand > convert_to_ge(ptr< ::lestes::md::types::tm_data_type_base > type);

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class tm_instr_op_imm_base.
        tm_instr_op_imm_base (
                ulint a__tm_instr_op_base__id,
                ptr< ::lestes::std::set< ::lestes::md::types::tm_data_type_base::id_type > > a__tm_instr_op_base__allowed_types,
                ptr< ::lestes::std::vector< ulint > > a__tm_instr_op_base__destroyed_by,
                ulint a__tm_instr_op_base__destroys);

        //! Marking routine for class tm_instr_op_imm_base. 
        virtual void gc_mark();

private:
        static ptr<reflection_list> reflection;
        
}; // tm_instr_op_imm_base


end_package(instructions);
end_package(md);
end_package(lestes);

package(lestes);
package(std);
specialize_objectize_for_enum( ::lestes::md::instructions::intr_flag_type );
specialize_objectize_for_enum( ::lestes::md::instructions::tm_instr_op_base::kind_type );
end_package(std);
end_package(lestes);

#endif // lestes__md__instructions__tm_instr_base_g_hh__included

---