path: root/host/commands/assemble_cvd/super_image_mixer.cc

//
// Copyright (C) 2019 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.

#include "host/commands/assemble_cvd/super_image_mixer.h"

#include <sys/stat.h>

#include <algorithm>
#include <array>
#include <memory>
#include <string>
#include <unordered_set>

#include <android-base/strings.h>
#include <android-base/logging.h>

#include "common/libs/fs/shared_buf.h"
#include "common/libs/utils/archive.h"
#include "common/libs/utils/contains.h"
#include "common/libs/utils/files.h"
#include "common/libs/utils/result.h"
#include "common/libs/utils/subprocess.h"
#include "host/commands/assemble_cvd/misc_info.h"
#include "host/libs/config/config_utils.h"
#include "host/libs/config/cuttlefish_config.h"
#include "host/libs/config/fetcher_config.h"

namespace cuttlefish {
namespace {

constexpr char kMiscInfoPath[] = "META/misc_info.txt";
constexpr std::array kVendorTargetImages = {
    "IMAGES/boot.img",
    "IMAGES/dtbo.img",
    "IMAGES/init_boot.img",
    "IMAGES/odm.img",
    "IMAGES/odm_dlkm.img",
    "IMAGES/recovery.img",
    "IMAGES/system_dlkm.img",
    "IMAGES/userdata.img",
    "IMAGES/vbmeta.img",
    "IMAGES/vbmeta_system_dlkm.img",
    "IMAGES/vbmeta_vendor.img",
    "IMAGES/vbmeta_vendor_dlkm.img",
    "IMAGES/vendor.img",
    "IMAGES/vendor_dlkm.img",
    "IMAGES/vendor_kernel_boot.img",
};
constexpr std::array kVendorTargetBuildProps = {
    "ODM/build.prop",
    "ODM/etc/build.prop",
    "VENDOR/build.prop",
    "VENDOR/etc/build.prop",
};

struct TargetFiles {
  Archive vendor_zip;
  Archive system_zip;
  std::vector<std::string> vendor_contents;
  std::vector<std::string> system_contents;
};

void FindImports(Archive* archive, const std::string& build_prop_file) {
  auto contents = archive->ExtractToMemory(build_prop_file);
  auto lines = android::base::Split(contents, "\n");
  for (const auto& line : lines) {
    auto parts = android::base::Split(line, " ");
    if (parts.size() >= 2 && parts[0] == "import") {
      LOG(INFO) << build_prop_file << ": " << line;
    }
  }
}

bool IsTargetFilesImage(const std::string& filename) {
  return android::base::StartsWith(filename, "IMAGES/") &&
         android::base::EndsWith(filename, ".img");
}

bool IsTargetFilesBuildProp(const std::string& filename) {
  return android::base::EndsWith(filename, "build.prop");
}

Result<TargetFiles> GetTargetFiles(const std::string& vendor_zip_path,
                                   const std::string& system_zip_path) {
  auto result = TargetFiles{
      .vendor_zip = Archive(vendor_zip_path),
      .system_zip = Archive(system_zip_path),
  };
  result.vendor_contents = result.vendor_zip.Contents();
  result.system_contents = result.system_zip.Contents();
  CF_EXPECTF(!result.vendor_contents.empty(), "Could not open {}",
             vendor_zip_path);
  CF_EXPECTF(!result.system_contents.empty(), "Could not open {}",
             system_zip_path);
  return result;
}

Result<void> CombineMiscInfo(TargetFiles& target_files,
                             const std::string& misc_output_path) {
  CF_EXPECTF(Contains(target_files.vendor_contents, kMiscInfoPath),
             "Default target files zip does not contain {}", kMiscInfoPath);
  CF_EXPECTF(Contains(target_files.system_contents, kMiscInfoPath),
             "System target files zip does not contain {}", kMiscInfoPath);

  const MiscInfo default_misc = CF_EXPECT(
      ParseMiscInfo(target_files.vendor_zip.ExtractToMemory(kMiscInfoPath)));
  const MiscInfo system_misc = CF_EXPECT(
      ParseMiscInfo(target_files.system_zip.ExtractToMemory(kMiscInfoPath)));

  auto output_misc = default_misc;
  auto system_super_partitions = SuperPartitionComponents(system_misc);
  // Ensure specific skipped partitions end up in the misc_info.txt
  for (auto partition :
       {"odm", "odm_dlkm", "vendor", "vendor_dlkm", "system_dlkm"}) {
    if (!Contains(system_super_partitions, partition)) {
      system_super_partitions.push_back(partition);
    }
  }
  CF_EXPECT(SetSuperPartitionComponents(system_super_partitions, &output_misc),
            "Failed to update super partitions components for misc_info");

  SharedFD misc_output_file = SharedFD::Creat(misc_output_path.c_str(), 0644);
  CF_EXPECT(misc_output_file->IsOpen(), "Failed to open output misc file: "
                                            << misc_output_file->StrError());

  CF_EXPECT(WriteAll(misc_output_file, WriteMiscInfo(output_misc)) >= 0,
            "Failed to write output misc file contents: "
                << misc_output_file->StrError());
  return {};
}

Result<void> ExtractTargetFiles(TargetFiles& target_files,
                                const std::string& combined_output_path) {
  for (const auto& name : target_files.vendor_contents) {
    if (!IsTargetFilesImage(name)) {
      continue;
    } else if (!Contains(kVendorTargetImages, name)) {
      continue;
    }
    LOG(INFO) << "Writing " << name << " from vendor target";
    CF_EXPECT(
        target_files.vendor_zip.ExtractFiles({name}, combined_output_path),
        "Failed to extract " << name << " from the vendor target zip");
  }
  for (const auto& name : target_files.vendor_contents) {
    if (!IsTargetFilesBuildProp(name)) {
      continue;
    } else if (!Contains(kVendorTargetBuildProps, name)) {
      continue;
    }
    FindImports(&target_files.vendor_zip, name);
    LOG(INFO) << "Writing " << name << " from vendor target";
    CF_EXPECT(
        target_files.vendor_zip.ExtractFiles({name}, combined_output_path),
        "Failed to extract " << name << " from the vendor target zip");
  }

  for (const auto& name : target_files.system_contents) {
    if (!IsTargetFilesImage(name)) {
      continue;
    } else if (Contains(kVendorTargetImages, name)) {
      continue;
    }
    LOG(INFO) << "Writing " << name << " from system target";
    CF_EXPECT(
        target_files.system_zip.ExtractFiles({name}, combined_output_path),
        "Failed to extract " << name << " from the system target zip");
  }
  for (const auto& name : target_files.system_contents) {
    if (!IsTargetFilesBuildProp(name)) {
      continue;
    } else if (Contains(kVendorTargetBuildProps, name)) {
      continue;
    }
    FindImports(&target_files.system_zip, name);
    LOG(INFO) << "Writing " << name << " from system target";
    CF_EXPECT(
        target_files.system_zip.ExtractFiles({name}, combined_output_path),
        "Failed to extract " << name << " from the system target zip");
  }
  return {};
}

Result<void> CombineTargetZipFiles(const std::string& vendor_zip_path,
                                   const std::string& system_zip_path,
                                   const std::string& output_path) {
  CF_EXPECT(EnsureDirectoryExists(output_path));
  CF_EXPECT(EnsureDirectoryExists(output_path + "/META"));
  auto target_files =
      CF_EXPECT(GetTargetFiles(vendor_zip_path, system_zip_path));
  CF_EXPECT(ExtractTargetFiles(target_files, output_path));
  const auto misc_output_path = output_path + "/" + kMiscInfoPath;
  CF_EXPECT(CombineMiscInfo(target_files, misc_output_path));
  return {};
}

bool BuildSuperImage(const std::string& combined_target_zip,
                     const std::string& output_path) {
  std::string otatools_path = DefaultHostArtifactsPath("");
  std::string build_super_image_binary = HostBinaryPath("build_super_image");
  if (!FileExists(build_super_image_binary)) {
    LOG(ERROR) << "Could not find build_super_image";
    return false;
  }
  return Execute({
             build_super_image_binary,
             "--path=" + otatools_path,
             combined_target_zip,
             output_path,
         }) == 0;
}

std::string TargetFilesZip(const FetcherConfig& fetcher_config,
                           FileSource source) {
  for (const auto& file_iter : fetcher_config.get_cvd_files()) {
    const auto& file_path = file_iter.first;
    const auto& file_info = file_iter.second;
    if (file_info.source != source) {
      continue;
    }
    std::string expected_filename = "target_files-" + file_iter.second.build_id;
    if (file_path.find(expected_filename) != std::string::npos) {
      return file_path;
    }
  }
  return "";
}

Result<void> RebuildSuperImage(const FetcherConfig& fetcher_config,
                               const CuttlefishConfig& config,
                               const std::string& output_path) {
  auto instance = config.ForDefaultInstance();
  // In SuperImageNeedsRebuilding, it already checked both
  // has_default_target_zip and has_system_target_zip are the same.
  // Here, we only check if there is an input path
  std::string default_target_zip = instance.default_target_zip();
  std::string system_target_zip = instance.system_target_zip();
  if (default_target_zip == "" || default_target_zip == "unset") {
    default_target_zip =
        TargetFilesZip(fetcher_config, FileSource::DEFAULT_BUILD);
    CF_EXPECT(default_target_zip != "",
              "Unable to find default target zip file.");

    system_target_zip =
        TargetFilesZip(fetcher_config, FileSource::SYSTEM_BUILD);
    CF_EXPECT(system_target_zip != "", "Unable to find system target zip file.");
  }

  // TODO(schuffelen): Use cuttlefish_assembly
  std::string combined_target_path = instance.PerInstanceInternalPath("target_combined");
  // TODO(schuffelen): Use otatools/bin/merge_target_files
  CF_EXPECT(CombineTargetZipFiles(default_target_zip, system_target_zip,
                                  combined_target_path),
            "Could not combine target zip files.");

  CF_EXPECT(BuildSuperImage(combined_target_path, output_path),
            "Could not write the final output super image.");
  return {};
}

class SuperImageRebuilderImpl : public SuperImageRebuilder {
 public:
  INJECT(SuperImageRebuilderImpl(
      const FetcherConfig& fetcher_config, const CuttlefishConfig& config,
      const CuttlefishConfig::InstanceSpecific& instance))
      : fetcher_config_(fetcher_config), config_(config), instance_(instance) {}

