ocloc help cleanup

Change-Id: I4378fa306e3a2b3ec219800a61dbae6c7115808a
This commit is contained in:
chmielew
2019-07-04 10:29:41 +02:00
committed by sys_ocldev
parent 009dbc45e2
commit 369982995d
4 changed files with 77 additions and 32 deletions

View File

@ -19,30 +19,38 @@
using namespace NEO;
void printHelp() {
printf(R"===(ocloc is a tool for offline compilation to Intel OCL GPU device binary files.
It can be used for generation as well as manipulation (decoding/modifying)
of such binary files.
printf(R"===(ocloc is a tool for managing Intel OpenCL GPU device binary format.
It can be used for generation (as part of 'compile' command) as well as
manipulation (decoding/modifying - as part of 'disasm'/'asm' commands) of such
binary files.
Intel OpenCL GPU device binary is a format used by Intel OpenCL GPU runtime
(aka NEO). Intel OpenCL GPU runtime will return this binary format when queried
using clGetProgramInfo(..., CL_PROGRAM_BINARIES, ...). It will also honor
this format as input to clCreateProgramWithBinary function call.
ocloc does not require Intel GPU device to be present in the system nor does it
depend on Intel OpenCL GPU runtime driver to be installed. It does however rely
on the same set of compilers (IGC, common_clang) as the runtime driver.
Usage: ocloc [--help] <command> [<command_args>]
Available commands are listed below.
Use 'ocloc <command> --help' to get help about specific command.
Commands:
compile Compiles input to Intel OCL GPU device binary.
disasm Disassembles Intel OCL GPU device binary.
asm Assembles Intel OCL GPU device binary.
compile Compiles input to Intel OpenCL GPU device binary.
disasm Disassembles Intel OpenCL GPU device binary.
asm Assembles Intel OpenCL GPU device binary.
multi Compiles multiple files using a config file.
Default command (when none provided) is 'compile'.
Examples:
Compile file to Intel OCL GPU device binary (out = source_file_Gen9core.bin)
Compile file to Intel OpenCL GPU device binary (out = source_file_Gen9core.bin)
ocloc -file source_file.cl -device skl
Disassemble Intel OCL GPU device binary
Disassemble Intel OpenCL GPU device binary
ocloc disasm -file source_file_Gen9core.bin
Assemble to Intel OCL GPU device binary (after above disasm)
Assemble to Intel OpenCL GPU device binary (after above disasm)
ocloc asm -out reassembled.bin
)===");
}