You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tvm.apache.org by "masahi (via GitHub)" <gi...@apache.org> on 2023/05/06 19:55:25 UTC
[GitHub] [tvm] masahi opened a new pull request, #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion.
masahi opened a new pull request, #14792:
URL: https://github.com/apache/tvm/pull/14792
This is the first step toward supporting Intel XMX (tensorcore equivalent of Intel dGPUs). They expose XMX via SPIRV, and such SPIRV modules can be consumed by their OpenCL runtime.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] echuraev commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "echuraev (via GitHub)" <gi...@apache.org>.
echuraev commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187431236
##########
src/target/spirv/spirv_utils.cc:
##########
@@ -0,0 +1,188 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*!
+ * \file spirv_utils.cc
+ * \brief Build SPIRV block
+ */
+// Use libspirv for parsing and validating code.
+#include "spirv_utils.h"
+
+#if TVM_ENABLE_SPIRV
+#include <libspirv.h>
+
+#include "codegen_spirv.h"
+#endif
+
+#include <tvm/tir/transform.h>
+
+#include <algorithm>
+#include <fstream>
+#include <sstream>
+#include <vector>
+
+#include "../../runtime/spirv/spirv_shader.h"
+#include "../../support/utils.h"
+
+namespace tvm {
+namespace codegen {
+
+#if TVM_ENABLE_SPIRV
+
+class SPIRVTools {
+ public:
+ explicit SPIRVTools(Target target) {
+ uint32_t vulkan_version =
+ target->GetAttr<Integer>("vulkan_api_version").value_or(VK_API_VERSION_1_0).IntValue();
+ uint32_t spirv_version =
+ target->GetAttr<Integer>("max_spirv_version").value_or(0x10000).IntValue();
+
+ spv_target_env validation_version;
+ if (target->kind->name == "opencl") {
+ validation_version = SPV_ENV_OPENCL_2_2;
+ } else {
+ if (vulkan_version >= VK_API_VERSION_1_2) {
+ validation_version = SPV_ENV_VULKAN_1_2;
+ } else if (vulkan_version >= VK_API_VERSION_1_1 && spirv_version >= 0x10400) {
+ validation_version = SPV_ENV_VULKAN_1_1_SPIRV_1_4;
+ } else if (vulkan_version >= VK_API_VERSION_1_1) {
+ validation_version = SPV_ENV_VULKAN_1_1;
+ } else {
+ validation_version = SPV_ENV_VULKAN_1_0;
+ }
+ }
+ ctx_ = spvContextCreate(validation_version);
+ }
+
+ ~SPIRVTools() { spvContextDestroy(ctx_); }
+
+ std::string BinaryToText(const std::vector<uint32_t>& bin) {
+ spv_text text = nullptr;
+ spv_diagnostic diagnostic = nullptr;
+ spv_const_binary_t spv_bin{bin.data(), bin.size()};
+
+ spv_result_t res =
+ spvBinaryToText(ctx_, spv_bin.code, spv_bin.wordCount,
+ SPV_BINARY_TO_TEXT_OPTION_FRIENDLY_NAMES | SPV_BINARY_TO_TEXT_OPTION_INDENT,
+ &text, &diagnostic);
+
+ ICHECK_EQ(res, SPV_SUCCESS) << " line=" << diagnostic->position.line
+ << " column=" << diagnostic->position.column
+ << " index=" << diagnostic->position.index
+ << " error:" << diagnostic->error;
+ spvDiagnosticDestroy(diagnostic);
+
+ std::string ret(text->str);
+ spvTextDestroy(text);
+ return ret;
+ }
+
+ void ValidateShader(const std::vector<uint32_t>& bin) {
+ spv_const_binary_t spv_bin{bin.data(), bin.size()};
+
+ spv_diagnostic diagnostic = nullptr;
+ spv_result_t res = spvValidate(ctx_, &spv_bin, &diagnostic);
+
+ ICHECK_EQ(res, SPV_SUCCESS) << " index=" << diagnostic->position.index
+ << " error:" << diagnostic->error;
+
+ spvDiagnosticDestroy(diagnostic);
+ }
+
+ private:
+ spv_context ctx_;
+};
+
+std::pair<std::unordered_map<std::string, runtime::SPIRVShader>, std::string> LowerToSPIRV(
+ IRModule mod, Target target) {
+ using tvm::runtime::Registry;
+ using tvm::runtime::SPIRVShader;
+
+ std::ostringstream code_data;
+ SPIRVTools spirv_tools(target);
+ std::unordered_map<std::string, SPIRVShader> smap;
+
+ const auto* postproc = Registry::Get("tvm_callback_vulkan_postproc");
+
+ mod = tir::transform::PointerValueTypeRewrite()(std::move(mod));
+
+ CodeGenSPIRV cg(target);
+
+ for (auto kv : mod->functions) {
+ ICHECK(kv.second->IsInstance<PrimFuncNode>()) << "CodeGenSPIRV: Can only take PrimFunc";
+ auto f = Downcast<PrimFunc>(kv.second);
+ auto calling_conv = f->GetAttr<Integer>(tvm::attr::kCallingConv);
+ ICHECK(calling_conv == CallingConv::kDeviceKernelLaunch)
+ << "CodeGenSPIRV: expect calling_conv equals CallingConv::kDeviceKernelLaunch";
+ auto global_symbol = f->GetAttr<String>(tvm::attr::kGlobalSymbol);
+ ICHECK(global_symbol.defined())
+ << "CodeGenSPIRV: Expect PrimFunc to have the global_symbol attribute";
+
+ std::string f_name = global_symbol.value();
+ std::string entry = f_name;
+
+ SPIRVShader shader = cg.BuildFunction(f, entry);
+
+ if (auto path = std::getenv("TVM_VULKAN_DEBUG_SHADER_SAVEPATH")) {
+ if (*path) {
+ std::stringstream ss;
+ ss << path << "/" << f_name << "_";
+ std::string prefix = ss.str();
+
+ std::ofstream(prefix + "tir.txt") << f;
+ std::ofstream(prefix + "spv.txt") << spirv_tools.BinaryToText(shader.data);
+ std::ofstream(prefix + "spv.spv", std::ios::binary)
+ .write(reinterpret_cast<const char*>(shader.data.data()),
+ sizeof(shader.data[0]) * shader.data.size());
+ }
+ }
+
+ if (!support::BoolEnvironmentVar("TVM_VULKAN_DISABLE_SHADER_VALIDATION")) {
+ spirv_tools.ValidateShader(shader.data);
+ }
+
+ if (postproc != nullptr) {
+ TVMByteArray arr;
+ arr.data = reinterpret_cast<const char*>(dmlc::BeginPtr(shader.data));
+ arr.size = shader.data.size() * sizeof(uint32_t);
+ std::string transformed = (*postproc)(arr);
+ ICHECK_EQ(transformed.length() % 4U, 0U);
+ shader.data.resize(transformed.size() / 4U);
+ std::copy(transformed.begin(), transformed.end(),
+ reinterpret_cast<char*>(dmlc::BeginPtr(shader.data)));
+ }
+ code_data << spirv_tools.BinaryToText(shader.data);
+ smap[f_name] = std::move(shader);
+ }
+
+ return std::make_pair(smap, code_data.str());
+}
+
+#else
+
+std::pair<std::unordered_map<std::string, runtime::SPIRVShader>, std::string> LowerToSPIRV(
+ IRModule mod, Target target) {
+ LOG(FATAL) << "LowerToSPIRV is called but Vulkan is not enabled.";
Review Comment:
Probably Vulkan should be removed from the error message, then error message will be more generic?
##########
src/runtime/spirv/spirv_shader.h:
##########
@@ -31,7 +31,7 @@ namespace tvm {
namespace runtime {
namespace vulkan {
Review Comment:
I suppose it should be another namespace.
```suggestion
namespace spirv {
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] masahi commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "masahi (via GitHub)" <gi...@apache.org>.
masahi commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187288604
##########
src/runtime/opencl/opencl_module.cc:
##########
@@ -108,7 +109,27 @@ class OpenCLWrappedFunc {
LaunchParamConfig launch_param_config_;
};
-OpenCLModuleNode::~OpenCLModuleNode() {
+class OpenCLSPIRVModuleNode : public OpenCLModuleNodeBase {
Review Comment:
Ok, made the following changes:
* Add `runtime/spirv` dir and put `SPIRVShader` there
* Add `runtime/opencl/opencl_module_spirv.cc` and put `OpenCLSPIRVModuleNode` and related code there.
Overall I also like this organization. Please take a look.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] echuraev commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "echuraev (via GitHub)" <gi...@apache.org>.
echuraev commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187015136
##########
src/runtime/opencl/opencl_module.cc:
##########
@@ -108,7 +109,27 @@ class OpenCLWrappedFunc {
LaunchParamConfig launch_param_config_;
};
-OpenCLModuleNode::~OpenCLModuleNode() {
+class OpenCLSPIRVModuleNode : public OpenCLModuleNodeBase {
Review Comment:
Probably all runtime part related to SPIRV can be moved in a new directory in `src/runtime`? I suppose that SPIRV can be useful no only for Vulcan, so SPIRV can be separated from other runtimes initially. What do you think?
##########
src/target/source/codegen_opencl.cc:
##########
@@ -585,6 +586,14 @@ void CodeGenOpenCL::SetTextureScope(
}
runtime::Module BuildOpenCL(IRModule mod, Target target) {
+#if TVM_USE_VULKAN
Review Comment:
Probably this variable can be device-agnostic? Like: `TVM_USE_SPIRV` or something like that.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] masahi commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "masahi (via GitHub)" <gi...@apache.org>.
masahi commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187021774
##########
src/runtime/opencl/opencl_module.cc:
##########
@@ -108,7 +109,27 @@ class OpenCLWrappedFunc {
LaunchParamConfig launch_param_config_;
};
-OpenCLModuleNode::~OpenCLModuleNode() {
+class OpenCLSPIRVModuleNode : public OpenCLModuleNodeBase {
Review Comment:
This class is still specific to OpenCL. Other than the input binary format and kernel initialization, most runtime code are shared between the normal OpenCL runtime and the new one that consumes SPIRV. So I want to put it here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] masahi commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "masahi (via GitHub)" <gi...@apache.org>.
masahi commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187288604
##########
src/runtime/opencl/opencl_module.cc:
##########
@@ -108,7 +109,27 @@ class OpenCLWrappedFunc {
LaunchParamConfig launch_param_config_;
};
-OpenCLModuleNode::~OpenCLModuleNode() {
+class OpenCLSPIRVModuleNode : public OpenCLModuleNodeBase {
Review Comment:
Ok, made the following changes:
* Add `runtime/spirv` dir and put `SPIRVShader` there
* Add `runtime/opencl_module_spirv.cc` and put `OpenCLSPIRVModuleNode` and related code there.
Overall I also like this organization. Please take a look.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] masahi commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "masahi (via GitHub)" <gi...@apache.org>.
masahi commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187022499
##########
src/target/source/codegen_opencl.cc:
##########
@@ -585,6 +586,14 @@ void CodeGenOpenCL::SetTextureScope(
}
runtime::Module BuildOpenCL(IRModule mod, Target target) {
+#if TVM_USE_VULKAN
Review Comment:
Okay I'll change it to `TVM_HAS_SPIRV` which, for now, is set to true only when `USE_VULKAN=ON`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] tvm-bot commented on pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion.
Posted by "tvm-bot (via GitHub)" <gi...@apache.org>.
tvm-bot commented on PR #14792:
URL: https://github.com/apache/tvm/pull/14792#issuecomment-1537212275
<!---bot-comment-->
Thanks for contributing to TVM! Please refer to the contributing guidelines https://tvm.apache.org/docs/contribute/ for useful information and tips. Please request code reviews from [Reviewers](https://github.com/apache/incubator-tvm/blob/master/CONTRIBUTORS.md#reviewers) by @-ing them in a comment.
<!--bot-comment-ccs-start-->
* cc @echuraev, @elvin-n <sub>See [#10317](https://github.com/apache/tvm/issues/10317) for details</sub><!--bot-comment-ccs-end-->
<sub>Generated by [tvm-bot](https://github.com/apache/tvm/blob/main/ci/README.md#github-actions)</sub>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] echuraev merged pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "echuraev (via GitHub)" <gi...@apache.org>.
echuraev merged PR #14792:
URL: https://github.com/apache/tvm/pull/14792
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] masahi commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "masahi (via GitHub)" <gi...@apache.org>.
masahi commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187028643
##########
src/target/source/codegen_opencl.cc:
##########
@@ -585,6 +586,14 @@ void CodeGenOpenCL::SetTextureScope(
}
runtime::Module BuildOpenCL(IRModule mod, Target target) {
+#if TVM_USE_VULKAN
Review Comment:
Changed to `TVM_ENABLE_SPIRV`, thanks for the suggestion!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [tvm] echuraev commented on a diff in pull request #14792: [OpenCL] Refactor OpenCL runtime to support SPIRV binary ingestion
Posted by "echuraev (via GitHub)" <gi...@apache.org>.
echuraev commented on code in PR #14792:
URL: https://github.com/apache/tvm/pull/14792#discussion_r1187033774
##########
src/runtime/opencl/opencl_module.cc:
##########
@@ -108,7 +109,27 @@ class OpenCLWrappedFunc {
LaunchParamConfig launch_param_config_;
};
-OpenCLModuleNode::~OpenCLModuleNode() {
+class OpenCLSPIRVModuleNode : public OpenCLModuleNodeBase {
Review Comment:
Probably in this case, `SPIRVShader` from Vulcan can be moved to OpenCL directory? And I'm ok if it is in the same files with OpenCL runtime. Just as an idea, probably the SPIRV part can be moved to new files such as `spirv_module.h/cc`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org