[ID Refactor] Refactor ActorID, TaskID and ObjectID (#5286)

* Refactor ActorID, TaskID on the Java side. Left a TODO comment WIP for ObjectID ADD test Fix Add java part Fix Java test Fix Refine test. Enable test in CI * Extra a helper function. * Resolve TODOs * Fix Python CI * Fix Java lint * Update .travis.yml Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Address some comments. Address some comments. Add id_specification.rst Reanme id_specification.rst to id_specification.md typo Address zhijun's comments. Fix test Address comments. Fix lint Address comments * Fix test * Address comments. * Fix build error * Update src/ray/design_docs/id_specification.md Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Update src/ray/design_docs/id_specification.md Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Update src/ray/design_docs/id_specification.md Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Update src/ray/design_docs/id_specification.md Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Update src/ray/design_docs/id_specification.md Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Address comments * Update src/ray/common/id.h Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Update src/ray/common/id.h Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Update src/ray/common/id.h Co-Authored-By: Stephanie Wang <swang@cs.berkeley.edu> * Update src/ray/design_docs/id_specification.md Co-Authored-By: Hao Chen <chenh1024@gmail.com> * Update src/ray/design_docs/id_specification.md Co-Authored-By: Hao Chen <chenh1024@gmail.com> * Address comments. * Address comments. * Address comments. * Update C++ part to make sure task id is generated determantic * WIP * Fix core worker * Fix Java part * Fix comments. * Add Python side * Fix python * Address comments * Fix linting * Fix * Fix C++ linting * Add JobId() method to TaskID * Fix linting * Update src/ray/common/id.h Co-Authored-By: Hao Chen <chenh1024@gmail.com> * Update java/api/src/main/java/org/ray/api/id/TaskId.java Co-Authored-By: Hao Chen <chenh1024@gmail.com> * Update java/api/src/main/java/org/ray/api/id/TaskId.java Co-Authored-By: Hao Chen <chenh1024@gmail.com> * Update java/api/src/main/java/org/ray/api/id/ActorId.java Co-Authored-By: Hao Chen <chenh1024@gmail.com> * Address comments * Add DriverTaskId embeding job id * Fix tests * Add python dor_fake_driver_id * Address comments and fix linting * Fix CI
2026-06-28 03:02:56 +08:00 · 2019-08-07 11:04:51 +08:00
parent 50b93bf179
commit d372f24e3c
71 changed files with 1368 additions and 586 deletions
@@ -86,10 +86,10 @@ cdef VectorToObjectIDs(c_vector[CObjectID] object_ids):


 def compute_put_id(TaskID task_id, int64_t put_index):
-    if put_index < 1 or put_index > kMaxTaskPuts:
+    if put_index < 1 or put_index > CObjectID.MaxObjectIndex():
        raise ValueError("The range of 'put_index' should be [1, %d]"
-                         % kMaxTaskPuts)
-    return ObjectID(CObjectID.ForPut(task_id.native(), put_index).Binary())
+                         % CObjectID.MaxObjectIndex())
+    return ObjectID(CObjectID.ForPut(task_id.native(), put_index, 0).Binary())


 def compute_task_id(ObjectID object_id):
@@ -310,7 +310,8 @@ class ActorClass(object):
            raise Exception("Actors cannot be created before ray.init() "
                            "has been called.")

-        actor_id = ActorID.from_random()
+        actor_id = ActorID.of(worker.current_job_id, worker.current_task_id,
+                              worker.task_context.task_index + 1)
        # The actor cursor is a dummy object representing the most recent
        # actor method invocation. For each subsequent method invocation,
        # the current cursor should be added as a dependency, and then
@@ -78,8 +78,9 @@ cdef extern from "ray/common/task/task_spec.h" namespace "ray" nogil:
 cdef extern from "ray/common/task/task_util.h" namespace "ray" nogil:
    cdef cppclass TaskSpecBuilder "ray::TaskSpecBuilder":
        TaskSpecBuilder &SetCommonTaskSpec(
-            const CLanguage &language, const c_vector[c_string] &function_descriptor,
-            const CJobID &job_id, const CTaskID &parent_task_id, uint64_t parent_counter,
+            const CTaskID &task_id, const CLanguage &language,
+            const c_vector[c_string] &function_descriptor, const CJobID &job_id,
+            const CTaskID &parent_task_id, uint64_t parent_counter,
            uint64_t num_returns, const unordered_map[c_string, double] &required_resources,
            const unordered_map[c_string, double] &required_placement_resources)

@@ -19,7 +19,7 @@ cdef class TaskSpec:
    cdef:
        unique_ptr[CTaskSpec] task_spec

