aboutsummaryrefslogtreecommitdiffstats
path: root/src/chlists.c
blob: 39bea02ccc287d3646dcd49cbaf76b2a9ba7131f (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
133
134
135
136
/*
    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/>.
*/

/**
 * @file chlists.c
 * @brief Lists and queues code.
 * @addtogroup ThreadLists
 * @{
 */
#include <ch.h>

#if !CH_OPTIMIZE_SPEED || defined(__DOXYGEN__)
/**
 * @brief Inserts a thread into a priority ordered queue.
 *
 * @param tp the pointer to the thread to be inserted in the list
 * @param tqp the pointer to the threads list header
 * @note The insertion is done by scanning the list from the highest priority
 *       toward the lowest.
 * @note This function is @b not an API.
 */
void prio_insert(Thread *tp, ThreadsQueue *tqp) {

  /* cp iterates over the queue */
  Thread *cp = tqp->p_next;
  /* not end of queue? and cp has equal or higher priority than tp? */
  while ((cp != (Thread *)tqp) && (cp->p_prio >= tp->p_prio))
    /* iterate to next thread in queue */
    cp = cp->p_next;
  /* insert before cp, point tp to next and prev in queue */
  tp->p_prev = (tp->p_next = cp)->p_prev;
  /* make prev point to tp, and cp point back to tp */
  tp->p_prev->p_next = cp->p_prev = tp;
}

/**
 * @brief Inserts a Thread into a queue.
 *
 * @param tp the pointer to the thread to be inserted in the list
 * @param tqp the pointer to the threads list header
 * @note This function is @b not an API.
 */
void queue_insert(Thread *tp, ThreadsQueue *tqp) {

  tp->p_prev = (tp->p_next = (Thread *)tqp)->p_prev;
  tp->p_prev->p_next = tqp->p_prev = tp;
}

/**
 * @brief Removes the first-out Thread from a queue and returns it.
 *
 * @param tqp the pointer to the threads list header
 * @return The removed thread pointer.
 * @note This function is @b not an API.
 */
Thread *fifo_remove(ThreadsQueue *tqp) {
  Thread *tp = tqp->p_next;

  (tqp->p_next = tp->p_next)->p_prev = (Thread *)tqp;
  return tp;
}

/**
 * @brief Removes the last-out Thread from a queue and returns it.
 *
 * @param tqp the pointer to the threads list header
 * @return The removed thread pointer.
 * @note This function is @b not an API.
 */
Thread *lifo_remove(ThreadsQueue *tqp) {
  Thread *tp = tqp->p_next;

  (tqp->p_next = tp->p_next)->p_prev = (Thread *)tqp;
  return tp;
}

/**
 * @brief Removes a Thread from a FIFO list and returns it.
 *
 * @param tp the pointer to the thread to be removed from the list
 * @return The removed thread pointer.
 * @note This function is @b not an API.
 */
Thread *dequeue(Thread *tp) {

  tp->p_prev->p_next = tp->p_next;
  tp->p_next->p_prev = tp->p_prev;
  return tp;
}

/**
 * @brief Pushes a Thread on top of a stack list.
 *
 * @param tp the pointer to the thread to be inserted in the list
 * @param tlp the pointer to the threads list header
 * @note This function is @b not an API.
 */
void list_insert(Thread *tp, ThreadsList *tlp) {

  tp->p_next = tlp->p_next;
  tlp->p_next = tp;
}

/**
 * @brief Pops a Thread from the top of a stack list and returns it.
 *
 * @param tlp the pointer to the threads list header
 * @return The removed thread pointer.
 * @note The list must be non-empty before calling this function.
 * @note This function is @b not an API.
 */
Thread *list_remove(ThreadsList *tlp) {

  Thread *tp = tlp->p_next;
  tlp->p_next = tp->p_next;
  return tp;
}
#endif /* CH_OPTIMIZE_SPEED */

/** @} */