Initial nvml code

Currently there are a few *issues* related to the environment/build.

- Windows build is failing. Gotta figure that out.
- Getting process utilization returns nothing. This may be due to the fact I'm using WSL, meaning there's WDDM running. Or maybe it's just a mistake on my part.

Author: 2kai2kai2

.github/workflows/npm-publish.yml

@@ -49,7 +49,6 @@ jobs:
         with:
           path: prebuilds/
       - run: npm run install-dependencies
-      - run: npm run build-ts
       - run: echo "tgz_name=$(npm pack)" >> "$GITHUB_OUTPUT"
         id: pack
       - uses: actions/upload-artifact@v2

.gitignore

@@ -9,6 +9,4 @@ test/test_mac
 test/test_mem
 prebuilds/
 *.obj
-node-ps-data-*.tgz
-*.js
-*.d.ts
+node-ps-data-*.tgz

binding.gyp

@@ -3,10 +3,14 @@
         ["OS=='win'", {
             "targets": [{
                     "target_name": "node_ps_data",
-                    "sources": ["napi.cc", "lib_win.cc"],
-                    "include_dirs": ["./node_modules/node-addon-api"],
+                    "sources": ["napi.cc", "lib_win.cc", "lib_nvml.cc"],
+                    "include_dirs": [
+                        "./node_modules/node-addon-api",
+                        "C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v12.9/include"
+                    ],
                     "ldflags": [
-                        "-lpsapi" # gcc/g++
+                        "-lpsapi", # gcc/g++
+                        "-lnvidia-ml",
                     ],
                     "link_settings": {
                         "libraries": [
@@ -23,16 +27,24 @@
         "OS=='linux'", {
             "targets": [{
                     "target_name": "node_ps_data",
-                    "sources": ["napi.cc", "lib_linux.cc"],
+                    "sources": ["napi.cc", "lib_linux.cc", "lib_nvml.cc"],
                     "include_dirs": ["./node_modules/node-addon-api"],
+                    "link_settings": {
+                        "libraries": [
+                            "/usr/lib/x86_64-linux-gnu/libnvidia-ml.so",
+                        ],
+                    },
+                    "ldflags": [
+                        "-lnvidia-ml",
+                    ],
                     "cflags!": [ "-fno-exceptions" ],
                     "cflags_cc!": [ "-fno-exceptions" ]
             }]
         },
         "OS=='mac'", {
             "targets": [{
                     "target_name": "node_ps_data",
-                    "sources": ["napi.cc", "lib_mac.cc"],
+                    "sources": ["napi.cc", "lib_mac.cc", "lib_nvml_stub.cc"],
                     "include_dirs": ["./node_modules/node-addon-api"],
                     "cflags!": [ "-fno-exceptions" ],
                     "cflags_cc!": [ "-fno-exceptions" ],

index.d.ts

@@ -0,0 +1,110 @@
+
+/**
+ * @file index.d.ts
+ * @author @2kai2kai2
+ *
+ * @copyright Copyright (c) 2025 2kai2kai2
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @param pid Process ID to search for.
+ * @returns Process user-mode CPU usage time in ms, or 0 if not found.
+ */
+declare function cpuUserTime(pid: number): number;
+
+/**
+ * @param pid Process ID to search for.
+ * @returns Process kernel-mode (system-mode) CPU usage time in ms, or 0 if not found.
+ */
+declare function cpuKernelTime(pid: number): number;
+
+/**
+ * @param pid Process ID to search for.
+ * @returns Process total CPU usage time in ms, or 0 if not found.
+ */
+declare function cpuTime(pid: number): number;
+
+/**
+ * @param pid Process ID to search for.
+ * @returns Total usage in bytes. Windows includes shared working set while linux is more strict.
+ *
+ * Note that as this includes virtual memory, it will often be extremely high on MacOS.
+ */
+declare function memInfo(pid: number): number;
+
+/**
+ * @param pid Process ID to search for.
+ * @returns Resident/working set size in bytes. Windows includes shared working set while linux is more strict.
+ *
+ * Depending on operating system, this may be approximate. It represents the total amount of physical memory being used,
+ * which does not include any vitual memory.
+ */
+declare function memRSS(pid: number): number;
+
+/**
+ * @param pid Process ID to search for.
+ * @returns Number of bytes process has read from file.
+ */
+declare function fileRead(pid: number): number;
+
+/**
+ * @param pid Process ID to search for.
+ * @returns Number of bytes process has written to file.
+ */
+declare function fileWrite(pid: number): number;
+
+/**
+ * The return type for `NvidiaGPU::utilization` that shows utilization of computing resources.
+ * 
+ * NOTE: currently only contains smUtilization (which is what most people need),
+ * but things like video encode/decode accelerator data is not yet implemented.
+ */
+declare interface NvidiaGPUUtilization {
+    /**
+     * The utilization of the device's Steaming Multiprocessors (SMs)
+     * 
+     * This includes most 3D and compute operations.
+     */
+    smUtilization: number
+}
+
+/**
+ * A handle for getting process data from a single Nvidia GPU (internally uses [NVML](https://docs.nvidia.com/deploy/nvml-api/nvml-api-reference.html))
+ */
+declare class NvidiaGPU {
+    /**
+     * A good entrypoint, will return handles for all Nvidia GPUs on this computer.
+     * 
+     * If the computer does not have Nvidia GPUs (or drivers) it will be an empty array.
+     * 
+     * @throws
+     */
+    static allGPUs(): NvidiaGPU[];
+
+    /**
+     * @param deviceIdx The index of the GPU to get a handle for.
+     * @param pid The process id to search for.
+     * 
+     * @throws An error if `deviceIdx` is invalid or if we do not have permission to access it.
+     * @throws
+     */
+    constructor(deviceIdx: number, pid: number);
+
+    /**
+     * Returns the process's compute utilization since the last query
+     * (or if the last query was a long time ago/never, since the start of the stored buffer).
+     */
+    utilization(): NvidiaGPUUtilization;
+}

index.js

@@ -0,0 +1,20 @@
+/**
+ * @file index.js
+ * @author @2kai2kai2
+ *
+ * @copyright Copyright (c) 2025 2kai2kai2
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+module.exports = require("node-gyp-build")(__dirname);