Other useful kernel service 的协作图:

宏定义
#define	RT_HW_BACKTRACE_FRAME_GET_SELF(frame)

#define	_MEM_INIT(...)

#define	_MEM_MALLOC(...)

#define	_MEM_REALLOC(...)

#define	_MEM_FREE(...)

#define	_MEM_INFO(...)

#define	rt_container_of(ptr, type, member)

#define	RT_LIST_OBJECT_INIT(object)

#define	rt_list_entry(node, type, member)

#define	rt_list_for_each(pos, head)

#define	rt_list_for_each_safe(pos, n, head)

#define	rt_list_for_each_entry(pos, head, member)

#define	rt_list_for_each_entry_safe(pos, n, head, member)

#define	rt_list_first_entry(ptr, type, member)

#define	RT_SLIST_OBJECT_INIT(object)

#define	rt_slist_entry(node, type, member)

#define	rt_slist_for_each(pos, head)

#define	rt_slist_for_each_entry(pos, head, member)

#define	rt_slist_first_entry(ptr, type, member)

#define	rt_slist_tail_entry(ptr, type, member)

#define	rt_kprintf(...)

#define	rt_kputs(str)

#define	RT_ASSERT(EX)

#define	RT_DEBUG_NOT_IN_INTERRUPT

#define	RT_DEBUG_IN_THREAD_CONTEXT

#define	RT_DEBUG_SCHEDULER_AVAILABLE(need_check)

#define	rt_sched_thread_is_binding(thread)

函数
rt_weak void	rt_hw_us_delay (rt_uint32_t us)

rt_weak void	rt_hw_cpu_reset (void)

rt_weak void	rt_hw_cpu_shutdown (void)

rt_weak rt_err_t	rt_hw_backtrace_frame_get (rt_thread_t thread, struct rt_hw_backtrace_frame *frame)

rt_weak rt_err_t	rt_hw_backtrace_frame_unwind (rt_thread_t thread, struct rt_hw_backtrace_frame *frame)

rt_weak const char *	rt_hw_cpu_arch (void)

void	rt_show_version (void)

	RTM_EXPORT (rt_show_version)

rt_weak rt_err_t	rt_backtrace (void)

rt_weak rt_err_t	rt_backtrace_frame (rt_thread_t thread, struct rt_hw_backtrace_frame *frame)

rt_weak rt_err_t	rt_backtrace_formatted_print (rt_ubase_t *buffer, long buflen)

rt_weak rt_err_t	rt_backtrace_to_buffer (rt_thread_t thread, struct rt_hw_backtrace_frame frame, long skip, rt_ubase_t buffer, long buflen)

rt_err_t	rt_backtrace_thread (rt_thread_t thread)

rt_inline void	_heap_lock_init (void)

rt_inline rt_base_t	_heap_lock (void)

rt_inline void	_heap_unlock (rt_base_t level)

void	rt_system_heap_init_generic (void begin_addr, void end_addr)

rt_weak void	rt_system_heap_init (void begin_addr, void end_addr)

rt_weak void *	rt_malloc (rt_size_t size)

	RTM_EXPORT (rt_malloc)

rt_weak void *	rt_realloc (void *ptr, rt_size_t newsize)

	RTM_EXPORT (rt_realloc)

rt_weak void *	rt_calloc (rt_size_t count, rt_size_t size)

	RTM_EXPORT (rt_calloc)

rt_weak void	rt_free (void *ptr)

	RTM_EXPORT (rt_free)

rt_weak void	rt_memory_info (rt_size_t total, rt_size_t used, rt_size_t *max_used)

	RTM_EXPORT (rt_memory_info)

rt_weak void *	rt_malloc_align (rt_size_t size, rt_size_t align)

	RTM_EXPORT (rt_malloc_align)

rt_weak void	rt_free_align (void *ptr)

	RTM_EXPORT (rt_free_align)

int	__rt_ffs (int value)

rt_inline void	rt_list_init (rt_list_t *l)

rt_inline void	rt_list_insert_after (rt_list_t l, rt_list_t n)

rt_inline void	rt_list_insert_before (rt_list_t l, rt_list_t n)

rt_inline void	rt_list_remove (rt_list_t *n)

rt_inline int	rt_list_isempty (const rt_list_t *l)

rt_inline unsigned int	rt_list_len (const rt_list_t *l)

rt_inline void	rt_slist_init (rt_slist_t *l)

rt_inline void	rt_slist_append (rt_slist_t l, rt_slist_t n)

rt_inline void	rt_slist_insert (rt_slist_t l, rt_slist_t n)

rt_inline unsigned int	rt_slist_len (const rt_slist_t *l)

rt_inline rt_slist_t *	rt_slist_pop (rt_slist_t *l)

rt_inline rt_slist_t *	rt_slist_remove (rt_slist_t l, rt_slist_t n)

rt_inline rt_slist_t *	rt_slist_first (rt_slist_t *l)

rt_inline rt_slist_t *	rt_slist_tail (rt_slist_t *l)

rt_inline rt_slist_t *	rt_slist_next (rt_slist_t *n)

rt_inline int	rt_slist_isempty (rt_slist_t *l)

unsigned long	__rt_ffsl (unsigned long value)

unsigned long	__rt_clz (unsigned long value)

rt_inline rt_bool_t	rt_in_thread_context (void)

rt_inline rt_bool_t	rt_scheduler_is_available (void)

变量
const rt_uint8_t	__lowest_bit_bitmap []

void	rt_realloc_set_entry_hook (void(hook)(void *ptr, rt_size_t size))

void	rt_realloc_set_exit_hook (void(hook)(void *ptr, rt_size_t size))

void	rt_free_sethook (void(hook)(void *ptr))

详细描述

other useful service in the kernel

宏定义说明

