/* * Copyright (C) 2018-2023 Intel Corporation * * SPDX-License-Identifier: MIT * */ #pragma once #include "shared/offline_compiler/source/ocloc_arg_helper.h" #include "shared/offline_compiler/source/ocloc_fcl_facade.h" #include "shared/offline_compiler/source/ocloc_igc_facade.h" #include "shared/source/helpers/hw_info.h" #include "shared/source/utilities/arrayref.h" #include "shared/source/utilities/const_stringref.h" #include "ocl_igc_interface/code_type.h" #include #include #include namespace NEO { struct HardwareInfo; class OsLibrary; class CompilerCache; std::string convertToPascalCase(const std::string &inString); std::string generateFilePath(const std::string &directory, const std::string &fileNameBase, const char *extension); std::string getSupportedDevices(OclocArgHelper *helper); class OfflineCompiler { public: static int query(size_t numArgs, const std::vector &allArgs, OclocArgHelper *helper); static int queryAcronymIds(size_t numArgs, const std::vector &allArgs, OclocArgHelper *helper); static OfflineCompiler *create(size_t numArgs, const std::vector &allArgs, bool dumpFiles, int &retVal, OclocArgHelper *helper); MOCKABLE_VIRTUAL int build(); std::string &getBuildLog(); void printUsage(); static constexpr ConstStringRef queryHelp = "Depending on will generate file\n" "(with a name adequate to )\n" "containing either driver version or NEO revision hash.\n\n" "Usage: ocloc query \n\n" "Supported query options:\n" " OCL_DRIVER_VERSION ; returns driver version\n" " NEO_REVISION ; returns NEO revision hash\n\n" "Examples:\n" " Extract driver version\n" " ocloc query OCL_DRIVER_VERSION\n"; static constexpr ConstStringRef idsHelp = R"===( Depending on will return all matched versions (..) that correspond to the given name. All supported acronyms: %s. )==="; OfflineCompiler &operator=(const OfflineCompiler &) = delete; OfflineCompiler(const OfflineCompiler &) = delete; MOCKABLE_VIRTUAL ~OfflineCompiler(); bool isQuiet() const { return quiet; } bool isOnlySpirV() const { return onlySpirV; } std::string parseBinAsCharArray(uint8_t *binary, size_t size, std::string &fileName); static bool readOptionsFromFile(std::string &optionsOut, const std::string &file, OclocArgHelper *helper); ArrayRef getPackedDeviceBinaryOutput() { return this->elfBinary; } static std::string getFileNameTrunk(std::string &filePath); const HardwareInfo &getHardwareInfo() const { return hwInfo; } std::string getOptionsReadFromFile() const { return optionsReadFromFile; } std::string getInternalOptionsReadFromFile() const { return internalOptionsReadFromFile; } bool showHelpOnly() const { return showHelp; } protected: OfflineCompiler(); int initHardwareInfo(std::string deviceName); int initHardwareInfoForProductConfig(std::string deviceName); int initHardwareInfoForDeprecatedAcronyms(std::string deviceName, std::unique_ptr &&compilerProductHelper); bool isArgumentDeviceId(const std::string &argument) const; std::string getStringWithinDelimiters(const std::string &src); int initialize(size_t numArgs, const std::vector &allArgs, bool dumpFiles); int parseCommandLine(size_t numArgs, const std::vector &allArgs); void setStatelessToStatefulBufferOffsetFlag(); void appendExtraInternalOptions(std::string &internalOptions); void parseDebugSettings(); void storeBinary(char *&pDst, size_t &dstSize, const void *pSrc, const size_t srcSize); MOCKABLE_VIRTUAL int buildSourceCode(); MOCKABLE_VIRTUAL std::string validateInputType(const std::string &input, bool isLlvm, bool isSpirv); MOCKABLE_VIRTUAL int buildIrBinary(); void updateBuildLog(const char *pErrorString, const size_t errorStringSize); MOCKABLE_VIRTUAL bool generateElfBinary(); std::string generateFilePathForIr(const std::string &fileNameBase) { const char *ext = (isSpirV) ? ".spv" : ".bc"; return generateFilePath(outputDirectory, fileNameBase, useLlvmText ? ".ll" : ext); } std::string generateOptsSuffix() { std::string suffix{useOptionsSuffix ? options : ""}; std::replace(suffix.begin(), suffix.end(), ' ', '_'); return suffix; } MOCKABLE_VIRTUAL void writeOutAllFiles(); MOCKABLE_VIRTUAL void createDir(const std::string &path); void unifyExcludeIrFlags(); void enforceFormat(std::string &format); HardwareInfo hwInfo; AOT::PRODUCT_CONFIG deviceConfig = {}; std::string deviceName; std::string productFamilyName; std::string inputFile; std::string outputFile; std::string outputDirectory; std::string options; std::string internalOptions; std::string sourceCode; std::string buildLog; std::string optionsReadFromFile = ""; std::string internalOptionsReadFromFile = ""; std::string formatToEnforce = ""; std::string irHash, genHash, dbgHash, elfHash; std::string cacheDir; bool allowCaching = false; bool dumpFiles = true; bool useLlvmText = false; bool useLlvmBc = false; bool useCppFile = false; bool useGenFile = false; bool useOptionsSuffix = false; bool quiet = false; bool onlySpirV = false; bool inputFileLlvm = false; bool inputFileSpirV = false; bool outputNoSuffix = false; bool forceStatelessToStatefulOptimization = false; bool isSpirV = false; bool showHelp = false; bool excludeIr = false; std::vector elfBinary; size_t elfBinarySize = 0; char *genBinary = nullptr; size_t genBinarySize = 0; char *irBinary = nullptr; size_t irBinarySize = 0; char *debugDataBinary = nullptr; size_t debugDataBinarySize = 0; struct buildInfo; std::unique_ptr pBuildInfo; int revisionId = -1; uint64_t hwInfoConfig = 0u; std::unique_ptr igcFacade{nullptr}; std::unique_ptr fclFacade{nullptr}; std::unique_ptr cache; std::unique_ptr compilerProductHelper; IGC::CodeType::CodeType_t preferredIntermediateRepresentation; OclocArgHelper *argHelper = nullptr; }; } // namespace NEO