blob: 7749e1f59014e6595517e5f70a98b15a988a87cf [file] [log] [blame]
// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <lib/fdio/fdio.h>
#include <lib/fdio/namespace.h>
#include <lib/zx/channel.h>
#include <lib/zxio/zxio.h>
#include <fbl/macros.h>
#include <fbl/mutex.h>
#include <fbl/ref_counted.h>
#include <fbl/ref_ptr.h>
#include "sdk/lib/fdio/namespace/local-vnode.h"
struct fdio;
namespace fdio_internal {
struct DirentIteratorState;
// A local filesystem consisting of LocalVnodes, mapping string names
// to remote handles.
// This class is thread-safe.
struct fdio_namespace : public fbl::RefCounted<fdio_namespace> {
using LocalVnode = fdio_internal::LocalVnode;
using DirentIteratorState = fdio_internal::DirentIteratorState;
static fbl::RefPtr<fdio_namespace> Create() { return fbl::AdoptRef(new fdio_namespace()); }
// Create a new object referring to the root of this namespace.
// Returns |nullptr| on failure.
zx::result<fbl::RefPtr<fdio>> OpenRoot() const;
// Change the root of this namespace to match |io|.
// Does not take ownership of |io|.
zx_status_t SetRoot(fdio_t* io);
// Export all remote references and their paths in a flat format.
zx_status_t Export(fdio_flat_namespace_t** out) const;
// Reads a single entry from the list of directory entries into |inout_entry|.
// If we have reached the end, ZX_ERR_NOT_FOUND is returned.
zx_status_t Readdir(const LocalVnode& vn, DirentIteratorState* state,
zxio_dirent_t* inout_entry) const;
// Create a new object referring to the object at |path|.
// This object may represent either a local node, or a remote object.
zx::result<fbl::RefPtr<fdio>> Open(fbl::RefPtr<LocalVnode> vn, std::string_view path,
fuchsia_io::wire::OpenFlags flags) const;
// Connect to a remote object within the namespace.
// Returns an error if |path| does not exist.
// Returns an error if |path| references a non-remote object.
zx_status_t Connect(std::string_view path, fuchsia_io::wire::OpenFlags flags,
fidl::ServerEnd<fuchsia_io::Node> server_end) const;
// Attaches a local node defined by |on_open| to |path| within the current namespace.
zx_status_t Bind(std::string_view path, fdio_open_local_func_t on_open, void* context);
// Attaches |remote| to |path| within the current namespace.
zx_status_t Bind(std::string_view path, fidl::ClientEnd<fuchsia_io::Directory> remote);
// Detaches a remote object from |path| within the current namespace.
// Returns ZX_ERR_NOT_FOUND if |path| does not correspond with a bound remote.
// Returns ZX_ERR_NOT_SUPPORTED if |path| is the root of the namespace.
// Returns ZX_ERR_INVALID_ARGS for an unsupported |path|.
zx_status_t Unbind(std::string_view path);
bool IsBound(std::string_view path);
void ResetRoot() __TA_REQUIRES(lock_);
// Creates a local object with a connection to a vnode.
// This object will increase the number of references to the namespace by
// one.
zx::result<fbl::RefPtr<fdio>> CreateConnection(fbl::RefPtr<LocalVnode> vn) const;
// Lookup repeatedly to traverse vnodes within the local filesystem.
// |in_out_vn| and |in_out_path| are input and output parameters.
zx_status_t WalkLocked(fbl::RefPtr<LocalVnode>* in_out_vn, std::string_view* in_out_path) const
// Attaches the node generated by |builder| to |path| within the current namespace.
zx_status_t Bind(
std::string_view path,
fit::function<zx::result<fbl::RefPtr<LocalVnode>>(fbl::RefPtr<LocalVnode>, fbl::String name)>
mutable fbl::Mutex lock_;
fbl::RefPtr<LocalVnode> root_ __TA_GUARDED(lock_);