◆ RT_HW_BACKTRACE_FRAME_GET_SELF

#define RT_HW_BACKTRACE_FRAME_GET_SELF ( frame )

值:

        do {  \
        (frame)->fp = 0;                                \
        (frame)->pc = 0;                                \
    } while (0)

注解: can be overridden by cpuport.h which is defined by a specific arch

在文件 kservice.c 第 101 行定义.

    #define RT_HW_BACKTRACE_FRAME_GET_SELF(frame) do {  \
        (frame)->fp = 0;                                \
        (frame)->pc = 0;                                \
    } while (0)

◆ _MEM_INIT

#define _MEM_INIT ( ... )

在文件 kservice.c 第 760 行定义.

◆ _MEM_MALLOC

#define _MEM_MALLOC ( ... )

值:

RT_NULL

#define RT_NULL

定义 rttypes.h:114

在文件 kservice.c 第 761 行定义.

◆ _MEM_REALLOC

#define _MEM_REALLOC ( ... )

值:

RT_NULL

在文件 kservice.c 第 762 行定义.

◆ _MEM_FREE

#define _MEM_FREE ( ... )

在文件 kservice.c 第 763 行定义.

◆ _MEM_INFO

#define _MEM_INFO ( ... )

在文件 kservice.c 第 764 行定义.

◆ rt_container_of

#define rt_container_of	(	ptr,
		type,
		member )

值:

((type *)((char *)(ptr) - (unsigned long)(&((type *)0)->member)))

rt_container_of - return the start address of struct type, while ptr is the member of struct type.

在文件 rtservice.h 第 36 行定义.

36#define rt_container_of(ptr, type, member) \

37 ((type *)((char *)(ptr) - (unsigned long)(&((type *)0)->member)))

◆ RT_LIST_OBJECT_INIT

#define RT_LIST_OBJECT_INIT ( object )

值:

{ &(object), &(object) }

initialize a list object

在文件 rtservice.h 第 43 行定义.

◆ rt_list_entry

#define rt_list_entry	(	node,
		type,
		member )

值:

rt_container_of(node, type, member)

rt_container_of

#define rt_container_of(ptr, type, member)

定义 rtservice.h:36

get the struct for this entry

参数

node	the entry point
type	the type of structure
member	the name of list in structure

在文件 rtservice.h 第 129 行定义.

129#define rt_list_entry(node, type, member) \

130 rt_container_of(node, type, member)

◆ rt_list_for_each

#define rt_list_for_each	(		pos,
			head )

值:

for (pos = (head)->next; pos != (head); pos = pos->next)

rt_list_for_each - iterate over a list

参数

pos	the rt_list_t * to use as a loop cursor.
head	the head for your list.

在文件 rtservice.h 第 137 行定义.

137#define rt_list_for_each(pos, head) \

138 for (pos = (head)->next; pos != (head); pos = pos->next)

◆ rt_list_for_each_safe

#define rt_list_for_each_safe	(	pos,
		n,
		head )

值:

for (pos = (head)->next, n = pos->next; pos != (head); \

pos = n, n = pos->next)

rt_list_for_each_safe - iterate over a list safe against removal of list entry

参数

pos	the rt_list_t * to use as a loop cursor.
n	another rt_list_t * to use as temporary storage
head	the head for your list.

在文件 rtservice.h 第 146 行定义.

#define rt_list_for_each_safe(pos, n, head) \
    for (pos = (head)->next, n = pos->next; pos != (head); \
        pos = n, n = pos->next)

◆ rt_list_for_each_entry

#define rt_list_for_each_entry	(	pos,
		head,
		member )

值:

    for (pos = rt_list_entry((head)->next, rt_typeof(*pos), member); \
         &pos->member != (head); \
         pos = rt_list_entry(pos->member.next, rt_typeof(*pos), member))

rt_list_for_each_entry - iterate over list of given type

参数

pos	the type * to use as a loop cursor.
head	the head for your list.
member	the name of the list_struct within the struct.

在文件 rtservice.h 第 156 行定义.

#define rt_list_for_each_entry(pos, head, member) \
    for (pos = rt_list_entry((head)->next, rt_typeof(*pos), member); \
         &pos->member != (head); \
         pos = rt_list_entry(pos->member.next, rt_typeof(*pos), member))

◆ rt_list_for_each_entry_safe

#define rt_list_for_each_entry_safe	(	pos,
		n,
		head,
		member )

值:

    for (pos = rt_list_entry((head)->next, rt_typeof(*pos), member), \
         n = rt_list_entry(pos->member.next, rt_typeof(*pos), member); \
         &pos->member != (head); \
         pos = n, n = rt_list_entry(n->member.next, rt_typeof(*n), member))

rt_list_for_each_entry_safe - iterate over list of given type safe against removal of list entry

参数

pos	the type * to use as a loop cursor.
n	another type * to use as temporary storage
head	the head for your list.
member	the name of the list_struct within the struct.

在文件 rtservice.h 第 168 行定义.

#define rt_list_for_each_entry_safe(pos, n, head, member) \
    for (pos = rt_list_entry((head)->next, rt_typeof(*pos), member), \
         n = rt_list_entry(pos->member.next, rt_typeof(*pos), member); \
         &pos->member != (head); \
         pos = n, n = rt_list_entry(n->member.next, rt_typeof(*n), member))

◆ rt_list_first_entry

#define rt_list_first_entry	(	ptr,
		type,
		member )

值:

rt_list_entry((ptr)->next, type, member)

rt_list_first_entry - get the first element from a list

参数

ptr	the list head to take the element from.
type	the type of the struct this is embedded in.
member	the name of the list_struct within the struct.

Note, that list is expected to be not empty.

在文件 rtservice.h 第 182 行定义.

182#define rt_list_first_entry(ptr, type, member) \

