Improve internal library serialized byte code versioning

- Use different byte code versioning scheme value for chakracore from chakra in release build as well.
- Separate release flags between chakra/chakracore so that they can go into release mode independently.
- Make library byte code always use the release versioning scheme.
- Update the no jit version of the Intl byte code.
- Change the top level output directory for the no jit version to have the ".NoJIT" suffix so it can be
built independently of the with jit verison.

Author: curtisman

Build/Common.Build.Default.props

@@ -56,6 +56,7 @@
   <PropertyGroup>
     <OutBaseDir Condition="'$(OutBaseDir)'!=''">$(OutBaseDir)\$(SolutionName)</OutBaseDir>
     <OutBaseDir Condition="'$(OutBaseDir)'==''">$(SolutionDir)VcBuild</OutBaseDir>
+    <OutBaseDir Condition="'$(BuildJIT)'=='false'">$(OutBaseDir).NoJIT</OutBaseDir>
     <IntBaseDir Condition="'$(IntBaseDir)'==''">$(OutBaseDir)</IntBaseDir>
   </PropertyGroup>
 

bin/ChakraCore/ChakraCore.vcxproj

@@ -69,7 +69,7 @@
     <ClCompile Include="$(MsBuildThisFileDirectory)ConfigParserExternals.cpp" />
     <ClCompile Include="$(MsBuildThisFileDirectory)ChakraCoreDLLFunc.cpp" />
     <ClCompile Include="TestHooks.cpp" />
-    <None Include="CoreCommon.ver" />
+    <None Include="..\CoreCommon.ver" />
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="$(MsBuildThisFileDirectory)ChakraCore.rc">

bin/CoreCommon.ver

@@ -19,13 +19,13 @@
 #define VER_DEBUG                   0
 #endif
 
-#if CHAKRA_VERSION_BUILD_RELEASE
+#if CHAKRA_CORE_VERSION_RELEASE
 #define VER_PRIVATE                 0
 #else
 #define VER_PRIVATE                 VS_FF_PRIVATEBUILD
 #endif
 
-#if CHAKRA_VERSION_BUILD_RELEASE && CHAKRA_VERSION_BUILD_PRERELEASE
+#if CHAKRA_CORE_VERSION_RELEASE && CHAKRA_CORE_VERSION_PRERELEASE
 #define VER_PRERELEASE              VS_FF_PRERELEASE
 #else
 #define VER_PRERELEASE              0
@@ -38,22 +38,22 @@
 #define VER_FILEDESCRIPTION_SUFFIX1_STR L"Test"
 #endif
 
-#if !CHAKRA_VERSION_BUILD_RELEASE
+#if !CHAKRA_CORE_VERSION_RELEASE
 #define VER_FILEDESCRIPTION_SUFFIX2_STR L"Private"
-#elif CHAKRA_VERSION_BUILD_PRERELEASE
+#elif CHAKRA_CORE_VERSION_PRERELEASE
 #define VER_FILEDESCRIPTION_SUFFIX2_STR L"Pre-release"
 #endif
 
-#if CHAKRA_VERSION_BUILD_RELEASE
+#if CHAKRA_CORE_VERSION_RELEASE
 #define VER_PRODUCTBUILD            0
 #elif CHAKRA_VERSION_BUILD_NUMBER
 #define VER_PRODUCTBUILD            CHAKRA_VERSION_BUILD_NUMBER
 #else
 #define VER_PRODUCTBUILD            65535
 #endif
 
-#if CHAKRA_VERSION_BUILD_RELEASE
-#define VER_PRODUCTBUILD_QFE        CHAKRA_VERSION_BUILD_RELEASE_QFE
+#if CHAKRA_CORE_VERSION_RELEASE
+#define VER_PRODUCTBUILD_QFE        CHAKRA_CORE_VERSION_RELEASE_QFE
 #elif CHAKRA_VERSION_BUILD_QFE
 #define VER_PRODUCTBUILD_QFE        CHAKRA_VERSION_BUILD_QFE
 #else

lib/Runtime/ByteCode/ByteCodeSerializer.cpp

@@ -86,25 +86,31 @@ namespace Js
 // --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 // Byte Code Serializer Versioning scheme
 // Version number is a GUID (128 bits). There are two versioning modes--Engineering and Release. Engineering mode is for day-to-day development. Every time chakra.dll is built a
-// fresh new version is generated by hashing the build date and time. This means that a byte code file saved to disk is exactly tied to the chakra.dll that generated it. This works
+// fresh new version is generated by hashing the build date and time. This means that a byte code file saved to disk is exactly tied to the binary that generated it. This works
 // well for QA test runs and buddy tests because there is no chance of effects between runs.
 //
 // Release mode is used when chakra.dll is close to public release where there are actual changes to chakra. The GUID is a fixed number from build-to-build. This number will stay
