| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| #ifndef _THRIFT_TLOGGING_H_ |
| #define _THRIFT_TLOGGING_H_ 1 |
| |
| #include <thrift/thrift-config.h> |
| |
| /** |
| * Contains utility macros for debugging and logging. |
| * |
| */ |
| |
| #include <time.h> |
| |
| #ifdef HAVE_STDINT_H |
| #include <stdint.h> |
| #endif |
| |
| /** |
| * T_GLOBAL_DEBUGGING_LEVEL = 0: all debugging turned off, debug macros undefined |
| * T_GLOBAL_DEBUGGING_LEVEL = 1: all debugging turned on |
| */ |
| #define T_GLOBAL_DEBUGGING_LEVEL 0 |
| |
| /** |
| * T_GLOBAL_LOGGING_LEVEL = 0: all logging turned off, logging macros undefined |
| * T_GLOBAL_LOGGING_LEVEL = 1: all logging turned on |
| */ |
| #define T_GLOBAL_LOGGING_LEVEL 1 |
| |
| /** |
| * Standard wrapper around fprintf what will prefix the file name and line |
| * number to the line. Uses T_GLOBAL_DEBUGGING_LEVEL to control whether it is |
| * turned on or off. |
| * |
| * @param format_string |
| */ |
| #if T_GLOBAL_DEBUGGING_LEVEL > 0 |
| #define T_DEBUG(format_string, ...) \ |
| if (T_GLOBAL_DEBUGGING_LEVEL > 0) { \ |
| fprintf(stderr, "[%s,%d] " format_string " \n", __FILE__, __LINE__, ##__VA_ARGS__); \ |
| } |
| #else |
| #define T_DEBUG(format_string, ...) |
| #endif |
| |
| /** |
| * analogous to T_DEBUG but also prints the time |
| * |
| * @param string format_string input: printf style format string |
| */ |
| #if T_GLOBAL_DEBUGGING_LEVEL > 0 |
| #define T_DEBUG_T(format_string, ...) \ |
| { \ |
| if (T_GLOBAL_DEBUGGING_LEVEL > 0) { \ |
| time_t now; \ |
| char dbgtime[26]; \ |
| time(&now); \ |
| THRIFT_CTIME_R(&now, dbgtime); \ |
| dbgtime[24] = '\0'; \ |
| fprintf(stderr, \ |
| "[%s,%d] [%s] " format_string " \n", \ |
| __FILE__, \ |
| __LINE__, \ |
| dbgtime, \ |
| ##__VA_ARGS__); \ |
| } \ |
| } |
| #else |
| #define T_DEBUG_T(format_string, ...) |
| #endif |
| |
| /** |
| * analogous to T_DEBUG but uses input level to determine whether or not the string |
| * should be logged. |
| * |
| * @param int level: specified debug level |
| * @param string format_string input: format string |
| */ |
| #define T_DEBUG_L(level, format_string, ...) \ |
| if ((level) > 0) { \ |
| fprintf(stderr, "[%s,%d] " format_string " \n", __FILE__, __LINE__, ##__VA_ARGS__); \ |
| } |
| |
| /** |
| * Explicit error logging. Prints time, file name and line number |
| * |
| * @param string format_string input: printf style format string |
| */ |
| #define T_ERROR(format_string, ...) \ |
| { \ |
| time_t now; \ |
| char dbgtime[26]; \ |
| time(&now); \ |
| THRIFT_CTIME_R(&now, dbgtime); \ |
| dbgtime[24] = '\0'; \ |
| fprintf(stderr, \ |
| "[%s,%d] [%s] ERROR: " format_string " \n", \ |
| __FILE__, \ |
| __LINE__, \ |
| dbgtime, \ |
| ##__VA_ARGS__); \ |
| } |
| |
| /** |
| * Analogous to T_ERROR, additionally aborting the process. |
| * WARNING: macro calls abort(), ending program execution |
| * |
| * @param string format_string input: printf style format string |
| */ |
| #define T_ERROR_ABORT(format_string, ...) \ |
| { \ |
| time_t now; \ |
| char dbgtime[26]; \ |
| time(&now); \ |
| THRIFT_CTIME_R(&now, dbgtime); \ |
| dbgtime[24] = '\0'; \ |
| fprintf(stderr, \ |
| "[%s,%d] [%s] ERROR: Going to abort " format_string " \n", \ |
| __FILE__, \ |
| __LINE__, \ |
| dbgtime, \ |
| ##__VA_ARGS__); \ |
| exit(1); \ |
| } |
| |
| /** |
| * Log input message |
| * |
| * @param string format_string input: printf style format string |
| */ |
| #if T_GLOBAL_LOGGING_LEVEL > 0 |
| #define T_LOG_OPER(format_string, ...) \ |
| { \ |
| if (T_GLOBAL_LOGGING_LEVEL > 0) { \ |
| time_t now; \ |
| char dbgtime[26]; \ |
| time(&now); \ |
| THRIFT_CTIME_R(&now, dbgtime); \ |
| dbgtime[24] = '\0'; \ |
| fprintf(stderr, "[%s] " format_string " \n", dbgtime, ##__VA_ARGS__); \ |
| } \ |
| } |
| #else |
| #define T_LOG_OPER(format_string, ...) |
| #endif |
| |
| /** |
| * T_GLOBAL_DEBUG_VIRTUAL = 0 or unset: normal operation, |
| * virtual call debug messages disabled |
| * T_GLOBAL_DEBUG_VIRTUAL = 1: log a debug messages whenever an |
| * avoidable virtual call is made |
| * T_GLOBAL_DEBUG_VIRTUAL = 2: record detailed info that can be |
| * printed by calling |
| * apache::thrift::profile_print_info() |
| */ |
| #if T_GLOBAL_DEBUG_VIRTUAL > 1 |
| #define T_VIRTUAL_CALL() ::apache::thrift::profile_virtual_call(typeid(*this)) |
| #define T_GENERIC_PROTOCOL(template_class, generic_prot, specific_prot) \ |
| do { \ |
| if (!(specific_prot)) { \ |
| ::apache::thrift::profile_generic_protocol(typeid(*template_class), typeid(*generic_prot)); \ |
| } \ |
| } while (0) |
| #elif T_GLOBAL_DEBUG_VIRTUAL == 1 |
| #define T_VIRTUAL_CALL() fprintf(stderr, "[%s,%d] virtual call\n", __FILE__, __LINE__) |
| #define T_GENERIC_PROTOCOL(template_class, generic_prot, specific_prot) \ |
| do { \ |
| if (!(specific_prot)) { \ |
| fprintf(stderr, "[%s,%d] failed to cast to specific protocol type\n", __FILE__, __LINE__); \ |
| } \ |
| } while (0) |
| #else |
| #define T_VIRTUAL_CALL() |
| #define T_GENERIC_PROTOCOL(template_class, generic_prot, specific_prot) |
| #endif |
| |
| #endif // #ifndef _THRIFT_TLOGGING_H_ |
