Add more logging and probe for Lua support (#1136)

* log .NET version, OS, and processor architecture at startup

* don't include environment details in art; probe Lua support at app start if enabled

* log if exception raised while trying to load a script; since error parameter was alwasy ignored, remove it

* formatting

---------

Co-authored-by: Tal Zaccai <[email protected]>

Author: kevin-montrose

benchmark/BDN.benchmark/Lua/LuaScriptCacheOperations.cs

@@ -81,9 +81,9 @@ public void IterationSetup()
             sessionScriptCache.Clear();
 
             // Make outer hit available for every iteration
-            if (!sessionScriptCache.TryLoad(session, "return 1"u8, new(outerHitDigest), out _, out _, out _, out var error))
+            if (!sessionScriptCache.TryLoad(session, "return 1"u8, new(outerHitDigest), out _, out _, out _))
             {
-                throw new InvalidOperationException($"Should have been able to load: {error}");
+                throw new InvalidOperationException("Should have been able to load");
             }
         }
 
@@ -146,7 +146,7 @@ private void LoadScript(Span<byte> digest)
             {
                 if (storeWrapper.storeScriptCache.TryGetValue(digestKey, out var source))
                 {
-                    if (!sessionScriptCache.TryLoad(session, source, digestKey, out runner, out _, out _, out var error))
+                    if (!sessionScriptCache.TryLoad(session, source, digestKey, out runner, out _, out _))
                     {
                         // TryLoad will have written an error out, it any
 

libs/host/GarnetServer.cs

@@ -7,6 +7,7 @@
 using System.Linq;
 using System.Net.Sockets;
 using System.Reflection;
+using System.Runtime.InteropServices;
 using System.Text;
 using System.Threading;
 using Garnet.cluster;
@@ -185,6 +186,7 @@ private void InitializeServer()
 
             this.logger = this.loggerFactory?.CreateLogger("GarnetServer");
             logger?.LogInformation("Garnet {version} {bits} bit; {clusterMode} mode; Endpoint: {endpoint}", version, IntPtr.Size == 8 ? "64" : "32", opts.EnableCluster ? "cluster" : "standalone", opts.EndPoint);
+            logger?.LogInformation("Environment .NET {netVersion}; {osPlatform}; {processArch}", Environment.Version, Environment.OSVersion.Platform, RuntimeInformation.ProcessArchitecture);
 
             // Flush initialization logs from memory logger
             FlushMemoryLogger(this.initLogger, "ArgParser", this.loggerFactory);

libs/server/Lua/LuaCommands.cs

@@ -48,7 +48,7 @@ private unsafe bool TryEVALSHA()
                 {
                     if (storeWrapper.storeScriptCache.TryGetValue(scriptKey, out var source))
                     {
-                        if (!sessionScriptCache.TryLoad(this, source, scriptKey, out runner, out _, out _, out _))
+                        if (!sessionScriptCache.TryLoad(this, source, scriptKey, out runner, out _, out _))
                         {
                             // TryLoad will have written an error out, it any
 
@@ -121,7 +121,7 @@ private unsafe bool TryEVAL()
             sessionScriptCache.GetScriptDigest(script.ReadOnlySpan, digest);
 
             var scriptKey = new ScriptHashKey(digest);
-            if (!sessionScriptCache.TryLoad(this, script.ReadOnlySpan, scriptKey, out var runner, out _, out _, out var error))
+            if (!sessionScriptCache.TryLoad(this, script.ReadOnlySpan, scriptKey, out var runner, out _, out _))
             {
                 // TryLoad will have written any errors out
                 return true;
@@ -251,7 +251,7 @@ private bool NetworkScriptLoad()
             Span<byte> digest = stackalloc byte[SessionScriptCache.SHA1Len];
             sessionScriptCache.GetScriptDigest(source.Span, digest);
 
-            if (sessionScriptCache.TryLoad(this, source.ReadOnlySpan, new(digest), out _, out var digestOnHeap, out var compiledSource, out var error))
+            if (sessionScriptCache.TryLoad(this, source.ReadOnlySpan, new(digest), out _, out var digestOnHeap, out var compiledSource))
             {
                 // TryLoad will write any errors out
 

libs/server/Lua/LuaRunner.cs

@@ -2592,6 +2592,26 @@ static unsafe bool TryWriteTableToArray(LuaRunner runner, bool canSend, ref TRes
             }
         }
 
+        /// <summary>
+        /// Attempts a call into Lua libraries.
+        /// 
+        /// If this fails, it's basically impossible for any other Lua functionality to work.
+        /// </summary>
+        public static bool TryProbeSupport(out string errorMessage)
+        {
+            try
+            {
+                _ = NativeMethods.Version();
+                errorMessage = null;
+                return true;
+            }
+            catch (Exception e)
+            {
+                errorMessage = e.Message;
+                return false;
+            }
+        }
+
         /// <summary>
         /// Construct a bitmap we can quickly check for NoScript commands in.
         /// </summary>

libs/server/Lua/NativeMethods.cs

@@ -317,6 +317,16 @@ internal static partial class NativeMethods
         [UnmanagedCallConv(CallConvs = [typeof(CallConvCdecl), typeof(CallConvSuppressGCTransition)])]
         private static partial void lua_pushvalue(lua_State luaState, int stackIndex);
 
+        /// <summary>
+        /// see: https://www.lua.org/manual/5.4/manual.html#lua_version
+        /// 
+        /// Just returns a constant.
+        /// see: https://www.lua.org/source/5.4/lapi.c.html#lua_version
+        /// </summary>
+        [LibraryImport(LuaLibraryName)]
+        [UnmanagedCallConv(CallConvs = [typeof(CallConvCdecl), typeof(CallConvSuppressGCTransition)])]
+        private static partial double lua_version(lua_State ignored);
+
         // Helper methods for using the pinvokes defined above
 
         /// <summary>
@@ -653,6 +663,12 @@ internal static void Rotate(lua_State luaState, int stackIndex, int n)
         internal static unsafe void SetHook(lua_State luaState, delegate* unmanaged[Cdecl]<nint, nint, void> hook, LuaHookMask mask, int count)
         => lua_sethook(luaState, (nint)hook, (int)mask, count);
 
+        /// <summary>
+        /// Get the Lua version.
+        /// </summary>
+        internal static double Version()
+        => lua_version(default);
+
         /// <summary>
         /// Invoke the Lua GC.
         /// </summary>

libs/server/Lua/SessionScriptCache.cs

@@ -132,12 +132,9 @@ internal bool TryLoad(
             ScriptHashKey digest,
             out LuaRunner runner,
             out ScriptHashKey? digestOnHeap,
-            out byte[] compiledSource,
-            out string error
+            out byte[] compiledSource
         )
         {
-            error = null;
-
             if (scriptCache.TryGetValue(digest, out runner))
             {
                 digestOnHeap = null;
@@ -185,7 +182,8 @@ out string error
             }
             catch (Exception ex)
             {
-                error = ex.Message;
+                logger?.LogError(ex, "During Lua script loading, an unexpected exception");
+
                 digestOnHeap = null;
                 compiledSource = null;
                 return false;

libs/server/StoreWrapper.cs

@@ -175,6 +175,11 @@ public StoreWrapper(
             {
                 this.storeScriptCache = [];
 
+                if (!LuaRunner.TryProbeSupport(out var errorMessage))
+                {
+                    logger?.LogCritical("Lua probe failed, Lua scripts will fail {errorMessage}", errorMessage);
+                }
+
                 if (serverOptions.LuaOptions.Timeout != Timeout.InfiniteTimeSpan)
                 {
                     this.luaTimeoutManager = new(serverOptions.LuaOptions.Timeout, loggerFactory?.CreateLogger<LuaTimeoutManager>());