jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <Kernel/FileSystem/File.h>
30
31namespace Kernel {
32
33class Inode;
34
35class InodeFile final : public File {
36public:
37 static NonnullRefPtr<InodeFile> create(NonnullRefPtr<Inode>&& inode)
38 {
39 return adopt(*new InodeFile(move(inode)));
40 }
41
42 virtual ~InodeFile() override;
43
44 const Inode& inode() const { return *m_inode; }
45 Inode& inode() { return *m_inode; }
46
47 virtual bool can_read(const FileDescription&) const override { return true; }
48 virtual bool can_write(const FileDescription&) const override { return true; }
49
50 virtual ssize_t read(FileDescription&, u8*, ssize_t) override;
51 virtual ssize_t write(FileDescription&, const u8*, ssize_t) override;
52 virtual KResultOr<Region*> mmap(Process&, FileDescription&, VirtualAddress preferred_vaddr, size_t offset, size_t size, int prot, bool shared) override;
53
54 virtual String absolute_path(const FileDescription&) const override;
55
56 virtual KResult truncate(u64) override;
57 virtual KResult chown(uid_t, gid_t) override;
58 virtual KResult chmod(mode_t) override;
59
60 virtual const char* class_name() const override { return "InodeFile"; }
61
62 virtual bool is_seekable() const override { return true; }
63 virtual bool is_inode() const override { return true; }
64
65private:
66 explicit InodeFile(NonnullRefPtr<Inode>&&);
67 NonnullRefPtr<Inode> m_inode;
68};
69
70}