183 rt_list_entry((ptr)->next, type, member)

◆ RT_SLIST_OBJECT_INIT

#define RT_SLIST_OBJECT_INIT ( object )

值:

{ RT_NULL }

在文件 rtservice.h 第 185 行定义.

◆ rt_slist_entry

#define rt_slist_entry	(	node,
		type,
		member )

值:

rt_container_of(node, type, member)

get the struct for this single list node

参数

node	the entry point
type	the type of structure
member	the name of list in structure

在文件 rtservice.h 第 282 行定义.

282#define rt_slist_entry(node, type, member) \

283 rt_container_of(node, type, member)

◆ rt_slist_for_each

#define rt_slist_for_each	(		pos,
			head )

值:

for (pos = (head)->next; pos != RT_NULL; pos = pos->next)

rt_slist_for_each - iterate over a single list

参数

pos	the rt_slist_t * to use as a loop cursor.
head	the head for your single list.

在文件 rtservice.h 第 290 行定义.

290#define rt_slist_for_each(pos, head) \

291 for (pos = (head)->next; pos != RT_NULL; pos = pos->next)

◆ rt_slist_for_each_entry

#define rt_slist_for_each_entry	(	pos,
		head,
		member )

值:

    for (pos = ((head)->next == (RT_NULL) ? (RT_NULL) : rt_slist_entry((head)->next, rt_typeof(*pos), member)); \
         pos != (RT_NULL) && &pos->member != (RT_NULL); \
         pos = (pos->member.next == (RT_NULL) ? (RT_NULL) : rt_slist_entry(pos->member.next, rt_typeof(*pos), member)))

rt_slist_for_each_entry - iterate over single list of given type

参数

pos	the type * to use as a loop cursor.
head	the head for your single list.
member	the name of the list_struct within the struct.

在文件 rtservice.h 第 299 行定义.

#define rt_slist_for_each_entry(pos, head, member) \
    for (pos = ((head)->next == (RT_NULL) ? (RT_NULL) : rt_slist_entry((head)->next, rt_typeof(*pos), member)); \
         pos != (RT_NULL) && &pos->member != (RT_NULL); \
         pos = (pos->member.next == (RT_NULL) ? (RT_NULL) : rt_slist_entry(pos->member.next, rt_typeof(*pos), member)))

◆ rt_slist_first_entry

#define rt_slist_first_entry	(	ptr,
		type,
		member )

值:

rt_slist_entry((ptr)->next, type, member)

rt_slist_first_entry - get the first element from a slist

参数

ptr	the slist head to take the element from.
type	the type of the struct this is embedded in.
member	the name of the slist_struct within the struct.

Note, that slist is expected to be not empty.

在文件 rtservice.h 第 312 行定义.

312#define rt_slist_first_entry(ptr, type, member) \

313 rt_slist_entry((ptr)->next, type, member)

◆ rt_slist_tail_entry

#define rt_slist_tail_entry	(	ptr,
		type,
		member )

值:

rt_slist_entry(rt_slist_tail(ptr), type, member)

rt_slist_tail

rt_inline rt_slist_t * rt_slist_tail(rt_slist_t *l)

定义 rtservice.h:259

rt_slist_tail_entry - get the tail element from a slist

参数

ptr	the slist head to take the element from.
type	the type of the struct this is embedded in.
member	the name of the slist_struct within the struct.

Note, that slist is expected to be not empty.

在文件 rtservice.h 第 323 行定义.

323#define rt_slist_tail_entry(ptr, type, member) \

324 rt_slist_entry(rt_slist_tail(ptr), type, member)

◆ rt_kprintf

#define rt_kprintf ( ... )

在文件 rtthread.h 第 771 行定义.

◆ rt_kputs

#define rt_kputs ( str )

在文件 rtthread.h 第 772 行定义.

◆ RT_ASSERT

#define RT_ASSERT ( EX )

值:

{RT_UNUSED(EX);}

RT_UNUSED

#define RT_UNUSED(x)

定义 rtdef.h:120

在文件 rtthread.h 第 812 行定义.

◆ RT_DEBUG_NOT_IN_INTERRUPT

#define RT_DEBUG_NOT_IN_INTERRUPT

在文件 rtthread.h 第 866 行定义.

◆ RT_DEBUG_IN_THREAD_CONTEXT

#define RT_DEBUG_IN_THREAD_CONTEXT

在文件 rtthread.h 第 867 行定义.

◆ RT_DEBUG_SCHEDULER_AVAILABLE

#define RT_DEBUG_SCHEDULER_AVAILABLE ( need_check )

在文件 rtthread.h 第 868 行定义.

◆ rt_sched_thread_is_binding

#define rt_sched_thread_is_binding ( thread )

值:

(RT_TRUE)

RT_TRUE

#define RT_TRUE

定义 rttypes.h:110

在文件 rtthread.h 第 894 行定义.

函数说明

◆ rt_hw_us_delay()

rt_weak void rt_hw_us_delay ( rt_uint32_t us )

在文件 kservice.c 第 65 行定义.

{
    (void) us;
    LOG_W("rt_hw_us_delay() doesn't support for this board."
        "Please consider implementing rt_hw_us_delay() in another file.");
}

引用了 LOG_W.

◆ rt_hw_cpu_reset()

rt_weak void rt_hw_cpu_reset ( void )

在文件 kservice.c 第 72 行定义.

{
    LOG_W("rt_hw_cpu_reset() doesn't support for this board."
        "Please consider implementing rt_hw_cpu_reset() in another file.");
    return;
}

引用了 LOG_W.

◆ rt_hw_cpu_shutdown()

rt_weak void rt_hw_cpu_shutdown ( void )

在文件 kservice.c 第 79 行定义.

