ClickHouse/src/Common/checkStackSize.cpp

104 lines
4.0 KiB
C++
Raw Normal View History

2019-08-10 17:51:47 +00:00
#include <Common/checkStackSize.h>
#include <Common/Exception.h>
2021-06-15 19:55:21 +00:00
#include <common/scope_guard.h>
2019-08-10 17:51:47 +00:00
#include <pthread.h>
#include <cstdint>
#if defined(__FreeBSD__)
# include <pthread_np.h>
#endif
2019-08-10 17:51:47 +00:00
namespace DB
{
namespace ErrorCodes
{
extern const int CANNOT_PTHREAD_ATTR;
extern const int LOGICAL_ERROR;
extern const int TOO_DEEP_RECURSION;
}
}
static thread_local void * stack_address = nullptr;
static thread_local size_t max_stack_size = 0;
2021-06-19 14:12:30 +00:00
/**
* @param address_ - stack address
* @return stack size
*/
size_t getStackSize(void **address_)
2019-08-10 17:51:47 +00:00
{
using namespace DB;
2021-06-19 14:12:30 +00:00
size_t size;
void *address;
#if defined(OS_DARWIN)
2021-06-19 14:12:30 +00:00
// pthread_get_stacksize_np() returns a value too low for the main thread on
// OSX 10.9, http://mail.openjdk.java.net/pipermail/hotspot-dev/2013-October/011369.html
//
// Multiple workarounds possible, adopt the one made by https://github.com/robovm/robovm/issues/274
// https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/Multithreading/CreatingThreads/CreatingThreads.html
// Stack size for the main thread is 8MB on OSX excluding the guard page size.
pthread_t thread = pthread_self();
size = pthread_main_np() ? (8 * 1024 * 1024) : pthread_get_stacksize_np(thread);
2019-09-23 19:47:12 +00:00
2021-06-19 14:12:30 +00:00
// stack address points to the start of the stack, not the end how it's returned by pthread_get_stackaddr_np
address = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(pthread_get_stackaddr_np(thread)) - max_stack_size);
2019-09-21 18:30:01 +00:00
#else
2021-06-19 14:12:30 +00:00
pthread_attr_t attr;
# if defined(__FreeBSD__) || defined(OS_SUNOS)
2021-06-19 14:12:30 +00:00
pthread_attr_init(&attr);
if (0 != pthread_attr_get_np(pthread_self(), &attr))
throwFromErrno("Cannot pthread_attr_get_np", ErrorCodes::CANNOT_PTHREAD_ATTR);
# else
2021-06-19 14:12:30 +00:00
if (0 != pthread_getattr_np(pthread_self(), &attr))
throwFromErrno("Cannot pthread_getattr_np", ErrorCodes::CANNOT_PTHREAD_ATTR);
# endif
2019-08-10 17:51:47 +00:00
2021-06-19 14:12:30 +00:00
SCOPE_EXIT({ pthread_attr_destroy(&attr); });
2019-08-10 17:51:47 +00:00
2021-06-19 14:12:30 +00:00
if (0 != pthread_attr_getstack(&attr, &address, &size))
throwFromErrno("Cannot pthread_getattr_np", ErrorCodes::CANNOT_PTHREAD_ATTR);
#endif // OS_DARWIN
2021-06-19 14:12:30 +00:00
if (address_)
*address_ = address;
return size;
}
/** It works fine when interpreters are instantiated by ClickHouse code in properly prepared threads,
* but there are cases when ClickHouse runs as a library inside another application.
* If application is using user-space lightweight threads with manually allocated stacks,
* current implementation is not reasonable, as it has no way to properly check the remaining
* stack size without knowing the details of how stacks are allocated.
* We mark this function as weak symbol to be able to replace it in another ClickHouse-based products.
*/
__attribute__((__weak__)) void checkStackSize()
{
using namespace DB;
if (!stack_address)
max_stack_size = getStackSize(&stack_address);
2019-08-10 17:51:47 +00:00
const void * frame_address = __builtin_frame_address(0);
uintptr_t int_frame_address = reinterpret_cast<uintptr_t>(frame_address);
uintptr_t int_stack_address = reinterpret_cast<uintptr_t>(stack_address);
/// We assume that stack grows towards lower addresses. And that it starts to grow from the end of a chunk of memory of max_stack_size.
if (int_frame_address > int_stack_address + max_stack_size)
throw Exception("Logical error: frame address is greater than stack begin address", ErrorCodes::LOGICAL_ERROR);
size_t stack_size = int_stack_address + max_stack_size - int_frame_address;
/// Just check if we have already eat more than a half of stack size. It's a bit overkill (a half of stack size is wasted).
/// It's safe to assume that overflow in multiplying by two cannot occur.
if (stack_size * 2 > max_stack_size)
{
2020-11-10 18:22:26 +00:00
throw Exception(ErrorCodes::TOO_DEEP_RECURSION,
"Stack size too large. Stack address: {}, frame address: {}, stack size: {}, maximum stack size: {}",
stack_address, frame_address, stack_size, max_stack_size);
2019-08-10 17:51:47 +00:00
}
}