Skip to content

Install files in parallel, redux #1896

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
BillyONeal merged 7 commits into from
Jan 13, 2026
Merged

Install files in parallel, redux #1896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f1e4a05
Add a CMake build preset for Win-x64-Debug-WithArtifacts
BillyONeal Jan 8, 2026
a80c8cf
Delete `bool use_hard_link` which just made more complicated control …
BillyONeal Jan 8, 2026
e30df12
Parallelize installing regular files.
BillyONeal Jan 9, 2026
c6463af
Try to make diff prettier.
BillyONeal Jan 9, 2026
1f3518c
Delete unused lambda capture.
BillyONeal Jan 9, 2026
20cc161
Merge remote-tracking branch 'origin/main' into parallel-file-install
BillyONeal Jan 12, 2026
cc84d56
Nitpicks
BillyONeal Jan 12, 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
4 changes: 4 additions & 0 deletions CMakePresets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,10 @@
{
"name": "macos-ci",
"configurePreset": "macos-ci"
},
{
"name": "Win-x64-Debug-WithArtifacts",
"configurePreset": "Win-x64-Debug-WithArtifacts"
}
],
"testPresets": [
Expand Down
141 changes: 92 additions & 49 deletions src/vcpkg/commands.install.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#include <vcpkg/base/files.h>
#include <vcpkg/base/hash.h>
#include <vcpkg/base/messages.h>
#include <vcpkg/base/parallel-algorithms.h>
#include <vcpkg/base/path.h>
#include <vcpkg/base/sortedvector.h>
#include <vcpkg/base/system.debug.h>
Expand Down Expand Up @@ -67,6 +68,9 @@ namespace
return Strings::case_insensitive_ascii_less(lhs.file_path, rhs.file_path);
}
};

static constexpr StringLiteral SYMLINK_STATUS = "symlink_status";
static constexpr StringLiteral STATUS = "status";
}

namespace vcpkg
Expand All @@ -91,46 +95,78 @@ namespace vcpkg
std::vector<std::string> listfile_lines;
listfile_lines.push_back(listfile_triplet_prefix);

