/*
 * Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must 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.
 */
package com.oracle.truffle.js.nodes.instrumentation;

import java.util.Set;

import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.instrumentation.InstrumentableNode;
import com.oracle.truffle.api.instrumentation.Tag;
import com.oracle.truffle.js.nodes.JavaScriptNode;
import com.oracle.truffle.js.nodes.access.GlobalConstantNode;
import com.oracle.truffle.js.nodes.access.JSTargetableNode;
import com.oracle.truffle.js.nodes.access.OptionalChainNode.OptionalTargetableNode;
import com.oracle.truffle.js.nodes.access.OptionalChainNode.ShortCircuitTargetableNode;
import com.oracle.truffle.js.nodes.access.PrivateFieldGetNode;
import com.oracle.truffle.js.nodes.access.PropertyNode;
import com.oracle.truffle.js.nodes.access.ReadElementNode;
import com.oracle.truffle.js.nodes.access.WithVarWrapperNode;
import com.oracle.truffle.js.nodes.instrumentation.JSTags.InputNodeTag;
import com.oracle.truffle.js.runtime.Errors;
import com.oracle.truffle.js.runtime.JSContext;

Materialized nodes used by MaterializedInvokeNode to report JS function values to
the instrumentation framework.
By default, InvokeNode evaluates its target node in two separate steps: first, the
node is evaluated to retrieve the target value. Then, the same node is evaluated via
executeWithTarget() to retrieve the JS function instance to be called. The second
evaluation via executeWithTarget() causes a read event (e.g., property read) that
will be detected by the instrumentation framework. Since the target is already evaluated, such
read event will however miss its target value, resulting in a wrong series of
instrumentation events.
The materialized nodes in this class internally re-evaluate the target value
provided via executeWithTarget() using the internal EchoTargetValueNode
. In this way, the instrumentation framework is able to trace target and report it
correctly as an onInput value.
/**
 * Materialized nodes used by <code>MaterializedInvokeNode</code> to report JS function values to
 * the instrumentation framework.
 *
 * By default, <code>InvokeNode</code> evaluates its target node in two separate steps: first, the
 * node is evaluated to retrieve the <code>target</code> value. Then, the same node is evaluated via
 * <code>executeWithTarget()</code> to retrieve the JS function instance to be called. The second
 * evaluation via <code>executeWithTarget()</code> causes a read event (e.g., property read) that
 * will be detected by the instrumentation framework. Since the target is already evaluated, such
 * read event will however miss its <code>target</code> value, resulting in a wrong series of
 * instrumentation events.
 *
 * The materialized nodes in this class internally re-evaluate the <code>target</code> value
 * provided via <code>executeWithTarget()</code> using the internal <code>EchoTargetValueNode</code>
 * . In this way, the instrumentation framework is able to trace <code>target</code> and report it
 * correctly as an <code>onInput</code> value.
 *
 */
public abstract class JSMaterializedInvokeTargetableNode extends JSTargetableNode {
    public static JSTargetableNode createFor(JSTargetableNode target) {
        if (target instanceof PropertyNode) {
            return new MaterializedTargetablePropertyNode((PropertyNode) target);
        } else if (target instanceof ReadElementNode) {
            return new MaterializedTargetableReadElementNode((ReadElementNode) target);
        } else if (target instanceof WithVarWrapperNode || target instanceof GlobalConstantNode || target instanceof PrivateFieldGetNode ||
                        target instanceof ShortCircuitTargetableNode || target instanceof OptionalTargetableNode) {
            return target;
        } else {
            // Unknown targetable node: we might need to implement a new materialized node for it.
            throw Errors.shouldNotReachHere("Unsupported materialization node type: " + target.getClass());
        }
    }

    
Materialized version of ReadElementNode to be used as a target node by
MaterializedInvokeNode.
/**
     * Materialized version of <code>ReadElementNode</code> to be used as a target node by
     * <code>MaterializedInvokeNode</code>.
     *
     */
    private static class MaterializedTargetableReadElementNode extends ReadElementNode {
        protected MaterializedTargetableReadElementNode(JavaScriptNode targetNode, JavaScriptNode indexNode, JSContext context) {
            super(targetNode, indexNode, context);
        }

