GRPC C++  1.62.0
log.h
Go to the documentation of this file.
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 
23 
24 #include <stdarg.h>
25 #include <stdlib.h> /* for abort() */
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
43 typedef enum gpr_log_severity {
48 
50 GPRAPI const char* gpr_log_severity_string(gpr_log_severity severity);
51 
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 
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 
63 
64 GPRAPI void gpr_log_message(const char* file, int line,
65  gpr_log_severity severity, const char* message);
66 
68 GPRAPI void gpr_set_log_verbosity(gpr_log_severity min_severity_to_print);
69 
71 
76  const char* file;
77  int line;
79  const char* message;
80 };
81 
83 
84 typedef void (*gpr_log_func)(gpr_log_func_args* args);
86 
87 GPRAPI void gpr_assertion_failed(const char* filename, int line,
88  const char* message) GPR_ATTRIBUTE_NORETURN;
89 
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 */
GPR_LOG_SEVERITY_DEBUG
@ GPR_LOG_SEVERITY_DEBUG
Definition: log.h:44
GPR_PRINT_FORMAT_CHECK
#define GPR_PRINT_FORMAT_CHECK(FORMAT_STR, ARGS)
Definition: port_platform.h:632
gpr_set_log_function
GPRAPI void gpr_set_log_function(gpr_log_func func)
GPR_ATTRIBUTE_NORETURN
#define GPR_ATTRIBUTE_NORETURN
Definition: port_platform.h:696
gpr_log_func_args
Log overrides: applications can use this API to intercept logging calls and use their own implementat...
Definition: log.h:75
GPR_LOG_SEVERITY_INFO
@ GPR_LOG_SEVERITY_INFO
Definition: log.h:45
gpr_log_func_args::file
const char * file
Definition: log.h:76
gpr_log_func
void(* gpr_log_func)(gpr_log_func_args *args)
Definition: log.h:84
gpr_log_message
GPRAPI void gpr_log_message(const char *file, int line, gpr_log_severity severity, const char *message)
GPRAPI
#define GPRAPI
Definition: port_platform.h:718
GPR_LOG_SEVERITY_ERROR
@ GPR_LOG_SEVERITY_ERROR
Definition: log.h:46
gpr_log_verbosity_init
GPRAPI void gpr_log_verbosity_init(void)
gpr_log_func_args::line
int line
Definition: log.h:77
gpr_assertion_failed
GPRAPI void gpr_assertion_failed(const char *filename, int line, const char *message) GPR_ATTRIBUTE_NORETURN
gpr_log_func_args::message
const char * message
Definition: log.h:79
gpr_log_severity
gpr_log_severity
GPR log API.
Definition: log.h:43
gpr_log
GPRAPI void gpr_log(const char *file, int line, gpr_log_severity severity, const char *format,...) GPR_PRINT_FORMAT_CHECK(4
Log a message.
gpr_set_log_verbosity
GPRAPI void gpr_set_log_verbosity(gpr_log_severity min_severity_to_print)
Set global log verbosity.
gpr_log_severity_string
const GPRAPI char * gpr_log_severity_string(gpr_log_severity severity)
Returns a string representation of the log severity.
gpr_should_log
GPRAPI void GPRAPI int gpr_should_log(gpr_log_severity severity)
gpr_log_func_args::severity
gpr_log_severity severity
Definition: log.h:78
port_platform.h