mirror of
https://github.com/facebook/rocksdb.git
synced 2024-11-27 11:43:49 +00:00
80c663882a
Summary: First draft. Unit tests pass. Test Plan: unit tests attached Reviewers: heyongqiang Reviewed By: heyongqiang Differential Revision: https://reviews.facebook.net/D3969
194 lines
7.1 KiB
C
194 lines
7.1 KiB
C
/*
|
|
* 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/lib/cpp/thrift_config.h"
|
|
#include "thrift/lib/cpp/concurrency/Util.h"
|
|
|
|
#include <stdio.h>
|
|
|
|
/**
|
|
* Contains utility macros for debugging and logging.
|
|
*
|
|
*/
|
|
|
|
#ifdef THRIFT_HAVE_CLOCK_GETTIME
|
|
#include <sys/time.h>
|
|
#endif
|
|
#include <time.h>
|
|
|
|
#ifdef THRIFT_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
|
|
*/
|
|
#ifndef T_GLOBAL_DEBUGGING_LEVEL
|
|
#define T_GLOBAL_DEBUGGING_LEVEL 0
|
|
#endif
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
#define T_DEBUG(format_string,...) \
|
|
T_DEBUG_L(0, format_string, ##__VA_ARGS__)
|
|
|
|
#define COMPUTE_TIME \
|
|
int64_t nowMs = apache::thrift::concurrency::Util::currentTime(); \
|
|
time_t nowSec = (time_t) (nowMs / 1000); \
|
|
nowMs -= nowSec * 1000; \
|
|
int ms = (int)nowMs; \
|
|
char dbgtime[26]; \
|
|
ctime_r(&nowSec, dbgtime); \
|
|
dbgtime[24] = '\0';
|
|
|
|
/**
|
|
* analogous to T_DEBUG but also prints the time
|
|
*
|
|
* @param string format_string input: printf style format string
|
|
*/
|
|
#define T_DEBUG_T(format_string,...) \
|
|
do { \
|
|
if (T_GLOBAL_DEBUGGING_LEVEL > 0) { \
|
|
COMPUTE_TIME \
|
|
fprintf(stderr, "[%s,%d] [%s, %d ms] " format_string " \n", \
|
|
__FILE__, __LINE__, dbgtime, ms, \
|
|
##__VA_ARGS__); \
|
|
} \
|
|
} while(0)
|
|
|
|
|
|
/**
|
|
* 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, ...) \
|
|
do { \
|
|
if (T_GLOBAL_DEBUGGING_LEVEL > (level)) { \
|
|
COMPUTE_TIME \
|
|
fprintf(stderr, "[%s,%d] [%s, %d ms] " format_string " \n", \
|
|
__FILE__, __LINE__, dbgtime, ms, ##__VA_ARGS__); \
|
|
} \
|
|
} while (0)
|
|
|
|
|
|
/**
|
|
* Explicit error logging. Prints time, file name and line number
|
|
*
|
|
* @param string format_string input: printf style format string
|
|
*/
|
|
#define T_ERROR(format_string,...) \
|
|
{ \
|
|
COMPUTE_TIME \
|
|
fprintf(stderr,"[%s,%d] [%s, %d ms] ERROR: " format_string " \n", \
|
|
__FILE__, __LINE__,dbgtime, ms, \
|
|
##__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,...) \
|
|
{ \
|
|
COMPUTE_TIME \
|
|
fprintf(stderr,"[%s,%d] [%s, %d ms] ERROR: Going to abort " \
|
|
format_string " \n", \
|
|
__FILE__, __LINE__,dbgtime, ms, \
|
|
##__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) { \
|
|
COMPUTE_TIME \
|
|
fprintf(stderr,"[%s, %d ms] " format_string " \n", \
|
|
dbgtime, ms, ##__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
|