paddlepaddle--paddle/paddle/phi/common/place.cc

/* Copyright (c) 2022 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. */

#include "paddle/phi/common/place.h"

#include <sstream>
#include <string>

#include "glog/logging.h"
#include "paddle/common/exception.h"
#include "paddle/phi/backends/device_manager.h"
#include "paddle/phi/backends/gpu/gpu_info.h"
#include "paddle/phi/backends/xpu/xpu_info.h"

namespace phi {

const char *AllocationTypeStr(AllocationType type) {
  switch (type) {
    case AllocationType::UNDEFINED:
      return "undefined";
    case AllocationType::CPU:
      return "cpu";
    case AllocationType::GPU:
      return "gpu";
    case AllocationType::GPUPINNED:
      return "gpu_pinned";
    case AllocationType::XPU:
      return "xpu";
    case AllocationType::XPUPINNED:
      return "xpu_pinned";
    case AllocationType::IPU:
      return "ipu";
    case AllocationType::CUSTOM:
      return "custom_device";
    default:
      PD_THROW("Invalid phi device type.");
      return {};
  }
}

std::ostream &operator<<(std::ostream &os, AllocationType type) {
  os << AllocationTypeStr(type);
  return os;
}

bool operator==(AllocationType lhs, AllocationType rhs) {
  return static_cast<int>(lhs) == static_cast<int>(rhs);
}

Place::Place(AllocationType type, const std::string &dev_type)
    : device(0),
      alloc_type_(type),
      device_type_id_(phi::CustomRegisteredDeviceMap::Instance()
                          .GetOrRegisterGlobalDeviceTypeId(dev_type)) {}

std::string Place::DebugString() const {
  std::ostringstream os;
  os << "Place(";
  if (alloc_type_ == AllocationType::CUSTOM) {
    os << phi::CustomRegisteredDeviceMap::Instance().GetGlobalDeviceType(
        device_type_id_);
  } else {
    os << AllocationTypeStr(alloc_type_);
  }
  if (alloc_type_ == AllocationType::GPUPINNED ||
      alloc_type_ == AllocationType::XPUPINNED ||
      alloc_type_ == AllocationType::CPU) {
    os << ")";
  } else {
    os << ":" << std::to_string(device) << ")";
  }
  return os.str();
}

std::ostream &operator<<(std::ostream &os, const Place &p) {
  os << p.DebugString();
  return os;
}

Place GetPinnedPlace(const Place &place) {
  switch (place.GetType()) {
    case AllocationType::GPU:
      VLOG(10) << "GPUPinnedPlace";
      return phi::GPUPinnedPlace();
      break;
    case AllocationType::XPU:
      VLOG(10) << "XPUPinnedPlace";
      return phi::XPUPinnedPlace();
      break;
    default:
      VLOG(10) << "Not GPU/XPU PinnedPlace";
      return place;
  }
}

CustomRegisteredDeviceMap &CustomRegisteredDeviceMap::Instance() {
  static CustomRegisteredDeviceMap g_custom_registered_device_map;
  return g_custom_registered_device_map;
}

size_t CustomRegisteredDeviceMap::GetOrRegisterGlobalDeviceTypeId(
    const std::string &device_type) {
  if (device_type.empty()) return 0;
  if (registered_device_type_id_.find(device_type) ==
      registered_device_type_id_.end()) {
    size_t device_type_id = registered_device_type_id_.size() + 1;
    registered_device_type_id_[device_type] = device_type_id;
    registered_device_type_[device_type_id] = device_type;
  }
  return registered_device_type_id_[device_type];
}

std::string CustomRegisteredDeviceMap::GetGlobalDeviceType(
    size_t device_type_id) {
  if (registered_device_type_.find(device_type_id) ==
      registered_device_type_.end())
    return "";
  return registered_device_type_[device_type_id];
}

constexpr static int kAllocationTypeBitLength = 8;
constexpr static int kDeviceTypeIDBitLength = 8;
constexpr static int kDeviceIDBitLength = 8;

uint32_t Place::Hash::operator()(const Place &place) const {
  uint32_t hash_value = 0;
  // |----31-24------|-----23-16------|-----15-08----|---7-0----|
  // | For extension | AllocationType | DeviceTypeID | DeviceID |
  hash_value |= (static_cast<uint8_t>(place.alloc_type_)
                 << (kDeviceIDBitLength + kDeviceTypeIDBitLength));
  hash_value |=
      (static_cast<uint8_t>(place.device_type_id_) << kDeviceIDBitLength);
  hash_value |= static_cast<uint8_t>(place.device);
  return hash_value;
}

namespace detail {
static int8_t GetCorrectDeviceIdByPlaceType(
    const paddle::PlaceType &place_type) {
  switch (place_type) {
    case paddle::PlaceType::kCPU:
      return 0;
#if defined(PADDLE_WITH_CUDA) || defined(PADDLE_WITH_HIP)
    case paddle::PlaceType::kGPU:
      return static_cast<int8_t>(phi::backends::gpu::GetCurrentDeviceId());
#endif
    default:
      PD_THROW(
          "The PlaceType is a legacy design, only supports CPU and GPU, "
          "and will not support other place types in the future.");
  }
}
}  // namespace detail

Place::Place(paddle::PlaceType type)
    : device(detail::GetCorrectDeviceIdByPlaceType(type)),
      alloc_type_(static_cast<AllocationType>(type)),
      device_type_id_(
          CustomRegisteredDeviceMap::Instance().GetOrRegisterGlobalDeviceTypeId(
              "")) {
  LOG_FIRST_N(WARNING, 1)
      << "The `paddle::PlaceType::kCPU/kGPU` is deprecated since version "
         "2.3, and will be removed in version 2.4! Please use "
         "`paddle::CPUPlace()/DefaultGPUPlace()` to represent the place type.";
}

TEST_API bool is_gpu_place(const Place &p) {
  return p.GetType() == phi::AllocationType::GPU;
}

bool is_xpu_place(const Place &p) {
  return p.GetType() == phi::AllocationType::XPU;
}

bool is_ipu_place(const Place &p) {
  return p.GetType() == phi::AllocationType::IPU;
}

TEST_API bool is_cpu_place(const Place &p) {
  return p.GetType() == phi::AllocationType::CPU;
}

bool is_pinned_place(const Place &p) {
  return p.GetType() == phi::AllocationType::GPUPINNED ||
         p.GetType() == phi::AllocationType::XPUPINNED;
}

bool is_cuda_pinned_place(const Place &p) {
  return p.GetType() == phi::AllocationType::GPUPINNED;
}

bool is_xpu_pinned_place(const Place &p) {
  return p.GetType() == phi::AllocationType::XPUPINNED;
}

bool is_custom_place(const Place &p) {
  return p.GetType() == phi::AllocationType::CUSTOM;
}

bool is_accelerat_place(const Place &p) {
  return is_gpu_place(p) || is_xpu_place(p) || is_ipu_place(p) ||
         is_custom_place(p);
}

bool is_accelerat_allocation_type(AllocationType type) {
  return type == phi::AllocationType::GPU || type == phi::AllocationType::XPU ||
         type == phi::AllocationType::IPU ||
         type == phi::AllocationType::CUSTOM;
}

bool places_are_same_class(const Place &p1, const Place &p2) {
#ifdef PADDLE_WITH_CUSTOM_DEVICE
  if (is_custom_place(p1) && is_custom_place(p2)) {
    return p1.GetDeviceType() == p2.GetDeviceType();
  }
#endif
  return p1.GetType() == p2.GetType();
}

bool is_same_place(const Place &p1, const Place &p2) {
  if (places_are_same_class(p1, p2)) {
    if (is_cpu_place(p1) || is_cuda_pinned_place(p1) ||
        is_xpu_pinned_place(p1)) {
      return true;
    } else {
      return p1 == p2;
    }
  } else {
    return false;
  }
}

#ifdef PADDLE_WITH_CUSTOM_DEVICE
std::string PlaceHelper::GetDeviceType(const Place &place) {
  if (is_cpu_place(place)) {
    return "cpu";
  } else if (is_gpu_place(place)) {
    return "gpu";
  } else if (is_xpu_place(place)) {
    return "xpu";
  } else if (is_custom_place(place)) {
    return place.GetDeviceType();
  } else {
    PADDLE_THROW(common::errors::Fatal(
        "Unknown device type. Please check available devices by "
        "paddle.device.get_available_device()"));
  }
}

size_t PlaceHelper::GetDeviceId(const Place &place) {
  return place.GetDeviceId();
}

Place PlaceHelper::CreatePlace(const std::string &dev_type, size_t dev_id) {
  if (dev_type == "cpu") {
    return CPUPlace();
  } else if (dev_type == "gpu") {
    return GPUPlace(dev_id);
  } else if (dev_type == "xpu") {
    return XPUPlace(dev_id);
  } else {
    return CustomPlace(dev_type, dev_id);
  }
}
#endif

}  // namespace phi

