Annotate execution context API's with _Must_inspect_result_ (microsof…

…t#1568) * Annotate execution context API's with _Must_inspect_result_ Signed-off-by: Alan Jowett <[email protected]> * PR feedback Signed-off-by: Alan Jowett <[email protected]> * Fix rebase Signed-off-by: Alan Jowett <[email protected]> * Code analysis failure Signed-off-by: Alan Jowett <[email protected]> Signed-off-by: Alan Jowett <[email protected]> Signed-off-by: Alan Jowett <[email protected]> Co-authored-by: Alan Jowett <[email protected]> Co-authored-by: Dave Thaler <[email protected]>
Keerthivardhan1 · Nov 14, 2022 · 850f6d2 · 850f6d2
1 parent 8f4180d
commit 850f6d2
Show file tree

Hide file tree

Showing 15 changed files with 173 additions and 137 deletions.
diff --git a/libs/execution_context/ebpf_core.c b/libs/execution_context/ebpf_core.c
@@ -137,7 +137,7 @@ ebpf_general_helper_function_provider_detach_client(_Inout_ void* provider_bindi
     return STATUS_SUCCESS;
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_initiate()
 {
     ebpf_result_t return_value;
@@ -251,7 +251,7 @@ ebpf_core_terminate()
     ebpf_platform_terminate();
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_load_code(
     ebpf_handle_t program_handle,
     ebpf_code_type_t code_type,
@@ -317,7 +317,7 @@ _ebpf_core_protocol_load_code(_In_ const ebpf_operation_load_code_request_t* req
     EBPF_RETURN_RESULT(retval);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_resolve_helper(
     ebpf_handle_t program_handle,
     const size_t count_of_helpers,
@@ -390,7 +390,7 @@ _ebpf_core_protocol_resolve_helper(
     EBPF_RETURN_RESULT(return_value);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_resolve_maps(
     ebpf_handle_t program_handle,
     uint32_t count_of_maps,
@@ -464,7 +464,7 @@ _ebpf_core_protocol_resolve_map(
     EBPF_RETURN_RESULT(return_value);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_create_map(
     _In_ const ebpf_utf8_string_t* map_name,
     _In_ const ebpf_map_definition_in_memory_t* ebpf_map_definition,
@@ -684,7 +684,14 @@ _ebpf_core_protocol_load_native_programs(
     // If this call failed, stop the native driver. ebpfapi will create a
     // new service for the driver in the next attempt.
     if (result != EBPF_SUCCESS) {
-        ebpf_native_unload(&request->module_id);
+        ebpf_result_t native_unload_result = ebpf_native_unload(&request->module_id);
+        if (native_unload_result != EBPF_SUCCESS) {
+            EBPF_LOG_MESSAGE_GUID(
+                EBPF_TRACELOG_LEVEL_ERROR,
+                EBPF_TRACELOG_KEYWORD_NATIVE,
+                "Failed to unload native driver",
+                request->module_id);
+        }
     }
 
     EBPF_RETURN_RESULT(result);
@@ -921,7 +928,7 @@ _ebpf_core_protocol_query_program_info(
     EBPF_RETURN_RESULT(retval);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_update_pinning(const ebpf_handle_t handle, _In_ const ebpf_utf8_string_t* path)
 {
     EBPF_LOG_ENTRY();
@@ -967,7 +974,7 @@ _ebpf_core_protocol_update_pinning(_In_ const struct _ebpf_operation_update_map_
     EBPF_RETURN_RESULT(retval);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_get_pinned_object(_In_ const ebpf_utf8_string_t* path, _Out_ ebpf_handle_t* handle)
 {
     EBPF_LOG_ENTRY();
@@ -1370,7 +1377,7 @@ _ebpf_core_protocol_get_pinned_map_info(
     EBPF_RETURN_RESULT(result);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_get_handle_by_id(ebpf_object_type_t type, ebpf_id_t id, _Out_ ebpf_handle_t* handle)
 {
     EBPF_LOG_ENTRY();
@@ -2018,7 +2025,7 @@ static ebpf_protocol_handler_t _ebpf_protocol_handlers[] = {
     DECLARE_PROTOCOL_HANDLER_FIXED_REQUEST_VARIABLE_REPLY(load_native_programs, data, PROTOCOL_NATIVE_MODE),
 };
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_get_protocol_handler_properties(
     ebpf_operation_id_t operation_id,
     _Out_ size_t* minimum_request_size,
@@ -2070,7 +2077,7 @@ ebpf_core_get_protocol_handler_properties(
     return EBPF_SUCCESS;
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_core_invoke_protocol_handler(
     ebpf_operation_id_t operation_id,
     _In_reads_bytes_(input_buffer_length) const void* input_buffer,

diff --git a/libs/execution_context/ebpf_core.h b/libs/execution_context/ebpf_core.h
@@ -31,7 +31,7 @@ extern "C"
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this
      *  operation.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_initiate();
 
     /**
@@ -55,7 +55,7 @@ extern "C"
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this
      *  operation.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_invoke_protocol_handler(
         ebpf_operation_id_t operation_id,
         _In_reads_bytes_(input_buffer_length) const void* input_buffer,
@@ -76,7 +76,7 @@ extern "C"
      * @retval EBPF_SUCCESS The operation was successful.
      * @retval EBPF_NOT_SUPPORTED The operation id is not valid.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_get_protocol_handler_properties(
         ebpf_operation_id_t operation_id,
         _Out_ size_t* minimum_request_size,
@@ -123,7 +123,7 @@ extern "C"
      * @retval EBPF_SUCCESS The operation was successful.
      * @retval EBPF_NOT_FOUND No object was pinned to the provided path.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_get_pinned_object(_In_ const ebpf_utf8_string_t* path, _Out_ ebpf_handle_t* handle);
 
     /**
@@ -138,7 +138,7 @@ extern "C"
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this operation.
      * @retval EBPF_NOT_FOUND No object was pinned to the provided path.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_update_pinning(const ebpf_handle_t handle, _In_ const ebpf_utf8_string_t* path);
 
     /**
@@ -152,7 +152,7 @@ extern "C"
      * @retval EBPF_SUCCESS The operation was successful.
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this operation.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_create_map(
         _In_ const ebpf_utf8_string_t* map_name,
         _In_ const ebpf_map_definition_in_memory_t* ebpf_map_definition,
@@ -171,7 +171,7 @@ extern "C"
      * @retval EBPF_SUCCESS The operation was successful.
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this operation.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_load_code(
         ebpf_handle_t program_handle,
         ebpf_code_type_t code_type,
@@ -191,7 +191,7 @@ extern "C"
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this
      *  operation.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_get_handle_by_id(ebpf_object_type_t type, ebpf_id_t id, _Out_ ebpf_handle_t* handle);
 
     /**
@@ -209,7 +209,7 @@ extern "C"
      * @retval EBPF_INVALID_FD The program is incompatible with the map.
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this operation.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_resolve_maps(
         ebpf_handle_t program_handle,
         uint32_t count_of_maps,
@@ -230,7 +230,7 @@ extern "C"
      * @retval EBPF_INVALID_ARGUMENT An invalid argument was supplied.
      * @retval EBPF_NO_MEMORY Unable to allocate resources for this operation.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_core_resolve_helper(
         ebpf_handle_t program_handle,
         const size_t count_of_helpers,

diff --git a/libs/execution_context/ebpf_link.c b/libs/execution_context/ebpf_link.c
@@ -43,7 +43,7 @@ _ebpf_link_free(ebpf_core_object_t* object)
     ebpf_epoch_free(link);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_link_create(ebpf_link_t** link)
 {
     EBPF_LOG_ENTRY();
@@ -63,7 +63,7 @@ ebpf_link_create(ebpf_link_t** link)
     EBPF_RETURN_RESULT(EBPF_SUCCESS);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_link_initialize(
     ebpf_link_t* link, ebpf_attach_type_t attach_type, const uint8_t* context_data, size_t context_data_length)
 {
@@ -127,7 +127,7 @@ ebpf_link_initialize(
     EBPF_RETURN_RESULT(return_value);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_link_attach_program(ebpf_link_t* link, ebpf_program_t* program)
 {
     EBPF_LOG_ENTRY();
@@ -210,7 +210,7 @@ _ebpf_link_instance_invoke(
     EBPF_RETURN_RESULT(return_value);
 }
 
-ebpf_result_t
+_Must_inspect_result_ ebpf_result_t
 ebpf_link_get_info(
     _In_ const ebpf_link_t* link, _Out_writes_to_(*info_size, *info_size) uint8_t* buffer, _Inout_ uint16_t* info_size)
 {

diff --git a/libs/execution_context/ebpf_link.h b/libs/execution_context/ebpf_link.h
@@ -23,7 +23,7 @@ extern "C"
      *  link object.
      * @retval EBPF_SUCCESS The operation was successful.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_link_create(ebpf_link_t** link);
 
     /**
@@ -37,7 +37,7 @@ extern "C"
      *  provider.
      * @retval EBPF_SUCCESS The operation was successful.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_link_initialize(
         ebpf_link_t* link, ebpf_attach_type_t attach_type, const uint8_t* context_data, size_t context_data_length);
 
@@ -50,7 +50,7 @@ extern "C"
      * @retval EBPF_INVALID_ARGUMENT Hook instance has not been
      *  initialized.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_link_attach_program(ebpf_link_t* link, ebpf_program_t* program);
 
     /**
@@ -72,7 +72,7 @@ extern "C"
      * @retval EBPF_SUCCESS The operation was successful.
      * @retval EBPF_INSUFFICIENT_BUFFER The buffer was too small to hold bpf_link_info.
      */
-    ebpf_result_t
+    _Must_inspect_result_ ebpf_result_t
     ebpf_link_get_info(
         _In_ const ebpf_link_t* link,
         _Out_writes_to_(*info_size, *info_size) uint8_t* buffer,