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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_OPENCL_INC_OPENCL_DEVICE_SELECTION_H
#define INCLUDED_OPENCL_INC_OPENCL_DEVICE_SELECTION_H
#ifdef _MSC_VER
//#define _CRT_SECURE_NO_WARNINGS
#endif
#include <memory>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <clew/clew.h>
#include <tools/stream.hxx>
#include <tools/XmlWriter.hxx>
#include <tools/XmlWalker.hxx>
#include <rtl/math.hxx>
#include <opencl/OpenCLZone.hxx>
#include <vector>
enum ds_status
{
DS_SUCCESS = 0
,DS_INVALID_PROFILE = 1000
,DS_MEMORY_ERROR
, DS_INVALID_PERF_EVALUATOR_TYPE
, DS_INVALID_PERF_EVALUATOR
, DS_PERF_EVALUATOR_ERROR
, DS_FILE_ERROR
, DS_UNKNOWN_DEVICE_TYPE
, DS_PROFILE_FILE_ERROR
, DS_SCORE_SERIALIZER_ERROR
, DS_SCORE_DESERIALIZER_ERROR
};
// device type
enum class DeviceType
{
None,
// NativeCPU means the traditional Calc interpreter code path. (That also includes the so-called
// "software interpreter", but note that it definitely does not mean *exclusively* that.)
NativeCPU,
// OpenCLDevice means an OpenCL device as supplied by an OpenCL platform, which might well be
// implemented using code that runs on the CPU (and not a GPU). On Windows, OpenCL platforms
// typically provide two devices, one for the GPU and one for the CPU.
OpenCLDevice
};
struct ds_device
{
DeviceType eType;
cl_device_id aDeviceID;
OString sPlatformName;
OString sPlatformVendor;
OString sPlatformVersion;
OString sPlatformProfile;
OString sPlatformExtensions;
OString sDeviceName;
OString sDeviceVendor;
OString sDeviceVersion;
OString sDriverVersion;
OString sDeviceType;
OString sDeviceExtensions;
OString sDeviceOpenCLVersion;
bool bDeviceAvailable;
bool bDeviceCompilerAvailable;
bool bDeviceLinkerAvailable;
double fTime; // small time means faster device
bool bErrors; // were there any opencl errors
};
struct ds_profile
{
std::vector<ds_device> devices;
OString version;
ds_profile(OString const & inVersion)
: version(inVersion)
{}
};
inline OString getPlatformInfoString(cl_platform_id aPlatformId, cl_platform_info aPlatformInfo)
{
std::vector<char> temporary(2048, 0);
clGetPlatformInfo(aPlatformId, aPlatformInfo, temporary.size(), temporary.data(), nullptr);
return OString(temporary.data());
}
inline OString getDeviceInfoString(cl_device_id aDeviceId, cl_device_info aDeviceInfo)
{
std::vector<char> temporary(2048, 0);
clGetDeviceInfo(aDeviceId, aDeviceInfo, temporary.size(), temporary.data(), nullptr);
return OString(temporary.data());
}
inline OString getDeviceType(cl_device_id aDeviceId)
{
OString sType = "";
cl_device_type aDeviceType;
clGetDeviceInfo(aDeviceId, CL_DEVICE_TYPE, sizeof(aDeviceType), &aDeviceType, nullptr);
if (aDeviceType & CL_DEVICE_TYPE_CPU)
sType += "cpu ";
if (aDeviceType & CL_DEVICE_TYPE_GPU)
sType += "gpu ";
if (aDeviceType & CL_DEVICE_TYPE_ACCELERATOR)
sType += "accelerator ";
if (aDeviceType & CL_DEVICE_TYPE_CUSTOM)
sType += "custom ";
if (aDeviceType & CL_DEVICE_TYPE_DEFAULT)
sType += "default ";
return sType;
}
inline bool getDeviceInfoBool(cl_device_id aDeviceId, cl_device_info aDeviceInfo)
{
cl_bool bCLBool = 0;
// init to false in case clGetDeviceInfo returns CL_INVALID_VALUE when
// requesting unsupported (in version 1.0) CL_DEVICE_LINKER_AVAILABLE
clGetDeviceInfo(aDeviceId, aDeviceInfo, sizeof(bCLBool), &bCLBool, nullptr);
return bCLBool == CL_TRUE;
}
inline ds_status initDSProfile(std::unique_ptr<ds_profile>& rProfile, OString const & rVersion)
{
OpenCLZone zone;
int numDevices;
cl_uint numPlatforms;
std::vector<cl_platform_id> platforms;
std::vector<cl_device_id> devices;
unsigned int next;
unsigned int i;
rProfile.reset(new ds_profile(rVersion));
clGetPlatformIDs(0, nullptr, &numPlatforms);
if (numPlatforms != 0)
{
platforms.resize(numPlatforms);
clGetPlatformIDs(numPlatforms, platforms.data(), nullptr);
}
numDevices = 0;
for (i = 0; i < static_cast<unsigned int>(numPlatforms); i++)
{
cl_uint num = 0;
cl_int err = clGetDeviceIDs(platforms[i], CL_DEVICE_TYPE_ALL, 0, nullptr, &num);
if (err != CL_SUCCESS)
{
/* we want to catch at least the case when the call returns
* CL_DEVICE_NOT_FOUND (i.e. no devices), because some platforms
* don't set num to 0 in this case; but in fact this is a good
* thing to do for _any_ error returned by the call
*/
num = 0;
}
numDevices += num;
}
if (numDevices != 0)
{
devices.resize(numDevices);
}
rProfile->devices.resize(numDevices + 1); // +1 to numDevices to include the native CPU
next = 0;
for (i = 0; i < static_cast<unsigned int>(numPlatforms); i++)
{
cl_uint num = 0;
unsigned j;
OString sPlatformProfile = getPlatformInfoString(platforms[i], CL_PLATFORM_PROFILE);
OString sPlatformVersion = getPlatformInfoString(platforms[i], CL_PLATFORM_VERSION);
OString sPlatformName = getPlatformInfoString(platforms[i], CL_PLATFORM_NAME);
OString sPlatformVendor = getPlatformInfoString(platforms[i], CL_PLATFORM_VENDOR);
OString sPlatformExts = getPlatformInfoString(platforms[i], CL_PLATFORM_EXTENSIONS);
cl_int err = clGetDeviceIDs(platforms[i], CL_DEVICE_TYPE_ALL, numDevices, devices.data(), &num);
if (err != CL_SUCCESS)
{
/* we want to catch at least the case when the call returns
* CL_DEVICE_NOT_FOUND (i.e. no devices), because some platforms
* don't set num to 0 in this case; but in fact this is a good
* thing to do for _any_ error returned by the call
*/
num = 0;
}
for (j = 0; j < num; j++, next++)
{
cl_device_id aDeviceID = devices[j];
ds_device& rDevice = rProfile->devices[next];
rDevice.eType = DeviceType::OpenCLDevice;
rDevice.aDeviceID = aDeviceID;
rDevice.sPlatformName = sPlatformName;
rDevice.sPlatformVendor = sPlatformVendor;
rDevice.sPlatformVersion = sPlatformVersion;
rDevice.sPlatformProfile = sPlatformProfile;
rDevice.sPlatformExtensions = sPlatformExts;
rDevice.sDeviceName = getDeviceInfoString(aDeviceID, CL_DEVICE_NAME);
rDevice.sDeviceVendor = getDeviceInfoString(aDeviceID, CL_DEVICE_VENDOR);
rDevice.sDeviceVersion = getDeviceInfoString(aDeviceID, CL_DEVICE_VERSION);
rDevice.sDriverVersion = getDeviceInfoString(aDeviceID, CL_DRIVER_VERSION);
rDevice.sDeviceType = getDeviceType(aDeviceID);
rDevice.sDeviceExtensions = getDeviceInfoString(aDeviceID, CL_DEVICE_EXTENSIONS);
rDevice.sDeviceOpenCLVersion = getDeviceInfoString(aDeviceID, CL_DEVICE_OPENCL_C_VERSION);
rDevice.bDeviceAvailable = getDeviceInfoBool(aDeviceID, CL_DEVICE_AVAILABLE);
rDevice.bDeviceCompilerAvailable = getDeviceInfoBool(aDeviceID, CL_DEVICE_COMPILER_AVAILABLE);
rDevice.bDeviceLinkerAvailable = getDeviceInfoBool(aDeviceID, CL_DEVICE_LINKER_AVAILABLE);
}
}
rProfile->devices[next].eType = DeviceType::NativeCPU;
return DS_SUCCESS;
}
inline ds_status writeProfile(const OUString& rStreamName, std::unique_ptr<ds_profile> const & pProfile)
{
if (pProfile == nullptr)
return DS_INVALID_PROFILE;
if (rStreamName.isEmpty())
return DS_INVALID_PROFILE;
std::unique_ptr<SvStream> pStream;
pStream.reset(new SvFileStream(rStreamName, StreamMode::STD_READWRITE | StreamMode::TRUNC));
tools::XmlWriter aXmlWriter(pStream.get());
if (!aXmlWriter.startDocument())
return DS_FILE_ERROR;
aXmlWriter.startElement("profile");
aXmlWriter.startElement("version");
aXmlWriter.content(pProfile->version);
aXmlWriter.endElement();
for (ds_device& rDevice : pProfile->devices)
{
aXmlWriter.startElement("device");
switch(rDevice.eType)
{
case DeviceType::NativeCPU:
aXmlWriter.startElement("type");
aXmlWriter.content(OString("native"));
aXmlWriter.endElement();
break;
case DeviceType::OpenCLDevice:
aXmlWriter.startElement("type");
aXmlWriter.content(OString("opencl"));
aXmlWriter.endElement();
aXmlWriter.startElement("name");
aXmlWriter.content(rDevice.sDeviceName);
aXmlWriter.endElement();
aXmlWriter.startElement("driver");
aXmlWriter.content(rDevice.sDriverVersion);
aXmlWriter.endElement();
break;
default:
break;
}
aXmlWriter.startElement("time");
if (rtl::math::approxEqual(rDevice.fTime, DBL_MAX))
aXmlWriter.content(OString("max"));
else
aXmlWriter.content(OString::number(rDevice.fTime));
aXmlWriter.endElement();
aXmlWriter.startElement("errors");
aXmlWriter.content(rDevice.bErrors ? OString("true") : OString("false"));
aXmlWriter.endElement();
aXmlWriter.endElement();
}
aXmlWriter.endElement();
aXmlWriter.endDocument();
return DS_SUCCESS;
}
inline ds_status readProfile(const OUString& rStreamName, std::unique_ptr<ds_profile> const & pProfile)
{
ds_status eStatus = DS_SUCCESS;
if (rStreamName.isEmpty())
return DS_INVALID_PROFILE;
std::unique_ptr<SvStream> pStream;
pStream.reset(new SvFileStream(rStreamName, StreamMode::READ));
tools::XmlWalker aWalker;
if (!aWalker.open(pStream.get()))
return DS_FILE_ERROR;
if (aWalker.name() == "profile")
{
aWalker.children();
while (aWalker.isValid())
{
if (aWalker.name() == "version")
{
if (aWalker.content() != pProfile->version)
return DS_PROFILE_FILE_ERROR;
}
else if (aWalker.name() == "device")
{
aWalker.children();
DeviceType eDeviceType = DeviceType::None;
OString sName;
OString sVersion;
double fTime = -1.0;
bool bErrors = true;
while (aWalker.isValid())
{
if (aWalker.name() == "type")
{
OString sContent = aWalker.content();
if (sContent == "native")
eDeviceType = DeviceType::NativeCPU;
else if (sContent == "opencl")
eDeviceType = DeviceType::OpenCLDevice;
else
return DS_PROFILE_FILE_ERROR;
}
else if (aWalker.name() == "name")
{
sName = aWalker.content();
}
else if (aWalker.name() == "driver")
{
sVersion = aWalker.content();
}
else if (aWalker.name() == "time")
{
if (aWalker.content() == "max")
fTime = DBL_MAX;
else
fTime = aWalker.content().toDouble();
}
else if (aWalker.name() == "errors")
{
bErrors = (aWalker.content() == "true");
}
aWalker.next();
}
if (fTime < 0.0)
return DS_PROFILE_FILE_ERROR;
for (ds_device& rDevice : pProfile->devices)
{
// type matches? either both are DS_DEVICE_OPENCL_DEVICE or DS_DEVICE_NATIVE_CPU
if (rDevice.eType == eDeviceType)
{
// is DS_DEVICE_NATIVE_CPU or name + version matches?
if (eDeviceType == DeviceType::NativeCPU ||
(sName == rDevice.sDeviceName &&
sVersion == rDevice.sDriverVersion))
{
rDevice.fTime = fTime;
rDevice.bErrors = bErrors;
}
}
}
aWalker.parent();
}
aWalker.next();
}
aWalker.parent();
}
return eStatus;
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|