xref: /btstack/platform/qt/btstack_run_loop_qt.cpp (revision 7b06a5623f94b51d587e1e370d802fcf89fe17a5)

/*
 * Copyright (C) 2019 BlueKitchen GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 * 4. Any redistribution, use, or modification is done solely for
 *    personal benefit and not for any commercial purpose or for
 *    monetary gain.
 *
 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Please inquire about commercial licensing options at
 * [email protected]
 *
 */

#define BTSTACK_FILE__ "btstack_run_loop_qt.c"

/*
 *  btstack_run_loop_qt.c
 */

// enable POSIX functions (needed for -std=c99)
#define _POSIX_C_SOURCE 200809

#include "btstack_run_loop_qt.h"

#include "btstack_run_loop.h"
#include "btstack_util.h"
#include "btstack_linked_list.h"
#include "btstack_debug.h"

#include <stdio.h>
#include <stdlib.h>
#include <sys/time.h>
#include <time.h>
#include <unistd.h>

#include <QHash>
#include <QMutex>

// start time. tv_usec/tv_nsec = 0
#ifdef _POSIX_MONOTONIC_CLOCK
// use monotonic clock if available
static struct timespec init_ts;
#else
// fallback to gettimeofday
static struct timeval init_tv;
#endif

static BTstackRunLoopQt * btstack_run_loop_object;


#ifdef Q_OS_WIN
// associate each data source with QWinEventNotifier
static QHash<btstack_data_source_t *, QWinEventNotifier *> win_event_notifiers;
#else
static QHash<btstack_data_source_t *, QSocketNotifier *> read_notifiers;
static QHash<btstack_data_source_t *, QSocketNotifier *> write_notifiers;
#endif

static QMutex run_loop_callback_mutex;

static void btstack_run_loop_qt_dump_timer(void);

static void btstack_run_loop_qt_update_data_source(btstack_data_source_t * ds){
#ifdef Q_OS_WIN
    QWinEventNotifier * win_notifier = win_event_notifiers.value(ds, NULL);
    if (win_notifier){
        bool enabled = (ds->flags & (DATA_SOURCE_CALLBACK_READ | DATA_SOURCE_CALLBACK_WRITE)) != 0;
        win_notifier->setEnabled(enabled);
    }
#else
    QSocketNotifier * read_notifier = read_notifiers.value(ds, NULL);
    if (read_notifier){
        bool read_enabled = (ds->flags & DATA_SOURCE_CALLBACK_READ)   != 0;
        read_notifier->setEnabled(read_enabled);
    }
    QSocketNotifier * write_notifier = write_notifiers.value(ds, NULL);
    if (write_notifier){
        bool write_enabled = (ds->flags & DATA_SOURCE_CALLBACK_WRITE) != 0;
        write_notifier->setEnabled(write_enabled);
    }
#endif
}

void btstack_run_loop_qt_add_data_source(btstack_data_source_t *ds){
#ifdef Q_OS_WIN
    QWinEventNotifier * win_notifier = new QWinEventNotifier(ds->source.handle);
    win_event_notifiers.insert(ds, win_notifier);
    btstack_run_loop_qt_update_data_source(ds);
    QObject::connect(win_notifier, SIGNAL(activated(HANDLE)), btstack_run_loop_object, SLOT(processDataSource(HANDLE)));
    log_debug("add data source %p with handle %p", ds, ds->source.handle);
#else
    // POSIX Systems: macOS, Linux, ..
    QSocketNotifier * read_notifier = new QSocketNotifier(ds->source.fd, QSocketNotifier::Read);
    QSocketNotifier * write_notifier = new QSocketNotifier(ds->source.fd, QSocketNotifier::Write);
    read_notifiers.insert(ds, read_notifier);
    write_notifiers.insert(ds, write_notifier);
    btstack_run_loop_qt_update_data_source(ds);
    QObject::connect(read_notifier, SIGNAL(activated(int)),  btstack_run_loop_object, SLOT(processDataSourceRead(int)));
    QObject::connect(write_notifier, SIGNAL(activated(int)), btstack_run_loop_object, SLOT(processDataSourceWrite(int)));
#endif
    btstack_run_loop_base_add_data_source(ds);
}

