1 | /** |
---|
2 | * @file rtems/score/threadmp.h |
---|
3 | * |
---|
4 | * @brief Multiprocessing Portion of the Thread Package |
---|
5 | * |
---|
6 | * This include file contains the specification for all routines |
---|
7 | * and data specific to the multiprocessing portion of the thread package. |
---|
8 | */ |
---|
9 | |
---|
10 | /* |
---|
11 | * COPYRIGHT (c) 1989-2009. |
---|
12 | * On-Line Applications Research Corporation (OAR). |
---|
13 | * |
---|
14 | * The license and distribution terms for this file may be |
---|
15 | * found in the file LICENSE in this distribution or at |
---|
16 | * http://www.rtems.org/license/LICENSE. |
---|
17 | */ |
---|
18 | |
---|
19 | #ifndef _RTEMS_SCORE_THREADMP_H |
---|
20 | #define _RTEMS_SCORE_THREADMP_H |
---|
21 | |
---|
22 | #ifndef _RTEMS_SCORE_THREADIMPL_H |
---|
23 | # error "Never use <rtems/score/threadmp.h> directly; include <rtems/score/threadimpl.h> instead." |
---|
24 | #endif |
---|
25 | |
---|
26 | #include <rtems/score/mpciimpl.h> |
---|
27 | |
---|
28 | #ifdef __cplusplus |
---|
29 | extern "C" { |
---|
30 | #endif |
---|
31 | |
---|
32 | /** |
---|
33 | * @defgroup ScoreThreadMP Thread Handler Multiprocessing Support |
---|
34 | * |
---|
35 | * @ingroup Score |
---|
36 | * |
---|
37 | * This handler encapsulates functionality which is related to managing |
---|
38 | * threads in a multiprocessor system configuration. This handler must |
---|
39 | * manage proxies which represent remote threads blocking on local |
---|
40 | * operations. |
---|
41 | */ |
---|
42 | /**@{*/ |
---|
43 | |
---|
44 | /** |
---|
45 | * @brief Initialize MP thread handler. |
---|
46 | * |
---|
47 | * This routine initializes the multiprocessing portion of the Thread Handler. |
---|
48 | */ |
---|
49 | void _Thread_MP_Handler_initialization ( |
---|
50 | uint32_t maximum_proxies |
---|
51 | ); |
---|
52 | |
---|
53 | /** |
---|
54 | * @brief Allocate a MP proxy control block from |
---|
55 | * the inactive chain of free proxy control blocks. |
---|
56 | * |
---|
57 | * This allocates a proxy control block from |
---|
58 | * the inactive chain of free proxy control blocks. |
---|
59 | * |
---|
60 | * @note This function returns a thread control pointer |
---|
61 | * because proxies are substitutes for remote threads. |
---|
62 | */ |
---|
63 | Thread_Control *_Thread_MP_Allocate_proxy ( |
---|
64 | States_Control the_state |
---|
65 | ); |
---|
66 | |
---|
67 | /** |
---|
68 | * @brief Removes the MP proxy control block for the specified |
---|
69 | * id from the active chain of proxy control blocks. |
---|
70 | * |
---|
71 | * This function removes the proxy control block for the specified |
---|
72 | * id from the active red-black tree of proxy control blocks. |
---|
73 | */ |
---|
74 | Thread_Control *_Thread_MP_Find_proxy ( |
---|
75 | Objects_Id the_id |
---|
76 | ); |
---|
77 | |
---|
78 | /** |
---|
79 | * This function returns true if the thread in question is the |
---|
80 | * multiprocessing receive thread. |
---|
81 | * |
---|
82 | * @note This is a macro to avoid needing a prototype for |
---|
83 | * _MPCI_Receive_server_tcb until it is used. |
---|
84 | */ |
---|
85 | #define _Thread_MP_Is_receive(_the_thread) \ |
---|
86 | ((_the_thread) == _MPCI_Receive_server_tcb) |
---|
87 | |
---|
88 | /** |
---|
89 | * This routine frees a proxy control block to the |
---|
90 | * inactive chain of free proxy control blocks. |
---|
91 | */ |
---|
92 | void _Thread_MP_Free_proxy( Thread_Control *the_thread ); |
---|
93 | |
---|
94 | RTEMS_INLINE_ROUTINE bool _Thread_MP_Is_remote( Objects_Id id ) |
---|
95 | { |
---|
96 | Objects_Information *information; |
---|
97 | |
---|
98 | information = _Thread_Get_objects_information( id ); |
---|
99 | if ( information == NULL ) { |
---|
100 | return false; |
---|
101 | } |
---|
102 | |
---|
103 | return _Objects_MP_Is_remote( id, information ); |
---|
104 | } |
---|
105 | |
---|
106 | /**@}*/ |
---|
107 | |
---|
108 | #ifdef __cplusplus |
---|
109 | } |
---|
110 | #endif |
---|
111 | |
---|
112 | #endif |
---|
113 | /* end of include file */ |
---|