NuttX Operating System |
1.0 Introduction |
This manual provides general usage information for the NuttX RTOS from the perspective of the firmware developer.
1.1 Document Overview |
This user's manual is divided into three sections plus a index:
errno Variable 1.2 Intended Audience and Scope |
The intended audience for this document are firmware developers who are implementing applications on NuttX. Specifically, this documented is limited to addressing only NuttX RTOS APIs that are available to the application developer. As such, this document does not focus on any technical details of the organization or implementation of NuttX. Those technical details are provided in the NuttX Porting Guide.
Information about configuring and building NuttX is also needed by the application developer. That information can also be found in the NuttX Porting Guide.
2.0 OS Interfaces |
This section describes each C-callable interface to the NuttX Operating System. The description of each interface is presented in the following format:
Function Prototype: The C prototype of the interface function is provided.
Description: The operation performed by the interface function is discussed.
Input Parameters: All input parameters are listed along with brief descriptions of each input parameter.
Returned Value: All possible values returned by the interface function are listed. Values returned as side-effects (through pointer input parameters or through global variables) will be addressed in the description of the interface function.
Assumptions/Limitations: Any unusual assumptions made by the interface function or any non-obvious limitations to the use of the interface function will be indicated here.
POSIX Compatibility: Any significant differences between the NuttX interface and its corresponding POSIX interface will be noted here.
NOTE: In order to achieve an independent name space for the NuttX interface functions, differences in function names and types are to be expected and will not be identified as differences in these paragraphs.
2.1 Task Control Interfaces |
Tasks. NuttX is a flat address OS. As such it does not support processes in the way that, say, Linux does. NuttX only supports simple threads running within the same address space. However, the programming model makes a distinction between tasks and pthreads:
File Descriptors and Streams. This applies, in particular, in the area of opened file descriptors and streams. When a task is started using the interfaces in this section, it will be created with at most three open files.
If CONFIG_DEV_CONSOLE is defined, the first three file descriptors (corresponding to stdin, stdout, stderr) will be duplicated for the new task. Since these file descriptors are duplicated, the child task can free close them or manipulate them in any way without effecting the parent task. File-related operations (open, close, etc.) within a task will have no effect on other tasks. Since the three file descriptors are duplicated, it is also possible to perform some level of redirection.pthreads, on the other hand, will always share file descriptors with the parent thread. In this case, file operations will have effect only all pthreads the were started from the same parent thread.
Executing Programs within a File System. NuttX also provides internal interfaces for the execution of separately built programs that reside in a file system. These internal interfaces are, however, non-standard and are documented with the NuttX binary loader and NXFLAT.
Task Control Interfaces. The following task control interfaces are provided by NuttX:
Non-standard task control interfaces inspired by VxWorks interfaces:
Non-standard extensions to VxWorks-like interfaces to support POSIX Cancellation Points.
Standard interfaces
Standard vfork and exec[v|l] interfaces:
Standard posix_spawn interfaces:
Non-standard task control interfaces inspired by posix_spawn:
Function Prototype:
#include <sched.h> int task_create(char *name, int priority, int stack_size, main_t entry, char * const argv[]);
Description: This function creates and activates a new task with a specified priority and returns its system-assigned ID.
The entry address entry is the address of the "main" function of the task. This function will be called once the C environment has been set up. The specified function will be called with four arguments. Should the specified routine return, a call to exit() will automatically be made.
Note that an arbitrary number of arguments may be passed to the spawned functions.
The arguments are copied (via strdup) so that the life of the passed strings is not dependent on the life of the caller to task_create().
The newly created task does not inherit scheduler characteristics from the parent task: The new task is started at the default system priority and with the SCHED_FIFO scheduling policy. These characteristics may be modified after the new task has been started.
The newly created task does inherit the first three file descriptors (corresponding to stdin, stdout, and stderr) and redirection of standard I/O is supported.
Input Parameters:
name. Name of the new taskpriority. Priority of the new taskstack_size. size (in bytes) of the stack neededentry. Entry point of a new taskargv. A pointer to an array of input parameters. The array should be terminated with a NULL argv[] value. If no parameters are required, argv may be NULL. Returned Value:
errno is not set). Assumptions/Limitations:
POSIX Compatibility: This is a NON-POSIX interface. VxWorks provides the following similar interface:
int taskSpawn(char *name, int priority, int options, int stackSize, FUNCPTR entryPt,
int arg1, int arg2, int arg3, int arg4, int arg5,
int arg6, int arg7, int arg8, int arg9, int arg10);
The NuttX task_create() differs from VxWorks' taskSpawn() in the following ways:
Function Prototype:
#include <sched.h>
int task_init(struct tcb_s *tcb, char *name, int priority, uint32_t *stack, uint32_t stack_size,
maint_t entry, char * const argv[]);
Description:
This function initializes a Task Control Block (TCB) in preparation for starting a new thread. It performs a subset of the functionality of task_create() (see above).
Unlike task_create(), task_init() does not activate the task. This must be done by calling task_activate().
Input Parameters:
tcb. Address of the new task's TCB name. Name of the new task (not used) priority. Priority of the new task stack. Start of the pre-allocated stack stack_size. size (in bytes) of the pre-allocated stack entry. Entry point of a new task argv. A pointer to an array of input parameters. The array should be terminated with a NULL argv[] value. If no parameters are required, argv may be NULL. Returned Value:
OK, or ERROR if the task cannot be initialized.
This function can only failure is it is unable to assign a new, unique task ID to the TCB (errno is not set).
Assumptions/Limitations:
POSIX Compatibility: This is a NON-POSIX interface. VxWorks provides the following similar interface:
STATUS taskInit(WIND_TCB *pTcb, char *name, int priority, int options, uint32_t *pStackBase, int stackSize,
FUNCPTR entryPt, int arg1, int arg2, int arg3, int arg4, int arg5,
int arg6, int arg7, int arg8, int arg9, int arg10);
The NuttX task_init() differs from VxWorks' taskInit() in the following ways:
Function Prototype:
#include <sched.h>
int task_activate(struct tcb_s *tcb);
Description: This function activates tasks created by task_init(). Without activation, a task is ineligible for execution by the scheduler.
Input Parameters:
tcb. The TCB for the task for the task (same as the task_init argument). Returned Value:
errno is not set). Assumptions/Limitations:
POSIX Compatibility: This is a NON-POSIX interface. VxWorks provides the following similar interface:
STATUS taskActivate(int tid);
The NuttX task_activate() differs from VxWorks' taskActivate() in the following ways:
Function Prototype:
#include <sched.h> int task_delete(pid_t pid);
Description: This function causes a specified task to cease to exist. Its stack and TCB will be deallocated. This function is the companion to task_create(). This is the version of the function exposed to the user; it is simply a wrapper around the internal, nxtask_terminate() function.
The logic in this function only deletes non-running tasks. If the pid parameter refers to the currently running task, then processing is redirected to exit(). This can only happen if a task calls task_delete() in order to delete itself.
This function obeys the semantics of pthread cancellation: task deletion is deferred if cancellation is disabled or if deferred cancellation is supported (with Cancellation Points enabled).
Input Parameters:
pid. The task ID of the task to delete. An ID of zero signifies the calling task. Any attempt by the calling task will be automatically re-directed to exit(). Returned Value:
OK, or ERROR if the task cannot be deleted. The errno is set to indicate the nature of the failure. This function can fail, for example, if the provided pid does not correspond to a currently executing task. Assumptions/Limitations:
task_delete() must be used with caution: If the task holds resources (for example, allocated memory or semaphores needed by other tasks), then task_delete() can strand those resources.
POSIX Compatibility: This is a NON-POSIX interface. VxWorks provides the following similar interface:
STATUS taskDelete(int tid);
The NuttX task_delete() differs from VxWorks' taskDelete() in the following ways:
taskDeleteHookAdd() is not supported). However, if atexit() or on_exit support is enabled, those will be called when the task deleted. task_delete() will re-direct processing to exit(). Function Prototype:
#include <sched.h> int task_restart(pid_t pid);
Description: This function "restarts" a task. The task is first terminated and then reinitialized with same ID, priority, original entry point, stack size, and parameters it had when it was first started.
NOTES:
Input Parameters:
pid. The task ID of the task to delete. An ID of zero would signify the calling task (However, support for a task to restart itself has not been implemented). Returned Value:
Assumptions/Limitations:
POSIX Compatibility: This is a NON-POSIX interface. VxWorks provides the following similar interface:
STATUS taskRestart (int tid);
The NuttX task_restart() differs from VxWorks' taskRestart() in the following ways:
Function Prototype:
#include <sched.h>
int task_setcancelstate(int state, int *oldstate);
Description: The task_setcancelstate() function atomically sets both the calling task's cancellability state to the indicated state and returns the previous cancellability state at the location referenced by oldstate. Legal values for state are TASK_CANCEL_ENABLE and TASK_CANCEL_DISABLE.
Any pending thread cancellation may occur at the time that the cancellation state is set to TASK_CANCEL_ENABLE.
The cancellability state and type of any newly created tasks are TASK_CANCEL_ENABLE and TASK_CANCEL_DEFERRED respectively.
Input Parameters:
state New cancellation state. One of PTHREAD_CANCEL_ENABLE or PTHREAD_CANCEL_DISABLE.oldstate. Location to return the previous cancellation state. Returned Value:
Zero (OK) on success; ERROR is returned on any failure with the errno value set appropriately:
ESRCH. No thread could be found corresponding to that specified by the given thread ID. POSIX Compatibility: This is a non-standard interface. It extends the functionality of pthread_setcancelstate() to tasks and supports use of task_delete().
Function Prototype:
#include <sched.h>
int task_setcanceltype(int type, FAR int *oldtype);
Description: The task_setcanceltype() function atomically both sets the calling task's cancellability type to the indicated type and returns the previous cancellability type at the location referenced by oldtype. Legal values for type are TASK_CANCEL_DEFERRED and TASK_CANCEL_ASYNCHRONOUS.
The cancellability state and type of any newly created tasks are TASK_CANCEL_ENABLE and TASK_CANCEL_DEFERRED respectively.
Input Parameters:
type New cancellation state. One of PTHREAD_CANCEL_DEFERRED or PTHREAD_CANCEL_ASYNCHRONOUS.oldtype. Location to return the previous cancellation type. Returned Value:
Zero (OK) on success; ERROR is returned on any failure with the errno value set appropriately:
ESRCH. No thread could be found corresponding to that specified by the given thread ID. POSIX Compatibility: This is a non-standard interface. It extends the functionality of pthread_setcanceltype() to tasks and supports use of task_delete().
Function Prototype:
#include <sched.h>
void task_testcancel(void);
Description:
The task_testcancel() function creates a Cancellation Point in the calling task. The task_testcancel() function has no effect if cancellability is disabled.
Input Parameters: None
Returned Value: None
POSIX Compatibility: This is a non-standard interface. It extends the functionality of pthread_testcancel() to tasks and supports use of task_delete().
Function Prototype:
#include <sched.h>
void exit(int code);
#include <nuttx/unistd.h>
void _exit(int code);
Description: This function causes the calling task to cease to exist -- its stack and TCB will be deallocated. exit differs from _exit in that it flushes streams, closes file descriptors and will execute any function registered with atexit() or on_exit().
Input Parameters:
code. (ignored) Returned Value: None.
Assumptions/Limitations:
POSIX Compatibility: This is equivalent to the ANSI interface:
void exit(int code);
And the UNIX interface:
void _exit(int code);
The NuttX exit() differs from ANSI exit() in the following ways:
code parameter is ignored. Function Prototype:
#include <unistd.h>
pid_t getpid(void);
Description: This function returns the task ID of the calling task. The task ID will be invalid if called at the interrupt level.
Input Parameters: None.
Returned Value:
Assumptions/Limitations:
POSIX Compatibility: Compatible with the POSIX interface of the same name.
Function Prototype:
#include <unistd.h> pid_t vfork(void);
Description: The vfork() function has the same effect as fork(), except that the behavior is undefined if the process created by vfork() either modifies any data other than a variable of type pid_t used to store the return value from vfork(), or returns from the function in which vfork() was called, or calls any other function before successfully calling _exit() or one of the exec family of functions.
NOTE:vfork()is not an independent NuttX feature, but is implemented in architecture-specific logic (using only helper functions from the NuttX core logic). As a result,vfork()may not be available on all architectures.
Input Parameters: None.
Returned Value: Upon successful completion, vfork() returns 0 to the child process and returns the process ID of the child process to the parent process. Otherwise, -1 is returned to the parent, no child process is created, and errno is set to indicate the error.
Assumptions/Limitations:
POSIX Compatibility: Compatible with the BSD/Linux interface of the same name. POSIX marks this interface as Obsolete.
Function Prototype:
#include <nuttx/binfmt/binfmt.h>
#ifndef CONFIG_BUILD_KERNEL
int exec(FAR const char *filename, FAR char * const *argv,
FAR const struct symtab_s *exports, int nexports);
#endif
Description: This non-standard, NuttX function is similar to execv() and posix_spawn() but differs in the following ways;
execv() and posix_spawn() this function accepts symbol table information as input parameters. This means that the symbol table used to link the application prior to execution is provided by the caller, not by the system. execv(), this function always returns. This non-standard interface is included as a official NuttX API only because it is needed in certain build modes: exec() is probably the only want to load programs in the PROTECTED mode. Other file execution APIs rely on a symbol table provided by the OS. In the PROTECTED build mode, the OS cannot provide any meaningful symbolic information for execution of code in the user-space blob so that is the exec() function is really needed in that build case
apps/ that that generate their own symbol tables for linking test programs. So although it is not necessary, it can still be useful. The interface would be completely useless and will not be supported in the KERNEL build mode where the contrary is true: An application process cannot provide any meaning symbolic information for use in linking a different process.
NOTE: This function is flawed and useless without CONFIG_SCHED_ONEXIT and CONFIG_SCHED_HAVE_PARENT because without those features there is then no mechanism to unload the module once it exits.
filename: The path to the program to be executed. If CONFIG_LIB_ENVPATH is defined in the configuration, then this may be a relative path from the current working directory. Otherwise, path must be the absolute path to the program. argv: A pointer to an array of string arguments. The end of the array is indicated with a NULL entry. exports: The address of the start of the caller-provided symbol table. This symbol table contains the addresses of symbols exported by the caller and made available for linking the module into the system. nexports: The number of symbols in the exports table. Returned Value: Zero (OK) is returned on success; On any failure, exec() will return -1 (ERROR) and will set the errno value appropriately.
Assumptions/Limitations:
POSIX Compatibility: This is a non-standard interface unique to NuttX. Motivation for inclusion of this non-standard interface in certain build modes is discussed above.
Function Prototype:
#include <unistd.h> #ifdef CONFIG_LIBC_EXECFUNCS int execv(FAR const char *path, FAR char * const argv[]); #endif
Description: The standard exec family of functions will replace the current process image with a new process image. The new image will be constructed from a regular, executable file called the new process image file. There will be no return from a successful exec, because the calling process image is overlaid by the new process image.
Simplified execl() and execv() functions are provided by NuttX for compatibility. NuttX is a tiny embedded RTOS that does not support processes and hence the concept of overlaying a tasks process image with a new process image does not make any sense. In NuttX, these functions are wrapper functions that:
binfmt function exec(), and then exit(0). Note the inefficiency when execv() or execl() is called in the normal, two-step process: (1) first call vfork() to create a new thread, then (2) call execv() or execl() to replace the new thread with a program from the file system. Since the new thread will be terminated by the execv() or execl() call, it really served no purpose other than to support POSIX compatibility.
The non-standard binfmt function exec() needs to have (1) a symbol table that provides the list of symbols exported by the base code, and (2) the number of symbols in that table. This information is currently provided to exec() from execv() or execl() via NuttX configuration settings:
CONFIG_LIBC_EXECFUNCS: Enable execv() and execl() support CONFIG_EXECFUNCS_SYMTAB_ARRAY: Name of the symbol table used by execv() or execl(). CONFIG_EXECFUNCS_NSYMBOLS_VAR: Name of the int variable holding the number of symbols in the symbol table As a result of the above, the current implementations of execl() and execv() suffer from some incompatibilities that may or may not be addressed in a future version of NuttX. Other than just being an inefficient use of MCU resource, the most serious of these is that the exec'ed task will not have the same task ID as the vfork'ed function. So the parent function cannot know the ID of the exec'ed task.
Input Parameters:
path: The path to the program to be executed. If CONFIG_LIB_ENVPATH is defined in the configuration, then this may be a relative path from the current working directory. Otherwise, path must be the absolute path to the program. argv: A pointer to an array of string arguments. The end of the array is indicated with a NULL entry. Returned Value: This function does not return on success. On failure, it will return -1 (ERROR) and will set the errno value appropriately.
Assumptions/Limitations:
POSIX Compatibility: Similar with the POSIX interface of the same name. There are, however, several compatibility issues as detailed in the description above.
Function Prototype:
#include <unistd.h> #ifdef CONFIG_LIBC_EXECFUNCS int execl(FAR const char *path, ...); #endif
Description: execl() is functionally equivalent to execv(), differing only in the form of its input parameters. See the description of execv() for additional information.
Input Parameters:
path: The path to the program to be executed. If CONFIG_LIB_ENVPATH is defined in the configuration, then this may be a relative path from the current working directory. Otherwise, path must be the absolute path to the program. ...: A list of the string arguments to be received by the program. Zero indicates the end of the list. Returned Value: This function does not return on success. On failure, it will return -1 (ERROR) and will set the errno value appropriately.
Assumptions/Limitations:
POSIX Compatibility: Similar with the POSIX interface of the same name. There are, however, several compatibility issues as detailed in the description of execv().
Function Prototype:
#include <spawn.h>
int posix_spawn(FAR pid_t *pid, FAR const char *path,
FAR const posix_spawn_file_actions_t *file_actions,
FAR const posix_spawnattr_t *attr,
FAR char * const argv[], FAR char * const envp[]);
int posix_spawnp(FAR pid_t *pid, FAR const char *file,
FAR const posix_spawn_file_actions_t *file_actions,
FAR const posix_spawnattr_t *attr,
FAR char * const argv[], FAR char * const envp[]);
Description: The posix_spawn() and posix_spawnp() functions will create a new, child task, constructed from a regular executable file.
Input Parameters:
pid: Upon successful completion, posix_spawn() and posix_spawnp() will return the task ID of the child task to the parent task, in the variable pointed to by a non-NULL pid argument. If the pid argument is a null pointer, the process ID of the child is not returned to the caller.
path or file: The path argument to posix_spawn() is the absolute path that identifies the file to execute. The file argument to posix_spawnp() may also be a relative path and will be used to construct a pathname that identifies the file to execute. In the case of a relative path, the path prefix for the file will be obtained by a search of the directories passed as the environment variable PATH.
NOTE: NuttX provides only one implementation: If CONFIG_LIB_ENVPATH is defined, then only posix_spawnp() behavior is supported; otherwise, only posix_spawn behavior is supported.
file_actions: If file_actions is a null pointer, then file descriptors open in the calling process will remain open in the child process (unless CONFIG_FDCLONE_STDIO is defined). If file_actions is not NULL, then the file descriptors open in the child process will be those open in the calling process as modified by the spawn file actions object pointed to by file_actions.
attr: If the value of the attr parameter is NULL, the all default values for the POSIX spawn attributes will be used. Otherwise, the attributes will be set according to the spawn flags. The posix_spawnattr_t spawn attributes object type is defined in spawn.h. It will contains these attributes, not all of which are supported by NuttX:
POSIX_SPAWN_SETPGROUP: Setting of the new task's process group is not supported. NuttX does not support process groups. POSIX_SPAWN_SETSCHEDPARAM: Set new tasks priority to the sched_param value. POSIX_SPAWN_SETSCHEDULER: Set the new task's scheduler policy to the sched_policy value. POSIX_SPAWN_RESETIDS Resetting of the effective user ID of the child process is not supported. NuttX does not support effective user IDs. POSIX_SPAWN_SETSIGMASK: Set the new task's signal mask. POSIX_SPAWN_SETSIGDEF: Resetting signal default actions is not supported. NuttX does not support default signal actions. argv: argv[] is the argument list for the new task. argv[] is an array of pointers to null-terminated strings. The list is terminated with a null pointer.
envp: The envp[] argument is not used by NuttX and may be NULL. In standard implementations, envp[] is an array of character pointers to null-terminated strings that provide the environment for the new process image. The environment array is terminated by a null pointer. In NuttX, the envp[] argument is ignored and the new task will inherit the environment of the parent task unconditionally.
Returned Value: posix_spawn() and posix_spawnp() will return zero on success. Otherwise, an error number will be returned as the function return value to indicate the error:
EINVAL: The value specified by file_actions or attr is invalid. vfork() and exec[l|v]() had been called. Assumptions/Limitations:
posix_spawn() or posix_spawnp() behavior depending upon the setting of CONFIG_LIB_ENVPATH: If CONFIG_LIB_ENVPATH is defined, then only posix_spawnp() behavior is supported; otherwise, only posix_spawn() behavior is supported. envp argument is not used and the environ variable is not altered (NuttX does not support the environ variable). POSIX_SPAWN_SETPGROUP above). POSIX_SPAWN_RESETIDS above). POSIX_SPAWN_SETSIGDEF). POSIX Compatibility: The value of the argv[0] received by the child task is assigned by NuttX. For the caller of posix_spawn(), the provided argv[0] will correspond to argv[1] received by the new task.
Function Prototype:
#include <spawn.h> int posix_spawn_file_actions_init(FAR posix_spawn_file_actions_t *file_actions);
Description: The posix_spawn_file_actions_init() function initializes the object referenced by file_actions to an empty set of file actions for subsequent use in a call to posix_spawn() or posix_spawnp().
Input Parameters:
file_actions: The address of the posix_spawn_file_actions_t to be initialized. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>.
Function Prototype:
#include <spawn.h> int posix_spawn_file_actions_destroy(FAR posix_spawn_file_actions_t *file_actions);
Description: The posix_spawn_file_actions_destroy() function destroys the object referenced by file_actions which was previously initialized by posix_spawn_file_actions_init(), returning any resources obtained at the time of initialization to the system for subsequent reuse. A posix_spawn_file_actions_t may be reinitialized after having been destroyed, but must not be reused after destruction, unless it has been reinitialized.
Input Parameters:
file_actions: The address of the posix_spawn_file_actions_t to be destroyed. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawn_file_actions_addclose(FAR posix_spawn_file_actions_t *file_actions, int fd);
Description: The posix_spawn_file_actions_addclose() function adds a close operation to the list of operations associated with the object referenced by file_actions, for subsequent use in a call to posix_spawn() or posix_spawnp(). The descriptor referred to by fd is closed as if close() had been called on it prior to the new child process starting execution.
Input Parameters:
file_actions: The address of the posix_spawn_file_actions_t object to which the close operation will be appended. fd: The file descriptor to be closed. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawn_file_actions_adddup2(FAR posix_spawn_file_actions_t *file_actions, int fd1, int fd2);
Description: The posix_spawn_file_actions_adddup2() function adds a dup2 operation to the list of operations associated with the object referenced by file_actions, for subsequent use in a call to posix_spawn() or posix_spawnp(). The descriptor referred to by fd2 is created as if dup2() had been called on fd1 prior to the new child process starting execution.
Input Parameters:
file_actions: The address of the posix_spawn_file_actions_t object to which the dup2 operation will be appended. fd1: The file descriptor to be be duplicated. The first file descriptor to be argument to dup2(). fd2: The file descriptor to be be created. The second file descriptor to be argument to dup2(). Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h>
int posix_spawn_file_actions_addopen(FAR posix_spawn_file_actions_t *file_actions,
int fd, FAR const char *path, int oflags, mode_t mode);
Description: The posix_spawn_file_actions_addopen() function adds an open operation to the list of operations associated with the object referenced by file_actions, for subsequent use in a call to posix_spawn() or posix_spawnp(). The descriptor referred to by fd is opened using the path, oflag, and mode arguments as if open() had been called on it prior to the new child process starting execution. The string path is copied by the posix_spawn_file_actions_addopen() function during this process, so storage need not be persistent in the caller.
Input Parameters:
file_actions: The address of the posix_spawn_file_actions_t object to which the open operation will be appended. fd: The file descriptor to be opened. path: The path to be opened. oflags: Open flags. mode: File creation mode/ Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_init(FAR posix_spawnattr_t *attr);
Description: The posix_spawnattr_init() function initializes the object referenced by attr, to an empty set of spawn attributes for subsequent use in a call to posix_spawn() or posix_spawnp().
Then the spawn attributes are no longer needed, they should be destroyed by calling posix_spawnattr_destroyed(). In NuttX, however, posix_spawnattr_destroyed() is just stub:
#define posix_spawnattr_destroy(attr) (0)
For portability, the convention of calling posix_spawnattr_destroyed() when the attributes are not longer needed should still be followed.
Input Parameters:
attr: The address of the spawn attributes to be initialized. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_getflags(FAR const posix_spawnattr_t *attr, FAR short *flags);
Description: The posix_spawnattr_getflags() function will obtain the value of the spawn-flags attribute from the attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be queried. flags: The location to return the spawn flags Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_getschedparam(FAR const posix_spawnattr_t *attr, FAR struct sched_param *param);
Description: The posix_spawnattr_getschedparam() function will obtain the value of the spawn-schedparam attribute from the attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be queried. param: The location to return the spawn-schedparam value. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_getschedpolicy(FAR const posix_spawnattr_t *attr, FAR int *policy);
Description: The posix_spawnattr_getschedpolicy() function will obtain the value of the spawn-schedpolicy attribute from the attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be queried. policy: The location to return the spawn-schedpolicy value. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_getsigmask(FAR const posix_spawnattr_t *attr, FAR sigset_t *sigmask);
Description: The posix_spawnattr_getsigdefault() function will obtain the value of the spawn-sigmask attribute from the attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be queried. sigmask: The location to return the spawn-sigmask value. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_setflags(FAR posix_spawnattr_t *attr, short flags);
Description: The posix_spawnattr_setflags() function will set the spawn-flags attribute in an initialized attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be used. flags: The new value of the spawn-flags attribute. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_setschedparam(FAR posix_spawnattr_t *attr, FAR const struct sched_param *param);
Description: The posix_spawnattr_setschedparam() function will set the spawn-schedparam attribute in an initialized attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be used. param: The new value of the spawn-schedparam attribute. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_setschedpolicy(FAR posix_spawnattr_t *attr, int policy);
Description: The posix_spawnattr_setschedpolicy() function will set the spawn-schedpolicy attribute in an initialized attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be used. policy: The new value of the spawn-schedpolicy attribute. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawnattr_setsigmask(FAR posix_spawnattr_t *attr, FAR const sigset_t *sigmask);
Description: The posix_spawnattr_setsigmask() function will set the spawn-sigmask attribute in an initialized attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be used. sigmask: The new value of the spawn-sigmask attribute. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h>
int task_spawn(FAR pid_t *pid, FAR const char *name, main_t entry,
FAR const posix_spawn_file_actions_t *file_actions,
FAR const posix_spawnattr_t *attr,
FAR char * const argv[], FAR char * const envp[]);
Description: The task_spawn() function will create a new, child task, where the entry point to the task is an address in memory.
pid: Upon successful completion, task_spawn() will return the task ID of the child task to the parent task, in the variable pointed to by a non-NULL pid argument. If the pid argument is a null pointer, the process ID of the child is not returned to the caller.
name: The name to assign to the child task.
entry: The child task's entry point (an address in memory).
file_actions: If file_actions is a null pointer, then file descriptors open in the calling process will remain open in the child process (unless CONFIG_FDCLONE_STDIO is defined). If file_actions is not NULL, then the file descriptors open in the child process will be those open in the calling process as modified by the spawn file actions object pointed to by file_actions.
attr: If the value of the attr parameter is NULL, the all default values for the POSIX spawn attributes will be used. Otherwise, the attributes will be set according to the spawn flags. The posix_spawnattr_t spawn attributes object type is defined in spawn.h. It will contains these attributes, not all of which are supported by NuttX:
POSIX_SPAWN_SETPGROUP: Setting of the new task's process group is not supported. NuttX does not support process groups. POSIX_SPAWN_SETSCHEDPARAM: Set new tasks priority to the sched_param value. POSIX_SPAWN_SETSCHEDULER: Set the new task's scheduler policy to the sched_policy value. POSIX_SPAWN_RESETIDS Resetting of the effective user ID of the child process is not supported. NuttX does not support effective user IDs. POSIX_SPAWN_SETSIGMASK: Set the new task's signal mask. POSIX_SPAWN_SETSIGDEF: Resetting signal default actions is not supported. NuttX does not support default signal actions. And the non-standard:
TASK_SPAWN_SETSTACKSIZE: Set the stack size for the new task. argv: argv[] is the argument list for the new task. argv[] is an array of pointers to null-terminated strings. The list is terminated with a null pointer.
envp: The envp[] argument is not used by NuttX and may be NULL.
Returned Value: task_spawn() will return zero on success. Otherwise, an error number will be returned as the function return value to indicate the error:
POSIX Compatibility: This is a non-standard interface inspired by posix_spawn().
Function Prototype:
#include <spawn.h> int task_spawnattr_getstacksize(FAR const posix_spawnattr_t *attr, FAR size_t *stacksize);
Description: The task_spawnattr_getstacksize() function will obtain the value of the spawn-stacksize attribute from the attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be queried. policy: The location to return the spawn-stacksize value. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int task_spawnattr_setstacksize(FAR posix_spawnattr_t *attr, size_t stacksize);
Description: The task_spawnattr_setstacksize() function will set the spawn-stacksize attribute in an initialized attributes object referenced by attr.
Input Parameters:
attr: The address spawn attributes to be used. policy: The new value of the spawn-stacksize attribute. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>
Function Prototype:
#include <spawn.h> int posix_spawn_file_actions_init(FAR posix_spawn_file_actions_t *file_actions);
Description: The posix_spawn_file_actions_init() function initializes the object referenced by file_actions to an empty set of file actions for subsequent use in a call to posix_spawn() or posix_spawnp().
Input Parameters:
file_actions: The address of the posix_spawn_file_actions_t to be initialized. Returned Value: On success, this function returns 0; on failure it will return an error number from <errno.h>.
2.2 Task Scheduling Interfaces |
By default, NuttX performs strict priority scheduling: Tasks of higher priority have exclusive access to the CPU until they become blocked. At that time, the CPU is available to tasks of lower priority. Tasks of equal priority are scheduled FIFO.
Optionally, a Nuttx task or thread can be configured with round-robin or sporadic scheduler. The round-robin is similar to priority scheduling except that tasks with equal priority and share CPU time via time-slicing. The time-slice interval is a constant determined by the configuration setting CONFIG_RR_INTERVAL to a positive, non-zero value. Sporadic scheduling scheduling is more complex, varying the priority of a thread over a replenishment period. Support for sporadic scheduling is enabled by the configuration option CONFIG_SCHED_SPORADIC.
The OS interfaces described in the following paragraphs provide a POSIX- compliant interface to the NuttX scheduler:
Function Prototype:
#include <sched.h>
int sched_setparam(pid_t pid, FAR const struct sched_param *param);
Description: This function sets the priority of the task specified by pid input parameter.
NOTE: Setting a task's priority to the same value has the similar effect to sched_yield(): The task will be moved to after all other tasks with the same priority.
Input Parameters:
pid. The task ID of the task. If pid is zero, the priority of the calling task is set. param. A structure whose member sched_priority is the integer priority. The range of valid priority numbers is from SCHED_PRIORITY_MIN through SCHED_PRIORITY_MAX. Returned Value: On success, sched_setparam() returns 0 (OK). On error, -1 (ERROR) is returned, and errno is set appropriately.
EINVAL. The parameter param is invalid or does not make sense for the current scheduling policy. EPERM. The calling task does not have appropriate privileges. ESRCH. The task whose ID is pid could not be found. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
Function Prototype:
#include <sched.h>
int sched_getparam(pid_t pid, FAR struct sched_param *param);
Description: This function gets the scheduling priority of the task specified by pid.
Input Parameters:
pid. The task ID of the task. If pid is zero, the priority of the calling task is returned. param. A structure whose member sched_priority is the integer priority. The task's priority is copied to the sched_priority element of this structure. Returned Value:
OK) if successful, otherwise -1 (ERROR). Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <sched.h> int sched_setscheduler (pid_t pid, int policy, const struct sched_param *param);
Description: sched_setscheduler() sets both the scheduling policy and the priority for the task identified by pid. If pid equals zero, the scheduler of the calling thread will be set. The parameter param holds the priority of the thread under the new policy.
Input Parameters:
pid. The task ID of the task. If pid is zero, the priority of the calling task is set. policy. Scheduling policy requested (either SCHED_FIFO or SCHED_RR). param. A structure whose member sched_priority is the integer priority. The range of valid priority numbers is from SCHED_PRIORITY_MIN through SCHED_PRIORITY_MAX. Returned Value: On success, sched_setscheduler() returns OK (zero). On error, ERROR (-1) is returned, and errno is set appropriately:
EINVAL: The scheduling policy is not one of the recognized policies.ESRCH: The task whose ID is pid could not be found.Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <sched.h> int sched_getscheduler (pid_t pid);
Description: sched_getscheduler() returns the scheduling policy currently applied to the task identified by pid. If pid equals zero, the policy of the calling process will be retrieved.
Input Parameters:
pid. The task ID of the task to query. If pid is zero, the calling task is queried. Returned Value:
sched_getscheduler() returns the policy for the task (either SCHED_FIFO or SCHED_RR). On error, ERROR (-1) is returned, and errno is set appropriately: ESRCH: The task whose ID is pid could not be found.Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <sched.h>
int sched_yield(void);
Description: This function forces the calling task to give up the CPU (only to other tasks at the same priority).
Input Parameters: None.
Returned Value:
OK) or -1 (ERROR) Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <sched.h>
int sched_get_priority_max (int policy)
Description: This function returns the value of the highest possible task priority for a specified scheduling policy.
Input Parameters:
policy. Scheduling policy requested. Returned Value:
ERROR). Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <sched.h>
int sched_get_priority_min (int policy);
Description: This function returns the value of the lowest possible task priority for a specified scheduling policy.
Input Parameters:
policy. Scheduling policy requested. Returned Value:
ERROR) Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <sched.h>
int sched_get_rr_interval (pid_t pid, struct timespec *interval);
Description: sched_rr_get_interval() writes the timeslice interval for task identified by pid into the timespec structure pointed to by interval. If pid is zero, the timeslice for the calling process is written into 'interval. The identified process should be running under the SCHED_RR scheduling policy.'
Input Parameters:
pid. The task ID of the task. If pid is zero, the priority of the calling task is returned. interval. A structure used to return the time slice. Returned Value: On success, sched_rr_get_interval() returns OK (0). On error, ERROR (-1) is returned, and errno is set to:
EFAULT: Cannot copy to intervalEINVAL: Invalid pid.ENOSYS: The system call is not yet implemented.ESRCH: The process whose ID is pid could not be found.Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
2.3 Task Control Interfaces |
Task Control Interfaces.
Scheduler locking interfaces. This non-standard interfaces are used to enable and disable pre-emption and to test is pre-emption is currently enabled.
Task synchronization interfaces. wait(), waitpid() or waitid() may be used to wait for termination of child tasks.
Task Exit Hooks. atexit() and on_exit() may be use to register callback functions that are executed when a task group terminates. A task group is the functional analog of a process: It is a group that consists of the main task thread and of all of the pthreads created by the main task thread or any of the other pthreads within the task group. Members of a task group share certain resources such as environment variables, file descriptors, FILE streams, sockets, pthread keys and open message queues.
NOTE: Behavior of features related to task groups depend of NuttX configuration settings. See the discussion of "Parent and Child Tasks," below. See also the NuttX Tasking page and the Tasks vs. Threads FAQ for additional information on tasks and threads in NuttX.
A task group terminates when the last thread within the group exits.
Parent and Child Tasks. The task synchronization interfaces historically depend upon parent and child relationships between tasks. But default, NuttX does not use any parent/child knowledge. However, there are three important configuration options that can change that.
CONFIG_SCHED_HAVE_PARENT. If this setting is defined, then it instructs NuttX to remember the task ID of the parent task when each new child task is created. This support enables some additional features (such as SIGCHLD) and modifies the behavior of other interfaces. For example, it makes waitpid() more standards complete by restricting the waited-for tasks to the children of the caller.
CONFIG_SCHED_CHILD_STATUS If this option is selected, then the exit status of the child task will be retained after the child task exits. This option should be selected if you require knowledge of a child process's exit status. Without this setting, wait(), waitpid() or waitid() may fail. For example, if you do:
wait(), waitpid() or waitid()). This may fail because the child task may run to completion before the wait begins. There is a non-standard work-around in this case: The above sequence will work if you disable pre-emption using sched_lock() prior to starting the child task, then re-enable pre-emption with sched_unlock() after the wait completes. This works because the child task is not permitted to run until the wait is in place.
The standard solution would be to enable CONFIG_SCHED_CHILD_STATUS. In this case the exit status of the child task is retained after the child exits and the wait will successful obtain the child task's exit status whether it is called before the child task exits or not.
CONFIG_PREALLOC_CHILDSTATUS. To prevent runaway child status allocations and to improve allocation performance, child task exit status structures are pre-allocated when the system boots. This setting determines the number of child status structures that will be pre-allocated. If this setting is not defined or if it is defined to be zero then a value of 2*MAX_TASKS is used.
Note that there cannot be more that CONFIG_MAX_TASKS tasks in total. However, the number of child status structures may need to be significantly larger because this number includes the maximum number of tasks that are running PLUS the number of tasks that have exit'ed without having their exit status reaped (via wait(), waitpid() or waitid()).
Obviously, if tasks spawn children indefinitely and never have the exit status reaped, then you may have a memory leak! (See Warning below)
Warning: If you enable the CONFIG_SCHED_CHILD_STATUS feature, then your application must either (1) take responsibility for reaping the child status with wait(), waitpid() or waitid(), or (2) suppress retention of child status. If you do not reap the child status, then you have a memory leak and your system will eventually fail.
struct sigaction sa; sa.sa_handler = SIG_IGN; sa.sa_flags = SA_NOCLDWAIT; int ret = sigaction(SIGCHLD, &sa, NULL);
Function Prototype:
#include <sched.h>
int sched_lock(void);
Description: This function disables context switching by Disabling addition of new tasks to the ready-to-run task list. The task that calls this function will be the only task that is allowed to run until it either calls sched_unlock (the appropriate number of times) or until it blocks itself.
Input Parameters: None.
Returned Value:
Assumptions/Limitations:
POSIX Compatibility: This is a NON-POSIX interface. VxWorks provides the comparable interface:
STATUS taskLock(void);
Function Prototype:
#include <sched.h>
int sched_unlock(void);
Description: This function decrements the preemption lock count. Typically this is paired with sched_lock() and concludes a critical section of code. Preemption will not be unlocked until sched_unlock() has been called as many times as sched_lock(). When the lockCount is decremented to zero, any tasks that were eligible to preempt the current task will execute.
Input Parameters: None.
Returned Value:
Assumptions/Limitations:
POSIX Compatibility: This is a NON-POSIX interface. VxWorks provides the comparable interface:
STATUS taskUnlock(void);
Function Prototype:
#include <sched.h>
int32_t sched_lockcount(void)
Description: This function returns the current value of the lockCount. If zero, preemption is enabled; if non-zero, this value indicates the number of times that sched_lock() has been called on this thread of execution.
Input Parameters: None.
Returned Value:
Assumptions/Limitations:
POSIX Compatibility: None.
Function Prototype:
#include <sys/wait.h>
ipid_t waitpid(pid_t pid, int *stat_loc, int options);
Description:
The following discussion is a general description of thewaitpid()interface. However, as of this writing, the implementation ofwaitpid()is incomplete (but usable). IfCONFIG_SCHED_HAVE_PARENTis defined,waitpid()will be a little more compliant to specifications. WithoutCONFIG_SCHED_HAVE_PARENT,waitpid()simply supports waiting for any task to complete execution. WithCONFIG_SCHED_HAVE_PARENT,waitpid()will useSIGCHLDand can, therefore, wait for any child of the parent to complete. The implementation is incomplete in either case, however: NuttX does not support any concept of process groups. Nor does NuttX retain the status of exited tasks so ifwaitpid()is called after a task has exited, then no status will be available. The options argument is currently ignored.
The waitpid() functions will obtain status information pertaining to one of the caller's child processes. The waitpid() function will suspend execution of the calling thread until status information for one of the terminated child processes of the calling process is available, or until delivery of a signal whose action is either to execute a signal-catching function or to terminate the process. If more than one thread is suspended in waitpid() awaiting termination of the same process, exactly one thread will return the process status at the time of the target process termination. If status information is available prior to the call to waitpid(), return will be immediate.
NOTE: Because waitpid() is not fully POSIX compliant, it must be specifically enabled by setting CONFIG_SCHED_WAITPID in the NuttX configuration file.
Input Parameters:
pid. The task ID of the thread to wait forstat_loc. The location to return the exit statusoptions. ignored The pid argument specifies a set of child processes for which status is requested. The waitpid() function will only return the status of a child process from this set:
pid is equal to (pid_t)-1), status is requested for any child process. In this respect, waitpid() is then equivalent to wait(). pid is greater than 0, it specifies the process ID of a single child process for which status is requested. pid is 0, status is requested for any child process whose process group ID is equal to that of the calling process. pid is less than (pid_t)-1), status is requested for any child process whose process group ID is equal to the absolute value of pid. The options argument is constructed from the bitwise-inclusive OR of zero or more of the following flags, defined in the <sys/wait.h> header:
WCONTINUED. The waitpid() function will report the status of any continued child process specified by pid whose status has not been reported since it continued from a job control stop. WNOHANG. The waitpid() function will not suspend execution of the calling thread if status is not immediately available for one of the child processes specified by pid. WUNTRACED. The status of any child processes specified by pid that are stopped, and whose status has not yet been reported since they stopped, will also be reported to the requesting process. If the calling process has SA_NOCLDWAIT set or has SIGCHLD set to SIG_IGN, and the process has no unwaited-for children that were transformed into zombie processes, the calling thread will block until all of the children of the process containing the calling thread terminate, and waitpid() will fail and set errno to ECHILD.
If waitpid() returns because the status of a child process is available, these functions will return a value equal to the process ID of the child process. In this case, if the value of the argument stat_loc is not a null pointer, information will be stored in the location pointed to by stat_loc. The value stored at the location pointed to by stat_loc will be 0 if and only if the status returned is from a terminated child process that terminated by one of the following means:
main(). _exit() or exit() with a status argument of 0. Regardless of its value, this information may be interpreted using the following macros, which are defined in <sys/wait.h> and evaluate to integral expressions; the stat_val argument is the integer value pointed to by stat_loc.
WIFEXITED(stat_val). Evaluates to a non-zero value if status was returned for a child process that terminated normally. WEXITSTATUS(stat_val). If the value of WIFEXITED(stat_val) is non-zero, this macro evaluates to the low-order 8 bits of the status argument that the child process passed to _exit() or exit(), or the value the child process returned from main(). WIFSIGNALED(stat_val). Evaluates to a non-zero value if status was returned for a child process that terminated due to the receipt of a signal that was not caught (see >signal.h<). WTERMSIG(stat_val). If the value of WIFSIGNALED(stat_val) is non-zero, this macro evaluates to the number of the signal that caused the termination of the child process. WIFSTOPPED(stat_val). Evaluates to a non-zero value if status was returned for a child process that is currently stopped. WSTOPSIG(stat_val). If the value of WIFSTOPPED(stat_val) is non-zero, this macro evaluates to the number of the signal that caused the child process to stop. WIFCONTINUED(stat_val). Evaluates to a non-zero value if status was returned for a child process that has continued from a job control stop. Returned Value:
If waitpid() returns because the status of a child process is available, it will return a value equal to the process ID of the child process for which status is reported.
If waitpid() returns due to the delivery of a signal to the calling process, -1 will be returned and errno set to EINTR.
If waitpid() was invoked with WNOHANG set in options, it has at least one child process specified by pid for which status is not available, and status is not available for any process specified by pid, 0 is returned.
Otherwise, (pid_t)-1errno set to indicate the error:
ECHILD. The process specified by pid does not exist or is not a child of the calling process, or the process group specified by pid does not exist or does not have any member process that is a child of the calling process. EINTR. The function was interrupted by a signal. The value of the location pointed to by stat_loc is undefined. EINVAL. The options argument is not valid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name, but the implementation is incomplete (as detailed above).
Function Prototype:
#include <sys/wait.h>
#ifdef CONFIG_SCHED_HAVE_PARENT
int waitid(idtype_t idtype, id_t id, FAR siginfo_t *info, int options);
#endif
Description:
The following discussion is a general description of thewaitid()interface. However, as of this writing, the implementation ofwaitid()is incomplete (but usable). IfCONFIG_SCHED_HAVE_PARENTis defined,waitid()will be a little more compliant to specifications.waitpid()simply supports waiting a specific child task (P_PIDor for any child taskP_ALLto complete execution.SIGCHLDis used. The implementation is incomplete in either case, however: NuttX does not support any concept of process groups. Nor does NuttX retain the status of exited tasks so ifwaitpid()is called after a task has exited, then no status will be available. The options argument is currently ignored.
The waitid() function suspends the calling thread until one child of the process containing the calling thread changes state. It records the current state of a child in the structure pointed to by info. If a child process changed state prior to the call to waitid(), waitid() returns immediately. If more than one thread is suspended in wait() or waitpid() waiting termination of the same process, exactly one thread will return the process status at the time of the target process termination
The idtype and id arguments are used to specify which children waitid() will wait for.
idtype is P_PID, waitid() will wait for the child with a process ID equal to (pid_t)id. idtype is P_PGID, waitid() will wait for any child with a process group ID equal to (pid_t)id. idtype is P_ALL, waitid() will wait for any children and id is ignored. The options argument is used to specify which state changes waitid() will will wait for. It is formed by OR-ing together one or more of the following flags:
WEXITED: Wait for processes that have exited. WSTOPPED: Status will be returned for any child that has stopped upon receipt of a signal. WCONTINUES: Status will be returned for any child that was stopped and has been continued. WNOHANG: Return immediately if there are no children to wait for. WNOWAIT: Keep the process whose status is returned in info in a waitable state. This will not affect the state of the process; the process may be waited for again after this call completes. info argument must point to a siginfo_t structure. If waitid() returns because a child process was found that satisfied the conditions indicated by the arguments idtype and options, then the structure pointed to by info will be filled in by the system with the status of the process. The si_signo member will always be equal to SIGCHLD. Input Parameters: See the description above.
Returned Value: If waitid() returns due to the change of state of one of its children, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error.
The waitid() function will fail if:
ECHILD: EINTR: waitid() function was interrupted by a signal. EINVAL: An invalid value was specified for options, or idtype and id specify an invalid set of processes. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name, but the implementation is incomplete (as detailed in the description above).
Function Prototype:
#include <sys/wait.h>
#ifdef CONFIG_SCHED_HAVE_PARENT
pid_t wait(FAR int *stat_loc);
#endif
Description:
The following discussion is a general description of thewait()interface. However, as of this writing, the implementation ofwait()is incomplete (but usable).wait()is based onwaitpaid(). See the description ofwaitpaid()for further information.
The wait() function will suspend execution of the calling thread until status information for one of its terminated child processes is available, or until delivery of a signal whose action is either to execute a signal-catching function or to terminate the process. If more than one thread is suspended in wait() awaiting termination of the same process, exactly one thread will return the process status at the time of the target process termination. If status information is available prior to the call towait(), return will be immediate.
The waitpid() function will behave identically to wait(), if its pid argument is (pid_t)-1 and the options argument is 0. Otherwise, its behavior will be modified by the values of the pid and options arguments.
Input Parameters:
stat_loc. The location to return the exit status Returned Value: See the values returned by waitpaid().
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name, but the implementation is incomplete (as detailed in the description waitpaid()).
Function Prototype:
#include <stdlib.h>
int atexit(void (*func)(void));
Description: Registers a function to be called at program exit. The atexit() function registers the given function to be called at normal process termination, whether via exit() or via return from the program's main().
NOTE: CONFIG_SCHED_ATEXIT must be defined to enable this function.
Input Parameters:
func. A pointer to the function to be called when the task exits. Returned Value: On success, atexit() returns OK (0). On error, ERROR (-1) is returned, and errno is set to indicate the cause of the failure.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the ISO C interface of the same name. Limitations in the current implementation:
atexit function can be registered unless CONFIG_SCHED_ATEXIT_MAX defines a larger number.atexit() functions are not inherited when a new task is created.Function Prototype:
#include <stdlib.h>
int on_exit(CODE void (*func)(int, FAR void *), FAR void *arg)
Description: Registers a function to be called at program exit. The on_exit() function registers the given function to be called at normal process termination, whether via exit() or via return from the program's main(). The function is passed the status argument given to the last call to exit() and the arg argument from on_exit().
NOTE: CONFIG_SCHED_ONEXIT must be defined to enable this function
Input Parameters:
func. A pointer to the function to be called when the task exits.arg. An argument that will be provided to the on_exit() function when the task exits. Returned Value: On success, on_exit() returns OK (0). On error, ERROR (-1) is returned, and errno is set to indicate the cause of the failure.
Assumptions/Limitations:
POSIX Compatibility: This function comes from SunOS 4, but is also present in libc4, libc5 and glibc. It no longer occurs in Solaris (SunOS 5). Avoid this function, and use the standard atexit() instead.
on_exit function can be registered unless CONFIG_SCHED_ONEXIT_MAX defines a larger number.on_exit() functions are not inherited when a new task is created. 2.4 Named Message Queue Interfaces |
NuttX supports POSIX named message queues for inter-task communication. Any task may send or receive messages on named message queues. Interrupt handlers may send messages via named message queues.
Function Prototype:
#include <mqueue.h>
mqd_t mq_open(const char *mqName, int oflags, ...);
Description: This function establish a connection between a named message queue and the calling task. After a successful call of mq_open(), the task can reference the message queue using the address returned by the call. The message queue remains usable until it is closed by a successful call to mq_close().
Input Parameters:
mqName. Name of the queue to open oflags. Open flags. These may be any combination of: O_RDONLY. Open for read access. O_WRONLY. Open for write access. O_RDWR. Open for both read & write access. O_CREAT. Create message queue if it does not already exist. O_EXCL. Name must not exist when opened. O_NONBLOCK. Don't wait for data. ... Optional parameters. When the O_CREAT flag is specified, POSIX requires that a third and fourth parameter be supplied: mode. The mode parameter is of type mode_t. In the POSIX specification, this mode value provides file permission bits for the message queue. This parameter is required but not used in the present implementation. attr. A pointer to an mq_attr that is provided to initialize. the message queue. If attr is NULL, then the messages queue is created with implementation-defined default message queue attributes. If attr is non-NULL, then the message queue mq_maxmsg attribute is set to the corresponding value when the queue is created. The mq_maxmsg attribute determines the maximum number of messages that can be queued before addition attempts to send messages on the message queue fail or cause the sender to block; the mq_msgsize attribute determines the maximum size of a message that can be sent or received. Other elements of attr are ignored (i.e, set to default message queue attributes). Returned Value:
ERROR) Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
Function Prototype:
#include <mqueue.h>
int mq_close(mqd_t mqdes);
Description: This function is used to indicate that the calling task is finished with the specified message queued mqdes. The mq_close() deallocates any system resources allocated by the system for use by this task for its message queue.
If the calling task has attached a notification request to the message queue via this mqdes (see mq_notify()), this attachment will be removed and the message queue is available for another task to attach for notification.
Input Parameters:
mqdes. Message queue descriptor. Returned Value:
OK) if the message queue is closed successfully, otherwise, -1 (ERROR). Assumptions/Limitations:
mq_send() or mq_receive() is undefined when mq_close() is called. mq_close() is undefined. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <mqueue.h>
int mq_unlink(const char *mqName);
Description: This function removes the message queue named by "mqName." If one or more tasks have the message queue open when mq_unlink() is called, removal of the message queue is postponed until all references to the message queue have been closed.
Input Parameters:
mqName. Name of the message queue Returned Value: None.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <mqueue.h>
int mq_send(mqd_t mqdes, const void *msg, size_t msglen, int prio);
Description: This function adds the specified message, msg, to the message queue, mqdes. The msglen parameter specifies the length of the message in bytes pointed to by msg. This length must not exceed the maximum message length from the mq_getattr().
If the message queue is not full, mq_send() will place the msg in the message queue at the position indicated by the prio argument. Messages with higher priority will be inserted before lower priority messages The value of prio must not exceed MQ_PRIO_MAX.
If the specified message queue is full and O_NONBLOCK is not set in the message queue, then mq_send() will block until space becomes available to the queue the message.
If the message queue is full and NON_BLOCK is set, the message is not queued and ERROR is returned.
NOTE: mq_send() may be called from an interrupt handler. However, it behaves differently when called from the interrupt level:
Input Parameters:
mqdes. Message queue descriptor.msg. Message to send.msglen. The length of the message in bytes.prio. The priority of the message. Returned Value: On success, mq_send() returns 0 (OK); on error, -1 (ERROR) is returned, with errno set to indicate the error:
EAGAIN. The queue was empty, and the O_NONBLOCK flag was set for the message queue description referred to by mqdes. EINVAL. Either msg or mqdes is NULL or the value of prio is invalid. EPERM. Message queue opened not opened for writing. EMSGSIZE. msglen was greater than the maxmsgsize attribute of the message queue. EINTR. The call was interrupted by a signal handler. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
#include <mqueue.h>
int mq_timedsend(mqd_t mqdes, const char *msg, size_t msglen, int prio,
const struct timespec *abstime);
Description: This function adds the specified message, msg, to the message queue, mqdes. The msglen parameter specifies the length of the message in bytes pointed to by msg. This length must not exceed the maximum message length from the mq_getattr().
If the message queue is not full, mq_timedsend() will place the msg in the message queue at the position indicated by the prio argument. Messages with higher priority will be inserted before lower priority messages The value of prio must not exceed MQ_PRIO_MAX.
If the specified message queue is full and O_NONBLOCK is not set in the message queue, then mq_send() will block until space becomes available to the queue the message or until a timeout occurs.
mq_timedsend() behaves just like mq_send(), except that if the queue is full and the O_NONBLOCK flag is not enabled for the message queue description, then abstime points to a structure which specifies a ceiling on the time for which the call will block. This ceiling is an absolute timeout in seconds and nanoseconds since the Epoch (midnight on the morning of 1 January 1970).
If the message queue is full, and the timeout has already expired by the time of the call, mq_timedsend() returns immediately.
Input Parameters:
mqdes. Message queue descriptor.msg. Message to send.msglen. The length of the message in bytes.prio. The priority of the message. Returned Value: On success, mq_send() returns 0 (OK); on error, -1 (ERROR) is returned, with errno set to indicate the error:
EAGAIN. The queue was empty, and the O_NONBLOCK flag was set for the message queue description referred to by mqdes. EINVAL. Either msg or mqdes is NULL or the value of prio is invalid. EPERM. Message queue opened not opened for writing. EMSGSIZE. msglen was greater than the maxmsgsize attribute of the message queue. EINTR. The call was interrupted by a signal handler. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <mqueue.h>
ssize_t mq_receive(mqd_t mqdes, void *msg, size_t msglen, int *prio);
Description: This function receives the oldest of the highest priority messages from the message queue specified by mqdes. If the size of the buffer in bytes, msgLen, is less than the mq_msgsize attribute of the message queue, mq_receive() will return an error. Otherwise, the selected message is removed from the queue and copied to msg.
If the message queue is empty and O_NONBLOCK was not set, mq_receive() will block until a message is added to the message queue. If more than one task is waiting to receive a message, only the task with the highest priority that has waited the longest will be unblocked.
If the queue is empty and O_NONBLOCK is set, ERROR will be returned.
Input Parameters:
mqdes. Message Queue Descriptor.msg. Buffer to receive the message.msglen. Size of the buffer in bytes.prio. If not NULL, the location to store message priority. Returned Value:. One success, the length of the selected message in bytes is returned. On failure, -1 (ERROR) is returned and the errno is set appropriately:
EAGAIN The queue was empty and the O_NONBLOCK flag was set for the message queue description referred to by mqdes. EPERM Message queue opened not opened for reading. EMSGSIZE msglen was less than the maxmsgsize attribute of the message queue. EINTR The call was interrupted by a signal handler. EINVAL Invalid msg or mqdes Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <mqueue.h>
ssize_t mq_timedreceive(mqd_t mqdes, void *msg, size_t msglen,
int *prio, const struct timespec *abstime);
Description: This function receives the oldest of the highest priority messages from the message queue specified by mqdes. If the size of the buffer in bytes, msgLen, is less than the mq_msgsize attribute of the message queue, mq_timedreceive() will return an error. Otherwise, the selected message is removed from the queue and copied to msg.
If the message queue is empty and O_NONBLOCK was not set, mq_timedreceive() will block until a message is added to the message queue (or until a timeout occurs). If more than one task is waiting to receive a message, only the task with the highest priority that has waited the longest will be unblocked.
mq_timedreceive() behaves just like mq_receive(), except that if the queue is empty and the O_NONBLOCK flag is not enabled for the message queue description, then abstime points to a structure which specifies a ceiling on the time for which the call will block. This ceiling is an absolute timeout in seconds and nanoseconds since the Epoch (midnight on the morning of 1 January 1970).
If no message is available, and the timeout has already expired by the time of the call, mq_timedreceive() returns immediately.
Input Parameters:
mqdes. Message Queue Descriptor.msg. Buffer to receive the message.msglen. Size of the buffer in bytes.prio. If not NULL, the location to store message priority. abstime. The absolute time to wait until a timeout is declared. Returned Value:. One success, the length of the selected message in bytes is returned. On failure, -1 (ERROR) is returned and the errno is set appropriately:
EAGAIN: The queue was empty and the O_NONBLOCK flag was set for the message queue description referred to by mqdes. EPERM: Message queue opened not opened for reading. EMSGSIZE: msglen was less than the maxmsgsize attribute of the message queue. EINTR: The call was interrupted by a signal handler. EINVAL: Invalid msg or mqdes or abstime ETIMEDOUT: The call timed out before a message could be transferred. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <mqueue.h>
int mq_notify(mqd_t mqdes, FAR const struct sigevent *notification);
Description: If the notification input parameter is not NULL, this function connects the task with the message queue such that the specified signal will be sent to the task whenever the message changes from empty to non-empty. One notification can be attached to a message queue.
If notification; is NULL, the attached notification is detached (if it was held by the calling task) and the queue is available to attach another notification.
When the notification is sent to the registered task, its registration will be removed. The message queue will then be available for registration.
Input Parameters:
mqdes. Message queue descriptor notification. Real-time signal structure containing: sigev_notify. Should be SIGEV_SIGNAL (but actually ignored) sigev_signo. The signo to use for the notification sigev_value. Value associated with the signal Returned Value: On success mq_notify() returns 0; on error, -1 is returned, with errno set to indicate the error:
EBADF. The descriptor specified in mqdes is invalid. EBUSY. Another process has already registered to receive notification for this message queue. EINVAL. sevp->sigev_notify is not one of the permitted values; or sevp->sigev_notify is SIGEV_SIGNAL and sevp->sigev_signo is not a valid signal number. ENOMEM. Insufficient memory. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
mq_receive waiting to receive a message when a message arrives at the queue, the arriving message will satisfy the appropriate mq_receive() ... The resulting behavior is as if the message queue remains empty, and no notification will be sent." Function Prototype:
#include <mqueue.h>
int mq_setattr(mqd_t mqdes, const struct mq_attr *mqStat,
struct mq_attr *oldMqStat);
Description: This function sets the attributes associated with the specified message queue "mqdes." Only the "O_NONBLOCK" bit of the "mq_flags" can be changed.
If "oldMqStat" is non-null, mq_setattr() will store the previous message queue attributes at that location (just as would have been returned by mq_getattr()).
Input Parameters:
mqdes. Message queue descriptor mqStat. New attributes oldMqState. Old attributes Returned Value:
OK) if attributes are set successfully, otherwise -1 (ERROR). Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <mqueue.h>
int mq_getattr(mqd_t mqdes, struct mq_attr *mqStat);
Description: This functions gets status information and attributes associated with the specified message queue.
Input Parameters:
mqdes. Message queue descriptor mqStat. Buffer in which to return attributes. The returned attributes include: mq_maxmsg. Max number of messages in queue. mq_msgsize. Max message size. mq_flags. Queue flags. mq_curmsgs. Number of messages currently in queue. Returned Value:
OK) if attributes provided, -1 (ERROR) otherwise. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
2.5 Counting Semaphore Interfaces |
Semaphores. Semaphores are the basis for synchronization and mutual exclusion in NuttX. NuttX supports POSIX semaphores.
Semaphores are the preferred mechanism for gaining exclusive access to a resource. sched_lock() and sched_unlock() can also be used for this purpose. However, sched_lock() and sched_unlock() have other undesirable side-effects in the operation of the system: sched_lock() also prevents higher-priority tasks from running that do not depend upon the semaphore-managed resource and, as a result, can adversely affect system response times.
Priority Inversion. Proper use of semaphores avoids the issues of sched_lock(). However, consider the following example:
At this point, the high-priority Task A cannot execute until Task B (and possibly other medium-priority tasks) completes and until Task C relinquishes the semaphore. In effect, the high-priority task, Task A behaves as though it were lower in priority than the low-priority task, Task C! This phenomenon is called priority inversion.
Some operating systems avoid priority inversion by automatically increasing the priority of the low-priority Task C (the operable buzz-word for this behavior is priority inheritance). NuttX supports this behavior, but only if CONFIG_PRIORITY_INHERITANCE is defined in your OS configuration file. If CONFIG_PRIORITY_INHERITANCE is not defined, then it is left to the designer to provide implementations that will not suffer from priority inversion. The designer may, as examples:
Priority Inheritance. As mentioned, NuttX does support priority inheritance provided that CONFIG_PRIORITY_INHERITANCE is defined in your OS configuration file. However, the implementation and configuration of the priority inheritance feature is sufficiently complex that more needs to be said. How can a feature that can be described by a single, simple sentence require such a complex implementation:
CONFIG_SEM_PREALLOCHOLDERS. First of all, in NuttX priority inheritance is implement on POSIX counting semaphores. The reason for this is that these semaphores are the most primitive waiting mechanism in NuttX; Most other waiting facilities are based on semaphores. So if priority inheritance is implemented for POSIX counting semaphores, then most NuttX waiting mechanisms will have this capability. Complexity arises because counting semaphores can have numerous holders of semaphore counts. Therefore, in order to implement priority inheritance across all holders, then internal data structures must be allocated to manage the various holders associated with a semaphore. The setting CONFIG_SEM_PREALLOCHOLDERS defines the maximum number of different threads (minus one per semaphore instance) that can take counts on a semaphore with priority inheritance support. This setting defines the size of a single pool of pre-allocated structures. It may be set to zero if priority inheritance is disabled OR if you are only using semaphores as mutexes (only one holder) OR if no more than two threads participate using a counting semaphore.
The cost associated with setting CONFIG_SEM_PREALLOCHOLDERS is slightly increased code size and around 6-12 bytes times the value of CONFIG_SEM_PREALLOCHOLDERS.
CONFIG_SEM_NNESTPRIO: In addition, there may be multiple threads of various priorities that need to wait for a count from the semaphore. These, the lower priority thread holding the semaphore may have to be boosted numerous times and, to make things more complex, will have to keep track of all of the boost priorities values in order to correctly restore the priorities after a count has been handed out to the higher priority thread. The CONFIG_SEM_NNESTPRIO defines the size of an array, one array per active thread. This setting is the maximum number of higher priority threads (minus 1) than can be waiting for another thread to release a count on a semaphore. This value may be set to zero if no more than one thread is expected to wait for a semaphore. The cost associated with setting CONFIG_SEM_NNESTPRIO is slightly increased code size and (CONFIG_SEM_PREALLOCHOLDERS + 1) times the maximum number of active threads.
sem_destroy() then. Or what if the thread with the boosted priority re-prioritizes itself? The NuttX implement of priority inheritance attempts to handle all of these types of corner cases, but it is very likely that some are missed. The worst case result is that memory could by stranded within the priority inheritance logic. Locking versus Signaling Semaphores. Semaphores (and mutexes) may be used for many different purposes. One typical use is for mutual exclusion and locking of resources: In this usage, the thread that needs exclusive access to a resources takes the semaphore to get access to the resource. The same thread subsequently releases the semaphore count when it no longer needs exclusive access. Priority inheritance is intended just for this usage case.
In a different usage case, a semaphore may to be used to signal an event: One thread A waits on a semaphore for an event to occur. When the event occurs, another thread B will post the semaphore waking the waiting thread A. This is a completely different usage model; notice that in the mutual exclusion case, the same thread takes and posts the semaphore. In the signaling case, one thread takes the semaphore and a different thread posts the semaphore. Priority inheritance should never be used in this signaling case. Subtle, strange behaviors may result.
When priority inheritance is enabled with CONFIG_PRIORITY_INHERITANCE, the default protocol for the semaphore will be to use priority inheritance. For signaling semaphores, priority inheritance must be explicitly disabled by calling sem_setprotocol with SEM_PRIO_NONE. For the case of pthread mutexes, pthread_mutexattr_setprotocol with PTHREAD_PRIO_NONE.
This is discussed in much more detail on this Wiki page.
POSIX semaphore interfaces:
Function Prototype:
#include <semaphore.h>
int sem_init(sem_t *sem, int pshared, unsigned int value);
Description: This function initializes the UN-NAMED semaphore sem. Following a successful call to sem_init(), the semaphore may be used in subsequent calls to sem_wait(), sem_post(), and sem_trywait(). The semaphore remains usable until it is destroyed.
Only sem itself may be used for performing synchronization. The result of referring to copies of sem in calls to sem_wait(), sem_trywait(), sem_post(), and sem_destroy(), is not defined.
Input Parameters:
sem. Semaphore to be initialized pshared. Process sharing (not used) value. Semaphore initialization value Returned Value:
OK), or -1 (ERROR) if unsuccessful. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
Function Prototype:
#include <semaphore.h>
int sem_destroy(sem_t *sem);
Description: This function is used to destroy the un-named semaphore indicated by sem. Only a semaphore that was created using sem_init() may be destroyed using sem_destroy(). The effect of calling sem_destroy() with a named semaphore is undefined. The effect of subsequent use of the semaphore sem is undefined until sem is re-initialized by another call to sem_init().
The effect of destroying a semaphore upon which other tasks are currently blocked is undefined.
Input Parameters:
sem. Semaphore to be destroyed. Returned Value:
OK), or -1 (ERROR) if unsuccessful. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <semaphore.h>
sem_t *sem_open(const char *name, int oflag, ...);
Description: This function establishes a connection between named semaphores and a task. Following a call to sem_open() with the semaphore name, the task may reference the semaphore associated with name using the address returned by this call. The semaphore may be used in subsequent calls to sem_wait(), sem_trywait(), and sem_post(). The semaphore remains usable until the semaphore is closed by a successful call to sem_close().
If a task makes multiple calls to sem_open() with the same name, then the same semaphore address is returned (provided there have been no calls to sem_unlink()).
Input Parameters:
name. Semaphore name oflag. Semaphore creation options. This may one of the following bit settings: oflag = 0: Connect to the semaphore only if it already exists. oflag = O_CREAT: Connect to the semaphore if it exists, otherwise create the semaphore. oflag = O_CREAT with O_EXCL (O_CREAT|O_EXCL): Create a new semaphore unless one of this name already exists. mode. The mode parameter is of type mode_t. This parameter is required but not used in the present implementation. value. The value parameter is type unsigned int. The semaphore is created with an initial value of value. Valid initial values for semaphores must be less than or equal to SEM_VALUE_MAX (defined in include/limits.h). Returned Value:
SEM_FAILED if unsuccessful. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
Function Prototype:
#include <semaphore.h>
int sem_close(sem_t *sem);
Description: This function is called to indicate that the calling task is finished with the specified named semaphore, sem. The sem_close() deallocates any system resources allocated by the system for this named semaphore.
If the semaphore has not been removed with a call to sem_unlink(), then sem_close() has no effect on the named semaphore. However, when the named semaphore has been fully unlinked, the semaphore will vanish when the last task closes it.
Care must be taken to avoid risking the deletion of a semaphore that another calling task has already locked.
Input Parameters:
sem. Semaphore descriptor Returned Value:
OK), or -1 (ERROR) if unsuccessful. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <semaphore.h>
int sem_unlink(const char *name);
Description: This function will remove the semaphore named by the input name parameter. If one or more tasks have the semaphore named by name open when sem_unlink() is called, destruction of the semaphore will be postponed until all references have been destroyed by calls to sem_close().
Input Parameters:
name. Semaphore name Returned Value:
OK), or -1 (ERROR) if unsuccessful. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
Function Prototype:
#include <semaphore.h>
int sem_wait(sem_t *sem);
Description: This function attempts to lock the semaphore referenced by sem. If the semaphore as already locked by another task, the calling task will not return until it either successfully acquires the lock or the call is interrupted by a signal.
Input Parameters:
sem. Semaphore descriptor. Returned Value:
OK), or -1 (ERROR) is unsuccessful If sem_wait returns -1 (ERROR) then the cause of the failure will be indicated by the thread-specific errno. The following lists the possible values for errno:
EINVAL: Indicates that the sem input parameter is not valid. EINTR: Indicates that the wait was interrupt by a signal received by this task. In this case, the semaphore has not be acquired. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <semaphore.h>
int sem_timedwait(sem_t *sem, const struct timespec *abstime);
Description: This function will lock the semaphore referenced by sem as in the sem_wait() function. However, if the semaphore cannot be locked without waiting for another process or thread to unlock the semaphore by performing a sem_post() function, this wait will be terminated when the specified timeout expires.
abstime passes, as measured by the clock on which timeouts are based (that is, when the value of that clock equals or exceeds abstime), or if the absolute time specified by abstime has already been passed at the time of the call. This function attempts to lock the semaphore referenced by sem. If the semaphore is already locked by another task, the calling task will not return until it either successfully acquires the lock or the call is interrupted by a signal. Input Parameters:
sem. Semaphore descriptor. abstime. The absolute time to wait until a timeout is declared. Returned Value:
OK), or -1 (ERROR) is unsuccessful If sem_timedwait returns -1 (ERROR) then the cause of the failure will be indicated by the thread-specific errno. The following lists the possible values for errno:
EINVAL: Indicates that the sem input parameter is not valid or the thread would have blocked, and the abstime parameter specified a nanoseconds field value less than zero or greater than or equal to 1000 million. ETIMEDOUT: The semaphore could not be locked before the specified timeout expired. EDEADLK: A deadlock condition was detected. EINTR: Indicates that the wait was interrupt by a signal received by this task. In this case, the semaphore has not be acquired. Assumptions/Limitations:
POSIX Compatibility: Derived from IEEE Std 1003.1d-1999.
Function Prototype:
#include <semaphore.h>
int sem_trywait(sem_t *sem);
Description: This function locks the specified semaphore only if the semaphore is currently not locked. In any event, the call returns without blocking.
Input Parameters:
sem. The semaphore descriptor Returned Value:
OK) or -1 (ERROR) if unsuccessful sem_trywait returns -1 (ERROR) then the cause of the failure will be indicated by the thread-specific errno. The following lists the possible values for errno:
EINVAL: Indicates that the sem input parameter is not valid. EAGAIN: Indicates that the semaphore was not acquired.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <semaphore.h>
int sem_post(sem_t *sem);
Description: When a task has finished with a semaphore, it will call sem_post(). This function unlocks the semaphore referenced by sem by performing the semaphore unlock operation.
If the semaphore value resulting from this operation is positive, then no tasks were blocked waiting for the semaphore to become unlocked; The semaphore value is simply incremented.
If the value of the semaphore resulting from this operation is zero, then on of the tasks blocked waiting for the semaphore will be allowed to return successfully from its call to sem_wait().
NOTE: sem_post() may be called from an interrupt handler.
Input Parameters:
sem. Semaphore descriptor Returned Value:
OK) or -1 (ERROR) if unsuccessful. Assumptions/Limitations:. When called from an interrupt handler, it will appear as though the interrupt task is the one that is performing the unlock.
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <semaphore.h>
int sem_getvalue(sem_t *sem, int *sval);
Description: This function updates the location referenced by sval argument to have the value of the semaphore referenced by sem without effecting the state of the semaphore. The updated value represents the actual semaphore value that occurred at some unspecified time during the call, but may not reflect the actual value of the semaphore when it is returned to the calling task.
If sem is locked, the value return by sem_getvalue() will either be zero or a negative number whose absolute value represents the number of tasks waiting for the semaphore.
Input Parameters:
sem. Semaphore descriptor sval. Buffer by which the value is returned Returned Value:
OK) or -1 (ERROR) if unsuccessful. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <nuttx/semaphore.h>
int sem_getprotocol(FAR const pthread_mutexattr_t *attr, FAR int *protocol);
Description: Return the value of the semaphore protocol attribute.
Input Parameters:
attr. A pointer to the semaphore to be queriedprotocol. The user provided location in which to store the protocol value. May be one of SEM_PRIO_NONE, or SEM_PRIO_INHERIT, SEM_PRIO_PROTECT.Returned Value:
If successful, the sem_getprotocol() function will return zero (OK). Otherwise, an -1 (ERROR) will be returned and the errno value will be set to indicate the nature of the error.
Assumptions/Limitations:
POSIX Compatibility: Non-standard NuttX interface. Should not be used in portable code. Analogous to pthread_muxtexattr_getprotocol().
Function Prototype:
#include <nuttx/semaphore.h>
int sem_setprotocol(FAR pthread_mutexattr_t *attr, int protocol);
Description: Set semaphore protocol attribute. See the paragraph Locking versus Signaling Semaphores for some important information about the use of this interface.
Input Parameters:
attr. A pointer to the semaphore to be modifiedprotocol. The new protocol to use. One of SEM_PRIO_NONE, or SEM_PRIO_INHERIT, SEM_PRIO_PROTECT. SEM_PRIO_INHERIT is supported only if CONFIG_PRIORITY_INHERITANCE is defined; SEM_PRIO_PROTECT is not currently supported in any configuration.Returned Value:
If successful, the sem_setprotocol() function will return zero (OK). Otherwise, an -1 (ERROR) will be returned and the errno value will be set to indicate the nature of the error.
Assumptions/Limitations:
POSIX Compatibility: Non-standard NuttX interface. Should not be used in portable code. Analogous to pthread_muxtexattr_setprotocol().
2.6 Clocks and Timers |
Function Prototype:
#include <time.h>
int clock_settime(clockid_t clockid, const struct timespec *tp);
Description:
Input Parameters:
parm. Returned Value: If successful, the clock_settime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:
Function Prototype:
#include <time.h>
int clock_gettime(clockid_t clockid, struct timespec *tp);
Description:
Input Parameters:
parm. Returned Value: If successful, the clock_gettime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:
Function Prototype:
#include <time.h>
int clock_getres(clockid_t clockid, struct timespec *res);
Description:
Input Parameters:
parm. Returned Value: If successful, the clock_getres() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:
Function Prototype:
#include <time.h>
time_t mktime(struct tm *tp);
Description:
Input Parameters:
parm. Returned Value: If successful, the mktime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:
Function Prototype:
#include <time.h>
FAR struct tm *gmtime(FAR const time_t *timep);
Description: Represents GMT date/time in a type struct tm. This function is not re-entrant.
Input Parameters:
timep. Represents GMT calendar time. This is an absolute time value representing the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC). Returned Value: If successful, the gmtime() function will return the pointer to a statically defined instance of struct tm. Otherwise, a NULL will be returned to indicate the error:
#include <time.h> #ifdef CONFIG_LIBC_LOCALTIME # define localtime(c) gmtime(c) #else FAR struct tm *localtime(FAR const time_t *timep); #endif
Description: Represents local date/time in a type struct tm. This function is not re-entrant.
Input Parameters:
timep. Represents GMT calendar time. This is an absolute time value representing the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC). Returned Value: Returned Value: If successful, the localtime() function will return the pointer to a statically defined instance of struct tm. Otherwise, a NULL will be returned to indicate the error:
Function Prototype:
#include <time.h> FAR char *asctime(FAR const struct tm *tp);
Description: asctime() convert the time provided in a struct tm to a string representation. asctime() is not re-entrant.
Input Parameters:
tp. Pointer to the time to be converted. Returned Value: If successful, the asctime() function will return a pointer to a statically defined string holding the converted time. Otherwise, a NULL will be returned to indicate the error.
Function Prototype:
#include <time.h> FAR char *ctime(FAR const time_t *timep);
Description: ctime() converts the time provided in seconds since the epoch to a string representation. ctime() is not re-entrant.
Input Parameters:
timep. The current time represented as seconds since the epoch. Returned Value: If successful, the ctime() function will return the pointer to the converted string. Otherwise, a NULL will be returned to indicate the error.
Function Prototype:
#include <time.h>
struct tm *gmtime_r(const time_t *timep, struct tm *result);
Description: Represents GMT date/time in a type struct tm. This function is re-entrant.
Input Parameters:
timep. Represents GMT calendar time. This is an absolute time value representing the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC). result. A user-provided buffer to receive the converted time structure. Returned Value: If successful, the gmtime_r() function will return the pointer, result, provided by the caller. Otherwise, a NULL will be returned to indicate the error:
#include <time.h> #ifdef CONFIG_LIBC_LOCALTIME # define localtime_r(c,r) gmtime_r(c,r) #else FAR struct tm *localtime_r(FAR const time_t *timep, FAR struct tm *result); #endif
Description: Represents local date/time in a type struct tm. This function is re-entrant.
Input Parameters:
timep. Represents GMT calendar time. This is an absolute time value representing the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC). result. A user-provided buffer to receive the converted time structure. Returned Value: Returned Value: If successful, the localtime_r() function will return the pointer, result, provided by the caller. Otherwise, a NULL will be returned to indicate the error:
Function Prototype:
#include <time.h> FAR char *asctime_r(FAR const struct tm *tp, FAR char *buf);
Description: asctime_r() converts the time provided in a struct tm to a string representation. asctime-r() is re-entrant.
Input Parameters:
tp. Pointer to the time to be converted. buf. The user provider buffer. of size >= 26 characters, to receive the converted time. Returned Value: If successful, the asctime_r() function will return the pointer, buf, provided by the caller. Otherwise, a NULL will be returned to indicate the error.
Function Prototype:
#include <time.h> FAR char *ctime_r(FAR const time_t *timep, FAR char *buf);
Description: ctime_r() converts the time provided in seconds since the epoch to a string representation. ctime() is re-entrant.
Input Parameters:
timep. The current time represented as seconds since the epoch. buf. The user provider buffer. of size >= 26 characters, to receive the converted time. Returned Value: If successful, the ctime_r() function will return the pointer, buf, provided by the caller. Otherwise, a NULL will be returned to indicate the error.
Function Prototype:
#include <time.h>
int timer_create(clockid_t clockid, struct sigevent *evp, timer_t *timerid);
Description: The timer_create() function creates per-thread timer using the specified clock, clock_id, as the timing base. The timer_create() function returns, in the location referenced by timerid, a timer ID of type timer_t used to identify the timer in timer requests. This timer ID is unique until the timer is deleted. The particular clock, clock_id, is defined in <time.h>. The timer whose ID is returned will be in a disarmed state upon return from timer_create().
The evp argument, if non-NULL, points to a sigevent structure. This structure is allocated by the called and defines the asynchronous notification to occur. If the evp argument is NULL, the effect is as if the evp argument pointed to a sigevent structure with the sigev_notify member having the value SIGEV_SIGNAL, the sigev_signo having a default signal number, and the sigev_value member having the value of the timer ID.
Each implementation defines a set of clocks that can be used as timing bases for per-thread timers. All implementations will support a clock_id of CLOCK_REALTIME.
Input Parameters:
clockid. Specifies the clock to use as the timing base. Must be CLOCK_REALTIME.evp. Refers to a user allocated sigevent structure that defines the asynchronous notification. evp may be NULL (see above).timerid. The pre-thread timer created by the call to timer_create(). Returned Value: If the call succeeds, timer_create() will return 0 (OK) and update the location referenced by timerid to a timer_t, which can be passed to the other per-thread timer calls. If an error occurs, the function will return a value of -1 (ERROR) and set errno to indicate the error.
EAGAIN. The system lacks sufficient signal queuing resources to honor the request.EAGAIN. The calling process has already created all of the timers it is allowed by this implementation.EINVAL. The specified clock ID is not defined.ENOTSUP. The implementation does not support the creation of a timer attached to the CPU-time clock that is specified by clock_id and associated with a thread different thread invoking timer_create().POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
CLOCK_REALTIME is supported for the clockid argument.Function Prototype:
#include <time.h>
int timer_delete(timer_t timerid);
Description: The timer_delete() function deletes the specified timer, timerid, previously created by the timer_create() function. If the timer is armed when timer_delete() is called, the timer will be automatically disarmed before removal. The disposition of pending signals for the deleted timer is unspecified.
Input Parameters:
timerid. The pre-thread timer, previously created by the call to timer_create(), to be deleted. Returned Value: If successful, the timer_delete() function will return zero (OK). Otherwise, the function will return a value of -1 (ERROR) and set errno to indicate the error:
EINVAL. The timer specified timerid is not valid.POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <time.h>
int timer_settime(timer_t timerid, int flags, const struct itimerspec *value,
struct itimerspec *ovalue);
Description: The timer_settime() function sets the time until the next expiration of the timer specified by timerid from the it_value member of the value argument and arm the timer if the it_value member of value is non-zero. If the specified timer was already armed when timer_settime() is called, this call will reset the time until next expiration to the value specified. If the it_value member of value is zero, the timer will be disarmed. The effect of disarming or resetting a timer with pending expiration notifications is unspecified.
If the flag TIMER_ABSTIME is not set in the argument flags, timer_settime() will behave as if the time until next expiration is set to be equal to the interval specified by the it_value member of value. That is, the timer will expire in it_value nanoseconds from when the call is made. If the flag TIMER_ABSTIME is set in the argument flags, timer_settime() will behave as if the time until next expiration is set to be equal to the difference between the absolute time specified by the it_value member of value and the current value of the clock associated with timerid. That is, the timer will expire when the clock reaches the value specified by the it_value member of value. If the specified time has already passed, the function will succeed and the expiration notification will be made.
The reload value of the timer will be set to the value specified by the it_interval member of value. When a timer is armed with a non-zero it_interval, a periodic (or repetitive) timer is specified.
Time values that are between two consecutive non-negative integer multiples of the resolution of the specified timer will be rounded up to the larger multiple of the resolution. Quantization error will not cause the timer to expire earlier than the rounded time value.
If the argument ovalue is not NULL, the timer_settime() function will store, in the location referenced by ovalue, a value representing the previous amount of time before the timer would have expired, or zero if the timer was disarmed, together with the previous timer reload value. Timers will not expire before their scheduled time.
ovalue argument is ignored. Input Parameters:
timerid. The pre-thread timer, previously created by the call to timer_create(), to be be set.flags. Specify characteristics of the timer (see above)value. Specifies the timer value to setovalue. A location in which to return the time remaining from the previous timer setting (ignored). Returned Value: If the timer_gettime() succeeds, a value of 0 (OK) will be returned. If an error occurs, the value -1 (ERROR) will be returned, and errno set to indicate the error.
EINVAL. The timerid argument does not correspond to an ID returned by timer_create() but not yet deleted by timer_delete().EINVAL. A value structure specified a nanosecond value less than zero or greater than or equal to 1000 million, and the it_value member of that structure did not specify zero seconds and nanoseconds.POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
ovalue argument is ignored.Function Prototype:
#include <time.h>
int timer_gettime(timer_t timerid, struct itimerspec *value);
Description: The timer_gettime() function will store the amount of time until the specified timer, timerid, expires and the reload value of the timer into the space pointed to by the value argument. The it_value member of this structure will contain the amount of time before the timer expires, or zero if the timer is disarmed. This value is returned as the interval until timer expiration, even if the timer was armed with absolute time. The it_interval member of value will contain the reload value last set by timer_settime().
Due to the asynchronous operation of this function, the time reported by this function could be significantly more than that actual time remaining on the timer at any time.
Input Parameters:
timerid. Specifies pre-thread timer, previously created by the call to timer_create(), whose remaining count will be returned. Returned Value: If successful, the timer_gettime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:
EINVAL. The timerid argument does not correspond to an ID returned by timer_create() but not yet deleted by timer_delete().POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <time.h>
int timer_getoverrun(timer_t timerid);
Description: Only a single signal will be queued to the process for a given timer at any point in time. When a timer for which a signal is still pending expires, no signal will be queued, and a timer overrun will occur. When a timer expiration signal is delivered to or accepted by a process, if the implementation supports the Realtime Signals Extension, the timer_getoverrun() function will return the timer expiration overrun count for the specified timer. The overrun count returned contains the number of extra timer expirations that occurred between the time the signal was generated (queued) and when it was delivered or accepted, up to but not including an implementation-defined maximum of DELAYTIMER_MAX. If the number of such extra expirations is greater than or equal to DELAYTIMER_MAX, then the overrun count will be set to DELAYTIMER_MAX. The value returned by timer_getoverrun() will apply to the most recent expiration signal delivery or acceptance for the timer. If no expiration signal has been delivered for the timer, or if the Realtime Signals Extension is not supported, the return value of timer_getoverrun() is unspecified.
NOTE: This interface is not currently implemented in NuttX.
Input Parameters:
timerid. Specifies pre-thread timer, previously created by the call to timer_create(), whose overrun count will be returned. Returned Value: If the timer_getoverrun() function succeeds, it will return the timer expiration overrun count as explained above. timer_getoverrun() will fail if:
EINVAL. The timerid argument does not correspond to an ID returned by timer_create() but not yet deleted by timer_delete().POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the full POSIX implementation include:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <sys/time.h>
int gettimeofday(struct timeval *tp, void *tzp);
Description: This implementation of gettimeofday() is simply a thin wrapper around clock_gettime(). It simply calls clock_gettime() using the CLOCK_REALTIME timer and converts the result to the required struct timeval.
Input Parameters:
tp. The current time will be returned to this user provided location.tzp. A reference to the timezone -- IGNORED. Returned Value: See clock_gettime().
2.7 Signal Interfaces |
Tasks and Signals. NuttX provides signal interfaces for tasks and pthreads. Signals are used to alter the flow control of tasks by communicating asynchronous events within or between task contexts. Any task or interrupt handler can post (or send) a signal to a particular task using its task ID. The task being signaled will execute task-specified signal handler function the next time that the task has priority. The signal handler is a user-supplied function that is bound to a specific signal and performs whatever actions are necessary whenever the signal is received.
By default, here are no predefined actions for any signal. The default action for all signals (i.e., when no signal handler has been supplied by the user) is to ignore the signal. In this sense, all NuttX are real time signals by default. If the configuration option CONFIG_SIG_DEFAULT=y is included, some signals will perform their default actions dependent upon addition configuration settings as summarized in the following table:
| Signal | Action | Additional Configuration |
|---|---|---|
SIGUSR1 | Abnormal Termination | CONFIG_SIG_SIGUSR1_ACTION |
SIGUSR2 | Abnormal Termination | CONFIG_SIG_SIGUSR2_ACTION |
SIGALRM | Abnormal Termination | CONFIG_SIG_SIGALRM_ACTION |
SIGPOLL | Abnormal Termination | CONFIG_SIG_SIGPOLL_ACTION |
SIGSTOP | Suspend task | CONFIG_SIG_SIGSTOP_ACTION |
SIGSTP | Suspend task | CONFIG_SIG_SIGSTOP_ACTION |
SIGCONT | Resume task | CONFIG_SIG_SIGSTOP_ACTION |
SIGINT | Abnormal Termination | CONFIG_SIG_SIGKILL_ACTION |
SIGKILL | Abnormal Termination | CONFIG_SIG_SIGKILL_ACTION |
Tasks may also suspend themselves and wait until a signal is received.
Tasks Groups. NuttX supports both tasks and pthreads. The primary difference between tasks and pthreads is the tasks are much more independent. Tasks can create pthreads and those pthreads will share the resources of the task. The main task and its children pthreads together are referred as a task group. A task group is used in NuttX to emulate a POSIX process.
NOTE: Behavior of features related to task groups depend of NuttX configuration settings. See also the NuttX Tasking page and the Tasks vs. Threads FAQ for additional information on tasks and threads in NuttX.
Signaling Multi-threaded Task Groups. The behavior of signals in the multi-thread task group is complex. NuttX emulates a process model with task groups and follows the POSIX rules for signaling behavior. Normally when you signal the task group you would signal using the task ID of the main task that created the group (in practice, a different task should not know the IDs of the internal threads created within the task group); that ID is remembered by the task group (even if the main task thread exits).
Here are some of the things that should happen when you signal a multi-threaded task group:
You can mask out that signal using ''sigprocmask()'' (or ''pthread_sigmask()''). That signal will then be effectively disabled and will never be received in those threads that have the signal masked. On creation of a new thread, the new thread will inherit the signal mask of the parent thread that created it. So you if block signal signals on one thread then create new threads, those signals will also be blocked in the new threads as well.
You can control which thread receives the signal by controlling the signal mask. You can, for example, create a single thread whose sole purpose it is to catch a particular signal and respond to it: Simply block the signal in the main task; then the signal will be blocked in all of the pthreads in the group too. In the one "signal processing" pthread, enable the blocked signal. This thread will then be only thread that will receive the signal.
Signal Interfaces. The following signal handling interfaces are provided by NuttX:
Function Prototype:
#include <signal.h>
int sigemptyset(sigset_t *set);
Description: This function initializes the signal set specified by set such that all signals are excluded.
Input Parameters:
set. Signal set to initialize. Returned Value:
OK), or -1 (ERROR) if the signal set cannot be initialized. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sigfillset(sigset_t *set);
Description: This function initializes the signal set specified by set such that all signals are included.
Input Parameters:
set. Signal set to initialize Returned Value:
OK), or -1 (ERROR) if the signal set cannot be initialized. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sigaddset(sigset_t *set, int signo);
Description: This function adds the signal specified by signo to the signal set specified by set.
Input Parameters:
set. Signal set to add signal to signo. Signal to add Returned Value:
OK), or -1 (ERROR) if the signal number is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sigdelset(sigset_t *set, int signo);
Description: This function deletes the signal specified by signo from the signal set specified by set.
Input Parameters:
set. Signal set to delete the signal from signo. Signal to delete Returned Value:
OK), or -1 (ERROR) if the signal number is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sigismember(const sigset_t *set, int signo);
Description: This function tests whether the signal specified by signo is a member of the set specified by set.
Input Parameters:
set. Signal set to test signo. Signal to test for Returned Value:
ERROR) if the signal number is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sigaction(int signo, const struct sigaction *act,
struct sigaction *oact);
Description: This function allows the calling task to examine and/or specify the action to be associated with a specific signal.
The structure sigaction, used to describe an action to be taken, is defined to include the following members:
sa_u.sa_handler. A pointer to a signal-catching function. sa_u.sa_sigaction. An alternative form for the signal catching function. sa_mask. Additional set of signals to be blocked during execution of the signal-catching function. sa_flags: Special flags to affect behavior of a signal. If the argument act is not NULL, it points to a structure specifying the action to be associated with the specified signal. If the argument oact is not NULL, the action previously associated with the signal is stored in the location pointed to by the argument oact. If the argument act is NULL, signal handling is unchanged by this function call; thus, the call can be used to inquire about the current handling of a given signal.
When a signal is caught by a signal-catching function installed by the sigaction() function, a new signal mask is calculated and installed for the duration of the signal-catching function. This mask is formed by taking the union of the current signal mask and the value of the sa_mask for the signal being delivered, and then including the signal being delivered. If and when the signal handler returns, the original signal mask is restored.
Signal catching functions execute in the same address environment as the task that called sigaction() to install the signal-catching function.
Once an action is installed for a specific signal, it remains installed until another action is explicitly requested by another call to sigaction().
Input Parameters:
sig. Signal of interest act. Location of new handler oact. Location to store old handler Returned Value:
OK), or -1 (ERROR) if the signal number is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the POSIX implementation include:
SIG_DFL is treated like SIG_IGN. sa_flags in struct sigaction of act input are ignored (all treated like SA_SIGINFO). The one exception is if CONFIG_SCHED_CHILD_STATUS is defined; then SA_NOCLDWAIT is supported but only for SIGCHLD. Function Prototype:
#include <signal.h>
int sigignore(int signo);
Description: The sigignore() function will set the disposition of signo to SIG_IGN.
Input Parameters:
signo. The signal number to act on Returned Value:
ERROR) is returned with the errno value of EINVAL, for example, would indicate that signo argument is not a valid signal number. Function Prototype:
#include <signal.h>
void (*sigset(int signo, void (*disp)(int)))(int);
Description: The sigset() function will modify signal dispositions. The signo argument specifies the signal. The disp argument specifies the signal's disposition, which may be SIG_DFL, SIG_IGN, or the address of a signal handler. If disp is the address of a signal handler, the system will add signo to the calling process's signal mask before executing the signal handler; when the signal handler returns, the system will restore the calling process's signal mask to its state prior to the delivery of the signal. signo will be removed from the calling process's signal mask.
NOTE: The value SIG_HOLD for disp is not currently supported.
Input Parameters:
signo. The signal number to operate on disp. The new disposition of the signal Returned Value:
sigset() will the previous disposition of the signal. Otherwise, SIG_ERR will be returned and errno set to indicate the error. Function Prototype:
#include <signal.h>
int sigprocmask(int how, const sigset_t *set, sigset_t *oset);
Description: This function allows the calling task to examine and/or change its signal mask. If the set is not NULL, then it points to a set of signals to be used to change the currently blocked set. The value of how indicates the manner in which the set is changed.
If there are any pending unblocked signals after the call to sigprocmask(), those signals will be delivered before sigprocmask() returns.
If sigprocmask() fails, the signal mask of the task is not changed.
Input Parameters:
how. How the signal mast will be changed: SIG_BLOCK. The resulting set is the union of the current set and the signal set pointed to by the set input parameter. SIG_UNBLOCK. The resulting set is the intersection of the current set and the complement of the signal set pointed to by the set input parameter. SIG_SETMASK. The resulting set is the signal set pointed to by the set input parameter. set. Location of the new signal mask oset. Location to store the old signal mask Returned Value:
OK), or -1 (ERROR) if how is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sighold(int signo);
Description: The sighold() function will add signo to the calling process's signal mask
Input Parameters:
signo. Identifies the signal to be blocked. Returned Value:
ERROR) is returned with the errno value of EINVAL, for example, would indicate that signo argument is not a valid signal number. Function Prototype:
#include <signal.h>
int sigrelse(int signo);
Description: The sighold() function will remove signo from the calling process's signal mask
Input Parameters:
signo. Identifies the signal to be unblocked. Returned Value:
ERROR) is returned with the errno value of EINVAL, for example, would indicate that signo argument is not a valid signal number. Function Prototype:
#include <signal.h>
int sigpending(sigset_t *set);
Description: This function stores the returns the set of signals that are blocked for delivery and that are pending for the calling task in the space pointed to by set.
If the task receiving a signal has the signal blocked via its sigprocmask, the signal will pend until it is unmasked. Only one pending signal (for a given signo) is retained by the system. This is consistent with POSIX which states: "If a subsequent occurrence of a pending signal is generated, it is implementation defined as to whether the signal is delivered more than once."
Input Parameters:
set. The location to return the pending signal set. Returned Value:
OK) or -1 (ERROR) Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sigsuspend(const sigset_t *set);
Description: The sigsuspend() function replaces the signal mask with the set of signals pointed to by the argument set and then suspends the task until delivery of a signal to the task.
If the effect of the set argument is to unblock a pending signal, then no wait is performed.
The original signal mask is restored when sigsuspend() returns.
Waiting for an empty signal set stops a task without freeing any resources (a very bad idea).
Input Parameters:
set. The value of the signal mask to use while suspended. Returned Value:
ERROR) always Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the POSIX specification include:
Function Prototype:
#include <signal.h>
int sigpause(int signo);
Description: The sigpause()) function will remove signo) from the calling process's signal mask and suspend the calling process until a signal is received. The sigpause()) function will restore the process's signal mask to its original state before returning.
Input Parameters:
set. Identifies the signal to be unblocked while waiting. Returned Value:
sigpause always returns -1 (ERROR). On a successful wait for a signal, the errno will be set to EINTR. Function Prototype:
#include <signal.h>
int sigwaitinfo(const sigset_t *set, struct siginfo *info);
Description: This function is equivalent to sigtimedwait() with a NULL timeout parameter. (see below).
Input Parameters:
set. The set of pending signals to wait for. info. The returned signal values Returned Value:
ERROR) is returned. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
int sigtimedwait(const sigset_t *set, struct siginfo *info,
const struct timespec *timeout);
Description: This function selects the pending signal set specified by the argument set. If multiple signals are pending in set, it will remove and return the lowest numbered one. If no signals in set are pending at the time of the call, the calling task will be suspended until one of the signals in set becomes pending OR until the task interrupted by an unblocked signal OR until the time interval specified by timeout (if any), has expired. If timeout is NULL, then the timeout interval is forever.
If the info argument is non-NULL, the selected signal number is stored in the si_signo member and the cause of the signal is store in the si_code member. The content of si_value is only meaningful if the signal was generated by sigqueue(). The following values for si_code are defined in signal.h:
SI_USER. Signal sent from kill, raise, or abort SI_QUEUE. Signal sent from sigqueue SI_TIMER. Signal is result of timer expiration SI_ASYNCIO. Signal is the result of asynchronous IO completion SI_MESGQ. Signal generated by arrival of a message on an empty message queue. Input Parameters:
set. The set of pending signals to wait for. info. The returned signal values timeout. The amount of time to wait Returned Value:
ERROR) is returned. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the POSIX interface include:
Function Prototype:
#include <signal.h>
int sigqueue (int tid, int signo, union sigval value);
Description: This function sends the signal specified by signo with the signal parameter value to the task specified by tid.
If the receiving task has the signal blocked via its sigprocmask, the signal will pend until it is unmasked. Only one pending signal (for a given signo) is retained by the system. This is consistent with POSIX which states: "If a subsequent occurrence of a pending signal is generated, it is implementation defined as to whether the signal is delivered more than once."
Input Parameters:
tid. ID of the task to receive signal signo. Signal number value. Value to pass to task with signal Returned Value:
OK) is returned. On error, -1 (ERROR) is returned, and errno is set appropriately. EGAIN. The limit of signals which may be queued has been reached.EINVAL. signo was invalid.EPERM. The task does not have permission to send the signal to the receiving process.ESRCH. No process has a PID matching pid.Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the POSIX interface include:
Function Prototype:
#include <sys/types.h> #include <signal.h> int kill(pid_t pid, int sig);
Description: The kill() system call can be used to send any signal to any task.
If the receiving task has the signal blocked via its sigprocmask, the signal will pend until it is unmasked. Only one pending signal (for a given signo) is retained by the system. This is consistent with POSIX which states: "If a subsequent occurrence of a pending signal is generated, it is implementation defined as to whether the signal is delivered more than once."
Input Parameters:
pid. The id of the task to receive the signal. The POSIX kill() specification encodes process group information as zero and negative pid values. Only positive, non-zero values of pid are supported by this implementation. ID of the task to receive signal signo. The signal number to send. If signo is zero, no signal is sent, but all error checking is performed. Returned Value:
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. Differences from the POSIX interface include:
Function Prototype:
#include <unistd.h> int pause(void);
Description: The pause() function will suspend the calling thread until delivery of a non-blocked signal.
Returned Value: Since pause() suspends thread execution indefinitely unless interrupted a signal, there is no successful completion return value. A value of -1 (ERROR will always be returned and errno set to indicate the error (EINTR).
Assumptions/Limitations:
POSIX Compatibility: In the POSIX description of this function is the pause() function will suspend the calling thread until delivery of a signal whose action is either to execute a signal-catching function or to terminate the process. This implementation only waits for any non-blocked signal to be received.
2.8 Pthread Interfaces |
NuttX does not support processes in the way that, say, Linux does. NuttX only supports simple threads or tasks running within the same address space. However, NuttX does support the concept of a task group. A task group is the functional analog of a process: It is a group that consists of the main task thread and of all of the pthreads created by the main thread or any of the other pthreads within the task group. Members of a task group share certain resources such as environment variables, file descriptors, FILE streams, sockets, pthread keys and open message queues.
NOTE: Behavior of features related to task groups depend of NuttX configuration settings. See also the NuttX Tasking page and the Tasks vs. Threads FAQ for additional information on tasks and threads in NuttX.
The following pthread interfaces are supported in some form by NuttX:
pthread control interfaces. Interfaces that allow you to create and manage pthreads.
Thread Specific Data. These interfaces can be used to create pthread keys and then to access thread-specific data using these keys. Each task group has its own set of pthread keys. NOTES: (1) pthread keys create in one task group are not accessible in other task groups. (2) The main task thread does not have thread-specific data.
pthread Mutexes.
Condition Variables.
Barriers.
Initialization.
Signals.
No support for the following pthread interfaces is provided by NuttX:
pthread_atfork. register fork handlers.pthread_attr_getdetachstate. get and set the detachstate attribute.pthread_attr_getguardsize. get and set the thread guardsize attribute.pthread_attr_getinheritsched. get and set the inheritsched attribute.pthread_attr_getscope. get and set the contentionscope attribute.pthread_attr_getstack. get and set stack attributes.pthread_attr_getstackaddr. get and set the stackaddr attribute.pthread_attr_setdetachstate. get and set the detachstate attribute.pthread_attr_setguardsize. get and set the thread guardsize attribute.pthread_attr_setscope. get and set the contentionscope attribute.pthread_attr_setstack. get and set stack attributes.pthread_attr_setstackaddr. get and set the stackaddr attribute.pthread_condattr_getclock. set the clock selection condition variable attribute.pthread_condattr_getpshared. get the process-shared condition variable attribute.pthread_condattr_setclock. set the clock selection condition variable attribute.pthread_condattr_setpshared. set the process-shared condition variable attribute.pthread_getconcurrency. get and set the level of concurrency.pthread_getcpuclockid. access a thread CPU-time clock.pthread_mutex_getprioceiling. get and set the priority ceiling of a mutex.pthread_mutex_setprioceiling. get and set the priority ceiling of a mutex.pthread_mutex_timedlock. lock a mutex.pthread_mutexattr_getprioceiling. get and set the prioceiling attribute of the mutex attributes object.pthread_mutexattr_setprioceiling. get and set the prioceiling attribute of the mutex attributes object.pthread_rwlockattr_destroy. destroy and initialize the read-write lock attributes object.pthread_rwlockattr_getpshared. get and set the process-shared attribute of the read-write lock attributes object.pthread_rwlockattr_init. destroy and initialize the read-write lock attributes object.pthread_rwlockattr_setpshared. get and set the process-shared attribute of the read-write lock attributes object.pthread_setconcurrency. get and set the level of concurrency.pthread_spin_destroy. destroy or initialize a spin lock object.pthread_spin_init. destroy or initialize a spin lock object.pthread_spin_lock. lock a spin lock object.pthread_spin_trylock. lock a spin lock object.pthread_spin_unlock. unlock a spin lock object.Function Prototype:
#include <pthread.h>
int pthread_attr_init(pthread_attr_t *attr);
Description: Initializes a thread attributes object (attr) with default values for all of the individual attributes used by the implementation.
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_init() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_destroy(FAR pthread_attr_t *attr);
Description: An attributes object can be deleted when it is no longer needed.
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_destroy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_setschedpolicy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_getschedpolicy(FAR const pthread_attr_t *attr, FAR int *policy);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_getschedpolicy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_setschedparam(pthread_attr_t *attr,
const struct sched_param *param);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_getschedpolicy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_getschedparam(pthread_attr_t *attr,
struct sched_param *param);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_getschedparam() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_setinheritsched(pthread_attr_t *attr,
int inheritsched);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_setinheritsched() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_getinheritsched(const pthread_attr_t *attr,
int *inheritsched);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_getinheritsched() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_setstacksize(pthread_attr_t *attr, long stacksize);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_setstacksize() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_attr_getstacksize(FAR const pthread_attr_t *attr, FAR size_t *stackaddr);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_attr_getstacksize() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_create(pthread_t *thread, pthread_attr_t *attr,
pthread_startroutine_t startRoutine,
pthread_addr_t arg);
Description: To create a thread object and runnable thread, a routine must be specified as the new thread's start routine. An argument may be passed to this routine, as an untyped address; an untyped address may also be returned as the routine's value. An attributes object may be used to specify details about the kind of thread being created.
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_create() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_detach(pthread_t thread);
Description: A thread object may be "detached" to specify that the return value and completion status will not be requested.
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_detach() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
void pthread_exit(pthread_addr_t pvValue);
Description: A thread may terminate it's own execution.
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_exit() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_cancel(pthread_t thread);
Description:
The pthread_cancel() function will request that thread be canceled. The target thread's cancellability state, enabled, or disabled, determines when the cancellation takes effect: When the cancellation is acted on, thread will be terminated. When cancellability is disabled, all cancellations are held pending in the target thread until the thread re-enables cancellability.
The target thread's cancellability state determines how the cancellation is acted on: Either asynchronously or deferred. Asynchronous cancellations will be acted upon immediately (when enabled), interrupting the thread with its processing in an arbitrary state.
When cancellability is deferred, all cancellations are held pending in the target thread until the thread changes the cancellability type or a Cancellation Point function such as pthread_testcancel() is entered.
Input Parameters:
thread. Identifies the thread to be canceled.Returned Value:
If successful, the pthread_cancel() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
ESRCH. No thread could be found corresponding to that specified by the given thread ID.POSIX Compatibility: Comparable to the POSIX interface of the same name. Except:
Function Prototype:
#include <pthread.h>
int pthread_setcancelstate(int state, int *oldstate);
Description:
The pthread_setcancelstate() function atomically sets both the calling thread's cancellability state to the indicated state and returns the previous cancellability state at the location referenced by oldstate. Legal values for state are PTHREAD_CANCEL_ENABLE and PTHREAD_CANCEL_DISABLE.
Any pending thread cancellation may occur at the time that the cancellation state is set to PTHREAD_CANCEL_ENABLE.
Input Parameters:
state New cancellation state. One of PTHREAD_CANCEL_ENABLE or PTHREAD_CANCEL_DISABLE.oldstate. Location to return the previous cancellation state. Returned Value:
If successful, the pthread_setcancelstate() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
ESRCH. No thread could be found corresponding to that specified by the given thread ID.POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_setcanceltype(int type, FAR int *oldtype);
Description: The pthread_setcanceltype() function atomically both sets the calling thread's cancellability type to the indicated type and returns the previous cancellability type at the location referenced by oldtype. Legal values for type are PTHREAD_CANCEL_DEFERRED and PTHREAD_CANCEL_ASYNCHRONOUS.
The cancellability state and type of any newly created threads are PTHREAD_CANCEL_ENABLE and PTHREAD_CANCEL_DEFERRED respectively.
Input Parameters:
type New cancellation state. One of PTHREAD_CANCEL_DEFERRED or PTHREAD_CANCEL_ASYNCHRONOUS.oldtype. Location to return the previous cancellation type. Returned Value:
If successful, the pthread_setcancelstate() function will return zero (OK). Otherwise, an error number will be returned to indicate the error.
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
void pthread_testcancel(void);
Description:
The pthread_testcancel() function creates a Cancellation Point in the calling thread. The pthread_testcancel() function has no effect if cancellability is disabled.
Input Parameters: None
Returned Value: None
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
void pthread_cleanup_pop(int execute);
Description:
The pthread_cleanup_pop() function will remove the routine at the top of the calling thread's cancellation cleanup stack and optionally invoke it (if execute is non-zero).
Input Parameters:
execute. Execute the popped cleanup function immediately.Returned Value:
If successful, the pthread_setcancelstate() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
void pthread_cleanup_push(CODE void (*routine)(FAR void *), FAR void *arg);
Description:
The pthread_cleanup_push() function will push the specified cancellation cleanup handler routine onto the calling thread's cancellation cleanup stack.
The cancellation cleanup handler will be popped from the cancellation cleanup stack and invoked with the argument arg when:
pthread_exit()).pthread_cleanup_pop() with a non-zero execute argument.Input Parameters:
routine. The cleanup routine to be pushed on the cleanup stack.arg. An argument that will accompany the callback.Returned Value:
If successful, the pthread_setcancelstate() function will return zero (OK). Otherwise, an error number will be returned to indicate the error.
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_join(pthread_t thread, pthread_addr_t *ppvValue);
Description: A thread can await termination of another thread and retrieve the return value of the thread.
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_join() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
void pthread_yield(void);
Description: A thread may tell the scheduler that its processor can be made available.
Input Parameters:
Returned Value:
pthread_yield() function always succeeds.Assumptions/Limitations:
POSIX Compatibility: This call is nonstandard, but present on several other systems. Use the POSIX sched_yield() instead.
Function Prototype:
#include <pthread.h>
pthread_t pthread_self(void);
Description: A thread may obtain a copy of its own thread handle.
Input Parameters:
Returned Value:
If successful, the pthread_self() function will return copy of caller's thread handle. Otherwise, in exceptional circumstances, the negated error code -ESRCH can be returned if the system cannot deduce the identity of the calling thread.
POSIX Compatibility: Comparable to the POSIX interface of the same name. The -ESRCH return value is non-standard; POSIX says pthread_self() must always succeed. NuttX implements pthread_self() as a macro only, not as a function as required by POSIX.
Function Prototype:
#include <pthread.h>
int pthread_getschedparam(pthread_t thread, int *policy,
struct sched_param *param);
Description: The pthread_getschedparam() functions will get the scheduling policy and parameters of threads. For SCHED_FIFO and SCHED_RR, the only required member of the sched_param structure is the priority sched_priority.
The pthread_getschedparam() function will retrieve the scheduling policy and scheduling parameters for the thread whose thread ID is given by thread and will store those values in policy and param, respectively. The priority value returned from pthread_getschedparam() will be the value specified by the most recent pthread_setschedparam(), pthread_setschedprio(), or pthread_create() call affecting the target thread. It will not reflect any temporary adjustments to its priority (such as might result of any priority inheritance, for example).
The policy parameter may have the value SCHED_FIFO, SCHED_RR, or SCHED_SPORADIC. SCHED_RR requires the configuration setting CONFIG_RR_INTERVAL > 0; SCHED_SPORADIC requires the configuration setting CONFIG_SCHED_SPORADIC=y. (SCHED_OTHER and non-standard scheduler policies, in particular, are not supported). The SCHED_FIFO and SCHED_RR policies will have a single scheduling parameter:
sched_priority The thread priority. The SCHED_SPORADIC policy has four additional scheduling parameters:
sched_ss_low_priority Low scheduling priority for sporadic server. sched_ss_repl_period Replenishment period for sporadic server. sched_ss_init_budget Initial budget for sporadic server. sched_ss_max_repl Maximum pending replenishments for sporadic server. Input Parameters:
thread. The ID of thread whose scheduling parameters will be queried. policy. The location to store the thread's scheduling policy. param. The location to store the thread's priority. Returned Value: 0 (OK) if successful. Otherwise, the error code ESRCH if the value specified by thread does not refer to an existing thread.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_setschedparam(pthread_t thread, int policy,
const struct sched_param *param);
Description: The pthread_setschedparam() functions will set the scheduling policy and parameters of threads. For SCHED_FIFO and SCHED_RR, the only required member of the sched_param structure is the priority sched_priority.
pthread_setschedparam() function will set the scheduling policy and associated scheduling parameters for the thread whose thread ID is given by thread to the policy and associated parameters provided in policy and param, respectively. The policy parameter may have the value SCHED_FIFO or SCHED_RR. (SCHED_OTHER and SCHED_SPORADIC, in particular, are not supported). The SCHED_FIFO and SCHED_RR policies will have a single scheduling parameter, sched_priority.
If the pthread_setschedparam() function fails, the scheduling parameters will not be changed for the target thread.
Input Parameters:
thread. The ID of thread whose scheduling parameters will be modified. policy. The new scheduling policy of the thread. Either SCHED_FIFO or SCHED_RR. SCHED_OTHER and SCHED_SPORADIC are not supported. param. The location to store the thread's priority. Returned Value:
If successful, the pthread_setschedparam() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
EINVAL. The value specified by policy or one of the scheduling parameters associated with the scheduling policy policy is invalid. ENOTSUP. An attempt was made to set the policy or scheduling parameters to an unsupported value (SCHED_OTHER and SCHED_SPORADIC in particular are not supported) EPERM. The caller does not have the appropriate permission to set either the scheduling parameters or the scheduling policy of the specified thread. Or, the implementation does not allow the application to modify one of the parameters to the value specified. ESRCH. The value specified by thread does not refer to a existing thread. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_key_create(pthread_key_t *key, void (*destructor)(void*))
Description:
This function creates a thread-specific data key visible to all threads in the system. Although the same key value may be used by different threads, the values bound to the key by pthread_setspecific() are maintained on a per-thread basis and persist for the life of the calling thread.
Upon key creation, the value NULL will be associated with the new key in all active threads. Upon thread creation, the value NULL will be associated with all defined keys in the new thread.
Input Parameters:
key is a pointer to the key to create. destructor is an optional destructor function that may be associated with each key that is invoked when a thread exits. However, this argument is ignored in the current implementation. Returned Value:
If successful, the pthread_key_create() function will store the newly created key value at *key and return zero (OK). Otherwise, an error number will be returned to indicate the error:
EAGAIN. The system lacked sufficient resources to create another thread-specific data key, or the system-imposed limit on the total number of keys per task {PTHREAD_KEYS_MAX} has been exceeded. ENOMEM Insufficient memory exists to create the key. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
destructor argument. Function Prototype:
#include <pthread.h>
int pthread_setspecific(pthread_key_t key, void *value)
Description:
The pthread_setspecific() function associates a thread-specific value with a key obtained via a previous call to pthread_key_create(). Different threads may bind different values to the same key. These values are typically pointers to blocks of dynamically allocated memory that have been reserved for use by the calling thread.
The effect of calling pthread_setspecific() with a key value not obtained from pthread_key_create() or after a key has been deleted with pthread_key_delete() is undefined.
Input Parameters:
key. The data key to set the binding for. value. The value to bind to the key. Returned Value:
If successful, pthread_setspecific() will return zero (OK). Otherwise, an error number will be returned:
ENOMEM. Insufficient memory exists to associate the value with the key. EINVAL. The key value is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
pthread_setspecific() may be called from a thread-specific data destructor function. Function Prototype:
#include <pthread.h>
void *pthread_getspecific(pthread_key_t key)
Description:
The pthread_getspecific() function returns the value currently bound to the specified key on behalf of the calling thread.
The effect of calling pthread_getspecific() with a key value not obtained from pthread_key_create() or after a key has been deleted with pthread_key_delete() is undefined.
Input Parameters:
key. The data key to get the binding for. Returned Value:
The function pthread_getspecific() returns the thread-specific data associated with the given key. If no thread specific data is associated with the key, then the value NULL is returned.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
pthread_getspecific() may be called from a thread-specific data destructor function. Function Prototype:
#include <pthread.h>
int pthread_key_delete(pthread_key_t key)
Description:
This POSIX function deletes a thread-specific data key previously returned by pthread_key_create(). No cleanup actions are done for data structures related to the deleted key or associated thread-specific data in any threads. It is undefined behavior to use key after it has been deleted.
Input Parameters:
key. The key to delete Returned Value:
If successful, the pthread_key_delete() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
EINVAL. The parameter key is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutexattr_init(pthread_mutexattr_t *attr);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_mutexattr_init() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_mutexattr_destroy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutexattr_getpshared(pthread_mutexattr_t *attr,
int *pshared);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_mutexattr_getpshared() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutexattr_setpshared(pthread_mutexattr_t *attr,
int pshared);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_mutexattr_setpshared() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
#ifdef CONFIG_PTHREAD_MUTEX_TYPES
int pthread_mutexattr_gettype(FAR const pthread_mutexattr_t *attr, FAR int *type);
#endif
Description: Return the mutex type from the mutex attributes.
Input Parameters:
attr. The mutex attributes to querytype. Location to return the mutex type. See pthread_mutexattr_settype() for a description of possible mutex types that may be returned.Returned Value:
If successful, the pthread_mutexattr_settype() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
EINVAL. Parameters attr and/or attr are invalid.POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
#ifdef CONFIG_PTHREAD_MUTEX_TYPES
int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type);
#endif
Description: Set the mutex type in the mutex attributes.
Input Parameters:
attr. The mutex attributes in which to set the mutex type.type. The mutex type value to set. The following values are supported: PTHREAD_MUTEX_NORMAL. This type of mutex does not detect deadlock. A thread attempting to re-lock this mutex without first unlocking it will deadlock. Attempting to unlock a mutex locked by a different thread results in undefined behavior. Attempting to unlock an unlocked mutex results in undefined behavior. PTHREAD_MUTEX_ERRORCHECK. This type of mutex provides error checking. A thread attempting to re-lock this mutex without first unlocking it will return with an error. A thread attempting to unlock a mutex which another thread has locked will return with an error. A thread attempting to unlock an unlocked mutex will return with an error.PTHREAD_MUTEX_RECURSIVE. A thread attempting to re-lock this mutex without first unlocking it will succeed in locking the mutex. The re-locking deadlock which can occur with mutexes of type PTHREAD_MUTEX_NORMAL cannot occur with this type of mutex. Multiple locks of this mutex require the same number of unlocks to release the mutex before another thread can acquire the mutex. A thread attempting to unlock a mutex which another thread has locked will return with an error. A thread attempting to unlock an unlocked mutex will return with an error.PTHREAD_MUTEX_DEFAULT. The default mutex type (PTHREAD_MUTEX_NORMAL). In NuttX, PTHREAD_MUTEX_NORMAL is not implemented. Rather, the behavior described for PTHREAD_MUTEX_ERRORCHECK is the normal behavior.
Returned Value:
If successful, the pthread_mutexattr_settype() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
EINVAL. Parameters attr and/or attr are invalid.POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutexattr_getprotocol(FAR const pthread_mutexattr_t *attr,
FAR int *protocol);
Description: Return the value of the mutex protocol attribute..
Input Parameters:
attr. A pointer to the mutex attributes to be queriedprotocol. The user provided location in which to store the protocol value. May be one of PTHREAD_PRIO_NONE, or PTHREAD_PRIO_INHERIT, PTHREAD_PRIO_PROTECT.Returned Value:
If successful, the pthread_mutexattr_getprotocol() function will return zero (OK). Otherwise, an error number will be returned to indicate the error.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutexattr_setprotocol(FAR pthread_mutexattr_t *attr,
int protocol);
Description: Set mutex protocol attribute. See the paragraph Locking versus Signaling Semaphores for some important information about the use of this interface.
Input Parameters:
attr. A pointer to the mutex attributes to be modifiedprotocol. The new protocol to use. One of PTHREAD_PRIO_NONE, or PTHREAD_PRIO_INHERIT, PTHREAD_PRIO_PROTECT. PTHREAD_PRIO_INHERIT is supported only if CONFIG_PRIORITY_INHERITANCE is defined; PTHREAD_PRIO_PROTECT is not currently supported in any configuration.Returned Value:
If successful, the pthread_mutexattr_setprotocol() function will return zero (OK). Otherwise, an error number will be returned to indicate the error.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutex_init(pthread_mutex_t *mutex,
pthread_mutexattr_t *attr);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_mutex_init() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutex_destroy(pthread_mutex_t *mutex);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_mutex_destroy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutex_lock(pthread_mutex_t *mutex);
Description: The mutex object referenced by mutex is locked by calling pthread_mutex_lock(). If the mutex is already locked, the calling thread blocks until the mutex becomes available. This operation returns with the mutex object referenced by mutex in the locked state with the calling thread as its owner.
If the mutex type is PTHREAD_MUTEX_NORMAL, deadlock detection is not provided. Attempting to re-lock the mutex causes deadlock. If a thread attempts to unlock a mutex that it has not locked or a mutex which is unlocked, undefined behavior results.
In NuttX, PTHREAD_MUTEX_NORMAL is not implemented. Rather, the behavior described for PTHREAD_MUTEX_ERRORCHECK is the normal behavior.
If the mutex type is PTHREAD_MUTEX_ERRORCHECK, then error checking is provided. If a thread attempts to re-lock a mutex that it has already locked, an error will be returned. If a thread attempts to unlock a mutex that it has not locked or a mutex which is unlocked, an error will be returned.
If the mutex type is PTHREAD_MUTEX_RECURSIVE, then the mutex maintains the concept of a lock count. When a thread successfully acquires a mutex for the first time, the lock count is set to one. Every time a thread re-locks this mutex, the lock count is incremented by one. Each time the thread unlocks the mutex, the lock count is decremented by one. When the lock count reaches zero, the mutex becomes available for other threads to acquire. If a thread attempts to unlock a mutex that it has not locked or a mutex which is unlocked, an error will be returned.
If a signal is delivered to a thread waiting for a mutex, upon return from the signal handler the thread resumes waiting for the mutex as if it was not interrupted.
Input Parameters:
mutex. A reference to the mutex to be locked.Returned Value:
If successful, the pthread_mutex_lock() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. Note that this function will never return the error EINTR.
Assumptions/Limitations:POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutex_timedlock(pthread_mutex_t *mutex, const struct timespec *abs_timeout);
Description: The pthread_mutex_timedlock() function will lock the mutex object referenced by mutex. If the mutex is already locked, the calling thread will block until the mutex becomes available as in the pthread_mutex_lock() function. If the mutex cannot be locked without waiting for another thread to unlock the mutex, this wait will be terminated when the specified abs_timeout expires.
The timeout will expire when the absolute time specified by abs_timeout passes, as measured by the clock on which timeouts are based (that is, when the value of that clock equals or exceeds abs_timeout), or if the absolute time specified by abs_timeout has already been passed at the time of the call.
Input Parameters:
mutex. A reference to the mutex to be locked.abs_timeout. Maximum wait time (with NULL meaning to wait forever).Returned Value:
If successful, the pthread_mutex_trylock() function will return zero (OK). Otherwise, an error number will be returned to indicate the error. Note that the errno EINTR is never returned by pthread_mutex_timedlock(). The returned errno is ETIMEDOUT if the mutex could not be locked before the specified timeout expired
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name. This implementation does not return EAGAIN when the mutex could not be acquired because the maximum number of recursive locks for mutex has been exceeded.
Function Prototype:
#include <pthread.h>
int pthread_mutex_trylock(pthread_mutex_t *mutex);
Description: The function pthread_mutex_trylock() is identical to pthread_mutex_lock() except that if the mutex object referenced by mutex is currently locked (by any thread, including the current thread), the call returns immediately with the errno EBUSY.
If a signal is delivered to a thread waiting for a mutex, upon return from the signal handler the thread resumes waiting for the mutex as if it was not interrupted.
Input Parameters:
mutex. A reference to the mutex to be locked.Returned Value:
If successful, the pthread_mutex_trylock() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. Note that this function will never return the error EINTR.
Assumptions/Limitations:POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_mutex_unlock(pthread_mutex_t *mutex);
Description:
The pthread_mutex_unlock() function releases the mutex object referenced by mutex. The manner in which a mutex is released is dependent upon the mutex's type attribute. If there are threads blocked on the mutex object referenced by mutex when pthread_mutex_unlock() is called, resulting in the mutex becoming available, the scheduling policy is used to determine which thread will acquire the mutex. (In the case of PTHREAD_MUTEX_RECURSIVE mutexes, the mutex becomes available when the count reaches zero and the calling thread no longer has any locks on this mutex).
If a signal is delivered to a thread waiting for a mutex, upon return from the signal handler the thread resumes waiting for the mutex as if it was not interrupted.
Input Parameters:
mutex.Returned Value:
If successful, the pthread_mutex_unlock() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. Note that this function will never return the error EINTR.
Assumptions/Limitations:POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_condattr_init(pthread_condattr_t *attr);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_condattr_init() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_condattr_destroy(pthread_condattr_t *attr);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_condattr_destroy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_cond_init(pthread_cond_t *cond, pthread_condattr_t *attr);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_cond_init() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_cond_destroy(pthread_cond_t *cond);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_cond_destroy() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_cond_broadcast(pthread_cond_t *cond);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_cond_broadcast() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_cond_signal(pthread_cond_t *dond);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_cond_signal() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_cond_wait() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
const struct timespec *abstime);
Description:
Input Parameters:
To be provided.Returned Value:
If successful, the pthread_cond_timedwait() function will return zero (OK). Otherwise, an error number will be returned to indicate the error:
To be provided. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_barrierattr_init(FAR pthread_barrierattr_t *attr);
Description: The pthread_barrierattr_init() function will initialize a barrier attribute object attr with the default value for all of the attributes defined by the implementation.
Input Parameters:
attr. Barrier attributes to be initialized. Returned Value: 0 (OK) on success or EINVAL if attr is invalid.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_barrierattr_destroy(FAR pthread_barrierattr_t *attr);
Description: The pthread_barrierattr_destroy() function will destroy a barrier attributes object. A destroyed attributes object can be reinitialized using pthread_barrierattr_init(); the results of otherwise referencing the object after it has been destroyed are undefined.
Input Parameters:
attr. Barrier attributes to be destroyed. Returned Value: 0 (OK) on success or EINVAL if attr is invalid.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_barrierattr_setpshared(FAR pthread_barrierattr_t *attr, int pshared);
Description: The process-shared attribute is set to PTHREAD_PROCESS_SHARED to permit a barrier to be operated upon by any thread that has access to the memory where the barrier is allocated. If the process-shared attribute is PTHREAD_PROCESS_PRIVATE, the barrier can only be operated upon by threads created within the same process as the thread that initialized the barrier. If threads of different processes attempt to operate on such a barrier, the behavior is undefined. The default value of the attribute is PTHREAD_PROCESS_PRIVATE.
Input Parameters:
attr. Barrier attributes to be modified.pshared. The new value of the pshared attribute. Returned Value: 0 (OK) on success or EINVAL if either attr is invalid or pshared is not one of PTHREAD_PROCESS_SHARED or PTHREAD_PROCESS_PRIVATE.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_barrierattr_getpshared(FAR const pthread_barrierattr_t *attr, FAR int *pshared);
Description: The pthread_barrierattr_getpshared() function will obtain the value of the process-shared attribute from the attributes object referenced by attr.
Input Parameters:
attr. Barrier attributes to be queried.pshared. The location to stored the current value of the pshared attribute. Returned Value: 0 (OK) on success or EINVAL if either attr or pshared is invalid.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_barrier_init(FAR pthread_barrier_t *barrier,
FAR const pthread_barrierattr_t *attr, unsigned int count);
Description: The pthread_barrier_init() function allocates any resources required to use the barrier referenced by barrier and initialized the barrier with the attributes referenced by attr. If attr is NULL, the default barrier attributes will be used. The results are undefined if pthread_barrier_init() is called when any thread is blocked on the barrier. The results are undefined if a barrier is used without first being initialized. The results are undefined if pthread_barrier_init() is called specifying an already initialized barrier.
Input Parameters:
barrier. The barrier to be initialized. attr. Barrier attributes to be used in the initialization. count. The count to be associated with the barrier. The count argument specifies the number of threads that must call pthread_barrier_wait() before any of them successfully return from the call. The value specified by count must be greater than zero. Returned Value: 0 (OK) on success or one of the following error numbers:
EAGAIN. The system lacks the necessary resources to initialize another barrier. EINVAL. The barrier reference is invalid, or the values specified by attr are invalid, or the value specified by count is equal to zero. ENOMEM. Insufficient memory exists to initialize the barrier. EBUSY. The implementation has detected an attempt to reinitialize a barrier while it is in use. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_barrier_destroy(FAR pthread_barrier_t *barrier);
Description: The pthread_barrier_destroy() function destroys the barrier referenced by barrie and releases any resources used by the barrier. The effect of subsequent use of the barrier is undefined until the barrier is reinitialized by another call to pthread_barrier_init(). The results are undefined if pthread_barrier_destroy() is called when any thread is blocked on the barrier, or if this function is called with an uninitialized barrier.
Input Parameters:
barrier. The barrier to be destroyed. Returned Value: 0 (OK) on success or one of the following error numbers:
EBUSY. The implementation has detected an attempt to destroy a barrier while it is in use. EINVAL. The value specified by barrier is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_barrier_wait(FAR pthread_barrier_t *barrier);
Description: The pthread_barrier_wait() function synchronizes participating threads at the barrier referenced by barrier. The calling thread is blocked until the required number of threads have called pthread_barrier_wait() specifying the same barrier. When the required number of threads have called pthread_barrier_wait() specifying the barrier, the constant PTHREAD_BARRIER_SERIAL_THREAD will be returned to one unspecified thread and zero will be returned to each of the remaining threads. At this point, the barrier will be reset to the state it had as a result of the most recent pthread_barrier_init() function that referenced it.
The constant PTHREAD_BARRIER_SERIAL_THREAD is defined in pthread.h and its value must be distinct from any other value returned by pthread_barrier_wait().
The results are undefined if this function is called with an uninitialized barrier.
If a signal is delivered to a thread blocked on a barrier, upon return from the signal handler the thread will resume waiting at the barrier if the barrier wait has not completed. Otherwise, the thread will continue as normal from the completed barrier wait. Until the thread in the signal handler returns from it, it is unspecified whether other threads may proceed past the barrier once they have all reached it.
A thread that has blocked on a barrier will not prevent any unblocked thread that is eligible to use the same processing resources from eventually making forward progress in its execution. Eligibility for processing resources will be determined by the scheduling policy.
Input Parameters:
barrier. The barrier on which to wait. Returned Value: 0 (OK) on success or EINVAL if the barrier is not valid.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <pthread.h>
int pthread_once(FAR pthread_once_t *once_control, CODE void (*init_routine)(void));
Description: The first call to pthread_once() by any thread with a given once_control, will call the init_routine() with no arguments. Subsequent calls to pthread_once() with the same once_control will have no effect. On return from pthread_once(), init_routine() will have completed.
Input Parameters:
once_control. Determines if init_routine() should be called. once_control should be declared and initialized as follows: pthread_once_t once_control = PTHREAD_ONCE_INIT;
PTHREAD_ONCE_INIT is defined in pthread.h. init_routine. The initialization routine that will be called once. Returned Value: 0 (OK) on success or EINVAL if either once_control or init_routine are invalid.
Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
#include <pthread.h>
int pthread_kill(pthread_t thread, int signo)
Description: The pthread_kill() system call can be used to send any signal to a thread. See kill() for further information as this is just a simple wrapper around the kill() function.
Input Parameters:
thread. The id of the thread to receive the signal. Only positive, non-zero values of tthreadt are supported. signo. The signal number to send. If signo is zero, no signal is sent, but all error checking is performed. Returned Value:
On success, the signal was sent and zero is returned. On error one of the following error numbers is returned.
EINVAL. An invalid signal was specified. EPERM. The thread does not have permission to send the signal to the target thread. ESRCH. No thread could be found corresponding to that specified by the given thread ID. ENOSYS. Do not support sending signals to process groups. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
Function Prototype:
#include <signal.h>
#include <pthread.h>
int pthread_sigmask(int how, FAR const sigset_t *set, FAR sigset_t *oset);
Description: This function is a simple wrapper around sigprocmask(). See the sigprocmask() function description for further information.
Input Parameters:
how. How the signal mast will be changed: SIG_BLOCK: The resulting set is the union of the current set and the signal set pointed to by set. SIG_UNBLOCK: The resulting set is the intersection of the current set and the complement of the signal set pointed to by set. SIG_SETMASK: The resulting set is the signal set pointed to by set. set. Location of the new signal mask. oset. Location to store the old signal mask. Returned Value:
OK) on success or EINVAL if how is invalid. Assumptions/Limitations:
POSIX Compatibility: Comparable to the POSIX interface of the same name.
2.9 Environment Variables |
Overview. NuttX supports environment variables that can be used to control the behavior of programs. In the spirit of NuttX the environment variable behavior attempts to emulate the behavior of environment variables in the multi-processing OS:
Programming Interfaces. The following environment variable programming interfaces are provided by Nuttx and are described in detail in the following paragraphs.
Disabling Environment Variable Support. All support for environment variables can be disabled by setting CONFIG_DISABLE_ENVIRON in the board configuration file.
getenvFunction Prototype:
#include <stdlib.h> FAR char *getenv(const char *name);
Description: The getenv() function searches the environment list for a string that matches the string pointed to by name.
Input Parameters:
name. The name of the variable to find. Returned Value: The value of the variable (read-only) or NULL on failure.
putenvFunction Prototype:
#include <stdlib.h> int putenv(char *string);
Description: The putenv() function adds or changes the value of environment variables. The argument string is of the form name=value. If name does not already exist in the environment, then string is added to the environment. If name does exist, then the value of name in the environment is changed to value.
Input Parameters:
string name=value string describing the environment setting to add/modify. Returned Value: Zero on success.
clearenvFunction Prototype:
#include <stdlib.h> int clearenv(void);
Description: The clearenv() function clears the environment of all name-value pairs and sets the value of the external variable environ to NULL.
Input Parameters: None
Returned Value: Zero on success.
setenvFunction Prototype:
#include <stdlib.h> int setenv(const char *name, const char *value, int overwrite);
Description: The setenv() function adds the variable name to the environment with the specified value if the variable name does not exist. If the name does exist in the environment, then its value is changed to value if overwrite is non-zero; if overwrite is zero, then the value of name is unaltered.
Input Parameters:
name The name of the variable to change. value The new value of the variable. value Replace any existing value if non-zero. Returned Value: Zero on success.
unsetenvFunction Prototype:
#include <stdlib.h> int unsetenv(const char *name);
Description: The unsetenv() function deletes the variable name from the environment.
Input Parameters:
name The name of the variable to delete. Returned Value: Zero on success.
2.10 File System Interfaces |
mmap() and eXecute In Place (XIP)Overview. NuttX includes an optional, scalable file system. This file-system may be omitted altogether; NuttX does not depend on the presence of any file system.
Pseudo Root File System. A simple in-memory, pseudo file system can be enabled by default. This is an in-memory file system because it does not require any storage medium or block driver support. Rather, file system contents are generated on-the-fly as referenced via standard file system operations (open, close, read, write, etc.). In this sense, the file system is pseudo file system (in the same sense that the Linux /proc file system is also referred to as a pseudo file system).
Any user supplied data or logic can be accessed via the pseudo-file system. Built in support is provided for character and block driver nodes in the any pseudo file system directory. (By convention, however, all driver nodes should be in the /dev pseudo file system directory).
Mounted File Systems The simple in-memory file system can be extended my mounting block devices that provide access to true file systems backed up via some mass storage device. NuttX supports the standard mount() command that allows a block driver to be bound to a mount-point within the pseudo file system and to a a file system. At present, NuttX supports only the VFAT file system.
Comparison to Linux From a programming perspective, the NuttX file system appears very similar to a Linux file system. However, there is a fundamental difference: The NuttX root file system is a pseudo file system and true file systems may be mounted in the pseudo file system. In the typical Linux installation by comparison, the Linux root file system is a true file system and pseudo file systems may be mounted in the true, root file system. The approach selected by NuttX is intended to support greater scalability from the very tiny platform to the moderate platform.
File System Interfaces. The NuttX file system simply supports a set of standard, file system APIs (open(), close(), read(), write, etc.) and a registration mechanism that allows devices drivers to a associated with nodes in a file-system-like name space.
#include <fcntl.h> int creat(FAR const char *path, mode_t mode); int open(FAR const char *path, int oflag, ...); int fcntl(int fd, int cmd, ...);
#include <unistd.h> int close(int fd); int dup(int fd); int dup2(int fd1, int fd2); off_t lseek(int fd, off_t offset, int whence); ssize_t pread(int fd, void *buf, size_t nbytes, off_t offset); ssize_t pwrite(int fd, const void *buf, size_t nbytes, off_t offset); ssize_t read(int fd, void *buf, size_t nbytes); int unlink(const char *path); ssize_t write(int fd, const void *buf, size_t nbytes);
#include <sys/ioctl.h> int ioctl(int fd, int req, ...);
Function Prototype:
#include <poll.h> int poll(struct pollfd *fds, nfds_t nfds, int timeout);
Description: poll() waits for one of a set of file descriptors to become ready to perform I/O. If none of the events requested (and no error) has occurred for any of the file descriptors, then poll() blocks until one of the events occurs.
Configuration Settings. In order to use the select with TCP/IP sockets test, you must have the following things selected in your NuttX configuration file:
CONFIG_NET Defined for general network supportCONFIG_NET_TCP Defined for TCP/IP supportIn order to for select to work with incoming connections, you must also select:
CONFIG_NET_TCPBACKLOG Incoming connections pend in a backlog until accept() is called. The size of the backlog is selected when listen() is called.Input Parameters:
fds. List of structures describing file descriptors to be monitored.nfds. The number of entries in the list.timeout. Specifies an upper limit on the time for which poll() will block in milliseconds. A negative value of timeout means an infinite timeout.Returned Value:
On success, the number of structures that have nonzero revents fields. A value of 0 indicates that the call timed out and no file descriptors were ready. On error, -1 is returned, and errno is set appropriately:
EBADF. An invalid file descriptor was given in one of the sets.EFAULT. The fds address is invalidEINTR. A signal occurred before any requested event.EINVAL. The nfds value exceeds a system limit.ENOMEM. There was no space to allocate internal data structures.ENOSYS. One or more of the drivers supporting the file descriptor does not support the poll method.Function Prototype:
#include <sys/select.h>
int select(int nfds, FAR fd_set *readfds, FAR fd_set *writefds,
FAR fd_set *exceptfds, FAR struct timeval *timeout);
Description: select() allows a program to monitor multiple file descriptors, waiting until one or more of the file descriptors become "ready" for some class of I/O operation (e.g., input possible). A file descriptor is considered ready if it is possible to perform the corresponding I/O operation (e.g., read(2)) without blocking.
NOTE: poll() is the fundamental API for performing such monitoring operation under NuttX. select() is provided for compatibility and is simply a layer of added logic on top of poll(). As such, select() is more wasteful of resources and poll() is the recommended API to be used.
Input Parameters:
nfds. the maximum file descriptor number (+1) of any descriptor in any of the three sets.readfds. the set of descriptions to monitor for read-ready eventswritefds. the set of descriptions to monitor for write-ready eventsexceptfds. the set of descriptions to monitor for error eventstimeout. Return at this time if none of these events of interest occur.Returned Value:
0: Timer expired>0: The number of bits set in the three sets of descriptors-1: An error occurred (errno will be set appropriately, see poll()).#include <dirent.h> int closedir(DIR *dirp); FAR DIR *opendir(const char *path); FAR struct dirent *readdir(FAR DIR *dirp); int readdir_r(FAR DIR *dirp, FAR struct dirent *entry, FAR struct dirent **result); void rewinddir(FAR DIR *dirp); void seekdir(FAR DIR *dirp, int loc); int telldir(FAR DIR *dirp);
#include <unistd.h>
/* Task Control Interfaces */
pid_t vfork(void);
pid_t getpid(void);
void _exit(int status) noreturn_function;
unsigned int sleep(unsigned int seconds);
void usleep(unsigned long usec);
int pause(void);
/* File descriptor operations */
int close(int fd);
int dup(int fd);
int dup2(int fd1, int fd2);
int fsync(int fd);
off_t lseek(int fd, off_t offset, int whence);
ssize_t read(int fd, FAR void *buf, size_t nbytes);
ssize_t write(int fd, FAR const void *buf, size_t nbytes);
ssize_t pread(int fd, FAR void *buf, size_t nbytes, off_t offset);
ssize_t pwrite(int fd, FAR const void *buf, size_t nbytes, off_t offset);
/* Check if a file descriptor corresponds to a terminal I/O file */
int isatty(int fd);
/* Memory management */
#if defined(CONFIG_ARCH_ADDRENV) && defined(CONFIG_MM_PGALLOC) && \
defined(CONFIG_ARCH_USE_MMU)
FAR void *sbrk(intptr_t incr);
#endif
/* Special devices */
int pipe(int fd[2]);
/* Working directory operations */
int chdir(FAR const char *path);
FAR char *getcwd(FAR char *buf, size_t size);
/* File path operations */
int access(FAR const char *path, int amode);
int rmdir(FAR const char *pathname);
int unlink(FAR const char *pathname);
#ifdef CONFIG_PSEUDOFS_SOFTLINKS
int link(FAR const char *path1, FAR const char *path2);
ssize_t readlink(FAR const char *path, FAR char *buf, size_t bufsize);
#endif
/* Execution of programs from files */
#ifdef CONFIG_LIBC_EXECFUNCS
int execl(FAR const char *path, ...);
int execv(FAR const char *path, FAR char * const argv[]);
#endif
/* Networking */
#ifdef CONFIG_NET
int gethostname(FAR char *name, size_t size);
int sethostname(FAR const char *name, size_t size);
#endif
/* Other */
int getopt(int argc, FAR char * const argv[], FAR const char *optstring);
#include <stdio.h>
/* Operations on streams (FILE) */
void clearerr(FAR FILE *stream);
int fclose(FAR FILE *stream);
int fflush(FAR FILE *stream);
int feof(FAR FILE *stream);
int ferror(FAR FILE *stream);
int fileno(FAR FILE *stream);
int fgetc(FAR FILE *stream);
int fgetpos(FAR FILE *stream, FAR fpos_t *pos);
FAR char *fgets(FAR char *s, int n, FAR FILE *stream);
FAR FILE *fopen(FAR const char *path, FAR const char *type);
int fprintf(FAR FILE *stream, FAR const char *format, ...);
int fputc(int c, FAR FILE *stream);
int fputs(FAR const char *s, FAR FILE *stream);
size_t fread(FAR void *ptr, size_t size, size_t n_items, FAR FILE *stream);
FAR FILE *freopen(FAR const char *path, FAR const char *mode,
FAR FILE *stream);
int fseek(FAR FILE *stream, long int offset, int whence);
int fsetpos(FAR FILE *stream, FAR fpos_t *pos);
long ftell(FAR FILE *stream);
size_t fwrite(FAR const void *ptr, size_t size, size_t n_items, FAR FILE *stream);
FAR char *gets(FAR char *s);
FAR char *gets_s(FAR char *s, rsize_t n);
void setbuf(FAR FILE *stream, FAR char *buf);
int setvbuf(FAR FILE *stream, FAR char *buffer, int mode, size_t size);
int ungetc(int c, FAR FILE *stream);
/* Operations on the stdout stream, buffers, paths, and the whole printf-family * /
int printf(FAR const char *format, ...);
int puts(FAR const char *s);
int rename(FAR const char *source, FAR const char *target);
int sprintf(FAR char *dest, FAR const char *format, ...);
int asprintf(FAR char **ptr, FAR const char *fmt, ...);
int snprintf(FAR char *buf, size_t size, FAR const char *format, ...);
int sscanf(FAR const char *buf, FAR const char *fmt, ...);
void perror(FAR const char *s);
int vprintf(FAR const char *s, va_list ap);
int vfprintf(FAR FILE *stream, FAR const char *s, va_list ap);
int vsprintf(FAR char *buf, FAR const char *s, va_list ap);
int vasprintf(FAR char **ptr, FAR const char *fmt, va_list ap);
int vsnprintf(FAR char *buf, size_t size, FAR const char *format, va_list ap);
int vsscanf(FAR char *buf, FAR const char *s, va_list ap);
/* Operations on file descriptors including:
*
* POSIX-like File System Interfaces (fdopen), and
* Extensions from the Open Group Technical Standard, 2006, Extended API Set
* Part 1 (dprintf and vdprintf)
*/
FAR FILE *fdopen(int fd, FAR const char *type);
int dprintf(int fd, FAR const char *fmt, ...);
int vdprintf(int fd, FAR const char *fmt, va_list ap);
/* Operations on paths */
FAR char *tmpnam(FAR char *s);
FAR char *tempnam(FAR const char *dir, FAR const char *pfx);
int remove(FAR const char *path);
#include <sys/stat.h>
int mkdir(FAR const char *pathname, mode_t mode);
int mkfifo(FAR const char *pathname, mode_t mode);
int stat(FAR const char *path, FAR struct stat *buf);
int fstat(int fd, FAR struct stat *buf);
#include <sys/statfs.h>
int statfs(FAR const char *path, FAR struct statfs *buf);
int fstatfs(int fd, FAR struct statfs *buf);
stdlib.h generally addresses other operating system interfaces. However, the following may also be considered as file system interfaces:
#include <stdlib.h> int mktemp(FAR char *template); int mkstemp(FAR char *template);
#include <aio.h>
int aio_cancel(int, FAR struct aiocb *aiocbp);
int aio_error(FAR const struct aiocb *aiocbp);
int aio_fsync(int, FAR struct aiocb *aiocbp);
int aio_read(FAR struct aiocb *aiocbp);
ssize_t aio_return(FAR struct aiocb *aiocbp);
int aio_suspend(FAR const struct aiocb * const list[], int nent,
FAR const struct timespec *timeout);
int aio_write(FAR struct aiocb *aiocbp);
int lio_listio(int mode, FAR struct aiocb * const list[], int nent,
FAR struct sigevent *sig);
#include <string.h> char *strchr(const char *s, int c); FAR char *strdup(const char *s); const char *strerror(int); size_t strlen(const char *); size_t strnlen(const char *, size_t); char *strcat(char *, const char *); char *strncat(char *, const char *, size_t); int strcmp(const char *, const char *); int strncmp(const char *, const char *, size_t); int strcasecmp(const char *, const char *); int strncasecmp(const char *, const char *, size_t); char *strcpy(char *dest, const char *src); char *strncpy(char *, const char *, size_t); char *strpbrk(const char *, const char *); char *strchr(const char *, int); char *strrchr(const char *, int); size_t strspn(const char *, const char *); size_t strcspn(const char *, const char *); char *strstr(const char *, const char *); char *strtok(char *, const char *); char *strtok_r(char *, const char *, char **); void *memset(void *s, int c, size_t n); void *memcpy(void *dest, const void *src, size_t n); int memcmp(const void *s1, const void *s2, size_t n); void *memmove(void *dest, const void *src, size_t count); #include <strings.h> #define bcmp(b1,b2,len) memcmp(b1,b2,(size_t)len) #define bcopy(b1,b2,len) (void)memmove(b2,b1,len) #define bzero(s,n) (void)memset(s,0,n) #define index(s,c) strchr(s,c) #define rindex(s,c) strrchr(s,c) int ffs(int j); int strcasecmp(const char *, const char *); int strncasecmp(const char *, const char *, size_t);
pipeFunction Prototype:
#include <unistd.h> int pipe(int fd[2]);
Description:
pipe() creates a pair of file descriptors, pointing to a pipe inode, and places them in the array pointed to by fd. fd[0] is for reading, fd[1] is for writing.
Input Parameters:
fd[2]. The user provided array in which to catch the pipe file descriptors.Returned Value:
0 is returned on success; otherwise, -1 is returned with errno set appropriately.
mkfifoFunction Prototype:
#include <sys/stat.h> int mkfifo(FAR const char *pathname, mode_t mode);
Description:
mkfifo() makes a FIFO device driver file with name pathname. Unlike Linux, a NuttX FIFO is not a special file type but simply a device driver instance. mode specifies the FIFO's permissions (but is ignored in the current implementation).
Once the FIFO has been created by mkfifo(), any thread can open it for reading or writing, in the same way as an ordinary file. However, it must have been opened from both reading and writing before input or output can be performed. This FIFO implementation will block all attempts to open a FIFO read-only until at least one thread has opened the FIFO for writing.
If all threads that write to the FIFO have closed, subsequent calls to read() on the FIFO will return 0 (end-of-file).
Input Parameters:
pathname. The full path to the FIFO instance to attach to or to create (if not already created). mode. Ignored for now Returned Value:
0 is returned on success; otherwise, -1 is returned with errno set appropriately.
mmap() and eXecute In Place (XIP) NuttX operates in a flat open address space and is focused on MCUs that do support Memory Management Units (MMUs). Therefore, NuttX generally does not require mmap() functionality and the MCUs generally cannot support true memory-mapped files.
However, memory mapping of files is the mechanism used by NXFLAT, the NuttX tiny binary format, to get files into memory in order to execute them. mmap() support is therefore required to support NXFLAT. There are two conditions where mmap() can be supported:
mmap() can be used to support eXecute In Place (XIP) on random access media under the following very restrictive conditions:
The file-system supports the FIOC_MMAP ioctl command. Any file system that maps files contiguously on the media should support this ioctl command. By comparison, most file system scatter files over the media in non-contiguous sectors. As of this writing, ROMFS is the only file system that meets this requirement.
The underlying block driver supports the BIOC_XIPBASE ioctl command that maps the underlying media to a randomly accessible address. At present, only the RAM/ROM disk driver does this.
Some limitations of this approach are as follows:
Since no real mapping occurs, all of the file contents are "mapped" into memory.
All mapped files are read-only.
There are no access privileges.
If CONFIG_FS_RAMMAP is defined in the configuration, then mmap() will support simulation of memory mapped files by copying files whole into RAM. These copied files have some of the properties of standard memory mapped files. There are many, many exceptions exceptions, however. Some of these include:
The goal is to have a single region of memory that represents a single file and can be shared by many threads. That is, given a filename a thread should be able to open the file, get a file descriptor, and call mmap() to get a memory region. Different file descriptors opened with the same file path should get the same memory region when mapped.
The limitation in the current design is that there is insufficient knowledge to know that these different file descriptors correspond to the same file. So, for the time being, a new memory region is created each time that rammmap() is called. Not very useful!
The entire mapped portion of the file must be present in memory. Since it is assumed that the MCU does not have an MMU, on-demanding paging in of file blocks cannot be supported. Since the while mapped portion of the file must be present in memory, there are limitations in the size of files that may be memory mapped (especially on MCUs with no significant RAM resources).
All mapped files are read-only. You can write to the in-memory image, but the file contents will not change.
There are no access privileges.
Since there are no processes in NuttX, all mmap() and munmap() operations have immediate, global effects. Under Linux, for example, munmap() would eliminate only the mapping with a process; the mappings to the same file in other processes would not be effected.
Like true mapped file, the region will persist after closing the file descriptor. However, at present, these ram copied file regions are not automatically "unmapped" (i.e., freed) when a thread is terminated. This is primarily because it is not possible to know how many users of the mapped region there are and, therefore, when would be the appropriate time to free the region (other than when munmap is called).
NOTE: Note, if the design limitation of a) were solved, then it would be easy to solve exception d) as well.
mmapFunction Prototype:
#include <sys/mman.h> FAR void *mmap(FAR void *start, size_t length, int prot, int flags, int fd, off_t offset);
Description:
mmap() as needed to support eXecute In Place (XIP) operation (as described above). Input Parameters:
start A hint at where to map the memory -- ignored. The address of the underlying media is fixed and cannot be re-mapped without MMU support. length The length of the mapping -- ignored. The entire underlying media is always accessible. prot See the PROT_* definitions in sys/mman.h. PROT_NONE - Will cause an error. PROT_READ - PROT_WRITE and PROT_EXEC also assumed. PROT_WRITE - PROT_READ and PROT_EXEC also assumed. PROT_EXEC - PROT_READ and PROT_WRITE also assumed. flags See the MAP_* definitions in sys/mman.h. MAP_SHARED - Required MAP_PRIVATE - Will cause an error MAP_FIXED - Will cause an error MAP_FILE - Ignored MAP_ANONYMOUS - Will cause an error MAP_ANON - Will cause an error MAP_GROWSDOWN - Ignored MAP_DENYWRITE - Will cause an error MAP_EXECUTABLE - Ignored MAP_LOCKED - Ignored MAP_NORESERVE - Ignored MAP_POPULATE - Ignored AP_NONBLOCK - Ignored fd file descriptor of the backing file -- required. offset The offset into the file to map. Returned Value:
On success, mmap() returns a pointer to the mapped area. On error, the value MAP_FAILED is returned, and errno is set appropriately.
ENOSYS - Returned if any of the unsupported mmap() features are attempted. EBADF - fd is not a valid file descriptor. EINVAL - Length is 0. flags contained neither MAP_PRIVATE or MAP_SHARED, or contained both of these values. ENODEV - The underlying file-system of the specified file does not support memory mapping. 2.11 Network Interfaces |
NuttX supports a BSD-compatible socket interface layer. These socket interface can be enabled by settings in the architecture configuration file. Those socket APIs are discussed in the following paragraphs.
socketFunction Prototype:
#include <sys/socket.h> int socket(int domain, int type, int protocol);
Description: socket() creates an endpoint for communication and returns a descriptor.
Input Parameters:
domain: (see sys/socket.h)type: (see sys/socket.h)protocol: (see sys/socket.h) Returned Value: 0 on success; -1 on error with errno set appropriately:
EACCES. Permission to create a socket of the specified type and/or protocol is denied.EAFNOSUPPORT. The implementation does not support the specified address family.EINVAL. Unknown protocol, or protocol family not available.EMFILE. Process file table overflow.ENFILE The system limit on the total number of open files has been reached.ENOBUFS or ENOMEM. Insufficient memory is available. The socket cannot be created until sufficient resources are freed.EPROTONOSUPPORT. The protocol type or the specified protocol is not supported within this domain.bindFunction Prototype:
#include <sys/socket.h> int bind(int sockfd, const struct sockaddr *addr, socklen_t addrlen);
Description: bind() gives the socket sockfd the local address addr. addr is addrlen bytes long. Traditionally, this is called "assigning a name to a socket." When a socket is created with socket(), it exists in a name space (address family) but has no name assigned.
Input Parameters:
sockfd: Socket descriptor from socket.addr: Socket local address.addrlen: Length of addr. Returned Value: 0 on success; -1 on error with errno set appropriately:
EACCES The address is protected, and the user is not the superuser.EADDRINUSE The given address is already in use.EBADF sockfd is not a valid descriptor.EINVAL The socket is already bound to an address.ENOTSOCK sockfd is a descriptor for a file, not a socket.connectFunction Prototype:
#include <sys/socket.h> int connect(int sockfd, const struct sockaddr *addr, socklen_t addrlen);
Description: connect() connects the socket referred to by the file descriptor sockfd to the address specified by addr. The addrlen argument specifies the size of addr. The format of the address in addr is determined by the address space of the socket sockfd. If the socket sockfd is of type SOCK_DGRAM then addr is the address to which datagrams are sent by default, and the only address from which datagrams are received. If the socket is of type SOCK_STREAM or SOCK_SEQPACKET, this call attempts to make a connection to the socket that is bound to the address specified by addr. Generally, connection-based protocol sockets may successfully connect() only once; connectionless protocol sockets may use connect() multiple times to change their association. Connectionless sockets may dissolve the association by connecting to an address with the sa_family member of sockaddr set to AF_UNSPEC.
Input Parameters:
sockfd: Socket descriptor returned by socket()addr: Server address (form depends on type of socket)addrlen: Length of actual addr Returned Value: 0 on success; -1 on error with errno set appropriately:
EACCES or EPERM: The user tried to connect to a broadcast address without having the socket broadcast flag enabled or the connection request failed because of a local firewall rule.EADDRINUSE Local address is already in use.EAFNOSUPPORT The passed address didn't have the correct address family in its sa_family field.EAGAIN No more free local ports or insufficient entries in the routing cache. For PF_INET.EALREADY The socket is non-blocking and a previous connection attempt has not yet been completed.EBADF The file descriptor is not a valid index in the descriptor table.ECONNREFUSED No one listening on the remote address.EFAULT The socket structure address is outside the user's address space.EINPROGRESS The socket is non-blocking and the connection cannot be completed immediately.EINTR The system call was interrupted by a signal that was caught.EISCONN The socket is already connected.ENETUNREACH Network is unreachable.ENOTSOCK The file descriptor is not associated with a socket.ETIMEDOUT Timeout while attempting connection. The server may be too busy to accept new connections.Function Prototype:
#include <sys/socket.h> int listen(int sockfd, int backlog);
Description: To accept connections, a socket is first created with socket(), a willingness to accept incoming connections and a queue limit for incoming connections are specified with listen(), and then the connections are accepted with accept(). The listen() call applies only to sockets of type SOCK_STREAM or SOCK_SEQPACKET.
Input Parameters:
sockfd: Socket descriptor of the bound socket.backlog: The maximum length the queue of pending connections may grow. If a connection request arrives with the queue full, the client may receive an error with an indication of ECONNREFUSED or, if the underlying protocol supports retransmission, the request may be ignored so that retries succeed. Returned Value: On success, zero is returned. On error, -1 is returned, and errno is set appropriately.
EADDRINUSE: Another socket is already listening on the same port.EBADF: The argument sockfd is not a valid descriptor.ENOTSOCK: The argument sockfd is not a socket.EOPNOTSUPP: The socket is not of a type that supports the listen operation.Function Prototype:
#include <sys/socket.h> int accept(int sockfd, struct sockaddr *addr, socklen_t *addrlen);
Description: The accept() function is used with connection-based socket types (SOCK_STREAM, SOCK_SEQPACKET and SOCK_RDM). It extracts the first connection request on the queue of pending connections, creates a new connected socket with most of the same properties as sockfd, and allocates a new socket descriptor for the socket, which is returned. The newly created socket is no longer in the listening state. The original socket sockfd is unaffected by this call. Per file descriptor flags are not inherited across an accept.
The sockfd argument is a socket descriptor that has been created with socket(), bound to a local address with bind(), and is listening for connections after a call to listen().
On return, the addr structure is filled in with the address of the connecting entity. The addrlen argument initially contains the size of the structure pointed to by addr; on return it will contain the actual length of the address returned.
If no pending connections are present on the queue, and the socket is not marked as non-blocking, accept blocks the caller until a connection is present. If the socket is marked non-blocking and no pending connections are present on the queue, accept returns EAGAIN.
Input Parameters:
sockfd: Socket descriptor of the listening socket.addr: Receives the address of the connecting client.addrlen: Input: allocated size of addr, Return: returned size of addr.Returned Value: Returns -1 on error. If it succeeds, it returns a non-negative integer that is a descriptor for the accepted socket.
EAGAIN or EWOULDBLOCK: The socket is marked non-blocking and no connections are present to be accepted.EBADF: The descriptor is invalid.ENOTSOCK: The descriptor references a file, not a socket.EOPNOTSUPP: The referenced socket is not of type SOCK_STREAM.EINTR: The system call was interrupted by a signal that was caught before a valid connection arrived.ECONNABORTED: A connection has been aborted.EINVAL: Socket is not listening for connections.EMFILE: The per-process limit of open file descriptors has been reached.ENFILE: The system maximum for file descriptors has been reached.EFAULT: The addr parameter is not in a writable part of the user address space.ENOBUFS or ENOMEM: Not enough free memory.EPROTO: Protocol error.EPERM: Firewall rules forbid connection.sendFunction Prototype:
#include <sys/socket.h> ssize_t send(int sockfd, const void *buf, size_t len, int flags);
Description: The send() call may be used only when the socket is in a connected state (so that the intended recipient is known). The only difference between send() and write() is the presence of flags. With zero flags parameter, send() is equivalent to write(). Also, send(s,buf,len,flags) is equivalent to sendto(s,buf,len,flags,NULL,0).
Input Parameters:
sockfd: Socket descriptor of socket buf: Data to send len: Length of data to send flags: Send flags Returned Value: See sendto().
sendtoFunction Prototype:
#include <sys/socket.h>
ssize_t sendto(int sockfd, const void *buf, size_t len, int flags,
const struct sockaddr *to, socklen_t tolen);
Description: If sendto() is used on a connection-mode (SOCK_STREAM, SOCK_SEQPACKET) socket, the parameters to and tolen are ignored (and the error EISCONN may be returned when they are not NULL and 0), and the error ENOTCONN is returned when the socket was not actually connected.
Input Parameters:
sockfd: Socket descriptor of socket buf: Data to send len: Length of data to send flags: Send flags to: Address of recipient tolen: The length of the address structure Returned Value: On success, returns the number of characters sent. On error, -1 is returned, and errno is set appropriately:
EAGAIN or EWOULDBLOCK. The socket is marked non-blocking and the requested operation would block. EBADF. An invalid descriptor was specified. ECONNRESET. Connection reset by peer. EDESTADDRREQ. The socket is not connection-mode, and no peer address is set. EFAULT. An invalid user space address was specified for a parameter. EINTR. A signal occurred before any data was transmitted. EINVAL. Invalid argument passed. EISCONN. The connection-mode socket was connected already but a recipient was specified. (Now either this error is returned, or the recipient specification is ignored.) EMSGSIZE. The socket type requires that message be sent atomically, and the size of the message to be sent made this impossible. ENOBUFS. The output queue for a network interface was full. This generally indicates that the interface has stopped sending, but may be caused by transient congestion. ENOMEM. No memory available. ENOTCONN. The socket is not connected, and no target has been given. ENOTSOCK. The argument s is not a socket. EOPNOTSUPP. Some bit in the flags argument is inappropriate for the socket type. EPIPE. The local end has been shut down on a connection oriented socket. In this case the process will also receive a SIGPIPE unless MSG_NOSIGNAL is set. recvFunction Prototype:
#include <sys/socket.h> ssize_t recv(int sockfd, void *buf, size_t len, int flags);
Description: The recv() call is identical to recvfrom() with a NULL from parameter.
Input Parameters:
Returned Value: See recvfrom().
recvfromFunction Prototype:
#include <sys/socket.h>
ssize_t recvfrom(int sockfd, void *buf, size_t len, int flags,
struct sockaddr *from, socklen_t *fromlen);
Description: recvfrom() receives messages from a socket, and may be used to receive data on a socket whether or not it is connection-oriented.
If from is not NULL, and the underlying protocol provides the source address, this source address is filled in. The argument fromlen initialized to the size of the buffer associated with from, and modified on return to indicate the actual size of the address stored there.
Input Parameters:
sockfd: Socket descriptor of socket.buf: Buffer to receive data.len: Length of buffer.flags: Receive flags.from: Address of source.fromlen: The length of the address structure. Returned Value: On success, returns the number of characters sent. If no data is available to be received and the peer has performed an orderly shutdown, recv() will return 0. Otherwise, on errors, -1 is returned, and errno is set appropriately:
EAGAIN. The socket is marked non-blocking and the receive operation would block, or a receive timeout had been set and the timeout expired before data was received. EBADF. The argument sockfd is an invalid descriptor. ECONNREFUSED. A remote host refused to allow the network connection (typically because it is not running the requested service). EFAULT. The receive buffer pointer(s) point outside the process's address space. EINTR. The receive was interrupted by delivery of a signal before any data were available. EINVAL. Invalid argument passed. ENOMEM. Could not allocate memory. ENOTCONN. The socket is associated with a connection-oriented protocol and has not been connected. ENOTSOCK. The argument sockfd does not refer to a socket. setsockoptFunction Prototype:
#include <sys/socket.h>
int setsockopt(int sockfd, int level, int option,
const void *value, socklen_t value_len);
Description: setsockopt() sets the option specified by the option argument, at the protocol level specified by the level argument, to the value pointed to by the value argument for the socket associated with the file descriptor specified by the sockfd argument.
The level argument specifies the protocol level of the option. To set options at the socket level, specify the level argument as SOL_SOCKET.
See sys/socket.h for a complete list of values for the option argument.
Input Parameters:
sockfd: Socket descriptor of socketlevel: Protocol level to set the optionoption: identifies the option to setvalue: Points to the argument valuevalue_len: The length of the argument value Returned Value: On success, returns the number of characters sent. On error, -1 is returned, and errno is set appropriately:
BADF. The sockfd argument is not a valid socket descriptor. DOM. The send and receive timeout values are too big to fit into the timeout fields in the socket structure. INVAL. The specified option is invalid at the specified socket level or the socket has been shut down. ISCONN. The socket is already connected, and a specified option cannot be set while the socket is connected. NOPROTOOPT. The option is not supported by the protocol. NOTSOCK. The sockfd argument does not refer to a socket. NOMEM. There was insufficient memory available for the operation to complete. NOBUFS. Insufficient resources are available in the system to complete the call. getsockoptFunction Prototype:
#include <sys/socket.h> int getsockopt(int sockfd, int level, int option, void *value, socklen_t *value_len);
Description: getsockopt() retrieve those value for the option specified by the option argument for the socket specified by the sockfd argument. If the size of the option value is greater than value_len, the value stored in the object pointed to by the value argument will be silently truncated. Otherwise, the length pointed to by the value_len argument will be modified to indicate the actual length of the value.
The level argument specifies the protocol level of the option. To retrieve options at the socket level, specify the level argument as SOL_SOCKET.
See sys/socket.h for a complete list of values for the option argument.
Input Parameters:
sockfd: Socket descriptor of socket level: Protocol level to set the option option: Identifies the option to get value: Points to the argument value value_len: The length of the argument value Returned Value: On success, returns the number of characters sent. On error, -1 is returned, and errno is set appropriately:
BADF. The sockfd argument is not a valid socket descriptor.INVAL. The specified option is invalid at the specified socket level or the socket has been shutdown.NOPROTOOPT. The option is not supported by the protocol.NOTSOCK. The sockfd argument does not refer to a socket.NOBUFS. Insufficient resources are available in the system to complete the call. 2.12 Shared Memory Interfaces |
Shared memory interfaces are only available with the NuttX kernel build (CONFIG_BUILD_KERNEL=y). These interfaces support user memory regions that can be shared between multiple user processes. Shared memory interfaces:
shmgetFunction Prototype:
#include <sys/shm.h> #include <sys/ipc.h> int shmget(key_t key, size_t size, int shmflg);
Description: The shmget() function will return the shared memory identifier associated with key.
A shared memory identifier, associated data structure, and shared memory segment of at least size bytes is created for key if one of the following is true:
The argument key is equal to IPC_PRIVATE.
The argument key does not already have a shared memory identifier associated with it and (shmflg & IPC_CREAT) is non-zero.
The low-order nine bits of shm_perm.mode are set equal to the low-order nine bits of shmflg.
The value of shm_segsz is set equal to the value of size.
The values of shm_lpid, shm_nattch, shm_atime, and shm_dtime are set equal to 0.
The value of shm_ctime is set equal to the current time.
When the shared memory segment is created, it will be initialized with all zero values.
Input Parameters:
key: The key that is used to access the unique shared memory identifier. size: The shared memory region that is created will be at least this size in bytes. shmflg: See IPC_* definitions in sys/ipc.h. Only the values IPC_PRIVATE or IPC_CREAT are supported. Returned Value: Upon successful completion, shmget() will return a non-negative integer, namely a shared memory identifier; otherwise, it will return -1 and set errno to indicate the error.
EACCES. A shared memory identifier exists for key but operation permission as specified by the low-order nine bits of shmflg would not be granted. EEXIST. A shared memory identifier exists for the argument key but (shmflg & IPC_CREAT) && (shmflg & IPC_EXCL) are non-zero. EINVAL. A shared memory segment is to be created and the value of size is less than the system-imposed minimum or greater than the system-imposed maximum. EINVAL. No shared memory segment is to be created and a shared memory segment exists for key but the size of the segment associated with it is less than size and size is not 0. ENOENT. A shared memory identifier does not exist for the argument key and (shmflg & IPC_CREAT) is 0. ENOMEM. A shared memory identifier and associated shared memory segment will be created, but the amount of available physical memory is not sufficient to fill the request. ENOSPC. A shared memory identifier is to be created, but the system-imposed limit on the maximum number of allowed shared memory identifiers system-wide would be exceeded. POSIX Deviations
The values of shm_perm.cuid, shm_perm.uid, shm_perm.cgid, and shm_perm.gid should be set equal to the effective user ID and effective group ID, respectively, of the calling process. The NuttX ipc_perm structure, however, does not support these fields because user and group IDs are not yet supported by NuttX.
shmatFunction Prototype:
#include <sys/shm.h> void *shmat(int shmid, FAR const void *shmaddr, int shmflg);
Description: The shmat() function attaches the shared memory segment associated with the shared memory identifier specified by shmid to the address space of the calling process. The segment is attached at the address specified by one of the following criteria:
If shmaddr is a null pointer, the segment is attached at the first available address as selected by the system.
If shmaddr is not a null pointer and (shmflg & SHM_RND) is non-zero, the segment is attached at the address given by (shmaddr - ((uintptr_t)shmaddr % SHMLBA)).
If shmaddr is not a null pointer and (shmflg & SHM_RND) is 0, the segment is attached at the address given by shmaddr.
The segment is attached for reading if (shmflg & SHM_RDONLY) is non-zero and the calling process has read permission; otherwise, if it is 0 and the calling process has read and write permission, the segment is attached for reading and writing.
Input Parameters:
shmid: Shared memory identifiersmaddr: Determines mapping of the shared memory regionshmflg: See SHM_* definitions in include/sys/shm.h. Only SHM_RDONLY and SHM_RND are supported. Returned Value: Upon successful completion, shmat() will increment the value of shm_nattch in the data structure associated with the shared memory ID of the attached shared memory segment and return the segment's start address. Otherwise, the shared memory segment will not be attached, shmat() will return -1, and errno will be set to indicate the error.
EACCES. Operation permission is denied to the calling process EINVAL. The value of shmid is not a valid shared memory identifier, the shmaddr is not a null pointer, and the value of (shmaddr -((uintptr_t)shmaddr % SHMLBA)) is an illegal address for attaching shared memory; or the shmaddr is not a null pointer, (shmflg & SHM_RND) is 0, and the value of shmaddr is an illegal address for attaching shared memory. EMFILE. The number of shared memory segments attached to the calling process would exceed the system-imposed limit. ENOMEM. The available data space is not large enough to accommodate the shared memory segment. shmctlFunction Prototype:
#include <sys/shm.h> #include <sys/ipc.h> int shmctl(int shmid, int cmd, FAR struct shmid_ds *buf);
Description: The shmctl() function provides a variety of shared memory control operations as specified by cmd. The following values for cmd are available:
IPC_STAT. Place the current value of each member of the shmid_ds data structure associated with shmid into the structure pointed to by buf.
IPC_SET. Set the value of the shm_perm.mode member of the shmid_ds data structure associated with shmid to the corresponding value found in the structure pointed to by buf.
IPC_RMID. Remove the shared memory identifier specified by shmid from the system and destroy the shared memory segment and shmid_ds data structure associated with it.
Input Parameters:
shmid: Shared memory identifiercmd: shmctl() commandbuf: Data associated with the shmctl() command Returned Value: Upon successful completion, shmctl() will return 0; otherwise, it will return -1 and set errno to indicate the error.
EACCES. The argument cmd is equal to IPC_STAT and the calling process does not have read permission. EINVAL. The value of shmid is not a valid shared memory identifier, or the value of cmd is not a valid command. EPERM. The argument cmd is equal to IPC_RMID or IPC_SET and the effective user ID of the calling process is not equal to that of a process with appropriate privileges and it is not equal to the value of shm_perm.cuid or shm_perm.uid in the data structure associated with shmid. EOVERFLOW. The cmd argument is IPC_STAT and the gid or uid value is too large to be stored in the structure pointed to by the buf argument. POSIX Deviations
IPC_SET. Does not set the shm_perm.uid or shm_perm.gidmembers of the shmid_ds data structure associated with shmid because user and group IDs are not yet supported by NuttX IPC_SET. Does not restrict the operation to processes with appropriate privileges or matching user IDs in shmid_ds data structure associated with shmid. Again because user IDs and user/group privileges are are not yet supported by NuttX IPC_RMID. Does not restrict the operation to processes with appropriate privileges or matching user IDs in shmid_ds data structure associated with shmid. Again because user IDs and user/group privileges are are not yet supported by NuttX shmdtFunction Prototype:
#include <sys/shm.h> int shmdt(FAR const void *shmaddr);
Description: The shmdt() function detaches the shared memory segment located at the address specified by shmaddr from the address space of the calling process.
Input Parameters:
shmid: Shared memory identifier Returned Value: Upon successful completion, shmdt() will decrement the value of shm_nattch in the data structure associated with the shared memory ID of the attached shared memory segment and return 0.
Otherwise, the shared memory segment will not be detached, shmdt() will return -1, and errno will be set to indicate the error.
EINVAL. The value of shmaddr is not the data segment start address of a shared memory segment. 3.0 OS Data Structures |
3.1 Scalar Types |
Many of the types used to communicate with NuttX are simple scalar types. These types are used to provide architecture independence of the OS from the application. The scalar types used at the NuttX interface include:
3.2 Hidden Interface Structures |
Several of the types used to interface with NuttX are structures that are intended to be hidden from the application. From the standpoint of the application, these structures (and structure pointers) should be treated as simple handles to reference OS resources. These hidden structures include:
In order to maintain portability, applications should not reference specific elements within these hidden structures. These hidden structures will not be described further in this user's manual.
3.3 Access to the |
A pointer to the thread-specific errno value is available through a function call:
Function Prototype:
#include <errno.h> #define errno *__errno() int *__errno(void);
Description: __errno() returns a pointer to the thread-specific errno value. Note that the symbol errno is defined to be __errno() so that the usual access by referencing the symbol errno will work as expected.
There is a unique, private errno value for each NuttX task. However, the implementation of errno differs somewhat from the use of errno in most multi-threaded process environments: In NuttX, each pthread will also have its own private copy of errno and the errno will not be shared between pthreads. This is, perhaps, non-standard but promotes better thread independence.
Input Parameters: None
Returned Values:
errno value. 3.4 User Interface Structures |
main_t defines the type of a task entry point. main_t is declared in sys/types.h as:
typedef int (*main_t)(int argc, char *argv[]);
This structure is used to pass scheduling priorities to and from NuttX;
struct sched_param
{
int sched_priority;
};
This structure is used to pass timing information between the NuttX and a user application:
struct timespec
{
time_t tv_sec; /* Seconds */
long tv_nsec; /* Nanoseconds */
};
This structure is used to communicate message queue attributes between NuttX and a MoBY application:
struct mq_attr {
size_t mq_maxmsg; /* Max number of messages in queue */
size_t mq_msgsize; /* Max message size */
unsigned mq_flags; /* Queue flags */
size_t mq_curmsgs; /* Number of messages currently in queue */
};
The following structure defines the action to take for given signal:
struct sigaction
{
union
{
void (*_sa_handler)(int);
void (*_sa_sigaction)(int, siginfo_t *, void *);
} sa_u;
sigset_t sa_mask;
int sa_flags;
};
#define sa_handler sa_u._sa_handler
#define sa_sigaction sa_u._sa_sigaction
The following types is used to pass parameters to/from signal handlers:
typedef struct siginfo
{
int si_signo;
int si_code;
union sigval si_value;
} siginfo_t;
This defines the type of the struct siginfo si_value field and is used to pass parameters with signals.
union sigval
{
int sival_int;
void *sival_ptr;
};
The following is used to attach a signal to a message queue to notify a task when a message is available on a queue.
struct sigevent
{
int sigev_signo;
union sigval sigev_value;
int sigev_notify;
};
Index |