-// the same for releases where there is no change to jscript9. The reason for this is that we don't want to invalidate compatible byte code that has already been cached.
+// the same for releases where there is no change to chakra.dll. The reason for this is that we don't want to invalidate compatible byte code that has already been cached.
 enum FileVersionScheme : byte
 {
-    // Even Chakra and ChakraCore may have the same version, their byte code may not be compatible. Give them different value.
+    // Currently Chakra and ChakraCore versioning scheme is different.
+    // Same version number for Chakra and ChakraCore doesn't mean they are the same.
+    // Give the versioning scheme different value, so that byte code generate from one won't be use in the other.
 #ifdef NTBUILD
     EngineeringVersioningScheme = 10,
+    ReleaseVersioningScheme = 20,
 #else
     EngineeringVersioningScheme = 11,
+    ReleaseVersioningScheme = 21,
+#endif
+
+#if (defined(NTBUILD) && CHAKRA_VERSION_RELEASE) || (!defined(NTBUILD) && CHAKRA_CORE_VERSION_RELEASE)
+    CurrentFileVersionScheme = ReleaseVersioningScheme
+#else
+    CurrentFileVersionScheme = EngineeringVersioningScheme
 #endif
-    LibraryEngineeringVersioningScheme = 12,
-    ReleaseVersioningScheme = 20
 };
 
-const FileVersionScheme currentFileVersionScheme = EngineeringVersioningScheme;
-const FileVersionScheme currentFileVersionSchemeLibrary = LibraryEngineeringVersioningScheme;
 
 // it should be in separate file for testing
 #include "byteCodeCacheReleaseFileVersion.h"
@@ -411,7 +417,8 @@ class ByteCodeBufferBuilder
             expectedOpCodeCount.value = 0;
         }
 