namespace paddle {

bool operator==(const Place &place, PlaceType place_type) {
  LOG_FIRST_N(WARNING, 1)
      << "The `paddle::PlaceType::kCPU/kGPU` is deprecated since version "
         "2.3, and will be removed in version 2.4! Please use "
         "`Tensor::is_cpu()/is_gpu()` method to determine the type of place.";
  return place.GetType() == static_cast<AllocationType>(place_type);
}

bool operator==(PlaceType place_type, const Place &place) {
  LOG_FIRST_N(WARNING, 1)
      << "The `paddle::PlaceType::kCPU/kGPU` is deprecated since version "
         "2.3, and will be removed in version 2.4! Please use "
         "`Tensor::is_cpu()/is_gpu()` method to determine the type of place.";
  return static_cast<AllocationType>(place_type) == place.GetType();
}

GPUPlace DefaultGPUPlace() {
  return GPUPlace(
#if defined(PADDLE_WITH_CUDA) || defined(PADDLE_WITH_HIP)
      phi::backends::gpu::GetCurrentDeviceId());
#else
      0);
#endif
}

phi::XPUPlace DefaultXPUPlace() {
  return phi::XPUPlace(
#ifdef PADDLE_WITH_XPU
      phi::backends::xpu::GetXPUCurrentDeviceId());
#else
      0);
#endif
}

phi::CustomPlace DefaultCustomPlace() {
#ifdef PADDLE_WITH_CUSTOM_DEVICE
  auto dev_types = phi::DeviceManager::GetAllCustomDeviceTypes();
  int device_id = phi::DeviceManager::GetDevice(dev_types[0]);
  return phi::CustomPlace(dev_types[0], device_id);
#else
  PADDLE_THROW(common::errors::Unavailable("Unsupported custom device"));
#endif
}

}  // namespace paddle