Port SDL_cpuinfo.h (#2308)

* Add `get_cpu_instruction_sets`
Add `get_cpu_count`
Add `get_cpu_cache_line_size`
Add `get_system_ram`

* format

* Return False instead of None

* add docs

* remove unused variables

* fix typo

* Remove `get_cpu_count()`
Remove `get_cpu_cache_line_size()`

* add tests

* update docs

* get_system_ram -> get_total_ram

* fix docs

Author: yunline

buildconfig/stubs/pygame/system.pyi

@@ -2,10 +2,29 @@ from typing import List, Optional
 
 from typing_extensions import TypedDict
 
+class _InstructionSets(TypedDict):
+    RDTSC: bool
+    ALTIVEC: bool
+    MMX: bool
+    SSE: bool
+    SSE2: bool
+    SSE3: bool
+    SSE41: bool
+    SSE42: bool
+    AVX: bool
+    AVX2: bool
+    AVX512F: bool
+    NEON: bool
+    ARMSIMD: bool
+    LSX: bool
+    LASX: bool
+
 # dict at runtime, TypedDict exists solely for the typechecking benefits
 class _Locale(TypedDict):
     language: str
     country: Optional[str]
 
+def get_cpu_instruction_sets() -> _InstructionSets: ...
+def get_total_ram() -> int: ...
 def get_pref_path(org: str, app: str) -> str: ...
 def get_pref_locales() -> List[_Locale]: ...

docs/reST/ref/system.rst

@@ -16,6 +16,57 @@ open just in case something obvious comes up.
 
 .. versionadded:: 2.2.0
 
+.. function:: get_cpu_instruction_sets
+
+   | :sl:`get the information of CPU instruction sets`
+   | :sg:`get_cpu_instruction_sets() -> instruction_sets`
+
+   Returns a dict of the information of CPU instruction sets. The keys of
+   the dict are the names of instruction sets and the values determine 
+   whether the instruction set is available.
+
+   Some of functions like ``Surface.blit`` can be accelerated by SIMD 
+   instruction sets like SSE2 or AVX2. By checking the availability of 
+   instruction sets, you can check if these accelerations are available.
+
+   Here is an example of the returned dict
+   ::
+
+     {
+          'RDTSC': True,
+          'ALTIVEC': False,
+          'MMX': True,
+          'SSE': True,
+          'SSE2': True,
+          'SSE3': True,
+          'SSE41': True,
+          'SSE42': True,
+          'AVX': True,
+          'AVX2': True, 
+          'AVX512F': False,
+          'NEON': False, 
+          'ARMSIMD': False,
+          'LSX': False, 
+          'LASX': False
+     }
+
+   .. Note:: The value of ``ARMSIMD`` will be always False if
+      SDL version < 2.0.12.
+      
+      The values of ``LSX`` and ``LASX`` will be always False if
+      SDL version < 2.24.0.
+   
+   .. versionadded:: 2.3.1
+
+.. function:: get_total_ram
+
+   | :sl:`get the amount of RAM configured in the system`
+   | :sg:`get_total_ram() -> ram_size`
+
+   Returns the amount of RAM configured in the system in MiB.
+
+   .. versionadded:: 2.3.1
+
 .. function:: get_pref_path
 
    | :sl:`get a writeable folder for your app`

src_c/doc/system_doc.h

@@ -1,4 +1,6 @@
 /* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
 #define DOC_SYSTEM "pygame module to provide additional context about the system"
+#define DOC_SYSTEM_GETCPUINSTRUCTIONSETS "get_cpu_instruction_sets() -> instruction_sets\nget the information of CPU instruction sets"
+#define DOC_SYSTEM_GETTOTALRAM "get_total_ram() -> ram_size\nget the amount of RAM configured in the system"
 #define DOC_SYSTEM_GETPREFPATH "get_pref_path(org, app) -> path\nget a writeable folder for your app"
 #define DOC_SYSTEM_GETPREFLOCALES "get_pref_locales() -> list[locale]\nget preferred locales set on the system"

src_c/system.c

@@ -4,6 +4,68 @@
 
 #include "doc/system_doc.h"
 
+static PyObject *
+pg_system_get_cpu_instruction_sets(PyObject *self, PyObject *_null)
+{
+    PyObject *tmp_bool = NULL;
+    PyObject *instruction_sets = NULL;
+
+    instruction_sets = PyDict_New();
+    if (!instruction_sets) {
+        goto error;
+    }
+
+#define INSERT_INSTRUCTIONSET_INFO(name, SDL_fn_name)               \
+    tmp_bool = PyBool_FromLong((SDL_fn_name)());                    \
+    if (PyDict_SetItemString(instruction_sets, (name), tmp_bool)) { \
+        Py_DECREF(tmp_bool);                                        \
+        goto error;                                                 \
+    }                                                               \
+    Py_DECREF(tmp_bool);
+
+    INSERT_INSTRUCTIONSET_INFO("RDTSC", SDL_HasRDTSC);
+    INSERT_INSTRUCTIONSET_INFO("ALTIVEC", SDL_HasAltiVec);
+    INSERT_INSTRUCTIONSET_INFO("MMX", SDL_HasMMX);
+    INSERT_INSTRUCTIONSET_INFO("SSE", SDL_HasSSE);
+    INSERT_INSTRUCTIONSET_INFO("SSE2", SDL_HasSSE2);
+    INSERT_INSTRUCTIONSET_INFO("SSE3", SDL_HasSSE3);
+    INSERT_INSTRUCTIONSET_INFO("SSE41", SDL_HasSSE41);
+    INSERT_INSTRUCTIONSET_INFO("SSE42", SDL_HasSSE42);
+    INSERT_INSTRUCTIONSET_INFO("AVX", SDL_HasAVX);
+    INSERT_INSTRUCTIONSET_INFO("AVX2", SDL_HasAVX2);
+    INSERT_INSTRUCTIONSET_INFO("AVX512F", SDL_HasAVX512F);
+    INSERT_INSTRUCTIONSET_INFO("NEON", SDL_HasNEON);
+#if SDL_VERSION_ATLEAST(2, 0, 12)
+    INSERT_INSTRUCTIONSET_INFO("ARMSIMD", SDL_HasARMSIMD);
+#else
+    if (PyDict_SetItemString(instruction_sets, "ARMSIMD", Py_False))
+        goto error;
+#endif
+#if SDL_VERSION_ATLEAST(2, 24, 0)
+    INSERT_INSTRUCTIONSET_INFO("LSX", SDL_HasLSX);
+    INSERT_INSTRUCTIONSET_INFO("LASX", SDL_HasLASX);
+#else
+    if (PyDict_SetItemString(instruction_sets, "LSX", Py_False))
+        goto error;
+    if (PyDict_SetItemString(instruction_sets, "LASX", Py_False))
+        goto error;
+#endif
+
+#undef INSERT_INSTRUCTIONSET_INFO
+
+    return instruction_sets;
+
+error:
+    Py_XDECREF(instruction_sets);
+    return NULL;
+}
+
+static PyObject *
+pg_system_get_total_ram(PyObject *self, PyObject *_null)
+{
+    return PyLong_FromLong(SDL_GetSystemRAM());
+}
+
 static PyObject *
 pg_system_get_pref_path(PyObject *self, PyObject *args, PyObject *kwargs)
 {
@@ -100,6 +162,10 @@ pg_system_get_pref_locales(PyObject *self, PyObject *_null)
 }
 
 static PyMethodDef _system_methods[] = {
+    {"get_cpu_instruction_sets", pg_system_get_cpu_instruction_sets,
+     METH_NOARGS, DOC_SYSTEM_GETCPUINSTRUCTIONSETS},
+    {"get_total_ram", pg_system_get_total_ram, METH_NOARGS,
+     DOC_SYSTEM_GETTOTALRAM},
     {"get_pref_path", (PyCFunction)pg_system_get_pref_path,
      METH_VARARGS | METH_KEYWORDS, DOC_SYSTEM_GETPREFPATH},
     {"get_pref_locales", pg_system_get_pref_locales, METH_NOARGS,

test/system_test.py

@@ -5,6 +5,18 @@
 
 
 class SystemModuleTest(unittest.TestCase):
+    def test_get_cpu_instruction_sets(self):
+        instruction_sets = pygame.system.get_cpu_instruction_sets()
+
+        for name in instruction_sets:
+            self.assertIsInstance(name, str)
+            self.assertIsInstance(instruction_sets[name], bool)
+
+    def test_get_total_ram(self):
+        ram = pygame.system.get_total_ram()
+
+        self.assertIsInstance(ram, int)
+
     def test_get_pref_path(self):
         get_pref_path = pygame.system.get_pref_path