Make Platform functions to return az_result

CHANGELOG.md

@@ -9,6 +9,7 @@
 - Update provisioning client struct member name in `az_iot_provisioning_client_register_response` from `registration_result` to `registration_state`.
 - Changed `operation_status` in `az_iot_provisioning_client_register_response` from `az_span` to `az_iot_provisioning_client_operation_status` enum.
 - Removed `az_iot_provisioning_client_parse_operation_status()` from `az_iot_provisioning_client.h`.
+- Platform: `az_platform_clock_msec()`, and `az_platform_sleep_msec()` return `az_result`, which is `AZ_ERROR_DEPENDENCY_NOT_PROVIDED` when `az_noplatform` implementation is used.
 
 ### Bug Fixes
 

README.md

@@ -149,7 +149,7 @@ By default, when building the project with no options, the following static libr
   - az_storage_blobs
     - Storage SDK blobs client.
   - az_noplatform
-    - A platform abstraction which will compile but returns 0 or does nothing for all platform calls. This ensures the project can be compiled without the need to provide any specific platform implementation. This is useful if you want to use az_core without platform specific functions like `time` or `sleep`.
+    - A platform abstraction which will compile but returns `AZ_ERROR_DEPENDENCY_NOT_PROVIDED` from all its functions. This ensures the project can be compiled without the need to provide any specific platform implementation. This is useful if you want to use az_core without platform specific functions like `time` or `sleep`.
   - az_nohttp
     - Library that provides a no-op HTTP stack, returning `AZ_ERROR_DEPENDENCY_NOT_PROVIDED`. Similar to `az_noplatform`, this library ensures the project can be compiled without requiring any HTTP stack implementation. This is useful if you want to use `az_core` without `az_http` functionality.
 

sdk/docs/core/README.md

@@ -6,7 +6,7 @@ The library allows client libraries to expose common functionality in a consiste
 
 ## Porting the Azure SDK to Another Platform
 
-The `Azure Core` library requires you to implement a few functions to provide platform-specific features such as a clock and thread sleep. By default, `Azure Core` ships with no-op versions of these functions, all of which return 0 or do no operations. The no-op versions allow the Azure SDK to compile successfully so you can verify that your build tool chain is working properly; however, failures may occur if you execute the code.
+The `Azure Core` library requires you to implement a few functions to provide platform-specific features such as a clock and thread sleep. By default, `Azure Core` ships with no-op versions of these functions, all of which return `AZ_ERROR_DEPENDENCY_NOT_PROVIDED`. These function versions allow the Azure SDK to compile successfully so you can verify that your build tool chain is working properly; however, failures may occur if you execute the code.
 
 ## Key Concepts
 

sdk/docs/platform/README.md

@@ -4,7 +4,7 @@ The Azure SDK platform layer provides abstractions for platform specific APIs wh
 
 ## Platform
 
-Azure SDK Core depends on some system-specific functions. These functions are not part of the C99 standard library and their implementation depends on system architecture (for example a clock, thread sleep, or interlock).
+Azure SDK Core depends on some system-specific functions. These functions are not part of the C99 standard library and their implementation depends on system architecture (for example, clock, or thread sleep).
 
 Azure SDK provides three platform implementations for you, one for Windows (`az_win32`), another for Linux and MacOS (`az_posix`) and an empty implementation (`az_noplatform`).
 

sdk/inc/azure/core/az_http_transport.h

