Add an OS.get_processor_name() method

This method can be used to get the CPU model name.
It can be used in conjunction with
`VisualServer.get_video_adapter_name()` and
`VisualServer.get_video_adapter_vendor()` for annotating benchmarks
and automatic graphics quality configuration.
This commit is contained in:
Hugo Locurcio 2022-02-15 22:25:51 +01:00
parent 685d4b4739
commit 7f9e974a8b
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
13 changed files with 78 additions and 4 deletions

View file

@ -960,6 +960,10 @@ int _OS::get_processor_count() const {
return OS::get_singleton()->get_processor_count();
}
String _OS::get_processor_name() const {
return OS::get_singleton()->get_processor_name();
}
bool _OS::is_stdout_verbose() const {
return OS::get_singleton()->is_stdout_verbose();
}
@ -1319,6 +1323,7 @@ void _OS::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_low_processor_usage_mode_sleep_usec"), &_OS::get_low_processor_usage_mode_sleep_usec);
ClassDB::bind_method(D_METHOD("get_processor_count"), &_OS::get_processor_count);
ClassDB::bind_method(D_METHOD("get_processor_name"), &_OS::get_processor_name);
ClassDB::bind_method(D_METHOD("get_executable_path"), &_OS::get_executable_path);
ClassDB::bind_method(D_METHOD("execute", "path", "arguments", "blocking", "output", "read_stderr", "open_console"), &_OS::execute, DEFVAL(true), DEFVAL(Array()), DEFVAL(false), DEFVAL(false));

View file

