/*

 * Copyright (C) 2008 Apple Inc. All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 *

 * 1.  Redistributions of source code must retain the above copyright

 *     notice, this list of conditions and the following disclaimer.

 * 2.  Redistributions in binary form must reproduce the above copyright

 *     notice, this list of conditions and the following disclaimer in the

 *     documentation and/or other materials provided with the distribution.

 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of

 *     its contributors may be used to endorse or promote products derived

 *     from this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY

 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY

 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

#ifndef JITStubs_h

#define JITStubs_h

#include <wtf/Platform.h>

#include "MacroAssemblerCodeRef.h"

#include "Register.h"

#if ENABLE(JIT)

namespace JSC {

    struct StructureStubInfo;

    class CodeBlock;

    class ExecutablePool;

    class FunctionExecutable;

    class Identifier;

    class JSGlobalData;

    class JSGlobalData;

    class JSObject;

    class JSPropertyNameIterator;

    class JSValue;

    class JSValueEncodedAsPointer;

    class Profiler;

    class PropertySlot;

    class PutPropertySlot;

    class RegisterFile;

    class JSGlobalObject;

    class RegExp;

    union JITStubArg {

        void* asPointer;

        EncodedJSValue asEncodedJSValue;

        int32_t asInt32;

        JSValue jsValue() { return JSValue::decode(asEncodedJSValue); }

        JSObject* jsObject() { return static_cast<JSObject*>(asPointer); }

        Identifier& identifier() { return *static_cast<Identifier*>(asPointer); }

        int32_t int32() { return asInt32; }

        CodeBlock* codeBlock() { return static_cast<CodeBlock*>(asPointer); }

        FunctionExecutable* function() { return static_cast<FunctionExecutable*>(asPointer); }

        RegExp* regExp() { return static_cast<RegExp*>(asPointer); }

        JSPropertyNameIterator* propertyNameIterator() { return static_cast<JSPropertyNameIterator*>(asPointer); }

        JSGlobalObject* globalObject() { return static_cast<JSGlobalObject*>(asPointer); }

        JSString* jsString() { return static_cast<JSString*>(asPointer); }

        ReturnAddressPtr returnAddress() { return ReturnAddressPtr(asPointer); }

    };

#if PLATFORM(X86_64)

    struct JITStackFrame {

        void* reserved; // Unused

        JITStubArg args[6];

        void* padding[2]; // Maintain 32-byte stack alignment (possibly overkill).

        void* code;

        RegisterFile* registerFile;

        CallFrame* callFrame;

        JSValue* exception;

        Profiler** enabledProfilerReference;

        JSGlobalData* globalData;

        void* savedRBX;

        void* savedR15;

        void* savedR14;

        void* savedR13;

        void* savedR12;

        void* savedRBP;

        void* savedRIP;

        // When JIT code makes a call, it pushes its return address just below the rest of the stack.

        ReturnAddressPtr* returnAddressSlot() { return reinterpret_cast<ReturnAddressPtr*>(this) - 1; }

    };

#elif PLATFORM(X86)

#if COMPILER(MSVC)

#pragma pack(push)

#pragma pack(4)

#endif // COMPILER(MSVC)

    struct JITStackFrame {

        void* reserved; // Unused

        JITStubArg args[6];

#if USE(JSVALUE32_64)

        void* padding[2]; // Maintain 16-byte stack alignment.

#endif

        void* savedEBX;

        void* savedEDI;

        void* savedESI;

        void* savedEBP;

        void* savedEIP;

        void* code;

        RegisterFile* registerFile;

        CallFrame* callFrame;

        JSValue* exception;

        Profiler** enabledProfilerReference;

        JSGlobalData* globalData;

        // When JIT code makes a call, it pushes its return address just below the rest of the stack.

        ReturnAddressPtr* returnAddressSlot() { return reinterpret_cast<ReturnAddressPtr*>(this) - 1; }

    };

#if COMPILER(MSVC)

#pragma pack(pop)

#endif // COMPILER(MSVC)

#elif PLATFORM(ARM_THUMB2)

    struct JITStackFrame {

        void* reserved; // Unused

        JITStubArg args[6];

#if USE(JSVALUE32_64)

        void* padding[2]; // Maintain 16-byte stack alignment.

#endif

        ReturnAddressPtr thunkReturnAddress;

        void* preservedReturnAddress;

        void* preservedR4;

        void* preservedR5;

        void* preservedR6;

        // These arguments passed in r1..r3 (r0 contained the entry code pointed, which is not preserved)

        RegisterFile* registerFile;

        CallFrame* callFrame;

        JSValue* exception;

        void* padding2;

        // These arguments passed on the stack.

        Profiler** enabledProfilerReference;

        JSGlobalData* globalData;

        ReturnAddressPtr* returnAddressSlot() { return &thunkReturnAddress; }

    };

#elif PLATFORM(ARM_TRADITIONAL)

    struct JITStackFrame {

        JITStubArg padding; // Unused

        JITStubArg args[7];

        ReturnAddressPtr thunkReturnAddress;

        void* preservedR4;

        void* preservedR5;

        void* preservedR6;

        void* preservedR7;

        void* preservedR8;

        void* preservedLink;

        RegisterFile* registerFile;

        CallFrame* callFrame;

        JSValue* exception;

        // These arguments passed on the stack.

        Profiler** enabledProfilerReference;

        JSGlobalData* globalData;

        // When JIT code makes a call, it pushes its return address just below the rest of the stack.

        ReturnAddressPtr* returnAddressSlot() { return &thunkReturnAddress; }

    };

#else

#error "JITStackFrame not defined for this platform."

#endif

#if USE(JIT_STUB_ARGUMENT_VA_LIST)

    #define STUB_ARGS_DECLARATION void* args, ...

    #define STUB_ARGS (reinterpret_cast<void**>(vl_args) - 1)

    #if COMPILER(MSVC)

    #define JIT_STUB __cdecl

    #else

    #define JIT_STUB

    #endif

#else

    #define STUB_ARGS_DECLARATION void** args

    #define STUB_ARGS (args)

    #if PLATFORM(X86) && COMPILER(MSVC)

    #define JIT_STUB __fastcall

    #elif PLATFORM(X86) && COMPILER(GCC)

    #define JIT_STUB  __attribute__ ((fastcall))

    #else

    #define JIT_STUB

    #endif

#endif

#if PLATFORM(X86_64)

    struct VoidPtrPair {

        void* first;

        void* second;

    };

    #define RETURN_POINTER_PAIR(a,b) VoidPtrPair pair = { a, b }; return pair

#else

    // MSVC doesn't support returning a two-value struct in two registers, so

    // we cast the struct to int64_t instead.

    typedef uint64_t VoidPtrPair;

    union VoidPtrPairUnion {

        struct { void* first; void* second; } s;

        VoidPtrPair i;

    };

    #define RETURN_POINTER_PAIR(a,b) VoidPtrPairUnion pair = {{ a, b }}; return pair.i

#endif

    extern "C" void ctiVMThrowTrampoline();

    extern "C" void ctiOpThrowNotCaught();

    extern "C" EncodedJSValue ctiTrampoline(void* code, RegisterFile*, CallFrame*, JSValue* exception, Profiler**, JSGlobalData*);

    class JITThunks {

    public:

        JITThunks(JSGlobalData*);

        static void tryCacheGetByID(CallFrame*, CodeBlock*, ReturnAddressPtr returnAddress, JSValue baseValue, const Identifier& propertyName, const PropertySlot&, StructureStubInfo* stubInfo);

        static void tryCachePutByID(CallFrame*, CodeBlock*, ReturnAddressPtr returnAddress, JSValue baseValue, const PutPropertySlot&, StructureStubInfo* stubInfo);

        MacroAssemblerCodePtr ctiStringLengthTrampoline() { return m_ctiStringLengthTrampoline; }

        MacroAssemblerCodePtr ctiVirtualCallLink() { return m_ctiVirtualCallLink; }

        MacroAssemblerCodePtr ctiVirtualCall() { return m_ctiVirtualCall; }

        MacroAssemblerCodePtr ctiNativeCallThunk() { return m_ctiNativeCallThunk; }

    private:

        RefPtr<ExecutablePool> m_executablePool;

        MacroAssemblerCodePtr m_ctiStringLengthTrampoline;

        MacroAssemblerCodePtr m_ctiVirtualCallLink;

        MacroAssemblerCodePtr m_ctiVirtualCall;

        MacroAssemblerCodePtr m_ctiNativeCallThunk;

    };

extern "C" {

    EncodedJSValue JIT_STUB cti_op_add(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_bitand(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_bitnot(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_bitor(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_bitxor(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_call_NotJSFunction(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_call_eval(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_construct_NotJSConstruct(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_convert_this(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_del_by_id(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_del_by_val(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_div(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_array_fail(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_generic(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_method_check(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_proto_fail(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_proto_list(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_proto_list_full(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_self_fail(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_id_string_fail(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_val(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_val_byte_array(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_get_by_val_string(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_in(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_instanceof(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_is_boolean(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_is_function(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_is_number(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_is_object(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_is_string(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_is_undefined(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_less(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_lesseq(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_lshift(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_mod(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_mul(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_negate(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_not(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_nstricteq(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_post_dec(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_post_inc(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_pre_dec(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_pre_inc(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_resolve(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_resolve_base(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_resolve_global(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_resolve_skip(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_resolve_with_base(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_rshift(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_strcat(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_stricteq(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_sub(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_throw(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_to_jsnumber(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_to_primitive(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_typeof(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_op_urshift(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_vm_throw(STUB_ARGS_DECLARATION);

    EncodedJSValue JIT_STUB cti_to_object(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_construct_JSConstruct(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_new_array(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_new_error(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_new_func(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_new_func_exp(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_new_object(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_new_regexp(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_push_activation(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_push_new_scope(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_push_scope(STUB_ARGS_DECLARATION);

    JSObject* JIT_STUB cti_op_put_by_id_transition_realloc(STUB_ARGS_DECLARATION);

    JSPropertyNameIterator* JIT_STUB cti_op_get_pnames(STUB_ARGS_DECLARATION);

    VoidPtrPair JIT_STUB cti_op_call_arityCheck(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_op_eq(STUB_ARGS_DECLARATION);

#if USE(JSVALUE32_64)

    int JIT_STUB cti_op_eq_strings(STUB_ARGS_DECLARATION);

#endif

    int JIT_STUB cti_op_jless(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_op_jlesseq(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_op_jtrue(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_op_load_varargs(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_op_loop_if_less(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_op_loop_if_lesseq(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_op_loop_if_true(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_timeout_check(STUB_ARGS_DECLARATION);

    int JIT_STUB cti_has_property(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_create_arguments(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_create_arguments_no_params(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_debug(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_end(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_jmp_scopes(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_pop_scope(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_profile_did_call(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_profile_will_call(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_by_id(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_by_id_fail(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_by_id_generic(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_by_index(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_by_val(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_by_val_byte_array(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_getter(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_put_setter(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_ret_scopeChain(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_tear_off_activation(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_op_tear_off_arguments(STUB_ARGS_DECLARATION);

    void JIT_STUB cti_register_file_check(STUB_ARGS_DECLARATION);

    void* JIT_STUB cti_op_call_JSFunction(STUB_ARGS_DECLARATION);

    void* JIT_STUB cti_op_switch_char(STUB_ARGS_DECLARATION);

    void* JIT_STUB cti_op_switch_imm(STUB_ARGS_DECLARATION);

    void* JIT_STUB cti_op_switch_string(STUB_ARGS_DECLARATION);

    void* JIT_STUB cti_vm_lazyLinkCall(STUB_ARGS_DECLARATION);

} // extern "C"

} // namespace JSC

#endif // ENABLE(JIT)

#endif // JITStubs_h