2020-01-18 11:38:21 +03:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
|
|
*
|
2021-04-22 11:24:48 +03:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 11:38:21 +03:00
|
|
|
*/
|
|
|
|
|
2018-11-12 03:28:46 +03:00
|
|
|
#pragma once
|
|
|
|
|
2019-04-29 05:55:54 +03:00
|
|
|
#include <Kernel/DoubleBuffer.h>
|
2019-07-09 15:46:23 +03:00
|
|
|
#include <Kernel/FileSystem/File.h>
|
2020-07-17 00:23:03 +03:00
|
|
|
#include <Kernel/Lock.h>
|
2019-05-28 12:53:16 +03:00
|
|
|
#include <Kernel/UnixTypes.h>
|
2020-07-17 00:23:03 +03:00
|
|
|
#include <Kernel/WaitQueue.h>
|
2018-11-12 03:28:46 +03:00
|
|
|
|
2020-02-16 03:27:42 +03:00
|
|
|
namespace Kernel {
|
|
|
|
|
2019-06-07 10:36:51 +03:00
|
|
|
class FileDescription;
|
2019-04-29 05:55:54 +03:00
|
|
|
|
|
|
|
class FIFO final : public File {
|
2018-11-12 03:28:46 +03:00
|
|
|
public:
|
2019-07-03 22:17:35 +03:00
|
|
|
enum class Direction : u8 {
|
2019-05-28 12:53:16 +03:00
|
|
|
Neither,
|
|
|
|
Reader,
|
|
|
|
Writer
|
2018-11-12 03:28:46 +03:00
|
|
|
};
|
|
|
|
|
2019-06-21 19:37:47 +03:00
|
|
|
static NonnullRefPtr<FIFO> create(uid_t);
|
2019-04-29 05:55:54 +03:00
|
|
|
virtual ~FIFO() override;
|
2019-04-25 14:52:07 +03:00
|
|
|
|
|
|
|
uid_t uid() const { return m_uid; }
|
2018-11-12 03:28:46 +03:00
|
|
|
|
2020-09-17 22:51:09 +03:00
|
|
|
KResultOr<NonnullRefPtr<FileDescription>> open_direction(Direction);
|
|
|
|
KResultOr<NonnullRefPtr<FileDescription>> open_direction_blocking(Direction);
|
2018-11-12 03:28:46 +03:00
|
|
|
|
2019-04-29 05:55:54 +03:00
|
|
|
void attach(Direction);
|
|
|
|
void detach(Direction);
|
2018-11-12 03:28:46 +03:00
|
|
|
|
|
|
|
private:
|
2019-04-29 05:55:54 +03:00
|
|
|
// ^File
|
2021-03-17 15:18:51 +03:00
|
|
|
virtual KResultOr<size_t> write(FileDescription&, u64, const UserOrKernelBuffer&, size_t) override;
|
|
|
|
virtual KResultOr<size_t> read(FileDescription&, u64, UserOrKernelBuffer&, size_t) override;
|
2020-09-06 19:31:51 +03:00
|
|
|
virtual KResult stat(::stat&) const override;
|
2020-04-10 12:44:42 +03:00
|
|
|
virtual bool can_read(const FileDescription&, size_t) const override;
|
|
|
|
virtual bool can_write(const FileDescription&, size_t) const override;
|
2019-06-07 10:36:51 +03:00
|
|
|
virtual String absolute_path(const FileDescription&) const override;
|
2019-04-29 05:55:54 +03:00
|
|
|
virtual const char* class_name() const override { return "FIFO"; }
|
|
|
|
virtual bool is_fifo() const override { return true; }
|
|
|
|
|
2019-04-25 14:52:07 +03:00
|
|
|
explicit FIFO(uid_t);
|
2018-11-12 03:28:46 +03:00
|
|
|
|
|
|
|
unsigned m_writers { 0 };
|
|
|
|
unsigned m_readers { 0 };
|
2018-12-03 04:24:11 +03:00
|
|
|
DoubleBuffer m_buffer;
|
2019-04-25 14:52:07 +03:00
|
|
|
|
|
|
|
uid_t m_uid { 0 };
|
2020-01-07 09:29:50 +03:00
|
|
|
|
|
|
|
int m_fifo_id { 0 };
|
2020-07-17 00:23:03 +03:00
|
|
|
|
|
|
|
WaitQueue m_read_open_queue;
|
|
|
|
WaitQueue m_write_open_queue;
|
|
|
|
Lock m_open_lock;
|
2018-11-12 03:28:46 +03:00
|
|
|
};
|
2020-02-16 03:27:42 +03:00
|
|
|
|
|
|
|
}
|