  std::string Name() const override { return "SuperImageRebuilderImpl"; }
  bool Enabled() const override { return true; }

 private:
  std::unordered_set<SetupFeature*> Dependencies() const override { return {}; }
  Result<void> ResultSetup() override {
    if (CF_EXPECT(SuperImageNeedsRebuilding(fetcher_config_,
                                            instance_.default_target_zip(),
                                            instance_.system_target_zip()))) {
      CF_EXPECT(RebuildSuperImage(fetcher_config_, config_,
                                  instance_.new_super_image()));
    }
    return {};
  }

  const FetcherConfig& fetcher_config_;
  const CuttlefishConfig& config_;
  const CuttlefishConfig::InstanceSpecific& instance_;
};

}  // namespace

Result<bool> SuperImageNeedsRebuilding(const FetcherConfig& fetcher_config,
                                       const std::string& default_target_zip,
                                       const std::string& system_target_zip) {
  bool has_default_target_zip = false;
  bool has_system_target_zip = false;
  if (default_target_zip != "" && default_target_zip != "unset") {
    has_default_target_zip = true;
  }
  if (system_target_zip != "" && system_target_zip != "unset") {
    has_system_target_zip = true;
  }
  CF_EXPECT(has_default_target_zip == has_system_target_zip,
            "default_target_zip and system_target_zip "
            "flags must be specified together");
  // at this time, both should be the same, either true or false
  // therefore, I only check one variable
  if (has_default_target_zip) {
    return true;
  }

  bool has_default_build = false;
  bool has_system_build = false;
  for (const auto& file_iter : fetcher_config.get_cvd_files()) {
    if (file_iter.second.source == FileSource::DEFAULT_BUILD) {
      has_default_build = true;
    } else if (file_iter.second.source == FileSource::SYSTEM_BUILD) {
      has_system_build = true;
    }
  }
  return has_default_build && has_system_build;
}

fruit::Component<fruit::Required<const FetcherConfig, const CuttlefishConfig,
                                 const CuttlefishConfig::InstanceSpecific>,
                 SuperImageRebuilder>
SuperImageRebuilderComponent() {
  return fruit::createComponent()
      .bind<SuperImageRebuilder, SuperImageRebuilderImpl>()
      .addMultibinding<SetupFeature, SuperImageRebuilder>();
}

}  // namespace cuttlefish