{
    LOG_I("CPU shutdown...");
    LOG_W("Using default rt_hw_cpu_shutdown()."
        "Please consider implementing rt_hw_cpu_shutdown() in another file.");
    rt_hw_interrupt_disable();
    RT_ASSERT(0);
    return;
}

引用了 LOG_I, LOG_W, RT_ASSERT , 以及 rt_hw_interrupt_disable().

函数调用图:

◆ rt_hw_backtrace_frame_get()

rt_weak rt_err_t rt_hw_backtrace_frame_get	(	rt_thread_t	thread,
		struct rt_hw_backtrace_frame *	frame )

Get the inner most frame of target thread

参数

thread	the thread which frame belongs to
frame	the specified frame to be unwound

返回: rt_err_t 0 is succeed, otherwise a failure

在文件 kservice.c 第 117 行定义.

{
    RT_UNUSED(thread);
    RT_UNUSED(frame);
 
    LOG_W("%s is not implemented", __func__);
    return -RT_ENOSYS;
}

引用了 LOG_W , 以及 RT_UNUSED.

这是这个函数的调用关系图:

◆ rt_hw_backtrace_frame_unwind()

rt_weak rt_err_t rt_hw_backtrace_frame_unwind	(	rt_thread_t	thread,
		struct rt_hw_backtrace_frame *	frame )

Unwind the target frame

参数

thread	the thread which frame belongs to
frame	the specified frame to be unwound

返回: rt_err_t 0 is succeed, otherwise a failure

在文件 kservice.c 第 133 行定义.

{
    RT_UNUSED(thread);
    RT_UNUSED(frame);
 
    LOG_W("%s is not implemented", __func__);
    return -RT_ENOSYS;
}

引用了 LOG_W , 以及 RT_UNUSED.

这是这个函数的调用关系图:

◆ rt_hw_cpu_arch()

rt_weak const char * rt_hw_cpu_arch ( void )

在文件 kservice.c 第 142 行定义.

{
    return "unknown";
}

◆ rt_show_version()

void rt_show_version ( void )

This function will show the version of rt-thread rtos

在文件 kservice.c 第 150 行定义.

{
    rt_kprintf("\n \\ | /\n");
#if defined(RT_USING_SMART)
    rt_kprintf("- RT -     Thread Smart Operating System\n");
#elif defined(RT_USING_NANO)
    rt_kprintf("- RT -     Thread Nano Operating System\n");
#else
    rt_kprintf("- RT -     Thread Operating System\n");
#endif
    rt_kprintf(" / | \\     %d.%d.%d build %s %s\n",
               (rt_int32_t)RT_VERSION_MAJOR, (rt_int32_t)RT_VERSION_MINOR, (rt_int32_t)RT_VERSION_PATCH, __DATE__, __TIME__);
    rt_kprintf(" 2006 - 2024 Copyright by RT-Thread team\n");
}

引用了 rt_kprintf, RT_VERSION_MAJOR, RT_VERSION_MINOR , 以及 RT_VERSION_PATCH.

这是这个函数的调用关系图:

◆ RTM_EXPORT() [1/8]

RTM_EXPORT ( rt_show_version )

引用了 rt_show_version().

函数调用图:

◆ rt_backtrace()

rt_err_t rt_backtrace ( void )

Print backtrace of current thread to system console device

返回: rt_err_t 0 is success, otherwise a failure

在文件 kservice.c 第 394 行定义.

{
    struct rt_hw_backtrace_frame frame;
    rt_thread_t thread = rt_thread_self();
 
    RT_HW_BACKTRACE_FRAME_GET_SELF(&frame);
    if (!frame.fp)
        return -RT_EINVAL;
 
    /* we don't want this frame to be printed which is nearly garbage info */
    rt_hw_backtrace_frame_unwind(thread, &frame);
 
    return rt_backtrace_frame(thread, &frame);
}

引用了 rt_hw_backtrace_frame::fp, rt_backtrace_frame(), RT_HW_BACKTRACE_FRAME_GET_SELF, rt_hw_backtrace_frame_unwind() , 以及 rt_thread_self().

函数调用图:

◆ rt_backtrace_frame()

rt_err_t rt_backtrace_frame	(	rt_thread_t	thread,
		struct rt_hw_backtrace_frame *	frame )

Print backtrace from frame to system console device

参数

thread	the thread which frame belongs to
frame	where backtrace starts from

返回: rt_err_t 0 is success, otherwise a failure

在文件 kservice.c 第 416 行定义.

{
    long nesting = 0;
 
    rt_kprintf("please use: addr2line -e rtthread.elf -a -f\n");
 
    while (nesting < RT_BACKTRACE_LEVEL_MAX_NR)
    {
        rt_kprintf(" 0x%lx", (rt_ubase_t)frame->pc);
        if (rt_hw_backtrace_frame_unwind(thread, frame))
        {
            break;
        }
        nesting++;
    }
    rt_kprintf("\n");
    return RT_EOK;
}

引用了 rt_hw_backtrace_frame::pc, rt_hw_backtrace_frame_unwind() , 以及 rt_kprintf.

函数调用图:

这是这个函数的调用关系图:

◆ rt_backtrace_formatted_print()

rt_err_t rt_backtrace_formatted_print	(	rt_ubase_t *	buffer,
		long	buflen )

Print backtrace from buffer to system console

参数

buffer	where traced frames saved
buflen	number of items in buffer

返回: rt_err_t 0 is success, otherwise a failure

在文件 kservice.c 第 442 行定义.

{
    rt_kprintf("please use: addr2line -e rtthread.elf -a -f\n");
 
    for (rt_size_t i = 0; i < buflen && buffer[i] != 0; i++)
    {
        rt_kprintf(" 0x%lx", (rt_ubase_t)buffer[i]);
    }
 
    rt_kprintf("\n");
    return RT_EOK;
}

