CLCOMPILEPROGRAM(3clc)

📦

version 1.0~svn33624 · 3 versions

1.0~svn33624 · ubuntu jammy, ubuntu noble (latest)
1.0~svn33624 · ubuntu resolute, ubuntu stonking
1.0~svn33624 · debian trixie, ubuntu questing

💖 clCompileProgram(3clc) — OpenCL Manual 💖

okay bestie, gather round. This is the clCompileProgram page, and she is long, so we're doing part 1. No cap.

✨ NAME ✨

clCompileProgram — compiles a program's source for all the devices or a specific device(s) in the OpenCL context associated with program. That's the whole vibe.

       cl_int clCompileProgram(cl_program program, cl_uint num_devices,
                               const cl_device_id *device_list,
                               const char *options, cl_uint num_input_headers,
                               const cl_program *input_headers,
                               const char **header_include_names,
                               void (CL_CALLBACK *pfn_notify)( cl_program program, void *user_data),
                               void *user_data);

🌸 PARAMETERS 🌸

program — the program object that is the compilation target. She's the main character here.
device_list — pointer to a list of devices associated with program. If device_list is NULL, the compile runs for all devices associated with program. If device_list is a non-NULL value, the compile runs for the devices specified in this list.
num_devices — the number of devices listed in device_list.
options — pointer to a null-terminated string of characters describing the compilation options used for building the program executable. The list of supported options is below, bestie.
num_input_headers — number of programs that describe headers in the array referenced by input_headers.
input_headers — an array of program embedded headers created with clCreateProgramWithSource(3clc).
header_include_names — array with a one-to-one correspondence with input_headers. Each entry specifies the include name used by source in program that comes from an embedded header. The corresponding entry in input_headers identifies the program object containing the header source to be used. Embedded headers are searched first before the headers in the list of directories specified by the –I compile option (as described in section 5.6.4.1). If multiple entries in header_include_names refer to the same header name, the first one encountered will be used.
pfn_notify — function pointer to a notification routine. The notification routine is a callback function that an application can register and which will be called when the program executable has been built (successfully or unsuccessfully). If pfn_notify is not NULL, clCompileProgram does not need to wait for the compiler to complete and can return immediately once the compilation can begin. The compilation can begin if the context, program whose sources are being compiled, list of devices, input headers, programs that describe input headers and compiler options specified are all valid and appropriate host and device resources needed to perform the compile are available. If pfn_notify is NULL, clCompileProgram does not return until the compiler has completed. This callback function may be called asynchronously by the OpenCL implementation. It is the application's responsibility to ensure that the callback function is thread-safe.
user_data — passed as an argument when pfn_notify is called. user_data can be NULL.

🦋 NOTES 🦋

clCompileProgram compiles a program's source for all devices or a specific device(s) in the OpenCL context associated with program. The pre-processor runs before the program sources are compiled. The compiled binary is built for all devices associated with program or the list of devices specified. The compiled binary can be queried using clGetProgramInfo(3clc)(program, CL_PROGRAM_BINARIES, ...) and can be specified to clCreateProgramWithBinary(3clc) to create a new program object.

Compiler Options. The compiler options are categorized as pre-processor options, options for math intrinsics, options that control optimization and miscellaneous options. This specification defines a standard set of options that must be supported by the OpenCL C compiler when building program executables online or offline. These may be extended by a set of vendor- or platform specific options.

🌈 Preprocessor Options 🌈

These options control the OpenCL C preprocessor which is run on each program source before actual compilation.

-D options are processed in the order they are given in the options argument to clBuildProgram or or clCompileProgram.

-D name — Predefine name as a macro, with definition 1.
-D name=definition — The contents of definition are tokenized and processed as if they appeared during translation phase three in a #define directive. In particular, the definition will be truncated by embedded newline characters.
-I dir — Add the directory dir to the list of directories to be searched for header files.

💅 Math Intrinsics Options 💅

These options control compiler behavior regarding floating-point arithmetic. These options trade off between speed and correctness.

-cl-single-precision-constant — Treat double precision floating-point constant as single precision constant.
-cl-denorms-are-zero — This option controls how single precision and double precision denormalized numbers are handled. If specified as a build option, the single precision denormalized numbers may be flushed to zero; double precision denormalized numbers may also be flushed to zero if the optional extension for double precision is supported. This is intended to be a performance hint and the OpenCL compiler can choose not to flush denorms to zero if the device supports single precision (or double precision) denormalized numbers.

This option is ignored for single precision numbers if the device does not support single precision denormalized numbers i.e. CL_FP_DENORM bit is not set in CL_DEVICE_SINGLE_FP_CONFIG.

This option is ignored for double precision numbers if the device does not support double precision or if it does support double precision but CL_FP_DENORM bit is not set in CL_DEVICE_DOUBLE_FP_CONFIG.

This flag only applies for scalar and vector single precision floating-point variables and computations on these floating-point variables inside a program. It does not apply to reading from or writing to image objects.

