resolve feedbacks

Author: xhan65

include/onnxruntime/core/session/environment.h

@@ -146,7 +146,7 @@ class Environment {
     return execution_devices_;
   }
 
-  /// Get hardware device incompatibility reasons for a specific EP.
+  /// Get hardware device incompatibility details for a specific EP.
   /// @param ep_name The name of the execution provider to check.
   /// @param hw The hardware device to check for incompatibility.
   /// @param details Output: Incompatibility details including reasons for incompatibility if any.

include/onnxruntime/core/session/onnxruntime_c_api.h

@@ -518,7 +518,7 @@ typedef enum OrtDeviceEpIncompatibilityReason {
   OrtDeviceEpIncompatibility_DRIVER_INCOMPATIBLE = 1 << 0,
   OrtDeviceEpIncompatibility_DEVICE_INCOMPATIBLE = 1 << 1,
   OrtDeviceEpIncompatibility_MISSING_DEPENDENCY = 1 << 2,
-  OrtDeviceEpIncompatibility_UNKNOWN = 1 << 30
+  OrtDeviceEpIncompatibility_UNKNOWN = 1 << 31
 } OrtDeviceEpIncompatibilityReason;
 
 /** \brief Delegate to allow providing custom OrtEpDevice selection logic

include/onnxruntime/core/session/onnxruntime_ep_c_api.h

@@ -1308,13 +1308,14 @@ struct OrtEpApi {
    */
   ORT_API2_STATUS(KernelInfo_GetEp, _In_ const OrtKernelInfo* info, _Outptr_ const OrtEp** ep);
 
-  /** \brief Initialize an OrtDeviceEpIncompatibilityDetails instance.
+  /** \brief Set the details of an OrtDeviceEpIncompatibilityDetails instance.
    *
-   * Used by execution provider factories to initialize incompatibility details in their
-   * GetHardwareDeviceIncompatibilityDetails implementation. ORT creates the object and passes it
-   * to the EP, which uses this function to set the incompatibility information.
+   * Used by execution provider factories to set incompatibility details in their
+   * GetHardwareDeviceIncompatibilityDetails implementation. ORT creates and initializes the object
+   * before passing it to the EP, so calling this function is optional. The EP uses this function
+   * to set incompatibility information when the device is not compatible.
    *
-   * \param[in,out] details The OrtDeviceEpIncompatibilityDetails instance to initialize.
+   * \param[in,out] details The OrtDeviceEpIncompatibilityDetails instance to update.
    * \param[in] reasons_bitmask Bitmask of OrtDeviceEpIncompatibilityReason values. (0 = no incompatibility).
    * \param[in] error_code Optional EP-specific error code (0 = no error).
    * \param[in] notes Optional human-readable notes. Can be null.
@@ -1323,7 +1324,7 @@ struct OrtEpApi {
    *
    * \since Version 1.24.
    */