引用了 rt_kprintf.

◆ rt_backtrace_to_buffer()

rt_err_t rt_backtrace_to_buffer	(	rt_thread_t	thread,
		struct rt_hw_backtrace_frame *	frame,
		long	skip,
		rt_ubase_t *	buffer,
		long	buflen )

Print backtrace from frame to the given buffer

参数

thread	the thread which frame belongs to
frame	where backtrace starts from. NULL if it's the current one
skip	the number of frames to discarded counted from calling function. Noted that the inner most frame is always discarded and not counted, which is obviously reasonable since that's this function itself.
buffer	where traced frames saved
buflen	max number of items can be saved in buffer. If there are no more than buflen items to be saved, there will be a NULL after the last saved item in the buffer.

返回: rt_err_t 0 is success, otherwise a failure

在文件 kservice.c 第 470 行定义.

{
    long nesting = 0;
    struct rt_hw_backtrace_frame cur_frame;
 
    if (!thread)
        return -RT_EINVAL;
 
    RT_ASSERT(rt_object_get_type(&thread->parent) == RT_Object_Class_Thread);
 
    if (!frame)
    {
        frame = &cur_frame;
        RT_HW_BACKTRACE_FRAME_GET_SELF(frame);
        if (!frame->fp)
            return -RT_EINVAL;
    }
 
    /* discard frames as required. The inner most is always threw. */
    do {
        rt_hw_backtrace_frame_unwind(thread, frame);
    } while (skip-- > 0);
 
    while (nesting < buflen)
    {
        *buffer++ = (rt_ubase_t)frame->pc;
        if (rt_hw_backtrace_frame_unwind(thread, frame))
        {
            break;
        }
        nesting++;
    }
 
    if (nesting < buflen)
        *buffer = RT_NULL;
 
    return RT_EOK;
}

引用了 rt_hw_backtrace_frame::fp, rt_thread::parent, rt_hw_backtrace_frame::pc, RT_ASSERT, RT_HW_BACKTRACE_FRAME_GET_SELF, rt_hw_backtrace_frame_unwind(), RT_NULL, RT_Object_Class_Thread , 以及 rt_object_get_type().

函数调用图:

◆ rt_backtrace_thread()

rt_err_t rt_backtrace_thread ( rt_thread_t thread )

Print backtrace of a thread to system console device

参数

thread which call stack is traced

返回: rt_err_t 0 is success, otherwise a failure

在文件 kservice.c 第 519 行定义.

{
    rt_err_t rc;
    struct rt_hw_backtrace_frame frame;
    if (thread)
    {
        rc = rt_hw_backtrace_frame_get(thread, &frame);
        if (rc == RT_EOK)
        {
            rc = rt_backtrace_frame(thread, &frame);
        }
    }
    else
    {
        rc = -RT_EINVAL;
    }
    return rc;
}

引用了 rt_backtrace_frame() , 以及 rt_hw_backtrace_frame_get().

函数调用图:

◆ rt_realloc_set_entry_hook()

void rt_realloc_set_entry_hook ( void(* hook )(void **ptr, rt_size_t size) )

This function will set a hook function, which will be invoked when a memory block is allocated from heap memory.

参数

hook	the hook function.

在文件 kservice.c 第 613 行定义.

{
    rt_realloc_entry_hook = hook;
}

◆ rt_realloc_set_exit_hook()

void rt_realloc_set_exit_hook ( void(* hook )(void **ptr, rt_size_t size) )

This function will set a hook function, which will be invoked when a memory block is allocated from heap memory.

参数

hook	the hook function.

在文件 kservice.c 第 624 行定义.

{
    rt_realloc_exit_hook = hook;
}

◆ rt_free_sethook()

void rt_free_sethook ( void(* hook )(void **ptr) )

This function will set a hook function, which will be invoked when a memory block is released to heap memory.

参数

hook	the hook function

在文件 kservice.c 第 635 行定义.

{
    rt_free_hook = hook;
}

◆ _heap_lock_init()

rt_inline void _heap_lock_init ( void )

在文件 kservice.c 第 650 行定义.

{
#if defined(RT_USING_HEAP_ISR)
    rt_spin_lock_init(&_heap_spinlock);
#elif defined(RT_USING_MUTEX)
    rt_mutex_init(&_lock, "heap", RT_IPC_FLAG_PRIO);
#endif
}

引用了 RT_IPC_FLAG_PRIO, rt_mutex_init() , 以及 rt_spin_lock_init().

函数调用图:

这是这个函数的调用关系图:

◆ _heap_lock()

rt_inline rt_base_t _heap_lock ( void )

在文件 kservice.c 第 659 行定义.

{
#if defined(RT_USING_HEAP_ISR)
    return rt_spin_lock_irqsave(&_heap_spinlock);
#elif defined(RT_USING_MUTEX)
    if (rt_thread_self())
        return rt_mutex_take(&_lock, RT_WAITING_FOREVER);
    else
        return RT_EOK;
#else
    rt_enter_critical();
    return RT_EOK;
#endif
}

引用了 rt_enter_critical(), rt_mutex_take(), rt_spin_lock_irqsave(), rt_thread_self() , 以及 RT_WAITING_FOREVER.

函数调用图:

这是这个函数的调用关系图:

◆ _heap_unlock()

rt_inline void _heap_unlock ( rt_base_t level )

在文件 kservice.c 第 674 行定义.

{
#if defined(RT_USING_HEAP_ISR)
    rt_spin_unlock_irqrestore(&_heap_spinlock, level);
#elif defined(RT_USING_MUTEX)
    RT_ASSERT(level == RT_EOK);
    if (rt_thread_self())
        rt_mutex_release(&_lock);
#else
    rt_exit_critical();
#endif
}

