2018-12-31 20:04:05 +01:00
|
|
|
//
|
2024-01-01 01:07:21 +01:00
|
|
|
// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2024
|
2018-12-31 20:04:05 +01:00
|
|
|
//
|
|
|
|
// Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
|
|
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
|
|
//
|
|
|
|
#pragma once
|
2019-02-13 00:29:52 +01:00
|
|
|
|
2018-12-31 20:04:05 +01:00
|
|
|
#include "td/actor/impl/Actor-decl.h"
|
|
|
|
#include "td/actor/impl/ActorId-decl.h"
|
|
|
|
#include "td/actor/impl/EventFull-decl.h"
|
|
|
|
|
|
|
|
#include "td/utils/Closure.h"
|
2022-07-14 17:38:48 +02:00
|
|
|
#include "td/utils/common.h"
|
2022-02-09 15:05:27 +01:00
|
|
|
#include "td/utils/FlatHashMap.h"
|
2018-12-31 20:04:05 +01:00
|
|
|
#include "td/utils/Heap.h"
|
|
|
|
#include "td/utils/List.h"
|
2020-10-08 17:30:36 +02:00
|
|
|
#include "td/utils/logging.h"
|
2018-12-31 20:04:05 +01:00
|
|
|
#include "td/utils/MovableValue.h"
|
|
|
|
#include "td/utils/MpscPollableQueue.h"
|
|
|
|
#include "td/utils/ObjectPool.h"
|
2018-09-07 02:41:21 +02:00
|
|
|
#include "td/utils/port/detail/PollableFd.h"
|
2018-12-31 20:04:05 +01:00
|
|
|
#include "td/utils/port/Poll.h"
|
2018-09-10 03:08:15 +02:00
|
|
|
#include "td/utils/port/PollFlags.h"
|
2018-12-31 20:04:05 +01:00
|
|
|
#include "td/utils/port/thread_local.h"
|
2022-06-29 23:28:25 +02:00
|
|
|
#include "td/utils/Promise.h"
|
2018-12-31 20:04:05 +01:00
|
|
|
#include "td/utils/Slice.h"
|
2018-09-18 15:43:16 +02:00
|
|
|
#include "td/utils/Time.h"
|
2018-12-31 20:04:05 +01:00
|
|
|
#include "td/utils/type_traits.h"
|
|
|
|
|
|
|
|
#include <functional>
|
|
|
|
#include <memory>
|
|
|
|
#include <type_traits>
|
|
|
|
#include <utility>
|
|
|
|
|
|
|
|
namespace td {
|
2018-07-03 21:29:04 +02:00
|
|
|
|
2020-10-05 17:07:23 +02:00
|
|
|
extern int VERBOSITY_NAME(actor);
|
|
|
|
|
2018-12-31 20:04:05 +01:00
|
|
|
class ActorInfo;
|
2018-07-03 21:29:04 +02:00
|
|
|
|
2018-12-31 20:04:05 +01:00
|
|
|
class Scheduler;
|
|
|
|
class SchedulerGuard {
|
|
|
|
public:
|
2018-08-16 15:56:16 +02:00
|
|
|
explicit SchedulerGuard(Scheduler *scheduler, bool lock = true);
|
2018-12-31 20:04:05 +01:00
|
|
|
~SchedulerGuard();
|
2023-05-05 12:51:19 +02:00
|
|
|
SchedulerGuard(const SchedulerGuard &) = delete;
|
|
|
|
SchedulerGuard &operator=(const SchedulerGuard &) = delete;
|
|
|
|
SchedulerGuard(SchedulerGuard &&) = default;
|
|
|
|
SchedulerGuard &operator=(SchedulerGuard &&) = delete;
|
2018-12-31 20:04:05 +01:00
|
|
|
|
|
|
|
private:
|
|
|
|
MovableValue<bool> is_valid_ = true;
|
2018-08-16 15:56:16 +02:00
|
|
|
bool is_locked_;
|
2018-12-31 20:04:05 +01:00
|
|
|
Scheduler *scheduler_;
|
|
|
|
ActorContext *save_context_;
|
|
|
|
Scheduler *save_scheduler_;
|
|
|
|
const char *save_tag_;
|
|
|
|
};
|
|
|
|
|
|
|
|
class Scheduler {
|
|
|
|
public:
|
|
|
|
class Callback {
|
|
|
|
public:
|
|
|
|
Callback() = default;
|
|
|
|
Callback(const Callback &) = delete;
|
|
|
|
Callback &operator=(const Callback &) = delete;
|
|
|
|
virtual ~Callback() = default;
|
|
|
|
virtual void on_finish() = 0;
|
|
|
|
virtual void register_at_finish(std::function<void()>) = 0;
|
|
|
|
};
|
|
|
|
Scheduler() = default;
|
|
|
|
Scheduler(const Scheduler &) = delete;
|
|
|
|
Scheduler &operator=(const Scheduler &) = delete;
|
|
|
|
Scheduler(Scheduler &&) = delete;
|
|
|
|
Scheduler &operator=(Scheduler &&) = delete;
|
|
|
|
~Scheduler();
|
|
|
|
|
|
|
|
void init(int32 id, std::vector<std::shared_ptr<MpscPollableQueue<EventFull>>> outbound, Callback *callback);
|
|
|
|
|
|
|
|
int32 sched_id() const;
|
|
|
|
int32 sched_count() const;
|
|
|
|
|
|
|
|
template <class ActorT, class... Args>
|
2021-12-09 22:27:13 +01:00
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> create_actor(Slice name, Args &&...args);
|
2018-12-31 20:04:05 +01:00
|
|
|
template <class ActorT, class... Args>
|
2021-12-09 22:27:13 +01:00
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> create_actor_on_scheduler(Slice name, int32 sched_id, Args &&...args);
|
2018-12-31 20:04:05 +01:00
|
|
|
template <class ActorT>
|
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> register_actor(Slice name, ActorT *actor_ptr, int32 sched_id = -1);
|
|
|
|
template <class ActorT>
|
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> register_actor(Slice name, unique_ptr<ActorT> actor_ptr, int32 sched_id = -1);
|
|
|
|
|
|
|
|
template <class ActorT>
|
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> register_existing_actor(unique_ptr<ActorT> actor_ptr);
|
|
|
|
|
|
|
|
void send_to_scheduler(int32 sched_id, const ActorId<> &actor_id, Event &&event);
|
|
|
|
void send_to_other_scheduler(int32 sched_id, const ActorId<> &actor_id, Event &&event);
|
|
|
|
|
2022-06-29 23:28:25 +02:00
|
|
|
void run_on_scheduler(int32 sched_id, Promise<Unit> action); // TODO Action
|
|
|
|
|
2022-07-20 12:40:14 +02:00
|
|
|
template <class T>
|
|
|
|
void destroy_on_scheduler(int32 sched_id, T &value);
|
|
|
|
|
2024-05-02 20:35:25 +02:00
|
|
|
template <class T>
|
|
|
|
void destroy_on_scheduler_unique_ptr(int32 sched_id, T &value);
|
|
|
|
|
2022-07-22 20:21:30 +02:00
|
|
|
template <class... ArgsT>
|
|
|
|
void destroy_on_scheduler(int32 sched_id, ArgsT &...values);
|
|
|
|
|
2024-05-06 18:38:24 +02:00
|
|
|
template <class EventT>
|
|
|
|
void send_lambda_immediately(ActorRef actor_ref, EventT &&func);
|
|
|
|
|
|
|
|
template <class EventT>
|
|
|
|
void send_lambda_later(ActorRef actor_ref, EventT &&func);
|
|
|
|
|
|
|
|
template <class EventT>
|
|
|
|
void send_closure_immediately(ActorRef actor_ref, EventT &&closure);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
2024-05-06 18:38:24 +02:00
|
|
|
template <class EventT>
|
|
|
|
void send_closure_later(ActorRef actor_ref, EventT &&closure);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
2024-05-06 18:38:24 +02:00
|
|
|
void send_immediately(ActorRef actor_ref, Event &&event);
|
|
|
|
|
|
|
|
void send_later(ActorRef actor_ref, Event &&event);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
|
|
|
void before_tail_send(const ActorId<> &actor_id);
|
|
|
|
|
2018-09-11 00:20:41 +02:00
|
|
|
static void subscribe(PollableFd fd, PollFlags flags = PollFlags::ReadWrite());
|
|
|
|
static void unsubscribe(PollableFdRef fd);
|
|
|
|
static void unsubscribe_before_close(PollableFdRef fd);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
|
|
|
void yield_actor(Actor *actor);
|
|
|
|
void stop_actor(Actor *actor);
|
|
|
|
void do_stop_actor(Actor *actor);
|
|
|
|
uint64 get_link_token(Actor *actor);
|
|
|
|
void migrate_actor(Actor *actor, int32 dest_sched_id);
|
|
|
|
void do_migrate_actor(Actor *actor, int32 dest_sched_id);
|
|
|
|
void start_migrate_actor(Actor *actor, int32 dest_sched_id);
|
|
|
|
void finish_migrate_actor(Actor *actor);
|
|
|
|
|
2021-08-15 10:15:14 +02:00
|
|
|
double get_actor_timeout(const Actor *actor) const;
|
2018-12-31 20:04:05 +01:00
|
|
|
void set_actor_timeout_in(Actor *actor, double timeout);
|
|
|
|
void set_actor_timeout_at(Actor *actor, double timeout_at);
|
|
|
|
void cancel_actor_timeout(Actor *actor);
|
|
|
|
|
|
|
|
void finish();
|
|
|
|
void yield();
|
2018-09-18 15:43:16 +02:00
|
|
|
void run(Timestamp timeout);
|
|
|
|
void run_no_guard(Timestamp timeout);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
|
|
|
void wakeup();
|
|
|
|
|
|
|
|
static Scheduler *instance();
|
|
|
|
static ActorContext *&context();
|
|
|
|
static void on_context_updated();
|
|
|
|
|
|
|
|
SchedulerGuard get_guard();
|
2018-08-16 15:56:16 +02:00
|
|
|
SchedulerGuard get_const_guard();
|
2018-12-31 20:04:05 +01:00
|
|
|
|
2018-09-18 15:43:16 +02:00
|
|
|
Timestamp get_timeout();
|
|
|
|
|
2018-12-31 20:04:05 +01:00
|
|
|
private:
|
|
|
|
static void set_scheduler(Scheduler *scheduler);
|
2021-07-03 22:51:36 +02:00
|
|
|
|
2022-07-20 12:57:05 +02:00
|
|
|
void destroy_on_scheduler_impl(int32 sched_id, Promise<Unit> action);
|
|
|
|
|
2018-12-31 20:04:05 +01:00
|
|
|
class ServiceActor final : public Actor {
|
|
|
|
public:
|
|
|
|
void set_queue(std::shared_ptr<MpscPollableQueue<EventFull>> queues);
|
|
|
|
|
|
|
|
private:
|
|
|
|
std::shared_ptr<MpscPollableQueue<EventFull>> inbound_;
|
2018-08-16 15:56:16 +02:00
|
|
|
bool subscribed_{false};
|
2021-10-25 07:33:14 +02:00
|
|
|
|
|
|
|
void start_up() final;
|
2021-07-03 22:51:36 +02:00
|
|
|
void loop() final;
|
|
|
|
void tear_down() final;
|
2018-12-31 20:04:05 +01:00
|
|
|
};
|
|
|
|
friend class ServiceActor;
|
|
|
|
|
2023-03-27 17:08:06 +02:00
|
|
|
void clear();
|
|
|
|
|
2018-12-31 20:04:05 +01:00
|
|
|
void do_event(ActorInfo *actor, Event &&event);
|
|
|
|
|
|
|
|
void enter_actor(ActorInfo *actor_info);
|
|
|
|
void exit_actor(ActorInfo *actor_info);
|
|
|
|
|
|
|
|
void yield_actor(ActorInfo *actor_info);
|
|
|
|
void stop_actor(ActorInfo *actor_info);
|
|
|
|
void do_stop_actor(ActorInfo *actor_info);
|
|
|
|
uint64 get_link_token(ActorInfo *actor_info);
|
|
|
|
void migrate_actor(ActorInfo *actor_info, int32 dest_sched_id);
|
|
|
|
void do_migrate_actor(ActorInfo *actor_info, int32 dest_sched_id);
|
|
|
|
void start_migrate_actor(ActorInfo *actor_info, int32 dest_sched_id);
|
|
|
|
|
2021-08-15 10:15:14 +02:00
|
|
|
double get_actor_timeout(const ActorInfo *actor_info) const;
|
2018-12-31 20:04:05 +01:00
|
|
|
void set_actor_timeout_in(ActorInfo *actor_info, double timeout);
|
|
|
|
void set_actor_timeout_at(ActorInfo *actor_info, double timeout_at);
|
|
|
|
void cancel_actor_timeout(ActorInfo *actor_info);
|
|
|
|
|
|
|
|
void register_migrated_actor(ActorInfo *actor_info);
|
|
|
|
void add_to_mailbox(ActorInfo *actor_info, Event &&event);
|
|
|
|
void clear_mailbox(ActorInfo *actor_info);
|
|
|
|
|
2024-02-17 19:42:51 +01:00
|
|
|
void flush_mailbox(ActorInfo *actor_info);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
2024-05-06 18:38:24 +02:00
|
|
|
void get_actor_sched_id_to_send_immediately(const ActorInfo *actor_info, int32 &actor_sched_id,
|
|
|
|
bool &on_current_sched, bool &can_send_immediately);
|
|
|
|
|
|
|
|
void get_actor_sched_id_to_send_later(const ActorInfo *actor_info, int32 &actor_sched_id, bool &on_current_sched);
|
|
|
|
|
|
|
|
template <class RunFuncT, class EventFuncT>
|
|
|
|
void send_immediately_impl(const ActorId<> &actor_id, const RunFuncT &run_func, const EventFuncT &event_func);
|
2024-05-06 13:20:35 +02:00
|
|
|
|
2024-05-06 18:38:24 +02:00
|
|
|
template <class EventFuncT>
|
|
|
|
void send_later_impl(const ActorId<> &actor_id, const EventFuncT &event_func);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
2018-09-18 15:43:16 +02:00
|
|
|
Timestamp run_timeout();
|
2018-12-31 20:04:05 +01:00
|
|
|
void run_mailbox();
|
2021-10-06 16:16:23 +02:00
|
|
|
Timestamp run_events(Timestamp timeout);
|
2018-09-18 15:43:16 +02:00
|
|
|
void run_poll(Timestamp timeout);
|
2018-12-31 20:04:05 +01:00
|
|
|
|
|
|
|
template <class ActorT>
|
|
|
|
ActorOwn<ActorT> register_actor_impl(Slice name, ActorT *actor_ptr, Actor::Deleter deleter, int32 sched_id);
|
|
|
|
void destroy_actor(ActorInfo *actor_info);
|
|
|
|
|
|
|
|
static TD_THREAD_LOCAL Scheduler *scheduler_;
|
|
|
|
static TD_THREAD_LOCAL ActorContext *context_;
|
|
|
|
|
|
|
|
Callback *callback_ = nullptr;
|
2018-09-27 03:19:03 +02:00
|
|
|
unique_ptr<ObjectPool<ActorInfo>> actor_info_pool_;
|
2018-12-31 20:04:05 +01:00
|
|
|
|
2018-10-26 16:11:20 +02:00
|
|
|
int32 actor_count_ = 0;
|
2018-12-31 20:04:05 +01:00
|
|
|
ListNode pending_actors_list_;
|
|
|
|
ListNode ready_actors_list_;
|
|
|
|
KHeap<double> timeout_queue_;
|
|
|
|
|
2022-02-09 15:05:27 +01:00
|
|
|
FlatHashMap<ActorInfo *, std::vector<Event>> pending_events_;
|
2018-12-31 20:04:05 +01:00
|
|
|
|
|
|
|
ServiceActor service_actor_;
|
|
|
|
Poll poll_;
|
|
|
|
|
2018-10-26 16:11:20 +02:00
|
|
|
bool yield_flag_ = false;
|
2018-12-31 20:04:05 +01:00
|
|
|
bool has_guard_ = false;
|
|
|
|
bool close_flag_ = false;
|
|
|
|
|
2018-10-26 16:11:20 +02:00
|
|
|
int32 sched_id_ = 0;
|
|
|
|
int32 sched_n_ = 0;
|
2018-12-31 20:04:05 +01:00
|
|
|
std::shared_ptr<MpscPollableQueue<EventFull>> inbound_queue_;
|
|
|
|
std::vector<std::shared_ptr<MpscPollableQueue<EventFull>>> outbound_queues_;
|
|
|
|
|
|
|
|
std::shared_ptr<ActorContext> save_context_;
|
|
|
|
|
|
|
|
struct EventContext {
|
2018-10-26 16:11:20 +02:00
|
|
|
int32 dest_sched_id{0};
|
2018-12-31 20:04:05 +01:00
|
|
|
enum Flags { Stop = 1, Migrate = 2 };
|
|
|
|
int32 flags{0};
|
2018-10-26 16:11:20 +02:00
|
|
|
uint64 link_token{0};
|
2018-12-31 20:04:05 +01:00
|
|
|
|
2018-10-26 16:11:20 +02:00
|
|
|
ActorInfo *actor_info{nullptr};
|
2018-12-31 20:04:05 +01:00
|
|
|
};
|
2018-10-26 16:11:20 +02:00
|
|
|
EventContext *event_context_ptr_{nullptr};
|
2018-12-31 20:04:05 +01:00
|
|
|
|
|
|
|
friend class GlobalScheduler;
|
|
|
|
friend class SchedulerGuard;
|
|
|
|
friend class EventGuard;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*** Interface to current scheduler ***/
|
|
|
|
template <class ActorT, class... Args>
|
2021-12-09 22:27:13 +01:00
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> create_actor(Slice name, Args &&...args);
|
2018-12-31 20:04:05 +01:00
|
|
|
template <class ActorT, class... Args>
|
2021-12-09 22:27:13 +01:00
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> create_actor_on_scheduler(Slice name, int32 sched_id, Args &&...args);
|
2018-12-31 20:04:05 +01:00
|
|
|
template <class ActorT>
|
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> register_actor(Slice name, ActorT *actor_ptr, int32 sched_id = -1);
|
|
|
|
template <class ActorT>
|
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> register_actor(Slice name, unique_ptr<ActorT> actor_ptr, int32 sched_id = -1);
|
|
|
|
|
|
|
|
template <class ActorT>
|
|
|
|
TD_WARN_UNUSED_RESULT ActorOwn<ActorT> register_existing_actor(unique_ptr<ActorT> actor_ptr);
|
|
|
|
|
|
|
|
template <class ActorIdT, class FunctionT, class... ArgsT>
|
2021-12-09 22:27:13 +01:00
|
|
|
void send_closure(ActorIdT &&actor_id, FunctionT function, ArgsT &&...args) {
|
2018-12-31 20:04:05 +01:00
|
|
|
using ActorT = typename std::decay_t<ActorIdT>::ActorT;
|
|
|
|
using FunctionClassT = member_function_class_t<FunctionT>;
|
|
|
|
static_assert(std::is_base_of<FunctionClassT, ActorT>::value, "unsafe send_closure");
|
|
|
|
|
2024-05-06 18:38:24 +02:00
|
|
|
Scheduler::instance()->send_closure_immediately(std::forward<ActorIdT>(actor_id),
|
|
|
|
create_immediate_closure(function, std::forward<ArgsT>(args)...));
|
2018-12-31 20:04:05 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
template <class ActorIdT, class FunctionT, class... ArgsT>
|
2021-12-09 22:27:13 +01:00
|
|
|
void send_closure_later(ActorIdT &&actor_id, FunctionT function, ArgsT &&...args) {
|
2018-12-31 20:04:05 +01:00
|
|
|
using ActorT = typename std::decay_t<ActorIdT>::ActorT;
|
|
|
|
using FunctionClassT = member_function_class_t<FunctionT>;
|
|
|
|
static_assert(std::is_base_of<FunctionClassT, ActorT>::value, "unsafe send_closure");
|
|
|
|
|
2024-05-06 18:38:24 +02:00
|
|
|
Scheduler::instance()->send_later(std::forward<ActorIdT>(actor_id),
|
|
|
|
Event::delayed_closure(function, std::forward<ArgsT>(args)...));
|
2018-12-31 20:04:05 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
template <class... ArgsT>
|
2021-12-09 22:27:13 +01:00
|
|
|
void send_lambda(ActorRef actor_ref, ArgsT &&...args) {
|
2024-05-06 18:38:24 +02:00
|
|
|
Scheduler::instance()->send_lambda_immediately(actor_ref, std::forward<ArgsT>(args)...);
|
2018-12-31 20:04:05 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
template <class... ArgsT>
|
2021-12-09 22:27:13 +01:00
|
|
|
void send_event(ActorRef actor_ref, ArgsT &&...args) {
|
2024-05-06 18:38:24 +02:00
|
|
|
Scheduler::instance()->send_immediately(actor_ref, std::forward<ArgsT>(args)...);
|
2018-12-31 20:04:05 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
template <class... ArgsT>
|
2021-12-09 22:27:13 +01:00
|
|
|
void send_event_later(ActorRef actor_ref, ArgsT &&...args) {
|
2024-05-06 18:38:24 +02:00
|
|
|
Scheduler::instance()->send_later(actor_ref, std::forward<ArgsT>(args)...);
|
2018-12-31 20:04:05 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace td
|