Improve ap startup on linux (o3de#17526)

* Improves the startup time of AP on linux.

Note that this could also potentially improve it on mac and windows,
as well as metafile processing in general.

Most of this change is just moving the initialization of the catalog
until the file cache is warmed up and then using the file cache to
fix path cases on case sensitive file systems.

The rest of it is fixing the unit tests to account for this -
the mock for the file system wasn't sufficient to actually use this
new code as it would do things like always answer false for
"is directory".

With this change, all unit tests pass in debug on linux, with no
unexpected assertions and no failures.  In addition, AP starts
and idles very quickly without any long freezes during startup.

Signed-off-by: Nicholas Lawson <[email protected]>

* Fixes a warning I'm not sure I created

During Createjobs,  Asset Processor Manager does this:
```cpp
Q_EMIT CreateJobsDurationChanged(sourceAsset.RelativePath().c_str(), sourceAsset.ScanFolderId());
```

However, scan folder ID of type AZ::s64 which hasn't been registered to Qt
serializer's meta object system, so it does not know how to convert it to
a byte array to emit messages across threads.  This causes warnings
and probably causes that message not to be emitted.

* Fixes for windows

Most of the problems were in oversights in existing tests.
For example the asset catalog tests use a virtual file system
but were using CreateDummyFile which makes real files.

Likewise, the asset catalog was using SystemFile instead of FileIO
which was the mock file IO.  So it would be making mock files in memory
but then checking real files on disk, etc.

Note that the Pass-thru file cache is only used in unit tests, or when
specifically asked for by a command line parameter, which is not used
in any of the test scripts.

Signed-off-by: Nicholas Lawson <[email protected]>

Author: nick-l-o3de

Code/Framework/AzCore/AzCore/IO/FileIO.h

@@ -33,6 +33,10 @@ namespace AZ
         /// like "*.bat" or "blah??.pak" or "test*.exe" and such.
         bool NameMatchesFilter(AZStd::string_view name, AZStd::string_view filter);
 
+        //! Converts the operating-specific values returned by AZ::IO::FileIO API
+        //! to independent units representing the milliseconds since 1/1/1970 0:00 UTC
+        AZ::u64 FileTimeToMSecsSincePosixEpoch(AZ::u64 fileTime);
+
         using HandleType = AZ::u32;
         static const HandleType InvalidHandle = 0;
 

Code/Framework/AzCore/Platform/Android/platform_android_files.cmake

@@ -35,6 +35,7 @@ set(FILES
     ../Common/Default/AzCore/IO/Streamer/StreamerContext_Default.cpp
     ../Common/Default/AzCore/IO/Streamer/StreamerContext_Default.h
     ../Common/UnixLike/AzCore/IO/AnsiTerminalUtils_UnixLike.cpp
+    ../Common/UnixLike/AzCore/IO/FileIO_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/SystemFile_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/Internal/SystemFileUtils_UnixLike.h
     ../Common/UnixLike/AzCore/IO/Internal/SystemFileUtils_UnixLike.cpp

Code/Framework/AzCore/Platform/Common/UnixLike/AzCore/IO/FileIO_UnixLike.cpp

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) Contributors to the Open 3D Engine Project.
+ * For complete copyright and license terms please see the LICENSE at the root of this distribution.
+ *
+ * SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ */
+
+#include <AzCore/IO/FileIO.h>
+
+namespace AZ::IO
+{
+    // On posix compatible systems, file times are in time_t, that is, 
+    // number of seconds since posix epoch.  Converting this just means converting from
+    // seconds to milliseconds
+    AZ::u64 FileTimeToMSecsSincePosixEpoch(AZ::u64 fileTime)
+    { 
+        return fileTime * 1000;
+    }
+}

Code/Framework/AzCore/Platform/Common/WinAPI/AzCore/IO/FileIO_WinAPI.cpp

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) Contributors to the Open 3D Engine Project.
+ * For complete copyright and license terms please see the LICENSE at the root of this distribution.
+ *
+ * SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ */
+
+#include <AzCore/IO/FileIO.h>
+
+namespace AZ::IO
+{
+    // There are no leap seconds from the start of the win32 file epoch
+    // which begins Jan 1 1601, until the posix epoch begins.  So to convert
+    // it can just be offset.
+    // see Code\Legacy\CrySystem\LocalizedStringManager.cpp for example of where these constants
+    // came from.
+    // it represents the number of 100-nanosecond intervals between the two epocs.
+    // since win32 file time is in 100-nanosecond intervals.
+    AZ::u64 FileTimeToMSecsSincePosixEpoch(AZ::u64 fileTime)
+    { 
+        static constexpr const AZ::u64 differenceBetweenEpochs = 116444736000000000;
+        if (fileTime <= differenceBetweenEpochs)
+        {
+            return 0; // before the epoch
+        }
+        
+        fileTime = fileTime - differenceBetweenEpochs; 
+        // convert second      to millisecond = * 1,000
+        // convert millisecond to millisecond = * 1
+        // convert microsecond to millisecond = / 1,000
+        // convert nanosecond  to millisecond = / 1,000,000 , therefore
+        // convert 100 nanosec to millisecond = /    10,000   (1,000,000 / 100)
+        fileTime = fileTime / 10000; // convert from 100-nanosecond interval to seconds
+        return fileTime;
+    }
+}

