[Core] Vendor setproctitle (#53471)

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>

Author: jjyao

.bazelrc

@@ -57,6 +57,7 @@ build:clang-cl --per_file_copt="-\\.(asm|S)$@-Werror"
 build:msvc-cl     --per_file_copt="-\\.(asm|S)$@-WX"
 # Ignore warnings for protobuf generated files and external projects.
 build --per_file_copt="\\.pb\\.cc$@-w"
+build --per_file_copt="src/ray/thirdparty/.*$@-w"
 build:linux --per_file_copt="-\\.(asm|S)$,external/.*@-w,-Wno-error=implicit-function-declaration,-Wno-error=unused-function"
 build:macos --per_file_copt="-\\.(asm|S)$,external/.*@-w,-Wno-error=implicit-function-declaration,-Wno-error=unused-function,-Wno-missing-template-arg-list-after-template-kw"
 # Ignore warnings for host tools, which we generally can't control.

.pre-commit-config.yaml

@@ -10,6 +10,7 @@ exclude: |
     release/release_logs/|
     rllib/tests/data|
     thirdparty/patches/|
+    src/ray/thirdparty/|
     doc/external/|
     doc/source/
   )

BUILD.bazel

@@ -901,31 +901,6 @@ cc_proto_library(
     deps = [":extra_actions_base_proto_lib"],
 )
 
-ray_cc_library(
-    name = "sha256",
-    srcs = [
-        "src/ray/thirdparty/sha256.c",
-    ],
-    hdrs = [
-        "src/ray/thirdparty/sha256.h",
-    ],
-)
-
-ray_cc_library(
-    name = "aligned_alloc",
-    srcs = [
-        "src/ray/thirdparty/aligned_alloc.c",
-    ],
-    hdrs = [
-        "src/ray/thirdparty/aligned_alloc.h",
-    ],
-)
-
-ray_cc_library(
-    name = "dlmalloc",
-    hdrs = ["src/ray/thirdparty/dlmalloc.c"],
-)
-
 alias(
     name = "hiredis",
     actual = "@com_github_redis_hiredis//:hiredis",
@@ -983,6 +958,7 @@ pyx_library(
         "//src/ray/util:memory",
         "//src/ray/util:stream_redirection",
         "//src/ray/util:stream_redirection_options",
+        "//src/ray/thirdparty/setproctitle:setproctitle",
     ],
 )
 

LICENSE

@@ -480,3 +480,36 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+--------------------------------------------------------------------------------
+
+Code in src/ray/thirdparty/setproctitle is adapted from https://github.com/dvarrazzo/py-setproctitle
+
+BSD 3-Clause License
+
+Copyright (c) 2009, Daniele Varrazzo <daniele.varrazzo@gmail.com>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ci/env/install-dependencies.sh

@@ -415,7 +415,7 @@ install_thirdparty_packages() {
   fi
   mkdir -p "${WORKSPACE_DIR}/python/ray/thirdparty_files"
   RAY_THIRDPARTY_FILES="$(realpath "${WORKSPACE_DIR}/python/ray/thirdparty_files")"
-  CC=gcc python -m pip install psutil==5.9.6 setproctitle==1.2.2 colorama==0.4.6 --target="${RAY_THIRDPARTY_FILES}"
+  CC=gcc python -m pip install psutil==5.9.6 colorama==0.4.6 --target="${RAY_THIRDPARTY_FILES}"
 }
 
 install_dependencies() {

ci/env/install-toolchains.sh

@@ -51,7 +51,7 @@ install_clang() {
 }
 
 install_toolchains() {
-  local uses_clang=1 some_lightweight_target="//:sha256"
+  local uses_clang=1 some_lightweight_target="//src/ray/thirdparty:sha256"
   if bazel aquery --config=get-toolchain --output=textproto "${some_lightweight_target}" |
      grep "external_Slocal_Uconfig_Ucc_Cmsvc_Ucompiler_Ufiles" > /dev/null; then
     # We detected that we use MSVC, not Clang

ci/lint/check_import_order.py

@@ -1,7 +1,7 @@
 """
 This script ensures python files conform to ray's import ordering rules.
-In particular, we make sure psutil and setproctitle is imported _after_
-importing ray due to our bundling of the two libraries.
+In particular, we make sure psutil is imported _after_
+importing ray due to our bundling of the library.
 
 Usage:
 $ python check_import_order.py SOURCE_DIR -s SKIP_DIR
@@ -19,7 +19,7 @@
 
 
 def check_import(file):
-    check_to_lines = {"import ray": -1, "import psutil": -1, "import setproctitle": -1}
+    check_to_lines = {"import ray": -1, "import psutil": -1}
 
     with io.open(file, "r", encoding="utf-8") as f:
         for i, line in enumerate(f):
@@ -39,7 +39,7 @@ def check_import(file):
                 ):
                     check_to_lines[check] = i
 
-    for import_lib in ["import psutil", "import setproctitle"]:
+    for import_lib in ["import psutil"]:
         if check_to_lines[import_lib] != -1:
             import_psutil_line = check_to_lines[import_lib]
             import_ray_line = check_to_lines["import ray"]

ci/lint/format.sh

@@ -353,7 +353,7 @@ fi
 check_docstyle
 
 # Ensure import ordering
-# Make sure that for every import psutil; import setproctitle
+# Make sure that for every import psutil
 # There's a import ray above it.
 
 PYTHON_EXECUTABLE=${PYTHON_EXECUTABLE:-python}

doc/source/ray-contribute/development.rst

@@ -448,4 +448,4 @@ Then you should run the following commands:
 .. code-block:: bash
 
   rm -rf python/ray/thirdparty_files/
-  python3 -m pip install setproctitle
+  python3 -m pip install psutil

doc/source/ray-core/miscellaneous.rst

@@ -67,11 +67,11 @@ And specify a name for tasks (and actor methods too) at task submission time:
 
 .. testcode::
 
-   import setproctitle
+   import psutil
 
    @ray.remote
    def f(x):
-      assert setproctitle.getproctitle() == "ray::special_f"
+      assert psutil.Process().cmdline()[0] == "ray::special_f"
       return x + 1
 
    obj = f.options(name="special_f").remote(3)