Merge pull request #978 from swiftlang/t/ack

[llbuild3] Add Ackermann test

Author: dmbryson

products/llbuild3/SwiftAdaptors.hpp

@@ -290,6 +290,8 @@ class EngineRef {
   LLBUILD3_EXPORT CASDatabaseRef cas();
 
   LLBUILD3_EXPORT BuildRef build(const LabelPB artifact);
+
+  LLBUILD3_EXPORT std::vector<StatPB> stats();
 };
 
 LLBUILD3_EXPORT EngineRef makeEngine(ExtEngineConfig config,

src/llbuild3/Engine.cpp

@@ -204,6 +204,25 @@ class EngineImpl: public ActionExecutorListener {
   std::condition_variable readyJobsCondition;
   bool shutdown{false};
 
+  /// Perf counters
+  std::atomic<uint64_t> st_buildCount{0};
+  std::atomic<uint64_t> st_buildCompletedCount{0};
+
+  std::atomic<uint64_t> st_artifactRequestCount{0};
+  std::atomic<uint64_t> st_ruleRequestCount{0};
+
+  std::atomic<uint64_t> st_taskCount{0};
+  std::atomic<uint64_t> st_taskTransitions{0};
+  std::atomic<uint64_t> st_taskCacheHits{0};
+  std::atomic<uint64_t> st_taskCacheMisses{0};
+  std::atomic<uint64_t> st_taskCompletedCount{0};
+
+  std::atomic<uint64_t> st_actionCount{0};
+  std::atomic<uint64_t> st_actionCompletedCount{0};
+  std::atomic<uint64_t> st_subtaskCount{0};
+  std::atomic<uint64_t> st_subtaskCompletedCount{0};
+
+
 public:
   EngineImpl(EngineConfig config, std::shared_ptr<CASDatabase> casDB,
              std::shared_ptr<ActionCache> cache,
@@ -301,6 +320,7 @@ class EngineImpl: public ActionExecutorListener {
   /// @{
 
   Build build(const Label& artifact) {
+    st_buildCount++;
     auto context = std::shared_ptr<BuildContext>(new BuildContext());
 
     uint64_t buildID = 0;
@@ -321,6 +341,7 @@ class EngineImpl: public ActionExecutorListener {
     }
 
     if (res.has_error()) {
+      st_buildCompletedCount++;
       logger->event(logctx, {
         makeStat("log.message", "build_completed"),
         makeStat("build_id", buildID),
@@ -333,6 +354,24 @@ class EngineImpl: public ActionExecutorListener {
     return Build(context);
   }
 
+  std::vector<Stat> stats() {
+    return {
+      makeStat("builds", st_buildCount),
+      makeStat("builds_completed", st_buildCompletedCount),
+      makeStat("artifact_requests", st_artifactRequestCount),
+      makeStat("rule_requests", st_ruleRequestCount),
+      makeStat("tasks", st_taskCount),
+      makeStat("task_transitions", st_taskTransitions),
+      makeStat("task_cache_hits", st_taskCacheHits),
+      makeStat("task_cache_misses", st_taskCacheMisses),
+      makeStat("tasks_completed", st_taskCompletedCount),
+      makeStat("actions", st_actionCount),
+      makeStat("actions_completed", st_actionCompletedCount),
+      makeStat("subtasks", st_subtaskCount),
+      makeStat("subtasks_completed", st_subtaskCompletedCount)
+    };
+  }
+
   /// @}
 
   /// @name Task Management Client APIs
@@ -344,6 +383,7 @@ class EngineImpl: public ActionExecutorListener {
 
   result<uint64_t, Error> taskRequestArtifact(uint64_t taskID,
                                               const Label& label) {
+    st_artifactRequestCount++;
     // FIXME: concretize label with context?
 
     uint64_t buildID = 0;
@@ -444,6 +484,7 @@ class EngineImpl: public ActionExecutorListener {
   }
 
   result<uint64_t, Error> taskRequestRule(uint64_t taskID, const Label& label) {
+    st_ruleRequestCount++;
     // FIXME: concretize label with context?
 
     uint64_t buildID = 0;
@@ -539,6 +580,8 @@ class EngineImpl: public ActionExecutorListener {
   }
 
   result<uint64_t, Error> taskRequestAction(uint64_t taskID, const Action& action) {
+    st_actionCount++;
+
     uint64_t buildID = 0;
     uint64_t workID = 0;
 
@@ -561,6 +604,7 @@ class EngineImpl: public ActionExecutorListener {
     if (res.has_error()) {
       std::lock_guard<std::mutex> lock(taskInfosMutex);
       actionTaskMap.erase(workID);
+      st_actionCompletedCount++;
       return fail(res.error());
     }
 
@@ -575,6 +619,8 @@ class EngineImpl: public ActionExecutorListener {
   }
 
   result<uint64_t, Error> taskSpawnSubtask(uint64_t taskID, const Subtask& subtask) {
+    st_subtaskCount++;
+
     uint64_t buildID = 0;
     uint64_t workID = 0;
     uint64_t sid = 0;
@@ -599,6 +645,7 @@ class EngineImpl: public ActionExecutorListener {
     if (res.has_error()) {
       std::lock_guard<std::mutex> lock(taskInfosMutex);
       subtaskTaskMap.erase(workID);
+      st_subtaskCompletedCount++;
       return fail(res.error());
     }
 
@@ -635,6 +682,8 @@ class EngineImpl: public ActionExecutorListener {
       return;
     }
 
+    st_actionCompletedCount++;
+
     auto taskID = entry->second;
     auto& rtask = taskInfos.at(taskID);
     rtask.pendingActions.at(cid.workID).result = {std::move(result)};
@@ -658,6 +707,8 @@ class EngineImpl: public ActionExecutorListener {
       return;
     }
 
+    st_subtaskCompletedCount++;
+
     auto taskID = entry->second;
     auto& rtask = taskInfos.at(taskID);
     rtask.pendingSubtasks.at(cid.workID) = std::move(result);
@@ -797,6 +848,7 @@ class EngineImpl: public ActionExecutorListener {
     }
 
     // Insert the task
+    st_taskCount++;
     auto taskID = nextTaskID++;
     auto insertion = taskInfos.try_emplace(taskID, taskID, std::move(task));
     auto& taskInfo = (insertion.first)->second;
@@ -860,12 +912,14 @@ class EngineImpl: public ActionExecutorListener {
       actionCache->get(cacheKey, [this, ctx, inputs, sres, &taskInfo](result<CacheValue, Error> res) {
         if (res.has_error()) {
           logger->error(logctx, res.error());
+          st_taskCacheMisses++;
           enqueueReadyTask(taskInfo, ctx, inputs, sres);
           return;
         }
 
         if (!res->has_data()) {
           // not found
+          st_taskCacheMisses++;
           enqueueReadyTask(taskInfo, ctx, inputs, sres);
           return;
         }
@@ -874,6 +928,7 @@ class EngineImpl: public ActionExecutorListener {
         casDB->get(res->data(), [this, ctx, inputs, sres, &taskInfo](result<CASObject, Error> res) {
           if (res.has_error()) {
             logger->error(logctx, res.error());
+            st_taskCacheMisses++;
             enqueueReadyTask(taskInfo, ctx, inputs, sres);
             return;
           }
@@ -884,6 +939,7 @@ class EngineImpl: public ActionExecutorListener {
               makeEngineError(EngineError::InternalProtobufSerialization,
                               "failed to parse cached task transition")
             );
+            st_taskCacheMisses++;
             enqueueReadyTask(taskInfo, ctx, inputs, sres);
             return;
           }
@@ -920,11 +976,13 @@ class EngineImpl: public ActionExecutorListener {
 
             if (res.has_error()) {
               logger->error(logctx, res.error());
+              st_taskCacheMisses++;
               enqueueReadyTask(taskInfo, ctx, inputs, sres);
               return;
             }
           }
 
+          st_taskCacheHits++;
           processTaskNextState(taskInfo, value.state());
         });
       });
@@ -1012,6 +1070,7 @@ class EngineImpl: public ActionExecutorListener {
   }
 
   void processTaskNextState(TaskInfo& taskInfo, const TaskNextState& next) {
+    st_taskTransitions++;
     std::lock_guard<std::mutex> lock(taskInfosMutex);
 
     switch (next.StateValue_case()) {
@@ -1091,6 +1150,8 @@ class EngineImpl: public ActionExecutorListener {
   }
 
   void processFinishedTask(TaskInfo& taskInfo) {
+    st_taskCompletedCount++;
+    
     // update all tasks waiting on this task
     auto work = [this, &taskInfo](const JobContext&) {
       std::lock_guard<std::mutex> lock(taskInfosMutex);
@@ -1428,6 +1489,7 @@ class EngineImpl: public ActionExecutorListener {
 
 
     void sendResult(const result<Artifact, Error>& buildResult) {
+      engine.st_buildCompletedCount++;
       engine.logger->event(engine.logctx, {
         makeStat("log.message", "build_completed"),
         makeStat("build_id", buildID),
@@ -1567,3 +1629,7 @@ std::shared_ptr<CASDatabase> Engine::cas() {
 Build Engine::build(const Label& artifact) {
   return static_cast<EngineImpl*>(impl)->build(artifact);
 }
+
+std::vector<Stat> Engine::stats() {
+  return static_cast<EngineImpl*>(impl)->stats();
+}

src/llbuild3/Engine.h

@@ -188,6 +188,9 @@ class Engine {
   /// Build the requested artifact.
   Build build(const Label& artifact);
 
+  /// Get engine perf stats
+  std::vector<Stat> stats();
+
   /// @}
 };
 

src/llbuild3/Engine.swift

@@ -773,4 +773,8 @@ public class TEngine {
       })
     }
   }
+
+  public func stats() throws -> [TStat] {
+    return try eng.stats().map { try TStat(serializedBytes: $0) }
+  }
 }

src/llbuild3/Label.swift

@@ -36,7 +36,7 @@ extension TLabel {
 
   /// Characters disallowed in label components.
   public static let invalidCharacters = CharacterSet(
-    charactersIn: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890-_:/."
+    charactersIn: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890:/! \\\"#$%&'()*+,-.;<=>?@[]^_`{|}"
   ).inverted
 
   public init(_ string: String) throws {

src/llbuild3/SwiftAdaptors.cpp

@@ -919,6 +919,21 @@ BuildRef EngineRef::build(const LabelPB artifact) {
   return BuildRef(std::shared_ptr<Build>(new Build(build)));
 }
 
+std::vector<StatPB> EngineRef::stats() {
+  auto stats = engine->stats();
+  std::vector<StatPB> sv;
+
+  for (auto& s: stats) {
+    std::string spb;
+    if (!s.SerializeToString(&spb)) {
+      break;
+    }
+    sv.push_back(std::move(spb));
+  }
+
+  return sv;
+}
+
 EngineRef makeEngine(
   ExtEngineConfig config, CASDatabaseRef casDB, ActionCacheRef cache,
   ActionExecutorRef executor, LoggerRef logger, ClientContextRef clientContext,