9#include <botan/internal/os_utils.h>
11#include <botan/exceptn.h>
12#include <botan/mem_ops.h>
13#include <botan/internal/target_info.h>
15#if defined(BOTAN_HAS_CPUID)
16 #include <botan/internal/cpuid.h>
25#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
32 #include <sys/resource.h>
33 #include <sys/types.h>
39#if defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
40 #include <emscripten/emscripten.h>
43#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL) || defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
47#if defined(BOTAN_TARGET_OS_HAS_WIN32)
51 #if defined(BOTAN_BUILD_COMPILER_IS_MSVC)
52 #include <libloaderapi.h>
53 #include <stringapiset.h>
57#if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
58 #include <mach/vm_statistics.h>
59 #include <sys/sysctl.h>
60 #include <sys/types.h>
63#if defined(BOTAN_TARGET_OS_HAS_PRCTL)
64 #include <sys/prctl.h>
67#if defined(BOTAN_TARGET_OS_IS_FREEBSD) || defined(BOTAN_TARGET_OS_IS_OPENBSD) || defined(BOTAN_TARGET_OS_IS_DRAGONFLY)
68 #include <pthread_np.h>
71#if defined(BOTAN_TARGET_OS_IS_HAIKU)
72 #include <kernel/OS.h>
78#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
80#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
81 return ::GetCurrentProcessId();
82#elif defined(BOTAN_TARGET_OS_IS_LLVM) || defined(BOTAN_TARGET_OS_IS_NONE)
85 #error "Missing get_process_id"
91#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL) || defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
92 #define BOTAN_TARGET_HAS_AUXVAL_INTERFACE
95std::optional<unsigned long> auxval_hwcap() {
98#elif defined(BOTAN_TARGET_HAS_AUXVAL_INTERFACE)
107std::optional<unsigned long> auxval_hwcap2() {
108#if defined(AT_HWCAP2)
110#elif defined(BOTAN_TARGET_HAS_AUXVAL_INTERFACE)
119std::optional<unsigned long> get_auxval(std::optional<unsigned long>
id) {
121#if defined(BOTAN_TARGET_OS_HAS_GETAUXVAL)
122 return ::getauxval(*
id);
123#elif defined(BOTAN_TARGET_OS_HAS_ELF_AUX_INFO)
124 unsigned long auxinfo = 0;
125 if(::elf_aux_info(
static_cast<int>(*
id), &auxinfo,
sizeof(auxinfo)) == 0) {
137 if(
const auto hwcap = get_auxval(auxval_hwcap())) {
140 auto hwcap2 = get_auxval(auxval_hwcap2()).value_or(0);
141 return std::make_pair(*hwcap, hwcap2);
153bool running_in_privileged_state() {
154#if defined(AT_SECURE)
155 if(
auto at_secure = get_auxval(AT_SECURE)) {
156 return at_secure != 0;
160#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
161 return (::getuid() != ::geteuid()) || (::getgid() != ::getegid());
172#if defined(BOTAN_TARGET_OS_HAS_WIN32)
174 ::QueryPerformanceCounter(&tv);
177#elif defined(BOTAN_USE_GCC_INLINE_ASM)
179 #if defined(BOTAN_TARGET_ARCH_IS_X86_64)
181 uint32_t rtc_low = 0;
182 uint32_t rtc_high = 0;
183 asm volatile(
"rdtsc" :
"=d"(rtc_high),
"=a"(rtc_low));
184 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
186 #elif defined(BOTAN_TARGET_ARCH_IS_X86_FAMILY) && defined(BOTAN_HAS_CPUID)
189 uint32_t rtc_low = 0;
190 uint32_t rtc_high = 0;
191 asm volatile(
"rdtsc" :
"=d"(rtc_high),
"=a"(rtc_low));
192 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
195 #elif defined(BOTAN_TARGET_ARCH_IS_PPC64)
198 uint32_t rtc_low = 0;
199 uint32_t rtc_high = 0;
200 uint32_t rtc_high2 = 0;
201 asm volatile(
"mftbu %0" :
"=r"(rtc_high));
202 asm volatile(
"mftb %0" :
"=r"(rtc_low));
203 asm volatile(
"mftbu %0" :
"=r"(rtc_high2));
205 if(rtc_high == rtc_high2) {
206 rtc = (
static_cast<uint64_t
>(rtc_high) << 32) | rtc_low;
211 #elif defined(BOTAN_TARGET_ARCH_IS_ALPHA)
212 asm volatile(
"rpcc %0" :
"=r"(rtc));
215 #elif defined(BOTAN_TARGET_ARCH_IS_SPARC64) && !defined(BOTAN_TARGET_OS_IS_OPENBSD)
216 asm volatile(
"rd %%tick, %0" :
"=r"(rtc));
218 #elif defined(BOTAN_TARGET_ARCH_IS_IA64)
219 asm volatile(
"mov %0=ar.itc" :
"=r"(rtc));
221 #elif defined(BOTAN_TARGET_ARCH_IS_S390X)
222 asm volatile(
"stck 0(%0)" : :
"a"(&rtc) :
"memory",
"cc");
224 #elif defined(BOTAN_TARGET_ARCH_IS_HPPA)
225 asm volatile(
"mfctl 16,%0" :
"=r"(rtc));
237#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
239 #if defined(_SC_NPROCESSORS_ONLN)
240 const long cpu_online = ::sysconf(_SC_NPROCESSORS_ONLN);
242 return static_cast<size_t>(cpu_online);
246 #if defined(_SC_NPROCESSORS_CONF)
247 const long cpu_conf = ::sysconf(_SC_NPROCESSORS_CONF);
249 return static_cast<size_t>(cpu_conf);
255#if defined(BOTAN_TARGET_OS_HAS_THREADS)
258 const size_t hw_concur = std::thread::hardware_concurrency();
273#if defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
274 return emscripten_get_now();
284#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
287 const clockid_t clock_types[] = {
288 #if defined(CLOCK_MONOTONIC_HR)
291 #if defined(CLOCK_MONOTONIC_RAW)
294 #if defined(CLOCK_MONOTONIC)
297 #if defined(CLOCK_PROCESS_CPUTIME_ID)
298 CLOCK_PROCESS_CPUTIME_ID,
300 #if defined(CLOCK_THREAD_CPUTIME_ID)
301 CLOCK_THREAD_CPUTIME_ID,
305 for(clockid_t clock : clock_types) {
306 struct timespec ts {};
308 if(::clock_gettime(clock, &ts) == 0) {
309 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
314#if defined(BOTAN_TARGET_OS_HAS_SYSTEM_CLOCK)
316 auto now = std::chrono::high_resolution_clock::now().time_since_epoch();
317 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
324#if defined(BOTAN_TARGET_OS_HAS_CLOCK_GETTIME)
325 struct timespec ts {};
327 if(::clock_gettime(CLOCK_REALTIME, &ts) == 0) {
328 return (
static_cast<uint64_t
>(ts.tv_sec) * 1000000000) +
static_cast<uint64_t
>(ts.tv_nsec);
332#if defined(BOTAN_TARGET_OS_HAS_SYSTEM_CLOCK)
333 auto now = std::chrono::system_clock::now().time_since_epoch();
334 return std::chrono::duration_cast<std::chrono::nanoseconds>(now).count();
336 throw Not_Implemented(
"OS::get_system_timestamp_ns this system does not support a clock");
343#if defined(BOTAN_TARGET_OS_HAS_WIN32)
344 if(::localtime_s(&tm, &time) != 0) {
347#elif defined(BOTAN_TARGET_OS_HAS_POSIX1)
348 if(::localtime_r(&time, &tm) ==
nullptr) {
352 if(
auto tmp = std::localtime(&time)) {
359 std::ostringstream oss;
360 oss << std::put_time(&tm, format.c_str());
365 const size_t default_page_size = 4096;
367#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
368 long p = ::sysconf(_SC_PAGESIZE);
370 return static_cast<size_t>(p);
372 return default_page_size;
374#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
376 SYSTEM_INFO sys_info;
377 ::GetSystemInfo(&sys_info);
378 return sys_info.dwPageSize;
380 return default_page_size;
393 const size_t max_locked_kb = 512;
399#if defined(RLIMIT_MEMLOCK) && defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
400 const size_t mlock_requested =
403 if(mlock_requested > 0) {
404 struct ::rlimit limits {};
406 ::getrlimit(RLIMIT_MEMLOCK, &limits);
408 if(limits.rlim_cur < limits.rlim_max) {
409 limits.rlim_cur = limits.rlim_max;
410 ::setrlimit(RLIMIT_MEMLOCK, &limits);
411 ::getrlimit(RLIMIT_MEMLOCK, &limits);
414 return std::min<size_t>(limits.rlim_cur, mlock_requested * 1024);
417#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
418 const size_t mlock_requested =
421 SIZE_T working_min = 0, working_max = 0;
422 if(!::GetProcessWorkingSetSize(::GetCurrentProcess(), &working_min, &working_max)) {
433 if(working_min > overhead) {
434 const size_t lockable_bytes = working_min - overhead;
435 return std::min<size_t>(lockable_bytes, mlock_requested * 1024);
448 if(running_in_privileged_state()) {
452#if defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(BOTAN_BUILD_COMPILER_IS_MSVC)
453 const std::string name(name_view);
456 if(getenv_s(&req_size, val,
sizeof(val), name.c_str()) == 0) {
460 if(req_size > 0 && val[req_size - 1] ==
'\0') {
461 value_out = std::string(val);
463 value_out = std::string(val, req_size);
468 const std::string name(name_view);
469 if(
const char* val = std::getenv(name.c_str())) {
482 const size_t val = std::stoul(value,
nullptr);
484 }
catch(std::exception&) {
491#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
496 #if defined(BOTAN_TARGET_OS_IS_IOS) || defined(BOTAN_TARGET_OS_IS_MACOS)
499 static constexpr int default_locked_fd = 255;
500 int locked_fd = default_locked_fd;
503 if(locked_fdl < 240 || locked_fdl > 255) {
504 locked_fdl = default_locked_fd;
506 locked_fd =
static_cast<int>(locked_fdl);
508 return VM_MAKE_TAG(locked_fd);
519 std::vector<void*> result;
521#if(defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)) || \
522 defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
524 result.reserve(count);
528 #if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
529 static const int locked_fd = get_locked_fd();
532 for(
size_t i = 0; i != count; ++i) {
535 #if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
537 int mmap_flags = MAP_PRIVATE;
539 #if defined(MAP_ANONYMOUS)
540 mmap_flags |= MAP_ANONYMOUS;
541 #elif defined(MAP_ANON)
542 mmap_flags |= MAP_ANON;
545 #if defined(MAP_CONCEAL)
546 mmap_flags |= MAP_CONCEAL;
547 #elif defined(MAP_NOCORE)
548 mmap_flags |= MAP_NOCORE;
551 int mmap_prot = PROT_READ | PROT_WRITE;
553 #if defined(PROT_MAX)
554 mmap_prot |= PROT_MAX(mmap_prot);
557 ptr = ::mmap(
nullptr,
564 if(ptr == MAP_FAILED) {
569 if(::mlock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) != 0) {
570 ::munmap(ptr, 3 * page_size);
574 #if defined(MADV_DONTDUMP)
576 ::madvise(
static_cast<uint8_t*
>(ptr) + page_size, page_size, MADV_DONTDUMP);
579 #elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
580 ptr = ::VirtualAlloc(
nullptr, 3 * page_size, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
585 if(::VirtualLock(
static_cast<uint8_t*
>(ptr) + page_size, page_size) == 0) {
586 ::VirtualFree(ptr, 0, MEM_RELEASE);
591 std::memset(ptr, 0, 3 * page_size);
600 result.push_back(
static_cast<uint8_t*
>(ptr) + page_size);
610#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
612 ::mprotect(page, page_size, PROT_READ | PROT_WRITE);
613#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
616 ::VirtualProtect(page, page_size, PAGE_READWRITE, &old_perms);
624#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
626 ::mprotect(page, page_size, PROT_NONE);
627#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
630 ::VirtualProtect(page, page_size, PAGE_NOACCESS, &old_perms);
640 for(
void* ptr : pages) {
647#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && defined(BOTAN_TARGET_OS_HAS_POSIX_MLOCK)
648 ::munlock(ptr, page_size);
649 ::munmap(
static_cast<uint8_t*
>(ptr) - page_size, 3 * page_size);
650#elif defined(BOTAN_TARGET_OS_HAS_VIRTUAL_LOCK)
651 ::VirtualUnlock(ptr, page_size);
652 ::VirtualFree(
static_cast<uint8_t*
>(ptr) - page_size, 0, MEM_RELEASE);
658#if defined(BOTAN_TARGET_OS_HAS_PRCTL) && defined(PR_SET_VMA) && defined(PR_SET_VMA_ANON_NAME)
659 static constexpr char name[] =
"Botan mlock pool";
661 int r = prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME,
reinterpret_cast<uintptr_t
>(page), size, name);
668#if defined(BOTAN_TARGET_OS_HAS_THREADS)
669void OS::set_thread_name(std::thread& thread,
const std::string& name) {
670 #if defined(BOTAN_TARGET_OS_IS_LINUX) || defined(BOTAN_TARGET_OS_IS_FREEBSD) || defined(BOTAN_TARGET_OS_IS_DRAGONFLY)
671 static_cast<void>(pthread_setname_np(thread.native_handle(), name.c_str()));
672 #elif defined(BOTAN_TARGET_OS_IS_OPENBSD)
673 static_cast<void>(pthread_set_name_np(thread.native_handle(), name.c_str()));
674 #elif defined(BOTAN_TARGET_OS_IS_NETBSD)
675 static_cast<void>(pthread_setname_np(thread.native_handle(),
"%s",
const_cast<char*
>(name.c_str())));
676 #elif defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(_LIBCPP_HAS_THREAD_API_PTHREAD)
677 static_cast<void>(pthread_setname_np(thread.native_handle(), name.c_str()));
678 #elif defined(BOTAN_TARGET_OS_HAS_WIN32) && defined(BOTAN_BUILD_COMPILER_IS_MSVC)
679 typedef HRESULT(WINAPI * std_proc)(HANDLE, PCWSTR);
680 HMODULE kern = GetModuleHandleA(
"KernelBase.dll");
681 std_proc set_thread_name =
reinterpret_cast<std_proc
>(GetProcAddress(kern,
"SetThreadDescription"));
682 if(set_thread_name) {
684 auto sz = MultiByteToWideChar(CP_UTF8, 0, name.data(), -1,
nullptr, 0);
687 if(MultiByteToWideChar(CP_UTF8, 0, name.data(), -1, &w[0], sz) > 0) {
688 (void)set_thread_name(thread.native_handle(), w.c_str());
692 #elif defined(BOTAN_TARGET_OS_IF_HAIKU)
693 auto thread_id = get_pthread_thread_id(thread.native_handle());
694 static_cast<void>(rename_thread(thread_id, name.c_str()));
703#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
708::sigjmp_buf g_sigill_jmp_buf;
710void botan_sigill_handler(
int ) {
711 siglongjmp(g_sigill_jmp_buf, 1);
719 volatile int probe_result = -3;
721#if defined(BOTAN_TARGET_OS_HAS_POSIX1) && !defined(BOTAN_TARGET_OS_IS_EMSCRIPTEN)
722 struct sigaction old_sigaction {};
724 struct sigaction sigaction {};
726 sigaction.sa_handler = botan_sigill_handler;
727 sigemptyset(&sigaction.sa_mask);
728 sigaction.sa_flags = 0;
730 int rc = ::sigaction(SIGILL, &sigaction, &old_sigaction);
733 throw System_Error(
"run_cpu_instruction_probe sigaction failed", errno);
736 rc = sigsetjmp(g_sigill_jmp_buf, 1);
740 probe_result = probe_fn();
747 rc = ::sigaction(SIGILL, &old_sigaction,
nullptr);
749 throw System_Error(
"run_cpu_instruction_probe sigaction restore failed", errno);
760#if defined(BOTAN_TARGET_OS_HAS_POSIX1)
763 POSIX_Echo_Suppression() : m_stdin_fd(fileno(stdin)), m_old_termios{} {
764 if(::tcgetattr(m_stdin_fd, &m_old_termios) != 0) {
765 throw System_Error(
"Getting terminal status failed", errno);
768 struct termios noecho_flags = m_old_termios;
769 noecho_flags.c_lflag &= ~ECHO;
770 noecho_flags.c_lflag |= ECHONL;
772 if(::tcsetattr(m_stdin_fd, TCSANOW, &noecho_flags) != 0) {
773 throw System_Error(
"Clearing terminal echo bit failed", errno);
777 void reenable_echo()
override {
779 if(::tcsetattr(m_stdin_fd, TCSANOW, &m_old_termios) != 0) {
780 throw System_Error(
"Restoring terminal echo bit failed", errno);
786 ~POSIX_Echo_Suppression()
override {
792 POSIX_Echo_Suppression(
const POSIX_Echo_Suppression& other) =
delete;
793 POSIX_Echo_Suppression(POSIX_Echo_Suppression&& other) =
delete;
794 POSIX_Echo_Suppression& operator=(
const POSIX_Echo_Suppression& other) =
delete;
795 POSIX_Echo_Suppression& operator=(POSIX_Echo_Suppression&& other) =
delete;
799 struct termios m_old_termios;
802 return std::make_unique<POSIX_Echo_Suppression>();
804#elif defined(BOTAN_TARGET_OS_HAS_WIN32)
808 Win32_Echo_Suppression() {
809 m_input_handle = ::GetStdHandle(STD_INPUT_HANDLE);
810 if(::GetConsoleMode(m_input_handle, &m_console_state) == 0)
811 throw System_Error(
"Getting console mode failed", ::GetLastError());
813 DWORD new_mode = ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
814 if(::SetConsoleMode(m_input_handle, new_mode) == 0)
815 throw System_Error(
"Setting console mode failed", ::GetLastError());
818 void reenable_echo()
override {
819 if(m_input_handle != INVALID_HANDLE_VALUE) {
820 if(::SetConsoleMode(m_input_handle, m_console_state) == 0)
821 throw System_Error(
"Setting console mode failed", ::GetLastError());
822 m_input_handle = INVALID_HANDLE_VALUE;
826 ~Win32_Echo_Suppression()
override {
832 Win32_Echo_Suppression(
const Win32_Echo_Suppression& other) =
delete;
833 Win32_Echo_Suppression(Win32_Echo_Suppression&& other) =
delete;
834 Win32_Echo_Suppression& operator=(
const Win32_Echo_Suppression& other) =
delete;
835 Win32_Echo_Suppression& operator=(Win32_Echo_Suppression&& other) =
delete;
838 HANDLE m_input_handle;
839 DWORD m_console_state;
842 return std::make_unique<Win32_Echo_Suppression>();
static bool has(CPUID::Feature feat)
size_t get_memory_locking_limit()
uint64_t BOTAN_TEST_API get_high_resolution_clock()
size_t BOTAN_TEST_API get_cpu_available()
std::unique_ptr< Echo_Suppression > BOTAN_UNSTABLE_API suppress_echo_on_terminal()
size_t read_env_variable_sz(std::string_view var_name, size_t def_value=0)
void page_allow_access(void *page)
std::string BOTAN_TEST_API format_time(time_t time, const std::string &format)
bool read_env_variable(std::string &value_out, std::string_view var_name)
void page_prohibit_access(void *page)
std::optional< std::pair< unsigned long, unsigned long > > get_auxval_hwcap()
int BOTAN_TEST_API run_cpu_instruction_probe(const std::function< int()> &probe_fn)
std::vector< void * > allocate_locked_pages(size_t count)
size_t system_page_size()
uint64_t BOTAN_TEST_API get_system_timestamp_ns()
void free_locked_pages(const std::vector< void * > &pages)
void page_named(void *page, size_t size)
uint32_t BOTAN_TEST_API get_process_id()
uint64_t BOTAN_TEST_API get_cpu_cycle_counter()
void secure_scrub_memory(void *ptr, size_t n)