1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*
ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS/RT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @addtogroup Messages
* @{
*/
#include <ch.h>
#ifdef CH_USE_MESSAGES
/**
* Sends a message to the specified thread. The client is stopped until the
* server executes a \p chMsgRelease() after receiving the message.
*
* @param tp the pointer to the thread
* @param msg the message, it can be a pointer to a complex structure
* @return the return message from \p chMsgRelease()
*/
t_msg chMsgSend(Thread *tp, t_msg msg) {
chSysLock();
#ifdef CH_USE_MESSAGES_PRIORITY
if (tp->p_flags & P_MSGBYPRIO)
prio_insert(currp, &tp->p_msgqueue);
else
fifo_insert(currp, &tp->p_msgqueue);
#else
fifo_insert(currp, &tp->p_msgqueue);
#endif
currp->p_msg = msg;
currp->p_wtthdp = tp;
if (tp->p_state == PRWTMSG)
chSchReadyI(tp, RDY_OK);
chSchGoSleepS(PRSNDMSG);
msg = currp->p_rdymsg;
chSysUnlock();
return msg;
}
#ifdef CH_USE_MESSAGES_EVENT
/**
* Sends a message to the specified thread and atomically triggers an event.
* The client is stopped until the server executes a \p chMsgRelease()
* after receiving the message.
*
* @param tp the pointer to the thread
* @param msg the message, it can be a pointer to a complex structure
* @param esp the event source to pulse while sending the message
* @return the return message from \p chMsgRelease()
* @return the message return status from \p chMsgRelease()
* @note This function assumes that the receiving thread is not sleeping into
* a \p chMsgWait(). The use case is that the server thread is waiting
* for both messages AND events while waiting into \p chEvtWait().
*/
t_msg chMsgSendWithEvent(Thread *tp, t_msg msg, EventSource *esp) {
chSysLock();
chDbgAssert(tp->p_state != PRWTMSG, "chmsg.c, chMsgSendWithEvent()");
#ifdef CH_USE_MESSAGES_PRIORITY
if (tp->p_flags & P_MSGBYPRIO)
prio_insert(currp, &tp->p_msgqueue);
else
fifo_insert(currp, &tp->p_msgqueue);
#else
fifo_insert(currp, &tp->p_msgqueue);
#endif
chEvtSendI(esp);
currp->p_wtthdp = tp;
currp->p_msg = msg;
chSchGoSleepS(PRSNDMSG);
msg = currp->p_rdymsg;
chSysUnlock();
return msg;
}
#endif
#ifdef CH_USE_MESSAGES_TIMEOUT
static void wakeup(void *p) {
chDbgAssert(((Thread *)p)->p_state == PRSNDMSG, "chmsg.c, wakeup()");
chSchReadyI(dequeue(p), RDY_TIMEOUT);
}
/**
* Sends a message to the specified thread with timeout specification. The
* sender is stopped until the receiver executes a \p chMsgRelease().
*
* @param tp the pointer to the thread
* @param msg the message. Note that it can be a pointer to a complex
* message structure.
* @param time the number of ticks before the operation fails
* @return the message return status from \p chMsgRelease() or
* \p RDY_TIMEOUT the specified time expired.
* @note The server thread can also return data into the message structure
* if you need messages to be bidirectional, just define the structure
* according your needs. If you dont need complicated messages exchange
* you may just use the \p chMsgRelease() status code as response
* to the message.
*/
t_msg chMsgSendTimeout(Thread *tp, t_msg msg, t_time time) {
VirtualTimer vt;
chSysLock();
chVTSetI(&vt, time, wakeup, currp);
#ifdef CH_USE_MESSAGES_PRIORITY
if (tp->p_flags & P_MSGBYPRIO)
prio_insert(currp, &tp->p_msgqueue);
else
fifo_insert(currp, &tp->p_msgqueue);
#else
fifo_insert(currp, &tp->p_msgqueue);
#endif
currp->p_msg = msg;
currp->p_wtthdp = tp;
if (tp->p_state == PRWTMSG)
chSchReadyI(tp, RDY_OK);
chSchGoSleepS(PRSNDMSG);
msg = currp->p_rdymsg;
if (chVTIsArmedI(&vt))
chVTResetI(&vt);
chSysUnlock();
return msg;
}
#endif /* CH_USE_MESSAGES_TIMEOUT */
/**
* Suspends the thread and waits for an incoming message.
*
* @return the pointer to the message structure. Note, it is always the
* message associated to the thread on the top of the messages queue.
* @note You can assume that the data contained in the message is stable until
* you invoke \p chMsgRelease() because the sending thread is
* suspended until then.
*/
t_msg chMsgWait(void) {
t_msg msg;
chSysLock();
if (!chMsgIsPendingI(currp))
chSchGoSleepS(PRWTMSG);
msg = chMsgGetI(currp);
chSysUnlock();
return msg;
}
/**
* Returns the next message in the queue.
*
* @return the pointer to the message structure. Note, it is always the
* message associated to the thread on the top of the messages queue.
* If the queue is empty then \p NULL is returned.
* @note You can assume that the data pointed by the message is stable until
* you invoke \p chMsgRelease() because the sending thread is
* suspended until then. Always remember that the message data is not
* copied between the sender and the receiver, just a pointer is passed.
*/
t_msg chMsgGet(void) {
t_msg msg;
chSysLock();
msg = chMsgIsPendingI(currp) ? chMsgGetI(currp) : NULL;
chSysUnlock();
return msg;
}
/**
* Releases the thread waiting on top of the messages queue.
*
* @param msg the message returned to the message sender
* @note You can call this function only if there is a message already in the
* queue else the result will be unpredictable (a crash most likely).
* Exiting from the \p chMsgWait() ensures you have at least one
* message in the queue so it is not a big deal.<br>
* The condition is not checked in order to make this code as fast as
* possible.
*/
void chMsgRelease(t_msg msg) {
chSysLock();
chDbgAssert(chMsgIsPendingI(currp), "chmsg.c, chMsgRelease()");
chSchWakeupS(fifo_remove(&currp->p_msgqueue), msg);
chSysUnlock();
}
#endif /* CH_USE_MESSAGES */
/** @} */
|
