kernel/include/kernel/wait.h

// Copyright 2016 The Fuchsia Authors
// Copyright (c) 2008-2014 Travis Geiselbrecht
//
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT

#pragma once

#include <arch/defines.h>
#include <arch/ops.h>
#include <arch/thread.h>
#include <list.h>
#include <sys/types.h>
#include <zircon/compiler.h>
#include <zircon/types.h>

__BEGIN_CDECLS

/* wait queue stuff */
#define WAIT_QUEUE_MAGIC (0x77616974) // 'wait'

typedef struct wait_queue {
    int magic;
    int count;
    struct list_node heads;
} wait_queue_t;

#define WAIT_QUEUE_INITIAL_VALUE(q)             \
    {                                           \
        .magic = WAIT_QUEUE_MAGIC,              \
        .count = 0,                             \
        .heads = LIST_INITIAL_VALUE((q).heads), \
    }

/* wait queue primitive */
/* NOTE: must be inside critical section when using these */
void wait_queue_init(wait_queue_t* wait);

void wait_queue_destroy(wait_queue_t*);

/*
 * block on a wait queue.
 * return status is whatever the caller of wait_queue_wake_*() specifies.
 * a deadline other than ZX_TIME_INFINITE will abort at the specified time
 * and return ZX_ERR_TIMED_OUT. a deadline in the past will immediately return.
 */
zx_status_t wait_queue_block(wait_queue_t*, zx_time_t deadline);

/*
 * block on a wait queue, ignoring existing signals in |signal_mask|.
 * return status is whatever the caller of wait_queue_wake_*() specifies.
 * a deadline other than ZX_TIME_INFINITE will abort at the specified time
 * and return ZX_ERR_TIMED_OUT. a deadline in the past will immediately return.
 */
zx_status_t wait_queue_block_with_mask(wait_queue_t*, zx_time_t deadline,
                                       uint signal_mask);

/* returns the highest priority of all the blocked threads on this wait queue.
 * returns -1 if no threads are blocked.
 */
int wait_queue_blocked_priority(wait_queue_t*);

/*
 * release one or more threads from the wait queue.
 * reschedule = should the system reschedule if any is released.
 * wait_queue_error = what wait_queue_block() should return for the blocking thread.
 */
int wait_queue_wake_one(wait_queue_t*, bool reschedule, zx_status_t wait_queue_error);
int wait_queue_wake_all(wait_queue_t*, bool reschedule, zx_status_t wait_queue_error);
struct thread* wait_queue_dequeue_one(wait_queue_t* wait, zx_status_t wait_queue_error);

/* is the wait queue currently empty */
bool wait_queue_is_empty(wait_queue_t*);

/* remove a specific thread out of a wait queue it's blocked on */
zx_status_t wait_queue_unblock_thread(struct thread* t, zx_status_t wait_queue_error, bool* local_resched);

__END_CDECLS