saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-30 20:18:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[VitisAI] Add Version Check. Requsted by Microsoft (#20347)

Browse source 
### Description
<!-- Describe your changes. -->
Add version for onnxruntime_providers_vitisai.dll. So, the
onnxruntime_vitisai_ep.dll can check if the version is compatible.
To make sure the old onnxruntime_vitisai_ep.dll still work, we would
offset the api struct by version field.


### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
This is the direct request from Microsoft. The following is the problem
we try to solve:

How would you describe the dependency between (a)
onnxruntime_vitisai_ep.dll and (b) onnxruntime_providers_vitisai.dll?
E.g. for each version of (a) there is a minimum required version of (b),
or for each version of (b) there is minimum required version of (a).

Please note that in practice we won't be able to use the exact version
of ORT/EP that you tested against (because we might need to update ORT
for other reasons), but we might be able to accommodate some version
constraints that you specify. As we approach shipping, we'll lock the
version of ORT/EP to allow for stabilization and more detailed testing
(and work with you if it needs to be updated).
This commit is contained in:
Yueqing Zhang 2024-04-19 14:05:44 +08:00 committed by GitHub
parent 12569626cb
commit 9001c69b84
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
onnxruntime/core/providers/vitisai/imp/global_api.cc
View file

@ -52,6 +52,7 @@ struct OrtVitisAIEpAPI {
const char* json_config);
std::vector<std::unique_ptr<vaip_core::ExecutionProvider>>* (*compile_onnx_model_with_options)(
const std::string& model_path, const onnxruntime::Graph& graph, const onnxruntime::ProviderOptions& options);
uint32_t (*vaip_get_version)();
void Ensure() {
if (handle_)
return;
@ -65,6 +66,8 @@ struct OrtVitisAIEpAPI {
::onnxruntime::LogRuntimeError(0, status1, __FILE__, static_cast<const char*>(__FUNCTION__), __LINE__);
ORT_THROW(status1);
}
std::ignore = env.GetSymbolFromLibrary(handle_, "vaip_get_version",
(void**)&vaip_get_version);
}
private:
@ -177,8 +180,17 @@ void initialize_vitisai_ep() {
create_kernel_registry(s_domains_vitisaiep);
}
static void set_version_info(vaip_core::OrtApiForVaip& api) {
const char* magic = "VAIP";
std::memcpy(reinterpret_cast<char*>(&api.magic), magic, sizeof(api.magic));
api.major = 1u;
api.minor = 0u;
api.patch = 0u;
}
vaip_core::OrtApiForVaip* create_org_api_hook() {
InitProviderOrtApi();
set_version_info(the_global_api);
the_global_api.host_ = Provider_GetHost();
assert(Ort::Global<void>::api_ != nullptr);
the_global_api.ort_api_ = Ort::Global<void>::api_;
@ -359,5 +371,9 @@ vaip_core::OrtApiForVaip* create_org_api_hook() {
the_global_api.get_lib_id = []() -> vaip_core::DllSafe<std::string> {
return vaip_core::DllSafe(std::string(GIT_COMMIT_ID));
};
return &the_global_api;
if (!s_library_vitisaiep.vaip_get_version) {
return reinterpret_cast<vaip_core::OrtApiForVaip*>(&(the_global_api.host_));
} else {
return &the_global_api;
}
}

8
onnxruntime/core/providers/vitisai/include/vaip/vaip_ort_api.h
View file

@ -13,6 +13,14 @@ struct OrtApi;
namespace vaip_core {
struct OrtApiForVaip {
uint32_t magic; // 'VAIP' or something else to make sure the following field
// are not garbage.
uint32_t major; // bump this field changes that are not backward compatible or
// that represent a change in direction for the project
uint32_t minor; // bump this field for adding new features without breaking
// existing behavior
uint32_t patch; // bump this field for fixing some bugs but not introducing
// new functionality
onnxruntime::ProviderHost* host_;
const OrtApi* ort_api_;
// model