System API for getting os, architecture, processor count (#149)

TODO:
- ~~Get system info for POSIX compliant systems~~
- ~~Bikeshed on the field name for thread/logical processor/core count
(lol)~~

Closes issue #117

---------

Co-authored-by: ariel <[email protected]>

Author: ffrostfall

CMakeLists.txt

@@ -16,6 +16,7 @@ add_library(Lute.Net STATIC)
 add_library(Lute.Task STATIC)
 add_library(Lute.VM STATIC)
 add_library(Lute.Process STATIC)
+add_library(Lute.System STATIC)
 
 # luau setup
 set(LUAU_BUILD_CLI OFF)
@@ -89,13 +90,15 @@ target_compile_features(Lute.Net PUBLIC cxx_std_17)
 target_compile_features(Lute.Task PUBLIC cxx_std_17)
 target_compile_features(Lute.VM PUBLIC cxx_std_17)
 target_compile_features(Lute.Process PUBLIC cxx_std_17)
+target_compile_features(Lute.System PUBLIC cxx_std_17)
 target_include_directories(Lute.Runtime PUBLIC runtime/include ${LIBUV_INCLUDE_DIR})
 target_include_directories(Lute.Fs PUBLIC fs/include ${LIBUV_INCLUDE_DIR})
 target_include_directories(Lute.Luau PUBLIC luau/include ${LIBUV_INCLUDE_DIR})
 target_include_directories(Lute.Net PUBLIC net/include ${LIBUV_INCLUDE_DIR} ${UWEBSOCKETS_INCLUDE_DIR})
 target_include_directories(Lute.Task PUBLIC task/include ${LIBUV_INCLUDE_DIR})
 target_include_directories(Lute.VM PUBLIC vm/include ${LIBUV_INCLUDE_DIR})
 target_include_directories(Lute.Process PUBLIC process/include ${LIBUV_INCLUDE_DIR})
+target_include_directories(Lute.System PUBLIC system/include ${LIBUV_INCLUDE_DIR})
 
 target_link_libraries(Lute.Runtime PRIVATE Luau.CLI.lib Luau.Compiler Luau.Config Luau.CodeGen Luau.VM uv_a)
 target_link_libraries(Lute.Fs PRIVATE Lute.Runtime Luau.VM uv_a)
@@ -104,7 +107,8 @@ target_link_libraries(Lute.Net PRIVATE Lute.Runtime Luau.VM uv_a ${WOLFSSL_LIBRA
 target_link_libraries(Lute.Task PRIVATE Lute.Runtime Luau.VM uv_a)
 target_link_libraries(Lute.VM PRIVATE Lute.Runtime Luau.VM uv_a)
 target_link_libraries(Lute.Process PRIVATE Lute.Runtime Luau.VM uv_a)
-target_link_libraries(Lute.CLI PRIVATE Luau.CLI.lib Luau.Compiler Luau.Config Luau.CodeGen Luau.Analysis Luau.VM Lute.Runtime Lute.Fs Lute.Luau Lute.Net Lute.Task Lute.VM Lute.Process)
+target_link_libraries(Lute.System PRIVATE Lute.Runtime Luau.VM uv_a)
+target_link_libraries(Lute.CLI PRIVATE Luau.CLI.lib Luau.Compiler Luau.Config Luau.CodeGen Luau.Analysis Luau.VM Lute.Runtime Lute.Fs Lute.Luau Lute.Net Lute.Task Lute.VM Lute.Process Lute.System)
 
 set(LUTE_OPTIONS)
 
@@ -128,4 +132,5 @@ target_compile_options(Lute.Net PRIVATE ${LUTE_OPTIONS})
 target_compile_options(Lute.Task PRIVATE ${LUTE_OPTIONS})
 target_compile_options(Lute.VM PRIVATE ${LUTE_OPTIONS})
 target_compile_options(Lute.Process PRIVATE ${LUTE_OPTIONS})
+target_compile_options(Lute.System PRIVATE ${LUTE_OPTIONS})
 target_compile_options(Lute.CLI PRIVATE ${LUTE_OPTIONS})

Sources.cmake

@@ -53,3 +53,9 @@ target_sources(Lute.CLI PRIVATE
     cli/tc.h
     cli/tc.cpp
 )
+
+target_sources(Lute.System PRIVATE
+    system/include/lute/system.h
+
+    system/src/system.cpp
+)

cli/main.cpp

@@ -13,6 +13,7 @@
 #include "lute/net.h"
 #include "lute/options.h"
 #include "lute/process.h"
+#include "lute/system.h"
 #include "lute/ref.h"
 #include "lute/require.h"
 #include "lute/runtime.h"
@@ -70,6 +71,9 @@ lua_State* setupState(Runtime& runtime)
 
     luteopen_vm(L);
     lua_setfield(L, -2, "@lute/vm");
+    
+    luteopen_system(L);
+    lua_setfield(L, -2, "@lute/system");
 
     static const luaL_Reg funcs[] = {
         {"require", lua_require},

examples/system_lib.luau

@@ -0,0 +1,13 @@
+local system = require("@lute/system")
+
+print(system.os)
+print(system.arch)
+print(system.threadcount())
+
+for i, cpu in system.cpus() do
+	-- print(`[core {string.format("%.02i", i)}] speed: {cpu.speed}, model: {cpu.model}`)
+
+	-- for key, time in cpu.times do
+	-- 	print(`   [times] {key}: {time}`)
+	-- end
+end

system/include/lute/system.h

@@ -0,0 +1,32 @@
+#pragma once
+
+#include "lua.h"
+#include "lualib.h"
+#include <string>
+
+// open the library as a standard global luau library
+int luaopen_system(lua_State* L);
+// open the library as a table on top of the stack
+int luteopen_system(lua_State* L);
+
+static const char kArchitectureProperty[] = "arch";
+static const char kOperatingSystemProperty[] = "os";
+
+namespace system_lib
+{
+int lua_cpus(lua_State* L);
+int lua_threadcount(lua_State* L);
+
+static const luaL_Reg lib[] = {
+    {"cpus", lua_cpus},
+    {"threadcount", lua_threadcount},
+
+    {nullptr, nullptr}
+};
+
+static const std::string properties[] = {
+    kArchitectureProperty,
+    kOperatingSystemProperty,
+};
+
+} // namespace system_lib

system/src/system.cpp

@@ -0,0 +1,105 @@
+#include "lute/system.h"
+#include "lua.h"
+#include "uv.h"
+#include <iterator>
+#include <string>
+#include <vector>
+
+int luaopen_system(lua_State* L)
+{
+    luteopen_system(L);
+    lua_setglobal(L, "system");
+
+    return 1;
+}
+
+int luteopen_system(lua_State* L)
+{
+    lua_createtable(L, 0, std::size(system_lib::lib) + std::size(system_lib::properties));
+
+    for (auto& [name, func] : system_lib::lib)
+    {
+        if (!name || !func)
+            break;
+
+        lua_pushcfunction(L, func, name);
+        lua_setfield(L, -2, name);
+    }
+
+    // os
+    uv_utsname_t sysinfo;
+    uv_os_uname(&sysinfo);
+
+    lua_pushstring(L, sysinfo.sysname);
+    lua_setfield(L, -2, kOperatingSystemProperty);
+
+    lua_pushstring(L, sysinfo.machine);
+    lua_setfield(L, -2, kArchitectureProperty);
+
+    lua_setreadonly(L, -1, 1);
+
+    return 1;
+}
+
+namespace system_lib
+{
+int lua_cpus(lua_State* L)
+{
+    int count = uv_available_parallelism();
+    uv_cpu_info_t* cpus;
+
+    uv_cpu_info(&cpus, &count);
+
+    lua_createtable(L, count, 0);
+
+    int j = 0;
+    for (int i = 0; i < count; i++)
+    {
+        lua_pushinteger(L, ++j);
+
+        auto cpuInfo = cpus[i];
+
+        // model, speed, times
+        lua_createtable(L, 0, 2);
+
+        lua_pushstring(L, cpuInfo.model);
+        lua_setfield(L, -2, "model");
+
+        lua_pushinteger(L, (int)cpuInfo.speed);
+        lua_setfield(L, -2, "speed");
+
+        // sys, user, idle, irq, nice
+        lua_createtable(L, 0, 5);
+
+        // cast to double cuz uint64 has higher max n and lua numbers are 52bit
+        lua_pushnumber(L, static_cast<double>(cpuInfo.cpu_times.sys));
+        lua_setfield(L, -2, "sys");
+
+        lua_pushnumber(L, static_cast<double>(cpuInfo.cpu_times.idle));
+        lua_setfield(L, -2, "idle");
+
+        lua_pushnumber(L, static_cast<double>(cpuInfo.cpu_times.irq));
+        lua_setfield(L, -2, "irq");
+
+        lua_pushnumber(L, static_cast<double>(cpuInfo.cpu_times.nice));
+        lua_setfield(L, -2, "nice");
+
+        lua_pushnumber(L, static_cast<double>(cpuInfo.cpu_times.user));
+        lua_setfield(L, -2, "user");
+
+        lua_setfield(L, -2, "times");
+
+        lua_settable(L, -3);
+    };
+
+    return 1;
+}
+
+int lua_threadcount(lua_State* L)
+{
+    lua_pushinteger(L, uv_available_parallelism());
+
+    return 1;
+}
+
+} // namespace system_lib