std::string list_listfile_line;
for (auto&& proximate_file : proximate_files)
{
const StringView filename = parse_filename(proximate_file);
std::mutex console_mutex;
std::vector<Path> source_files(proximate_files.size());
std::vector<vcpkg::FileType> statuses(proximate_files.size());
execute_in_parallel(proximate_files.size(), [&, hydrate](size_t idx) {
const auto& proximate_file = proximate_files[idx];
const auto filename = parse_filename(proximate_file);
if (filename == FileDotDsStore)
{
// Do not copy .DS_Store files
continue;
// Do not copy .DS_Store files (leaves file_type::none)
return;
}

auto source_file = source_dir / proximate_file;
std::error_code ec;
vcpkg::FileType status;
StringView status_call_name;
const StringLiteral* status_call_name;
switch (hydrate)
{
case SymlinkHydrate::CopySymlinks:
status = fs.symlink_status(source_file, ec);
status_call_name = "symlink_status";
status_call_name = &SYMLINK_STATUS;
break;
case SymlinkHydrate::CopyData:
status = fs.status(source_file, ec);
status_call_name = "status";
status_call_name = &STATUS;
break;
default: Checks::unreachable(VCPKG_LINE_INFO);
}

if (ec)
{
msg::println_warning(format_filesystem_call_error(ec, status_call_name, {source_file}));
continue;
std::lock_guard<std::mutex> lock(console_mutex);
msg::println_warning(format_filesystem_call_error(ec, *status_call_name, {source_file}));
status = FileType::none;
}
else
{
switch (status)
{
case FileType::regular:
if (filename == FileControl || filename == FileVcpkgDotJson || filename == FileBuildInfo)
{
// Do not copy the control file or manifest file
status = FileType::none;
}
break;
case FileType::directory:
case FileType::symlink:
case FileType::junction: break;
default:
std::lock_guard<std::mutex> lock(console_mutex);
msg::println_error(msgInvalidFileType, msg::path = source_file);
status = FileType::none;
}
}

source_files[idx] = std::move(source_file);
statuses[idx] = status;
});

// At this point, each corresponding index between proximate_files, filenames, source_files, and statuses is
// either has file_type::none (skip), or is filled out
// Copy all the non-regular-files serially to avoid races with missing parent directories.
std::vector<Path> target_regular_files(proximate_files.size());
std::error_code ec;
std::string list_listfile_line;
for (std::size_t idx = 0; idx < proximate_files.size(); ++idx)
{
const auto& proximate_file = proximate_files[idx];
list_listfile_line = listfile_triplet_prefix;
list_listfile_line.append(proximate_file);

auto target = destination_triplet / proximate_file;

bool use_hard_link = true;
switch (status)
switch (statuses[idx])
{
case FileType::directory:
{
Expand All @@ -147,33 +183,19 @@ namespace vcpkg
}
case FileType::regular:
{
if (filename == FileControl || filename == FileVcpkgDotJson || filename == FileBuildInfo)
{
// Do not copy the control file or manifest file
continue;
}

target_regular_files[idx] = std::move(target);
listfile_lines.push_back(list_listfile_line);
break;
}
case FileType::symlink:
Copy link
Member Author

@BillyONeal BillyONeal Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub's diff is awful. This line should go with 185 on the 'red' side.

Copy link
Member Author

@BillyONeal BillyONeal Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obligatory cult of Beyond Compare recruitment flyer:

a better diff of this function

case FileType::junction:
{
if (fs.exists(target, IgnoreErrors{}))
{
msg::println_warning(msgOverwritingFile, msg::path = target);
fs.remove_all(target, IgnoreErrors{});
}
if (use_hard_link)
{
fs.create_hard_link(source_file, target, ec);
if (ec)
{
Debug::println("Install from packages to installed: Fallback to copy "
"instead creating hard links because of: ",
ec.message());
use_hard_link = false;
}
}
if (!use_hard_link)
{
fs.copy_file(source_file, target, CopyOptions::overwrite_existing, ec);
}

fs.copy_symlink(source_files[idx], target, ec);
if (ec)
{
msg::println_error(msgInstallFailed, msg::path = target, msg::error_msg = ec.message());
Expand All @@ -182,26 +204,47 @@ namespace vcpkg
listfile_lines.push_back(list_listfile_line);
break;
}
case FileType::symlink:
case FileType::junction:
case FileType::none: break; // skip or error case
default: Checks::unreachable(VCPKG_LINE_INFO); break;
}
}

// explicit captures to avoid capturing outer 'ec'
execute_in_parallel(
proximate_files.size(), [&statuses, &target_regular_files, &source_files, &fs, &console_mutex](size_t idx) {
if (statuses[idx] == FileType::regular)
{
const auto& target = target_regular_files[idx];
if (fs.exists(target, IgnoreErrors{}))
{
msg::println_warning(msgOverwritingFile, msg::path = target);
{
std::lock_guard<std::mutex> lock(console_mutex);
msg::println_warning(msgOverwritingFile, msg::path = target);
} // unlock

fs.remove_all(target, IgnoreErrors{});
}

fs.copy_symlink(source_file, target, ec);
std::error_code ec;
fs.create_hard_link(source_files[idx], target, ec);
if (ec)
{
msg::println_error(msgInstallFailed, msg::path = target, msg::error_msg = ec.message());
}
{
std::lock_guard<std::mutex> lock(console_mutex);
Debug::println("Install from packages to installed: Fallback to copy "
"instead creating hard links because of: ",
ec.message());
} // unlock

listfile_lines.push_back(list_listfile_line);
break;
fs.copy_file(source_files[idx], target, CopyOptions::overwrite_existing, ec);
if (ec)
{
std::lock_guard<std::mutex> lock(console_mutex);
msg::println_error(msgInstallFailed, msg::path = target, msg::error_msg = ec.message());
} // unlock
}
}
default: msg::println_error(msgInvalidFileType, msg::path = source_file); break;
}
}
});

std::sort(listfile_lines.begin(), listfile_lines.end());
fs.write_lines(listfile, listfile_lines, VCPKG_LINE_INFO);
Expand Down
Loading