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_SUPPORT_LOG_H 20 #define GRPC_SUPPORT_LOG_H 21 22 #include <stdarg.h> 23 #include <stdlib.h> /* for abort() */ 24 25 #include <grpc/support/port_platform.h> 26 27 #ifdef __cplusplus 28 extern "C" { 29 #endif 30 31 /** GPR log API. 32 33 Usage (within grpc): 34 35 int argument1 = 3; 36 char* argument2 = "hello"; 37 gpr_log(GPR_DEBUG, "format string %d", argument1); 38 gpr_log(GPR_INFO, "hello world"); 39 gpr_log(GPR_ERROR, "%d %s!!", argument1, argument2); */ 40 41 /** The severity of a log message - use the #defines below when calling into 42 gpr_log to additionally supply file and line data */ 43 typedef enum gpr_log_severity { 44 GPR_LOG_SEVERITY_DEBUG, 45 GPR_LOG_SEVERITY_INFO, 46 GPR_LOG_SEVERITY_ERROR 47 } gpr_log_severity; 48 49 /** Returns a string representation of the log severity */ 50 GPRAPI const char* gpr_log_severity_string(gpr_log_severity severity); 51 52 /** Macros to build log contexts at various severity levels */ 53 #define GPR_DEBUG __FILE__, __LINE__, GPR_LOG_SEVERITY_DEBUG 54 #define GPR_INFO __FILE__, __LINE__, GPR_LOG_SEVERITY_INFO 55 #define GPR_ERROR __FILE__, __LINE__, GPR_LOG_SEVERITY_ERROR 56 57 /** Log a message. It's advised to use GPR_xxx above to generate the context 58 * for each message */ 59 GPRAPI void gpr_log(const char* file, int line, gpr_log_severity severity, 60 const char* format, ...) GPR_PRINT_FORMAT_CHECK(4, 5); 61 62 GPRAPI int gpr_should_log(gpr_log_severity severity); 63 64 GPRAPI void gpr_log_message(const char* file, int line, 65 gpr_log_severity severity, const char* message); 66 67 /** Set global log verbosity */ 68 GPRAPI void gpr_set_log_verbosity(gpr_log_severity min_severity_to_print); 69 70 GPRAPI void gpr_log_verbosity_init(void); 71 72 /** Log overrides: applications can use this API to intercept logging calls 73 and use their own implementations */ 74 75 struct gpr_log_func_args { 76 const char* file; 77 int line; 78 gpr_log_severity severity; 79 const char* message; 80 }; 81 82 typedef struct gpr_log_func_args gpr_log_func_args; 83 84 typedef void (*gpr_log_func)(gpr_log_func_args* args); 85 GPRAPI void gpr_set_log_function(gpr_log_func func); 86 87 GPRAPI void gpr_assertion_failed(const char* filename, int line, 88 const char* message) GPR_ATTRIBUTE_NORETURN; 89 90 /** abort() the process if x is zero, having written a line to the log. 91 92 Intended for internal invariants. If the error can be recovered from, 93 without the possibility of corruption, or might best be reflected via 94 an exception in a higher-level language, consider returning error code. */ 95 #define GPR_ASSERT(x) \ 96 do { \ 97 if (GPR_UNLIKELY(!(x))) { \ 98 gpr_assertion_failed(__FILE__, __LINE__, #x); \ 99 } \ 100 } while (0) 101 102 #ifndef NDEBUG 103 #define GPR_DEBUG_ASSERT(x) GPR_ASSERT(x) 104 #else 105 #define GPR_DEBUG_ASSERT(x) 106 #endif 107 108 #ifdef __cplusplus 109 } 110 #endif 111 112 #endif /* GRPC_SUPPORT_LOG_H */ 113