2019-03-04 13:03:32 +00:00
|
|
|
#include "QueryProfiler.h"
|
2019-05-19 20:22:44 +00:00
|
|
|
|
2019-07-10 20:47:39 +00:00
|
|
|
#include <common/Pipe.h>
|
|
|
|
#include <common/StackTrace.h>
|
|
|
|
#include <common/StringRef.h>
|
|
|
|
#include <common/logger_useful.h>
|
|
|
|
#include <Common/CurrentThread.h>
|
|
|
|
#include <Common/Exception.h>
|
|
|
|
#include <IO/WriteHelpers.h>
|
|
|
|
#include <IO/WriteBufferFromFileDescriptor.h>
|
|
|
|
|
2019-05-19 20:22:44 +00:00
|
|
|
namespace DB
|
|
|
|
{
|
|
|
|
|
2019-07-10 20:47:39 +00:00
|
|
|
extern LazyPipe trace_pipe;
|
|
|
|
|
|
|
|
namespace
|
|
|
|
{
|
|
|
|
/// Normally query_id is a UUID (string with a fixed length) but user can provide custom query_id.
|
|
|
|
/// Thus upper bound on query_id length should be introduced to avoid buffer overflow in signal handler.
|
|
|
|
constexpr size_t QUERY_ID_MAX_LEN = 1024;
|
|
|
|
|
|
|
|
void writeTraceInfo(TimerType timer_type, int /* sig */, siginfo_t * /* info */, void * context)
|
|
|
|
{
|
|
|
|
constexpr size_t buf_size = sizeof(char) + // TraceCollector stop flag
|
|
|
|
8 * sizeof(char) + // maximum VarUInt length for string size
|
|
|
|
QUERY_ID_MAX_LEN * sizeof(char) + // maximum query_id length
|
|
|
|
sizeof(StackTrace) + // collected stack trace
|
|
|
|
sizeof(TimerType); // timer type
|
|
|
|
char buffer[buf_size];
|
|
|
|
WriteBufferFromFileDescriptor out(trace_pipe.fds_rw[1], buf_size, buffer);
|
|
|
|
|
|
|
|
StringRef query_id = CurrentThread::getQueryId();
|
|
|
|
query_id.size = std::min(query_id.size, QUERY_ID_MAX_LEN);
|
|
|
|
|
|
|
|
const auto signal_context = *reinterpret_cast<ucontext_t *>(context);
|
|
|
|
const StackTrace stack_trace(signal_context);
|
|
|
|
|
|
|
|
writeChar(false, out);
|
|
|
|
writeStringBinary(query_id, out);
|
|
|
|
writePODBinary(stack_trace, out);
|
|
|
|
writePODBinary(timer_type, out);
|
|
|
|
out.next();
|
|
|
|
}
|
|
|
|
|
|
|
|
const UInt32 TIMER_PRECISION = 1e9;
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace ErrorCodes
|
|
|
|
{
|
|
|
|
extern const int CANNOT_MANIPULATE_SIGSET;
|
|
|
|
extern const int CANNOT_SET_SIGNAL_HANDLER;
|
|
|
|
extern const int CANNOT_CREATE_TIMER;
|
|
|
|
extern const int CANNOT_SET_TIMER_PERIOD;
|
|
|
|
extern const int CANNOT_DELETE_TIMER;
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename ProfilerImpl>
|
|
|
|
QueryProfilerBase<ProfilerImpl>::QueryProfilerBase(const Int32 thread_id, const int clock_type, const UInt32 period, const int pause_signal)
|
|
|
|
: log(&Logger::get("QueryProfiler"))
|
|
|
|
, pause_signal(pause_signal)
|
|
|
|
{
|
|
|
|
struct sigaction sa{};
|
|
|
|
sa.sa_sigaction = ProfilerImpl::signalHandler;
|
|
|
|
sa.sa_flags = SA_SIGINFO | SA_RESTART;
|
|
|
|
|
|
|
|
if (sigemptyset(&sa.sa_mask))
|
|
|
|
throwFromErrno("Failed to clean signal mask for query profiler", ErrorCodes::CANNOT_MANIPULATE_SIGSET);
|
|
|
|
|
|
|
|
if (sigaddset(&sa.sa_mask, pause_signal))
|
|
|
|
throwFromErrno("Failed to add signal to mask for query profiler", ErrorCodes::CANNOT_MANIPULATE_SIGSET);
|
|
|
|
|
|
|
|
if (sigaction(pause_signal, &sa, previous_handler))
|
|
|
|
throwFromErrno("Failed to setup signal handler for query profiler", ErrorCodes::CANNOT_SET_SIGNAL_HANDLER);
|
|
|
|
|
|
|
|
try
|
|
|
|
{
|
|
|
|
struct sigevent sev;
|
|
|
|
sev.sigev_notify = SIGEV_THREAD_ID;
|
|
|
|
sev.sigev_signo = pause_signal;
|
|
|
|
sev._sigev_un._tid = thread_id;
|
|
|
|
if (timer_create(clock_type, &sev, &timer_id))
|
|
|
|
throwFromErrno("Failed to create thread timer", ErrorCodes::CANNOT_CREATE_TIMER);
|
|
|
|
|
|
|
|
struct timespec interval{.tv_sec = period / TIMER_PRECISION, .tv_nsec = period % TIMER_PRECISION};
|
|
|
|
struct itimerspec timer_spec = {.it_interval = interval, .it_value = interval};
|
|
|
|
if (timer_settime(timer_id, 0, &timer_spec, nullptr))
|
|
|
|
throwFromErrno("Failed to set thread timer period", ErrorCodes::CANNOT_SET_TIMER_PERIOD);
|
|
|
|
}
|
|
|
|
catch (...)
|
|
|
|
{
|
|
|
|
tryCleanup();
|
|
|
|
throw;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename ProfilerImpl>
|
|
|
|
QueryProfilerBase<ProfilerImpl>::~QueryProfilerBase()
|
|
|
|
{
|
|
|
|
tryCleanup();
|
|
|
|
}
|
|
|
|
|
|
|
|
template <typename ProfilerImpl>
|
|
|
|
void QueryProfilerBase<ProfilerImpl>::tryCleanup()
|
|
|
|
{
|
|
|
|
if (timer_id != nullptr && timer_delete(timer_id))
|
|
|
|
LOG_ERROR(log, "Failed to delete query profiler timer " + errnoToString(ErrorCodes::CANNOT_DELETE_TIMER));
|
|
|
|
|
|
|
|
if (previous_handler != nullptr && sigaction(pause_signal, previous_handler, nullptr))
|
|
|
|
LOG_ERROR(log, "Failed to restore signal handler after query profiler " + errnoToString(ErrorCodes::CANNOT_SET_SIGNAL_HANDLER));
|
|
|
|
}
|
|
|
|
|
|
|
|
template class QueryProfilerBase<QueryProfilerReal>;
|
|
|
|
template class QueryProfilerBase<QueryProfilerCpu>;
|
|
|
|
|
|
|
|
QueryProfilerReal::QueryProfilerReal(const Int32 thread_id, const UInt32 period)
|
|
|
|
: QueryProfilerBase(thread_id, CLOCK_REALTIME, period, SIGUSR1)
|
|
|
|
{}
|
|
|
|
|
|
|
|
void QueryProfilerReal::signalHandler(int sig, siginfo_t * info, void * context)
|
|
|
|
{
|
|
|
|
writeTraceInfo(TimerType::Real, sig, info, context);
|
|
|
|
}
|
|
|
|
|
|
|
|
QueryProfilerCpu::QueryProfilerCpu(const Int32 thread_id, const UInt32 period)
|
|
|
|
: QueryProfilerBase(thread_id, CLOCK_THREAD_CPUTIME_ID, period, SIGUSR2)
|
|
|
|
{}
|
|
|
|
|
|
|
|
void QueryProfilerCpu::signalHandler(int sig, siginfo_t * info, void * context)
|
|
|
|
{
|
|
|
|
writeTraceInfo(TimerType::Cpu, sig, info, context);
|
|
|
|
}
|
2019-05-19 20:22:44 +00:00
|
|
|
|
|
|
|
}
|