From dfcab1c3f09971cba6a198ba81158d1190975165 Mon Sep 17 00:00:00 2001
From: eldritch horrors <pennae@lix.systems>
Date: Fri, 26 Jul 2024 19:24:38 +0200
Subject: libstore: return finishedness from Goal methods

this is the first step towards removing all result-related mutation of
Goal state from goal implementations themselves, and into Worker state
instead. once that is done we can treat all non-const Goal fields like
private state of the goal itself, and make threading of goals possible

Change-Id: I69ff7d02a6fd91a65887c6640bfc4f5fb785b45c
---
 src/libstore/build/drv-output-substitution-goal.cc | 50 +++++++++++-----------
 1 file changed, 25 insertions(+), 25 deletions(-)

(limited to 'src/libstore/build/drv-output-substitution-goal.cc')

diff --git a/src/libstore/build/drv-output-substitution-goal.cc b/src/libstore/build/drv-output-substitution-goal.cc
index 94c9206a3..4d10543cd 100644
--- a/src/libstore/build/drv-output-substitution-goal.cc
+++ b/src/libstore/build/drv-output-substitution-goal.cc
@@ -20,21 +20,20 @@ DrvOutputSubstitutionGoal::DrvOutputSubstitutionGoal(
 }
 
 
-void DrvOutputSubstitutionGoal::init()
+Goal::WorkResult DrvOutputSubstitutionGoal::init()
 {
     trace("init");
 
     /* If the derivation already exists, we’re done */
     if (worker.store.queryRealisation(id)) {
-        amDone(ecSuccess);
-        return;
+        return amDone(ecSuccess);
     }
 
     subs = settings.useSubstitutes ? getDefaultSubstituters() : std::list<ref<Store>>();
-    tryNext();
+    return tryNext();
 }
 
-void DrvOutputSubstitutionGoal::tryNext()
+Goal::WorkResult DrvOutputSubstitutionGoal::tryNext()
 {
     trace("trying next substituter");
 
@@ -43,7 +42,7 @@ void DrvOutputSubstitutionGoal::tryNext()
        prevents infinite waiting. */
     if (worker.runningSubstitutions >= std::max(1U, settings.maxSubstitutionJobs.get())) {
         worker.waitForBuildSlot(shared_from_this());
-        return;
+        return StillAlive{};
     }
 
     maintainRunningSubstitutions =
@@ -54,16 +53,14 @@ void DrvOutputSubstitutionGoal::tryNext()
            with it. */
         debug("derivation output '%s' is required, but there is no substituter that can provide it", id.to_string());
 
-        /* Hack: don't indicate failure if there were no substituters.
-           In that case the calling derivation should just do a
-           build. */
-        amDone(substituterFailed ? ecFailed : ecNoSubstituters);
-
         if (substituterFailed) {
             worker.failedSubstitutions++;
         }
 
-        return;
+        /* Hack: don't indicate failure if there were no substituters.
+           In that case the calling derivation should just do a
+           build. */
+        return amDone(substituterFailed ? ecFailed : ecNoSubstituters);
     }
 
     sub = subs.front();
@@ -85,9 +82,10 @@ void DrvOutputSubstitutionGoal::tryNext()
     worker.childStarted(shared_from_this(), {downloadState->outPipe.readSide.get()}, true, false);
 
     state = &DrvOutputSubstitutionGoal::realisationFetched;
+    return StillAlive{};
 }
 
-void DrvOutputSubstitutionGoal::realisationFetched()
+Goal::WorkResult DrvOutputSubstitutionGoal::realisationFetched()
 {
     worker.childTerminated(this);
     maintainRunningSubstitutions.reset();
@@ -116,8 +114,7 @@ void DrvOutputSubstitutionGoal::realisationFetched()
                     worker.store.printStorePath(localOutputInfo->outPath),
                     worker.store.printStorePath(depPath)
                 );
-                tryNext();
-                return;
+                return tryNext();
             }
             addWaitee(worker.makeDrvOutputSubstitutionGoal(depId));
         }
@@ -125,29 +122,32 @@ void DrvOutputSubstitutionGoal::realisationFetched()
 
     addWaitee(worker.makePathSubstitutionGoal(outputInfo->outPath));
 
-    if (waitees.empty()) outPathValid();
-    else state = &DrvOutputSubstitutionGoal::outPathValid;
+    if (waitees.empty()) {
+        return outPathValid();
+    } else {
+        state = &DrvOutputSubstitutionGoal::outPathValid;
+        return StillAlive{};
+    }
 }
 
-void DrvOutputSubstitutionGoal::outPathValid()
+Goal::WorkResult DrvOutputSubstitutionGoal::outPathValid()
 {
     assert(outputInfo);
     trace("output path substituted");
 
     if (nrFailed > 0) {
         debug("The output path of the derivation output '%s' could not be substituted", id.to_string());
-        amDone(nrNoSubstituters > 0 || nrIncompleteClosure > 0 ? ecIncompleteClosure : ecFailed);
-        return;
+        return amDone(nrNoSubstituters > 0 || nrIncompleteClosure > 0 ? ecIncompleteClosure : ecFailed);
     }
 
     worker.store.registerDrvOutput(*outputInfo);
-    finished();
+    return finished();
 }
 
-void DrvOutputSubstitutionGoal::finished()
+Goal::WorkResult DrvOutputSubstitutionGoal::finished()
 {
     trace("finished");
-    amDone(ecSuccess);
+    return amDone(ecSuccess);
 }
 
 std::string DrvOutputSubstitutionGoal::key()
@@ -157,9 +157,9 @@ std::string DrvOutputSubstitutionGoal::key()
     return "a$" + std::string(id.to_string());
 }
 
-void DrvOutputSubstitutionGoal::work()
+Goal::WorkResult DrvOutputSubstitutionGoal::work()
 {
-    (this->*state)();
+    return (this->*state)();
 }
 
 
-- 
cgit v1.2.3