Move Lua scripting engine into a Valkey module

src/CMakeLists.txt

@@ -19,9 +19,10 @@ add_dependencies(valkey-server release_header)
 if (NOT WITHOUT_LUA)
     message(STATUS "Build Lua scripting engine module")
     add_subdirectory(modules/lua)
-    add_dependencies(valkey-server luaengine)
+    add_dependencies(valkey-server valkeylua)
     target_compile_definitions(valkey-server PRIVATE LUA_ENGINE_ENABLED)
-    target_compile_definitions(valkey-server PRIVATE LUA_ENGINE_LIB=libluaengine.so)
+    target_compile_definitions(valkey-server PRIVATE LUA_ENGINE_LIB=libvalkeylua.so)
+    target_link_options(valkey-server PRIVATE -Wl,--disable-new-dtags)
 
     set(VALKEY_INSTALL_RPATH "")
     set_target_properties(valkey-server PROPERTIES

src/Makefile

@@ -254,7 +254,7 @@ endif
 FINAL_CFLAGS+= -I../deps/libvalkey/include -I../deps/linenoise -I../deps/hdr_histogram -I../deps/fpconv
 
 # Lua scripting engine module
-LUA_MODULE_NAME:=modules/lua/libluaengine.so
+LUA_MODULE_NAME:=modules/lua/libvalkeylua.so
 ifeq ($(BUILD_LUA),no)
 	LUA_MODULE=
 	LUA_MODULE_INSTALL=
@@ -263,7 +263,7 @@ else
 	LUA_MODULE_INSTALL=install-lua-module
 
 	current_dir = $(shell pwd)
-	FINAL_CFLAGS+=-DLUA_ENGINE_ENABLED -DLUA_ENGINE_LIB=libluaengine.so
+	FINAL_CFLAGS+=-DLUA_ENGINE_ENABLED -DLUA_ENGINE_LIB=libvalkeylua.so
 ifeq ($(uname_S),Darwin)
 	FINAL_LDFLAGS+= -Wl,-rpath,$(PREFIX)/lib:$(current_dir)/modules/lua
 else

src/module.c

@@ -12749,41 +12749,15 @@ int moduleLoad(const char *path, void **module_argv, int module_argc, int is_loa
     return C_OK;
 }
 
-/* Unload the module registered with the specified name. On success
- * C_OK is returned, otherwise C_ERR is returned and errmsg is set
- * with an appropriate message. */
-int moduleUnload(sds name, const char **errmsg) {
-    struct ValkeyModule *module = dictFetchValue(modules, name);
-
-    if (module == NULL) {
-        *errmsg = "no such module with that name";
-        return C_ERR;
-    } else if (listLength(module->types)) {
-        *errmsg = "the module exports one or more module-side data "
-                  "types, can't unload";
-        return C_ERR;
-    } else if (listLength(module->usedby)) {
-        *errmsg = "the module exports APIs used by other modules. "
-                  "Please unload them first and try again";
-        return C_ERR;
-    } else if (module->blocked_clients) {
-        *errmsg = "the module has blocked clients. "
-                  "Please wait for them to be unblocked and try again";
-        return C_ERR;
-    } else if (moduleHoldsTimer(module)) {
-        *errmsg = "the module holds timer that is not fired. "
-                  "Please stop the timer or wait until it fires.";
-        return C_ERR;
-    }
-
+static int moduleUnloadInternal(struct ValkeyModule *module) {
     /* Give module a chance to clean up. */
     const char *onUnloadNames[] = {"ValkeyModule_OnUnload", "RedisModule_OnUnload"};
     int (*onunload)(void *) = NULL;
     for (size_t i = 0; i < sizeof(onUnloadNames) / sizeof(onUnloadNames[0]); i++) {
         onunload = (int (*)(void *))(unsigned long)dlsym(module->handle, onUnloadNames[i]);
         if (onunload) {
             if (i != 0) {
-                serverLog(LL_NOTICE, "Legacy Redis Module %s found", name);
+                serverLog(LL_NOTICE, "Legacy Redis Module %s found", module->name);
             }
             break;
         }
@@ -12796,7 +12770,7 @@ int moduleUnload(sds name, const char **errmsg) {
         moduleFreeContext(&ctx);
 
         if (unload_status == VALKEYMODULE_ERR) {
-            serverLog(LL_WARNING, "Module %s OnUnload failed. Unload canceled.", name);
+            serverLog(LL_WARNING, "Module %s OnUnload failed. Unload canceled.", module->name);
             errno = ECANCELED;
             return C_ERR;
         }
@@ -12825,6 +12799,49 @@ int moduleUnload(sds name, const char **errmsg) {
     return C_OK;
 }
 
+/* Unload the module registered with the specified name. On success
+ * C_OK is returned, otherwise C_ERR is returned and errmsg is set
+ * with an appropriate message. */
+int moduleUnload(sds name, const char **errmsg) {
+    struct ValkeyModule *module = dictFetchValue(modules, name);
+
+    if (module == NULL) {
+        *errmsg = "no such module with that name";
+        return C_ERR;
+    } else if (listLength(module->types)) {
+        *errmsg = "the module exports one or more module-side data "
+                  "types, can't unload";
+        return C_ERR;
+    } else if (listLength(module->usedby)) {
+        *errmsg = "the module exports APIs used by other modules. "
+                  "Please unload them first and try again";
+        return C_ERR;
+    } else if (module->blocked_clients) {
+        *errmsg = "the module has blocked clients. "
+                  "Please wait for them to be unblocked and try again";
+        return C_ERR;
+    } else if (moduleHoldsTimer(module)) {
+        *errmsg = "the module holds timer that is not fired. "
+                  "Please stop the timer or wait until it fires.";
+        return C_ERR;
+    }
+
+    return moduleUnloadInternal(module);
+}
+
+void moduleUnloadAllModules(void) {
+    dictIterator *di = dictGetSafeIterator(modules);
+    dictEntry *de;
+
+    while ((de = dictNext(di)) != NULL) {
+        struct ValkeyModule *module = dictGetVal(de);
+        /* We ignore the return value of `moduleUnloadInternal` here, because
+         * we're shutting down the server. */
+        moduleUnloadInternal(module);
+    }
+    dictReleaseIterator(di);
+}
+
 void modulePipeReadable(aeEventLoop *el, int fd, void *privdata, int mask) {
     UNUSED(el);
     UNUSED(fd);

src/module.h

@@ -183,6 +183,7 @@ void moduleInitModulesSystemLast(void);
 void modulesCron(void);
 int moduleLoad(const char *path, void **argv, int argc, int is_loadex);
 int moduleUnload(sds name, const char **errmsg);
+void moduleUnloadAllModules(void);
 void moduleLoadFromQueue(void);
 int moduleGetCommandKeysViaAPI(struct serverCommand *cmd, robj **argv, int argc, getKeysResult *result);
 int moduleGetCommandChannelsViaAPI(struct serverCommand *cmd, robj **argv, int argc, getKeysResult *result);

src/modules/lua/CMakeLists.txt

@@ -1,4 +1,4 @@
-project(luaengine)
+project(valkeylua)
 
 option(WITHOUT_LUA "Build Valkey without Lua scripting engine")
 
@@ -15,12 +15,12 @@ set(LUA_ENGINE_SRCS
     debug_lua.c
     list.c)
 
-add_library(luaengine SHARED "${LUA_ENGINE_SRCS}")
+add_library(valkeylua SHARED "${LUA_ENGINE_SRCS}")
 
-add_dependencies(luaengine lualib)
-target_link_libraries(luaengine PRIVATE lualib)
-target_include_directories(luaengine PRIVATE ../../../deps/lua/src)
+add_dependencies(valkeylua lualib)
+target_link_libraries(valkeylua PRIVATE lualib)
+target_include_directories(valkeylua PRIVATE ../../../deps/lua/src)
 
-install(TARGETS luaengine
+install(TARGETS valkeylua
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
 )

src/modules/lua/Makefile

@@ -21,9 +21,9 @@ ifeq ("$(wildcard /usr/lib/libSystem.dylib)","")
 endif
 endif
 
-all: libluaengine.so
+all: libvalkeylua.so
 
-libluaengine.so: $(OBJS) $(LIBS)
+libvalkeylua.so: $(OBJS) $(LIBS)
 	$(CC) -o $@ $(SHOBJ_LDFLAGS) $^
 
 sha1.o: ../../sha1.c

src/server.c

@@ -4814,15 +4814,7 @@ int finishShutdown(void) {
     /* Close the listening sockets. Apparently this allows faster restarts. */
     closeListeningSockets(1);
 
-#ifdef LUA_ENGINE_ENABLED
-    /* Unload Lua engine module */
-    const char *err = NULL;
-    sds name = sdsnew("lua");
-    if (moduleUnload(name, &err) != C_OK) {
-        serverLog(LL_WARNING, "Failed to unload 'lua' module: %s", err);
-    }
-    sdsfree(name);
-#endif
+    moduleUnloadAllModules();
 
     serverLog(LL_WARNING, "%s is now ready to exit, bye bye...", server.sentinel_mode ? "Sentinel" : "Valkey");
     return C_OK;