system/ulib/hypervisor/include/hypervisor/guest.h

// Copyright 2017 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.

#pragma once

#include <zircon/types.h>

__BEGIN_CDECLS

typedef struct e820entry {
    uint64_t addr;
    uint64_t size;
    uint32_t type;
} __PACKED e820entry_t;

/**
 * Create an identity-mapped page table.
 *
 * @param addr The mapped address of guest physical memory.
 * @param size The size of guest physical memory.
 * @param end_off The offset to the end of the page table.
 */
zx_status_t guest_create_page_table(uintptr_t addr, size_t size, uintptr_t* end_off);

/**
 * Return the size in bytes of e820 memory map.
 *
 * @param size The size of guest physical memory.
 */
size_t guest_e820_size(size_t size);

/**
 * Create an e820 memory map.
 *
 * @param addr The mapped address of guest physical memory.
 * @param size The size of guest physical memory.
 * @param e820_off The offset to the e820 memory map.
 */
zx_status_t guest_create_e820(uintptr_t addr, size_t size, uintptr_t e820_off);

/**
 * Get a hypervisor resource to create a guest.
 */
zx_status_t guest_get_resource(zx_handle_t* resource);

__END_CDECLS