xref: /arkcompiler/ets_runtime/ecmascript/compiler/range_guard.h

/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ECMASCRIPT_COMPILER_RANGE_GUARD_H
#define ECMASCRIPT_COMPILER_RANGE_GUARD_H

#include "ecmascript/compiler/circuit_builder.h"
#include "ecmascript/compiler/gate_accessor.h"
#include "ecmascript/compiler/pass_manager.h"
#include "ecmascript/compiler/base/depend_chain_helper.h"
#include "ecmascript/mem/chunk_containers.h"
#include "ecmascript/compiler/number_gate_info.h"
#include "ecmascript/compiler/combined_pass_visitor.h"

namespace panda::ecmascript::kungfu {
class RangeGuard : public PassVisitor {
public:
    RangeGuard(Circuit* circuit, RPOVisitor* visitor, Chunk* chunk)
        : PassVisitor(circuit, chunk, visitor), circuit_(circuit),
        builder_(circuit), acc_(circuit), dependChains_(chunk) {}

    ~RangeGuard() = default;

    void Initialize() override;
    GateRef VisitGate(GateRef gate) override;
    bool CheckInputSource(GateRef lhs, GateRef rhs);
    uint32_t CheckIndexCheckLengthInput(GateRef lhs, GateRef rhs) const;
    uint32_t CheckIndexCheckIndexInput(GateRef lhs, GateRef rhs) const;
private:

    DependChains* GetDependChain(GateRef dependIn)
    {
        size_t idx = acc_.GetId(dependIn);
        ASSERT(idx <= circuit_->GetMaxGateId());
        return dependChains_[idx];
    }

    uint32_t FoundIndexCheckedForLength(DependChains* dependChain, GateRef input) const
    {
        for (auto iter = dependChain->begin(); iter != dependChain->end(); ++iter) {
            uint32_t length = CheckIndexCheckLengthInput(iter.GetCurrentGate(), input);
            if (length > 0) { // found !!!
                return length;
            }
        }

        return 0;
    }

    uint32_t FoundIndexCheckedForIndex(DependChains* dependChain, GateRef input) const
    {
        for (auto iter = dependChain->begin(); iter != dependChain->end(); ++iter) {
            uint32_t length = CheckIndexCheckIndexInput(iter.GetCurrentGate(), input);
            if (length > 0) { // found !!!
                return length;
            }
        }

        return 0;
    }

    GateRef VisitDependEntry(GateRef gate);
    GateRef UpdateDependChain(GateRef gate, DependChains* dependInfo);
    GateRef TryApplyRangeGuardForLength(DependChains* dependInfo, GateRef gate, GateRef input);
    GateRef TryApplyRangeGuardForIndex(DependChains* dependInfo, GateRef gate, GateRef input);
    GateRef TryApplyRangeGuardGate(GateRef gate);
    GateRef TraverseOthers(GateRef gate);
    GateRef TraverseDependSelector(GateRef gate);

    Circuit* circuit_;
    CircuitBuilder builder_;
    GateAccessor acc_;
    ChunkVector<DependChains*> dependChains_;

    friend class RangeInfo;
};
}  // panda::ecmascript::kungfu
#endif  // ECMASCRIPT_COMPILER_RANGE_GUARD_H