Merge pull request #2 from StrangeLoopGames/simon/nanoseconds

redwyre · web-flow · commit 21a4fd01d35f · 2022-03-04T02:26:02.000+10:00
Nanoseconds
diff --git a/NativeTime.Plugin/CMakeLists.txt b/NativeTime.Plugin/CMakeLists.txt
@@ -27,7 +27,6 @@ endif()
 if (APPLE)
     set(CMAKE_C_FLAGS "-x objective-c")
     add_compile_options("-dynamiclib")
-    target_sources(NativeTimeNative PRIVATE Metal.mm)
 elseif(UNIX)
     add_compile_definitions(UNITY_LINUX=1)
 endif()
diff --git a/NativeTime.Plugin/Linux.cpp b/NativeTime.Plugin/Linux.cpp
@@ -0,0 +1,27 @@
+#include "pch.h"
+
+#ifdef UNITY_LINUX
+
+#include "NativeTime.h"
+#include "IUnityInterface.h"
+
+const int NsToTicks = 100;
+const int SecToTicks = 10000000;
+const int SecondsToNanoSeconds = 1000000000;
+
+struct timespec resolution;
+
+extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API Init()
+{
+	clock_getres(CLOCK_MONOTONIC_RAW, &resolution);
+}
+
+extern "C" uint64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestampNs()
+{
+	struct timespec time;
+	clock_gettime(CLOCK_MONOTONIC_RAW, &time);
+	return (static_cast<uint64_t>(time.tv_sec) * SecondsToNanoSeconds) + static_cast<uint64_t>(time.tv_nsec);
+}
+
+
+#endif
diff --git a/NativeTime.Plugin/Metal.mm b/NativeTime.Plugin/Metal.mm
diff --git a/NativeTime.Plugin/NativeTime.Plugin.vcxproj b/NativeTime.Plugin/NativeTime.Plugin.vcxproj
@@ -192,6 +192,7 @@
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="framework.h" />
+    <ClInclude Include="Linux.cpp" />
     <ClInclude Include="pch.h" />
     <ClInclude Include="PlatformBase.h" />
     <ClInclude Include="PluginAPI\IUnityEventQueue.h" />
diff --git a/NativeTime.Plugin/NativeTime.Plugin.vcxproj.filters b/NativeTime.Plugin/NativeTime.Plugin.vcxproj.filters
@@ -41,6 +41,7 @@
       <Filter>PluginAPI</Filter>
     </ClInclude>
     <ClInclude Include="PlatformBase.h" />
+    <ClInclude Include="Linux.cpp" />
   </ItemGroup>
   <ItemGroup>
     <None Include="cpp.hint" />
diff --git a/NativeTime.Plugin/NativeTime.h b/NativeTime.Plugin/NativeTime.h
@@ -14,4 +14,8 @@
 #define NATIVETIME_API __declspec(dllimport)
 #endif
 
-extern "C" int64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestamp();
+const int SecondsToMicroSeconds = 1000000;
+const int SecondsToNanoSeconds = 1000000000;
+
+extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API Init();
+extern "C" uint64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestampNs();
diff --git a/NativeTime.Plugin/Osx.cpp b/NativeTime.Plugin/Osx.cpp
@@ -6,9 +6,13 @@
 #include "IUnityInterface.h"
 
 
-extern "C" int64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestamp()
+extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API Init()
 {
-	return 0;
+}
+
+extern "C" uint64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestampNs()
+{
+	return clock_gettime_nsec_np(CLOCK_UPTIME_RAW);
 }
 
 
diff --git a/NativeTime.Plugin/Windows.cpp b/NativeTime.Plugin/Windows.cpp
@@ -5,23 +5,22 @@
 #include "NativeTime.h"
 #include "IUnityInterface.h"
 
-#include <windows.h>
-#include <profileapi.h>
+static uint64_t s_frequency = 0;
 
-static LARGE_INTEGER s_frequency = LARGE_INTEGER();
-
-extern "C" int64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestamp()
+extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API Init()
 {
-	if (s_frequency.QuadPart == 0)
-	{
-		QueryPerformanceFrequency(&s_frequency);
-	}
+	LARGE_INTEGER frequency;
+	QueryPerformanceFrequency(&frequency);
+	s_frequency = frequency.QuadPart;
+}
 
+extern "C" uint64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestampNs()
+{
 	LARGE_INTEGER time;
 	QueryPerformanceCounter(&time);
-	time.QuadPart *= 10000000;
-	time.QuadPart /= s_frequency.QuadPart;
-	return time.QuadPart;
+	uint64_t elapsed = time.QuadPart;
+	
+	return elapsed * SecondsToNanoSeconds / s_frequency;
 }
 
 #endif
diff --git a/NativeTime.Plugin/pch.h b/NativeTime.Plugin/pch.h
@@ -7,8 +7,21 @@
 #ifndef PCH_H
 #define PCH_H
 
-// add headers that you want to pre-compile here
-#include "framework.h"
 #include "PlatformBase.h"
 
