1 // 2 // 3 // Copyright 2015 gRPC authors. 4 // 5 // Licensed under the Apache License, Version 2.0 (the "License"); 6 // you may not use this file except in compliance with the License. 7 // You may obtain a copy of the License at 8 // 9 // http://www.apache.org/licenses/LICENSE-2.0 10 // 11 // Unless required by applicable law or agreed to in writing, software 12 // distributed under the License is distributed on an "AS IS" BASIS, 13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 // See the License for the specific language governing permissions and 15 // limitations under the License. 16 // 17 // 18 19 #ifndef GRPC_SRC_CORE_LIB_IOMGR_IOMGR_INTERNAL_H 20 #define GRPC_SRC_CORE_LIB_IOMGR_IOMGR_INTERNAL_H 21 22 #include <grpc/support/port_platform.h> 23 #include <stdbool.h> 24 25 #include "src/core/lib/iomgr/closure.h" 26 #include "src/core/lib/iomgr/error.h" 27 28 typedef struct grpc_iomgr_object { 29 char* name; 30 struct grpc_iomgr_object* next; 31 struct grpc_iomgr_object* prev; 32 } grpc_iomgr_object; 33 34 typedef struct grpc_iomgr_platform_vtable { 35 void (*init)(void); 36 void (*flush)(void); 37 void (*shutdown)(void); 38 void (*shutdown_background_closure)(void); 39 bool (*is_any_background_poller_thread)(void); 40 bool (*add_closure_to_background_poller)(grpc_closure* closure, 41 grpc_error_handle error); 42 } grpc_iomgr_platform_vtable; 43 44 void grpc_iomgr_register_object(grpc_iomgr_object* obj, const char* name); 45 void grpc_iomgr_unregister_object(grpc_iomgr_object* obj); 46 47 bool grpc_have_determined_iomgr_platform(); 48 49 void grpc_set_iomgr_platform_vtable(grpc_iomgr_platform_vtable* vtable); 50 51 void grpc_set_default_iomgr_platform(); 52 53 void grpc_iomgr_platform_init(void); 54 /// flush any globally queued work from iomgr 55 void grpc_iomgr_platform_flush(void); 56 /// tear down all platform specific global iomgr structures 57 void grpc_iomgr_platform_shutdown(void); 58 59 /// shut down all the closures registered in the background poller 60 void grpc_iomgr_platform_shutdown_background_closure(void); 61 62 /// return true if the caller is a worker thread for any background poller 63 bool grpc_iomgr_platform_is_any_background_poller_thread(void); 64 65 /// Return true if the closure is registered into the background poller. Note 66 /// that the closure may or may not run yet when this function returns, and the 67 /// closure should not be blocking or long-running. 68 bool grpc_iomgr_platform_add_closure_to_background_poller( 69 grpc_closure* closure, grpc_error_handle error); 70 71 bool grpc_iomgr_abort_on_leaks(void); 72 73 #endif // GRPC_SRC_CORE_LIB_IOMGR_IOMGR_INTERNAL_H 74