task_scheduler.h File Reference

#include <zrtos/zrtos.h>
#include <zrtos/types.h>
#include <zrtos/clist.h>
#include <zrtos/error.h>
#include <zrtos/task.h>

Include dependency graph for task_scheduler.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_zrtos_task_scheduler_t

Macros
#define	ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB(code)
#define	ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB_EX(is_locked, code)
#define	ZRTOS_TASK_SCHEDULER__EACH_TASK(node)

Typedefs
typedef struct _zrtos_task_scheduler_t	zrtos_task_scheduler_t

Functions
zrtos_task_t *	_zrtos_task_scheduler__get_active_task (void)
bool	zrtos_task_scheduler__add_task (zrtos_task_t *task)
bool	zrtos_task_scheduler__remove_task (zrtos_task_t *task)
bool	zrtos_task_scheduler__has_task (zrtos_task_t *task)
static zrtos_task_t *	_zrtos_task_scheduler__get_sleep_task (void)
static void	zrtos_task_scheduler__page_task_out (void)
static void	zrtos_task_scheduler__page_task_in (zrtos_task_t *task)
static bool	_zrtos_task_scheduler__set_active_task (zrtos_task_t *task)
static bool	_zrtos_task_scheduler__switch_task (void)
void	_zrtos_task_scheduler__on_tick (void)
static void	_zrtos_task_scheduler__on_tick_ex (void)
void	zrtos_task_scheduler__delay_ms (zrtos_task_tick_t ms)
void	zrtos_task_scheduler__start (void)
void	zrtos_task_scheduler__stop (void)
void	zrtos_task_scheduler__init ()
static zrtos_task_t *	zrtos_task_scheduler__get_any_child (zrtos_task_t *task)

Variables
zrtos_task_scheduler_t	zrtos_task_scheduler = {}

Macro Definition Documentation

ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB

#define ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB

(

code

)

Value:

do{                                        \
        ZRTOS_ARCH__DISABLE_INTERRUPTS();      \
        zrtos_task_scheduler.do_not_disturb++; \
        ZRTOS_ARCH__ENABLE_INTERRUPTS();       \
        do{                                    \
            code;                              \
        }while(0);                             \
        ZRTOS_ARCH__DISABLE_INTERRUPTS();      \
        zrtos_task_scheduler.do_not_disturb--; \
        ZRTOS_ARCH__ENABLE_INTERRUPTS();       \
    }while(0);

Definition at line 32 of file task_scheduler.h.

ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB_EX

#define ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB_EX	(		is_locked,
			code
	)

Value:

do{                                                         \
        ZRTOS_ARCH__DISABLE_INTERRUPTS();                       \
        is_locked = (zrtos_task_scheduler.do_not_disturb == 0); \
        zrtos_task_scheduler.do_not_disturb++;                  \
        ZRTOS_ARCH__ENABLE_INTERRUPTS();                        \
        do{                                                     \
            code;                                               \
        }while(0);                                              \
        ZRTOS_ARCH__DISABLE_INTERRUPTS();                       \
        zrtos_task_scheduler.do_not_disturb--;                  \
        ZRTOS_ARCH__ENABLE_INTERRUPTS();                        \
    }while(0);

Definition at line 46 of file task_scheduler.h.

ZRTOS_TASK_SCHEDULER__EACH_TASK

#define ZRTOS_TASK_SCHEDULER__EACH_TASK

(

node

)

Value:

for(zrtos_task_t *node = _zrtos_task_scheduler__get_active_task() \
        ,*sentinel = node                                             \
        ,*next                                                        \
        ;({                                                           \
            next = zrtos_task__get_next_task(node);                   \
            node != sentinel;                                         \
        })                                                            \
        ;node = next                                                  \
    )

Definition at line 209 of file task_scheduler.h.

Typedef Documentation

zrtos_task_scheduler_t

typedef struct _zrtos_task_scheduler_t zrtos_task_scheduler_t

Function Documentation

_zrtos_task_scheduler__get_active_task()

zrtos_task_t* _zrtos_task_scheduler__get_active_task

(

void

)

Definition at line 61 of file task_scheduler.h.

                                                          {
    zrtos_clist_node_t *node = zrtos_clist__get_root(
        &zrtos_task_scheduler.root
    );
    return zrtos_types__get_container_of(node,zrtos_task_t,node);
}

Here is the call graph for this function:

Here is the caller graph for this function:

_zrtos_task_scheduler__get_sleep_task()

static zrtos_task_t* _zrtos_task_scheduler__get_sleep_task ( void  )

static

Definition at line 105 of file task_scheduler.h.

                                                                {
    return &zrtos_task_scheduler.sleep_task;
}

Here is the caller graph for this function:

_zrtos_task_scheduler__on_tick()

void _zrtos_task_scheduler__on_tick

(

void

)

Definition at line 158 of file task_scheduler.h.

                                                                {
    ZRTOS_ARCH__SAVE_CPU_STATE_EX(zrtos_task_scheduler.tmp_stack_ptr);
    if(zrtos_task_scheduler.do_not_disturb == 0){
        _zrtos_task_scheduler__switch_task();
    }
    ZRTOS_ARCH__LOAD_CPU_STATE_EX(zrtos_task_scheduler.tmp_stack_ptr);
    ZRTOS_ARCH__RETURN_FROM_INTERRUPT();
}

Here is the call graph for this function:

Here is the caller graph for this function:

_zrtos_task_scheduler__on_tick_ex()

static void _zrtos_task_scheduler__on_tick_ex ( void  )

static