-        byte actualFileVersionScheme = GenerateLibraryByteCode()? currentFileVersionSchemeLibrary : currentFileVersionScheme;
+        // library alaways use the release versioning scheme
+        byte actualFileVersionScheme = GenerateLibraryByteCode()? ReleaseVersioningScheme : CurrentFileVersionScheme;
 #if ENABLE_DEBUG_CONFIG_OPTIONS
         if (Js::Configuration::Global.flags.ForceSerializedBytecodeVersionSchema)
         {
@@ -421,22 +428,14 @@ class ByteCodeBufferBuilder
         fileVersionKind.value = actualFileVersionScheme;
         if (actualFileVersionScheme != ReleaseVersioningScheme)
         {
-            if (GenerateLibraryByteCode())
-            {
-                Assert(actualFileVersionScheme == LibraryEngineeringVersioningScheme);
-                // Library code always follows the ChakraCore version
-                V1.value = CHAKRA_CORE_MAJOR_VERSION << 16 | CHAKRA_CORE_MINOR_VERSION;
-            }
-            else
-            {
-                Assert(actualFileVersionScheme == EngineeringVersioningScheme);
-                DWORD jscriptMajor, jscriptMinor, buildDateHash, buildTimeHash;
-                Js::VerifyOkCatastrophic(AutoSystemInfo::GetJscriptFileVersion(&jscriptMajor, &jscriptMinor, &buildDateHash, &buildTimeHash));
-                V1.value = jscriptMajor;
-                V2.value = jscriptMinor;
-                V3.value = buildDateHash;
-                V4.value = buildTimeHash;
-            }
+            Assert(!GenerateLibraryByteCode());
+            Assert(actualFileVersionScheme == EngineeringVersioningScheme);
+            DWORD jscriptMajor, jscriptMinor, buildDateHash, buildTimeHash;
+            Js::VerifyOkCatastrophic(AutoSystemInfo::GetJscriptFileVersion(&jscriptMajor, &jscriptMinor, &buildDateHash, &buildTimeHash));
+            V1.value = jscriptMajor;
+            V2.value = jscriptMinor;
+            V3.value = buildDateHash;
+            V4.value = buildTimeHash;
         }
         else
         {
@@ -2595,15 +2594,15 @@ class ByteCodeBufferReader
     HRESULT ReadHeader()
     {
         auto current = ReadConstantSizedInt32NoSize(raw, &magic);
-        if (magic!=magicConstant)
+        if (magic != magicConstant)
         {
             AssertMsg(false, "Unrecognized magic constant in byte code file header. Is this really a bytecode file?");
             return E_FAIL;
         }
         current = ReadConstantSizedInt32NoSize(current, &totalSize);
         current = ReadByte(current, &fileVersionScheme);
 
-        byte expectedFileVersionScheme = isLibraryCode? currentFileVersionSchemeLibrary : currentFileVersionScheme;
+        byte expectedFileVersionScheme = isLibraryCode? ReleaseVersioningScheme : CurrentFileVersionScheme;
 #if ENABLE_DEBUG_CONFIG_OPTIONS
         if (Js::Configuration::Global.flags.ForceSerializedBytecodeVersionSchema)
         {
@@ -2623,17 +2622,9 @@ class ByteCodeBufferReader
 
         if (expectedFileVersionScheme != ReleaseVersioningScheme)
         {
-            if (isLibraryCode)
-            {
-                Js::VerifyCatastrophic(expectedFileVersionScheme == LibraryEngineeringVersioningScheme);
-                // Library code always use the ChakraCore version
-                expectedV1 = CHAKRA_CORE_MAJOR_VERSION << 16 | CHAKRA_CORE_MINOR_VERSION;
-            }
-            else
-            {
-                Js::VerifyCatastrophic(expectedFileVersionScheme == EngineeringVersioningScheme);
-                Js::VerifyOkCatastrophic(AutoSystemInfo::GetJscriptFileVersion(&expectedV1, &expectedV2, &expectedV3, &expectedV4));
-            }
+            Js::VerifyCatastrophic(!isLibraryCode);
+            Js::VerifyCatastrophic(expectedFileVersionScheme == EngineeringVersioningScheme);
+            Js::VerifyOkCatastrophic(AutoSystemInfo::GetJscriptFileVersion(&expectedV1, &expectedV2, &expectedV3, &expectedV4));
         }
         else
         {
@@ -2682,7 +2673,7 @@ class ByteCodeBufferReader
         current = ReadByte(current, &architecture);
         if (architecture!=magicArchitecture)
         {
-            // This byte cache file was created with against a jscript running under a different architecture. It is incompatible.
+            // This byte cache file was created with against a chakra running under a different architecture. It is incompatible.
             return ByteCodeSerializer::InvalidByteCode;
         }
 
@@ -2696,13 +2687,13 @@ class ByteCodeBufferReader
         current = ReadInt32(current, &buildInPropertyCount);
         if (buildInPropertyCount!=expectedBuildInPropertyCount)
         {
-            // This byte cache file was created with against a jscript that has a different number of built in properties. It is incompatible.
+            // This byte cache file was created with against a chakra that has a different number of built in properties. It is incompatible.
             return ByteCodeSerializer::InvalidByteCode;
         }
         current = ReadInt32(current, &opCodeCount);
         if (opCodeCount != expectedOpCodeCount)
         {
-            // This byte cache file was created with against a jscript that has a different number of built in properties. It is incompatible.
+            // This byte cache file was created with against a chakra that has a different number of built in properties. It is incompatible.
             return ByteCodeSerializer::InvalidByteCode;
         }
         current = ReadInt32(current, &sourceSize);

lib/Runtime/ByteCode/byteCodeCacheReleaseFileVersion.h

@@ -4,17 +4,6 @@
 //-------------------------------------------------------------------------------------------------------
 // NOTE: If there is a merge conflict the correct fix is to make a new GUID.
 
-const GUID byteCodeCacheReleaseFileVersion = { /* 52B8F09F-7CFC-43E4-9D50-FC7D3503305B */
-    0x52b8f09f,
-    0x7cfc,
-    0x43e4,
-    { 0x9d, 0x50, 0xfc, 0x7d, 0x35, 0x3, 0x30, 0x5b }
-  };
-
-// Touching file in order to pass unit-tests (they expect this file to be edited for all inetcore/jscript/... changes
-// Enabling version unittest for Servicing branch
-// Editing file without updating GUID, bytecode is not changed by this changeset
-// Editing file without updating GUID, bytecode is not changed by this changeset
-// Editing file without updating GUID, bytecode is not changed by this changeset
-// Editing file without updating GUID, bytecode is not changed by this changeset
-// Editing file without updating GUID, bytecode is not changed by this changeset
+// {A1B09088-45E7-42DB-8D65-FB739F559946}
+const GUID byteCodeCacheReleaseFileVersion =
+{ 0xa1b09088, 0x45e7, 0x42db,{ 0x8d, 0x65, 0xfb, 0x73, 0x9f, 0x55, 0x99, 0x46 } };

lib/Runtime/Library/InJavascript/GenByteCode.cmd

@@ -8,9 +8,9 @@ if "%1"=="-nojit" (
 )
 
 :: This script will expect ch.exe to be built for x86_debug and x64_debug
-set _BinLocation=%~dp0..\..\..\..\Build\VcBuild\bin
+set _BinLocation=%~dp0..\..\..\..\Build\VcBuild%_suffix%\bin
 if "%OutBaseDir%" NEQ "" (
-  set _BinLocation=%OutBaseDir%\Chakra.Core\bin
+  set _BinLocation=%OutBaseDir%\Chakra.Core%_suffix%\bin
 )
 
 if not exist %_BinLocation%\x86_debug\ch.exe (