sparse_image.h

Go to the documentation of this file.

/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * 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 <stdint.h>
 
#include <memory>
#include <string>
 
#include "cuttlefish/host/libs/image_aggregator/disk_image.h"
#include "cuttlefish/result/result.h"
 
namespace cuttlefish {
 
Result<void> ForceRawImage(const std::string& image_path);
Result<bool> IsSparseImage(const std::string& image_path);
 
class AndroidSparseImage : public DiskImage {
 public:
  static Result<AndroidSparseImage> OpenExisting(const std::string& path);
 
  AndroidSparseImage(AndroidSparseImage&&);
  ~AndroidSparseImage() override;
  AndroidSparseImage& operator=(AndroidSparseImage&&);
 
  static std::string MagicString();
 
  Result<uint64_t> VirtualSizeBytes() const override;
 
 private:
  struct Impl;
 
  AndroidSparseImage(std::unique_ptr<Impl>);
 
  std::unique_ptr<Impl> impl_;
};
 
}  // namespace cuttlefish