Subzero: Initial implementation of multithreaded translation.

src/IceGlobalContext.h

 //===- subzero/src/IceGlobalContext.h - Global context defs -----*- C++ -*-===//
 //
 //                        The Subzero Code Generator
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 // This file declares aspects of the compilation that persist across
 // multiple functions.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef SUBZERO_SRC_ICEGLOBALCONTEXT_H
 #define SUBZERO_SRC_ICEGLOBALCONTEXT_H
 
-#include <memory>
 #include <mutex>
+#include <queue>
+#include <thread>
 
 #include "IceDefs.h"
 #include "IceClFlags.h"
 #include "IceIntrinsics.h"
 #include "IceRNG.h"
 #include "IceTimerTree.h"
 #include "IceTypes.h"
 
 namespace Ice {
 
@@ skipping 59 matching lines @@
   class ThreadContext {
     ThreadContext(const ThreadContext &) = delete;
     ThreadContext &operator=(const ThreadContext &) = delete;
 
   public:
     ThreadContext() {}
     CodeStats StatsFunction;
     std::vector<TimerStack> Timers;
   };
 
+  class CfgQueue {
+  public:
+    explicit CfgQueue(uint32_t NumWorkers)
+        : NumWorkers(NumWorkers), IsEnded(false) {}
+    void add(Cfg *Func) {
+      std::unique_lock<GlobalLockType> L(Lock);

[JF, 2015/01/22 20:50:56]

Can you add a comment on CfgQueue explaining the locking approach for the
producer/consumer? I don't find this intuitive to read, even with the comments
on the members below.

I would also allow more Cfgs to be enqueued than there are workers: that's what
the PNaCl translator does because often functions are very small, so the
consumers dequeue something like 10 functions at at time. This should be a knob
that we can tune later.

[jvoung (off chromium), 2015/01/22 23:06:06]

Yeah, for pnacl-llc, it dequeues N functions at a time, where the N starts at
like 8 or 10, but the N tapers down to 1 near the end.

[Jim Stichnoth, 2015/01/23 07:55:54]

Done.
 
Renamed NumWorkers -> MaxSize, and added an explicit Sequential argument to the
ctor.  There can be knobs at a higher level to control it.

I can't imagine we would ever see any systematic difference from batching
dequeues in Subzero (though we might accidentally end up with a better load
balance), but we can certainly try.  Hopefully the batch would be based on total
bitcode size rather than number of functions.

[Jim Stichnoth, 2015/01/23 07:55:55]

Even for small functions, my sense is that it takes a vast amount of time to
translate the function relative to the amount of time to lock and grab a work
item.  For my future benefit, do you happen to have a writeup of an analysis of
why chunking wins?

[jvoung (off chromium), 2015/01/23 17:49:09]

Sorry I don't have the numbers anymore, but it can be re-measured by tweaking
the knob under "RecommendedChunkSize()" in
tools/pnacl-llc/ThreadedFunctionQueue.h.

What I saw was that the synchronization added by dynamic scheduling w/ 1 dequeue
at a time was almost always worse that static scheduling by a few pct. It was
only after dequeuing more that the overhead was small enough to make dynamic
scheduling a win over static scheduling. Static scheduling didn't have any
synchronization though, since we were already duplicating bitcode reader state
and calculating function number % N == TID was all it took. There might have
been some other effects though -- I wasn't as careful about false-sharing and
cache lines.

In any case, there isn't static scheduling to compare against here, but it might
be worth measuring later.

The chunking + tapering method was just "Guided Self-Scheduling" which sehr
recommended.

[JF, 2015/01/23 17:51:02]

Code review was:
  https://codereview.chromium.org/196793026/

+      // If the work queue is already "full", wait for a consumer to
+      // grab an element and shrink the queue.
+      while (WorkQueue.size() > NumWorkers) {
+        Shrunk.wait(L);
+      }
+      WorkQueue.push(Func);
+      L.unlock();
+      GrewOrEnded.notify_one();
+    }
+    Cfg *get() {
+      std::unique_lock<GlobalLockType> L(Lock);
+      while (!IsEnded || !WorkQueue.empty()) {
+        if (!WorkQueue.empty()) {
+          Cfg *Func = WorkQueue.front();
+          WorkQueue.pop();
+          L.unlock();
+          Shrunk.notify_one();
+          return Func;
+        }
+        // If the work queue is empty, and this is pure sequential
+        // execution, then return nullptr.
+        if (NumWorkers == 0)
+          return nullptr;
+        GrewOrEnded.wait(L);
+      }
+      return nullptr;
+    }
+    void end() {
+      std::unique_lock<GlobalLockType> L(Lock);
+      IsEnded = true;
+      L.unlock();
+      GrewOrEnded.notify_all();
+    }
+
+  private:
+    std::queue<Cfg *> WorkQueue;

[JF, 2015/01/22 20:50:56]

This should probably be an std::array if the size is constant.

[Jim Stichnoth, 2015/01/23 07:55:55]

There is just one add() and one get() per function, so this seems really
unlikely to be contended.  The default queue<> in terms of deque<> seems like it
ought to have pretty good allocation performance, and I don't need to implement
a circular buffer for the push() and pop() operations.

+    // Lock guards access to WorkQueue and IsEnded.
+    GlobalLockType Lock;
+    // GrewOrEnded is notified (by the producer) when something is
+    // added to the queue, in case consumers are waiting for a
+    // non-empty queue.
+    std::condition_variable GrewOrEnded;
+    // Shrunk is notified (by the consumer) when something is removed
+    // from the queue, in case the producer is waiting for the queue
+    // to drop below maximum capacity.
+    std::condition_variable Shrunk;
+    const uint32_t NumWorkers;

[JF, 2015/01/22 20:50:56]

I'd make this a size_t.

[Jim Stichnoth, 2015/01/23 07:55:55]

Done, here and in IceClFlags.h and llvm2ice.cpp.

+    bool IsEnded;
+  };
+
 public:
   GlobalContext(Ostream *OsDump, Ostream *OsEmit, ELFStreamer *ELFStreamer,
                 VerboseMask Mask, TargetArch Arch, OptLevel Opt,
                 IceString TestPrefix, const ClFlags &Flags);
   ~GlobalContext();
 
-  // Returns true if any of the specified options in the verbose mask
-  // are set.  If the argument is omitted, it checks if any verbose
-  // options at all are set.
   VerboseMask getVerbose() const { return VMask; }
-  bool isVerbose(VerboseMask Mask = IceV_All) const { return VMask & Mask; }
-  void setVerbose(VerboseMask Mask) { VMask = Mask; }
-  void addVerbose(VerboseMask Mask) { VMask |= Mask; }
-  void subVerbose(VerboseMask Mask) { VMask &= ~Mask; }
 
   // The dump and emit streams need to be used by only one thread at a
   // time.  This is done by exclusively reserving the streams via
   // lockStr() and unlockStr().  The OstreamLocker class can be used
   // to conveniently manage this.
   //
   // The model is that a thread grabs the stream lock, then does an
   // arbitrary amount of work during which far-away callees may grab
   // the stream and do something with it, and finally the thread
   // releases the stream lock.  This allows large chunks of output to
   // be dumped or emitted without risking interleaving from multiple
   // threads.
   void lockStr() { StrLock.lock(); }
   void unlockStr() { StrLock.unlock(); }
   Ostream &getStrDump() { return *StrDump; }
   Ostream &getStrEmit() { return *StrEmit; }
 
   TargetArch getTargetArch() const { return Arch; }
   OptLevel getOptLevel() const { return Opt; }
+  bool getErrorStatus() const { return ErrorStatus; }
 
   // When emitting assembly, we allow a string to be prepended to
   // names of translated functions.  This makes it easier to create an
   // execution test against a reference translator like llc, with both
   // translators using the same bitcode as input.
   IceString getTestPrefix() const { return TestPrefix; }
   IceString mangleName(const IceString &Name) const;
 
   // Manage Constants.
   // getConstant*() functions are not const because they might add
@@ skipping 80 matching lines @@
 
   TimerStackIdT newTimerStackID(const IceString &Name);
   TimerIdT getTimerID(TimerStackIdT StackID, const IceString &Name);
   void pushTimer(TimerIdT ID, TimerStackIdT StackID = TSK_Default);
   void popTimer(TimerIdT ID, TimerStackIdT StackID = TSK_Default);
   void resetTimer(TimerStackIdT StackID);
   void setTimerName(TimerStackIdT StackID, const IceString &NewName);
   void dumpTimers(TimerStackIdT StackID = TSK_Default,
                   bool DumpCumulative = true);
 
+  // Adds a newly parsed and constructed function to the Cfg work
+  // queue.  Notifies any idle workers that a new function is
+  // available for translating.  May block if the work queue is too
+  // large, in order to control memory footprint.
+  void cfgQueueAdd(Cfg *Func) { CfgQ.add(Func); }
+  // Takes a Cfg from the work queue for translating.  May block if
+  // the work queue is currently empty.  Returns nullptr if there is
+  // no more work (in which case the translation thread will probably
+  // just exit).

[JF, 2015/01/22 20:50:56]

"probably"? That seems mostly accurate.

[Jim Stichnoth, 2015/01/23 07:55:54]

Done.

+  Cfg *cfgQueueGet() { return CfgQ.get(); }
+  // Notifies that no more work will be added to the work queue.
+  void cfgQueueEnd() { CfgQ.end(); }
+
+  void startWorkerThreads() {
+    uint32_t NumWorkers = getFlags().NumTranslationThreads;
+    for (uint32_t i = 0; i < NumWorkers; ++i) {
+      ThreadContext *WorkerTLS = new ThreadContext();
+      AllThreadContexts.push_back(WorkerTLS);
+      TranslationThreads.push_back(std::thread(
+          &GlobalContext::translateFunctionsWrapper, this, WorkerTLS));
+    }
+    if (NumWorkers) {
+      // TODO(stichnot): start emitter thread

[JF, 2015/01/22 20:50:56]

?

[Jim Stichnoth, 2015/01/23 07:55:54]

Done.

+    }
+  }
+
+  void waitForWorkerThreads() {
+    cfgQueueEnd();
+    // TODO(stichnot): end the emitter queue
+    for (std::thread &Worker : TranslationThreads) {
+      Worker.join();
+    }
+    TranslationThreads.clear();
+    // TODO(stichnot): join the emitter queue
+  }
+
+  // Translation thread startup routine.
+  void translateFunctionsWrapper(ThreadContext *MyTLS) {
+    TLS = MyTLS;
+    translateFunctions();
+  }
+  // Translate functions from the Cfg queue until the queue is empty.
+  void translateFunctions();
+
+  // Utility function to match a symbol name against a match string.
+  // An empty match string means match everything.  Returns true if
+  // there is a match.
+  static bool matchSymbolName(const IceString &SymbolName,
+                              const IceString &Match) {
+    return Match.empty() || Match == SymbolName;
+}

[JF, 2015/01/22 20:50:56]

I don't understand what this is for.

[Jim Stichnoth, 2015/01/23 07:55:54]

Hopefully documented better.

+
 private:
   // Try to make sure the mutexes are allocated on separate cache
   // lines, assuming the maximum cache line size is 64.
   const static size_t MaxCacheLineSize = 64;
   alignas(MaxCacheLineSize) GlobalLockType AllocLock;
   alignas(MaxCacheLineSize) GlobalLockType ConstPoolLock;
   alignas(MaxCacheLineSize) GlobalLockType StatsLock;
   alignas(MaxCacheLineSize) GlobalLockType TimerLock;
 
   // StrLock is a global lock on the dump and emit output streams.
   typedef std::mutex StrLockType;
   StrLockType StrLock;
 
   Ostream *StrDump; // Stream for dumping / diagnostics
   Ostream *StrEmit; // Stream for code emission
 
   ArenaAllocator<> Allocator;
   VerboseMask VMask;
   std::unique_ptr<ConstantPool> ConstPool;
   Intrinsics IntrinsicsInfo;
   const TargetArch Arch;
   const OptLevel Opt;
   const IceString TestPrefix;
   const ClFlags &Flags;
   RandomNumberGenerator RNG;
   std::unique_ptr<ELFObjectWriter> ObjectWriter;
   CodeStats StatsCumulative;
   std::vector<TimerStack> Timers;
+  CfgQueue CfgQ;
+  bool ErrorStatus;

[JF, 2015/01/22 20:50:56]

Use std::error_code?

[Jim Stichnoth, 2015/01/23 07:55:54]

Done.

 
   LockedPtr<ArenaAllocator<>> getAllocator() {
     return LockedPtr<ArenaAllocator<>>(&Allocator, &AllocLock);
   }
   LockedPtr<ConstantPool> getConstPool() {
     return LockedPtr<ConstantPool>(ConstPool.get(), &ConstPoolLock);
   }
   LockedPtr<CodeStats> getStatsCumulative() {
     return LockedPtr<CodeStats>(&StatsCumulative, &StatsLock);
   }
   LockedPtr<std::vector<TimerStack>> getTimers() {
     return LockedPtr<std::vector<TimerStack>>(&Timers, &TimerLock);
   }
 
   std::vector<ThreadContext *> AllThreadContexts;
+  std::vector<std::thread> TranslationThreads;
   // Each thread has its own TLS pointer which is also held in
   // AllThreadContexts.
   thread_local static ThreadContext *TLS;
 
   // Private helpers for mangleName()
   typedef llvm::SmallVector<char, 32> ManglerVector;
   void incrementSubstitutions(ManglerVector &OldName) const;
 };
 
 // Helper class to push and pop a timer marker.  The constructor
@@ skipping 37 matching lines @@
   explicit OstreamLocker(GlobalContext *Ctx) : Ctx(Ctx) { Ctx->lockStr(); }
   ~OstreamLocker() { Ctx->unlockStr(); }
 
 private:
   GlobalContext *const Ctx;
 };
 
 } // end of namespace Ice
 
 #endif // SUBZERO_SRC_ICEGLOBALCONTEXT_H