Skip to content

[NFC] Drop PerformJobsState as a friend class #17864

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
merged 1 commit into from
Jul 10, 2018
Merged

[NFC] Drop PerformJobsState as a friend class #17864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 30 additions & 2 deletions include/swift/Driver/Compilation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,6 @@ enum class PreserveOnSignal : bool {
};

class Compilation {
friend class PerformJobsState;

public:
/// The filelist threshold value to pass to ensure file lists are never used
static const size_t NEVER_USE_FILELIST = SIZE_MAX;
Expand Down Expand Up @@ -246,6 +244,10 @@ class Compilation {
return TheOutputInfo;
}

DiagnosticEngine &getDiags() const {
return Diags;
}

UnwrappedArrayView<const Action> getActions() const {
return llvm::makeArrayRef(Actions);
}
Expand Down Expand Up @@ -299,14 +301,24 @@ class Compilation {
ContinueBuildingAfterErrors = Value;
}

bool getShowIncrementalBuildDecisions() const {
return ShowIncrementalBuildDecisions;
}
void setShowsIncrementalBuildDecisions(bool value = true) {
ShowIncrementalBuildDecisions = value;
}

bool getShowJobLifecycle() const {
return ShowJobLifecycle;
}
void setShowJobLifecycle(bool value = true) {
ShowJobLifecycle = value;
}

bool getShowDriverTimeCompilation() const {
return ShowDriverTimeCompilation;
}

size_t getFilelistThreshold() const {
return FilelistThreshold;
}
Expand All @@ -315,6 +327,22 @@ class Compilation {
return Stats.get();
}

OutputLevel getOutputLevel() const {
return Level;
}

unsigned getBatchSeed() const {
return BatchSeed;
}

llvm::sys::TimePoint<> getLastBuildTime() const {
return LastBuildTime;
}

Optional<unsigned> getBatchCount() const {
return BatchCount;
}

/// Requests the path to a file containing all input source files. This can
/// be shared across jobs.
///
Expand Down
108 changes: 56 additions & 52 deletions lib/Driver/Compilation.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ namespace driver {
DriverTimers;

void noteBuilding(const Job *cmd, StringRef reason) {
if (!Comp.ShowIncrementalBuildDecisions)
if (!Comp.getShowIncrementalBuildDecisions())
return;
if (ScheduledCommands.count(cmd))
return;
Expand All @@ -254,15 +254,15 @@ namespace driver {
/// its inputs are in FinishedCommands.
void scheduleCommandIfNecessaryAndPossible(const Job *Cmd) {
if (ScheduledCommands.count(Cmd)) {
if (Comp.ShowJobLifecycle) {
if (Comp.getShowJobLifecycle()) {
llvm::outs() << "Already scheduled: " << LogJob(Cmd) << "\n";
}
return;
}

if (auto Blocking = findUnfinishedJob(Cmd->getInputs())) {
BlockingCommands[Blocking].push_back(Cmd);
if (Comp.ShowJobLifecycle) {
if (Comp.getShowJobLifecycle()) {
llvm::outs() << "Blocked by: " << LogJob(Blocking)
<< ", now blocking jobs: "
<< LogJobArray(BlockingCommands[Blocking]) << "\n";
Expand All @@ -283,28 +283,28 @@ namespace driver {
void addPendingJobToTaskQueue(const Job *Cmd) {
// FIXME: Failing here should not take down the whole process.
bool success =
writeFilelistIfNecessary(Cmd, *Comp.TranslatedArgs.get(), Comp.Diags);
writeFilelistIfNecessary(Cmd, Comp.getArgs(), Comp.getDiags());
assert(success && "failed to write filelist");
(void)success;

assert(Cmd->getExtraEnvironment().empty() &&
"not implemented for compilations with multiple jobs");
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Added to TaskQueue: " << LogJob(Cmd) << "\n";
TQ->addTask(Cmd->getExecutable(), Cmd->getArgumentsForTaskExecution(),
llvm::None, (void *)Cmd);
}

/// When a task finishes, check other Jobs that may be blocked.
void markFinished(const Job *Cmd, bool Skipped=false) {
if (Comp.ShowJobLifecycle) {
if (Comp.getShowJobLifecycle()) {
llvm::outs() << "Job "
<< (Skipped ? "skipped" : "finished")
<< ": " << LogJob(Cmd) << "\n";
}
FinishedCommands.insert(Cmd);
if (Comp.Stats) {
auto &D = Comp.Stats->getDriverCounters();
if (auto *Stats = Comp.getStatsReporter()) {
auto &D = Stats->getDriverCounters();
if (Skipped)
D.NumDriverJobsSkipped++;
else
Expand All @@ -313,7 +313,7 @@ namespace driver {
auto BlockedIter = BlockingCommands.find(Cmd);
if (BlockedIter != BlockingCommands.end()) {
auto AllBlocked = std::move(BlockedIter->second);
if (Comp.ShowJobLifecycle) {
if (Comp.getShowJobLifecycle()) {
llvm::outs() << "Scheduling maybe-unblocked jobs: "
<< LogJobArray(AllBlocked) << "\n";
}
Expand All @@ -333,7 +333,7 @@ namespace driver {
// TODO: properly handle task began.
const Job *BeganCmd = (const Job *)Context;

if (Comp.ShowDriverTimeCompilation) {
if (Comp.getShowDriverTimeCompilation()) {
llvm::SmallString<128> TimerName;
llvm::raw_svector_ostream OS(TimerName);
OS << LogJob(BeganCmd);
Expand All @@ -345,7 +345,7 @@ namespace driver {
DriverTimers[BeganCmd]->startTimer();
}

switch (Comp.Level) {
switch (Comp.getOutputLevel()) {
case OutputLevel::Normal:
break;
// For command line or verbose output, print out each command as it
Expand All @@ -369,10 +369,10 @@ namespace driver {
/// disable incremental logic and schedule all existing deferred commands.
void
dependencyLoadFailed(StringRef DependenciesFile, bool Warn=true) {
if (Warn && Comp.ShowIncrementalBuildDecisions)
Comp.Diags.diagnose(SourceLoc(),
diag::warn_unable_to_load_dependencies,
DependenciesFile);
if (Warn && Comp.getShowIncrementalBuildDecisions())
Comp.getDiags().diagnose(SourceLoc(),
diag::warn_unable_to_load_dependencies,
DependenciesFile);
Comp.disableIncrementalBuild();
for (const Job *Cmd : DeferredCommands)
scheduleCommandIfNecessaryAndPossible(Cmd);
Expand Down Expand Up @@ -497,11 +497,11 @@ namespace driver {
TaskFinishedResponse
unpackAndFinishBatch(int ReturnCode, StringRef Output,
StringRef Errors, const BatchJob *B) {
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Batch job finished: " << LogJob(B) << "\n";
auto res = TaskFinishedResponse::ContinueExecution;
for (const Job *J : B->getCombinedJobs()) {
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << " ==> Unpacked batch constituent finished: "
<< LogJob(J) << "\n";
auto r = taskFinished(
Expand Down Expand Up @@ -546,11 +546,11 @@ namespace driver {

if (Pid != llvm::sys::ProcessInfo::InvalidPid) {

if (Comp.ShowDriverTimeCompilation) {
if (Comp.getShowDriverTimeCompilation()) {
DriverTimers[FinishedCmd]->stopTimer();
}

switch (Comp.Level) {
switch (Comp.getOutputLevel()) {
case OutputLevel::PrintJobs:
// Only print the jobs, not the outputs
break;
Expand Down Expand Up @@ -592,17 +592,18 @@ namespace driver {

if (!isa<CompileJobAction>(FinishedCmd->getSource()) ||
ReturnCode != EXIT_FAILURE) {
Comp.Diags.diagnose(SourceLoc(), diag::error_command_failed,
FinishedCmd->getSource().getClassName(),
ReturnCode);
Comp.getDiags().diagnose(SourceLoc(), diag::error_command_failed,
FinishedCmd->getSource().getClassName(),
ReturnCode);
}

// See how ContinueBuildingAfterErrors gets set up in Driver.cpp for
// more info.
assert((Comp.ContinueBuildingAfterErrors || !Comp.EnableBatchMode) &&
assert((Comp.getContinueBuildingAfterErrors() ||
!Comp.getBatchModeEnabled()) &&
"batch mode diagnostics require ContinueBuildingAfterErrors");

return Comp.ContinueBuildingAfterErrors ?
return Comp.getContinueBuildingAfterErrors() ?
TaskFinishedResponse::ContinueExecution :
TaskFinishedResponse::StopExecution;
}
Expand All @@ -626,11 +627,11 @@ namespace driver {
TaskProcessInformation ProcInfo) {
const Job *SignalledCmd = (const Job *)Context;

if (Comp.ShowDriverTimeCompilation) {
if (Comp.getShowDriverTimeCompilation()) {
DriverTimers[SignalledCmd]->stopTimer();
}

if (Comp.Level == OutputLevel::Parseable) {
if (Comp.getOutputLevel() == OutputLevel::Parseable) {
// Parseable output was requested.
SignalledCmd->forEachContainedJobAndPID(Pid, [&](const Job *J,
Job::PID P) {
Expand All @@ -644,17 +645,19 @@ namespace driver {
llvm::errs() << Output;
}
if (!ErrorMsg.empty())
Comp.Diags.diagnose(SourceLoc(), diag::error_unable_to_execute_command,
ErrorMsg);
Comp.getDiags().diagnose(SourceLoc(),
diag::error_unable_to_execute_command,
ErrorMsg);

if (Signal.hasValue()) {
Comp.Diags.diagnose(SourceLoc(), diag::error_command_signalled,
SignalledCmd->getSource().getClassName(),
Signal.getValue());
Comp.getDiags().diagnose(SourceLoc(), diag::error_command_signalled,
SignalledCmd->getSource().getClassName(),
Signal.getValue());
} else {
Comp.Diags.diagnose(SourceLoc(),
diag::error_command_signalled_without_signal_number,
SignalledCmd->getSource().getClassName());
Comp.getDiags()
.diagnose(SourceLoc(),
diag::error_command_signalled_without_signal_number,
SignalledCmd->getSource().getClassName());
}

// Since the task signalled, unconditionally set result to -2.
Expand All @@ -666,9 +669,9 @@ namespace driver {

public:
PerformJobsState(Compilation &Comp, std::unique_ptr<TaskQueue> &&TaskQueue)
: Comp(Comp), ActualIncrementalTracer(Comp.Stats.get()),
: Comp(Comp), ActualIncrementalTracer(Comp.getStatsReporter()),
TQ(std::move(TaskQueue)) {
if (Comp.ShowIncrementalBuildDecisions || Comp.Stats)
if (Comp.getShowIncrementalBuildDecisions() || Comp.getStatsReporter())
IncrementalTracer = &ActualIncrementalTracer;
}

Expand Down Expand Up @@ -747,7 +750,7 @@ namespace driver {
for (StringRef dependency : DepGraph.getExternalDependencies()) {
llvm::sys::fs::file_status depStatus;
if (!llvm::sys::fs::status(dependency, depStatus))
if (depStatus.getLastModificationTime() < Comp.LastBuildTime)
if (depStatus.getLastModificationTime() < Comp.getLastBuildTime())
continue;

// If the dependency has been modified since the oldest built file,
Expand Down Expand Up @@ -775,7 +778,7 @@ namespace driver {
template <typename Container>
void transferJobsToTaskQueue(Container &Cmds, StringRef Kind) {
for (const Job *Cmd : Cmds) {
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Adding " << Kind
<< " job to task queue: "
<< LogJob(Cmd) << "\n";
Expand All @@ -791,11 +794,11 @@ namespace driver {
CommandSetVector &NonBatchable) {
for (const Job *Cmd : PendingExecution) {
if (Comp.getToolChain().jobIsBatchable(Comp, Cmd)) {
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Batchable: " << LogJob(Cmd) << "\n";
Batchable.insert(Cmd);
} else {
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Not batchable: " << LogJob(Cmd) << "\n";
NonBatchable.insert(Cmd);
}
Expand All @@ -810,7 +813,7 @@ namespace driver {
std::vector<const Job *> const &Batch) {
if (Batch.empty())
return;
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Forming batch job from "
<< Batch.size() << " constituents\n";
auto const &TC = Comp.getToolChain();
Expand Down Expand Up @@ -838,8 +841,8 @@ namespace driver {
size_t FillCount = TargetSize + ((P < Remainder) ? 1 : 0);
std::fill_n(std::back_inserter(PartitionIndex), FillCount, P);
}
if (Comp.BatchSeed != 0) {
std::minstd_rand gen(Comp.BatchSeed);
if (Comp.getBatchSeed() != 0) {
std::minstd_rand gen(Comp.getBatchSeed());
std::shuffle(PartitionIndex.begin(), PartitionIndex.end(), gen);
}
assert(PartitionIndex.size() == NumJobs);
Expand All @@ -851,7 +854,7 @@ namespace driver {
/// nonzero value, pseudo-randomly (but determinstically and nearly-evenly).
void partitionIntoBatches(std::vector<const Job *> Batchable,
BatchPartition &Partition) {
if (Comp.ShowJobLifecycle) {
if (Comp.getShowJobLifecycle()) {
llvm::outs() << "Found " << Batchable.size() << " batchable jobs\n";
llvm::outs() << "Forming into " << Partition.size() << " batches\n";
}
Expand All @@ -865,14 +868,14 @@ namespace driver {
assert(Idx < Partition.size());
std::vector<const Job*> &P = Partition[Idx];
if (P.empty() || TC.jobsAreBatchCombinable(Comp, P[0], Cmd)) {
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Adding " << LogJob(Cmd)
<< " to batch " << Idx << '\n';
P.push_back(Cmd);
} else {
// Strange but theoretically possible that we have a batchable job
// that's not combinable with others; tack a new batch on for it.
if (Comp.ShowJobLifecycle)
if (Comp.getShowJobLifecycle())
llvm::outs() << "Adding " << LogJob(Cmd)
<< " to new batch " << Partition.size() << '\n';
Partition.push_back(std::vector<const Job*>());
Expand Down Expand Up @@ -930,8 +933,8 @@ namespace driver {
return;
}

size_t NumPartitions = (Comp.BatchCount.hasValue() ?
Comp.BatchCount.getValue() :
size_t NumPartitions = (Comp.getBatchCount().hasValue() ?
Comp.getBatchCount().getValue() :
TQ->getNumberOfParallelTasks());
CommandSetVector Batchable, NonBatchable;
std::vector<const Job *> Batches;
Expand Down Expand Up @@ -984,8 +987,9 @@ namespace driver {
// exit / signal (or else a poll failed); unfortunately the task
// causing it was dropped on the floor and we have no way to recover
// it here, so we report a very poor, generic error.
Comp.Diags.diagnose(SourceLoc(), diag::error_unable_to_execute_command,
"<unknown>");
Comp.getDiags().diagnose(SourceLoc(),
diag::error_unable_to_execute_command,
"<unknown>");
Result = -2;
AnyAbnormalExit = true;
return;
Expand All @@ -1008,7 +1012,7 @@ namespace driver {
// If we got here, all the queued and pending work we know about is
// done; mark anything still in deferred state as skipped.
for (const Job *Cmd : DeferredCommands) {
if (Comp.Level == OutputLevel::Parseable) {
if (Comp.getOutputLevel() == OutputLevel::Parseable) {
// Provide output indicating this command was skipped if parseable
// output was requested.
parseable_output::emitSkippedMessage(llvm::errs(), *Cmd);
Expand Down Expand Up @@ -1104,7 +1108,7 @@ namespace driver {

int getResult() {
if (Result == 0)
Result = Comp.Diags.hadAnyError();
Result = Comp.getDiags().hadAnyError();
return Result;
}

Expand Down