引用了 RT_ASSERT, rt_exit_critical(), rt_mutex_release(), rt_spin_unlock_irqrestore() , 以及 rt_thread_self().

函数调用图:

这是这个函数的调用关系图:

◆ rt_system_heap_init_generic()

void rt_system_heap_init_generic	(	void *	begin_addr,
		void *	end_addr )

This function will do the generic system heap initialization.

参数

begin_addr	the beginning address of system page.
end_addr	the end address of system page.

在文件 kservice.c 第 774 行定义.

{
    rt_uintptr_t begin_align = RT_ALIGN((rt_uintptr_t)begin_addr, RT_ALIGN_SIZE);
    rt_uintptr_t end_align   = RT_ALIGN_DOWN((rt_uintptr_t)end_addr, RT_ALIGN_SIZE);
 
    RT_ASSERT(end_align > begin_align);
 
    /* Initialize system memory heap */
    _MEM_INIT("heap", (void *)begin_align, end_align - begin_align);
    /* Initialize multi thread contention lock */
    _heap_lock_init();
}

引用了 _heap_lock_init(), _MEM_INIT, RT_ALIGN, RT_ALIGN_DOWN , 以及 RT_ASSERT.

函数调用图:

这是这个函数的调用关系图:

◆ rt_system_heap_init()

rt_weak void rt_system_heap_init	(	void *	begin_addr,
		void *	end_addr )

This function will init system heap. User can override this API to complete other works, like heap sanitizer initialization.

参数

begin_addr	the beginning address of system page.
end_addr	the end address of system page.

在文件 kservice.c 第 795 行定义.

{
    rt_system_heap_init_generic(begin_addr, end_addr);
}

引用了 rt_system_heap_init_generic().

函数调用图:

◆ rt_malloc()

rt_weak void * rt_malloc ( rt_size_t size )

Allocate a block of memory with a minimum of 'size' bytes.

参数

size	is the minimum size of the requested block in bytes.

返回: the pointer to allocated memory or NULL if no free memory was found.

在文件 kservice.c 第 807 行定义.

{
    rt_base_t level;
    void *ptr;
 
    /* Enter critical zone */
    level = _heap_lock();
    /* allocate memory block from system heap */
    ptr = _MEM_MALLOC(size);
    /* Exit critical zone */
    _heap_unlock(level);
    /* call 'rt_malloc' hook */
    RT_OBJECT_HOOK_CALL(rt_malloc_hook, (&ptr, size));
    return ptr;
}

引用了 _heap_lock(), _heap_unlock(), _MEM_MALLOC , 以及 RT_OBJECT_HOOK_CALL.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [2/8]

RTM_EXPORT ( rt_malloc )

引用了 rt_malloc().

函数调用图:

◆ rt_realloc()

rt_weak void * rt_realloc	(	void *	ptr,
		rt_size_t	newsize )

This function will change the size of previously allocated memory block.

参数

ptr	is the pointer to memory allocated by rt_malloc.
newsize	is the required new size.

返回: the changed memory block address.

在文件 kservice.c 第 833 行定义.

{
    rt_base_t level;
    void *nptr;
 
    /* Entry hook */
    RT_OBJECT_HOOK_CALL(rt_realloc_entry_hook, (&ptr, newsize));
    /* Enter critical zone */
    level = _heap_lock();
    /* Change the size of previously allocated memory block */
    nptr = _MEM_REALLOC(ptr, newsize);
    /* Exit critical zone */
    _heap_unlock(level);
    /* Exit hook */
    RT_OBJECT_HOOK_CALL(rt_realloc_exit_hook, (&nptr, newsize));
    return nptr;
}

引用了 _heap_lock(), _heap_unlock(), _MEM_REALLOC , 以及 RT_OBJECT_HOOK_CALL.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [3/8]

RTM_EXPORT ( rt_realloc )

引用了 rt_realloc().

函数调用图:

◆ rt_calloc()

rt_weak void * rt_calloc	(	rt_size_t	count,
		rt_size_t	size )

This function will contiguously allocate enough space for count objects that are size bytes of memory each and returns a pointer to the allocated memory.

注解: The allocated memory is filled with bytes of value zero.

参数

count	is the number of objects to allocate.
size	is the size of one object to allocate.

返回: pointer to allocated memory / NULL pointer if there is an error.

在文件 kservice.c 第 865 行定义.

{
    void *p;
 
    /* allocate 'count' objects of size 'size' */
    p = rt_malloc(count * size);
    /* zero the memory */
    if (p)
    {
        rt_memset(p, 0, count * size);
    }
    return p;
}

引用了 rt_malloc().

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [4/8]

RTM_EXPORT ( rt_calloc )

引用了 rt_calloc().

函数调用图:

◆ rt_free()

rt_weak void rt_free ( void * ptr )

This function will release the previously allocated memory block by rt_malloc. The released memory block is taken back to system heap.

参数

ptr	the address of memory which will be released.

在文件 kservice.c 第 886 行定义.

{
    rt_base_t level;
 
    /* call 'rt_free' hook */
    RT_OBJECT_HOOK_CALL(rt_free_hook, (&ptr));
    /* NULL check */
    if (ptr == RT_NULL) return;
    /* Enter critical zone */
    level = _heap_lock();
    _MEM_FREE(ptr);
    /* Exit critical zone */
    _heap_unlock(level);
}

引用了 _heap_lock(), _heap_unlock(), _MEM_FREE, RT_NULL , 以及 RT_OBJECT_HOOK_CALL.

函数调用图:

◆ RTM_EXPORT() [5/8]

RTM_EXPORT ( rt_free )

引用了 rt_free().

函数调用图:

◆ rt_memory_info()

rt_weak void rt_memory_info	(	rt_size_t *	total,
		rt_size_t *	used,
		rt_size_t *	max_used )