-  ORT_API2_STATUS(DeviceEpIncompatibilityDetails_Initialize, _Inout_ OrtDeviceEpIncompatibilityDetails* details,
+  ORT_API2_STATUS(DeviceEpIncompatibilityDetails_SetDetails, _Inout_ OrtDeviceEpIncompatibilityDetails* details,
                   _In_ uint32_t reasons_bitmask,
                   _In_ int32_t error_code,
                   _In_opt_z_ const char* notes);
@@ -2014,14 +2015,14 @@ struct OrtEpFactory {
    *
    * This function allows an execution provider to check if a specific hardware device is compatible
    * with the execution provider. The EP can set specific incompatibility reasons via the
-   * OrtDeviceEpIncompatibilityDetails parameter using OrtEpApi::DeviceEpIncompatibilityDetails_Initialize.
+   * OrtDeviceEpIncompatibilityDetails parameter using OrtEpApi::DeviceEpIncompatibilityDetails_SetDetails.
    *
    * \param[in] this_ptr The OrtEpFactory instance.
    * \param[in] hw The hardware device to check for incompatibility.
-   * \param[in,out] details Pre-allocated incompatibility details object created by ORT.
-   *                        The EP should initialize this using OrtEpApi::DeviceEpIncompatibilityDetails_Initialize
-   *                        to set any incompatibility information. If the device is compatible, the EP can
-   *                        leave the object uninitialized (it defaults to no incompatibility).
+   * \param[in,out] details Pre-allocated incompatibility details object created and initialized by ORT.
+   *                        The EP can use OrtEpApi::DeviceEpIncompatibilityDetails_SetDetails to set
+   *                        incompatibility information. If the device is compatible, the EP can
+   *                        leave the object unchanged (it defaults to no incompatibility).
    *
    * \note Implementation of this function is optional.
    *       If not implemented, ORT will assume the device is compatible with this EP.

onnxruntime/core/session/environment.cc

@@ -668,10 +668,6 @@ Status Environment::GetHardwareDeviceEpIncompatibilityDetails(
 
   // ORT creates the details object with default values (compatible)
   details = std::make_unique<OrtDeviceEpIncompatibilityDetails>();
-  details->reasons_bitmask = 0;
-  details->error_code = 0;
-  details->notes = "";
-
   // If the factory implements GetHardwareDeviceIncompatibilityDetails, let it initialize the details
   if (matched_factory->GetHardwareDeviceIncompatibilityDetails != nullptr) {
     OrtStatusPtr status = matched_factory->GetHardwareDeviceIncompatibilityDetails(matched_factory, hw, details.get());

onnxruntime/core/session/onnxruntime_c_api.cc

@@ -4410,9 +4410,14 @@ ORT_API_STATUS_IMPL(OrtApis::GetHardwareDevices, _In_ const OrtEnv* env,
 
   const auto& device_vector = env->GetEnvironment().GetSortedOrtHardwareDevices();
   size_t available_devices = device_vector.size();
-  size_t copy_count = std::min(num_devices, available_devices);
 
-  for (size_t i = 0; i < copy_count; ++i) {
+  if (num_devices < available_devices) {
+    return OrtApis::CreateStatus(ORT_INVALID_ARGUMENT,
+                                 "num_devices is less than the number of available hardware devices. "
+                                 "Use GetNumHardwareDevices() to get the required array size.");
+  }
+
+  for (size_t i = 0; i < available_devices; ++i) {
     devices[i] = device_vector[i];
   }
 

onnxruntime/core/session/plugin_ep/ep_api.cc

@@ -656,7 +656,7 @@ ORT_API_STATUS_IMPL(KernelInfo_GetEp, _In_ const OrtKernelInfo* info, _Outptr_ c
   API_IMPL_END
 }
 
-ORT_API_STATUS_IMPL(DeviceEpIncompatibilityDetails_Initialize, _Inout_ OrtDeviceEpIncompatibilityDetails* details,
+ORT_API_STATUS_IMPL(DeviceEpIncompatibilityDetails_SetDetails, _Inout_ OrtDeviceEpIncompatibilityDetails* details,
                     _In_ uint32_t reasons_bitmask,
                     _In_ int32_t error_code,
                     _In_opt_z_ const char* notes) {
@@ -840,7 +840,7 @@ static constexpr OrtEpApi ort_ep_api = {
     &OrtExecutionProviderApi::EpGraphSupportInfo_LookUpKernel,
     &OrtExecutionProviderApi::SharedPrePackedWeightCache_StoreWeightData,
     &OrtExecutionProviderApi::KernelInfo_GetEp,
-    &OrtExecutionProviderApi::DeviceEpIncompatibilityDetails_Initialize,
+    &OrtExecutionProviderApi::DeviceEpIncompatibilityDetails_SetDetails,
     &OrtExecutionProviderApi::CreateIfKernel,
     &OrtExecutionProviderApi::CreateLoopKernel,
     &OrtExecutionProviderApi::CreateScanKernel,

onnxruntime/test/autoep/library/example_plugin_ep/ep_factory.cc

@@ -325,7 +325,7 @@ OrtStatus* ORT_API_CALL ExampleEpFactory::GetHardwareDeviceIncompatibilityDetail
   if (device_type != OrtHardwareDeviceType_CPU) {
     // Report that the device type is not supported
     uint32_t reasons = OrtDeviceEpIncompatibility_DEVICE_INCOMPATIBLE;
-    return factory.ep_api.DeviceEpIncompatibilityDetails_Initialize(
+    return factory.ep_api.DeviceEpIncompatibilityDetails_SetDetails(
         details,
         reasons,
         static_cast<int32_t>(device_type),  // Use device type as the error code for testing

onnxruntime/test/framework/hardware_device_compatibility_test.cc

@@ -313,6 +313,30 @@ TEST(GetHardwareDevicesCapiTest, GetHardwareDevices_InvalidArguments_NullDevices
   api->ReleaseEnv(env);
 }
 
+TEST(GetHardwareDevicesCapiTest, GetHardwareDevices_InvalidArguments_ArrayTooSmall) {
+  const OrtApi* api = OrtGetApiBase()->GetApi(ORT_API_VERSION);
+  ASSERT_NE(api, nullptr);
+
+  OrtEnv* env = nullptr;
+  EXPECT_EQ(nullptr, api->CreateEnv(ORT_LOGGING_LEVEL_WARNING, "HwDevicesTest", &env));
+  EXPECT_NE(env, nullptr);
+
+  // Get number of devices first
+  size_t num_devices = 0;
+  ASSERT_ORTSTATUS_OK(api->GetNumHardwareDevices(env, &num_devices));
+  ASSERT_GT(num_devices, 0u);
+
+  // Try to get devices with an undersized array (pass a valid pointer but claim size is 0)
+  std::vector<const OrtHardwareDevice*> devices(1);  // Allocate at least 1 element to avoid nullptr
+  OrtStatus* st = api->GetHardwareDevices(env, devices.data(), 0);  // But claim size is 0
+  ASSERT_NE(st, nullptr);
+  EXPECT_EQ(api->GetErrorCode(st), ORT_INVALID_ARGUMENT);
+  EXPECT_THAT(api->GetErrorMessage(st), testing::HasSubstr("num_devices is less than"));
+  api->ReleaseStatus(st);
+
+  api->ReleaseEnv(env);
+}
+
 TEST(GetHardwareDevicesCapiTest, ReturnsDevices) {
   const OrtApi* api = OrtGetApiBase()->GetApi(ORT_API_VERSION);
   ASSERT_NE(api, nullptr);