ardupilot/libraries/AP_HAL_SITL/Scheduler.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

434 lines
11 KiB
C++
Raw Normal View History

#include <AP_HAL/AP_HAL.h>
#include "AP_HAL_SITL.h"
2020-08-03 00:24:26 -03:00
#include <AP_HAL_SITL/I2CDevice.h>
#include "Scheduler.h"
#include "UARTDriver.h"
#include <sys/time.h>
#include <fenv.h>
#include <AP_BoardConfig/AP_BoardConfig.h>
2020-05-13 14:07:44 -03:00
#if defined (__clang__) || (defined (__APPLE__) && defined (__MACH__))
#include <stdlib.h>
#else
2018-08-19 23:39:05 -03:00
#include <malloc.h>
#endif
#include <AP_RCProtocol/AP_RCProtocol.h>
#ifdef UBSAN_ENABLED
2024-01-19 18:34:16 -04:00
#include <fcntl.h>
#include <sanitizer/asan_interface.h>
#endif
using namespace HALSITL;
extern const AP_HAL::HAL& hal;
#ifndef SITL_STACK_CHECKING_ENABLED
//#define SITL_STACK_CHECKING_ENABLED !defined(__CYGWIN__) && !defined(__CYGWIN64__)
// stack checking is disabled until the memory corruption issues are
// fixed with pthread_attr_setstack. These may be due to
// changes in the way guard pages are handled.
#define SITL_STACK_CHECKING_ENABLED 0
#endif
AP_HAL::Proc Scheduler::_failsafe = nullptr;
AP_HAL::MemberProc Scheduler::_timer_proc[SITL_SCHEDULER_MAX_TIMER_PROCS] = {nullptr};
uint8_t Scheduler::_num_timer_procs = 0;
bool Scheduler::_in_timer_proc = false;
AP_HAL::MemberProc Scheduler::_io_proc[SITL_SCHEDULER_MAX_TIMER_PROCS] = {nullptr};
uint8_t Scheduler::_num_io_procs = 0;
bool Scheduler::_in_io_proc = false;
bool Scheduler::_should_exit = false;
bool Scheduler::_in_semaphore_take_wait = false;
2018-08-19 23:39:05 -03:00
Scheduler::thread_attr *Scheduler::threads;
HAL_Semaphore Scheduler::_thread_sem;
Scheduler::Scheduler(SITL_State *sitlState) :
_sitlState(sitlState),
_stopped_clock_usec(0)
{
}
#ifdef UBSAN_ENABLED
/*
catch ubsan errors and append to a log file
*/
extern "C" {
void __ubsan_get_current_report_data(const char **OutIssueKind,
const char **OutMessage,
const char **OutFilename, unsigned *OutLine,
unsigned *OutCol, char **OutMemoryAddr);
2024-01-19 18:34:16 -04:00
void __ubsan_on_report();
void __ubsan_on_report()
{
static int fd = -1;
if (fd == -1) {
const char *ubsan_log_path = getenv("UBSAN_LOG_PATH");
if (ubsan_log_path == nullptr) {
ubsan_log_path = "ubsan.log";
}
if (ubsan_log_path != nullptr) {
fd = open(ubsan_log_path, O_APPEND|O_CREAT|O_WRONLY, 0644);
}
}
if (fd != -1) {
const char *OutIssueKind = nullptr;
const char *OutMessage = nullptr;
const char *OutFilename = nullptr;
unsigned OutLine=0;
unsigned OutCol=0;
char *OutMemoryAddr=nullptr;
__ubsan_get_current_report_data(&OutIssueKind, &OutMessage, &OutFilename,
&OutLine, &OutCol, &OutMemoryAddr);
dprintf(fd, "ubsan error: %s:%u:%u %s:%s\n",
OutFilename, OutLine, OutCol,
OutIssueKind, OutMessage);
}
}
}
#endif
void Scheduler::init()
{
_main_ctx = pthread_self();
}
bool Scheduler::in_main_thread() const
{
if (!_in_timer_proc && !_in_io_proc && pthread_self() == _main_ctx) {
return true;
}
return false;
}
/*
* semaphore_wait_hack_required - possibly move time input step
* forward even if we are currently pretending to be the IO or timer
* threads.
*
* Without this, if another thread has taken a semaphore (e.g. the
* Object Avoidance thread), and an "IO process" tries to take that
* semaphore with a timeout specified, then we end up not advancing
* time (due to the logic in SITL_State::wait_clock) and thus taking
* the semaphore never times out - meaning we essentially deadlock.
*/
bool Scheduler::semaphore_wait_hack_required() const
{
if (pthread_self() != _main_ctx) {
// only the main thread ever moves stuff forwards
return false;
}
return _in_semaphore_take_wait;
}
void Scheduler::delay_microseconds(uint16_t usec)
{
if (_sitlState->_sitl == nullptr) {
// this allows examples to run
hal.scheduler->stop_clock(AP_HAL::micros64()+usec);
return;
}
uint64_t start = AP_HAL::micros64();
do {
uint64_t dtime = AP_HAL::micros64() - start;
if (dtime >= usec) {
break;
}
_sitlState->wait_clock(start + usec);
} while (true);
}
void Scheduler::delay(uint16_t ms)
{
uint32_t start = AP_HAL::millis();
uint32_t now = start;
do {
delay_microseconds(1000);
if (_min_delay_cb_ms <= (ms - (now - start))) {
if (in_main_thread()) {
call_delay_cb();
}
}
now = AP_HAL::millis();
} while (now - start < ms);
}
void Scheduler::register_timer_process(AP_HAL::MemberProc proc)
{
for (uint8_t i = 0; i < _num_timer_procs; i++) {
if (_timer_proc[i] == proc) {
return;
}
}
if (_num_timer_procs < SITL_SCHEDULER_MAX_TIMER_PROCS) {
_timer_proc[_num_timer_procs] = proc;
_num_timer_procs++;
}
}
void Scheduler::register_io_process(AP_HAL::MemberProc proc)
{
for (uint8_t i = 0; i < _num_io_procs; i++) {
if (_io_proc[i] == proc) {
return;
}
}
if (_num_io_procs < SITL_SCHEDULER_MAX_TIMER_PROCS) {
_io_proc[_num_io_procs] = proc;
_num_io_procs++;
}
}
void Scheduler::register_timer_failsafe(AP_HAL::Proc failsafe, uint32_t period_us)
{
_failsafe = failsafe;
}
void Scheduler::set_system_initialized() {
if (_initialized) {
AP_HAL::panic(
"PANIC: scheduler system initialized called more than once");
}
int exceptions = FE_OVERFLOW | FE_DIVBYZERO;
#ifndef __i386__
// i386 with gcc doesn't work with FE_INVALID
exceptions |= FE_INVALID;
#endif
#if !defined(HAL_BUILD_AP_PERIPH)
if (_sitlState->_sitl == nullptr || _sitlState->_sitl->float_exception) {
feenableexcept(exceptions);
} else {
feclearexcept(exceptions);
}
#else
feclearexcept(exceptions);
#endif
_initialized = true;
}
void Scheduler::sitl_end_atomic() {
if (_nested_atomic_ctr == 0) {
hal.serial(0)->printf("NESTED ATOMIC ERROR\n");
} else {
_nested_atomic_ctr--;
}
}
void Scheduler::reboot(bool hold_in_bootloader)
{
HAL_SITL::actually_reboot();
abort();
}
void Scheduler::_run_timer_procs()
{
if (_in_timer_proc) {
// the timer calls took longer than the period of the
// timer. This is bad, and may indicate a serious
// driver failure. We can't just call the drivers
// again, as we could run out of stack. So we only
// call the _failsafe call. It's job is to detect if
// the drivers or the main loop are indeed dead and to
// activate whatever failsafe it thinks may help if
// need be. We assume the failsafe code can't
// block. If it does then we will recurse and die when
// we run out of stack
if (_failsafe != nullptr) {
_failsafe();
}
return;
}
_in_timer_proc = true;
// now call the timer based drivers
for (int i = 0; i < _num_timer_procs; i++) {
if (_timer_proc[i]) {
_timer_proc[i]();
}
}
// and the failsafe, if one is setup
if (_failsafe != nullptr) {
_failsafe();
}
_in_timer_proc = false;
}
void Scheduler::_run_io_procs()
{
if (_in_io_proc) {
return;
}
_in_io_proc = true;
// now call the IO based drivers
for (int i = 0; i < _num_io_procs; i++) {
if (_io_proc[i]) {
_io_proc[i]();
}
}
_in_io_proc = false;
for (uint8_t i=0; i<hal.num_serial; i++) {
hal.serial(i)->_timer_tick();
}
hal.storage->_timer_tick();
2018-08-19 23:39:05 -03:00
2020-08-03 00:24:26 -03:00
// in lieu of a thread-per-bus:
((HALSITL::I2CDeviceManager*)(hal.i2c_mgr))->_timer_tick();
#if SITL_STACK_CHECKING_ENABLED
2018-08-19 23:39:05 -03:00
check_thread_stacks();
#endif
#if AP_RCPROTOCOL_ENABLED
AP::RC().update();
#endif
}
/*
set simulation timestamp
*/
void Scheduler::stop_clock(uint64_t time_usec)
{
_stopped_clock_usec = time_usec;
if (_sitlState->_sitl != nullptr && time_usec - _last_io_run > 10000) {
_last_io_run = time_usec;
_run_io_procs();
}
}
/*
trampoline for thread create
*/
void *Scheduler::thread_create_trampoline(void *ctx)
{
2018-08-19 23:39:05 -03:00
struct thread_attr *a = (struct thread_attr *)ctx;
a->thread = pthread_self();
2018-08-19 23:39:05 -03:00
a->f[0]();
WITH_SEMAPHORE(_thread_sem);
if (threads == a) {
threads = a->next;
} else {
for (struct thread_attr *p=threads; p->next; p=p->next) {
if (p->next == a) {
p->next = p->next->next;
break;
}
}
}
free(a->stack);
free(a->f);
delete a;
return nullptr;
}
2018-08-19 23:39:05 -03:00
#ifndef PTHREAD_STACK_MIN
#define PTHREAD_STACK_MIN 16384U
#endif
/*
create a new thread
*/
bool Scheduler::thread_create(AP_HAL::MemberProc proc, const char *name, uint32_t stack_size, priority_base base, int8_t priority)
{
2018-08-19 23:39:05 -03:00
WITH_SEMAPHORE(_thread_sem);
// even an empty thread takes 2500 bytes on Linux, so always add 2300, giving us 200 bytes
// safety margin
stack_size += 2300;
pthread_t thread {};
const uint32_t alloc_stack = MAX(size_t(PTHREAD_STACK_MIN),stack_size);
struct thread_attr *a = NEW_NOTHROW struct thread_attr;
2018-08-19 23:39:05 -03:00
if (!a) {
return false;
}
2018-08-19 23:39:05 -03:00
// take a copy of the MemberProc, it is freed after thread exits
a->f = (AP_HAL::MemberProc *)malloc(sizeof(proc));
if (!a->f) {
goto failed;
}
if (posix_memalign(&a->stack, 4096, alloc_stack) != 0) {
goto failed;
}
2018-08-19 23:39:05 -03:00
if (!a->stack) {
goto failed;
}
memset(a->stack, stackfill, alloc_stack);
a->stack_min = (const uint8_t *)((((uint8_t *)a->stack) + alloc_stack) - stack_size);
a->stack_size = stack_size;
a->f[0] = proc;
a->name = name;
if (pthread_attr_init(&a->attr) != 0) {
goto failed;
}
#if SITL_STACK_CHECKING_ENABLED
2018-08-19 23:39:05 -03:00
if (pthread_attr_setstack(&a->attr, a->stack, alloc_stack) != 0) {
AP_HAL::panic("Failed to set stack of size %u for thread %s", alloc_stack, name);
}
#endif
2018-08-19 23:39:05 -03:00
if (pthread_create(&thread, &a->attr, thread_create_trampoline, a) != 0) {
goto failed;
}
#if !defined(__APPLE__)
pthread_setname_np(thread, name);
#endif
2018-08-19 23:39:05 -03:00
a->next = threads;
threads = a;
return true;
2018-08-19 23:39:05 -03:00
failed:
if (a->stack) {
free(a->stack);
}
if (a->f) {
free(a->f);
}
delete a;
return false;
}
2018-08-19 23:39:05 -03:00
/*
check for stack overflow
*/
void Scheduler::check_thread_stacks(void)
{
WITH_SEMAPHORE(_thread_sem);
for (struct thread_attr *p=threads; p; p=p->next) {
const uint8_t ncheck = 8;
for (uint8_t i=0; i<ncheck; i++) {
if (p->stack_min[i] != stackfill) {
AP_HAL::panic("stack overflow in thread %s\n", p->name);
}
}
}
}
// get the name of the current thread, or nullptr if not known
const char *Scheduler::get_current_thread_name(void) const
{
const pthread_t self = pthread_self();
for (struct thread_attr *a=threads; a; a=a->next) {
if (a->thread == self) {
return a->name;
}
}
return nullptr;
}