pio 0.1.0

data/README.md

@@ -0,0 +1,4 @@
+pio
+===
+
+Packet parser and generator

data/Rakefile

@@ -0,0 +1,89 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "bundler/gem_tasks"
+require "flay"
+require "rake/tasklib"
+require "flay_task"
+require "flog"
+require "reek/rake/task"
+require "rspec/core"
+require "rspec/core/rake_task"
+require "yard"
+
+
+$ruby_source = FileList[ "lib/**/*.rb" ]
+
+
+task :quality => [ :reek, :flog, :flay ]
+
+
+RSpec::Core::RakeTask.new do | task |
+  task.rspec_opts = "--format documentation --color"
+end
+
+
+Reek::Rake::Task.new do | t |
+  t.fail_on_error = true
+  t.verbose = false
+  t.ruby_opts = [ "-rubygems" ]
+  t.reek_opts = "--quiet"
+  t.source_files = $ruby_source
+end
+
+
+desc "Analyze for code complexity"
+task :flog do
+  flog = Flog.new( :continue => true )
+  flog.flog( *$ruby_source )
+  threshold = 10
+
+  bad_methods = flog.totals.select do | name, score |
+    ( not ( /##{flog.no_method}$/=~ name ) ) and score > threshold
+  end
+  bad_methods.sort do | a, b |
+    a[ 1 ] <=> b[ 1 ]
+  end.reverse.each do | name, score |
+    puts "%8.1f: %s" % [ score, name ]
+  end
+  unless bad_methods.empty?
+    raise "#{ bad_methods.size } methods have a flog complexity > #{ threshold }"
+  end
+end
+
+
+FlayTask.new do | t |
+  t.dirs = $ruby_source.collect do | each |
+    each[ /[^\/]+/ ]
+  end.uniq
+  t.threshold = 0
+  t.verbose = $trace
+end
+
+
+YARD::Rake::YardocTask.new do | t |
+  t.options = [ "--no-private" ]
+  t.options << "--debug" << "--verbose" if $trace
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp.rb

@@ -0,0 +1,45 @@
+require "rubygems"
+
+require "bindata"
+require "forwardable"
+require "pio/lldp/frame"
+
+
+module Pio
+  # LLDP frame parser and generator.
+  class Lldp
+    extend Forwardable
+
+
+    def self.read raw_data
+      frame = Frame.read( raw_data )
+      new frame.dpid, frame.port_id
+    end
+
+
+    def initialize dpid, port_number, destination_mac = "01:80:c2:00:00:0e"
+      @frame = Frame.new
+      @frame.destination_mac = destination_mac
+      @frame.source_mac = "11:22:33:44:55:66"  # FIXME
+      @frame.chassis_id = dpid
+      @frame.port_id = port_number
+    end
+
+
+    def_delegator :@frame, :dpid
+    def_delegator :@frame, :optional_tlv
+    def_delegator :@frame, :port_id, :port_number
+
+
+    def to_binary
+      @frame.to_binary_s + "\000" * ( 64 - @frame.num_bytes )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/chassis-id-tlv.rb

@@ -0,0 +1,57 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # Chassis ID TLV
+    class ChassisIdTlv < BinData::Primitive
+      endian :big
+
+      bit7 :tlv_type, :value => 1
+      bit9 :tlv_info_length, :value => lambda { subtype.num_bytes + chassis_id.length }
+      uint8 :subtype, :initial_value => 7
+      string :chassis_id, :read_length => lambda { tlv_info_length - subtype.num_bytes }
+
+
+      def get
+        tmp_chassis_id = chassis_id
+
+        case subtype
+        when 4
+          mac_address
+        when 7
+          BinData::Uint64be.read tmp_chassis_id
+        else
+          tmp_chassis_id
+        end
+      end
+
+
+      def set value
+        self.chassis_id = if value.kind_of?( Fixnum ) and subtype == 7
+                            BinData::Uint64be.new( value ).to_binary_s
+                          else
+                            value
+                          end
+      end
+
+
+      ##########################################################################
+      private
+      ##########################################################################
+
+
+      def mac_address
+        chassis_id.unpack( "C6" ).collect { | each | "%02x" % each }.join( "" ).hex
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/end-of-lldpdu-value.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # End Of LLDPDU
+    class EndOfLldpduValue < BinData::Record
+      endian :big
+
+      stringz :tlv_info_string, :length => 0, :value => ""
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/frame.rb

@@ -0,0 +1,38 @@
+require "rubygems"
+require "bindata"
+
+require "pio/lldp/chassis-id-tlv"
+require "pio/lldp/mac-address"
+require "pio/lldp/optional-tlv"
+require "pio/lldp/port-id-tlv"
+require "pio/lldp/ttl-tlv"
+
+
+module Pio
+  class Lldp
+    # LLDP frame
+    class Frame < BinData::Record
+      endian :big
+
+      mac_address :destination_mac
+      mac_address :source_mac
+      uint16 :ethertype, :value => 0x88cc
+      chassis_id_tlv :chassis_id
+      port_id_tlv :port_id
+      ttl_tlv :ttl, :initial_value => 120
+      array :optional_tlv, :type => :optional_tlv, :read_until => lambda { element.end_of_lldpdu? }
+
+
+      def dpid
+        chassis_id
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/mac-address.rb

@@ -0,0 +1,28 @@
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # MAC address
+    class MacAddress < BinData::Primitive
+      array :octets, :type => :uint8, :initial_length => 6
+
+
+      def set value
+        self.octets = value.split( /:/ ).collect { | each | each.hex }
+      end
+
+
+      def get
+        octets.inject( "" ) { | str, each | str + ( "%02x" % each ) }.hex
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/management-address-value.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # TLV value field of management address TLV
+    class ManagementAddressValue < BinData::Record
+      endian :big
+
+      stringz :management_address
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/optional-tlv.rb

@@ -0,0 +1,73 @@
+require "pio/lldp/port-description-value"
+require "pio/lldp/system-name-value"
+require "pio/lldp/system-description-value"
+require "pio/lldp/system-capabilities-value"
+require "pio/lldp/management-address-value"
+require "pio/lldp/end-of-lldpdu-value"
+
+
+module Pio
+  class Lldp
+    # Optional TLV and End Of LLDPDU
+    class OptionalTlv < BinData::Record
+      endian :big
+
+      bit7 :tlv_type
+      bit9 :tlv_info_length
+      choice :tlv_value,
+             :read_length => :tlv_info_length,
+             :onlyif => lambda { not end_of_lldpdu? },
+             :selection => :chooser do
+        end_of_lldpdu_value 0
+        port_description_value 4
+        system_name_value 5
+        system_description_value 6
+        system_capabilities_value 7
+        management_address_value 8
+        string "unknown"
+      end
+
+
+      def end_of_lldpdu?
+        tlv_type == 0
+      end
+
+
+      def chooser
+        if valid_optional_tlv?
+          tlv_type
+        else
+          "unknown"
+        end
+      end
+
+
+      ##########################################################################
+      private
+      ##########################################################################
+
+
+      def valid_optional_tlv?
+        optional_tlv? or end_of_lldpdu_tlv?
+      end
+
+
+      def optional_tlv?
+        tmp_tlv_type = tlv_type
+        4 <= tmp_tlv_type and tmp_tlv_type <= 8
+      end
+
+
+      def end_of_lldpdu_tlv?
+        tlv_type == 0
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/port-description-value.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # TLV value field of port description TLV
+    class PortDescriptionValue < BinData::Record
+      endian :big
+
+      stringz :port_description
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/pio/lldp/port-id-tlv.rb

@@ -0,0 +1,44 @@
+require "rubygems"
+require "bindata"
+
+
+module Pio
+  class Lldp
+    # Port ID TLV
+    class PortIdTlv < BinData::Primitive
+      endian :big
+
+      bit7 :tlv_type, :value => 2
+      bit9 :tlv_info_length, :initial_value => lambda { port_id.num_bytes + 1 }
+      uint8 :subtype, :initial_value => 7
+      string :port_id, :read_length => lambda { tlv_info_length - 1 }
+
+
+      def get
+        tmp_id = port_id
+
+        if subtype == 7
+          BinData::Uint32be.read tmp_id
+        else
+          tmp_id
+        end
+      end
+
+
+      def set value
+        self.port_id = if value.kind_of?( Fixnum ) and subtype == 7
+                         BinData::Uint32be.new( value ).to_binary_s
+                       else
+                         value
+                       end
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: