wasm-micro-runtime/core/shared-lib/utils/runtime_timer.c

/*
 * Copyright (C) 2019 Intel Corporation.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "runtime_timer.h"
#include "bh_thread.h"
#include "bh_time.h"

#define PRINT(...)
//#define PRINT printf

typedef struct _app_timer {
    struct _app_timer * next;
    uint32 id;
    unsigned int interval;
    uint64 expiry;
    bool is_periodic;
} app_timer_t;

struct _timer_ctx {
    app_timer_t * g_app_timers;
    app_timer_t * idle_timers;
    app_timer_t * free_timers;
    unsigned int g_max_id;
    int pre_allocated;
    unsigned int owner;

    //add mutext and conditions
    korp_cond cond;
    korp_mutex mutex;

    timer_callback_f timer_callback;
    check_timer_expiry_f refresh_checker;
};

uint32 bh_get_elpased_ms(uint32 * last_system_clock)
{
    uint32 elpased_ms;

    // attention: the bh_get_tick_ms() return 64 bits integer.
    // but the bh_get_elpased_ms() is designed to use 32 bits clock count.
    uint32 now = (uint32) bh_get_tick_ms();

    // system clock overrun
    if (now < *last_system_clock) {
        elpased_ms = now + (0xFFFFFFFF - *last_system_clock) + 1;
    } else {
        elpased_ms = now - *last_system_clock;
    }

    *last_system_clock = now;

    return elpased_ms;
}

static app_timer_t * remove_timer_from(timer_ctx_t ctx, uint32 timer_id,
        bool active_list)
{
    vm_mutex_lock(&ctx->mutex);
    app_timer_t ** head;
    if (active_list)
        head = &ctx->g_app_timers;
    else
        head = &ctx->idle_timers;

    app_timer_t * t = *head;
    app_timer_t * prev = NULL;

    while (t) {
        if (t->id == timer_id) {
            if (prev == NULL) {
                *head = t->next;
                PRINT("removed timer [%d] at head from list %d\n", t->id, active_list);
            } else {
                prev->next = t->next;
                PRINT("removed timer [%d] after [%d] from list %d\n", t->id, prev->id, active_list);
            }
            vm_mutex_unlock(&ctx->mutex);

            if (active_list && prev == NULL && ctx->refresh_checker)
                ctx->refresh_checker(ctx);

            return t;
        } else {
            prev = t;
            t = t->next;
        }
    }

    vm_mutex_unlock(&ctx->mutex);

    return NULL;
}

static app_timer_t * remove_timer(timer_ctx_t ctx, uint32 timer_id,
        bool * active)
{
    app_timer_t* t = remove_timer_from(ctx, timer_id, true);
    if (t) {
        if (active)
            *active = true;
        return t;
    }

    if (active)
        *active = false;
    return remove_timer_from(ctx, timer_id, false);
}

static void reschedule_timer(timer_ctx_t ctx, app_timer_t * timer)
{

    vm_mutex_lock(&ctx->mutex);
    app_timer_t * t = ctx->g_app_timers;
    app_timer_t * prev = NULL;

    timer->next = NULL;
    timer->expiry = bh_get_tick_ms() + timer->interval;

    while (t) {
        if (timer->expiry < t->expiry) {
            if (prev == NULL) {
                timer->next = ctx->g_app_timers;
                ctx->g_app_timers = timer;
                PRINT("rescheduled timer [%d] at head\n", timer->id);
            } else {
                timer->next = t;
                prev->next = timer;
                PRINT("rescheduled timer [%d] after [%d]\n", timer->id, prev->id);
            }

            vm_mutex_unlock(&ctx->mutex);

            // ensure the refresh_checker() is called out of the lock
            if (prev == NULL && ctx->refresh_checker)
                ctx->refresh_checker(ctx);

            return;
        } else {
            prev = t;
            t = t->next;
        }
    }

    if (prev) {
        // insert to the list end
        prev->next = timer;
        PRINT("rescheduled timer [%d] at end, after [%d]\n", timer->id, prev->id);
    } else {
        // insert at the begin
        bh_assert(ctx->g_app_timers == NULL);
        ctx->g_app_timers = timer;
        PRINT("rescheduled timer [%d] as first\n", timer->id);
    }

    vm_mutex_unlock(&ctx->mutex);

    // ensure the refresh_checker() is called out of the lock
    if (prev == NULL && ctx->refresh_checker)
        ctx->refresh_checker(ctx);

}

static void release_timer(timer_ctx_t ctx, app_timer_t * t)
{
    if (ctx->pre_allocated) {
        vm_mutex_lock(&ctx->mutex);
        t->next = ctx->free_timers;
        ctx->free_timers = t;
        PRINT("recycle timer :%d\n", t->id);
        vm_mutex_unlock(&ctx->mutex);
    } else {
        PRINT("destroy timer :%d\n", t->id);
        bh_free(t);
    }
}

void release_timer_list(app_timer_t ** p_list)
{
    app_timer_t *t = *p_list;
    while (t) {
        app_timer_t *next = t->next;
        PRINT("destroy timer list:%d\n", t->id);
        bh_free(t);
        t = next;
    }

    *p_list = NULL;
}

/*
 *
 *    API exposed
 *
 */