Definition at line 168 of file task_scheduler.h.

                                                   {
    _zrtos_task_scheduler__on_tick();
}

Here is the call graph for this function:

Here is the caller graph for this function:

_zrtos_task_scheduler__set_active_task()

static bool _zrtos_task_scheduler__set_active_task ( zrtos_task_t *  task )

static

Definition at line 126 of file task_scheduler.h.

                                                                      {
    zrtos_task_scheduler__page_task_out();
    zrtos_task_scheduler__page_task_in(task);
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

_zrtos_task_scheduler__switch_task()

static bool _zrtos_task_scheduler__switch_task ( void  )

static

Definition at line 132 of file task_scheduler.h.

                                                    {
    zrtos_task_t *active_task = _zrtos_task_scheduler__get_active_task();
    zrtos_task_t *task = active_task;

    do{
        zrtos_task__on_tick(task);
        task = zrtos_task__get_next_task(task);
    }while(task != active_task);

    task = active_task;
    do{
        task = zrtos_task__get_next_task(task);
        if(zrtos_task__is_ready(task)){
            return _zrtos_task_scheduler__set_active_task(task);
        }
    }while(task != active_task);

    _zrtos_task_scheduler__set_active_task(
        _zrtos_task_scheduler__get_sleep_task()
    );

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__add_task()

bool zrtos_task_scheduler__add_task

(

zrtos_task_t *

task

)

Definition at line 68 of file task_scheduler.h.

                                                       {
    ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB({
        zrtos_task__set_parent(task,_zrtos_task_scheduler__get_active_task());
        zrtos_clist__push(&zrtos_task_scheduler.root,&task->node);
    });

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__delay_ms()

void zrtos_task_scheduler__delay_ms

(

zrtos_task_tick_t

ms

)

Definition at line 172 of file task_scheduler.h.

                                                         {
    zrtos_task__set_delay_ms(
         _zrtos_task_scheduler__get_active_task()
        ,ms
    );
    _zrtos_task_scheduler__on_tick_ex();
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__get_any_child()

static zrtos_task_t* zrtos_task_scheduler__get_any_child ( zrtos_task_t *  task )

static

Definition at line 220 of file task_scheduler.h.

                                                                            {
    ZRTOS_TASK_SCHEDULER__EACH_TASK(node){
        if(zrtos_task__get_parent(node) == task){
            return node;
        }
    }
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__has_task()

bool zrtos_task_scheduler__has_task

(

zrtos_task_t *

task

)

Definition at line 86 of file task_scheduler.h.

                                                       {
    bool ret = false;

    ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB({
        zrtos_task_t *node = _zrtos_task_scheduler__get_active_task();
        zrtos_task_t *sentinel = node;

        do{
            if(node == task){
                ret = true;
                break;
            }
            node = zrtos_task__get_next_task(node);
        }while(node != sentinel);
    });

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__init()

void zrtos_task_scheduler__init

(

)

Definition at line 193 of file task_scheduler.h.

                                 {
    zrtos_clist__init(&zrtos_task_scheduler.root);
    zrtos_task__init(
         &zrtos_task_scheduler.sleep_task
        ,(zrtos_arch_stack_t*)0
    );
    zrtos_clist__push(
         &zrtos_task_scheduler.root
        ,&zrtos_task_scheduler.sleep_task.node
    );
    //zrtos_task_scheduler__add_task(&zrtos_task_scheduler.sleep_task);
    //zrtos_task_scheduler.tmp_stack_ptr = 0;
    zrtos_task_scheduler.do_not_disturb = 0;
    _zrtos_task_scheduler__on_tick_ex();
}

Here is the call graph for this function:

zrtos_task_scheduler__page_task_in()

static void zrtos_task_scheduler__page_task_in ( zrtos_task_t *  task )

static

Definition at line 118 of file task_scheduler.h.

 {
    zrtos_clist__set_root(&zrtos_task_scheduler.root,&task->node);
    zrtos_task_scheduler.tmp_stack_ptr = zrtos_task__get_stack_ptr(task);
    errno = zrtos_task__get_errno(task);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__page_task_out()

static void zrtos_task_scheduler__page_task_out ( void  )

static

Definition at line 109 of file task_scheduler.h.

                                                     {
    zrtos_task_t *active_task = _zrtos_task_scheduler__get_active_task();
    zrtos_task__set_stack_ptr(
         active_task
        ,zrtos_task_scheduler.tmp_stack_ptr
    );
    zrtos_task__set_errno(active_task,errno);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__remove_task()

bool zrtos_task_scheduler__remove_task

(

zrtos_task_t *

task

)

Definition at line 77 of file task_scheduler.h.

                                                          {
    ZRTOS_TASK_SCHEDULER__DO_NOT_DISTURB({
        zrtos_clist__delete(&zrtos_task_scheduler.root,&task->node);
        zrtos_task__set_parent(task,0);
    });

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_task_scheduler__start()

void zrtos_task_scheduler__start

(

void

)

Definition at line 180 of file task_scheduler.h.

                                      {
/*
    while(true){
        _zrtos_task_scheduler__on_tick_ex();
    }
    __builtin_unreachable();
*/
}

zrtos_task_scheduler__stop()

void zrtos_task_scheduler__stop

(

void

)

Definition at line 189 of file task_scheduler.h.

                                     {
    //_zrtos_task_scheduler__isr_stop();
}

Variable Documentation

zrtos_task_scheduler

zrtos_task_scheduler_t zrtos_task_scheduler = {}

Definition at line 29 of file task_scheduler.h.