A process in Contiki consists of a single protothread.
More...
|
file | process.c |
| Implementation of the Contiki process kernel.
|
|
file | process.h |
| Header file for the Contiki process interface.
|
|
A process in Contiki consists of a single protothread.
◆ PROCESS
#define PROCESS |
( |
|
name, |
|
|
|
strname |
|
) |
| |
Declare a process.
This macro declares a process. The process has two names: the variable of the process structure, which is used by the C program, and a human readable string name, which is used when debugging. A configuration option allows removal of the readable name to save RAM.
- Parameters
-
name | The variable name of the process structure. |
strname | The string representation of the process' name. |
Definition at line 307 of file process.h.
◆ PROCESS_BEGIN
#define PROCESS_BEGIN |
( |
| ) |
|
Define the beginning of a process.
This macro defines the beginning of a process, and must always appear in a PROCESS_THREAD() definition. The PROCESS_END() macro must come at the end of the process.
Definition at line 120 of file process.h.
◆ PROCESS_CONTEXT_BEGIN
#define PROCESS_CONTEXT_BEGIN |
( |
|
p | ) |
|
Value:{\
process_current = p
#define PROCESS_CURRENT()
Get a pointer to the currently running process.
Switch context to another process.
This function switch context to the specified process and executes the code as if run by that process. Typical use of this function is to switch context in services, called by other processes. Each PROCESS_CONTEXT_BEGIN() must be followed by the PROCESS_CONTEXT_END() macro to end the context switch.
Example:
- Parameters
-
p | The process to use as context |
- See also
- PROCESS_CONTEXT_END()
-
PROCESS_CURRENT()
Definition at line 426 of file process.h.
◆ PROCESS_CONTEXT_END
#define PROCESS_CONTEXT_END |
( |
|
p | ) |
process_current = tmp_current; } |
End a context switch.
This function ends a context switch and changes back to the previous process.
- Parameters
-
p | The process used in the context switch |
- See also
- PROCESS_CONTEXT_START()
Definition at line 440 of file process.h.
◆ PROCESS_CURRENT
#define PROCESS_CURRENT |
( |
| ) |
|
Get a pointer to the currently running process.
This macro get a pointer to the currently running process. Typically, this macro is used to post an event to the current process with process_post().
Definition at line 402 of file process.h.
◆ PROCESS_END
Define the end of a process.
This macro defines the end of a process. It must appear in a PROCESS_THREAD() definition and must always be included. The process exits when the PROCESS_END() macro is reached.
Definition at line 131 of file process.h.
◆ PROCESS_ERR_FULL
#define PROCESS_ERR_FULL 1 |
Return value indicating that the event queue was full.
This value is returned from process_post() to indicate that the event queue was full and that an event could not be posted.
Definition at line 82 of file process.h.
◆ PROCESS_ERR_OK
Return value indicating that an operation was successful.
This value is returned to indicate that an operation was successful.
Definition at line 74 of file process.h.
◆ PROCESS_EXITHANDLER
#define PROCESS_EXITHANDLER |
( |
|
handler | ) |
|
Specify an action when a process exits.
- Note
- This declaration must come immediately before the PROCESS_BEGIN() macro.
- Parameters
-
handler | The action to be performed. |
Definition at line 254 of file process.h.
◆ PROCESS_NAME
#define PROCESS_NAME |
( |
|
name | ) |
|
Declare the name of a process.
This macro is typically used in header files to declare the name of a process that is implemented in the C file.
Definition at line 286 of file process.h.
◆ PROCESS_PAUSE
#define PROCESS_PAUSE |
( |
| ) |
|
Yield the process for a short while.
This macro yields the currently running process for a short while, thus letting other processes run before the process continues.
Definition at line 221 of file process.h.
◆ PROCESS_POLLHANDLER
#define PROCESS_POLLHANDLER |
( |
|
handler | ) |
|
Specify an action when a process is polled.
- Note
- This declaration must come immediately before the PROCESS_BEGIN() macro.
- Parameters
-
handler | The action to be performed. |
Definition at line 242 of file process.h.
◆ PROCESS_PT_SPAWN
#define PROCESS_PT_SPAWN |
( |
|
pt, |
|
|
|
thread |
|
) |
| |
Spawn a protothread from the process.
- Parameters
-
pt | The protothread state (struct pt) for the new protothread |
thread | The call to the protothread function. |
- See also
- PT_SPAWN()
Definition at line 211 of file process.h.
◆ PROCESS_THREAD
#define PROCESS_THREAD |
( |
|
name, |
|
|
|
ev, |
|
|
|
data |
|
) |
| |
Define the body of a process.
This macro is used to define the body (protothread) of a process. The process is called whenever an event occurs in the system, A process always start with the PROCESS_BEGIN() macro and end with the PROCESS_END() macro.
Definition at line 273 of file process.h.
◆ PROCESS_WAIT_EVENT
#define PROCESS_WAIT_EVENT |
( |
| ) |
|
Wait for an event to be posted to the process.
This macro blocks the currently running process until the process receives an event.
Definition at line 141 of file process.h.
◆ PROCESS_WAIT_EVENT_UNTIL
#define PROCESS_WAIT_EVENT_UNTIL |
( |
|
c | ) |
|
Wait for an event to be posted to the process, with an extra condition.
This macro is similar to PROCESS_WAIT_EVENT() in that it blocks the currently running process until the process receives an event. But PROCESS_WAIT_EVENT_UNTIL() takes an extra condition which must be true for the process to continue.
- Parameters
-
c | The condition that must be true for the process to continue. |
- See also
- PT_WAIT_UNTIL()
Definition at line 157 of file process.h.
◆ PROCESS_WAIT_UNTIL
#define PROCESS_WAIT_UNTIL |
( |
|
c | ) |
|
◆ PROCESS_YIELD_UNTIL
#define PROCESS_YIELD_UNTIL |
( |
|
c | ) |
|
Yield the currently running process until a condition occurs.
This macro is different from PROCESS_WAIT_UNTIL() in that PROCESS_YIELD_UNTIL() is guaranteed to always yield at least once. This ensures that the process does not end up in an infinite loop and monopolizing the CPU.
- Parameters
-
c | The condition to wait for. |
Definition at line 178 of file process.h.
◆ process_alloc_event()
process_event_t process_alloc_event |
( |
void |
| ) |
|
Allocate a global event number.
- Returns
- The allocated event number
In Contiki, event numbers above 128 are global and may
be posted from one process to another. This function
allocates one such event number.
- Note
- There currently is no way to deallocate an allocated event number.
Definition at line 93 of file process.c.
Referenced by button_hal_init().
◆ process_exit()
void process_exit |
( |
struct process * |
p | ) |
|
Cause a process to exit.
- Parameters
-
p | The process that is to be exited This function causes a process to exit. The process can
either be the currently executing process, or another
process that is currently running.
|
- See also
- PROCESS_CURRENT()
Definition at line 202 of file process.c.
Referenced by rf_ble_beacond_stop().
◆ process_init()
void process_init |
( |
void |
| ) |
|
Initialize the process module.
This function initializes the process module and should be called by the system boot-up code.
Definition at line 208 of file process.c.
◆ process_is_running()
int process_is_running |
( |
struct process * |
p | ) |
|
Check if a process is running.
This function checks if a specific process is running.
- Parameters
-
- Return values
-
Non-zero | if the process is running. |
Zero | if the process is not running. |
Definition at line 383 of file process.c.
◆ process_nevents()
int process_nevents |
( |
void |
| ) |
|
Number of events waiting to be processed.
- Returns
- The number of events that are currently waiting to be processed.
Definition at line 316 of file process.c.
Referenced by platform_main_loop().
◆ process_poll()
void process_poll |
( |
struct process * |
p | ) |
|
Request a process to be polled.
This function typically is called from an interrupt handler to cause a process to be polled.
- Parameters
-
p | A pointer to the process' process structure. |
Definition at line 371 of file process.c.
Referenced by etimer_request_poll().
◆ process_post()
int process_post |
( |
struct process * |
p, |
|
|
process_event_t |
ev, |
|
|
process_data_t |
data |
|
) |
| |
Post an asynchronous event.
This function posts an asynchronous event to one or more processes. The handing of the event is deferred until the target process is scheduled by the kernel. An event can be broadcast to all processes, in which case all processes in the system will be scheduled to handle the event.
- Parameters
-
ev | The event to be posted. |
data | The auxiliary data to be sent with the event |
p | The process to which the event should be posted, or PROCESS_BROADCAST if the event should be posted to all processes. |
- Return values
-
PROCESS_ERR_OK | The event could be posted. |
PROCESS_ERR_FULL | The event queue was full and the event could not be posted. |
Definition at line 322 of file process.c.
◆ process_post_synch()
void process_post_synch |
( |
struct process * |
p, |
|
|
process_event_t |
ev, |
|
|
process_data_t |
data |
|
) |
| |
Post a synchronous event to a process.
- Parameters
-
p | A pointer to the process' process structure. |
ev | The event to be posted. |
data | A pointer to additional data that is posted together with the event. |
Definition at line 362 of file process.c.
◆ process_run()
Run the system once - call poll handlers and process one event.
This function should be called repeatedly from the main() program to actually run the Contiki system. It calls the necessary poll handlers, and processes one event. The function returns the number of events that are waiting in the event queue so that the caller may choose to put the CPU to sleep when there are no pending events.
- Returns
- The number of events that are currently waiting in the event queue.
Definition at line 302 of file process.c.
Referenced by platform_main_loop().
◆ process_start()
void process_start |
( |
struct process * |
p, |
|
|
process_data_t |
data |
|
) |
| |