@@ -226,6 +226,8 @@ AZ_NODISCARD int32_t az_http_request_headers_count(az_http_request const* reques
  * @retval #AZ_ERROR_HTTP_RESPONSE_COULDNT_RESOLVE_HOST The URL from \p ref_request can't be
  * resolved by the HTTP stack and the request was not sent.
  * @retval #AZ_ERROR_HTTP_ADAPTER Any other issue from the transport adapter layer.
+ * @retval #AZ_ERROR_DEPENDENCY_NOT_PROVIDED No platform implementation was supplied to support this
+ * function.
  */
 AZ_NODISCARD az_result
 az_http_client_send_request(az_http_request const* request, az_http_response* ref_response);

sdk/inc/azure/core/az_platform.h

@@ -29,9 +29,14 @@
  * called twice with one second interval, the difference between the values returned should be equal
  * to 1000.
  *
- * @return Platform clock in milliseconds.
+ * @param[out] out_clock_msec Platform clock in milliseconds.
+ *
+ * @return An #az_result value indicating the result of the operation.
+ * @retval #AZ_OK Success.
+ * @retval #AZ_ERROR_DEPENDENCY_NOT_PROVIDED No platform implementation was supplied to support this
+ * function.
  */
-AZ_NODISCARD int64_t az_platform_clock_msec();
+AZ_NODISCARD az_result az_platform_clock_msec(int64_t* out_clock_msec);
 
 /**
  * @brief Tells the platform to sleep for a given number of milliseconds.
@@ -40,8 +45,13 @@ AZ_NODISCARD int64_t az_platform_clock_msec();
  *
  * @remarks The behavior is undefined when \p milliseconds is a non-positive value (0 or less than
  * 0).
+ *
+ * @return An #az_result value indicating the result of the operation.
+ * @retval #AZ_OK Success.
+ * @retval #AZ_ERROR_DEPENDENCY_NOT_PROVIDED No platform implementation was supplied to support this
+ * function.
  */
-void az_platform_sleep_msec(int32_t milliseconds);
+AZ_NODISCARD az_result az_platform_sleep_msec(int32_t milliseconds);
 
 #include <azure/core/_az_cfg_suffix.h>
 

sdk/src/azure/core/az_http_policy_logging.c

@@ -110,8 +110,7 @@ static az_result _az_http_policy_logging_append_http_request_msg(
     remainder = az_span_copy(remainder, new_line_tab_string);
     remainder = az_span_copy(remainder, header_name);
 
-    if (az_span_size(header_value) > 0
-        && !az_span_is_content_equal(header_name, auth_header_name))
+    if (az_span_size(header_value) > 0 && !az_span_is_content_equal(header_name, auth_header_name))
     {
       remainder = az_span_copy(remainder, colon_separator_string);
       remainder = _az_http_policy_logging_copy_lengthy_value(remainder, header_value);
@@ -254,10 +253,13 @@ AZ_NODISCARD az_result az_http_pipeline_policy_logging(
     return _az_http_pipeline_nextpolicy(ref_policies, ref_request, ref_response);
   }
 
-  int64_t const start = az_platform_clock_msec();
+  int64_t start;
+  _az_RETURN_IF_FAILED(az_platform_clock_msec(&start));
+
   az_result const result = _az_http_pipeline_nextpolicy(ref_policies, ref_request, ref_response);
-  int64_t const end = az_platform_clock_msec();
 
+  int64_t end;
+  _az_RETURN_IF_FAILED(az_platform_clock_msec(&end));
   _az_http_policy_logging_log_http_response(ref_response, end - start, ref_request);
 
   return result;

sdk/src/azure/core/az_http_policy_retry.c

@@ -206,11 +206,16 @@ AZ_NODISCARD az_result az_http_pipeline_policy_retry(
       _az_http_policy_retry_log(attempt, retry_after_msec);
     }
 
-    az_platform_sleep_msec(retry_after_msec);
+    _az_RETURN_IF_FAILED(az_platform_sleep_msec(retry_after_msec));
 
-    if (context != NULL && az_context_has_expired(context, az_platform_clock_msec()))
+    if (context != NULL)
     {
-      return AZ_ERROR_CANCELED;
+      int64_t clock = 0;
+      _az_RETURN_IF_FAILED(az_platform_clock_msec(&clock));
+      if (az_context_has_expired(context, clock))
+      {
+        return AZ_ERROR_CANCELED;
+      }
     }
   }
 

sdk/src/azure/platform/az_curl.c

@@ -590,13 +590,6 @@ static AZ_NODISCARD az_result _az_http_client_curl_send_request_impl_process(
   return result;
 }
 
-/**
- * @brief uses AZ_HTTP_BUILDER to set up CURL request and perform it.
- *
- * @param request an internal http builder with data to build and send http request
- * @param ref_response pre-allocated buffer where http response will be written
- * @return az_result
- */
 AZ_NODISCARD az_result
 az_http_client_send_request(az_http_request const* request, az_http_response* ref_response)
 {

sdk/src/azure/platform/az_nohttp.c

@@ -5,15 +5,6 @@
 
 #include <azure/core/_az_cfg.h>
 
-/**
- * @brief Provides no HTTP support.
- *
- * @param request An internal HTTP builder with data to build and send HTTP request.
- * @param ref_response A pre-allocated buffer where the HTTP response will be written.
- * @return An #az_result value indicating the result of the operation.
- * @retval #AZ_OK Success.
- * @retval other Failure.
- */
 AZ_NODISCARD az_result
 az_http_client_send_request(az_http_request const* request, az_http_response* ref_response)
 {

sdk/src/azure/platform/az_noplatform.c

@@ -2,9 +2,19 @@
 // SPDX-License-Identifier: MIT
 
 #include <azure/core/az_platform.h>
+#include <azure/core/internal/az_precondition_internal.h>
 
 #include <azure/core/_az_cfg.h>
 
-AZ_NODISCARD int64_t az_platform_clock_msec() { return 0; }
+AZ_NODISCARD az_result az_platform_clock_msec(int64_t* out_clock_msec)
+{
+  _az_PRECONDITION_NOT_NULL(out_clock_msec);
+  *out_clock_msec = 0;
+  return AZ_ERROR_DEPENDENCY_NOT_PROVIDED;
+}
 
-void az_platform_sleep_msec(int32_t milliseconds) { (void)milliseconds; }
+AZ_NODISCARD az_result az_platform_sleep_msec(int32_t milliseconds)
+{
+  (void)milliseconds;
+  return AZ_ERROR_DEPENDENCY_NOT_PROVIDED;
+}

sdk/src/azure/platform/az_posix.c

@@ -1,21 +1,25 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // SPDX-License-Identifier: MIT
 
-#include <azure/core/internal/az_config_internal.h>
 #include <azure/core/az_platform.h>
+#include <azure/core/internal/az_config_internal.h>
+#include <azure/core/internal/az_precondition_internal.h>
 
 #include <time.h>
 
 #include <unistd.h>
 
 #include <azure/core/_az_cfg.h>
 
-AZ_NODISCARD int64_t az_platform_clock_msec()
+AZ_NODISCARD az_result az_platform_clock_msec(int64_t* out_clock_msec)
 {
-  return (int64_t)((clock() / CLOCKS_PER_SEC) * _az_TIME_MILLISECONDS_PER_SECOND);
+  _az_PRECONDITION_NOT_NULL(out_clock_msec);
+  *out_clock_msec = (int64_t)((clock() / CLOCKS_PER_SEC) * _az_TIME_MILLISECONDS_PER_SECOND);
+  return AZ_OK;
 }
 
-void az_platform_sleep_msec(int32_t milliseconds)
+AZ_NODISCARD az_result az_platform_sleep_msec(int32_t milliseconds)
 {
   (void)usleep((useconds_t)milliseconds * _az_TIME_MICROSECONDS_PER_MILLISECOND);
+  return AZ_OK;
 }

sdk/src/azure/platform/az_win32.c

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: MIT
 
 #include <azure/core/az_platform.h>
+#include <azure/core/internal/az_precondition_internal.h>
 
 // Two macros below are not used in the code below, it is windows.h that consumes them.
 #define WIN32_LEAN_AND_MEAN
@@ -10,6 +11,15 @@
 
 #include <azure/core/_az_cfg.h>
 
-AZ_NODISCARD int64_t az_platform_clock_msec() { return GetTickCount64(); }
+AZ_NODISCARD az_result az_platform_clock_msec(int64_t* out_clock_msec)
+{
+  _az_PRECONDITION_NOT_NULL(out_clock_msec);
+  *out_clock_msec = GetTickCount64();
+  return AZ_OK;
+}
 
-void az_platform_sleep_msec(int32_t milliseconds) { Sleep(milliseconds); }
+AZ_NODISCARD az_result az_platform_sleep_msec(int32_t milliseconds)
+{
+  Sleep(milliseconds);
+  return AZ_OK;
+}

sdk/tests/core/CMakeLists.txt

@@ -11,7 +11,7 @@ include(AddTestCMocka)
 
 # -ld link option is only available for gcc
 if(UNIT_TESTING_MOCKS)
-    set(WRAP_FUNCTIONS "-Wl,--wrap=az_platform_clock_msec")
+    set(WRAP_FUNCTIONS "-Wl,--wrap=az_platform_clock_msec -Wl,--wrap=az_platform_sleep_msec")
 else()
     set(WRAP_FUNCTIONS "")
 endif()

sdk/tests/core/test_az_policy.c

@@ -7,6 +7,7 @@
 #include <azure/core/az_http_transport.h>
 #include <azure/core/az_span.h>
 #include <azure/core/internal/az_http_internal.h>
+#include <azure/core/internal/az_precondition_internal.h>
 
 #include <setjmp.h>
 #include <stdarg.h>
@@ -90,7 +91,7 @@ void test_az_http_pipeline_policy_telemetry(void** state)
   // Create policy options
   _az_http_policy_telemetry_options telemetry = _az_http_policy_telemetry_options_default();
 
-  _az_http_policy policies[1] = {            
+  _az_http_policy policies[1] = {
             {
               ._internal = {
                 .process = test_policy_transport,
@@ -135,7 +136,7 @@ void test_az_http_pipeline_policy_apiversion(void** state)
   api_version._internal.name = AZ_SPAN_FROM_STR("name");
   api_version._internal.version = AZ_SPAN_FROM_STR("version");
 
-  _az_http_policy policies[1] = {            
+  _az_http_policy policies[1] = {
             {
               ._internal = {
                 .process = test_policy_transport,
@@ -248,7 +249,7 @@ void test_az_http_pipeline_policy_retry(void** state)
   // Create policy options
   az_http_policy_retry_options retry_options = _az_http_policy_retry_options_default();
 
-  _az_http_policy policies[1] = {            
+  _az_http_policy policies[1] = {
             {
               ._internal = {
                 .process = test_policy_transport_retry_response,
@@ -295,7 +296,7 @@ void test_az_http_pipeline_policy_retry_with_header(void** state)
   // make just one retry
   retry_options.max_retries = 1;
 
-  _az_http_policy policies[1] = {            
+  _az_http_policy policies[1] = {
             {
               ._internal = {
                 .process = test_policy_transport_retry_response_with_header,
@@ -342,7 +343,7 @@ void test_az_http_pipeline_policy_retry_with_header_2(void** state)
   // make just one retry
   retry_options.max_retries = 1;
 
-  _az_http_policy policies[1] = {            
+  _az_http_policy policies[1] = {
             {
               ._internal = {
                 .process = test_policy_transport_retry_response_with_header_2,
@@ -358,8 +359,20 @@ void test_az_http_pipeline_policy_retry_with_header_2(void** state)
       az_http_pipeline_policy_retry(policies, &retry_options, &request, &response), AZ_OK);
 }
 
-int64_t __wrap_az_platform_clock_msec();
-int64_t __wrap_az_platform_clock_msec() { return (int64_t)mock(); }
+az_result __wrap_az_platform_clock_msec(int64_t* out_clock_msec);
+az_result __wrap_az_platform_clock_msec(int64_t* out_clock_msec)
+{
+  _az_PRECONDITION_NOT_NULL(out_clock_msec);
+  *out_clock_msec = (int64_t)mock();
+  return AZ_OK;
+}
+
+az_result __wrap_az_platform_sleep_msec(int32_t milliseconds);
+az_result __wrap_az_platform_sleep_msec(int32_t milliseconds)
+{
+  (void)milliseconds;
+  return AZ_OK;
+}
 
 #endif // _az_MOCK_ENABLED