kernel/object/include/object/vm_address_region_dispatcher.h

// Copyright 2016 The Fuchsia Authors
//
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT

#pragma once

#include <zircon/types.h>
#include <fbl/canary.h>
#include <object/dispatcher.h>

#include <sys/types.h>

class VmAddressRegion;
class VmMapping;
class VmObject;

class VmAddressRegionDispatcher final : public Dispatcher {
public:
    static zx_status_t Create(fbl::RefPtr<VmAddressRegion> vmar,
                              fbl::RefPtr<Dispatcher>* dispatcher,
                              zx_rights_t* rights);

    ~VmAddressRegionDispatcher() final;
    zx_obj_type_t get_type() const final { return ZX_OBJ_TYPE_VMAR; }

    // TODO(teisenbe): Make this the planned batch interface
    zx_status_t Allocate(size_t offset, size_t size, uint32_t flags,
                         fbl::RefPtr<VmAddressRegionDispatcher>* dispatcher,
                         zx_rights_t* rights);

    zx_status_t Destroy();

    zx_status_t Map(size_t vmar_offset,
                    fbl::RefPtr<VmObject> vmo, uint64_t vmo_offset, size_t len,
                    uint32_t flags, fbl::RefPtr<VmMapping>* out);

    zx_status_t Protect(vaddr_t base, size_t len, uint32_t flags);

    zx_status_t Unmap(vaddr_t base, size_t len);

    fbl::RefPtr<VmAddressRegion> vmar() const { return vmar_; }

    // Check if the given flags define an allowed combination of RWX
    // protections.
    static bool is_valid_mapping_protection(uint32_t flags);

private:
    explicit VmAddressRegionDispatcher(fbl::RefPtr<VmAddressRegion> vmar);

    fbl::Canary<fbl::magic("VARD")> canary_;
    fbl::RefPtr<VmAddressRegion> vmar_;
};