RTEMS 6.1-rc1
Files | Data Structures | Typedefs | Variables
User Extensions Handler

This group contains the User Extensions Handler implementation. More...

Files

file  userext.h
 This header file provides interfaces of the User Extensions Handler which are used by the implementation and the Application Configuration.
 
file  userextdata.h
 This header file provides data structures used by the implementation and the Application Configuration to define _User_extensions_Initial_count, _User_extensions_Initial_extensions, and _User_extensions_Initial_switch_controls.
 
file  userextimpl.h
 This header file provides interfaces of the User Extensions Handler which are only used by the implementation.
 
file  userext.c
 This source file contains the implementation of _User_extensions_Handler_initialization().
 
file  userextaddset.c
 This source file contains the implementation of _User_extensions_Add_set().
 
file  userextiterate.c
 This source file contains the definition of _User_extensions_List and the implementation of _User_extensions_Fatal_visitor(), _User_extensions_Iterate(), _User_extensions_Thread_begin_visitor(), _User_extensions_Thread_create_visitor(), _User_extensions_Thread_delete_visitor(), _User_extensions_Thread_exitted_visitor(), _User_extensions_Thread_restart_visitor(), _User_extensions_Thread_start_visitor(), and _User_extensions_Thread_terminate_visitor().
 
file  userextremoveset.c
 This source file contains the implementation of _User_extensions_Remove_set().
 

Data Structures

struct  User_extensions_Table
 User extension table. More...
 
struct  User_extensions_Switch_control
 Manages the switch callouts. More...
 
struct  User_extensions_Control
 Manages each user extension set. More...
 
struct  User_extensions_Iterator
 Chain iterator for dynamic user extensions. More...
 
struct  User_extensions_List
 
struct  User_extensions_Thread_create_context
 
struct  User_extensions_Fatal_context
 

Typedefs

typedef bool(* User_extensions_thread_create_extension) (struct _Thread_Control *executing, struct _Thread_Control *created)
 Task create extension. More...
 
typedef void(* User_extensions_thread_delete_extension) (struct _Thread_Control *executing, struct _Thread_Control *deleted)
 Task delete extension. More...
 
typedef void(* User_extensions_thread_start_extension) (struct _Thread_Control *executing, struct _Thread_Control *started)
 Task start extension. More...
 
typedef void(* User_extensions_thread_restart_extension) (struct _Thread_Control *executing, struct _Thread_Control *restarted)
 Task restart extension. More...
 
typedef void(* User_extensions_thread_switch_extension) (struct _Thread_Control *executing, struct _Thread_Control *heir)
 Task switch extension. More...
 
typedef void(* User_extensions_thread_begin_extension) (struct _Thread_Control *executing)
 Task begin extension. More...
 
typedef void(* User_extensions_thread_exitted_extension) (struct _Thread_Control *executing)
 Task exitted extension. More...
 
typedef void(* User_extensions_fatal_extension) (Internal_errors_Source source, bool always_set_to_false, Internal_errors_t code)
 Fatal error extension. More...
 
typedef void(* User_extensions_thread_terminate_extension) (struct _Thread_Control *terminated)
 Task termination extension. More...
 
typedef struct User_extensions_Iterator User_extensions_Iterator
 Chain iterator for dynamic user extensions. More...
 

Variables

const size_t _User_extensions_Initial_count
 The count of initial user extensions. More...
 
const User_extensions_Table _User_extensions_Initial_extensions []
 The table of initial user extensions. More...
 
User_extensions_Switch_control _User_extensions_Initial_switch_controls []
 A spare switch control for each initial user extension. More...
 
User_extensions_List _User_extensions_List
 List of active extensions.
 
Chain_Control _User_extensions_Switches_list
 List of active task switch extensions.
 

Extension Maintainance

