Implement JsExecuteBackgroundParse

This change enables execution of background-parsed script. It is built upon the serialization and parser state JSRT APIs.

With this change, there are several memory leaks that will be addressed in a subsequent commit.

Author: Thomas Moore

bin/ChakraCore/ChakraCore.def

@@ -70,3 +70,7 @@ JsSerializeParserState
 JsRunScriptWithParserState
 JsGetPromiseState
 JsGetPromiseResult
+
+JsQueueBackgroundParse
+JsDiscardBackgroundParse
+JsExecuteBackgroundParse

bin/ch/ChakraRtInterface.cpp

@@ -160,6 +160,12 @@ bool ChakraRTInterface::LoadChakraDll(ArgInfo* argInfo, HINSTANCE *outLibrary)
     m_jsApiHooks.pfJsrtSerializeParserState = (JsAPIHooks::JsrtSerializeParserState)GetChakraCoreSymbol(library, "JsSerializeParserState");
     m_jsApiHooks.pfJsrtRunScriptWithParserState = (JsAPIHooks::JsrtRunScriptWithParserState)GetChakraCoreSymbol(library, "JsRunScriptWithParserState");
 
+    m_jsApiHooks.pfJsrtQueueBackgroundParse = (JsAPIHooks::JsrtQueueBackgroundParse)GetChakraCoreSymbol(library, "JsQueueBackgroundParse");
+    m_jsApiHooks.pfJsrtDiscardBackgroundParse = (JsAPIHooks::JsrtDiscardBackgroundParse)GetChakraCoreSymbol(library, "JsDiscardBackgroundParse");
+    m_jsApiHooks.pfJsrtExecuteBackgroundParse = (JsAPIHooks::JsrtExecuteBackgroundParse)GetChakraCoreSymbol(library, "JsExecuteBackgroundParse");
+
+
+
     m_jsApiHooks.pfJsrtTTDCreateRecordRuntime = (JsAPIHooks::JsrtTTDCreateRecordRuntimePtr)GetChakraCoreSymbol(library, "JsTTDCreateRecordRuntime");
     m_jsApiHooks.pfJsrtTTDCreateReplayRuntime = (JsAPIHooks::JsrtTTDCreateReplayRuntimePtr)GetChakraCoreSymbol(library, "JsTTDCreateReplayRuntime");
     m_jsApiHooks.pfJsrtTTDCreateContext = (JsAPIHooks::JsrtTTDCreateContextPtr)GetChakraCoreSymbol(library, "JsTTDCreateContext");

bin/ch/ChakraRtInterface.h

@@ -92,6 +92,10 @@ struct JsAPIHooks
 
     typedef JsErrorCode(WINAPI *JsrtSerializeParserState)(JsValueRef script, JsValueRef *buffer, JsParseScriptAttributes parseAttributes);
     typedef JsErrorCode(WINAPI *JsrtRunScriptWithParserState)(JsValueRef script, JsSourceContext sourceContext, JsValueRef sourceUrl, JsParseScriptAttributes parseAttributes, JsValueRef parserState, JsValueRef *result);
+    
+    typedef JsErrorCode(WINAPI *JsrtQueueBackgroundParse)(JsScriptContents* contents, DWORD* dwBgParseCookie);
+    typedef JsErrorCode(WINAPI *JsrtDiscardBackgroundParse)(DWORD dwBgParseCookie, void* buffer, bool* callerOwnsBuffer);
+    typedef JsErrorCode(WINAPI *JsrtExecuteBackgroundParse)(DWORD dwBgParseCookie, JsValueRef script, JsSourceContext sourceContext, WCHAR *url, JsParseScriptAttributes parseAttributes, JsValueRef parserState, JsValueRef *result);
 
     typedef JsErrorCode(WINAPI *JsrtTTDCreateRecordRuntimePtr)(JsRuntimeAttributes attributes, bool enableDebugging, size_t snapInterval, size_t snapHistoryLength, TTDOpenResourceStreamCallback openResourceStream, JsTTDWriteBytesToStreamCallback writeBytesToStream, JsTTDFlushAndCloseStreamCallback flushAndCloseStream, JsThreadServiceCallback threadService, JsRuntimeHandle *runtime);
     typedef JsErrorCode(WINAPI *JsrtTTDCreateReplayRuntimePtr)(JsRuntimeAttributes attributes, const char* infoUri, size_t infoUriCount, bool enableDebugging, TTDOpenResourceStreamCallback openResourceStream, JsTTDReadBytesFromStreamCallback readBytesFromStream, JsTTDFlushAndCloseStreamCallback flushAndCloseStream, JsThreadServiceCallback threadService, JsRuntimeHandle *runtime);
@@ -195,6 +199,10 @@ struct JsAPIHooks
     JsrtSerializeParserState pfJsrtSerializeParserState;
     JsrtRunScriptWithParserState pfJsrtRunScriptWithParserState;
 
+    JsrtQueueBackgroundParse pfJsrtQueueBackgroundParse;
+    JsrtDiscardBackgroundParse pfJsrtDiscardBackgroundParse;
+    JsrtExecuteBackgroundParse pfJsrtExecuteBackgroundParse;
+
     JsrtTTDCreateRecordRuntimePtr pfJsrtTTDCreateRecordRuntime;
     JsrtTTDCreateReplayRuntimePtr pfJsrtTTDCreateReplayRuntime;
     JsrtTTDCreateContextPtr pfJsrtTTDCreateContext;
