#include #include #include #include #include #include #include #include /// pair #if __has_include("config_tools.h") #include "config_tools.h" #endif #if __has_include("config_core.h") #include "config_core.h" #endif #include #include #include /// Universal executable for various clickhouse applications #if ENABLE_CLICKHOUSE_SERVER || !defined(ENABLE_CLICKHOUSE_SERVER) int mainEntryClickHouseServer(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_CLIENT || !defined(ENABLE_CLICKHOUSE_CLIENT) int mainEntryClickHouseClient(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_LOCAL || !defined(ENABLE_CLICKHOUSE_LOCAL) int mainEntryClickHouseLocal(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_BENCHMARK || !defined(ENABLE_CLICKHOUSE_BENCHMARK) int mainEntryClickHouseBenchmark(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_EXTRACT_FROM_CONFIG || !defined(ENABLE_CLICKHOUSE_EXTRACT_FROM_CONFIG) int mainEntryClickHouseExtractFromConfig(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_COMPRESSOR || !defined(ENABLE_CLICKHOUSE_COMPRESSOR) int mainEntryClickHouseCompressor(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_FORMAT || !defined(ENABLE_CLICKHOUSE_FORMAT) int mainEntryClickHouseFormat(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_COPIER || !defined(ENABLE_CLICKHOUSE_COPIER) int mainEntryClickHouseClusterCopier(int argc, char ** argv); #endif #if ENABLE_CLICKHOUSE_OBFUSCATOR || !defined(ENABLE_CLICKHOUSE_OBFUSCATOR) int mainEntryClickHouseObfuscator(int argc, char ** argv); #endif namespace { using MainFunc = int (*)(int, char**); /// Add an item here to register new application std::pair clickhouse_applications[] = { #if ENABLE_CLICKHOUSE_LOCAL || !defined(ENABLE_CLICKHOUSE_LOCAL) {"local", mainEntryClickHouseLocal}, #endif #if ENABLE_CLICKHOUSE_CLIENT || !defined(ENABLE_CLICKHOUSE_CLIENT) {"client", mainEntryClickHouseClient}, #endif #if ENABLE_CLICKHOUSE_BENCHMARK || !defined(ENABLE_CLICKHOUSE_BENCHMARK) {"benchmark", mainEntryClickHouseBenchmark}, #endif #if ENABLE_CLICKHOUSE_SERVER || !defined(ENABLE_CLICKHOUSE_SERVER) {"server", mainEntryClickHouseServer}, #endif #if ENABLE_CLICKHOUSE_EXTRACT_FROM_CONFIG || !defined(ENABLE_CLICKHOUSE_EXTRACT_FROM_CONFIG) {"extract-from-config", mainEntryClickHouseExtractFromConfig}, #endif #if ENABLE_CLICKHOUSE_COMPRESSOR || !defined(ENABLE_CLICKHOUSE_COMPRESSOR) {"compressor", mainEntryClickHouseCompressor}, #endif #if ENABLE_CLICKHOUSE_FORMAT || !defined(ENABLE_CLICKHOUSE_FORMAT) {"format", mainEntryClickHouseFormat}, #endif #if ENABLE_CLICKHOUSE_COPIER || !defined(ENABLE_CLICKHOUSE_COPIER) {"copier", mainEntryClickHouseClusterCopier}, #endif #if ENABLE_CLICKHOUSE_OBFUSCATOR || !defined(ENABLE_CLICKHOUSE_OBFUSCATOR) {"obfuscator", mainEntryClickHouseObfuscator}, #endif }; int printHelp(int, char **) { std::cerr << "Use one of the following commands:" << std::endl; for (auto & application : clickhouse_applications) std::cerr << "clickhouse " << application.first << " [args] " << std::endl; return -1; } bool isClickhouseApp(const std::string & app_suffix, std::vector & argv) { /// Use app if the first arg 'app' is passed (the arg should be quietly removed) if (argv.size() >= 2) { auto first_arg = argv.begin() + 1; /// 'clickhouse --client ...' and 'clickhouse client ...' are Ok if (*first_arg == "--" + app_suffix || *first_arg == app_suffix) { argv.erase(first_arg); return true; } } /// Use app if clickhouse binary is run through symbolic link with name clickhouse-app std::string app_name = "clickhouse-" + app_suffix; return !argv.empty() && (app_name == argv[0] || endsWith(argv[0], "/" + app_name)); } enum class InstructionFail { NONE = 0, SSE3 = 1, SSSE3 = 2, SSE4_1 = 3, SSE4_2 = 4, POPCNT = 5, AVX = 6, AVX2 = 7, AVX512 = 8 }; const char * instructionFailToString(InstructionFail fail) { switch (fail) { case InstructionFail::NONE: return "NONE"; case InstructionFail::SSE3: return "SSE3"; case InstructionFail::SSSE3: return "SSSE3"; case InstructionFail::SSE4_1: return "SSE4.1"; case InstructionFail::SSE4_2: return "SSE4.2"; case InstructionFail::POPCNT: return "POPCNT"; case InstructionFail::AVX: return "AVX"; case InstructionFail::AVX2: return "AVX2"; case InstructionFail::AVX512: return "AVX512"; } __builtin_unreachable(); } sigjmp_buf jmpbuf; [[noreturn]] void sigIllCheckHandler(int, siginfo_t *, void *) { siglongjmp(jmpbuf, 1); } /// Check if necessary SSE extensions are available by trying to execute some sse instructions. /// If instruction is unavailable, SIGILL will be sent by kernel. void checkRequiredInstructionsImpl(volatile InstructionFail & fail) { #if defined(__SSE3__) fail = InstructionFail::SSE3; __asm__ volatile ("addsubpd %%xmm0, %%xmm0" : : : "xmm0"); #endif #if defined(__SSSE3__) fail = InstructionFail::SSSE3; __asm__ volatile ("pabsw %%xmm0, %%xmm0" : : : "xmm0"); #endif #if defined(__SSE4_1__) fail = InstructionFail::SSE4_1; __asm__ volatile ("pmaxud %%xmm0, %%xmm0" : : : "xmm0"); #endif #if defined(__SSE4_2__) fail = InstructionFail::SSE4_2; __asm__ volatile ("pcmpgtq %%xmm0, %%xmm0" : : : "xmm0"); #endif /// Defined by -msse4.2 #if defined(__POPCNT__) fail = InstructionFail::POPCNT; { uint64_t a = 0; uint64_t b = 0; __asm__ volatile ("popcnt %1, %0" : "=r"(a) :"r"(b) :); } #endif #if defined(__AVX__) fail = InstructionFail::AVX; __asm__ volatile ("vaddpd %%ymm0, %%ymm0, %%ymm0" : : : "ymm0"); #endif #if defined(__AVX2__) fail = InstructionFail::AVX2; __asm__ volatile ("vpabsw %%ymm0, %%ymm0" : : : "ymm0"); #endif #if defined(__AVX512__) fail = InstructionFail::AVX512; __asm__ volatile ("vpabsw %%zmm0, %%zmm0" : : : "zmm0"); #endif fail = InstructionFail::NONE; } /// This function is safe to use in static initializers. void writeError(const char * data, size_t size) { while (size != 0) { ssize_t res = ::write(STDERR_FILENO, data, size); if ((-1 == res || 0 == res) && errno != EINTR) _Exit(1); if (res > 0) { data += res; size -= res; } } } /// Check SSE and others instructions availability. Calls exit on fail. /// This function must be called as early as possible, even before main, because static initializers may use unavailable instructions. void checkRequiredInstructions() { struct sigaction sa{}; struct sigaction sa_old{}; sa.sa_sigaction = sigIllCheckHandler; sa.sa_flags = SA_SIGINFO; auto signal = SIGILL; if (sigemptyset(&sa.sa_mask) != 0 || sigaddset(&sa.sa_mask, signal) != 0 || sigaction(signal, &sa, &sa_old) != 0) { /// You may wonder about strlen. /// Typical implementation of strlen is using SSE4.2 or AVX2. /// But this is not the case because it's compiler builtin and is executed at compile time. const char * msg = "Can not set signal handler\n"; writeError(msg, strlen(msg)); _Exit(1); } volatile InstructionFail fail = InstructionFail::NONE; if (sigsetjmp(jmpbuf, 1)) { const char * msg1 = "Instruction check fail. The CPU does not support "; writeError(msg1, strlen(msg1)); const char * msg2 = instructionFailToString(fail); writeError(msg2, strlen(msg2)); const char * msg3 = " instruction set.\n"; writeError(msg3, strlen(msg3)); _Exit(1); } checkRequiredInstructionsImpl(fail); if (sigaction(signal, &sa_old, nullptr)) { const char * msg = "Can not set signal handler\n"; writeError(msg, strlen(msg)); _Exit(1); } } struct Checker { Checker() { checkRequiredInstructions(); } } checker; } /// This allows to implement assert to forbid initialization of a class in static constructors. /// Usage: /// /// extern bool inside_main; /// class C { C() { assert(inside_main); } }; bool inside_main = false; int main(int argc_, char ** argv_) { inside_main = true; SCOPE_EXIT({ inside_main = false; }); /// Reset new handler to default (that throws std::bad_alloc) /// It is needed because LLVM library clobbers it. std::set_new_handler(nullptr); /// PHDR cache is required for query profiler to work reliably /// It also speed up exception handling, but exceptions from dynamically loaded libraries (dlopen) /// will work only after additional call of this function. updatePHDRCache(); std::vector argv(argv_, argv_ + argc_); /// Print a basic help if nothing was matched MainFunc main_func = printHelp; for (auto & application : clickhouse_applications) { if (isClickhouseApp(application.first, argv)) { main_func = application.second; break; } } return main_func(static_cast(argv.size()), argv.data()); }