-    def __init__(self, JobID job_id, function_descriptor, arguments,
+    def __init__(self, TaskID task_id, JobID job_id, function_descriptor, arguments,
                 int num_returns, TaskID parent_task_id, int parent_counter,
                 ActorID actor_creation_id,
                 ObjectID actor_creation_dummy_object_id,
@@ -51,6 +51,7 @@ cdef class TaskSpec:

        # Build common task spec.
        builder.SetCommonTaskSpec(
+            task_id.native(),
            LANGUAGE_PYTHON,
            c_function_descriptor,
            job_id.native(),
@@ -53,11 +53,21 @@ cdef extern from "ray/common/id.h" namespace "ray" nogil:
        @staticmethod
        CActorClassID FromBinary(const c_string &binary)

-    cdef cppclass CActorID "ray::ActorID"(CUniqueID):
+    cdef cppclass CActorID "ray::ActorID"(CBaseID[CActorID]):

        @staticmethod
        CActorID FromBinary(const c_string &binary)

+        @staticmethod
+        const CActorID Nil()
+
+        @staticmethod
+        size_t Size()
+
+        @staticmethod
+        CActorID Of(CJobID job_id, CTaskID parent_task_id, int64_t parent_task_counter)
+
+
    cdef cppclass CActorHandleID "ray::ActorHandleID"(CUniqueID):

        @staticmethod
@@ -103,8 +113,26 @@ cdef extern from "ray/common/id.h" namespace "ray" nogil:
        @staticmethod
        size_t Size()

+        @staticmethod
+        CTaskID ForDriverTask(const CJobID &job_id)
+
+        @staticmethod
+        CTaskID ForFakeTask()
+
+        @staticmethod
+        CTaskID ForActorCreationTask(CActorID actor_id)
+
+        @staticmethod
+        CTaskID ForActorTask(CJobID job_id, CTaskID parent_task_id, int64_t parent_task_counter, CActorID actor_id)
+
+        @staticmethod
+        CTaskID ForNormalTask(CJobID job_id, CTaskID parent_task_id, int64_t parent_task_counter)
+
    cdef cppclass CObjectID" ray::ObjectID"(CBaseID[CObjectID]):

+        @staticmethod
+        int64_t MaxObjectIndex()
+
        @staticmethod
        CObjectID FromBinary(const c_string &binary)

@@ -112,7 +140,7 @@ cdef extern from "ray/common/id.h" namespace "ray" nogil:
        const CObjectID Nil()

        @staticmethod
-        CObjectID ForPut(const CTaskID &task_id, int64_t index);
+        CObjectID ForPut(const CTaskID &task_id, int64_t index, int64_t transport_type);

        @staticmethod
        CObjectID ForTaskReturn(const CTaskID &task_id, int64_t index);
@@ -36,7 +36,6 @@ def check_id(b, size=kUniqueIDSize):

 cdef extern from "ray/common/constants.h" nogil:
    cdef int64_t kUniqueIDSize
-    cdef int64_t kMaxTaskPuts


 cdef class BaseID:
@@ -151,6 +150,9 @@ cdef class ObjectID(BaseID):
    def is_nil(self):
        return self.data.IsNil()

+    def task_id(self):
+        return TaskID(self.data.TaskId().Binary())
+
    cdef size_t hash(self):
        return self.data.Hash()

@@ -197,9 +199,35 @@ cdef class TaskID(BaseID):
        return CTaskID.Size()

    @classmethod
-    def from_random(cls):
-        return cls(os.urandom(CTaskID.Size()))
+    def for_fake_task(cls):
+        return cls(CTaskID.ForFakeTask().Binary())

+    @classmethod
+    def for_driver_task(cls, job_id):
+        return cls(CTaskID.ForDriverTask(CJobID.FromBinary(job_id.binary())).Binary())
+
+    @classmethod
+    def for_actor_creation_task(cls, actor_id):
+        assert isinstance(actor_id, ActorID)
+        return cls(CTaskID.ForActorCreationTask(CActorID.FromBinary(actor_id.binary())).Binary())
+
+    @classmethod
+    def for_actor_task(cls, job_id, parent_task_id, parent_task_counter, actor_id):
+        assert isinstance(job_id, JobID)
+        assert isinstance(parent_task_id, TaskID)
+        assert isinstance(actor_id, ActorID)
+        return cls(CTaskID.ForActorTask(CJobID.FromBinary(job_id.binary()),
+                                        CTaskID.FromBinary(parent_task_id.binary()),
+                                        parent_task_counter,
+                                        CActorID.FromBinary(actor_id.binary())).Binary())
+
+    @classmethod
+    def for_normal_task(cls, job_id, parent_task_id, parent_task_counter):
+        assert isinstance(job_id, JobID)
+        assert isinstance(parent_task_id, TaskID)
+        return cls(CTaskID.ForNormalTask(CJobID.FromBinary(job_id.binary()),
+                                         CTaskID.FromBinary(parent_task_id.binary()),
+                                         parent_task_counter).Binary())

 cdef class ClientID(UniqueID):

@@ -257,15 +285,47 @@ cdef class WorkerID(UniqueID):
    cdef CWorkerID native(self):
        return <CWorkerID>self.data

-cdef class ActorID(UniqueID):
+cdef class ActorID(BaseID):
+    cdef CActorID data

    def __init__(self, id):
-        check_id(id)
+        check_id(id, CActorID.Size())
        self.data = CActorID.FromBinary(<c_string>id)

    cdef CActorID native(self):
        return <CActorID>self.data

+    @classmethod
+    def of(cls, job_id, parent_task_id, parent_task_counter):
+        assert isinstance(job_id, JobID)
+        assert isinstance(parent_task_id, TaskID)
+        return cls(CActorID.Of(CJobID.FromBinary(job_id.binary()),
+                               CTaskID.FromBinary(parent_task_id.binary()),
+                               parent_task_counter).Binary())
+
+    @classmethod
+    def nil(cls):
+        return cls(CActorID.Nil().Binary())
+
+    @classmethod
+    def size(cls):
+        return CActorID.Size()
+
+    def binary(self):
+        return self.data.Binary()
+
+    def hex(self):
+        return decode(self.data.Hex())
+
+    def size(self):
+        return CActorID.Size()
+
+    def is_nil(self):
+        return self.data.IsNil()
+
+    cdef size_t hash(self):
+        return self.data.Hash()
+

 cdef class ActorHandleID(UniqueID):

@@ -2520,13 +2520,14 @@ def test_global_state_api(shutdown_only):
    assert len(task_table) == 1
    assert driver_task_id == list(task_table.keys())[0]
    task_spec = task_table[driver_task_id]["TaskSpec"]
-    nil_id_hex = ray.ObjectID.nil().hex()
+    nil_unique_id_hex = ray.UniqueID.nil().hex()
+    nil_actor_id_hex = ray.ActorID.nil().hex()

    assert task_spec["TaskID"] == driver_task_id
-    assert task_spec["ActorID"] == nil_id_hex
+    assert task_spec["ActorID"] == nil_actor_id_hex
    assert task_spec["Args"] == []
    assert task_spec["JobID"] == job_id.hex()
-    assert task_spec["FunctionID"] == nil_id_hex
+    assert task_spec["FunctionID"] == nil_unique_id_hex
    assert task_spec["ReturnObjectIDs"] == []

    client_table = ray.nodes()
@@ -2551,7 +2552,7 @@ def test_global_state_api(shutdown_only):
    task_id = list(task_id_set)[0]

    task_spec = task_table[task_id]["TaskSpec"]
-    assert task_spec["ActorID"] == nil_id_hex
+    assert task_spec["ActorID"] == nil_actor_id_hex
    assert task_spec["Args"] == [1, "hi", x_id]
    assert task_spec["JobID"] == job_id.hex()
    assert task_spec["ReturnObjectIDs"] == [result_id]
@@ -200,7 +200,7 @@ class Worker(object):
                # to the current task ID may not be correct. Generate a
                # random task ID so that the backend can differentiate
                # between different threads.
-                self._task_context.current_task_id = TaskID.from_random()
+                self._task_context.current_task_id = TaskID.for_fake_task()
                if getattr(self, "_multithreading_warned", False) is not True:
                    logger.warning(
                        "Calling ray.get or ray.wait in a separate thread "
@@ -718,7 +718,24 @@ class Worker(object):
            function_descriptor_list = (
                function_descriptor.get_function_descriptor_list())
            assert isinstance(job_id, JobID)
+
+            if actor_creation_id is not None and not actor_creation_id.is_nil(
+            ):
+                # This is an actor creation task.
+                task_id = TaskID.for_actor_creation_task(actor_creation_id)
+            elif actor_id is not None and not actor_id.is_nil():
+                # This is an actor task.
+                task_id = TaskID.for_actor_task(
+                    self.current_job_id, self.current_task_id,
+                    self.task_context.task_index, actor_id)
+            else:
+                # This is a normal task.
+                task_id = TaskID.for_normal_task(self.current_job_id,
+                                                 self.current_task_id,
+                                                 self.task_context.task_index)
+
            task = ray._raylet.TaskSpec(
+                task_id,
                job_id,
                function_descriptor_list,
                args_for_raylet,
@@ -1917,6 +1934,7 @@ def connect(node,

        function_descriptor = FunctionDescriptor.for_driver_task()
        driver_task_spec = ray._raylet.TaskSpec(
+            TaskID.for_driver_task(worker.current_job_id),
            worker.current_job_id,
            function_descriptor.get_function_descriptor_list(),
            [],  # arguments.