aboutsummaryrefslogtreecommitdiffstats
path: root/src/chcond.c
blob: 668333b10b9c001c5086105d1fc971933a47d513 (plain)
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
/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT and Copyright (C) 2008 Leon Woestenberg.

    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 CondVars
 * @{
 */

#include <ch.h>

#ifdef CH_USE_CONDVARS

/**
 * Initializes s \p CondVar structure.
 * @param cp pointer to a \p CondVar structure
 */
void chCondInit(CondVar *cp) {

  fifo_init(&cp->c_queue);
}

/**
 * Signals one thread that is waiting on the condition variable.
 *
 * @param mp pointer to the \p CondVar structure
 */
void chCondSignal(CondVar *cp) {

  chSysLock();
  chCondSignalS(cp);
  chSysUnlock();
}

/**
 * Signals one thread that is waiting on the condition variable.
 *
 * @param cp pointer to the \p CondVar structure
 * @note This function must be called within a \p chSysLock() / \p chSysUnlock()
 *       block.
 */
void chCondSignalS(CondVar *cp) {

  if (notempty(&cp->c_queue))
    /* wake up the first thread, if any */
    chSchWakeupS(fifo_remove(&cp->c_queue), RDY_OK);
}

/**
 * Signal all threads that are waiting on the condition variable.
 *
 * @param mp pointer to the \p CondVar structure
 */
void chCondBroadcast(CondVar *cp) {

  chSysLock();

  chCondBroadcastS(cp);
  chSchRescheduleS();

  chSysUnlock();
}

/**
 * Signal all threads that are waiting on the condition variable.
 *
 * @param cp pointer to the \p CondVar structure
 * @note This function must be called within a \p chSysLock() / \p chSysUnlock()
 */
void chCondBroadcastS(CondVar *cp) {

  /* empties the condition variable queue and inserts all the Threads into the
   * ready list in FIFO order. The wakeup message is set to \p RDY_RESET in
   * order to make a chCondBroadcast() detectable from a chCondSignal(). */
  while (cp->c_queue.p_next != (void *)&cp->c_queue)
    chSchReadyI(fifo_remove(&cp->c_queue))->p_rdymsg = RDY_RESET;
}

/**
 * Wait on the condition variable protected by the given mutex.
 *
 * Release the mutex, wait on the condition variable, and lock the mutex. This
 * is done atomically.
 *
 * @param cp pointer to the \p CondVar structure
 * @note This function must be called within a \p chSysLock() / \p chSysUnlock()
 */
msg_t chCondWait(CondVar *cp, Mutex *mp) {
  msg_t msg;

  chSysLock();

  msg = chCondWaitS(cp, mp);

  chSysUnlock();
  return msg;
}

msg_t chCondWaitS(CondVar *cp, Mutex *mp) {

  /* lock the mutex that protects access to the condition variable */
  chMtxLockS(mp);
  /* wait on the condition variable */
  prio_insert(currp, &cp->c_queue);
  /* Thread remembers the condition variable it waits on */
  currp->p_wtcondp = cp;
  /* sleep until signaled */
  chSchGoSleepS(PRWTCOND);
  /* lock the mutex that protects access to the condition variable */
  chMtxLockS(mp);
  currp->p_wtcondp = NULL;
  return currp->p_rdymsg;
}

#endif /* CH_USE_CONDVARS */

/** @} */