2020-01-18 08:38:21 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 08:38:21 +00:00
|
|
|
*/
|
|
|
|
|
2018-11-12 00:28:46 +00:00
|
|
|
#pragma once
|
|
|
|
|
2019-04-29 02:55:54 +00:00
|
|
|
#include <Kernel/DoubleBuffer.h>
|
2019-07-09 12:46:23 +00:00
|
|
|
#include <Kernel/FileSystem/File.h>
|
2021-07-18 07:10:27 +00:00
|
|
|
#include <Kernel/Locking/Mutex.h>
|
2019-05-28 09:53:16 +00:00
|
|
|
#include <Kernel/UnixTypes.h>
|
2020-07-16 21:23:03 +00:00
|
|
|
#include <Kernel/WaitQueue.h>
|
2018-11-12 00:28:46 +00:00
|
|
|
|
2020-02-16 00:27:42 +00:00
|
|
|
namespace Kernel {
|
|
|
|
|
2021-09-07 11:39:11 +00:00
|
|
|
class OpenFileDescription;
|
2019-04-29 02:55:54 +00:00
|
|
|
|
|
|
|
class FIFO final : public File {
|
2018-11-12 00:28:46 +00:00
|
|
|
public:
|
2019-07-03 19:17:35 +00:00
|
|
|
enum class Direction : u8 {
|
2019-05-28 09:53:16 +00:00
|
|
|
Neither,
|
|
|
|
Reader,
|
|
|
|
Writer
|
2018-11-12 00:28:46 +00:00
|
|
|
};
|
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
static ErrorOr<NonnullRefPtr<FIFO>> try_create(UserID);
|
2019-04-29 02:55:54 +00:00
|
|
|
virtual ~FIFO() override;
|
2019-04-25 11:52:07 +00:00
|
|
|
|
2021-08-28 20:11:16 +00:00
|
|
|
UserID uid() const { return m_uid; }
|
2018-11-12 00:28:46 +00:00
|
|
|
|
2021-11-07 23:51:39 +00:00
|
|
|
ErrorOr<NonnullRefPtr<OpenFileDescription>> open_direction(Direction);
|
|
|
|
ErrorOr<NonnullRefPtr<OpenFileDescription>> open_direction_blocking(Direction);
|
2018-11-12 00:28:46 +00:00
|
|
|
|
2021-06-24 12:04:41 +00:00
|
|
|
#pragma GCC diagnostic push
|
|
|
|
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
|
2019-04-29 02:55:54 +00:00
|
|
|
void attach(Direction);
|
|
|
|
void detach(Direction);
|
2021-06-24 12:04:41 +00:00
|
|
|
#pragma GCC diagnostic pop
|
2018-11-12 00:28:46 +00:00
|
|
|
|
|
|
|
private:
|
2019-04-29 02:55:54 +00:00
|
|
|
// ^File
|
2022-04-01 17:58:27 +00:00
|
|
|
virtual ErrorOr<size_t> write(OpenFileDescription&, u64, UserOrKernelBuffer const&, size_t) override;
|
2021-11-07 23:51:39 +00:00
|
|
|
virtual ErrorOr<size_t> read(OpenFileDescription&, u64, UserOrKernelBuffer&, size_t) override;
|
2021-12-17 10:22:27 +00:00
|
|
|
virtual ErrorOr<struct stat> stat() const override;
|
2022-04-01 17:58:27 +00:00
|
|
|
virtual bool can_read(OpenFileDescription const&, u64) const override;
|
|
|
|
virtual bool can_write(OpenFileDescription const&, u64) const override;
|
|
|
|
virtual ErrorOr<NonnullOwnPtr<KString>> pseudo_path(OpenFileDescription const&) const override;
|
2021-10-02 22:24:00 +00:00
|
|
|
virtual StringView class_name() const override { return "FIFO"sv; }
|
2019-04-29 02:55:54 +00:00
|
|
|
virtual bool is_fifo() const override { return true; }
|
|
|
|
|
2021-08-28 20:11:16 +00:00
|
|
|
explicit FIFO(UserID, NonnullOwnPtr<DoubleBuffer> buffer);
|
2018-11-12 00:28:46 +00:00
|
|
|
|
|
|
|
unsigned m_writers { 0 };
|
|
|
|
unsigned m_readers { 0 };
|
2021-08-01 09:30:52 +00:00
|
|
|
NonnullOwnPtr<DoubleBuffer> m_buffer;
|
2019-04-25 11:52:07 +00:00
|
|
|
|
2021-08-28 20:11:16 +00:00
|
|
|
UserID m_uid { 0 };
|
2020-01-07 06:29:50 +00:00
|
|
|
|
|
|
|
int m_fifo_id { 0 };
|
2020-07-16 21:23:03 +00:00
|
|
|
|
|
|
|
WaitQueue m_read_open_queue;
|
|
|
|
WaitQueue m_write_open_queue;
|
2021-07-17 19:09:51 +00:00
|
|
|
Mutex m_open_lock;
|
2018-11-12 00:28:46 +00:00
|
|
|
};
|
2020-02-16 00:27:42 +00:00
|
|
|
|
|
|
|
}
|