-cl-fp32-correctly-rounded-divide-sqrt — The -cl-fp32-correctly-rounded-divide-sqrt build option to clBuildProgram or clCompileProgram allows an application to specify that single precision floating-point divide (x/y and 1/x) and sqrt used in the program source are correctly rounded. If this build option is not specified, the minimum numerical accuracy of single precision floating-point divide and sqrt are as defined in section 7.4 of the OpenCL specification.

This build option can only be specified if the CL_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT is set in CL_DEVICE_SINGLE_FP_CONFIG (as defined in the table of allowed values for param_name for clGetDeviceInfo(3clc)) for devices that the program is being build. clBuildProgram or clCompileProgram will fail to compile the program for a device if the -cl-fp32-correctly-rounded-divide-sqrt option is specified and CL_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT is not set for the device.

✨ Optimization Options ✨

These options control various sorts of optimizations. Turning on optimization flags makes the compiler attempt to improve the performance and/or code size at the expense of compilation time and possibly the ability to debug the program.

-cl-opt-disable — This option disables all optimizations. The default is optimizations are enabled.

The following options control compiler behavior regarding floating-point arithmetic. These options trade off between performance and correctness and must be specifically enabled. These options are not turned on by default since it can result in incorrect output for programs which depend on an exact implementation of IEEE 754 rules/specifications for math functions.

-cl-mad-enable — Allow a * b + c to be replaced by a mad. The mad computes a * b + c with reduced accuracy. For example, some OpenCL devices implement mad as truncate the result of a * b before adding it to c.
-cl-no-signed-zeros — Allow optimizations for floating-point arithmetic that ignore the signedness of zero. IEEE 754 arithmetic specifies the distinct behavior of +0.0 and -0.0 values, which then prohibits simplification of expressions such as x+0.0 or 0.0*x (even with -clfinite-math only). This option implies that the sign of a zero result isn't significant.
-cl-unsafe-math-optimizations — Allow optimizations for floating-point arithmetic that (a) assume that arguments and results are valid, (b) may violate IEEE 754 standard and (c) may violate the OpenCL numerical compliance requirements as defined in section 7.4 for single precision and double precision floating-point, and edge case behavior in section 7.5. This option includes the -cl-no-signed-zeros and -cl-mad-enable options.
-cl-finite-math-only — Allow optimizations for floating-point arithmetic that assume that arguments and results are not NaNs or ±∞. This option may violate the OpenCL numerical compliance requirements defined in section 7.4 for single precision and double precision floating point, and edge case behavior in section 7.5.
-cl-fast-relaxed-math — Sets the optimization options -cl-finite-math-only and -cl-unsafe-math-optimizations. This allows optimizations for floating-point arithmetic that may violate the IEEE 754 standard and the OpenCL numerical compliance requirements defined in the specification in section 7.4 for single-precision and double precision floating-point, and edge case behavior in section 7.5. This option causes the preprocessor macro __FAST_RELAXED_MATH__ to be defined in the OpenCL program.

🌸 Options to Request or Suppress Warnings 🌸

Warnings are diagnostic messages that report constructions which are not inherently erroneous but which are risky or suggest there may have been an error. The following languageindependent options do not enable specific warnings but control the kinds of diagnostics produced by the OpenCL compiler.

-w — Inhibit all warning messages.
-Werror — Make all warnings into errors.

👑 Options Controlling the OpenCL C Version 👑

The following option controls the version of OpenCL C that the compiler accepts.

-cl-std= — Determine the OpenCL C language version to use. A value for this option must be provided. Valid values are:
CL1.1 — bestie, this one supports all the OpenCL C programs that use the OpenCL C language features defined in section 6 of the OpenCL 1.1 specification. periodt. ✨
CL1.2 — same energy, but for the OpenCL C language features defined in section 6 of the OpenCL 1.2 specification. slay. 💅

okay so listen 👀 calls to clBuildProgram or clCompileProgram with the -cl-std=CL1.1 option will fail to compile the program for any devices with CL_DEVICE_OPENCL_C_VERSION = OpenCL C 1.0. and calls to clBuildProgram or clCompileProgram with the -cl-std=CL1.2 option will fail to compile the program for any devices with CL_DEVICE_OPENCL_C_VERSION = OpenCL C 1.0 or OpenCL C 1.1. like it's just not gonna happen, no cap 😭

If the -cl-std build option is not specified, the CL_DEVICE_OPENCL_C_VERSION is used to select the version of OpenCL C to be used when compiling the program for each device. it just picks for u, main character behavior fr 🫶

🌸 Options for Querying Kernel Argument Information 🌸

-cl-kernel-arg-info — this lets the compiler stash info about the arguments of a kernel(s) inside the program executable. and what info exactly?? the argument name, its type, the address and access qualifiers used. so if u wanna know, go check the description of clGetKernelArgInfo(3clc) for how to query all that. iykyk 👑

🔗 Linker Options 🔗

okay so this spec defines a standard set of linker options that must be supported by the OpenCL C compiler when linking compiled programs — online or offline. these linker options are categorized as library linking options and program linking options. and they may be extended by a set of vendor- or platform-specific options, because of course they can 🎀

