source: mainline/kernel/generic/include/synch/waitq.h@ 111b9b9

ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 111b9b9 was 111b9b9, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 2 years ago

Reimplement waitq using thread_wait/wakeup

This adds a few functions to the thread API which can be
summarized as "stop running until woken up by others".
The ordering and context-switching concerns are thus yeeted
to this abstraction and waitq only deals with maintaining
the queues. Overall, this makes the control flow in waitq
much easier to navigate.

  • Property mode set to 100644
File size: 2.8 KB
Line 
1/*
2 * Copyright (c) 2001-2004 Jakub Jermar
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup kernel_sync
30 * @{
31 */
32/** @file
33 */
34
35#ifndef KERN_WAITQ_H_
36#define KERN_WAITQ_H_
37
38#include <typedefs.h>
39#include <synch/spinlock.h>
40#include <abi/synch.h>
41#include <adt/list.h>
42
43/** Wait queue structure.
44 *
45 */
46typedef struct waitq {
47 /** Lock protecting wait queue structure.
48 *
49 * Must be acquired before T.lock for each T of type thread_t.
50 */
51 IRQ_SPINLOCK_DECLARE(lock);
52
53 /**
54 * If negative, number of wakeups that are to be ignored (necessary for futex operation).
55 * If positive, number of wakeups that weren't able to wake a thread.
56 */
57 int wakeup_balance;
58
59 /** List of sleeping threads for which there was no missed_wakeup. */
60 list_t sleepers;
61
62 bool closed;
63} waitq_t;
64
65typedef struct wait_guard {
66 ipl_t ipl;
67} wait_guard_t;
68
69struct thread;
70
71extern void waitq_initialize(waitq_t *);
72extern void waitq_initialize_with_count(waitq_t *, int);
73extern errno_t waitq_sleep(waitq_t *);
74extern errno_t _waitq_sleep_timeout(waitq_t *, uint32_t, unsigned int);
75extern errno_t waitq_sleep_timeout(waitq_t *, uint32_t);
76extern wait_guard_t waitq_sleep_prepare(waitq_t *);
77extern errno_t waitq_sleep_unsafe(waitq_t *, wait_guard_t);
78extern errno_t waitq_sleep_timeout_unsafe(waitq_t *, uint32_t, unsigned int, wait_guard_t);
79
80extern void waitq_wake_one(waitq_t *);
81extern void waitq_wake_all(waitq_t *);
82extern void waitq_signal(waitq_t *);
83extern void waitq_close(waitq_t *);
84
85#endif
86
87/** @}
88 */
Note: See TracBrowser for help on using the repository browser.