1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/* Copyright 2017 The TensorFlow 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.
==============================================================================*/
// A simple CPU allocator that intercepts malloc/free calls from MKL library
// and redirects them to Tensorflow allocator
#ifndef TENSORFLOW_CORE_COMMON_RUNTIME_MKL_CPU_ALLOCATOR_H_
#define TENSORFLOW_CORE_COMMON_RUNTIME_MKL_CPU_ALLOCATOR_H_
#ifdef INTEL_MKL
#include <cstdlib>
#include <string>
#include "tensorflow/core/common_runtime/bfc_allocator.h"
#include "tensorflow/core/common_runtime/visitable_allocator.h"
#include "tensorflow/core/lib/strings/numbers.h"
#include "tensorflow/core/lib/strings/str_util.h"
#include "tensorflow/core/platform/mem.h"
#include "i_malloc.h"
#ifdef _WIN32
typedef unsigned int uint;
#endif
namespace tensorflow {
class MklSubAllocator : public SubAllocator {
public:
~MklSubAllocator() override {}
void* Alloc(size_t alignment, size_t num_bytes) override {
return port::AlignedMalloc(num_bytes, alignment);
}
void Free(void* ptr, size_t num_bytes) override { port::AlignedFree(ptr); }
};
/// CPU allocator for MKL that wraps BFC allocator and intercepts
/// and redirects memory allocation calls from MKL.
class MklCPUAllocator : public VisitableAllocator {
public:
// Constructor and other standard functions
/// Environment variable that user can set to upper bound on memory allocation
static constexpr const char* kMaxLimitStr = "TF_MKL_ALLOC_MAX_BYTES";
/// Default upper limit on allocator size - 64GB
static constexpr size_t kDefaultMaxLimit = 64LL << 30;
MklCPUAllocator() { TF_CHECK_OK(Initialize()); }
~MklCPUAllocator() override { delete allocator_; }
Status Initialize() {
VLOG(2) << "MklCPUAllocator: In MklCPUAllocator";
// Set upper bound on memory allocation to physical RAM available on the
// CPU unless explicitly specified by user
uint64 max_mem_bytes = kDefaultMaxLimit;
#if defined(_SC_PHYS_PAGES) && defined(_SC_PAGESIZE)
max_mem_bytes =
(uint64)sysconf(_SC_PHYS_PAGES) * (uint64)sysconf(_SC_PAGESIZE);
#endif
char* user_mem_bytes = getenv(kMaxLimitStr);
if (user_mem_bytes != NULL) {
uint64 user_val = 0;
if (!strings::safe_strtou64(user_mem_bytes, &user_val)) {
return errors::InvalidArgument("Invalid memory limit (", user_mem_bytes,
") specified for MKL allocator through ",
kMaxLimitStr);
}
#if defined(_SC_PHYS_PAGES) && defined(_SC_PAGESIZE)
if (user_val > max_mem_bytes) {
LOG(WARNING) << "The user specified a memory limit " << kMaxLimitStr
<< "=" << user_val
<< " greater than available physical memory: "
<< max_mem_bytes
<< ". This could significantly reduce performance!";
}
#endif
max_mem_bytes = user_val;
}
VLOG(1) << "MklCPUAllocator: Setting max_mem_bytes: " << max_mem_bytes;
allocator_ = new BFCAllocator(new MklSubAllocator, max_mem_bytes,
kAllowGrowth, kName);
// For redirecting all allocations from MKL to this allocator
// From: http://software.intel.com/en-us/node/528565
i_malloc = MallocHook;
i_calloc = CallocHook;
i_realloc = ReallocHook;
i_free = FreeHook;
return Status::OK();
}
inline string Name() override { return kName; }
inline void* AllocateRaw(size_t alignment, size_t num_bytes) override {
return allocator_->AllocateRaw(alignment, num_bytes);
}
inline void DeallocateRaw(void* ptr) override {
allocator_->DeallocateRaw(ptr);
}
void GetStats(AllocatorStats* stats) override { allocator_->GetStats(stats); }
void ClearStats() override { allocator_->ClearStats(); }
void AddAllocVisitor(Visitor visitor) override {
allocator_->AddAllocVisitor(visitor);
}
void AddFreeVisitor(Visitor visitor) override {
allocator_->AddFreeVisitor(visitor);
}
private:
// Hooks provided by this allocator for memory allocation routines from MKL
static inline void* MallocHook(size_t size) {
VLOG(3) << "MklCPUAllocator: In MallocHook";
return cpu_allocator()->AllocateRaw(kAlignment, size);
}
static inline void FreeHook(void* ptr) {
VLOG(3) << "MklCPUAllocator: In FreeHook";
cpu_allocator()->DeallocateRaw(ptr);
}
static inline void* CallocHook(size_t num, size_t size) {
Status s = Status(error::Code::UNIMPLEMENTED,
"Unimplemented case for hooking MKL function.");
TF_CHECK_OK(s); // way to assert with an error message
}
static inline void* ReallocHook(void* ptr, size_t size) {
Status s = Status(error::Code::UNIMPLEMENTED,
"Unimplemented case for hooking MKL function.");
TF_CHECK_OK(s); // way to assert with an error message
}
/// Do we allow growth in BFC Allocator
static const bool kAllowGrowth = true;
/// Name
static constexpr const char* kName = "mklcpu";
/// The alignment that we need for the allocations
static constexpr const size_t kAlignment = 64;
VisitableAllocator* allocator_; // owned by this class
};
} // namespace tensorflow
#endif // INTEL_MKL
#endif // TENSORFLOW_CORE_COMMON_RUNTIME_MKL_CPU_ALLOCATOR_H_
|