typedef void(* User_extensions_Visitor) (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 User extension visitor. More...
 
void _User_extensions_Handler_initialization (void)
 Initializes the user extensions handler.
 
void _User_extensions_Add_set (User_extensions_Control *extension)
 Adds a user extension. More...
 
void _User_extensions_Remove_set (User_extensions_Control *extension)
 Removes a user extension. More...
 
void _User_extensions_Thread_create_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Creates a visitor. More...
 
void _User_extensions_Thread_delete_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Deletes a visitor. More...
 
void _User_extensions_Thread_start_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Starts a visitor. More...
 
void _User_extensions_Thread_restart_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Restarts a visitor. More...
 
void _User_extensions_Thread_begin_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Calls the begin function of the thread callout for the visitor. More...
 
void _User_extensions_Thread_exitted_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Calls the exitted function of the thread callout for the visitor. More...
 
void _User_extensions_Fatal_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Calls the fatal function of the thread callout for the visitor. More...
 
void _User_extensions_Thread_terminate_visitor (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)
 Terminates a visitor. More...
 
void _User_extensions_Iterate (void *arg, User_extensions_Visitor visitor, Chain_Iterator_direction direction)
 Iterates through all user extensions and calls the visitor for each. More...
 

Detailed Description

This group contains the User Extensions Handler implementation.

This handler provides the invocation of application dependent routines at critical points in the life of each thread and the system as a whole.

Typedef Documentation

◆ User_extensions_fatal_extension

typedef void(* User_extensions_fatal_extension) (Internal_errors_Source source, bool always_set_to_false, Internal_errors_t code)

Fatal error extension.

It corresponds to _Terminate() (used by the rtems_fatal() directive).

This extension should not call any RTEMS directives.

Parameters
[in]sourceThe fatal source indicating the subsystem the fatal condition originated in.
[in]always_set_to_falseThis parameter is always set to false and provided only for backward compatibility reasons.
[in]codeThe fatal error code. This value must be interpreted with respect to the source.

◆ User_extensions_Iterator

Chain iterator for dynamic user extensions.

Since user extensions may delete or restart the executing thread, we must clean up registered iterators.

See also
_User_extensions_Iterate(), _User_extensions_Destroy_iterators() and Thread_Control::last_user_extensions_iterator.

◆ User_extensions_thread_begin_extension

typedef void(* User_extensions_thread_begin_extension) (struct _Thread_Control *executing)

Task begin extension.

It corresponds to _Thread_Handler().

Thread dispatching is disabled. The executing thread is not the holder of the allocator mutex.

Parameters
[in]executingThe executing thread.

◆ User_extensions_thread_create_extension

typedef bool(* User_extensions_thread_create_extension) (struct _Thread_Control *executing, struct _Thread_Control *created)

Task create extension.

It corresponds to _Thread_Initialize() (used by the rtems_task_create() directive and pthread_create()).

It is invoked after the new thread has been completely initialized, but before it is placed on a ready chain.

Thread dispatching may be disabled. This depends on the context of the _Thread_Initialize() call. Thread dispatch is disabled during the creation of the idle thread and the initialization threads. It can be considered as an invalid API usage, if the application calls _Thread_Initialize() with disabled thread dispatching. Disabled thread dispatching is different from disabled preemption.

It can be assumed that the executing thread locked the allocator mutex. The only exception is the creation of the idle thread. In this case the allocator mutex is not locked. Since the allocator mutex allows nesting the normal memory allocation routines can be used.

Parameters
[in]executingThe executing thread.
[in]createdThe created thread.
Return values
trueSuccessful operation.
falseA thread create user extension will frequently attempt to allocate resources. If this allocation fails, then the extension should return false and the entire thread create operation will fail.

◆ User_extensions_thread_delete_extension

typedef void(* User_extensions_thread_delete_extension) (struct _Thread_Control *executing, struct _Thread_Control *deleted)

Task delete extension.

It corresponds to _Thread_Close() (used by the rtems_task_delete() directive, pthread_exit() and pthread_cancel()).

It is invoked before all resources of the thread are deleted. The executing and deleted arguments are never equal.

Thread dispatching is enabled. The executing thread locked the allocator mutex.

Parameters
[in]executingThe executing thread.
[in]deletedThe deleted thread.

◆ User_extensions_thread_exitted_extension

typedef void(* User_extensions_thread_exitted_extension) (struct _Thread_Control *executing)

Task exitted extension.

It corresponds to _Thread_Handler() after a return of the entry function.

Thread dispatching is disabled. The state of the allocator mutex is arbitrary.

Parameters
[in]executingThe executing thread.

◆ User_extensions_thread_restart_extension

typedef void(* User_extensions_thread_restart_extension) (struct _Thread_Control *executing, struct _Thread_Control *restarted)

Task restart extension.

It corresponds to _Thread_Restart() (used by the rtems_task_restart() directive).

It is invoked in the context of the restarted thread right before the execution context is reloaded. The executing and restarted arguments are always equal. The thread stack reflects the previous execution context.

Thread dispatching is enabled. The thread is not the holder of the allocator mutex. The thread life is protected. Thread restart and delete requests issued by restart extensions lead to recursion.

Parameters
[in]executingThe executing thread.
[in]restartedThe executing thread. Yes, the executing thread.

◆ User_extensions_thread_start_extension

typedef void(* User_extensions_thread_start_extension) (struct _Thread_Control *executing, struct _Thread_Control *started)

Task start extension.

It corresponds to _Thread_Start() (used by the rtems_task_start() directive).

It is invoked after the environment of the thread has been loaded and the thread has been made ready.

Thread dispatching is disabled. The executing thread is not the holder of the allocator mutex.

Parameters
[in]executingThe executing thread.
[in]startedThe started thread.

◆ User_extensions_thread_switch_extension

typedef void(* User_extensions_thread_switch_extension) (struct _Thread_Control *executing, struct _Thread_Control *heir)

Task switch extension.

It corresponds to _Thread_Dispatch().

It is invoked before the context switch from the executing to the heir thread.

Thread dispatching is disabled. The state of the allocator mutex is arbitrary. Interrupts are disabled and the per-CPU lock is acquired on SMP configurations.

The context switches initiated through _Thread_Start_multitasking() are not covered by this extension.

Parameters
[in]executingThe executing thread.
[in]heirThe heir thread.

◆ User_extensions_thread_terminate_extension

typedef void(* User_extensions_thread_terminate_extension) (struct _Thread_Control *terminated)

Task termination extension.

This extension is invoked by _Thread_Life_action_handler() in case a termination request is recognized.

It is invoked in the context of the terminated thread right before the thread dispatch to the heir thread. The POSIX cleanup and key destructors execute in this context.

Thread dispatching is enabled. The thread is not the holder of the allocator mutex. The thread life is protected. Thread restart and delete requests issued by terminate extensions lead to recursion.

Parameters
[in]terminatedThe terminated thread.

◆ User_extensions_Visitor

typedef void(* User_extensions_Visitor) (Thread_Control *executing, void *arg, const User_extensions_Table *callouts)

User extension visitor.

Parameters
[in,out]executingThe currently executing thread.
[in,out]argThe argument passed to _User_extensions_Iterate().
[in]calloutsThe current callouts.

Function Documentation

◆ _User_extensions_Add_set()

void _User_extensions_Add_set ( User_extensions_Control extension)

Adds a user extension.

Parameters
extensionThe user extension to add.

◆ _User_extensions_Fatal_visitor()

void _User_extensions_Fatal_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Calls the fatal function of the thread callout for the visitor.

Parameters
executingThe currently executing thread.
argIs used as the user extension fatal context.
calloutsThe user extension table for the operation.

◆ _User_extensions_Iterate()

void _User_extensions_Iterate ( void *  arg,
User_extensions_Visitor  visitor,
Chain_Iterator_direction  direction 
)

Iterates through all user extensions and calls the visitor for each.

Parameters
[in,out]argThe argument passed to the visitor.
visitorThe visitor for each extension.
directionThe iteration direction for dynamic extensions.

◆ _User_extensions_Remove_set()

void _User_extensions_Remove_set ( User_extensions_Control extension)

Removes a user extension.

Parameters
extensionThe user extension to remove.

◆ _User_extensions_Thread_begin_visitor()

void _User_extensions_Thread_begin_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Calls the begin function of the thread callout for the visitor.

Parameters
executingThe currently executing thread.
argThis parameter is unused.
calloutsThe user extension table for the operation.

◆ _User_extensions_Thread_create_visitor()

void _User_extensions_Thread_create_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Creates a visitor.

Parameters
executingThe currently executing thread.
[in,out]argIs used as the thread create context for the operation.
calloutsThe user extension table for the operation.

◆ _User_extensions_Thread_delete_visitor()

void _User_extensions_Thread_delete_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Deletes a visitor.

Parameters
executingThe currently executing thread.
[in,out]argParameter for the callout.
calloutsThe user extension table for the operation.

◆ _User_extensions_Thread_exitted_visitor()

void _User_extensions_Thread_exitted_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Calls the exitted function of the thread callout for the visitor.

Parameters
executingThe currently executing thread.
argThis parameter is unused.
calloutsThe user extension table for the operation.

◆ _User_extensions_Thread_restart_visitor()

void _User_extensions_Thread_restart_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Restarts a visitor.

Parameters
executingThe currently executing thread.
argParameter for the callout.
calloutsThe user extension table for the operation.

◆ _User_extensions_Thread_start_visitor()

void _User_extensions_Thread_start_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Starts a visitor.

Parameters
executingThe currently executing thread.
argParameter for the callout.
calloutsThe user extension table for the operation.

◆ _User_extensions_Thread_terminate_visitor()

void _User_extensions_Thread_terminate_visitor ( Thread_Control executing,
void *  arg,
const User_extensions_Table callouts 
)

Terminates a visitor.

Parameters
executingThe currently executing thread.
argThis parameter is unused.
calloutsThe user extension table for the operation.

Variable Documentation

◆ _User_extensions_Initial_count

const size_t _User_extensions_Initial_count
extern

The count of initial user extensions.

Application provided via <rtems/confdefs.h>.

◆ _User_extensions_Initial_extensions

const User_extensions_Table _User_extensions_Initial_extensions[]
extern

The table of initial user extensions.

Application provided via <rtems/confdefs.h>.

◆ _User_extensions_Initial_switch_controls

User_extensions_Switch_control _User_extensions_Initial_switch_controls[]
extern

A spare switch control for each initial user extension.

Application provided via <rtems/confdefs.h>.