build-graph 0.1.0 → 0.3.0

data/lib/build/graph/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Build
+	module Graph
+		VERSION = "0.3.0"
+	end
+end

data/lib/build/graph/walker.rb

@@ -0,0 +1,200 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'set'
+
+require_relative 'error'
+
+module Build
+	module Graph
+		# A walker walks over a graph and applies a task to each node.
+		class Walker
+			def initialize(controller, &task)
+				@controller = controller
+				@task = task
+			
+				@count = 0
+			
+				@outputs = {}
+				@dirty = Set.new
+			
+				# Generate a list of dirty outputs, possibly a subset, if the build graph might generate additional nodes:
+				@controller.nodes.each do |key, node|
+					# For a given child, a list of any parents waiting on it.
+					if node.dirty?
+						@dirty << node
+					
+						@outputs[node] = []
+					
+						node.outputs.each do |output|
+							@outputs[output] = []
+						end
+					end
+				end
+			
+				@parents = {}
+			
+				# Failed output paths:
+				@failed = Set.new
+			end
+		
+			attr :controller
+			attr :output
+		
+			attr_accessor :count
+		
+			attr :dirty
+			attr :parents
+		
+			def task(*arguments)
+				@task.call(self, *arguments)
+			end
+		
+			def wait_on_paths(paths)
+				edge = Edge.new
+				failed = false
+			
+				paths.each do |path|
+					if @outputs.include? path
+						@outputs[path] << edge
+					
+						edge.increment!
+					end
+				
+					if !failed and @failed.include?(path)
+						failed = true
+					end
+				end
+			
+				edge.wait || failed
+			end
+		
+			def wait_for_nodes(children)
+				edge = Edge.new
+			
+				children.each do |child|
+					if @dirty.include?(child)
+						edge.increment!
+					
+						@parents[child] ||= []
+						@parents[child] << edge
+					end
+				end
+			
+				edge.wait
+			end
+		
+			def exit(node)
+				@dirty.delete(node)
+			
+				# Fail outputs if the node failed:
+				@failed += node.outputs if node.failed?
+			
+				# Clean the node's outputs:
+				node.outputs.each do |path|
+					if edges = @outputs.delete(path)
+						edges.each{|edge| edge.traverse(node)}
+					end
+				end
+		
+				# Trigger the parent nodes:
+				if parents = @parents.delete(node)
+					parents.each{|edge| edge.traverse(node)}
+				end
+			end
+		end
+	
+		# A task is a specific process and scope applied to a graph node.
+		class Task
+			def initialize(controller, walker, node)
+				@controller = controller
+				@node = node
+				@walker = walker
+			
+				# If the execution of the node fails, this is where we save the error:
+				@error = nil
+			
+				@children = []
+			end
+		
+			attr :children
+		
+			def inputs
+				@node.inputs
+			end
+		
+			def outputs
+				@node.outputs
+			end
+		
+			def wet?
+				@node.dirty?
+			end
+		
+			# Derived task should override this function to provide appropriate behaviour.
+			def visit
+				wait_for_inputs
+			
+				# If all inputs were good, we can update the node.
+				unless any_inputs_failed?
+					begin
+						#self.instance_eval(&update)e
+						yield
+					rescue TransientError => error
+						$stderr.puts Rainbow("Error: #{error.inspect}").red
+						@error = error
+					end
+				end
+			
+				wait_for_children
+			end
+		
+			def exit
+				if @error || any_child_failed? || any_inputs_failed?
+					@node.fail!
+				elsif wet?
+					@node.clean!
+				end
+			
+				@walker.exit(@node)
+			
+				@walker.count += 1
+			end
+		
+		protected
+			def wait_for_inputs
+				# Wait on any inputs, returns whether any inputs failed:
+				@inputs_failed = @walker.wait_on_paths(@node.inputs)
+			end
+		
+			def wait_for_children
+				@walker.wait_for_nodes(@children)
+			end
+		
+			def any_child_failed?
+				@children.any?{|child| child.failed?}
+			end
+		
+			def any_inputs_failed?
+				@inputs_failed
+			end
+		end
+	end
+end

data/spec/build/graph/graph_spec.rb

