place.h 2.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.

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. */

Y
Yi Wang 已提交
15
#pragma once
16

Y
Yi Wang 已提交
17
#include <iostream>
Y
Yu Yang 已提交
18

Y
Yu Yang 已提交
19
#include "paddle/platform/variant.h"
Y
Yi Wang 已提交
20

Y
Yi Wang 已提交
21 22
namespace paddle {
namespace platform {
Y
Yi Wang 已提交
23

24
struct CPUPlace {
Y
Yi Wang 已提交
25 26
  // WORKAROUND: for some reason, omitting this constructor
  // causes errors with boost 1.59 and OSX
27
  CPUPlace() {}
Y
Yi Wang 已提交
28

Y
Yi Wang 已提交
29
  // needed for variant equality comparison
30 31
  inline bool operator==(const CPUPlace &) const { return true; }
  inline bool operator!=(const CPUPlace &) const { return false; }
Y
Yi Wang 已提交
32 33
};

34 35
struct GPUPlace {
  GPUPlace() : GPUPlace(0) {}
Y
Yi Wang 已提交
36
  explicit GPUPlace(int d) : device(d) {}
Y
Yi Wang 已提交
37

Y
Yu Yang 已提交
38
  inline int GetDeviceId() const { return device; }
Y
Yi Wang 已提交
39
  // needed for variant equality comparison
40 41
  inline bool operator==(const GPUPlace &o) const { return device == o.device; }
  inline bool operator!=(const GPUPlace &o) const { return !(*this == o); }
Y
Yi Wang 已提交
42 43 44 45

  int device;
};

46 47 48
struct IsGPUPlace : public boost::static_visitor<bool> {
  bool operator()(const CPUPlace &) const { return false; }
  bool operator()(const GPUPlace &gpu) const { return true; }
Y
Yi Wang 已提交
49 50
};

Y
Yu Yang 已提交
51 52 53 54
// Define the max number of Place in bit length. i.e., the max number of places
// should be less equal than 2^(NUM_PLACE_TYPE_LIMIT_IN_BIT)
#define NUM_PLACE_TYPE_LIMIT_IN_BIT 4

55
typedef boost::variant<GPUPlace, CPUPlace> Place;
Y
Yi Wang 已提交
56

Y
Yu Yang 已提交
57 58 59 60 61 62
// static check number of place types is less equal than
// 2^(NUM_PLACE_TYPE_LIMIT_IN_BIT)
BOOST_MPL_ASSERT((boost::mpl::less_equal<
                  Place::types::size,
                  boost::mpl::long_<1 << NUM_PLACE_TYPE_LIMIT_IN_BIT>>));

Y
Yi Wang 已提交
63 64
void set_place(const Place &);
const Place &get_place();
Y
Yi Wang 已提交
65

66 67
const GPUPlace default_gpu();
const CPUPlace default_cpu();
Y
Yi Wang 已提交
68

Y
Yi Wang 已提交
69 70 71
bool is_gpu_place(const Place &);
bool is_cpu_place(const Place &);
bool places_are_same_class(const Place &, const Place &);
Y
Yi Wang 已提交
72

Y
Yi Wang 已提交
73
std::ostream &operator<<(std::ostream &, const Place &);
Y
Yi Wang 已提交
74

Y
Yi Wang 已提交
75 76
}  // namespace platform
}  // namespace paddle