Domain.hh

Go to the documentation of this file.

/*
 * Copyright 2021 Assured Information Security, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include <introvirt/core/arch/x86/PageDirectory.hh>
#include <introvirt/core/breakpoint/Breakpoint.hh>
#include <introvirt/core/breakpoint/SingleStep.hh>
#include <introvirt/core/breakpoint/Watchpoint.hh>
#include <introvirt/core/domain/Guest.hh>
#include <introvirt/core/event/EventCallback.hh>
#include <introvirt/core/fwd.hh>
#include <introvirt/core/memory/GuestMemoryMapping.hh>
#include <introvirt/core/memory/guest_ptr.hh>
#include <introvirt/util/compiler.hh>
 
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
namespace introvirt {
 
class Domain {
  public:
    virtual std::shared_ptr<Breakpoint> create_breakpoint(const guest_ptr<void>& address,
                                                          std::function<void(Event&)> callback) = 0;
 
    virtual std::unique_ptr<Watchpoint> create_watchpoint(const guest_ptr<void>& address,
                                                          uint64_t length, bool read, bool write,
                                                          bool execute,
                                                          std::function<void(Event&)> callback) = 0;
 
    virtual std::unique_ptr<SingleStep> single_step(Vcpu& vcpu,
                                                    std::function<void(Event&)> callback) = 0;
 
    virtual bool detect_guest() = 0;
 
    virtual Guest* guest() = 0;
 
    virtual const Guest* guest() const = 0;
 
    virtual std::string name() const = 0;
 
    virtual uint32_t id() const = 0;
 
    virtual Vcpu& vcpu(uint32_t index) = 0;
 
    virtual const Vcpu& vcpu(uint32_t index) const = 0;
 
    virtual uint32_t vcpu_count() const = 0;
 
    virtual const x86::PageDirectory& page_directory() const = 0;
 
    virtual void poll(EventCallback& callback) = 0;
 
    virtual void interrupt() = 0;
 
    virtual void pause() = 0;
 
    virtual void resume() = 0;
 
    virtual TaskFilter& task_filter() = 0;
 
    virtual SystemCallFilter& system_call_filter() = 0;
 
    virtual const SystemCallFilter& system_call_filter() const = 0;
 
    virtual const Hypervisor& hypervisor() const = 0;
 
    virtual std::shared_ptr<GuestMemoryMapping> map_pfns(const uint64_t* pfns,
                                                         size_t count) const = 0;
 
    virtual void intercept_system_calls(bool enabled) = 0;
 
    virtual void intercept_cr_writes(int cr, bool enabled) = 0;
 
    virtual void suspend_event(Event& event) = 0;
 
    virtual void suspend_event_step(Event& event) = 0;
 
    static Domain& thread_local_domain();
 
    virtual ~Domain() = default;
};
 
} // namespace introvirt