Class BinaryLookup

src/include/binary_lookup.h:109–269

BinaryLookup defines an API to manage the kernel cache on the disk The BinaryLookup object provides methods to: check if a cache file exists on the disk or not fill-up the signature to characterize the program beeing built on the disk build a cl_program from a string kernel or from a binary A cache entry is a file stored on the disk which contains 3 sections: A header section (providing informat

//
//
class BinaryLookup
 {
public:
    // Constructor
    // \param ctxt the context for which the cl_program should be built
    // \param device the device for which the cl_program should be built
    // \param kernel_name the kernel identifier
    BinaryLookup(cl_context ctxt, cl_device_id device, const std::string & kernel_name);
    ~BinaryLookup();

    // Methods to fill up the signature of the cache entry
    void variantInt(int num);
    void variantDouble(double num);
    void variantCompileOptions(const std::string & opts);
    void variantRaw(const void * data, size_t bytes);

    // Indicates whether or not the cache entry was found on the disk
    // If the cache entry was found and is complete on the disk, its content
    // is loaded
    // \return true if a cache entry was found, false else
    bool found();

    // Build a cl_program from the source code and init attributes
    // of the current structure
    // so that the program can be accessed with the getProgram method
    // Write the file to the cache
    cl_int buildFromSource(const char * source);

    // Build a cl_program from the source code and init attributes
    // so that the program can be accessed with the getProgram method
    // Write the file to the cache
    cl_int buildFromBinary(const void * data, 
                           size_t len,
                           const char * BuildOption);

    // Returns the cl_program built from binary or loaded from disk
    cl_program getProgram();

    // Set the current m_program to the given program
    void setProgram(cl_program program);

    // Build a cl_program from a text
    static cl_program buildProgramFromSource(const char * filename,
                                             cl_context context,
                                             cl_device_id device,
                                             cl_int & err,
                                             const char * options = 0);

    // Build a cl_program from binary
    static cl_program buildProgramFromBinary(const char * data,
                                             size_t data_size,
                                             cl_context context,
                                             cl_device_id device,
                                             cl_int & err,
                                             const char * options = 0);

    // Initialize the whole cache file information (magic_key, header and program)
    // and dump on the disk