summaryrefslogtreecommitdiffstats
path: root/src/opencl/qcldevice.h
blob: cb3438f2840428974f8fdfc46ba319b62c400a60 (plain)
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
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtOpenCL module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QCLDEVICE_H
#define QCLDEVICE_H

#include "qclplatform.h"
#include "qclworksize.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(CL)

class Q_CL_EXPORT QCLDevice
{
public:
    QCLDevice() : m_id(0), m_flags(0) {}
    QCLDevice(cl_device_id id) : m_id(id), m_flags(0) {}

    enum DeviceType
    {
        Default             = 0x00000001,
        CPU                 = 0x00000002,
        GPU                 = 0x00000004,
        Accelerator         = 0x00000008,
        All                 = 0xFFFFFFFF
    };
    Q_DECLARE_FLAGS(DeviceTypes, DeviceType)

    bool isNull() const { return m_id == 0; }

    QCLDevice::DeviceTypes deviceType() const;
    QCLPlatform platform() const;
    uint vendorId() const;
    bool isAvailable() const;

    bool hasCompiler() const;
    bool hasNativeKernels() const;
    bool hasOutOfOrderExecution() const;
    bool hasDouble() const;
    bool hasHalfFloat() const;
    bool hasErrorCorrectingMemory() const;

    int computeUnits() const;
    int clockFrequency() const;
    int addressBits() const;
    QSysInfo::Endian byteOrder() const;

    QCLWorkSize maximumWorkItemSize() const;
    size_t maximumWorkItemsPerGroup() const;

    bool hasImage2D() const;
    bool hasImage3D() const;
    bool hasWritableImage3D() const;
    QSize maximumImage2DSize() const;
    QCLWorkSize maximumImage3DSize() const;
    int maximumSamplers() const;
    int maximumReadImages() const;
    int maximumWriteImages() const;

    int preferredCharVectorSize() const;
    int preferredShortVectorSize() const;
    int preferredIntVectorSize() const;
    int preferredLongVectorSize() const;
    int preferredFloatVectorSize() const;
    int preferredDoubleVectorSize() const;
    int preferredHalfFloatVectorSize() const;

    enum FloatCapability
    {
        NotSupported        = 0x0000,
        Denorm              = 0x0001,
        InfinityNaN         = 0x0002,
        RoundNearest        = 0x0004,
        RoundZero           = 0x0008,
        RoundInfinity       = 0x0010,
        FusedMultiplyAdd    = 0x0020
    };
    Q_DECLARE_FLAGS(FloatCapabilities, FloatCapability)

    QCLDevice::FloatCapabilities floatCapabilities() const;
    QCLDevice::FloatCapabilities doubleCapabilities() const;
    QCLDevice::FloatCapabilities halfFloatCapabilities() const;

    quint64 profilingTimerResolution() const;

    enum CacheType
    {
        NoCache             = 0,
        ReadOnlyCache       = 1,
        ReadWriteCache      = 2
    };

    quint64 maximumAllocationSize() const;
    quint64 globalMemorySize() const;
    QCLDevice::CacheType globalMemoryCacheType() const;
    quint64 globalMemoryCacheSize() const;
    int globalMemoryCacheLineSize() const;
    quint64 localMemorySize() const;
    bool isLocalMemorySeparate() const;
    quint64 maximumConstantBufferSize() const;
    int maximumConstantArguments() const;

    int defaultAlignment() const;
    int minimumAlignment() const;
    int maximumParameterBytes() const;

    bool isFullProfile() const;
    bool isEmbeddedProfile() const;

    QString profile() const;
    QString version() const;
    QString driverVersion() const;
    QString name() const;
    QString vendor() const;
    QStringList extensions() const;

    bool hasExtension(const char *name) const;

    QCLPlatform::VersionFlags versionFlags() const;

    cl_device_id deviceId() const { return m_id; }

    static QList<QCLDevice> allDevices();
    static QList<QCLDevice> devices
        (QCLDevice::DeviceTypes types,
         const QCLPlatform &platform = QCLPlatform());

    bool operator==(const QCLDevice &other) const;
    bool operator!=(const QCLDevice &other) const;

private:
    cl_device_id m_id;
    mutable int m_flags;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QCLDevice::DeviceTypes)
Q_DECLARE_OPERATORS_FOR_FLAGS(QCLDevice::FloatCapabilities)

inline bool QCLDevice::operator==(const QCLDevice &other) const
{
    return m_id == other.m_id;
}

inline bool QCLDevice::operator!=(const QCLDevice &other) const
{
    return m_id != other.m_id;
}

#ifndef QT_NO_DEBUG_STREAM
Q_CL_EXPORT QDebug operator<<(QDebug, const QCLDevice &);
#endif

QT_END_NAMESPACE

QT_END_HEADER

#endif