bool btstack_run_loop_qt_remove_data_source(btstack_data_source_t *ds){
#ifdef Q_OS_WIN
    QWinEventNotifier * win_notifier = win_event_notifiers.value(ds, NULL);
    if (win_notifier){
        win_event_notifiers.remove(ds);
        free(win_notifier);
    }
#else
    QSocketNotifier * read_notifier = read_notifiers.value(ds, NULL);
    if (read_notifier){
        read_notifiers.remove(ds);
        free(read_notifier);
    }
    QSocketNotifier * write_notifier = write_notifiers.value(ds, NULL);
    if (write_notifier){
        write_notifiers.remove(ds);
        free(write_notifier);
    }
#endif
    return btstack_run_loop_base_remove_data_source(ds);
}

void btstack_run_loop_qt_enable_data_source_callbacks(btstack_data_source_t * ds, uint16_t callback_types){
    btstack_run_loop_base_enable_data_source_callbacks(ds, callback_types);
    btstack_run_loop_qt_update_data_source(ds);
}

void btstack_run_loop_qt_disable_data_source_callbacks(btstack_data_source_t * ds, uint16_t callback_types){
    btstack_run_loop_base_disable_data_source_callbacks(ds, callback_types);
    btstack_run_loop_qt_update_data_source(ds);
}

#ifdef _POSIX_MONOTONIC_CLOCK
/**
 * @brief Returns the timespec which represents the time(stop - start). It might be negative
 */
static void timespec_diff(struct timespec *start, struct timespec *stop, struct timespec *result){
    result->tv_sec = stop->tv_sec - start->tv_sec;
    if ((stop->tv_nsec - start->tv_nsec) < 0) {
        result->tv_sec = stop->tv_sec - start->tv_sec - 1;
        result->tv_nsec = stop->tv_nsec - start->tv_nsec + 1000000000;
    } else {
        result->tv_sec = stop->tv_sec - start->tv_sec;
        result->tv_nsec = stop->tv_nsec - start->tv_nsec;
    }
}

/**
 * @brief Convert timespec to miliseconds, might overflow
 */
static uint64_t timespec_to_milliseconds(struct timespec *a){
    uint64_t ret = 0;
    uint64_t sec_val = (uint64_t)(a->tv_sec);
    uint64_t nsec_val = (uint64_t)(a->tv_nsec);
    ret = (sec_val*1000) + (nsec_val/1000000);
    return ret;
}

/**
 * @brief Returns the milisecond value of (stop - start). Might overflow
 */
static uint64_t timespec_diff_milis(struct timespec* start, struct timespec* stop){
    struct timespec diff_ts;
    timespec_diff(start, stop, &diff_ts);
    return timespec_to_milliseconds(&diff_ts);
}
#endif

/**
 * @brief Queries the current time in ms since start
 */
static uint32_t btstack_run_loop_qt_get_time_ms(void){
    uint32_t time_ms;
#ifdef _POSIX_MONOTONIC_CLOCK
    struct timespec now_ts;
    clock_gettime(CLOCK_MONOTONIC, &now_ts);
    time_ms = (uint32_t) timespec_diff_milis(&init_ts, &now_ts);
#else
    struct timeval tv;
    gettimeofday(&tv, NULL);
    time_ms = (uint32_t) ((tv.tv_sec  - init_tv.tv_sec) * 1000) + (tv.tv_usec / 1000);
#endif
    return time_ms;
}

/**
 * Execute run_loop
 */
static void btstack_run_loop_qt_execute(void) {
}

