Skip to contentSkip to conversation

Add shared make jobserver support

PATCH New Richard Purdie 1 participant 1 message Feb 6, 2015

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Add shared make jobserver support

This is a WIP to add a make job server into bitbake. This means the pool of make tokens is central and shared by all tasks executed instead of the current one job pool per task. Currently we can end up with many more make subprocesses executing that is intended or optimal.

Implementation wise, make usually uses a pipe for this functionality. Here we substitute a named pipe (fifo) and intercept the make commands, passing in file descriptors to the central fifo. This assumes knowledge of make's internal API, on the plus side it hasn't changed since 1999.

Looking to the future we could dynamically control the pool but one step at a time.

TODO:
* Remove hardcoded /tmp/makefifo and use something in TMPDIR or similar (alongside the lock file?)
* Remove hardcoded make threads number and set from PARALLEL_MAKE
* If PARALLEL_MAKE = "", don't set MAKEARGS (currently parallelism is set everywhere) (need to check for -j in make commandline)

I'm sending this out so at least the code is available to people. Its not ready for merging in its current form but might be the basis for someone else to finish this up, it also gives us something we can test the performance implications with.

bitbake/lib/bb/runqueue.py +17 -0
index a6da72b..8b1763e 100644
@@ -1029,6 +1029,21 @@ class RunQueue:
             cache[task] = iscurrent
         return iscurrent
 
+    def setup_make_fifo(self):
+        fifoname = "/tmp/makefifo"
+        threads = 20
+        if os.path.exists(fifoname):
+            os.remove(fifoname)
+        os.mkfifo(fifoname)
+ 
+        # Has to be open for read and writing
+        self.makereadfd = os.open(fifoname, os.O_RDONLY|os.O_NONBLOCK)
+        self.makewritefd = os.open(fifoname, os.O_WRONLY)
+        wfd = os.fdopen(self.makewritefd, 'w')
+
+        for x in range(0, threads):
+            wfd.write('+')
+
     def _execute_runqueue(self):
         """
         Run the tasks in a queue prepared by rqdata.prepare()
@@ -1050,6 +1065,8 @@ class RunQueue:
                     depgraph = self.cooker.buildDependTree(self, self.rqdata.taskData)
                     bb.event.fire(bb.event.DepTreeGenerated(depgraph), self.cooker.data)
 
+                self.setup_make_fifo()
+
         if self.state is runQueueSceneInit:
             dump = self.cooker.configuration.dump_signatures
             if dump:
meta/conf/bitbake.conf +1 -1
index b84232a..0d28685 100644
@@ -422,7 +422,7 @@ EXTRA_IMAGEDEPENDS = ""
 # Toolchain info.
 ##################################################################
 
-PATH_prepend = "${COREBASE}/scripts:${STAGING_BINDIR_TOOLCHAIN}:${STAGING_BINDIR_CROSS}:${STAGING_DIR_NATIVE}${sbindir_native}:${STAGING_BINDIR_NATIVE}:${STAGING_DIR_NATIVE}${base_sbindir_native}:${STAGING_DIR_NATIVE}${base_bindir_native}:"
+PATH_prepend = "${COREBASE}/scripts/make-intercept:${COREBASE}/scripts:${STAGING_BINDIR_TOOLCHAIN}:${STAGING_BINDIR_CROSS}:${STAGING_DIR_NATIVE}${sbindir_native}:${STAGING_BINDIR_NATIVE}:${STAGING_DIR_NATIVE}${base_sbindir_native}:${STAGING_DIR_NATIVE}${base_bindir_native}:"
 export PATH
 
 ##################################################################
scripts/make-intercept/make new file +24 -0
new file mode 100755
index 0000000..5f04a13
@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+import sys
+import os
+import subprocess
+
+fifoname = "/tmp/makefifo"
+
+r = os.open(fifoname, os.O_RDONLY|os.O_NONBLOCK)
+w = os.open(fifoname, os.O_WRONLY)
+os.close(r)
+r = os.open(fifoname, os.O_RDONLY)
+
+newpath = []
+origpath = os.environ["PATH"].split(":")
+for p in origpath:
+    if "make-intercept" in p:
+         continue
+    newpath.append(p)
+os.environ["PATH"] = ":".join(newpath)
+os.environ["MAKEFLAGS"] = "-j --jobserver-fds=" + str(r) + "," + str(w)
+
+sys.argv[0] = "make"
+
+subprocess.call(sys.argv, shell=False)