aboutsummaryrefslogtreecommitdiff
path: root/trampoline.c
blob: 24573f1d7e50bcb784ed6a2010401c0bba0a0ce1 (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
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
#include <stdio.h>
#include <string.h>
#include <opencl.h>

#include "cl_error.h"
#include "slurp.h"
#include "sha1.h"

static cl_platform_id platform;
static cl_context context;
static cl_device_id* devices;
static cl_uint device_count;
static unsigned int device_in_use;
static cl_command_queue command_queue;
static cl_mem device_result;
static cl_mem device_sha;
static cl_mem device_search;

static cl_kernel kernel;
static cl_program program;

/**
 * Wrapper to help with fetching string-based information about an OpenCL
 * platform.
 *
 * Returns non-null pointer to a string which will need to be passed to free()
 * when finished with.
 * On failure, returns NULL
 */
char *get_platform_info(cl_platform_id id, cl_platform_info value_name)
{
	cl_int ret = 0;
	char *value = NULL;
	size_t value_len = 0;

	ret = clGetPlatformInfo(id, value_name, 0, NULL, &value_len);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get platform info for platform: %s\n", get_cl_error_string(ret));
		return NULL;
	}

	value = malloc(value_len);
	if (value == NULL) {
		perror("value buffer malloc");
		return NULL;
	}

	ret = clGetPlatformInfo(id, value_name, value_len, value, &value_len);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get platform info for platform: %s\n", get_cl_error_string(ret));
		return NULL;
	}

	return value;
}

/**
 * Set the trampoline's selected OpenCL platform to the first one with a name
 * matching the one in `preferred_platform`. If no exact match is found,
 * the first available platform is selected instead.
 *
 * Returns 0 when any platform was selected. Returns non-zero if no platform
 * could be selected
 */
int select_platform(const char *preferred_platform)
{
	cl_uint i = 0;
	cl_platform_id *platforms = NULL;
	cl_uint platform_count = 0;
	cl_int ret = 0;
	int preferred_platform_found = 0;
	char *p_name = NULL;
	char *p_vendor = NULL;
	char *p_version = NULL;

	ret = clGetPlatformIDs(0, NULL, &platform_count);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get CL platform count: %s ", get_cl_error_string(ret));
		return 1;
	}

	if (platform_count == 0) {
		fprintf(stderr, "No OpenCL platforms available ");
		return 1;
	}

	platforms = calloc(platform_count, sizeof(cl_platform_id));
	if (platforms == NULL) {
		perror("platform ID array calloc");
		return 1;
	}

	ret = clGetPlatformIDs(platform_count, platforms, NULL);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get CL platform IDs: %s ", get_cl_error_string(ret));
		return 1;
	}

	fprintf(stderr, "\nAvailable platforms:\n");
	for (i = 0; i < platform_count; i++) {
		p_name = get_platform_info(platforms[i], CL_PLATFORM_NAME);
		p_vendor = get_platform_info(platforms[i], CL_PLATFORM_VENDOR);
		p_version = get_platform_info(platforms[i], CL_PLATFORM_VERSION);
		if (   p_name == NULL
		    || p_version == NULL
		    || p_vendor == NULL) {
			free(p_name);
			free(p_vendor);
			free(p_version);
			free(platforms);
			return 1;
		}
		/* Is this platform the first preferred one? Select it for the lovely lady or gentleman */
		if (strcmp(preferred_platform, p_name) == 0 && !preferred_platform_found) {
			platform = platforms[i];
			preferred_platform_found = 1;
		}
		fprintf(stderr, "\t* Platform \"%s\" - From %s (%s)%s\n",
		        p_name, p_vendor, p_version, platform == platforms[i] ? " [SELECTED]" : "" );

		free(p_name);
		free(p_vendor);
		free(p_version);
	}

	if (!preferred_platform_found) {
		fprintf(stderr, "Warning: Preferred platform not found, falling back on first available platform.\n");
		platform = platforms[0];
	}

	free(platforms);

	return 0;
}


/**
 * Initialise the OpenCL trampoline, specifying the name of the OpenCL platform
 * to use if it is available
 *
 * Returns 0 on success, non-zero on failure.
 */
int tramp_init(const char *preferred_platform)
{
	cl_int ret = 0;

	if (select_platform(preferred_platform)) {
		return 1;
	}

	/* FIXME expose device type to user */
	ret = clGetDeviceIDs(platform, CL_DEVICE_TYPE_ALL, 0, NULL, &device_count);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get device count: %s ", get_cl_error_string(ret));
		return 1;
	}

	devices = malloc(device_count * sizeof(cl_device_id));
	if (!devices) {
		perror("device list malloc");
		return 1;
	}

	/* FIXME expose device type to user */
	ret = clGetDeviceIDs(platform, CL_DEVICE_TYPE_ALL, device_count, devices, NULL);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get device ID list: %s ", get_cl_error_string(ret));
		return 1;
	}

	context = clCreateContext(0, 1, devices, NULL, NULL, &ret);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to create CL context: %s ", get_cl_error_string(ret));
		return 1;
	}

	/* FIXME expose to user */
	device_in_use = 0;
	command_queue = clCreateCommandQueueWithProperties(context, devices[device_in_use], NULL, &ret);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to create command queue on context: %s ", get_cl_error_string(ret));
		return 1;
	}

	return 0;
}

