/*===================== begin_copyright_notice ==================================

Copyright (c) 2017 Intel Corporation

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.


======================= end_copyright_notice ==================================*/
#pragma once

#include "common/LLVMWarningsPush.hpp"
#include "llvm/Pass.h"
#include "llvm/Analysis/LoopInfo.h"
#include "common/LLVMWarningsPop.hpp"

#include "Compiler/CodeGenPublic.h"
#include "Compiler/CISACodeGen/WIAnalysis.hpp"

namespace IGC
{
    namespace IGCMD {
        class MetaDataUtils;
    }

    /// @brief  This pass implements a heuristic to determine whether SIMD32 is profitable.
    class Simd32ProfitabilityAnalysis : public llvm::FunctionPass
    {
    public:
        static char ID;

        Simd32ProfitabilityAnalysis();

        ~Simd32ProfitabilityAnalysis() {}

        virtual llvm::StringRef getPassName() const override
        {
            return "Simd32Profitability";
        }

        virtual bool runOnFunction(llvm::Function &F) override;

        virtual void getAnalysisUsage(llvm::AnalysisUsage &AU) const override
        {
            AU.setPreservesAll();
            AU.addRequired<WIAnalysis>();
            AU.addRequired<llvm::LoopInfoWrapperPass>();
            AU.addRequired<llvm::PostDominatorTreeWrapperPass>();
            AU.addRequired<MetaDataUtilsWrapper>();
            AU.addRequired<CodeGenContextWrapper>();
        }

        bool isSimd32Profitable() const { return m_isSimd32Profitable; }
        bool isSimd16Profitable() const { return m_isSimd16Profitable; }

    private:
        llvm::Function *F;
        llvm::PostDominatorTree *PDT;
        llvm::LoopInfo *LI;
        IGCMD::MetaDataUtils *pMdUtils;
        WIAnalysis *WI;
        bool m_isSimd32Profitable;
        bool m_isSimd16Profitable;

        unsigned getLoopCyclomaticComplexity();
        bool checkSimd32Profitable(CodeGenContext *);
        bool checkSimd16Profitable(CodeGenContext *);

        unsigned estimateLoopCount(llvm::Loop *L);
        unsigned estimateLoopCount_CASE1(llvm::Loop *L);
        unsigned estimateLoopCount_CASE2(llvm::Loop *L);

        bool isSelectBasedOnGlobalIdX(llvm::Value *);

        bool checkPSSimd32Profitable();
    };

} // namespace IGC
