summaryrefslogtreecommitdiff
path: root/Kernel/FileSystem/FIFO.cpp
blob: 1c7939db1190afd66f9a97c5a9c74a8c8e5b4ff4 (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
137
138
139
140
/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <AK/Atomic.h>
#include <AK/StdLibExtras.h>
#include <Kernel/FileSystem/FIFO.h>
#include <Kernel/FileSystem/OpenFileDescription.h>
#include <Kernel/Locking/Mutex.h>
#include <Kernel/Process.h>
#include <Kernel/Thread.h>

namespace Kernel {

static Atomic<int> s_next_fifo_id = 1;

ErrorOr<NonnullRefPtr<FIFO>> FIFO::try_create(UserID uid)
{
    auto buffer = TRY(DoubleBuffer::try_create("FIFO: Buffer"sv));
    return adopt_nonnull_ref_or_enomem(new (nothrow) FIFO(uid, move(buffer)));
}

ErrorOr<NonnullRefPtr<OpenFileDescription>> FIFO::open_direction(FIFO::Direction direction)
{
    auto description = TRY(OpenFileDescription::try_create(*this));
    if (direction == Direction::Reader) {
        ++m_readers;
    } else if (direction == Direction::Writer) {
        ++m_writers;
    }
    evaluate_block_conditions();
    description->set_fifo_direction({}, direction);
    return description;
}

ErrorOr<NonnullRefPtr<OpenFileDescription>> FIFO::open_direction_blocking(FIFO::Direction direction)
{
    MutexLocker locker(m_open_lock);

    auto description = TRY(open_direction(direction));

    if (direction == Direction::Reader) {
        m_read_open_queue.wake_all();

        if (m_writers == 0) {
            locker.unlock();
            m_write_open_queue.wait_forever("FIFO"sv);
            locker.lock();
        }
    }

    if (direction == Direction::Writer) {
        m_write_open_queue.wake_all();

        if (m_readers == 0) {
            locker.unlock();
            m_read_open_queue.wait_forever("FIFO"sv);
            locker.lock();
        }
    }

    return description;
}

FIFO::FIFO(UserID uid, NonnullOwnPtr<DoubleBuffer> buffer)
    : m_buffer(move(buffer))
    , m_uid(uid)
{
    m_fifo_id = ++s_next_fifo_id;

    // Use the same block condition for read and write
    m_buffer->set_unblock_callback([this]() {
        evaluate_block_conditions();
    });
}

FIFO::~FIFO() = default;

void FIFO::detach(OpenFileDescription& description)
{
    File::detach(description);

    auto direction = description.fifo_direction();
    if (direction == Direction::Reader) {
        VERIFY(m_readers);
        --m_readers;
    } else if (direction == Direction::Writer) {
        VERIFY(m_writers);
        --m_writers;
    }

    evaluate_block_conditions();
}

bool FIFO::can_read(OpenFileDescription const&, u64) const
{
    return !m_buffer->is_empty() || !m_writers;
}

bool FIFO::can_write(OpenFileDescription const&, u64) const
{
    return m_buffer->space_for_writing() || !m_readers;
}

ErrorOr<size_t> FIFO::read(OpenFileDescription& fd, u64, UserOrKernelBuffer& buffer, size_t size)
{
    if (m_buffer->is_empty()) {
        if (!m_writers)
            return 0;
        if (!fd.is_blocking())
            return EAGAIN;
    }
    return m_buffer->read(buffer, size);
}

ErrorOr<size_t> FIFO::write(OpenFileDescription& fd, u64, UserOrKernelBuffer const& buffer, size_t size)
{
    if (!m_readers)
        return EPIPE;
    if (!fd.is_blocking() && m_buffer->space_for_writing() == 0)
        return EAGAIN;

    return m_buffer->write(buffer, size);
}

ErrorOr<NonnullOwnPtr<KString>> FIFO::pseudo_path(OpenFileDescription const&) const
{
    return KString::formatted("fifo:{}", m_fifo_id);
}

ErrorOr<struct stat> FIFO::stat() const
{
    struct stat st = {};
    st.st_mode = S_IFIFO;
    return st;
}

}