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/RefCounted.h>
30#include <AK/RefPtr.h>
31#include <AK/String.h>
32#include <Kernel/Forward.h>
33#include <Kernel/Heap/SlabAllocator.h>
34
35namespace Kernel {
36
37// FIXME: Custody needs some locking.
38
39class Custody : public RefCounted<Custody> {
40 MAKE_SLAB_ALLOCATED(Custody)
41public:
42 static NonnullRefPtr<Custody> create(Custody* parent, const StringView& name, Inode& inode, int mount_flags)
43 {
44 return adopt(*new Custody(parent, name, inode, mount_flags));
45 }
46
47 ~Custody();
48
49 Custody* parent() { return m_parent.ptr(); }
50 const Custody* parent() const { return m_parent.ptr(); }
51 Inode& inode() { return *m_inode; }
52 const Inode& inode() const { return *m_inode; }
53 const String& name() const { return m_name; }
54 String absolute_path() const;
55
56 int mount_flags() const { return m_mount_flags; }
57
58private:
59 Custody(Custody* parent, const StringView& name, Inode&, int mount_flags);
60
61 RefPtr<Custody> m_parent;
62 String m_name;
63 NonnullRefPtr<Inode> m_inode;
64 int m_mount_flags { 0 };
65};
66
67}