blifutils 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: beffcb8de20600c830e33e4940b630bcd5adf2d9
-  data.tar.gz: 3f689ec7d8bb121f41ea36c7e9724f636d013a80
+  metadata.gz: b983d50091d1cdd6613589e30a03c7e660925aea
+  data.tar.gz: e919036b709395235ebde09cc7b32eea3f222874
 SHA512:
-  metadata.gz: '0952b7ab1036587562224e0c46d4df0830c966e28a1d75c196768a288f8fa40ec3b670967fe3a74784116ddafdea2a2510de7a610eb0dde7264b6fe6343c34bc'
-  data.tar.gz: 8b9aef1b9c0b798deaa2f9672bdad24023f98e8d2f037450000f202b519bd3158e7da1a79ad3fafcf43d853128e5bb7fab238235e9862cc252ee3364323ffbaf
+  metadata.gz: 5a4f0b845afaf9c2c9a91c9730b6e027d939e474a31a2f05f749c182cdde1d5d559d9d657c5b68b9072a4d50608273be3a2229c6a7342dcfe024f73ccc71c383
+  data.tar.gz: 1ea094b9a22b94e28c78a890836b55f3d21a77f8435ee5a9df321770cf832a807b5ca7b0b0fe152ef29c5361c505880a960b592dd777f4300d362c634c7a814e

data/bin/blifutils

@@ -29,27 +29,27 @@ inputFiles = []
 optparse = OptionParser.new do |opts|
 	# Set a banner, displayed at the top
 	# of the help screen.
-	opts.banner = "Usage: #{$0} [options] -i file1 file2 ..."
+	opts.banner = "Usage: #{File.basename($0)} [options] -i file1 file2 ..."
 
-	opts.on('-i', '--input FILES', 'Input blif files') do |file|
+	opts.on('-i', '--input FILES', 'Input BLIF files') do |file|
 		inputFiles << file
 	end
 
 	options[:blif] = false
 	options[:outputBlifName] = nil
-	opts.on('-o', '--output [FILE]', 'Output blif to FILE') do |file|
+	opts.on('-o', '--output [FILE]', 'Output BLIF FILE') do |file|
 		options[:blif] = true
 		options[:outputBlifName] = file
 	end
 
-	options[:simulation] = false
-	opts.on('-s', '--simulation', "Create C++ simulation files") do
-		options[:simulation] = true
+	options[:printModels] = false
+	opts.on('-p', '--print-models', 'Print model names') do
+		options[:printModels] = true
 	end
 
-	options[:vhdl] = false
-	opts.on('-v', '--vhdl', "Create a vhdl file") do
-		options[:vhdl] = true
+	options[:model] = nil
+	opts.on('-m', '--model NAME', 'Name of the model to process') do |mod|
+		options[:model] = mod
 	end
 
 	options[:flatten] = false
@@ -57,14 +57,14 @@ optparse = OptionParser.new do |opts|
 		options[:flatten] = true
 	end
 
-	options[:model] = nil
-	opts.on('-m', '--model NAME', 'Name of the model to process') do |mod|
-		options[:model] = mod
+	options[:simulation] = false
+	opts.on('-s', '--simulation', "Create C++ simulation files") do
+		options[:simulation] = true
 	end
 
-	options[:printModels] = false
-	opts.on('-p', '--print-models', 'Print model names') do
-		options[:printModels] = true
+	options[:vhdl] = false
+	opts.on('-v', '--vhdl', "Create a vhdl file") do
+		options[:vhdl] = true
 	end
 
 	options[:analyze] = false
@@ -81,6 +81,20 @@ optparse = OptionParser.new do |opts|
 		options[:analyzeLevelWithGV] = true
 	end
 
+	options[:default_latch_type] = nil
+	opts.on('--default-latch-type TYPE', 'Set undefined latch types to TYPE (re: rising edge, fe: falling edge, al: active low, ah: active high, as: asynchronous)') do |type|
+		options[:default_latch_type] = type.to_sym
+	end
+
+	options[:default_latch_clock] = nil
+	opts.on('--default-latch-clock NAME', 'Set undefined latch contol signals to NAME') do |name|
+		options[:default_latch_clock] = name
+	end
+
+	options[:default_latch_initial_value] = nil
+	opts.on('--default-latch-initial-value VALUE', "Set undefined latch initial value to VALUE (0, 1, 2: don't care, 3: undefine)") do |val|
+		options[:default_latch_initial_value] = val
+	end
 
 	options[:quiet] = false
 	opts.on('-q', '--quiet', "Don't print messages") do
@@ -90,21 +104,42 @@ optparse = OptionParser.new do |opts|
 	# This displays the help screen, all programs are
 	# assumed to have this option.
 	opts.on( '-h', '--help', 'Display this help' ) do
