Raincloud/sheepit-shadow-nabber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'CPU-javadoc' into 'master'

Browse Source 
Add javadoc to CPU

See merge request sheepitrenderfarm/client!254
This commit is contained in:
Sheepit Renderfarm
2023-10-19 10:35:30 +00:00
parent 1410f9bc38 42d2095c0b
commit 22bb587894
1 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
src/main/java/com/sheepit/client/hardware/cpu/CPU.java
View File

@@ -29,11 +29,17 @@ import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.InputStreamReader; import java.io.InputStreamReader;
/**
* Provides attributes to store various characteristic about the CPU and to detect the CPU architecture and core count
*/
@Getter @Setter public class CPU { @Getter @Setter public class CPU {
public static final int MIN_CORES = Runtime.getRuntime().availableProcessors() > 1 ? 2 : 1; public static final int MIN_CORES = Runtime.getRuntime().availableProcessors() > 1 ? 2 : 1;
private String name; private String name;
private String model; private String model;
private String family; private String family;
/**
* The detail is limited to only if it's 32 or 64bit
*/
private String arch; // 32 or 64 bits private String arch; // 32 or 64 bits
private static final Log log = Log.getInstance(null); private static final Log log = Log.getInstance(null);
private static Integer logicalCores = -1; // Store core count throughout instances private static Integer logicalCores = -1; // Store core count throughout instances
@@ -45,6 +51,17 @@ import java.io.InputStreamReader;
this.generateArch(); this.generateArch();
} }
/**
* Returns the maximum number of processors available.
* On Linux and Mac this functions returns and works exactly like availableProcessors.
* @see Runtime#availableProcessors()
* On Windows 10 (and earlier) the maximum reported number of processor is never over 64
* due to the nature of Processor Groups pre-Windows 11 and that JDK 11 goes not operate NUMA aware by default.
* Therefore, on Windows, the system is quieried via powershell about the number logical cores.
* in order te reflect what Blender will be able to utilize.
* @see <a href="https://learn.microsoft.com/en-us/windows/win32/procthread/processor-groups">Processor Groups</a>
* @return the maximum number of processors available; never smaller than one
*/
public int cores() { public int cores() {
// If logicalCores is -1, then haven't run the core-checking script yet // If logicalCores is -1, then haven't run the core-checking script yet
// Only want to run it once since cores is called multiple times // Only want to run it once since cores is called multiple times
@@ -52,6 +69,9 @@ import java.io.InputStreamReader;
// Use normal method for systems other than windows, and in case script fails. // Use normal method for systems other than windows, and in case script fails.
logicalCores = Runtime.getRuntime().availableProcessors(); logicalCores = Runtime.getRuntime().availableProcessors();
/* It is worth revisiting if this core detection logic is still needed
once support for either Windows 10 or OpenJDK 11 has been phased out, because as mentioned in the javadoc
JDK12+ may now run NUMA-aware out of the box or Win11+ Proc Groups now properly reflect the entire system*/
if (OS.getOS() instanceof Windows) { if (OS.getOS() instanceof Windows) {
ProcessBuilder powershellProcess = new ProcessBuilder("powershell.exe", ProcessBuilder powershellProcess = new ProcessBuilder("powershell.exe",
"((Get-CimInstance -ClassName Win32_Processor).NumberOfLogicalProcessors | Measure-Object -Sum ).Sum"); "((Get-CimInstance -ClassName Win32_Processor).NumberOfLogicalProcessors | Measure-Object -Sum ).Sum");
@@ -99,6 +119,9 @@ import java.io.InputStreamReader;
return logicalCores; return logicalCores;
} }
/**
* Detects whether the CPU is currently operating in 32 or 64 bit mode
*/
public void generateArch() { public void generateArch() {
String arch = System.getProperty("os.arch").toLowerCase(); String arch = System.getProperty("os.arch").toLowerCase();
switch (arch) { switch (arch) {
@@ -119,6 +142,10 @@ import java.io.InputStreamReader;
} }
} }
/**
* Returns if we have any data on the CPU
* @return boolean reflecting if all attributes of the CPU are empty
*/
public boolean haveData() { public boolean haveData() {
return this.name != null && this.model != null && this.family != null && this.arch != null; return this.name != null && this.model != null && this.family != null && this.arch != null;
} }