Skip to content

feat: Parallel zip fetch from object store #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maksym-lepekh merged 2 commits into from
Mar 12, 2026
Merged

feat: Parallel zip fetch from object store #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
560d511
feat: ObjectStorageProvider: add write back support (#1677)
maksym-lepekh Mar 5, 2026
a111a8b
feat: Parallel zip fetch from object store
maksym-lepekh Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 73 additions & 15 deletions src/vcpkg/binarycaching.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,18 @@ namespace
Path files_archive_parent_path(const std::string& abi) { return Path(abi.substr(0, 2)); }
Path files_archive_subpath(const std::string& abi) { return files_archive_parent_path(abi) / (abi + ".zip"); }

StringView try_extract_abi_from_zip_file(const Path& zip_file)
{
StringView file_stem = zip_file.stem();
auto reverse_it =
std::find_if(file_stem.rbegin(), file_stem.rend(), [](char ch) { return !std::isxdigit(ch); });
if (reverse_it != file_stem.rend() && (*reverse_it) == '_')
{
return {reverse_it.base(), file_stem.end()};
}
return {};
}

struct FilesWriteBinaryProvider : IWriteBinaryProvider
{
FilesWriteBinaryProvider(std::vector<Path>&& dirs) : m_dirs(std::move(dirs)) { }
Expand Down Expand Up @@ -326,7 +338,7 @@ namespace
// - IReadBinaryProvider::precheck()
struct ZipReadBinaryProvider : IReadBinaryProvider
{
ZipReadBinaryProvider(const ZipTool& zip) : m_zip(zip) { }
ZipReadBinaryProvider(const ZipTool& zip, Optional<Path> local_cache_folder = {}) : m_zip(zip), m_local_cache_folder(local_cache_folder) { }

struct UnzipJob
{
Expand Down Expand Up @@ -383,12 +395,27 @@ namespace
DiagKind::Note, job.zip_resource->path, msg::format(msgWhileExtractingThisArchive)});
}
}
});

if (job.zip_resource->to_remove == RemoveWhen::always)
for (auto&& job : jobs)
{
const auto zip_resource = job.zip_resource;

if (job.success)
{
fs.remove(job.zip_resource->path, IgnoreErrors{});
if (auto new_path = try_write_back_zip_file(context, zip_resource->path, fs))
{
Debug::print("Copied ", zip_resource->path, " to ", *(new_path.get()), "\n");
continue;
}
}
});

if (zip_resource->to_remove == RemoveWhen::always)
{
fs.remove(zip_resource->path, IgnoreErrors{});
Debug::print("Removed ", zip_resource->path, '\n');
}
}

for (auto&& job : jobs)
{
Expand All @@ -403,6 +430,31 @@ namespace
}
}

[[nodiscard]] Optional<Path> try_write_back_zip_file(DiagnosticContext& context, const Path& zip_file, const Filesystem& fs) const
{
if (!m_local_cache_folder)
{
return {};
}

const StringView abi = try_extract_abi_from_zip_file(zip_file);
if (abi.empty())
{
return {};
}

const Path& local_cache_folder = *m_local_cache_folder.get();
Path new_path = local_cache_folder / files_archive_subpath(std::string(abi));
if (fs.exists(new_path, IgnoreErrors{}))
{
return {};
}

fs.create_directories(context, new_path.parent_path());
fs.copy_file(context, zip_file, new_path, CopyOptions::overwrite_existing);
return new_path;
}

// For every action denoted by actions, at corresponding indicies in out_zips, stores a ZipResource indicating
// the downloaded location.
//
Expand All @@ -416,6 +468,7 @@ namespace

protected:
ZipTool m_zip;
Optional<Path> m_local_cache_folder;
};

struct FilesReadBinaryProvider : ZipReadBinaryProvider
Expand Down Expand Up @@ -1014,8 +1067,9 @@ namespace
ObjectStorageProvider(const ZipTool& zip,
const Path& buildtrees,
std::string&& prefix,
const std::shared_ptr<const IObjectStorageTool>& tool)
: ZipReadBinaryProvider(zip), m_buildtrees(buildtrees), m_prefix(std::move(prefix)), m_tool(tool)
const std::shared_ptr<const IObjectStorageTool>& tool,
Optional<Path> local_cache_folder)
: ZipReadBinaryProvider(zip, std::move(local_cache_folder)), m_buildtrees(buildtrees), m_prefix(std::move(prefix)), m_tool(tool)
{
}

Expand All @@ -1029,8 +1083,7 @@ namespace
View<const InstallPlanAction*> actions,
Span<Optional<ZipResource>> out_zip_paths) const override
{
for (size_t idx = 0; idx < actions.size(); ++idx)
{
execute_in_parallel(actions.size(), [&](size_t idx) {
auto&& action = *actions[idx];
const auto& abi = action.package_abi_or_exit(VCPKG_LINE_INFO);
auto tmp = make_temp_archive_path(m_buildtrees, action.spec, abi);
Expand All @@ -1043,16 +1096,15 @@ namespace
out_zip_paths[idx].emplace(std::move(tmp), RemoveWhen::always);
}
}
}
});
}

void precheck(DiagnosticContext& context,
const Filesystem&,
View<const InstallPlanAction*> actions,
Span<CacheAvailability> cache_status) const override
{
for (size_t idx = 0; idx < actions.size(); ++idx)
{
execute_in_parallel(actions.size(), [&](size_t idx) {
auto&& action = *actions[idx];
const auto& abi = action.package_abi_or_exit(VCPKG_LINE_INFO);
WarningDiagnosticContext wdc{context};
Expand All @@ -1065,7 +1117,7 @@ namespace
{
cache_status[idx] = CacheAvailability::unavailable;
}
}
});
}

LocalizedString restored_message(size_t count,
Expand Down Expand Up @@ -2763,22 +2815,28 @@ namespace vcpkg
std::make_unique<HttpGetBinaryProvider>(zip_tool, buildtrees, std::move(url), s.secrets));
}

Optional<Path> local_cache_folder;
if (!s.archives_to_write.empty())
{
local_cache_folder = s.archives_to_write.front();
}

for (auto&& prefix : s.gcs_read_prefixes)
{
m_config.read.push_back(
std::make_unique<ObjectStorageProvider>(zip_tool, buildtrees, std::move(prefix), gcs_tool));
std::make_unique<ObjectStorageProvider>(zip_tool, buildtrees, std::move(prefix), gcs_tool, local_cache_folder));
}

for (auto&& prefix : s.aws_read_prefixes)
{
m_config.read.push_back(
std::make_unique<ObjectStorageProvider>(zip_tool, buildtrees, std::move(prefix), aws_tool));
std::make_unique<ObjectStorageProvider>(zip_tool, buildtrees, std::move(prefix), aws_tool, local_cache_folder));
}

for (auto&& prefix : s.cos_read_prefixes)
{
m_config.read.push_back(
std::make_unique<ObjectStorageProvider>(zip_tool, buildtrees, std::move(prefix), cos_tool));
std::make_unique<ObjectStorageProvider>(zip_tool, buildtrees, std::move(prefix), cos_tool, local_cache_folder));
}

if (!s.upkg_templates_to_get.empty())
Expand Down