-		puts opts
+		puts opts.to_s
 		exit
 	end
 end
 
-optparse.parse!
+begin
+	optparse.parse!
+rescue OptionParser::MissingArgument => e
+	STDERR.puts e.message
+	abort optparse.to_s
+end
 
 ARGV.each{|f| inputFiles << f}
 
+unless [nil, :re, :fe, :al, :ah, :as].include?(options[:default_latch_type])
+	STDERR.puts "Default latch type must be either re, fe, al, ah or as."
+	abort optparse.to_s
+end
+
+unless options[:default_latch_initial_value].nil? 
+	unless options[:default_latch_initial_value].match(/^[0123]$/) then
+		STDERR.puts "Default latch initial value must be either 0, 1, 2 or 3."
+		abort optparse.to_s
+	end
+	options[:default_latch_initial_value] = options[:default_latch_initial_value].to_i
+end
 
 
 ## Read blif inputs and add models to the netlist ##
 netlist = BlifUtils::Netlist.new
 inputFiles.each do |iFile|
-	elNetlist = BlifUtils::Elaborator.elaborate_netlist(BlifUtils::Parser.parse(iFile, quiet: options[:quiet]), quiet: options[:quiet])
+	elNetlist = BlifUtils::Elaborator.elaborate_netlist(BlifUtils::Parser.parse(iFile, quiet: options[:quiet]), 
+														quiet: options[:quiet],
+														default_latch_type: options[:default_latch_type],  
+														default_latch_clock: options[:default_latch_clock], 
+														default_latch_initial_value: options[:default_latch_initial_value])
 	elNetlist.models.each{|model| netlist.add_model(model)}
 end
 

data/lib/blifutils.rb

@@ -18,7 +18,7 @@
 
 
 module BlifUtils
-	VERSION = '0.0.1'
+	VERSION = '0.0.2'
 end
 
 require 'blifutils/parser'

data/lib/blifutils/ast.rb

@@ -123,7 +123,7 @@ module BlifUtils
 			class GenericLatch
 				attr_reader :input, :output, :initValue, :ctrlType, :ctrlSig
 
-				def initialize (input, output, initValue: 3, ctrlType: :re, ctrlSig: nil)
+				def initialize (input, output, initValue: nil, ctrlType: nil, ctrlSig: nil)
 					@input = input
 					@output = output
 					@initValue = initValue
@@ -135,9 +135,9 @@ module BlifUtils
 					str  = '    '*indent + "Latch:\n"
 					str += '    '*(indent+1) + "Input:  \"#{@input}\"\n"
 					str += '    '*(indent+1) + "Output: \"#{@output}\"\n"
-					str += '    '*(indent+1) + "Initial value: \"#{@initValue}\"\n"
-					str += '    '*(indent+1) + "Type: \"#{@ctrlType}\"\n"
-					str += '    '*(indent+1) + "Clock signal: #{@ctrlSig.nil? ? "nil" : "\"#{@ctrlSig}\""}\n"
+					str += '    '*(indent+1) + "Initial value: #{@initValue.nil? ? "undefined" : "\"#{@initValue}\""}\n"
+					str += '    '*(indent+1) + "Type: #{@ctrlType.nil? ? "undefined" : "\"#{@ctrlSig}\""}\n"
+					str += '    '*(indent+1) + "Clock signal: #{@ctrlSig.nil? ? "undefined" : "\"#{@ctrlSig}\""}\n"
 					return str
 				end
 			end # BlifUtils::AST::GenericLatch

data/lib/blifutils/elaborator.rb

@@ -26,13 +26,13 @@ module BlifUtils
 
 	module Elaborator
 
-		def self.elaborate_netlist (ast, quiet: false)
+		def self.elaborate_netlist (ast, quiet: false, default_latch_type: nil, default_latch_clock: nil, default_latch_initial_value: nil)
 			modelDeclarations = gather_model_declarations(ast)
 
 			netlist = BlifUtils::Netlist.new
 			models = ast.modelList.collect do |modelAst|
 				puts "Elaborating model \"#{modelAst.name}\"..." unless quiet
-				netlist.add_model(elaborate_model(modelAst, modelDeclarations, quiet: quiet))
+				netlist.add_model(elaborate_model(modelAst, modelDeclarations, quiet: quiet, default_latch_type: default_latch_type, default_latch_clock: default_latch_clock, default_latch_initial_value: default_latch_initial_value))
 			end
 
 			return netlist
@@ -94,7 +94,7 @@ module BlifUtils
 		end # BlifUtils::Elaborator::gather_model_declarations
 
 
-		def self.elaborate_model (modelAst, modelDeclarations, quiet: false)
+		def self.elaborate_model (modelAst, modelDeclarations, quiet: false, default_latch_type: nil, default_latch_clock: nil, default_latch_initial_value: nil)
 			name = modelAst.name
 			inputs = []
 			outputs = []