Code/Framework/AzCore/Platform/Linux/platform_linux_files.cmake

@@ -36,6 +36,7 @@ set(FILES
     ../Common/Default/AzCore/IO/Streamer/StreamerContext_Default.cpp
     ../Common/Default/AzCore/IO/Streamer/StreamerContext_Default.h
     ../Common/UnixLike/AzCore/IO/AnsiTerminalUtils_UnixLike.cpp
+    ../Common/UnixLike/AzCore/IO/FileIO_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/SystemFile_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/SystemFile_UnixLike.h
     ../Common/UnixLike/AzCore/IO/Internal/SystemFileUtils_UnixLike.h

Code/Framework/AzCore/Platform/Mac/platform_mac_files.cmake

@@ -37,6 +37,7 @@ set(FILES
     ../Common/Default/AzCore/IO/Streamer/StreamerContext_Default.cpp
     ../Common/Default/AzCore/IO/Streamer/StreamerContext_Default.h
     ../Common/UnixLike/AzCore/IO/AnsiTerminalUtils_UnixLike.cpp
+    ../Common/UnixLike/AzCore/IO/FileIO_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/SystemFile_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/Internal/SystemFileUtils_UnixLike.h
     ../Common/UnixLike/AzCore/IO/Internal/SystemFileUtils_UnixLike.cpp

Code/Framework/AzCore/Platform/Windows/platform_windows_files.cmake

@@ -35,6 +35,7 @@ set(FILES
     AzCore/Debug/StackTracer_Windows.cpp
     ../Common/WinAPI/AzCore/Debug/Trace_WinAPI.cpp
     ../Common/WinAPI/AzCore/IO/AnsiTerminalUtils_WinAPI.cpp
+    ../Common/WinAPI/AzCore/IO/FileIO_WinAPI.cpp
     ../Common/WinAPI/AzCore/IO/Streamer/StreamerContext_WinAPI.cpp
     ../Common/WinAPI/AzCore/IO/Streamer/StreamerContext_WinAPI.h
     ../Common/WinAPI/AzCore/IO/SystemFile_WinAPI.cpp

Code/Framework/AzCore/Platform/iOS/platform_ios_files.cmake

@@ -37,6 +37,7 @@ set(FILES
     ../Common/Apple/AzCore/IO/SystemFile_Apple.cpp
     ../Common/Apple/AzCore/IO/SystemFile_Apple.h
     ../Common/UnixLike/AzCore/IO/AnsiTerminalUtils_UnixLike.cpp
+    ../Common/UnixLike/AzCore/IO/FileIO_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/SystemFile_UnixLike.cpp
     ../Common/UnixLike/AzCore/IO/Internal/SystemFileUtils_UnixLike.h
     ../Common/UnixLike/AzCore/IO/Internal/SystemFileUtils_UnixLike.cpp

Code/Framework/AzToolsFramework/AzToolsFramework/Asset/AssetUtils.cpp

@@ -241,8 +241,24 @@ namespace AzToolsFramework::AssetUtils
         return configFiles;
     }
 
-    bool UpdateFilePathToCorrectCase(AZStd::string_view rootPath, AZStd::string& relPathFromRoot)
+    bool UpdateFilePathToCorrectCase(AZStd::string_view rootPath, AZStd::string& relPathFromRoot, bool checkEntirePath /* = true */)
     {
+        // The reason this is so expensive is that it could also be the case that the DIRECTORY path is the wrong case.
+        // For example, the actual path might be /SomeFolder/textures/whatever/texture.dat
+        // but the real file on disk is actually /SomeFolder/Textures/Whatever/texture.dat 
+        // Note the case difference of the directories.  If you were to ask the operating system just to list all of
+        // the files in the input folder (/SomeFolder/textures/whatever/*) it would not find any since the directory 
+        // does not itself exist.  Not only that, but many operating system calls on case-insensitive file systems
+        // actually use the input given in their return - that is, if you ask a WINAPI call to construct an absolute path
+        // to a file and give it the wrong case as input, the output absolute path will also be the wrong case.
+        // Thus, to actually correct a path it has to start at the bottom and whenever it encounters
+        // a path segment, it has to do a read of the actual directory information to see which files exist in that
+        // directory, and whether a file or directory exists with the correct name but with different case.
+
+        // if checkEntirePath is false, we only check the file name, and nothing else.  This is for the case where
+        // the path is known to be good except for the file name, such as when the relPathFromRoot comes from just
+        // taking an existing, known-good file and replacing its extension only.
+
         AZ::StringFunc::Path::Normalize(relPathFromRoot);
         AZStd::vector<AZStd::string> tokens;
         AZ::StringFunc::Tokenize(relPathFromRoot.c_str(), tokens, AZ_CORRECT_FILESYSTEM_SEPARATOR_STRING);
@@ -261,6 +277,15 @@ namespace AzToolsFramework::AssetUtils
 
         for (int idx = 0; idx < tokens.size(); idx++)
         {
+            if (!checkEntirePath)
+            {
+                if (idx != tokens.size() - 1)
+                {
+                    // only the last token is potentially incorrect, we can skip filenames before that
+                    validatedPath /= tokens[idx]; // go one step deeper.
+                    continue;
+                }
+            }
             AZStd::string element = tokens[idx];
             bool foundAMatch = false;
             AZ::IO::FileIOBase::GetInstance()->FindFiles(validatedPath.c_str(), "*", [&](const char* file)

Code/Framework/AzToolsFramework/AzToolsFramework/Asset/AssetUtils.h

@@ -49,7 +49,11 @@ namespace AzToolsFramework::AssetUtils
     //! @param root a trusted already-case-correct path (will not be case corrected). If empty it will be set to appRoot.
     //! @param relativePathFromRoot a non-trusted (may be incorrect case) path relative to rootPath,
     //!        which will be normalized and updated to be correct casing.
+    //! @param checkEntirePath Optimization - set this to false if the caller is absolutely sure the path
+    //!                             is correct and only the last element (file name or extension) is potentially incorrect, this can happen
+    //!                             when for example taking a real file found from a real file directory that is already correct and
+    //!                             replacing the file extension or file name only.
     //! @return if such a file does NOT exist, it returns FALSE, else returns TRUE.
     //! @note A very expensive function!  Call sparingly.
-    bool UpdateFilePathToCorrectCase(AZStd::string_view root, AZStd::string& relativePathFromRoot);
+    bool UpdateFilePathToCorrectCase(AZStd::string_view root, AZStd::string& relativePathFromRoot, bool checkEntirePath = true);
 } //namespace AzToolsFramework::AssetUtils