        MaterializedTargetableReadElementNode(ReadElementNode from) {
            this(new EchoTargetValueNode(), from.getElement(), from.getContext());
        }

        @Override
        public Object executeWithTarget(VirtualFrame frame, Object targetValue) {
            ((JSTargetableNode) getTarget()).executeWithTarget(frame, targetValue);
            return super.executeWithTarget(frame, targetValue);
        }

        @Override
        public Object execute(VirtualFrame frame) {
            throw Errors.shouldNotReachHere("Must use executeWithTarget()");
        }

        @Override
        public boolean isInstrumentable() {
            return true;
        }

        @Override
        public boolean hasTag(Class<? extends Tag> tag) {
            if (tag == InputNodeTag.class) {
                return true;
            }
            return super.hasTag(tag);
        }

        @Override
        public InstrumentableNode materializeInstrumentableNodes(Set<Class<? extends Tag>> materializedTags) {
            return this;
        }

        @Override
        protected JavaScriptNode copyUninitialized(Set<Class<? extends Tag>> materializedTags) {
            return new MaterializedTargetableReadElementNode(cloneUninitialized(getTarget(), materializedTags), cloneUninitialized(getIndexNode(), materializedTags), context);
        }
    }

    
Materialized version of PropertyNode to be used as a target node by
MaterializedInvokeNode.
/**
     * Materialized version of <code>PropertyNode</code> to be used as a target node by
     * <code>MaterializedInvokeNode</code>.
     *
     */
    private static class MaterializedTargetablePropertyNode extends PropertyNode {
        protected MaterializedTargetablePropertyNode(JSContext context, JavaScriptNode target, Object propertyKey, boolean getOwnProperty, boolean method) {
            super(context, target, propertyKey, getOwnProperty, method);
        }

        MaterializedTargetablePropertyNode(PropertyNode target) {
            this(target.getContext(), new EchoTargetValueNode(), target.getPropertyKey(), target.isOwnProperty(), target.isMethod());
        }

        @Override
        public Object executeWithTarget(VirtualFrame frame, Object targetValue) {
            ((JSTargetableNode) getTarget()).executeWithTarget(frame, targetValue);
            return super.executeWithTarget(frame, targetValue);
        }

        @Override
        public Object execute(VirtualFrame frame) {
            throw Errors.shouldNotReachHere("Must use executeWithTarget()");
        }

        @Override
        public boolean isInstrumentable() {
            return true;
        }

        @Override
        public boolean hasTag(Class<? extends Tag> tag) {
            if (tag == InputNodeTag.class) {
                return true;
            }
            return super.hasTag(tag);
        }

        @Override
        public InstrumentableNode materializeInstrumentableNodes(Set<Class<? extends Tag>> materializedTags) {
            return this;
        }

        @Override
        protected JavaScriptNode copyUninitialized(Set<Class<? extends Tag>> materializedTags) {
            return new MaterializedTargetablePropertyNode(getContext(), cloneUninitialized(getTarget(), materializedTags), getPropertyKey(), isOwnProperty(), isMethod());
        }
    }

    
Instrumentable node reporting to the instrumentation framework any value provided to
executeWithTarget().
/**
     * Instrumentable node reporting to the instrumentation framework any value provided to
     * <code>executeWithTarget()</code>.
     *
     */
    public static class EchoTargetValueNode extends JSTargetableNode {

        public static JSTargetableNode create() {
            return new EchoTargetValueNode();
        }

        @Override
        public Object executeWithTarget(VirtualFrame frame, Object target) {
            return target;
        }

        @Override
        public Object execute(VirtualFrame frame) {
            throw Errors.shouldNotReachHere("Must use executeWithTarget()");
        }

        @Override
        public boolean isInstrumentable() {
            return true;
        }

        @Override
        public boolean hasTag(Class<? extends Tag> tag) {
            return tag == JSTags.InputNodeTag.class;
        }

        @Override
        protected JavaScriptNode copyUninitialized(Set<Class<? extends Tag>> materializedTags) {
            return new EchoTargetValueNode();
        }
    }

}