cuttlefish::ImageFile Class Reference

#include <image_file.h>

Inheritance diagram for cuttlefish::ImageFile:

Public Member Functions
virtual	~ImageFile ()=default
virtual std::string	Name () const =0
virtual Result< std::string >	Generate ()=0
virtual Result< std::string >	Path () const =0

Detailed Description

An entire disk, GPT entry, or super image logical partition that ends up inside a block device inside the VM.

Image files may contain the contents of other image files, or serve as indirections to other image files.

Image files may come pre-made from an Android build, or may be generated dynamically at runtime.

Exposes the configuration of the image file as serialized data that can be used to determine whether an existing image file can be used or needs to be recreated.

Instances of this class have two states: configured but not created, and configured with a created image file. Subclasses should accept configuration at construction time, and should not expose any additional unconfigured states.

Constructor & Destructor Documentation

~ImageFile()

virtual cuttlefish::ImageFile::~ImageFile ( )

virtualdefault

Member Function Documentation

Generate()

virtual Result< std::string > cuttlefish::ImageFile::Generate ( )

pure virtual

If the image file is not ready, generate it. Returns the path to the file.

If this function succeeds, Path() should return the same value afterwards.

Implemented in cuttlefish::EfiLoaderImage, cuttlefish::InstanceBootImage, cuttlefish::MetadataImage, and cuttlefish::MiscImage.

Name()

virtual std::string cuttlefish::ImageFile::Name ( ) const

pure virtual

Image name, reused in multiple places for consistency.

• The filename (minus .img extension) used on the file system.
• GPT entry name
• Logical partition name within the super image.

Implemented in cuttlefish::EfiLoaderImage, cuttlefish::InstanceBootImage, cuttlefish::MetadataImage, and cuttlefish::MiscImage.

Path()

virtual Result< std::string > cuttlefish::ImageFile::Path ( ) const

pure virtual

Returns the path on the filesystem where the image file is.

The image file should be ready for use and correct for the current device configuration.

Implemented in cuttlefish::EfiLoaderImage, cuttlefish::InstanceBootImage, cuttlefish::MetadataImage, and cuttlefish::MiscImage.

---

The documentation for this class was generated from the following file:

• cuttlefish/host/commands/assemble_cvd/disk/image_file.h