summaryrefslogtreecommitdiffstats
path: root/src/com/mbien/opencl/CLException.java
blob: 4ca216c4a40fed978c0df599472bb71b536c4c5a (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
package com.mbien.opencl;

import static com.mbien.opencl.CL.*;

/**
 * Main Exception type for runtime OpenCL errors and unsuccessful function calls (e.g. returning not CL_SUCCESS).
 * @author Michael Bien
 */
public class CLException extends RuntimeException {

    public final int errorcode;

    private final static String ERROR_CODE_DOC = "http://www.khronos.org/opencl/sdk/1.0/docs/man/xhtml/errors.html";

    public CLException(String message) {
        super(message);
        errorcode = 0;
    }

    public CLException(int error, String message) {
        super(message + "\nerror: " + identifyError(error) + " (man page: "+ERROR_CODE_DOC+")");
        errorcode = error;
    }

    /**
     * Throws a CLException when <code>status != CL_SUCCESS</code>.
     */
    public static final void checkForError(int status, String message) {
        if(status != CL_SUCCESS)
            throw new CLException(status, message);
    }

    /**
     * Returns a human readable String for the OpenCL error code.
     */
    public String getCLErrorString() {
        return identifyError(errorcode);
    }

    private static final String identifyError(int error) {

        switch (error) {
            case CL_DEVICE_NOT_FOUND:
                return "CL_DEVICE_NOT_FOUND";

            case CL_DEVICE_NOT_AVAILABLE:
                return "CL_DEVICE_NOT_AVAILABLE";

            case CL_COMPILER_NOT_AVAILABLE:
                return "CL_COMPILER_NOT_AVAILABLE";

            case CL_MEM_OBJECT_ALLOCATION_FAILURE:
                return "CL_MEM_OBJECT_ALLOCATION_FAILURE";

            case CL_OUT_OF_RESOURCES:
                return "CL_OUT_OF_RESOURCES";

            case CL_OUT_OF_HOST_MEMORY:
                return "CL_OUT_OF_HOST_MEMORY";

            case CL_PROFILING_INFO_NOT_AVAILABLE:
                return "CL_PROFILING_INFO_NOT_AVAILABLE";

            case CL_MEM_COPY_OVERLAP:
                return "CL_MEM_COPY_OVERLAP";

            case CL_IMAGE_FORMAT_MISMATCH:
                return "CL_IMAGE_FORMAT_MISMATCH";

            case CL_IMAGE_FORMAT_NOT_SUPPORTED:
                return "CL_IMAGE_FORMAT_NOT_SUPPORTED";

            case CL_BUILD_PROGRAM_FAILURE:
                return "CL_BUILD_PROGRAM_FAILURE";

            case CL_MAP_FAILURE:
                return "CL_MAP_FAILURE";

            case CL_INVALID_VALUE:
                return "CL_INVALID_VALUE";

            case CL_INVALID_DEVICE_TYPE:
                return "CL_INVALID_DEVICE_TYPE";

            case CL_INVALID_PLATFORM:
                return "CL_INVALID_PLATFORM";

            case CL_INVALID_DEVICE:
                return "CL_INVALID_DEVICE";

            case CL_INVALID_CONTEXT:
                return "CL_INVALID_CONTEXT";

            case CL_INVALID_QUEUE_PROPERTIES:
                return "CL_INVALID_QUEUE_PROPERTIES";

            case CL_INVALID_COMMAND_QUEUE:
                return "CL_INVALID_COMMAND_QUEUE";

            case CL_INVALID_HOST_PTR:
                return "CL_INVALID_HOST_PTR";

            case CL_INVALID_MEM_OBJECT:
                return "CL_INVALID_MEM_OBJECT";

            case CL_INVALID_IMAGE_FORMAT_DESCRIPTOR:
                return "CL_INVALID_IMAGE_FORMAT_DESCRIPTOR";

            case CL_INVALID_IMAGE_SIZE:
                return "CL_INVALID_IMAGE_SIZE";

            case CL_INVALID_SAMPLER:
                return "CL_INVALID_SAMPLER";

            case CL_INVALID_BINARY:
                return "CL_INVALID_BINARY";

            case CL_INVALID_BUILD_OPTIONS:
                return "CL_INVALID_BUILD_OPTIONS";

            case CL_INVALID_PROGRAM:
                return "CL_INVALID_PROGRAM";

            case CL_INVALID_PROGRAM_EXECUTABLE:
                return "CL_INVALID_PROGRAM_EXECUTABLE";

            case CL_INVALID_KERNEL_NAME:
                return "CL_INVALID_KERNEL_NAME";

            case CL_INVALID_KERNEL_DEFINITION:
                return "CL_INVALID_KERNEL_DEFINITION";

            case CL_INVALID_KERNEL:
                return "CL_INVALID_KERNEL";

            case CL_INVALID_ARG_INDEX:
                return "CL_INVALID_ARG_INDEX";

            case CL_INVALID_ARG_VALUE:
                return "CL_INVALID_ARG_VALUE";

            case CL_INVALID_ARG_SIZE:
                return "CL_INVALID_ARG_SIZE";

            case CL_INVALID_KERNEL_ARGS:
                return "CL_INVALID_KERNEL_ARGS";

            case CL_INVALID_WORK_DIMENSION:
                return "CL_INVALID_WORK_DIMENSION";

            case CL_INVALID_WORK_GROUP_SIZE:
                return "CL_INVALID_WORK_GROUP_SIZE";

            case CL_INVALID_WORK_ITEM_SIZE:
                return "CL_INVALID_WORK_ITEM_SIZE";

            case CL_INVALID_GLOBAL_OFFSET:
                return "CL_INVALID_GLOBAL_OFFSET";

            case CL_INVALID_EVENT_WAIT_LIST:
                return "CL_INVALID_EVENT_WAIT_LIST";

            case CL_INVALID_EVENT:
                return "CL_INVALID_EVENT";

            case CL_INVALID_OPERATION:
                return "CL_INVALID_OPERATION";

            case CL_INVALID_GL_OBJECT:
                return "CL_INVALID_GL_OBJECT";

            case CL_INVALID_BUFFER_SIZE:
                return "CL_INVALID_BUFFER_SIZE";

            case CL_INVALID_MIP_LEVEL:
                return "CL_INVALID_MIP_LEVEL";

            case CL_INVALID_GLOBAL_WORK_SIZE:
                return "CL_INVALID_GLOBAL_WORK_SIZE or CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR";

// error-code conflict with CL_INVALID_GLOBAL_WORK_SIZE
//            case CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR:
//                return "CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR";

            default:
                return "unknown cause: code" + error;
        }
    }


}