@@ -154,26 +154,48 @@ module BlifUtils
 				end
 			end
 
+			if default_latch_type then
+				components.each do |c|
+					next unless c.isLatch? and c.ctrlType.nil?
+					c.set_type(default_latch_type)
+				end
+			end
+
+			if default_latch_clock then
+				components.each do |c|
+					next unless c.isLatch? and c.ctrlSig.nil?
+					c.set_clock(default_latch_clock)
+				end
+			end
+
+			if default_latch_initial_value then
+				components.each do |c|
+					next unless c.isLatch? and c.initValue.nil?
+					c.set_initial_value(default_latch_initial_value)
+				end
+			end
+
+
 			# Create all nets from their drivers #
+			netnames = {}
 			inputs.each do |iIO|
 				newNet = BlifUtils::Netlist::Net.new(iIO.net, :input, [], true, false)
+				netnames[newNet.name] = newNet
 				nets << newNet
 				iIO.net = newNet
 			end
 			components.reject{|comp| comp.isSubcircuit?}.each do |component|
 				newNet = BlifUtils::Netlist::Net.new(component.output, component, [], false, false)
-				if nets.collect{|net| net.name}.include?(newNet.name) then
-					abort "ERROR: In model \"#{name}\": net \"#{newNet.name}\" has more than one driver"
-				end
+				abort "ERROR: In model \"#{name}\": net \"#{newNet.name}\" has more than one driver" if netnames[newNet.name]
+				netnames[newNet.name] = newNet
 				nets << newNet
 				component.output = newNet
 			end
 			components.select{|comp| comp.isSubcircuit?}.each do |subcircuit|
 				subcircuit.outputFormalAcutalList.each do |outIO|
 					newNet = BlifUtils::Netlist::Net.new(outIO.net, subcircuit, [], false, false)
-					if nets.collect{|net| net.name}.include?(newNet.name) then
-						abort "ERROR: In model \"#{name}\": net \"#{newNet.name}\" has more than one driver"
-					end
+					abort "ERROR: In model \"#{name}\": net \"#{newNet.name}\" has more than one driver" if netnames[newNet.name]
+					netnames[newNet.name] = newNet
 					nets << newNet
 					outIO.net = newNet
 				end
@@ -181,49 +203,43 @@ module BlifUtils
 
 			# Update nets fanouts #
 			outputs.each_with_index do |oIO, i|
-				index = nets.index{|net| net.name == oIO.name}
-				if index.nil? then
-					abort "ERROR: In model \"#{name}\": output \"#{oIO.name}\" has no driver"
-				end
-				nets[index].fanouts << BlifUtils::Netlist::Fanout.new(:output, i)
-				nets[index].isOutput = true
-				oIO.net = nets[index]
+				theNet = netnames[oIO.name]
+				abort "ERROR: In model \"#{name}\": output \"#{oIO.name}\" has no driver" if theNet.nil?
+				theNet.fanouts << BlifUtils::Netlist::Fanout.new(:output, i)
+				theNet.isOutput = true
+				oIO.net = theNet
 			end
 			components.select{|comp| comp.isLatch?}.each do |latch|
-				index = nets.index{|net| net.name == latch.input}
-				if index.nil? then
-					abort "ERROR: In model \"#{name}\": input \"#{latch.input}\" from latch \"#{latch.output.name}\" has no driver"
-				end
-				nets[index].fanouts << BlifUtils::Netlist::Fanout.new(latch, 0)
-				latch.input = nets[index]
+				theNet = netnames[latch.input]
+				abort "ERROR: In model \"#{name}\": input \"#{latch.input}\" from latch \"#{latch.output.name}\" has no driver" if theNet.nil?
+				theNet.fanouts << BlifUtils::Netlist::Fanout.new(latch, 0)
+				latch.input = theNet
 			end
 			components.select{|comp| comp.isGate?}.each do |gate|
 				gate.inputs.each_with_index do |gin, i|
-					index = nets.index{|net| net.name == gin}
-					if index.nil? then
-						abort "ERROR: In model \"#{name}\": input \"#{gin}\" from gate \"#{gate.output.name}\" has no driver"
-					end
-					nets[index].fanouts << BlifUtils::Netlist::Fanout.new(gate, i)
-					gate.inputs[i] = nets[index]
+					theNet = netnames[gin]
+					abort "ERROR: In model \"#{name}\": input \"#{gin}\" from gate \"#{gate.output.name}\" has no driver" if theNet.nil?
+					theNet.fanouts << BlifUtils::Netlist::Fanout.new(gate, i)
+					gate.inputs[i] = theNet
 				end
 			end
 			components.select{|comp| comp.isSubcircuit?}.each do |subcircuit|
 				subcircuit.inputFormalAcutalList.each_with_index do |iIO, i|