🍓 Library Linking Options 🍓

the following options can be specified when creating a library of compiled binaries.

-create-library — create a library of compiled binaries specified in the input_programs argument to clLinkProgram(3clc). literally what it says on the tin ✨
-enable-link-options — allows the linker to modify the library behavior based on one or more link options (described in Program Linking Options, below) when this library is linked with a program executable. this option must be specified with the -create-library option. it's a package deal bestie, no solo acts 💖

💫 Program Linking Options 💫

the following options can be specified when linking a program executable.

-cl-denorms-are-zero
-cl-no-signed-zeroes
-cl-unsafe-math-optimizations
-cl-finite-math-only
-cl-fast-relaxed-mat

The linker may apply these options to all compiled program objects specified to clLinkProgram(3clc). The linker may apply these options only to libraries which were created with the -enable-link-option. so like… it may. it also may not. the suspense is real 🙈

🦋 Separate Compilation and Linking of Programs 🦋

OpenCL 1.2 extends how programs are compiled and linked to support the following:

Separate compilation and link stages. Program sources can be compiled to generate a compiled binary object and linked in a separate stage with other compiled program objects to the program exectuable. two whole moments, iconic 🌈
Embedded headers. In OpenCL 1.0 and 1.1, the -I build option could be used to specify the list of directories to be searched for headers files that are included by a program source(s). OpenCL 1.2 extends this by allowing the header sources to come from program objects instead of just header files. glow up fr 💅
Libraries. The linker can be used to link compiled objects and libraries into a program executable or to create a library of compiled binarie

💀 ERRORS 💀

clCompileProgram returns CL_SUCCESS if the function is executed successfully. otherwise, it returns one of the following errors — buckle up bestie, it's a list 😭

CL_INVALID_PROGRAM if program is not a valid program object.
CL_INVALID_VALUE if device_list is NULL and num_devices is greater than zero, or if device_list is not NULL and num_devices is zero.
CL_INVALID_VALUE if num_input_headers is zero and header_include_names or input_headers are not NULL or if num_input_headers is not zero and header_include_names or input_headers are NULL.
CL_INVALID_VALUE if pfn_notify is NULL but user_data is not NULL.
CL_INVALID_DEVICE if OpenCL devices listed in device_list are not in the list of devices associated with program.
CL_INVALID_COMPILER_OPTIONS if the compiler options specified by options are invalid.
CL_INVALID_OPERATION if the compilation or build of a program executable for any of the devices listed in device_list by a previous call to clCompileProgram or clBuildProgram for program has not completed.
CL_COMPILER_NOT_AVAILABLE if a compiler is not available i.e. CL_DEVICE_COMPILER_AVAILABLE specified in in the table of allowed values for param_name for clGetDeviceInfo(3clc) is set to CL_FALSE.
CL_COMPILE_PROGRAM_FAILURE if there is a failure to compile the program source. This error will be returned if clCompileProgram does not return until the compile has completed.
CL_INVALID_OPERATION if there are kernel objects attached to program.
CL_INVALID_OPERATION if program has no source i.e. it has not been created with clCreateProgramWithSource(3clc).
CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

✨ Example ✨

for example, consider the following program source:

#include <foo.h>
#include <mydir/myinc.h>

__kernel void image_filter (int n, int m, __constant float *filter_weights,
                            __read_only image2d_t src_image,
                            __write_only image2d_t dst_image) {
    ...
}

This kernel includes two headers foo.h and mydir/myinc.h. The following describes how these headers can be passed as embedded headers in program objects:

cl_program foo_pg = clCreateProgramWithSource(context, 1,
                                              &foo_header_src, NULL, &err);
cl_program myinc_pg = clCreateProgramWithSource(context, 1,
                                                &myinc_header_src, NULL, &err);

// let’s assume the program source described above is given
// by program_A and is loaded via clCreateProgramWithSource

cl_program input_headers[2] = { foo_pg, myinc_pg };
char * input_header_names[2] = { "foo.h", "mydir/myinc.h" };
clCompileProgram(program_A,
                 0, NULL,       // num_devices & device_list
                 NULL,          // compile_options
                 2,             // num_input_headers
                 input_headers,
                 input_header_names,
                 NULL, NULL);   // pfn_notify & user_data

📜 SPECIFICATION 📜

OpenCL Specification[1]

👀 SEE ALSO 👀

clGetDeviceInfo(3clc)

🫶 AUTHORS 🫶

The Khronos Group

💖 COPYRIGHT 💖

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.

🌟 NOTES 🌟

OpenCL Specification page 139, section 5.6.3 - Separate Compilation and Linking of Programs

and that's the whole page bestie, we ate and left no crumbs 🎀 this was brought to u by The Khronos Group, dated 01/14/2021, and it lives in the man page CLCOMPILEPROGRAM(3clc) — go forth and compile responsibly 💜

📦 where this page comes from

ubuntu jammy: opencl-1.2-man-doc 1.0~svn33624-5 · other
ubuntu noble: opencl-1.2-man-doc 1.0~svn33624-5 · other
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms