android/android-emu/android/snapshot/Loader.h

// Copyright 2017 The Android Open Source Project
//
// This software is licensed under the terms of the GNU General Public
// License version 2, as published by the Free Software Foundation, and
// may be copied, distributed, and modified under those terms.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

#pragma once

#include "android/base/Compiler.h"
#include "android/base/Optional.h"
#include "android/base/system/System.h"
#include "android/snapshot/common.h"
#include "android/snapshot/RamLoader.h"
#include "android/snapshot/Snapshot.h"

namespace android {
namespace snapshot {

class Loader {
    DISALLOW_COPY_AND_ASSIGN(Loader);

public:
    Loader(const Snapshot& snapshot, int error = 0);
    ~Loader();

    void interrupt();

    bool hasRamLoader() const { return mRamLoader; }
    RamLoader& ramLoader() { return *mRamLoader; }
    ITextureLoaderPtr textureLoader() const;

    OperationStatus status() const { return mStatus; }
    const Snapshot& snapshot() const { return mSnapshot; }

    void prepare();
    void start();
    void reportSuccessful();
    void reportInvalid();
    void complete(bool succeeded);
    void onInvalidSnapshotLoad();

    void join();

    // synchronize() will finish all background loading operations and update
    // the gap tracker with gap info from the ram file on disk, making the
    // Loader good for doing all other operations that can happen on it.
    void synchronize(bool isOnExit);

    const base::System::MemUsage& memUsage() const { return mMemUsage; }
    bool isHDD() const { return mDiskKind.valueOr(base::System::DiskKind::Ssd) ==
                                base::System::DiskKind::Hdd; }

private:
    OperationStatus mStatus;
    Snapshot mSnapshot;
    base::Optional<RamLoader> mRamLoader;
    std::shared_ptr<TextureLoader> mTextureLoader;

    base::System::MemUsage mMemUsage;
    base::Optional<base::System::DiskKind> mDiskKind = {};
};

}  // namespace snapshot
}  // namespace android