+#ifdef UNITY_WIN
+#include <windows.h>
+#include <profileapi.h>
+
+#elif UNITY_OSX
+#include <time.h>
+
+#elif UNITY_LINUX
+#define _POSIX_C_SOURCE 199309L
+#include <time.h>
+
+#else
+#error "Unsupported platform"
+#endif
+
 #endif //PCH_H
diff --git a/NativeTime.sln b/NativeTime.sln
@@ -12,7 +12,11 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "NativeTime", "NativeTime", "{A7E3F065-2DE0-4BE2-B580-7D447C05BCDB}"
 	ProjectSection(SolutionItems) = preProject
 		.gitignore = .gitignore
+		appveyor.yml = appveyor.yml
+		CMakeLists.txt = CMakeLists.txt
+		LICENSE = LICENSE
 		package.json = package.json
+		README.md = README.md
 	EndProjectSection
 EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "NativeTime.Plugin", "NativeTime.Plugin\NativeTime.Plugin.vcxproj", "{A20656BB-F143-45E8-A067-58E7A1EE36E1}"
diff --git a/README.md b/README.md
@@ -1,2 +1,36 @@
 # NativeTime
 Native time Unity package for burst compatibility
+
+## Why is this needed?
+Due to limitations in Burst, you cannot use `Stopwatch` or any of its function to calculate elapsed time. You also 
+cannot use Unity's `Time.realtimeSinceStartup`.
+
+Burst does however let you call native functions so this package includes a native plugin that returns the number of 
+nanoseconds since startup, which is converted to ticks (100ns) and passed to `TimeSpan`.
+
+## How to use
+
+Create a new `ValueStopwatch` using `ValueStopwatch.StartNew()`
+```cs
+
+var sw = ValueStopwatch.StartNew();
+DoThing();
+var elapsed = sw.ElapsedTicks;
+
+```
+
+To reset, just reassign from `ValueStopwatch.StartNew()`
+
+```cs
+
+var sw = ValueStopwatch.StartNew();
+DoThing1();
+var elapsed1 = sw.ElapsedTicks;
+
+sw = ValueStopwatch.StartNew();
+DoThing2();
+var elapsed2 = sw.ElapsedTicks;
+
+```
+
+You can also get the raw time in nanoseconds using `ValueStopwatch.GetTimestamp()` 
diff --git a/Runtime/NativeTime.cs b/Runtime/NativeTime.cs
@@ -1,33 +1,38 @@
 using System;
 using System.Runtime.InteropServices;
+using Unity.Collections;
 
 namespace StrangeLoopGames.NativeTime
 {
     internal class NativeTimeInternal
     {
 #if UNITY_STANDALONE_WIN || UNITY_EDITOR_WIN || UNITY_STANDALONE_OSX || UNITY_EDITOR_OSX || UNITY_STANDALONE_LINUX || UNITY_EDITOR_LINUX
         [DllImport("NativeTimeNative")]
-        public static extern long GetTimestamp();
+        public static extern ulong GetTimestampNs();
 #else
         /// <summary> Fallback for unsupported platform </summary>
         [BurstCompatible]
-        public static long GetTimestamp() { return 0; }
+        public static ulong GetTimestampNs() { return 0; }
 #endif
     }
 
     /// <summary>A burst compatible Stopwatch. Similar to <see cref="Stopwatch"/>.</summary>
     [BurstCompatible]
     public struct ValueStopwatch
     {
-        long start;
+        static const int TicksToNanoseconds = 100;
+        ulong start;
 
-        /// <summary> Returns the number of ticks since system startup. </summary>
-        public static long GetTimestamp() => NativeTimeInternal.GetTimestamp();
+        /// <summary> Returns the number of nanoseconds since system startup. </summary>
+        public static ulong GetTimestamp() => NativeTimeInternal.GetTimestampNs();
 
-        public TimeSpan ElapsedTicks()
+        public TimeSpan ElapsedTicks
         {
-            long elapsed = GetTimestamp() - this.start;
-            return new TimeSpan(elapsed);
+            get
+            {
+                ulong elapsed = GetTimestamp() - this.start;
+                return new TimeSpan(elapsed / TicksToNanoseconds);
+            }
         }
 
         public static ValueStopwatch StartNew()
diff --git a/Runtime/Plugins/x86/NativeTimeNative.dll b/Runtime/Plugins/x86/NativeTimeNative.dll
diff --git a/Runtime/Plugins/x86_64/NativeTimeNative.dll b/Runtime/Plugins/x86_64/NativeTimeNative.dll

Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,13 @@`
`6`	`6`	`#include "IUnityInterface.h"`
`7`	`7`
`8`	`8`
`9`		`-extern "C" int64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestamp()`
	`9`	`+extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API Init()`
`10`	`10`	`{`
`11`		`- return 0;`
	`11`	`+}`
	`12`	`+`
	`13`	`+extern "C" uint64_t UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API GetTimestampNs()`
	`14`	`+{`
	`15`	`+ return clock_gettime_nsec_np(CLOCK_UPTIME_RAW);`
`12`	`16`	`}`
`13`	`17`
`14`	`18`