Fixup: Implement suggestions by Matti

numpy · Apr 29, 2020 · 3395802 · 3395802
1 parent 1400cea
commit 3395802
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 4 deletions.
diff --git a/numpy/__init__.py b/numpy/__init__.py
@@ -306,4 +306,4 @@ def _mac_os_check():
         use_hugepage = int(use_hugepage)
 
     # Note that this will currently only make a difference on Linux
-    core.multiarray._multiarray_umath._set_madvise_hugepage(use_hugepage)
+    core.multiarray._set_madvise_hugepage(use_hugepage)
diff --git a/numpy/core/_add_newdocs.py b/numpy/core/_add_newdocs.py
@@ -4391,6 +4391,14 @@
     and then throwing away the ufunc.
     """)
 
+add_newdoc('numpy.core.multiarray', '_set_madvise_hugepage',
+    """
+    _set_madvise_hugepage(enabled: bool) -> bool
+
+    Set  or unset use of ``madvise (2)`` MADV_HUGEPAGE support when
+    allocating the array data. Returns the previously set value.
+    See `global_state` for more information.
+    """)
 
 add_newdoc('numpy.core._multiarray_tests', 'format_float_OSprintf_g',
     """

diff --git a/numpy/core/multiarray.py b/numpy/core/multiarray.py
@@ -17,7 +17,7 @@
 # _get_ndarray_c_version is semi-public, on purpose not added to __all__
 from ._multiarray_umath import (
     _fastCopyAndTranspose, _flagdict, _insert, _reconstruct, _vec_string,
-    _ARRAY_API, _monotonicity, _get_ndarray_c_version
+    _ARRAY_API, _monotonicity, _get_ndarray_c_version, _set_madvise_hugepage,
     )
 
 __all__ = [

diff --git a/numpy/core/src/multiarray/alloc.c b/numpy/core/src/multiarray/alloc.c
@@ -50,6 +50,13 @@ static cache_bucket dimcache[NBUCKETS_DIM];
 static int _madvise_hugepage = 1;
 
 
+/*
+ * This function enables or disables the use of `MADV_HUGEPAGE` on Linux
+ * by modifying the global static `_madvise_hugepage`.
+ * It returns the previous value of `_madvise_hugepage`.
+ *
+ * It is exposed to Python as `np.core.multiarray._set_madvise_hugepage`.
+ */
 NPY_NO_EXPORT PyObject *
 _set_madvise_hugepage(PyObject *NPY_UNUSED(self), PyObject *enabled_obj)
 {

diff --git a/numpy/core/src/multiarray/multiarraymodule.c b/numpy/core/src/multiarray/multiarraymodule.c
@@ -3972,7 +3972,6 @@ normalize_axis_index(PyObject *NPY_UNUSED(self), PyObject *args, PyObject *kwds)
     return PyInt_FromLong(axis);
 }
 
-
 static struct PyMethodDef array_module_methods[] = {
     {"_get_implementing_args",
         (PyCFunction)array__get_implementing_args,
@@ -4162,7 +4161,7 @@ static struct PyMethodDef array_module_methods[] = {
     {"_add_newdoc_ufunc", (PyCFunction)add_newdoc_ufunc,
         METH_VARARGS, NULL},
     {"_set_madvise_hugepage", (PyCFunction)_set_madvise_hugepage,
-        METH_O, "Toggle and return madvise hugepage (no OS support check)."},
+        METH_O, NULL},
     {NULL, NULL, 0, NULL}                /* sentinel */
 };