@@ -0,0 +1,212 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'build/graph'
+require 'build/files'
+require 'build/makefile'
+
+require 'process/group'
+require 'fileutils'
+require 'rainbow'
+
+module Build::Graph::GraphSpec
+	# The graph node is created once, so a graph has a fixed number of nodes, which store per-vertex state and connectivity.
+	class Node < Build::Graph::Node
+		include Build::Files
+		
+		def initialize(controller, inputs = Paths::NONE, outputs = Paths::NONE, &update)
+			@update = update
+			
+			super(controller, inputs, outputs)
+		end
+		
+		def apply!(scope)
+			scope.instance_eval(&@update)
+		end
+		
+		# This ensures that enclosed nodes are run if they are dirty. The top level node has no inputs or outputs by default, so children who become dirty wouldn't mark it as dirty and thus wouldn't be run.
+		def requires_update?
+			if outputs.count == 0
+				return true
+			else
+				super
+			end
+		end
+	end
+	
+	# The task is the context in which a vertex is updated. Because nodes may initially create other nodes, it is also responsible for looking up and creating new nodes.
+	class Task < Build::Graph::Task
+		include Build::Files
+		
+		def initialize(controller, walker, node, group = nil)
+			super(controller, walker, node)
+			
+			@group = group
+		end
+		
+		def wet?
+			@group and @node.dirty?
+		end
+		
+		def process(inputs, outputs, &block)
+			inputs = Build::Files::List.coerce(inputs)
+			outputs = Build::Files::List.coerce(outputs)
+			
+			child_node = @controller.nodes.fetch([inputs, outputs]) do |key|
+				@controller.nodes[key] = Node.new(@controller, inputs, outputs, &block)
+			end
+			
+			@children << child_node
+			
+			# State saved in update!
+			child_node.update!(@walker)
+			
+			return child_node
+		end
+		
+		def run(*arguments)
+			if wet?
+				status = @group.spawn(*arguments)
+				
+				if status != 0
+					raise RuntimeError.new(status)
+				end
+			end
+		end
+		
+		def visit
+			super do
+				@node.apply!(self)
+			end
+		end
+	end
+	
+	# The controller contains all graph nodes and is responsible for executing tasks on the graph. 
+	class Controller < Build::Graph::Controller
+		def initialize(&block)
+			@top = Node.new(self, &block)
+			
+			super()
+		end
+		
+		attr_accessor :top
+		
+		def traverse!(walker)
+			@top.update!(walker)
+		end
+		
+		def build_graph!
+			super do |walker, node|
+				Task.new(self, walker, node)
+			end
+		end
+		
+		def update!
+			group = Process::Group.new
+			
+			super do |walker, node|
+				Task.new(self, walker, node, group)
+			end
+			
+			group.wait
+		end
+	end
+	
+	include Build::Files
+	
+	describe Build::Graph do
+		it "shouldn't update mtime" do
+			test_glob = Glob.new(__dir__, "*.rb")
+			listing_output = Paths.directory(__dir__, ["listing.txt"])
+			
+			FileUtils.rm_f listing_output.to_a
+			
+			node = nil
+			
+			controller = Controller.new do
+				node = process test_glob, listing_output do
+					run("ls", "-la", *inputs, :out => outputs.first.for_writing)
+				end
+			end
+			
+			expect(controller.top).to_not be nil
+			expect(node).to_not be nil
+			
+			controller.update!
+			
+			mtime = listing_output.first.mtime
+			
+			# Ensure the mtime will change even if the granularity of the filesystem is 1 second:
+			sleep(1)
+			
+			controller.update!
+			
+			# The output file shouldn't have been changed because already exists and the input files haven't changed either:
+			expect(listing_output.first.mtime).to be == mtime
+			
+			FileUtils.rm_f listing_output.to_a
+		end
+		
+		it "should compile program and respond to changes in source code" do
+			program_root = Path.join(__dir__, "program")
+			code_glob = Glob.new(program_root, "*.cpp")
+			program_path = Path.join(program_root, "dictionary-sort")
+			
+			# FileUtils.touch(code_glob.first)
+			
+			controller = Controller.new do
+				process code_glob, program_path do
+					object_files = inputs.with(extension: ".o") do |input_path, output_path|
+						depfile_path = input_path + ".d"
+						
+						dependencies = Paths.new(input_path)
+						
+						if File.exist? depfile_path
+							depfile = Build::Makefile.load_file(depfile_path)
+							
+							dependencies = depfile[output_path] || dependencies
+						end
+						
+						process dependencies, output_path do
+							run("clang++", "-MMD", "-O3",
+								"-o", output_path.shortest_path(input_path.root),
+								"-c", input_path.relative_path, "-std=c++11",
+								chdir: input_path.root
+							)
+						end
+					end
+					
+					process object_files, program_path do
+						run("clang++", "-O3", "-o", program_path, *object_files.to_a, "-lm", "-pthread")
+					end
+				end
+				
+				process program_path, Paths::NONE do
+					run("./" + program_path.relative_path, chdir: program_path.root)
+				end
+			end
+			
+			controller.update!
+			
+			expect(program_path).to be_exist
+			expect(code_glob.first.mtime).to be <= program_path.mtime
+		end
+	end
+end

data/spec/build/graph/program/Benchmark.cpp

@@ -0,0 +1,72 @@
+//
+//  Benchmark.cpp
+//  DictionarySort
+//
+//  Created by Samuel Williams on 2/11/11.
+//  Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+//
+
+#include "Benchmark.h"
+
+#include <sys/time.h>
+
+// A timer class for quickly checking the wall-clock performance of code.
+namespace Benchmark
+{
+	static TimeT system_time () {
+		static struct timeval t;
+		gettimeofday (&t, (struct timezone*)0);
+		return ((TimeT)t.tv_sec) + ((TimeT)t.tv_usec / 1000000.0);
+	}
+    
+	WallTime::WallTime () {
+		this->reset();
+	}
+    
+	void WallTime::reset () {
+		this->_last = system_time();
+		this->_total = 0.0;
+	}
+    
+	TimeT WallTime::total () const {
+		TimeT current = system_time();
+		this->_total += current - this->_last;
+		this->_last = current;
+		return this->_total;
+	}
+
+	ProcessorTime::ProcessorTime()
+	{
+		this->reset();
+	}
+
+	void ProcessorTime::reset ()
+	{
+		this->_last = std::clock();
+		this->_total = 0;
+	}
+
+	TimeT ProcessorTime::total () const
+	{
+		std::clock_t current = std::clock();
+		this->_total += std::clock() - this->_last;
+		this->_last = current;
+		
+		return TimeT(this->_total) / TimeT(CLOCKS_PER_SEC);
+	}
+
+	Timer::Timer()
+	{
+	}
+
+	void Timer::reset ()
+	{
+		_wall_time.reset();
+		_processor_time.reset();
+	}
+
+	Timer::Sample Timer::sample() const
+	{
+		return {_wall_time.total(), _processor_time.total()};
+	}
+}