/**
 * Destroy the trampoline, deallocating/freeing resources allocated in a
 * previous call to tramp_init(char*)
 */
void tramp_destroy()
{
	clReleaseKernel(kernel);
	clReleaseProgram(program);
	clFlush(command_queue);
	clFinish(command_queue);
	clReleaseCommandQueue(command_queue);
	clReleaseContext(context);

	clReleaseMemObject(device_result);
	clReleaseMemObject(device_sha);
	clReleaseMemObject(device_search);

	if (devices) {
		free(devices);
		devices = NULL;
	}
}

/**
 * Load OpenCL kernel source from the file `filename` and create an OpenCL
 * program from it.
 *
 * Returns 0 on success, non-zero on failure.
 */
int tramp_load_kernel(const char *filename)
{
	cl_int ret = 0;
	size_t length = 0;
	FILE *fin = NULL;
	char *source = NULL;

	fin = fopen(filename, "r");
	if (!fin) {
		perror("fopen");
		return 1;
	}

	source = slurp(fin, &length);
	if (!source)
		return 1;

	fclose(fin);

	program = clCreateProgramWithSource(context, 1, (const char **)&source, &length, &ret);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to create program from source code: %s ", get_cl_error_string(ret));
		return 1;
	}

	free(source);
	source = NULL;

	return 0;
}

/**
 * Get a string showing the logged output (if any) of the build stage of OpenCL
 * program compilation.
 *
 * On success, returns a char* which must be passed to free(1) when no longer
 * needed. Else, returns NULL.
 */
char *tramp_get_build_log()
{
	cl_int ret = 0;
	cl_build_status build_status;
	char *build_log = NULL;
	size_t log_size = 0;

	ret = clGetProgramBuildInfo(program, devices[device_in_use],
	                            CL_PROGRAM_BUILD_STATUS,
	                            sizeof(cl_build_status),
	                            &build_status, NULL);

	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get program build status: %s ", get_cl_error_string(ret));
		return NULL;
	}

	ret = clGetProgramBuildInfo(program, devices[device_in_use],
	                            CL_PROGRAM_BUILD_LOG, 0, NULL, &log_size);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get program build log size: %s ", get_cl_error_string(ret));
		return NULL;
	}

	/* + 1 for null-terminator */
	build_log = malloc(log_size + 1);
	if (!build_log) {
		perror("malloc");
		return NULL;
	}
	ret = clGetProgramBuildInfo(program, devices[device_in_use],
	                            CL_PROGRAM_BUILD_LOG,
	                            log_size, build_log, NULL);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to get program build log: %s ", get_cl_error_string(ret));
		return NULL;
	}

	/* null-terminate log */
	build_log[log_size] = '\0';

	return build_log;
}

/**
 * Compile the loaded program/kernel to make it ready for execution.
 *
 * Returns 0 on success, non-zero otherwise.
 */
int tramp_compile_kernel()
{
	cl_int ret = 0;

	ret = clBuildProgram(program, 0, NULL, NULL, NULL, NULL);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to build program: %s ", get_cl_error_string(ret));
		return 1;
	}

	kernel = clCreateKernel(program, "key_brute", &ret);

	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to create kernel: %s ", get_cl_error_string(ret));
		return 1;
	}

	return 0;
}

/**
 * Set the arguments to be passed to the OpenCL kernel when run on the device.
 *
 * Returns 0 on success, non-zero otherwise.
 *
 * FIXME investigate using something more flexible?
 */
int tramp_set_kernel_args(unsigned int raw_len, unsigned int bitmask)
{
	cl_int ret = 0;

	device_result = clCreateBuffer(context, CL_MEM_WRITE_ONLY, 65536*4, NULL, &ret);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to create buffer for slave device: %s ", get_cl_error_string(ret));
		return 1;
	}

	device_sha = clCreateBuffer(context, CL_MEM_READ_WRITE, sizeof(struct sha_data), NULL, &ret);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to create SHA buffer for slave device: %s ", get_cl_error_string(ret));
		return 1;
	}

	device_search = clCreateBuffer(context, CL_MEM_READ_WRITE, 10, NULL, &ret);
	if (ret != CL_SUCCESS) {
		fprintf(stderr, "Failed to create search buffer for slave device: %s "