This function will caculate the total memory, the used memory, and the max used memory.

参数

total	is a pointer to get the total size of the memory.
used	is a pointer to get the size of memory used.
max_used	is a pointer to get the maximum memory used.

在文件 kservice.c 第 912 行定义.

{
    rt_base_t level;
 
    /* Enter critical zone */
    level = _heap_lock();
    _MEM_INFO(total, used, max_used);
    /* Exit critical zone */
    _heap_unlock(level);
}

引用了 _heap_lock(), _heap_unlock() , 以及 _MEM_INFO.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [6/8]

RTM_EXPORT ( rt_memory_info )

引用了 rt_memory_info().

函数调用图:

◆ rt_malloc_align()

rt_weak void * rt_malloc_align	(	rt_size_t	size,
		rt_size_t	align )

This function allocates a memory block, which address is aligned to the specified alignment size.

参数

size	is the allocated memory block size.
align	is the alignment size.

返回: The memory block address was returned successfully, otherwise it was returned empty RT_NULL.

在文件 kservice.c 第 965 行定义.

{
    void *ptr = RT_NULL;
    void *align_ptr = RT_NULL;
    int uintptr_size = 0;
    rt_size_t align_size = 0;
 
    /* sizeof pointer */
    uintptr_size = sizeof(void*);
    uintptr_size -= 1;
 
    /* align the alignment size to uintptr size byte */
    align = ((align + uintptr_size) & ~uintptr_size);
 
    /* get total aligned size */
    align_size = ((size + uintptr_size) & ~uintptr_size) + align;
    /* allocate memory block from heap */
    ptr = rt_malloc(align_size);
    if (ptr != RT_NULL)
    {
        /* the allocated memory block is aligned */
        if (((rt_uintptr_t)ptr & (align - 1)) == 0)
        {
            align_ptr = (void *)((rt_uintptr_t)ptr + align);
        }
        else
        {
            align_ptr = (void *)(((rt_uintptr_t)ptr + (align - 1)) & ~(align - 1));
        }
 
        /* set the pointer before alignment pointer to the real pointer */
        *((rt_uintptr_t *)((rt_uintptr_t)align_ptr - sizeof(void *))) = (rt_uintptr_t)ptr;
 
        ptr = align_ptr;
    }
 
    return ptr;
}

引用了 rt_malloc() , 以及 RT_NULL.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [7/8]

RTM_EXPORT ( rt_malloc_align )

引用了 rt_malloc_align().

函数调用图:

◆ rt_free_align()

rt_weak void rt_free_align ( void * ptr )

This function release the memory block, which is allocated by rt_malloc_align function and address is aligned.

参数

ptr	is the memory block pointer.

在文件 kservice.c 第 1011 行定义.

{
    void *real_ptr = RT_NULL;
 
    /* NULL check */
    if (ptr == RT_NULL) return;
    real_ptr = (void *) * (rt_uintptr_t *)((rt_uintptr_t)ptr - sizeof(void *));
    rt_free(real_ptr);
}

引用了 rt_free() , 以及 RT_NULL.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [8/8]

RTM_EXPORT ( rt_free_align )

引用了 __lowest_bit_bitmap , 以及 rt_free_align().

函数调用图:

◆ __rt_ffs()

int __rt_ffs ( int value )

This function finds the first bit set (beginning with the least significant bit) in value and return the index of that bit.

Bits are numbered starting at 1 (the least significant bit). A return value of zero from any of these functions means that the argument was zero.

参数

value is the value to find the first bit set in.

返回: Return the index of the first bit set. If value is 0, then this function shall return 0.

在文件 kservice.c 第 1083 行定义.

{
    if (value == 0)
    {
        return 0;
    }
 
    if (value & 0xff)
    {
        return __lowest_bit_bitmap[value & 0xff] + 1;
    }
 
    if (value & 0xff00)
    {
        return __lowest_bit_bitmap[(value & 0xff00) >> 8] + 9;
    }
 
    if (value & 0xff0000)
    {
        return __lowest_bit_bitmap[(value & 0xff0000) >> 16] + 17;
    }
 
    return __lowest_bit_bitmap[(value & 0xff000000) >> 24] + 25;
}

引用了 __lowest_bit_bitmap.

这是这个函数的调用关系图:

◆ rt_list_init()

rt_inline void rt_list_init ( rt_list_t * l )

initialize a list

参数

l	list to be initialized

在文件 rtservice.h 第 50 行定义.

{
    l->next = l->prev = l;
}

引用了 rt_list_node::next , 以及 rt_list_node::prev.

这是这个函数的调用关系图:

◆ rt_list_insert_after()

rt_inline void rt_list_insert_after	(	rt_list_t *	l,
		rt_list_t *	n )

insert a node after a list

参数

l	list to insert it
n	new node to be inserted

在文件 rtservice.h 第 61 行定义.

{
    l->next->prev = n;
    n->next = l->next;
 
    l->next = n;
    n->prev = l;
}

引用了 rt_list_node::next , 以及 rt_list_node::prev.

这是这个函数的调用关系图:

◆ rt_list_insert_before()

rt_inline void rt_list_insert_before	(	rt_list_t *	l,
		rt_list_t *	n )

insert a node before a list

参数

n	new node to be inserted
l	list to insert it

在文件 rtservice.h 第 76 行定义.

{
    l->prev->next = n;
    n->prev = l->prev;
 
    l->prev = n;
    n->next = l;
}

引用了 rt_list_node::next , 以及 rt_list_node::prev.

这是这个函数的调用关系图:

◆ rt_list_remove()

rt_inline void rt_list_remove ( rt_list_t * n )

remove node from list.

参数

n	the node to remove from the list.

在文件 rtservice.h 第 89 行定义.