// set timer
static void btstack_run_loop_qt_set_timer(btstack_timer_source_t *a, uint32_t timeout_in_ms){
    uint32_t time_ms = btstack_run_loop_qt_get_time_ms();
    a->timeout = time_ms + timeout_in_ms;
    log_debug("btstack_run_loop_qt_set_timer to %u ms (now %u, timeout %u)", a->timeout, time_ms, timeout_in_ms);
}

/**
 * Add timer to run_loop (keep list sorted)
 */
static void btstack_run_loop_qt_add_timer(btstack_timer_source_t *ts){
    uint32_t now = btstack_run_loop_qt_get_time_ms();
    int32_t next_timeout_before = btstack_run_loop_base_get_time_until_timeout(now);
    btstack_run_loop_base_add_timer(ts);
    int32_t next_timeout_after = btstack_run_loop_base_get_time_until_timeout(now);
    if (next_timeout_after >= 0 && (next_timeout_after != next_timeout_before)){
        QTimer::singleShot((uint32_t)next_timeout_after, btstack_run_loop_object, SLOT(processTimers()));
    }
}

// BTstackRunLoopQt class implementation
BTstackRunLoopQt::BTstackRunLoopQt(void) : QObject() {
    // enforce slot callback on receiver (main thread) via Qt::QueuedConnection
    connect(this, &BTstackRunLoopQt::callbackAdded, this, &BTstackRunLoopQt::processCallbacks, Qt::QueuedConnection);
    connect(this, &BTstackRunLoopQt::dataSourcesPollRequested, this, &BTstackRunLoopQt::pollDataSources, Qt::QueuedConnection);
}

void BTstackRunLoopQt::processTimers(){
    uint32_t now = btstack_run_loop_qt_get_time_ms();
    int32_t next_timeout_before = btstack_run_loop_base_get_time_until_timeout(now);
    btstack_run_loop_base_process_timers(btstack_run_loop_qt_get_time_ms());
    int32_t next_timeout_after = btstack_run_loop_base_get_time_until_timeout(now);
    if (next_timeout_after >= 0 && (next_timeout_after != next_timeout_before)){
        QTimer::singleShot((uint32_t)next_timeout_after, this, SLOT(processTimers()));
    }
}
#ifdef Q_OS_WIN
void BTstackRunLoopQt::processDataSource(HANDLE handle){
    log_debug("lookup data source for handle %p, sender %p", handle, QObject::sender());
    // find ds
    btstack_linked_list_iterator_t it;
    btstack_linked_list_iterator_init(&it, &btstack_run_loop_base_data_sources);
    while (btstack_linked_list_iterator_has_next(&it)){
        btstack_data_source_t *ds = (btstack_data_source_t*) btstack_linked_list_iterator_next(&it);
        if (handle == ds->source.handle){
            if (ds->flags & DATA_SOURCE_CALLBACK_READ){
                log_debug("process read ds %p with handle %p", ds, ds->source.handle);
                ds->process(ds, DATA_SOURCE_CALLBACK_READ);
            } else if (ds->flags & DATA_SOURCE_CALLBACK_WRITE){
                log_debug("process write ds %p with handle %p", ds, ds->source.handle);
                ds->process(ds, DATA_SOURCE_CALLBACK_WRITE);
            }
            break;
        }
    }
}
#else

void BTstackRunLoopQt::processCallbacks(void) {
    // execute callbacks - protect list with mutex
    while (1){
        run_loop_callback_mutex.lock();
        btstack_context_callback_registration_t * callback_registration = (btstack_context_callback_registration_t *) btstack_linked_list_pop(&btstack_run_loop_base_callbacks);
        run_loop_callback_mutex.unlock();
        if (callback_registration == NULL){
            break;
        }
        (*callback_registration->callback)(callback_registration->context);
    }
}

void BTstackRunLoopQt::pollDataSources(void) {
    btstack_run_loop_base_poll_data_sources();
}