-					index = nets.index{|net| net.name == iIO.net}
-					if index.nil? then
-						abort "ERROR: In model \"#{name}\": input \"#{iIO}\" (formal \"#{iIO.name}\" from reference model \"#{subcircuit.modelName}\" has no driver"
-					end
-					nets[index].fanouts << BlifUtils::Netlist::Fanout.new(subcircuit, i)
-					iIO.net = nets[index]
+					theNet = netnames[iIO.net]
+					abort "ERROR: In model \"#{name}\": input \"#{iIO}\" (formal \"#{iIO.name}\" from reference model \"#{subcircuit.modelName}\" has no driver" if theNet.nil?
+					theNet.fanouts << BlifUtils::Netlist::Fanout.new(subcircuit, i)
+					iIO.net = theNet
 				end
 			end
 
 			clocks = components.select{|comp| comp.isLatch?}.collect{|latch| latch.ctrlSig}.reject{|el| el.nil?}.uniq
 
 			# Check that each net has at least one fanout #
-			nets.each do |net|
-				if net.fanouts.empty? and not(clocks.include?(net.name)) then
-					STDERR.puts "WARNING: In model \"#{name}\": net \"#{net.name}\" has no fanouts" unless quiet
+			unless quiet then
+				nets.each do |net|
+					if net.fanouts.empty? and not(clocks.include?(net.name)) then
+						STDERR.puts "WARNING: In model \"#{name}\": net \"#{net.name}\" has no fanouts"
+					end
 				end
 			end
 
@@ -233,9 +249,9 @@ module BlifUtils
 	end # BlifUtils::Elaborator
 
 
-	def self.read(fileName, quiet: false)
+	def self.read(fileName, quiet: false, default_latch_type: nil, default_latch_clock: nil, default_latch_initial_value: nil)
 		ast = BlifUtils::Parser.parse(fileName, quiet: quiet)
-		netlist = BlifUtils::Elaborator.elaborate_netlist(ast, quiet: quiet)
+		netlist = BlifUtils::Elaborator.elaborate_netlist(ast, quiet: quiet, default_latch_type: nil, default_latch_clock: nil, default_latch_initial_value: nil)
 		return netlist
 	end # BlifUtils::read
 

data/lib/blifutils/netlist.rb

@@ -160,7 +160,23 @@ module BlifUtils
 
 
 			def to_blif
-				return ".latch #{@input.name} #{@output.name} #{@ctrlType} #{@ctrlSig.nil? ? 'NIL' : @ctrlSig} #{@initValue}\n"
+				res  = ".latch #{@input.name} #{@output.name}"
+				if @ctrlType
+					res += " #{@ctrlType} "
+					if @ctrlSig.nil?
+						res += "NIL"
+					elsif @ctrlSig.kind_of?(BlifUtils::Netlist::Net)
+						res += @ctrlSig.name
+					else
+						res += @ctrlSig
+					end
+				end
+				if @initValue
+					res += " #{@initValue} "
+				end
+				res += "\n"
+
+				return res
 			end
 
 
@@ -178,6 +194,22 @@ module BlifUtils
 				return "Latch \"#{@output.name}\""
 			end
 
+
+			def set_type (type)
+				raise "Type must be one of [nil, :fe, :re, :ah, :al, :as]" unless [nil, :fe, :re, :ah, :al, :as].include?(type)
+				@ctrlType = type
+			end
+
+
+			def set_clock (net_or_name)
+				@ctrlSig = net_or_name
+			end
+
+
+			def set_initial_value (value)
+				raise "Initial value must be an integer in the range 0..3" unless (value.kind_of?(Integer) and value >= 0 and value <= 3)
+				@initValue = value
+			end
 		end # BlifUtils::Netlist::Latch
 
 
@@ -299,6 +331,30 @@ module BlifUtils
 			end
 
 
+			def set_undefined_latches_type (type)
+				@components.each do |c|
+					next unless c.isLatch? and c.ctrlType.nil?
+					c.set_type(type)
+				end
+			end
+
+
+			def set_undefined_latches_clock (clk)
+				@components.each do |c|
+					next unless c.isLatch? and c.ctrlSig.nil?
+					c.set_clock(clk)
+				end
+			end
+
+
+			def set_undefined_latches_initial_value (value)
+				@components.each do |c|
+					next unless c.isLatch? and c.initValue.nil?
+					c.set_initial_value(value)
+				end
+			end
+
+
 			def analyze
 				bannerTitle = " #{@isBlackBox ? 'Black box' : 'Model'} \"#{@name}\" analysis "
 				bannerSize = [40, bannerTitle.length].max

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blifutils
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Théotime Bollengier