fleet_executor.h

// Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once
#include <memory>
#include <string>

#include "paddle/fluid/distributed/fleet_executor/carrier.h"
#include "paddle/fluid/distributed/fleet_executor/fleet_executor_desc.pb.h"
#include "paddle/fluid/platform/macros.h"
#include "paddle/fluid/platform/place.h"

namespace paddle {
namespace framework {
class ProgramDesc;
class Scope;
}

namespace distributed {
class RuntimeGraph;
class MessageBus;
class TaskNode;

class FleetExecutor final {
 public:
  FleetExecutor() = delete;
  explicit FleetExecutor(const std::string& exe_desc_str);
  ~FleetExecutor();
  void Init(const framework::ProgramDesc& program_desc, framework::Scope* scope,
            const platform::Place& place,
            const std::vector<TaskNode*>& task_nodes,
            const std::unordered_map<int64_t, int64_t>& task_id_to_rank);
  void Run();
  // TODO(liyurui): Change to use registry table for multi-carrier.
  static Carrier* GetCarrier();
  template <typename... Args>
  static Carrier* CreateCarrier(Args&&... args) {
    PADDLE_ENFORCE_EQ(
        carrier_.get(), nullptr,
        platform::errors::AlreadyExists("Carrier has been created already."));
    carrier_ = std::make_unique<Carrier>(std::forward<Args>(args)...);
    return carrier_.get();
  }

 private:
  DISABLE_COPY_AND_ASSIGN(FleetExecutor);
  void InitMessageBus();
  void InitCarrier();
  void CopyParameters(int microbatch_id, const framework::ProgramDesc& program);
  FleetExecutorDesc exe_desc_;
  std::shared_ptr<RuntimeGraph> runtime_graph_;
  framework::Scope* root_scope_;
  framework::Scope* minibatch_scope_;
  platform::Place place_;
  std::vector<framework::Scope*> microbatch_scopes_;
  // The carriers under FleetExecutor will share message bus,
  // using shared_ptr to manage lifetime and condition race.
  std::shared_ptr<MessageBus> msg_bus_;
  static std::unique_ptr<Carrier> carrier_;
};

}  // namespace distributed
}  // namespace paddle