{
    n->next->prev = n->prev;
    n->prev->next = n->next;
 
    n->next = n->prev = n;
}

引用了 rt_list_node::next , 以及 rt_list_node::prev.

这是这个函数的调用关系图:

◆ rt_list_isempty()

rt_inline int rt_list_isempty ( const rt_list_t * l )

tests whether a list is empty

参数

l	the list to test.

在文件 rtservice.h 第 101 行定义.

{
    return l->next == l;
}

引用了 rt_list_node::next.

这是这个函数的调用关系图:

◆ rt_list_len()

rt_inline unsigned int rt_list_len ( const rt_list_t * l )

get the list length

参数

l	the list to get.

在文件 rtservice.h 第 110 行定义.

{
    unsigned int len = 0;
    const rt_list_t *p = l;
    while (p->next != l)
    {
        p = p->next;
        len ++;
    }
 
    return len;
}

引用了 rt_list_node::next.

这是这个函数的调用关系图:

◆ rt_slist_init()

rt_inline void rt_slist_init ( rt_slist_t * l )

initialize a single list

参数

l	the single list to be initialized

在文件 rtservice.h 第 192 行定义.

{
    l->next = RT_NULL;
}

引用了 rt_slist_node::next , 以及 RT_NULL.

◆ rt_slist_append()

rt_inline void rt_slist_append	(	rt_slist_t *	l,
		rt_slist_t *	n )

在文件 rtservice.h 第 197 行定义.

{
    struct rt_slist_node *node;
 
    node = l;
    while (node->next) node = node->next;
 
    /* append the node to the tail */
    node->next = n;
    n->next = RT_NULL;
}

引用了 rt_slist_node::next , 以及 RT_NULL.

◆ rt_slist_insert()

rt_inline void rt_slist_insert	(	rt_slist_t *	l,
		rt_slist_t *	n )

在文件 rtservice.h 第 209 行定义.

{
    n->next = l->next;
    l->next = n;
}

引用了 rt_slist_node::next.

◆ rt_slist_len()

rt_inline unsigned int rt_slist_len ( const rt_slist_t * l )

在文件 rtservice.h 第 215 行定义.

{
    unsigned int len = 0;
    const rt_slist_t *list = l->next;
    while (list != RT_NULL)
    {
        list = list->next;
        len ++;
    }
 
    return len;
}

引用了 rt_slist_node::next , 以及 RT_NULL.

◆ rt_slist_pop()

rt_inline rt_slist_t * rt_slist_pop ( rt_slist_t * l )

在文件 rtservice.h 第 228 行定义.

{
    struct rt_slist_node *node = l;
 
    /* remove node */
    node = node->next;
    if (node != (rt_slist_t *)0)
    {
        ((struct rt_slist_node *)l)->next = node->next;
    }
 
    return node;
}

引用了 rt_slist_node::next.

◆ rt_slist_remove()

rt_inline rt_slist_t * rt_slist_remove	(	rt_slist_t *	l,
		rt_slist_t *	n )

在文件 rtservice.h 第 242 行定义.

{
    /* remove slist head */
    struct rt_slist_node *node = l;
    while (node->next && node->next != n) node = node->next;
 
    /* remove node */
    if (node->next != (rt_slist_t *)0) node->next = node->next->next;
 
    return l;
}

引用了 rt_slist_node::next.

◆ rt_slist_first()

rt_inline rt_slist_t * rt_slist_first ( rt_slist_t * l )

在文件 rtservice.h 第 254 行定义.

{
    return l->next;
}

引用了 rt_slist_node::next.

◆ rt_slist_tail()

rt_inline rt_slist_t * rt_slist_tail ( rt_slist_t * l )

在文件 rtservice.h 第 259 行定义.

{
    while (l->next) l = l->next;
 
    return l;
}

引用了 rt_slist_node::next.

◆ rt_slist_next()

rt_inline rt_slist_t * rt_slist_next ( rt_slist_t * n )

在文件 rtservice.h 第 266 行定义.

{
    return n->next;
}

引用了 rt_slist_node::next.

◆ rt_slist_isempty()

rt_inline int rt_slist_isempty ( rt_slist_t * l )

在文件 rtservice.h 第 271 行定义.

{
    return l->next == RT_NULL;
}

引用了 rt_slist_node::next , 以及 RT_NULL.

◆ __rt_ffsl()

unsigned long __rt_ffsl ( unsigned long value )

◆ __rt_clz()

unsigned long __rt_clz ( unsigned long value )

◆ rt_in_thread_context()

rt_inline rt_bool_t rt_in_thread_context ( void )

在文件 rtthread.h 第 871 行定义.

{
    return rt_thread_self() != RT_NULL && rt_interrupt_get_nest() == 0;
}

引用了 rt_interrupt_get_nest(), RT_NULL , 以及 rt_thread_self().

函数调用图:

这是这个函数的调用关系图:

◆ rt_scheduler_is_available()

rt_inline rt_bool_t rt_scheduler_is_available ( void )

在文件 rtthread.h 第 877 行定义.

{
    return rt_critical_level() == 0 && rt_in_thread_context();
}

引用了 rt_critical_level() , 以及 rt_in_thread_context().

函数调用图:

这是这个函数的调用关系图:

变量说明

◆ __lowest_bit_bitmap

const rt_uint8_t __lowest_bit_bitmap[]

初始值:

=
{
     0, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     7, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
     4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0
}

在文件 kservice.c 第 1051 行定义.

{
    /* 00 */ 0, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 10 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 20 */ 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 30 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 40 */ 6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 50 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 60 */ 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 70 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 80 */ 7, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* 90 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* A0 */ 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* B0 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* C0 */ 6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* D0 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* E0 */ 5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
    /* F0 */ 4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0
};