Implement remaining Lua runtime libraries #1075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

kevin-montrose merged 37 commits into main from luaRuntimeLibraries

Mar 18, 2025

benchmark/BDN.benchmark/Lua/LuaParams.cs

-Original file line number
+Diff line change
@@ Expand Up @@
             /// Get the equivalent <see cref="LuaOptions"/>.
             /// </summary>
             public LuaOptions CreateOptions()
-            => new(Mode, MemoryLimit ? "2m" : "", Timeout ?? System.Threading.Timeout.InfiniteTimeSpan, LuaLoggingMode.Enable);
+            => new(Mode, MemoryLimit ? "2m" : "", Timeout ?? System.Threading.Timeout.InfiniteTimeSpan, LuaLoggingMode.Enable, []);
             /// <summary>
             /// String representation
@@ Expand Down @@

benchmark/BDN.benchmark/Operations/OperationsBase.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -56,7 +56,7 @@ public virtual void GlobalSetup() @@
                     QuietMode = true,
                     EnableLua = true,
                     DisablePubSub = true,
-                    LuaOptions = new(LuaMemoryManagementMode.Native, "", Timeout.InfiniteTimeSpan, LuaLoggingMode.Enable),
+                    LuaOptions = new(LuaMemoryManagementMode.Native, "", Timeout.InfiniteTimeSpan, LuaLoggingMode.Enable, []),
                 };
                 if (Params.useAof)
@@ Expand Down @@

libs/host/Configuration/Options.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -560,6 +560,27 @@ internal sealed class Options @@
             [Option("lua-logging-mode", Required = false, HelpText = "Behavior of redis.log(...) when called from Lua scripts.  Defaults to Enable.")]
             public LuaLoggingMode LuaLoggingMode { get; set; }
+            // Parsing is a tad tricky here as JSON wants to set to empty at certain points
+            //
+            // A bespoke union-on-set gets the desired semantics.
+            private readonly HashSet<string> luaAllowedFunctions = [];
+            [OptionValidation]
+            [Option("lua-allowed-functions", Separator = ',', Required = false, HelpText = "If set, restricts the functions available in Lua scripts to given list.")]
+            public IEnumerable<string> LuaAllowedFunctions
+            {
+                get => luaAllowedFunctions;
+                set
+                {
+                    if (value == null)
+                    {
+                        return;
+                    }
+                    luaAllowedFunctions.UnionWith(value);
+                }
+            }
             [FilePathValidation(false, true, false)]
             [Option("unixsocket", Required = false, HelpText = "Unix socket address path to bind server to")]
             public string UnixSocketPath { get; set; }
@@ Expand Down Expand Up @@
                     LoadModuleCS = LoadModuleCS,
                     FailOnRecoveryError = FailOnRecoveryError.GetValueOrDefault(),
                     SkipRDBRestoreChecksumValidation = SkipRDBRestoreChecksumValidation.GetValueOrDefault(),
-                    LuaOptions = EnableLua.GetValueOrDefault() ? new LuaOptions(LuaMemoryManagementMode, LuaScriptMemoryLimit, LuaScriptTimeoutMs == 0 ? Timeout.InfiniteTimeSpan : TimeSpan.FromMilliseconds(LuaScriptTimeoutMs), LuaLoggingMode, logger) : null,
+                    LuaOptions = EnableLua.GetValueOrDefault() ? new LuaOptions(LuaMemoryManagementMode, LuaScriptMemoryLimit, LuaScriptTimeoutMs == 0 ? Timeout.InfiniteTimeSpan : TimeSpan.FromMilliseconds(LuaScriptTimeoutMs), LuaLoggingMode, LuaAllowedFunctions, logger) : null,
                     UnixSocketPath = UnixSocketPath,
                     UnixSocketPermission = unixSocketPermissions
                 };
@@ Expand Down @@

libs/host/defaults.conf

-Original file line number
+Diff line change
@@ Expand Up / @@ -380,6 +380,9 @@ @@
     	/* Allow redis.log(...) to write to the Garnet logs */
     	"LuaLoggingMode": "Enable",
+    	/* Allow all built in and redis.* functions by default */
+    	"LuaAllowedFunctions": null,
     	/* Unix socket address path to bind the server to */
     	"UnixSocketPath": null,
@@ Expand Down @@

libs/server/ArgSlice/ScratchBufferManager.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -114,6 +114,27 @@ public ArgSlice CreateArgSlice(string str) @@
                 return retVal;
             }
+            public ReadOnlySpan<byte> UTF8EncodeString(string str)
+            {
+                // We'll always need AT LEAST this many bytes
+                ExpandScratchBufferIfNeeded(str.Length);
+                var space = FullBuffer()[scratchBufferOffset..];
+                // Attempt to fit in the existing buffer first
+                if (!Encoding.UTF8.TryGetBytes(str, space, out var written))
+                {
+                    // If that fails, figure out exactly how much space we need
+                    var neededBytes = Encoding.UTF8.GetByteCount(str);
+                    ExpandScratchBufferIfNeeded(neededBytes);
+                    space = FullBuffer()[scratchBufferOffset..];
+                    written = Encoding.UTF8.GetBytes(str, space);
+                }
+                return space[..written];
+            }
             /// <summary>
             /// Create an ArgSlice that includes a header of specified size, followed by RESP Bulk-String formatted versions of the specified ArgSlice values (arg1 and arg2)
             /// </summary>
@@ Expand Down @@

libs/server/Lua/LuaOptions.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     // Licensed under the MIT license.
     using System;
+    using System.Collections.Generic;
     using System.Runtime.InteropServices;
     using Microsoft.Extensions.Logging;
@@ Expand All / @@ -18,6 +19,7 @@ public sealed class LuaOptions @@
             public string MemoryLimit = "";
             public TimeSpan Timeout = System.Threading.Timeout.InfiniteTimeSpan;
             public LuaLoggingMode LogMode = LuaLoggingMode.Silent;
+            public HashSet<string> AllowedFunctions = [];
             /// <summary>
             /// Construct options with default options.
@@ Expand All / @@ -30,12 +32,13 @@ public LuaOptions(ILogger logger = null) @@
             /// <summary>
             /// Construct options with specific settings.
             /// </summary>
-            public LuaOptions(LuaMemoryManagementMode memoryMode, string memoryLimit, TimeSpan timeout, LuaLoggingMode logMode, ILogger logger = null) : this(logger)
+            public LuaOptions(LuaMemoryManagementMode memoryMode, string memoryLimit, TimeSpan timeout, LuaLoggingMode logMode, IEnumerable<string> allowedFunctions, ILogger logger = null) : this(logger)
             {
                 MemoryManagementMode = memoryMode;
                 MemoryLimit = memoryLimit;
                 Timeout = timeout;
                 LogMode = logMode;
+                AllowedFunctions = new HashSet<string>(allowedFunctions, StringComparer.OrdinalIgnoreCase);
             }
             /// <summary>
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement remaining Lua runtime libraries #1075

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!