@ -327,6 +327,7 @@ public:
bool is_stdout_verbose() const;
int get_processor_count() const;
String get_processor_name() const;
enum SystemDir {
SYSTEM_DIR_DESKTOP,

View file

@ -512,6 +512,10 @@ int OS::get_processor_count() const {
return 1;
}
String OS::get_processor_name() const {
return "";
}
Error OS::native_video_play(String p_path, float p_volume, String p_audio_track, String p_subtitle_track) {
return FAILED;
}

View file

@ -519,6 +519,7 @@ public:
virtual bool is_custom_exit_code();
virtual int get_processor_count() const;
virtual String get_processor_name() const;
virtual String get_unique_id() const;

View file

@ -345,7 +345,14 @@
<method name="get_processor_count" qualifiers="const">
<return type="int" />
<description>
Returns the number of threads available on the host machine.
Returns the number of [i]logical[/i] CPU cores available on the host machine. On CPUs with HyperThreading enabled, this number will be greater than the number of [i]physical[/i] CPU cores.
</description>
</method>
<method name="get_processor_name" qualifiers="const">
<return type="String" />
<description>
Returns the name of the CPU model on the host machine (e.g. "Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz").
[b]Note:[/b] This method is only implemented on Windows, macOS, Linux and iOS. On Android, HTML5 and UWP, [method get_processor_name] returns an empty string.
</description>
</method>
<method name="get_real_window_size" qualifiers="const">

View file

@ -123,6 +123,7 @@ public:
String get_locale() const;
String get_unique_id() const;
virtual String get_processor_name() const;
virtual void vibrate_handheld(int p_duration_ms = 500);

View file

@ -54,6 +54,7 @@
#import <UIKit/UIKit.h>
#include <dlfcn.h>
#include <sys/sysctl.h>
#import <sys/utsname.h>
extern int gl_view_base_fb; // from gl_view.mm
@ -665,6 +666,15 @@ void OSIPhone::native_video_stop() {
}
}
String OSIPhone::get_processor_name() const {
char buffer[256];
size_t buffer_len = 256;
if (sysctlbyname("machdep.cpu.brand_string", &buffer, &buffer_len, NULL, 0) == 0) {
return String::utf8(buffer, buffer_len);
}
ERR_FAIL_V_MSG("", String("Couldn't get the CPU model name. Returning an empty string."));
}
void OSIPhone::vibrate_handheld(int p_duration_ms) {
// iOS does not support duration for vibration
AudioServicesPlaySystemSound(kSystemSoundID_Vibrate);

View file

@ -310,6 +310,7 @@ public:
virtual String get_ime_text() const;
virtual String get_unique_id() const;
virtual String get_processor_name() const;
virtual OS::PowerState get_power_state();
virtual int get_power_seconds_left();

View file

@ -41,6 +41,8 @@
#include "servers/visual/visual_server_raster.h"
#include <mach-o/dyld.h>
#include <os/log.h>
#include <sys/sysctl.h>
#include <Carbon/Carbon.h>
#import <Cocoa/Cocoa.h>
@ -48,9 +50,6 @@
#include <IOKit/IOKitLib.h>
#include <IOKit/hid/IOHIDKeys.h>
#include <IOKit/hid/IOHIDLib.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 101200
#include <os/log.h>
#endif
#include <dlfcn.h>
#include <fcntl.h>
@ -1510,6 +1509,15 @@ void OS_OSX::set_ime_position(const Point2 &p_pos) {
im_position = p_pos;
}
String OS_OSX::get_processor_name() const {
char buffer[256];
size_t buffer_len = 256;
if (sysctlbyname("machdep.cpu.brand_string", &buffer, &buffer_len, NULL, 0) == 0) {
return String::utf8(buffer, buffer_len);
}
ERR_FAIL_V_MSG("", String("Couldn't get the CPU model name. Returning an empty string."));
}
void OS_OSX::initialize_core() {
crash_handler.initialize();

View file

@ -3130,6 +3130,26 @@ int OS_Windows::get_processor_count() const {
return sysinfo.dwNumberOfProcessors;
}
String OS_Windows::get_processor_name() const {
const String id = "Hardware\\Description\\System\\CentralProcessor\\0";
HKEY hkey;
if (RegOpenKeyExW(HKEY_LOCAL_MACHINE, (LPCWSTR)(id.c_str()), 0, KEY_QUERY_VALUE, &hkey) != ERROR_SUCCESS) {
ERR_FAIL_V_MSG("", String("Couldn't get the CPU model name. Returning an empty string."));
}
WCHAR buffer[256];
DWORD buffer_len = 256;
DWORD vtype = REG_SZ;
if (RegQueryValueExW(hkey, L"ProcessorNameString", NULL, &vtype, (LPBYTE)buffer, &buffer_len) == ERROR_SUCCESS) {
RegCloseKey(hkey);
return String((const wchar_t *)buffer, buffer_len).strip_edges();
} else {
RegCloseKey(hkey);
ERR_FAIL_V_MSG("", String("Couldn't get the CPU model name. Returning an empty string."));
}
}
OS::LatinKeyboardVariant OS_Windows::get_latin_keyboard_variant() const {
unsigned long azerty[] = {
0x00020401, // Arabic (102) AZERTY

View file

@ -520,6 +520,7 @@ public:
virtual String get_locale() const;
virtual int get_processor_count() const;
virtual String get_processor_name() const;
virtual LatinKeyboardVariant get_latin_keyboard_variant() const;
virtual int keyboard_get_layout_count() const;

View file

@ -806,6 +806,20 @@ String OS_X11::get_unique_id() const {
return machine_id;
}
String OS_X11::get_processor_name() const {
FileAccessRef f = FileAccess::open("/proc/cpuinfo", FileAccess::READ);
ERR_FAIL_COND_V_MSG(!f, "", String("Couldn't open `/proc/cpuinfo` to get the CPU model name. Returning an empty string."));
while (!f->eof_reached()) {
const String line = f->get_line();
if (line.find("model name") != -1) {
return line.split(":")[1].strip_edges();
}
}
ERR_FAIL_V_MSG("", String("Couldn't get the CPU model name from `/proc/cpuinfo`. Returning an empty string."));
}
void OS_X11::finalize() {
events_thread_done = true;
events_thread.wait_to_finish();

View file

@ -329,6 +329,7 @@ public:
virtual void set_ime_position(const Point2 &p_pos);
virtual String get_unique_id() const;
virtual String get_processor_name() const;
virtual void move_window_to_foreground();
virtual void alert(const String &p_alert, const String &p_title = "ALERT!");