timer_ctx_t create_timer_ctx(timer_callback_f timer_handler,
        check_timer_expiry_f expiery_checker, int prealloc_num,
        unsigned int owner)
{
    timer_ctx_t ctx = (timer_ctx_t) bh_malloc(sizeof(struct _timer_ctx));
    if (ctx == NULL)
        return NULL;
    memset(ctx, 0, sizeof(struct _timer_ctx));

    ctx->timer_callback = timer_handler;
    ctx->pre_allocated = prealloc_num;
    ctx->refresh_checker = expiery_checker;
    ctx->owner = owner;

    while (prealloc_num > 0) {
        app_timer_t *timer = (app_timer_t*) bh_malloc(sizeof(app_timer_t));
        if (timer == NULL)
            goto cleanup;

        memset(timer, 0, sizeof(*timer));
        timer->next = ctx->free_timers;
        ctx->free_timers = timer;
        prealloc_num--;
    }

    vm_cond_init(&ctx->cond);
    vm_mutex_init(&ctx->mutex);

    PRINT("timer ctx created. pre-alloc: %d\n", ctx->pre_allocated);

    return ctx;

    cleanup:

    if (ctx) {
        release_timer_list(&ctx->free_timers);
        bh_free(ctx);
    }
    printf("timer ctx create failed\n");
    return NULL;
}

void destroy_timer_ctx(timer_ctx_t ctx)
{
    while (ctx->free_timers) {
        void * tmp = ctx->free_timers;
        ctx->free_timers = ctx->free_timers->next;
        bh_free(tmp);
    }

    cleanup_app_timers(ctx);

    vm_cond_destroy(&ctx->cond);
    vm_mutex_destroy(&ctx->mutex);
    bh_free(ctx);
}

void timer_ctx_set_lock(timer_ctx_t ctx, bool lock)
{
    if (lock)
        vm_mutex_lock(&ctx->mutex);
    else
        vm_mutex_unlock(&ctx->mutex);
}

void * timer_ctx_get_lock(timer_ctx_t ctx)
{
    return &ctx->mutex;
}

unsigned int timer_ctx_get_owner(timer_ctx_t ctx)
{
    return ctx->owner;
}

void add_idle_timer(timer_ctx_t ctx, app_timer_t * timer)
{
    vm_mutex_lock(&ctx->mutex);
    timer->next = ctx->idle_timers;
    ctx->idle_timers = timer;
    vm_mutex_unlock(&ctx->mutex);
}

uint32 sys_create_timer(timer_ctx_t ctx, int interval, bool is_period,
        bool auto_start)
{

    app_timer_t *timer;

    if (ctx->pre_allocated) {
        if (ctx->free_timers == NULL)
            return -1;
        else {
            timer = ctx->free_timers;
            ctx->free_timers = timer->next;
        }
    } else {
        timer = (app_timer_t*) bh_malloc(sizeof(app_timer_t));
        if (timer == NULL)
            return -1;
    }

    memset(timer, 0, sizeof(*timer));

    ctx->g_max_id++;
    if (ctx->g_max_id == -1)
        ctx->g_max_id++;
    timer->id = ctx->g_max_id;
    timer->interval = interval;
    timer->is_periodic = is_period;

    if (auto_start)
        reschedule_timer(ctx, timer);
    else
        add_idle_timer(ctx, timer);

    return timer->id;
}