static void btstack_run_loop_qt_execute_on_main_thread(btstack_context_callback_registration_t * callback_registration){
    // protect list with mutex
    run_loop_callback_mutex.lock();
    btstack_run_loop_base_add_callback(callback_registration);
    run_loop_callback_mutex.unlock();
    btstack_run_loop_object->emit callbackAdded();
}

static void btstack_run_loop_qt_poll_data_sources_from_irq(void){
    btstack_run_loop_object->emit dataSourcesPollRequested();
}

static void btstack_run_loop_qt_process_data_source(int fd, uint16_t callback_types){
    // find ds
    btstack_linked_list_iterator_t it;
    btstack_linked_list_iterator_init(&it, &btstack_run_loop_base_data_sources);
    while (btstack_linked_list_iterator_has_next(&it)){
        btstack_data_source_t *ds = (btstack_data_source_t*) btstack_linked_list_iterator_next(&it);
        if (fd == ds->source.fd){
            if ((callback_types & DATA_SOURCE_CALLBACK_READ) != 0){
                if ((ds->flags & DATA_SOURCE_CALLBACK_READ)  != 0){
                    ds->process(ds, DATA_SOURCE_CALLBACK_READ);
                }
            }
            if ((callback_types & DATA_SOURCE_CALLBACK_WRITE) != 0){
                if ((ds->flags & DATA_SOURCE_CALLBACK_WRITE)  != 0){
                    ds->process(ds, DATA_SOURCE_CALLBACK_WRITE);
                }
            }
            break;
        }
    }
}

void BTstackRunLoopQt::processDataSourceRead(int fd){
    log_debug("read - lookup data source for handle %p, sender %p", fd, QObject::sender());
    btstack_run_loop_qt_process_data_source(fd, DATA_SOURCE_CALLBACK_READ);
}
void BTstackRunLoopQt::processDataSourceWrite(int fd){
    log_debug("write - lookup data source for handle %p, sender %p", fd, QObject::sender());
    btstack_run_loop_qt_process_data_source(fd, DATA_SOURCE_CALLBACK_WRITE);
}
#endif

static void btstack_run_loop_qt_init(void){

    btstack_run_loop_base_init();

    btstack_run_loop_object = new BTstackRunLoopQt();

#ifdef _POSIX_MONOTONIC_CLOCK
    clock_gettime(CLOCK_MONOTONIC, &init_ts);
    init_ts.tv_nsec = 0;
#else
    // just assume that we started at tv_usec == 0
    gettimeofday(&init_tv, NULL);
    init_tv.tv_usec = 0;
#endif
}

static void btstack_run_loop_qt_dump_timer(void){
    btstack_linked_item_t *it;
    int i = 0;
    for (it = (btstack_linked_item_t *) btstack_run_loop_base_timers; it ; it = it->next){
        btstack_timer_source_t *ts = (btstack_timer_source_t*) it;
        log_info("timer %u (%p): timeout %u\n", i, ts, ts->timeout);
    }
}

static const btstack_run_loop_t btstack_run_loop_qt = {
    &btstack_run_loop_qt_init,
    &btstack_run_loop_qt_add_data_source,
    &btstack_run_loop_qt_remove_data_source,
    &btstack_run_loop_qt_enable_data_source_callbacks,
    &btstack_run_loop_qt_disable_data_source_callbacks,
    &btstack_run_loop_qt_set_timer,
    &btstack_run_loop_qt_add_timer,
    &btstack_run_loop_base_remove_timer,
    &btstack_run_loop_qt_execute,
    &btstack_run_loop_qt_dump_timer,
    &btstack_run_loop_qt_get_time_ms,
    &btstack_run_loop_qt_poll_data_sources_from_irq,
    &btstack_run_loop_qt_execute_on_main_thread,
    NULL
};

/**
 * Provide btstack_run_loop_posix instance
 */
const btstack_run_loop_t * btstack_run_loop_qt_get_instance(void){
    return &btstack_run_loop_qt;
}