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 <AK/ByteBuffer.h>
30#include <AK/String.h>
31#include <AK/Types.h>
32
33namespace Kernel {
34
35class FS;
36struct InodeMetadata;
37
38class InodeIdentifier {
39public:
40 InodeIdentifier() {}
41 InodeIdentifier(u32 fsid, u32 inode)
42 : m_fsid(fsid)
43 , m_index(inode)
44 {
45 }
46
47 bool is_valid() const { return m_fsid != 0 && m_index != 0; }
48
49 u32 fsid() const { return m_fsid; }
50 u32 index() const { return m_index; }
51
52 FS* fs();
53 const FS* fs() const;
54
55 bool operator==(const InodeIdentifier& other) const
56 {
57 return m_fsid == other.m_fsid && m_index == other.m_index;
58 }
59
60 bool operator!=(const InodeIdentifier& other) const
61 {
62 return m_fsid != other.m_fsid || m_index != other.m_index;
63 }
64
65 bool is_root_inode() const;
66
67 String to_string() const { return String::format("%u:%u", m_fsid, m_index); }
68
69private:
70 u32 m_fsid { 0 };
71 u32 m_index { 0 };
72};
73
74inline const LogStream& operator<<(const LogStream& stream, const InodeIdentifier& value)
75{
76 stream << value.fsid() << ':' << value.index();
77 return stream;
78}
79
80}