mirror of
https://github.com/RGBCube/serenity
synced 2025-10-31 21:52:45 +00:00
21d5f4ada1
This was supposed to be the foundation for some kind of pre-kernel environment, but nobody is working on it right now, so let's move everything back into the kernel and remove all the confusion.
105 lines
4.2 KiB
C++
105 lines
4.2 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/NonnullRefPtr.h>
|
|
#include <AK/RefCounted.h>
|
|
#include <AK/String.h>
|
|
#include <AK/Types.h>
|
|
#include <Kernel/Forward.h>
|
|
#include <Kernel/KResult.h>
|
|
#include <Kernel/UnixTypes.h>
|
|
#include <Kernel/VirtualAddress.h>
|
|
|
|
namespace Kernel {
|
|
|
|
// File is the base class for anything that can be referenced by a FileDescription.
|
|
//
|
|
// The most important functions in File are:
|
|
//
|
|
// read() and write()
|
|
// - Implement reading and writing.
|
|
// - Return the number of bytes read/written, OR a negative error code.
|
|
//
|
|
// can_read() and can_write()
|
|
//
|
|
// - Used to implement blocking I/O, and the select() and poll() syscalls.
|
|
// - Return true if read() or write() would succeed, respectively.
|
|
// - Note that can_read() should return true in EOF conditions,
|
|
// and a subsequent call to read() should return 0.
|
|
//
|
|
// ioctl()
|
|
//
|
|
// - Optional. If unimplemented, ioctl() on this File will fail with -ENOTTY.
|
|
// - Can be overridden in subclasses to implement arbitrary functionality.
|
|
// - Subclasses should take care to validate incoming addresses before dereferencing.
|
|
//
|
|
// mmap()
|
|
//
|
|
// - Optional. If unimplemented, mmap() on this File will fail with -ENODEV.
|
|
// - Called by mmap() when userspace wants to memory-map this File somewhere.
|
|
// - Should create a Region in the Process and return it if successful.
|
|
|
|
class File : public RefCounted<File> {
|
|
public:
|
|
virtual ~File();
|
|
|
|
virtual KResultOr<NonnullRefPtr<FileDescription>> open(int options);
|
|
virtual void close();
|
|
|
|
virtual bool can_read(const FileDescription&, size_t) const = 0;
|
|
virtual bool can_write(const FileDescription&, size_t) const = 0;
|
|
|
|
virtual ssize_t read(FileDescription&, size_t, u8*, ssize_t) = 0;
|
|
virtual ssize_t write(FileDescription&, size_t, const u8*, ssize_t) = 0;
|
|
virtual int ioctl(FileDescription&, unsigned request, unsigned arg);
|
|
virtual KResultOr<Region*> mmap(Process&, FileDescription&, VirtualAddress preferred_vaddr, size_t offset, size_t size, int prot, bool shared);
|
|
|
|
virtual String absolute_path(const FileDescription&) const = 0;
|
|
|
|
virtual KResult truncate(u64) { return KResult(-EINVAL); }
|
|
virtual KResult chown(uid_t, gid_t) { return KResult(-EBADF); }
|
|
virtual KResult chmod(mode_t) { return KResult(-EBADF); }
|
|
|
|
virtual const char* class_name() const = 0;
|
|
|
|
virtual bool is_seekable() const { return false; }
|
|
|
|
virtual bool is_inode() const { return false; }
|
|
virtual bool is_fifo() const { return false; }
|
|
virtual bool is_device() const { return false; }
|
|
virtual bool is_tty() const { return false; }
|
|
virtual bool is_master_pty() const { return false; }
|
|
virtual bool is_block_device() const { return false; }
|
|
virtual bool is_character_device() const { return false; }
|
|
virtual bool is_socket() const { return false; }
|
|
|
|
protected:
|
|
File();
|
|
};
|
|
|
|
}
|