| //------------------------------------------------------------------------------------------------------- |
| // Copyright (C) Microsoft. All rights reserved. |
| // Licensed under the MIT license. See LICENSE.txt file in the project root for full license information. |
| //------------------------------------------------------------------------------------------------------- |
| #include "RuntimeLibraryPch.h" |
| #include "Types/DeferredTypeHandler.h" |
| namespace Js |
| { |
| // This is a wrapper class for javascript functions that are added directly to the JS engine via BuildDirectFunction |
| // or CreateConstructor. We add a thunk before calling into user's direct C++ methods, with additional checks: |
| // . check the script site is still alive. |
| // . convert globalObject to hostObject |
| // . leavescriptstart/end |
| // . wrap the result value with potential cross site access |
| |
| JavascriptExternalFunction::JavascriptExternalFunction(ExternalMethod entryPoint, DynamicType* type) |
| : RuntimeFunction(type, &EntryInfo::ExternalFunctionThunk), nativeMethod(entryPoint), signature(nullptr), callbackState(nullptr), initMethod(nullptr), |
| oneBit(1), typeSlots(0), hasAccessors(0), prototypeTypeId(-1), flags(0) |
| { |
| DebugOnly(VerifyEntryPoint()); |
| } |
| |
| JavascriptExternalFunction::JavascriptExternalFunction(ExternalMethod entryPoint, DynamicType* type, InitializeMethod method, unsigned short deferredSlotCount, bool accessors) |
| : RuntimeFunction(type, &EntryInfo::ExternalFunctionThunk), nativeMethod(entryPoint), signature(nullptr), callbackState(nullptr), initMethod(method), |
| oneBit(1), typeSlots(deferredSlotCount), hasAccessors(accessors),prototypeTypeId(-1), flags(0) |
| { |
| DebugOnly(VerifyEntryPoint()); |
| } |
| |
| JavascriptExternalFunction::JavascriptExternalFunction(DynamicType* type, InitializeMethod method, unsigned short deferredSlotCount, bool accessors) |
| : RuntimeFunction(type, &EntryInfo::DefaultExternalFunctionThunk), nativeMethod(nullptr), signature(nullptr), callbackState(nullptr), initMethod(method), |
| oneBit(1), typeSlots(deferredSlotCount), hasAccessors(accessors), prototypeTypeId(-1), flags(0) |
| { |
| DebugOnly(VerifyEntryPoint()); |
| } |
| |
| |
| JavascriptExternalFunction::JavascriptExternalFunction(JavascriptExternalFunction* entryPoint, DynamicType* type) |
| : RuntimeFunction(type, &EntryInfo::WrappedFunctionThunk), wrappedMethod(entryPoint), callbackState(nullptr), initMethod(nullptr), |
| oneBit(1), typeSlots(0), hasAccessors(0), prototypeTypeId(-1), flags(0) |
| { |
| DebugOnly(VerifyEntryPoint()); |
| } |
| |
| JavascriptExternalFunction::JavascriptExternalFunction(StdCallJavascriptMethod entryPoint, DynamicType* type) |
| : RuntimeFunction(type, &EntryInfo::StdCallExternalFunctionThunk), stdCallNativeMethod(entryPoint), signature(nullptr), callbackState(nullptr), initMethod(nullptr), |
| oneBit(1), typeSlots(0), hasAccessors(0), prototypeTypeId(-1), flags(0) |
| { |
| DebugOnly(VerifyEntryPoint()); |
| } |
| |
| JavascriptExternalFunction::JavascriptExternalFunction(DynamicType *type) |
| : RuntimeFunction(type, &EntryInfo::ExternalFunctionThunk), nativeMethod(nullptr), signature(nullptr), callbackState(nullptr), initMethod(nullptr), |
| oneBit(1), typeSlots(0), hasAccessors(0), prototypeTypeId(-1), flags(0) |
| { |
| DebugOnly(VerifyEntryPoint()); |
| } |
| |
| void __cdecl JavascriptExternalFunction::DeferredInitializer(DynamicObject* instance, DeferredTypeHandlerBase* typeHandler, DeferredInitializeMode mode) |
| { |
| JavascriptExternalFunction* object = static_cast<JavascriptExternalFunction*>(instance); |
| HRESULT hr = E_FAIL; |
| |
| ScriptContext* scriptContext = object->GetScriptContext(); |
| AnalysisAssert(scriptContext); |
| // Don't call the implicit call if disable implicit call |
| if (scriptContext->GetThreadContext()->IsDisableImplicitCall()) |
| { |
| scriptContext->GetThreadContext()->AddImplicitCallFlags(ImplicitCall_External); |
| //we will return if we get call further into implicitcalls. |
| return; |
| } |
| |
| if (scriptContext->IsClosed() || scriptContext->IsInvalidatedForHostObjects()) |
| { |
| Js::JavascriptError::MapAndThrowError(scriptContext, E_ACCESSDENIED); |
| } |
| ThreadContext* threadContext = scriptContext->GetThreadContext(); |
| |
| typeHandler->Convert(instance, mode, object->typeSlots, object->hasAccessors); |
| |
| BEGIN_LEAVE_SCRIPT_INTERNAL(scriptContext) |
| { |
| ASYNC_HOST_OPERATION_START(threadContext); |
| |
| hr = object->initMethod(instance); |
| |
| ASYNC_HOST_OPERATION_END(threadContext); |
| } |
| END_LEAVE_SCRIPT_INTERNAL(scriptContext); |
| |
| if (FAILED(hr)) |
| { |
| Js::JavascriptError::MapAndThrowError(scriptContext, hr); |
| } |
| |
| JavascriptString * functionName = nullptr; |
| if (scriptContext->GetConfig()->IsES6FunctionNameEnabled() && |
| object->GetFunctionName(&functionName)) |
| { |
| object->SetPropertyWithAttributes(PropertyIds::name, functionName, PropertyConfigurable, nullptr); |
| } |
| |
| } |
| |
| void JavascriptExternalFunction::PrepareExternalCall(Js::Arguments * args) |
| { |
| ScriptContext * scriptContext = this->type->GetScriptContext(); |
| Assert(!scriptContext->GetThreadContext()->IsDisableImplicitException()); |
| scriptContext->VerifyAlive(); |
| |
| Assert(scriptContext->GetThreadContext()->IsScriptActive()); |
| |
| if (args->Info.Count == 0) |
| { |
| JavascriptError::ThrowTypeError(scriptContext, JSERR_This_NullOrUndefined); |
| } |
| |
| Var &thisVar = args->Values[0]; |
| |
| Js::TypeId typeId = Js::JavascriptOperators::GetTypeId(thisVar); |
| |
| Js::RecyclableObject* directHostObject = nullptr; |
| switch(typeId) |
| { |
| case TypeIds_Integer: |
| #if FLOATVAR |
| case TypeIds_Number: |
| #endif // FLOATVAR |
| Assert(!Js::RecyclableObject::Is(thisVar)); |
| break; |
| default: |
| { |
| Assert(Js::RecyclableObject::Is(thisVar)); |
| |
| ScriptContext* scriptContextThisVar = Js::RecyclableObject::FromVar(thisVar)->GetScriptContext(); |
| // We need to verify "this" pointer is active as well. The problem is that DOM prototype functions are |
| // the same across multiple frames, and caller can do function.call(closedthis) |
| Assert(!scriptContext->GetThreadContext()->IsDisableImplicitException()); |
| scriptContextThisVar->VerifyAlive(); |
| |
| // translate direct host for fastDOM. |
| switch(typeId) |
| { |
| case Js::TypeIds_GlobalObject: |
| { |
| Js::GlobalObject* srcGlobalObject = static_cast<Js::GlobalObject*>(thisVar); |
| directHostObject = srcGlobalObject->GetDirectHostObject(); |
| // For jsrt, direct host object can be null. If thats the case don't change it. |
| if (directHostObject != nullptr) |
| { |
| thisVar = directHostObject; |
| } |
| |
| } |
| break; |
| case Js::TypeIds_Undefined: |
| case Js::TypeIds_Null: |
| { |
| // Call to DOM function with this as "undefined" or "null" |
| // This should be converted to Global object |
| Js::GlobalObject* srcGlobalObject = scriptContextThisVar->GetGlobalObject() ; |
| directHostObject = srcGlobalObject->GetDirectHostObject(); |
| // For jsrt, direct host object can be null. If thats the case don't change it. |
| if (directHostObject != nullptr) |
| { |
| thisVar = directHostObject; |
| } |
| } |
| break; |
| } |
| } |
| break; |
| } |
| } |
| |
| Var JavascriptExternalFunction::ExternalFunctionThunk(RecyclableObject* function, CallInfo callInfo, ...) |
| { |
| ARGUMENTS(args, callInfo); |
| JavascriptExternalFunction* externalFunction = static_cast<JavascriptExternalFunction*>(function); |
| |
| ScriptContext * scriptContext = externalFunction->type->GetScriptContext(); |
| |
| #ifdef ENABLE_DIRECTCALL_TELEMETRY |
| DirectCallTelemetry::AutoLogger logger(scriptContext, externalFunction, &args); |
| #endif |
| |
| externalFunction->PrepareExternalCall(&args); |
| |
| #if ENABLE_TTD |
| Var result = nullptr; |
| |
| // |
| //TODO: This may be a hot path so we may want to reduce the number of checks here and perhaps create a special TTD external function so only record code is needed here (see also in StdCallExternalFunctionThunk below). |
| // |
| if(scriptContext->ShouldPerformDebugAction()) |
| { |
| TTD::TTDReplayExternalFunctionCallActionPopper logPopper(externalFunction); |
| |
| scriptContext->GetThreadContext()->TTDLog->ReplayExternalCallEvent(externalFunction, args.Info.Count, args.Values, &result); |
| } |
| else if(scriptContext->ShouldPerformRecordAction()) |
| { |
| //Root nesting depth handled in logPopper constructor, destructor, and Normal return paths -- the increment of nesting is handled by the popper but we need to add 1 to the value we record (so it matches) |
| TTD::NSLogEvents::EventLogEntry* callEvent = scriptContext->GetThreadContext()->TTDLog->RecordExternalCallEvent(externalFunction, scriptContext->TTDRootNestingCount + 1, args.Info.Count, args.Values); |
| TTD::TTDRecordExternalFunctionCallActionPopper logPopper(externalFunction, callEvent); |
| |
| BEGIN_LEAVE_SCRIPT_WITH_EXCEPTION(scriptContext) |
| { |
| // Don't do stack probe since BEGIN_LEAVE_SCRIPT_WITH_EXCEPTION does that for us already |
| result = externalFunction->nativeMethod(function, callInfo, args.Values); |
| } |
| END_LEAVE_SCRIPT_WITH_EXCEPTION(scriptContext); |
| |
| //no exception check below so I assume the external call cannot have an exception registered |
| logPopper.NormalReturn(false, result); |
| } |
| else |
| { |
| if(externalFunction->nativeMethod == nullptr) |
| { |
| //The only way this should happen is if the debugger is requesting a value to display that is an external accessor |
| //or the debugger is running something that can fail (and it is ok with that). |
| |
| result = function->GetScriptContext()->GetLibrary()->GetUndefined(); |
| } |
| else |
| { |
| BEGIN_LEAVE_SCRIPT_WITH_EXCEPTION(scriptContext) |
| { |
| // Don't do stack probe since BEGIN_LEAVE_SCRIPT_WITH_EXCEPTION does that for us already |
| result = externalFunction->nativeMethod(function, callInfo, args.Values); |
| } |
| END_LEAVE_SCRIPT_WITH_EXCEPTION(scriptContext); |
| } |
| } |
| #else |
| Var result = nullptr; |
| BEGIN_LEAVE_SCRIPT_WITH_EXCEPTION(scriptContext) |
| { |
| // Don't do stack probe since BEGIN_LEAVE_SCRIPT_WITH_EXCEPTION does that for us already |
| result = externalFunction->nativeMethod(function, callInfo, args.Values); |
| } |
| END_LEAVE_SCRIPT_WITH_EXCEPTION(scriptContext); |
| #endif |
| if (result == nullptr) |
| { |
| #pragma warning(push) |
| #pragma warning(disable:6011) // scriptContext cannot be null here |
| result = scriptContext->GetLibrary()->GetUndefined(); |
| #pragma warning(pop) |
| } |
| else |
| { |
| result = CrossSite::MarshalVar(scriptContext, result); |
| } |
| |
| return result; |
| } |
| |
| Var JavascriptExternalFunction::WrappedFunctionThunk(RecyclableObject* function, CallInfo callInfo, ...) |
| { |
| ARGUMENTS(args, callInfo); |
| JavascriptExternalFunction* externalFunction = static_cast<JavascriptExternalFunction*>(function); |
| ScriptContext* scriptContext = externalFunction->type->GetScriptContext(); |
| Assert(!scriptContext->GetThreadContext()->IsDisableImplicitException()); |
| scriptContext->VerifyAlive(); |
| Assert(scriptContext->GetThreadContext()->IsScriptActive()); |
| |
| // Make sure the callee knows we are a wrapped function thunk |
| args.Info.Flags = (Js::CallFlags) (((int32) args.Info.Flags) | CallFlags_Wrapped); |
| |
| // don't need to leave script here, ExternalFunctionThunk will |
| Assert(externalFunction->wrappedMethod->GetFunctionInfo()->GetOriginalEntryPoint() == JavascriptExternalFunction::ExternalFunctionThunk); |
| return JavascriptFunction::CallFunction<true>(externalFunction->wrappedMethod, externalFunction->wrappedMethod->GetEntryPoint(), args); |
| } |
| |
| Var JavascriptExternalFunction::DefaultExternalFunctionThunk(RecyclableObject* function, CallInfo callInfo, ...) |
| { |
| TypeId typeId = function->GetTypeId(); |
| rtErrors err = typeId == TypeIds_Undefined || typeId == TypeIds_Null ? JSERR_NeedObject : JSERR_NeedFunction; |
| JavascriptError::ThrowTypeError(function->GetScriptContext(), err); |
| } |
| |
| Var JavascriptExternalFunction::StdCallExternalFunctionThunk(RecyclableObject* function, CallInfo callInfo, ...) |
| { |
| ARGUMENTS(args, callInfo); |
| JavascriptExternalFunction* externalFunction = static_cast<JavascriptExternalFunction*>(function); |
| |
| externalFunction->PrepareExternalCall(&args); |
| |
| ScriptContext * scriptContext = externalFunction->type->GetScriptContext(); |
| AnalysisAssert(scriptContext); |
| Var result = NULL; |
| |
| #if ENABLE_TTD |
| if(scriptContext->ShouldPerformDebugAction()) |
| { |
| TTD::TTDReplayExternalFunctionCallActionPopper logPopper(externalFunction); |
| |
| scriptContext->GetThreadContext()->TTDLog->ReplayExternalCallEvent(externalFunction, args.Info.Count, args.Values, &result); |
| } |
| else if(scriptContext->ShouldPerformRecordAction()) |
| { |
| //Root nesting depth handled in logPopper constructor, destructor, and Normal return paths -- the increment of nesting is handled by the popper but we need to add 1 to the value we record (so it matches) |
| TTD::NSLogEvents::EventLogEntry* callEvent = scriptContext->GetThreadContext()->TTDLog->RecordExternalCallEvent(externalFunction, scriptContext->TTDRootNestingCount + 1, args.Info.Count, args.Values); |
| TTD::TTDRecordExternalFunctionCallActionPopper logPopper(externalFunction, callEvent); |
| |
| BEGIN_LEAVE_SCRIPT(scriptContext) |
| { |
| result = externalFunction->stdCallNativeMethod(function, ((callInfo.Flags & CallFlags_New) != 0), args.Values, args.Info.Count, externalFunction->callbackState); |
| } |
| END_LEAVE_SCRIPT(scriptContext); |
| |
| //exception check is done explicitly below call can have an exception registered |
| logPopper.NormalReturn(true, result); |
| } |
| else |
| { |
| BEGIN_LEAVE_SCRIPT(scriptContext) |
| { |
| result = externalFunction->stdCallNativeMethod(function, ((callInfo.Flags & CallFlags_New) != 0), args.Values, args.Info.Count, externalFunction->callbackState); |
| } |
| END_LEAVE_SCRIPT(scriptContext); |
| } |
| #else |
| BEGIN_LEAVE_SCRIPT(scriptContext) |
| { |
| result = externalFunction->stdCallNativeMethod(function, ((callInfo.Flags & CallFlags_New) != 0), args.Values, args.Info.Count, externalFunction->callbackState); |
| } |
| END_LEAVE_SCRIPT(scriptContext); |
| #endif |
| |
| if (result != nullptr && !Js::TaggedNumber::Is(result)) |
| { |
| if (!Js::RecyclableObject::Is(result)) |
| { |
| Js::Throw::InternalError(); |
| } |
| |
| Js::RecyclableObject * obj = Js::RecyclableObject::FromVar(result); |
| |
| // For JSRT, we could get result marshalled in different context. |
| bool isJSRT = scriptContext->GetThreadContext()->IsJSRT(); |
| if (!isJSRT && obj->GetScriptContext() != scriptContext) |
| { |
| Js::Throw::InternalError(); |
| } |
| } |
| |
| if (scriptContext->HasRecordedException()) |
| { |
| bool considerPassingToDebugger = false; |
| JavascriptExceptionObject* recordedException = scriptContext->GetAndClearRecordedException(&considerPassingToDebugger); |
| if (recordedException != nullptr) |
| { |
| // If this is script termination, then throw ScriptAbortExceptio, else throw normal Exception object. |
| if (recordedException == scriptContext->GetThreadContext()->GetPendingTerminatedErrorObject()) |
| { |
| throw Js::ScriptAbortException(); |
| } |
| else |
| { |
| JavascriptExceptionOperators::RethrowExceptionObject(recordedException, scriptContext, considerPassingToDebugger); |
| } |
| } |
| } |
| |
| if (result == nullptr) |
| { |
| result = scriptContext->GetLibrary()->GetUndefined(); |
| } |
| else |
| { |
| result = CrossSite::MarshalVar(scriptContext, result); |
| } |
| |
| return result; |
| } |
| |
| BOOL JavascriptExternalFunction::SetLengthProperty(Var length) |
| { |
| return DynamicObject::SetPropertyWithAttributes(PropertyIds::length, length, PropertyConfigurable, NULL, PropertyOperation_None, SideEffects_None); |
| } |
| |
| #if ENABLE_TTD |
| TTD::NSSnapObjects::SnapObjectType JavascriptExternalFunction::GetSnapTag_TTD() const |
| { |
| return TTD::NSSnapObjects::SnapObjectType::SnapExternalFunctionObject; |
| } |
| |
| void JavascriptExternalFunction::ExtractSnapObjectDataInto(TTD::NSSnapObjects::SnapObject* objData, TTD::SlabAllocator& alloc) |
| { |
| Js::JavascriptString* nameString = this->GetDisplayName(); |
| |
| TTD::TTString* snapName = alloc.SlabAllocateStruct<TTD::TTString>(); |
| alloc.CopyStringIntoWLength(nameString->GetSz(), nameString->GetLength(), *snapName); |
| |
| TTD::NSSnapObjects::StdExtractSetKindSpecificInfo<TTD::TTString*, TTD::NSSnapObjects::SnapObjectType::SnapExternalFunctionObject>(objData, snapName); |
| } |
| #endif |
| } |