Paparazzi UAS v7.1_unstable
Paparazzi is a free software Unmanned Aircraft System.
Loading...
Searching...
No Matches
threads_arch.c File Reference
#include "modules/core/threads.h"
#include "modules/core/threads_arch.h"
#include "stdbool.h"
#include <semaphore.h>
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
Include dependency graph for threads_arch.c:

Go to the source code of this file.

Data Structures

struct  stub_arg

Functions

void pprz_thread_init_main (void)
 Remember the calling thread as the main thread, the one running the periodic and event functions of the modules.
bool pprz_thread_is_main (void)
 The calling thread is the main thread (also true before pprz_thread_init_main() was called).
void pprz_thread_assert_main (const char *what, unsigned int id)
 Stop the program (abort on Linux/NPS, halt on ChibiOS) when not called from the main thread, e.g.
int pprz_mtx_init (pprz_mutex_t *mtx)
int pprz_mtx_lock (pprz_mutex_t *mtx)
int pprz_mtx_trylock (pprz_mutex_t *mtx)
 Performs a nonblocking lock on the mutex.
int pprz_mtx_unlock (pprz_mutex_t *mtx)
void pprz_bsem_init (pprz_bsem_t *bsem, bool taken)
void pprz_bsem_wait (pprz_bsem_t *bsem)
int pprz_bsem_wait_timeout (pprz_bsem_t *bsem, float timeout)
 Wait on semaphore no more than timeout.
void pprz_bsem_signal (pprz_bsem_t *bsem)
static void * stub (void *arg)
int pprz_thread_create (pprz_thread_t *thread, size_t size, const char *name, uint8_t prio, void(*func)(void *), void *arg)
 Creates a new thread whose stack is dynamically allocated.
void pprz_thread_exit (void *retval)
 Exit the current thread.
int pprz_thread_join (pprz_thread_t *thread, void **retval)
 Wait for the thread to terminate.
int pprz_thread_tryjoin (pprz_thread_t *thread, void **retval)
 Performs a nonblocking join with the thread.

Variables

static pthread_t main_thread
static bool main_thread_set = false

Data Structure Documentation

◆ stub_arg

struct stub_arg

Definition at line 97 of file threads_arch.c.

Data Fields
void * arg
void(*)(void *) func

Function Documentation

◆ pprz_bsem_init()

void pprz_bsem_init ( pprz_bsem_t * bsem,
bool taken )

Definition at line 59 of file threads_arch.c.

References bsem.

◆ pprz_bsem_signal()

void pprz_bsem_signal ( pprz_bsem_t * bsem)

Definition at line 83 of file threads_arch.c.

References bsem, and val.

◆ pprz_bsem_wait()

void pprz_bsem_wait ( pprz_bsem_t * bsem)

Definition at line 64 of file threads_arch.c.

References bsem.

◆ pprz_bsem_wait_timeout()

int pprz_bsem_wait_timeout ( pprz_bsem_t * bsem,
float timeout )

Wait on semaphore no more than timeout.

Parameters
timeoutin seconds
Returns
0 on success

Definition at line 68 of file threads_arch.c.

References bsem, and timeout.

◆ pprz_mtx_init()

int pprz_mtx_init ( pprz_mutex_t * mtx)

Definition at line 41 of file threads_arch.c.

References mtx.

◆ pprz_mtx_lock()

int pprz_mtx_lock ( pprz_mutex_t * mtx)

Definition at line 45 of file threads_arch.c.

References mtx.

◆ pprz_mtx_trylock()

int pprz_mtx_trylock ( pprz_mutex_t * mtx)

Performs a nonblocking lock on the mutex.

Returns
0 if successful

Definition at line 49 of file threads_arch.c.

References mtx.

◆ pprz_mtx_unlock()

int pprz_mtx_unlock ( pprz_mutex_t * mtx)

Definition at line 53 of file threads_arch.c.

References mtx.

◆ pprz_thread_assert_main()

void pprz_thread_assert_main ( const char * what,
unsigned int id )

Stop the program (abort on Linux/NPS, halt on ChibiOS) when not called from the main thread, e.g.

for an ABI message sent from another thread (ABI_CHECK_MAIN_THREAD)

Parameters
whatwhat was done outside the main thread (printed on Linux/NPS)
idits identifier (e.g. the ABI message ID)

Definition at line 34 of file threads_arch.c.

References pprz_thread_is_main().

Here is the call graph for this function:

◆ pprz_thread_create()

int pprz_thread_create ( pprz_thread_t * thread,
size_t size,
const char * name,
uint8_t prio,
void(* func )(void *),
void * arg )

Creates a new thread whose stack is dynamically allocated.

Parameters
[in]sizesize of the stack. Unused on linux at the moment.
[in]priothe priority level for the new thread. Unused on linux at the moment. NORMALPRIO
[in]pfthe thread function
[in]argan argument passed to the thread function. It can be NULL.
[out]threadpointer to a pprz_thread_t that will be writen with the handle to the thread
Returns
Return 0 on success, or a platform dependant error code.

@api

Definition at line 111 of file threads_arch.c.

References stub_arg::arg, stub_arg::func, and stub().

Here is the call graph for this function:

◆ pprz_thread_exit()

void pprz_thread_exit ( void * retval)

Exit the current thread.

Parameters
[out]retvalThe thread's return value

Definition at line 122 of file threads_arch.c.

◆ pprz_thread_init_main()

void pprz_thread_init_main ( void )

Remember the calling thread as the main thread, the one running the periodic and event functions of the modules.

Called by pprz_thread_periodic() (the init can run in another thread, e.g. in NPS).

Definition at line 25 of file threads_arch.c.

References main_thread, and main_thread_set.

◆ pprz_thread_is_main()

bool pprz_thread_is_main ( void )

The calling thread is the main thread (also true before pprz_thread_init_main() was called).

Definition at line 30 of file threads_arch.c.

References main_thread, and main_thread_set.

◆ pprz_thread_join()

int pprz_thread_join ( pprz_thread_t * thread,
void ** retval )

Wait for the thread to terminate.

Note
Warning ! This is a blocking function, do not use it in the main AP thread !
Parameters
[in]threadThe thread to be joined
[out]retvalThe thread's return value will be written to the variable pointed by retval

Definition at line 126 of file threads_arch.c.

◆ pprz_thread_tryjoin()

int pprz_thread_tryjoin ( pprz_thread_t * thread,
void ** retval )

Performs a nonblocking join with the thread.

Parameters
[in]threadThe thread to be joined
[out]retvalThe thread's return value will be written to the variable pointed by retval. must not be used if this fuction did not returned 0.
Returns
0 if the thread successfully joined.

Definition at line 130 of file threads_arch.c.

◆ stub()

void * stub ( void * arg)
static

Definition at line 104 of file threads_arch.c.

References stub_arg::arg, and stub_arg::func.

Referenced by pprz_thread_create().

Here is the caller graph for this function:

Variable Documentation

◆ main_thread

pthread_t main_thread
static

Definition at line 22 of file threads_arch.c.

◆ main_thread_set

bool main_thread_set = false
static

Definition at line 23 of file threads_arch.c.

Referenced by pprz_thread_init_main(), and pprz_thread_is_main().