bool sys_timer_cancel(timer_ctx_t ctx, uint32 timer_id)
{
    bool from_active;
    app_timer_t * t = remove_timer(ctx, timer_id, &from_active);
    if (t == NULL)
        return false;

    add_idle_timer(ctx, t);

    PRINT("sys_timer_stop called\n");
    return from_active;
}

bool sys_timer_destory(timer_ctx_t ctx, uint32 timer_id)
{
    bool from_active;
    app_timer_t * t = remove_timer(ctx, timer_id, &from_active);
    if (t == NULL)
        return false;

    release_timer(ctx, t);

    PRINT("sys_timer_destory called\n");
    return true;
}

bool sys_timer_restart(timer_ctx_t ctx, uint32 timer_id, int interval)
{
    app_timer_t * t = remove_timer(ctx, timer_id, NULL);
    if (t == NULL)
        return false;

    if (interval > 0)
        t->interval = interval;

    reschedule_timer(ctx, t);

    PRINT("sys_timer_restart called\n");
    return true;
}

/*
 *
 *
 * API called by the timer manager from another thread or the kernel timer handler
 *
 *
 */

// lookup the app queue by the module name
//post a timeout message to the app queue
//
static void handle_expired_timers(timer_ctx_t ctx, app_timer_t * expired)
{
    while (expired) {
        app_timer_t * t = expired;
        ctx->timer_callback(t->id, ctx->owner);

        expired = expired->next;
        if (t->is_periodic) {
            // if it is repeating, then reschedule it;
            reschedule_timer(ctx, t);

        } else {
            // else move it to idle list
            add_idle_timer(ctx, t);
        }
    }
}

int get_expiry_ms(timer_ctx_t ctx)
{
    int ms_to_next_expiry;
    uint64 now = bh_get_tick_ms();

    vm_mutex_lock(&ctx->mutex);
    if (ctx->g_app_timers == NULL)
        ms_to_next_expiry = 7 * 24 * 60 * 60 * 1000; // 1 week
    else if (ctx->g_app_timers->expiry >= now)
        ms_to_next_expiry = ctx->g_app_timers->expiry - now;
    else
        ms_to_next_expiry = 0;
    vm_mutex_unlock(&ctx->mutex);

    return ms_to_next_expiry;
}

int check_app_timers(timer_ctx_t ctx)
{
    vm_mutex_lock(&ctx->mutex);

    app_timer_t * t = ctx->g_app_timers;
    app_timer_t * prev = NULL;
    app_timer_t * expired = NULL;

    uint64 now = bh_get_tick_ms();

    while (t) {
        if (now >= t->expiry) {
            ctx->g_app_timers = t->next;

            t->next = expired;
            expired = t;

            t = ctx->g_app_timers;
        } else {
            break;
        }
    }
    vm_mutex_unlock(&ctx->mutex);

    handle_expired_timers(ctx, expired);

    return get_expiry_ms(ctx);
}

void cleanup_app_timers(timer_ctx_t ctx)
{
    app_timer_t *t;

    vm_mutex_lock(&ctx->mutex);

    release_timer_list(&ctx->g_app_timers);
    release_timer_list(&ctx->idle_timers);

    vm_mutex_unlock(&ctx->mutex);
}

/*
 *
 *   One reference implementation for timer manager
 *
 *
 */

void * thread_timer_check(void * arg)
{
    timer_ctx_t ctx = (timer_ctx_t) arg;
    while (1) {
        int ms_to_expiry = check_app_timers(ctx);
        vm_mutex_lock(&ctx->mutex);
        vm_cond_reltimedwait(&ctx->cond, &ctx->mutex, ms_to_expiry);
        vm_mutex_unlock(&ctx->mutex);
    }
}

void wakeup_timer_thread(timer_ctx_t ctx)
{
    vm_cond_signal(&ctx->cond);
}