@@ -430,6 +438,10 @@ class ChakraRTInterface
 
     static JsErrorCode WINAPI JsSerializeParserState(JsValueRef script, JsValueRef *buffer, JsParseScriptAttributes parseAttributes) { return HOOK_JS_API(SerializeParserState(script, buffer, parseAttributes)); }
     static JsErrorCode WINAPI JsRunScriptWithParserState(JsValueRef script, JsSourceContext sourceContext, JsValueRef sourceUrl, JsParseScriptAttributes parseAttributes, JsValueRef parserState, JsValueRef * result) { return HOOK_JS_API(RunScriptWithParserState(script, sourceContext, sourceUrl, parseAttributes, parserState, result)); }
+
+    static JsErrorCode WINAPI JsQueueBackgroundParse(JsScriptContents* contents, DWORD* dwBgParseCookie) { return HOOK_JS_API(QueueBackgroundParse(contents, dwBgParseCookie));  }
+    static JsErrorCode WINAPI JsDiscardBackgroundParse(DWORD dwBgParseCookie, void* buffer, bool* callerOwnsBuffer) { return HOOK_JS_API(DiscardBackgroundParse(dwBgParseCookie, buffer, callerOwnsBuffer)); }
+    static JsErrorCode WINAPI JsExecuteBackgroundParse(DWORD dwBgParseCookie, JsValueRef script, JsSourceContext sourceContext, WCHAR *url, JsParseScriptAttributes parseAttributes, JsValueRef parserState, JsValueRef *result) { return HOOK_JS_API(ExecuteBackgroundParse(dwBgParseCookie, script, sourceContext, url, parseAttributes, parserState, result)); }
 };
 
 class AutoRestoreContext

bin/ch/ch.cpp

@@ -755,6 +755,49 @@ HRESULT CreateAndRunSerializedScript(const char* fileName, LPCSTR fileContents,
     return hr;
 }
 
+// Use the asynchronous BGParse JSRT APIs in a synchronous call
+HRESULT RunBgParseSync(LPCSTR fileContents, UINT lengthBytes, const char* fileName)
+{
+    JsValueRef scriptSource;
+    JsErrorCode e = (ChakraRTInterface::JsCreateExternalArrayBuffer((void*)fileContents,
+        (unsigned int)lengthBytes,
+        nullptr, (void*)fileContents, &scriptSource));
+
+    // What's the preferred way of doing this?
+    WCHAR fileNameWide[MAX_PATH] = { 0 };
+    size_t fileNameLength = strlen(fileName);
+    for (int i = 0; i < fileNameLength; i++)
+    {
+        fileNameWide[i] = fileName[i];
+    }   
+
+
+    JsScriptContents scriptContents = { 0 };
+    scriptContents.container = (LPVOID)fileContents;
+    scriptContents.containerType = JsScriptContainerType::HeapAllocatedBuffer;
+    scriptContents.encodingType = JsScriptEncodingType::Utf8;
+    scriptContents.contentLengthInBytes = lengthBytes;
+    scriptContents.fullPath = fileNameWide;
+
+    DWORD cookie = 0;
+    e = ChakraRTInterface::JsQueueBackgroundParse(&scriptContents, &cookie);
+    Assert(e == JsErrorCode::JsNoError);
+
+    JsValueRef bgResult = nullptr;
+    e = ChakraRTInterface::JsExecuteBackgroundParse(
+        cookie,
+        scriptSource,
+        WScriptJsrt::GetNextSourceContext(),
+        (WCHAR*)scriptContents.fullPath,
+        JsParseScriptAttributes::JsParseScriptAttributeNone,
+        nullptr,//_In_ JsValueRef parserState,
+        &bgResult
+    );
+    Assert(e == JsErrorCode::JsNoError);
+
+    return S_OK;
+}
+
 HRESULT ExecuteTest(const char* fileName)
 {
     HRESULT hr = S_OK;
@@ -914,7 +957,7 @@ HRESULT ExecuteTest(const char* fileName)
         }
         else if (HostConfigFlags::flags.ExecuteWithBgParse)
         {
-            // Run multiple scripts with BGParse
+            RunBgParseSync(fileContents, lengthBytes, fileName);
         }
         else
         {

lib/Jsrt/ChakraCommon.h

@@ -2441,7 +2441,13 @@ typedef unsigned short uint16_t;
         JsDiscardBackgroundParse(DWORD dwBgParseCookie, void* buffer, bool* callerOwnsBuffer);
 
     CHAKRA_API
-        JsExecuteBackgroundParse(DWORD dwBgParseCookie, JsContextRef context, DWORD_PTR dwSourceContext, DWORD dwFlags, VARIANT* pvarResult, EXCEPINFO* pexcepinfo);
+        JsExecuteBackgroundParse(_In_ DWORD dwBgParseCookie,
+            _In_ JsValueRef script,
+            _In_ JsSourceContext sourceContext,
+            _In_ WCHAR *url,
+            _In_ JsParseScriptAttributes parseAttributes,
+            _In_ JsValueRef parserState,
+            _Out_ JsValueRef *result);
 
 
 #ifdef _WIN32