flaw_detector 0.0.1 → 0.1.0

data/ext/insns_ext/insns/2.0/vm_core_subset.h

@@ -0,0 +1,43 @@
+#ifndef VM_CORE_SUBSET_H
+#define VM_CORE_SUBSET_H
+
+/* to avoid warning */
+struct rb_thread_struct;
+struct rb_control_frame_struct;
+typedef int rb_iseq_t;
+typedef int rb_method_entry_t;
+
+/* rb_call_info_t contains calling information including inline cache */
+typedef struct rb_call_info_struct {
+    /* fixed at compile time */
+    ID mid;
+    VALUE flag;
+    int orig_argc;
+    rb_iseq_t *blockiseq;
+
+    /* inline cache: keys */
+    VALUE vmstat;
+    VALUE klass;
+
+    /* inline cache: values */
+    const rb_method_entry_t *me;
+    VALUE defined_class;
+
+    /* temporary values for method calling */
+    int argc;
+    struct rb_block_struct *blockptr;
+    VALUE recv;
+    union {
+	int opt_pc; /* used by iseq */
+	long index; /* used by ivar */
+	int missing_reason; /* used by method_missing */
+	int inc_sp; /* used by cfunc */
+    } aux;
+
+    VALUE (*call)(struct rb_thread_struct *th, struct rb_control_frame_struct *cfp, struct rb_call_info_struct *ci);
+} rb_call_info_t;
+typedef rb_call_info_t *CALL_INFO;
+
+#define VM_CALL_ARGS_BLOCKARG   (0x01 << 2) //copy from vm_core.h
+
+#endif /* VM_CORE_SUBSET_H */

data/flaw_detector.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["dbc.ginriki@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{The tool to detect code's flaw with static analysis}
-  s.description = %q{The tool detects code's flaw, which should be fixed, with static analysis of RubyVM bytecode. Therefore, it works for only ruby 1.9.x. ASAP, I will support ruby 2.0.x .}
+  s.description = %q{The tool detects code's flaw, which should be fixed, with static analysis of RubyVM bytecode. Therefore, it works for only ruby 1.9.x or 2.0.x .}
 
   s.rubyforge_project = "flaw detector"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.extensions                = ["ext/insns_ext/extconf.rb"]
-  s.required_ruby_version = "~> 1.9.0"
+  s.required_ruby_version = "> 1.9.0"
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"

data/lib/flaw_detector.rb

@@ -6,6 +6,7 @@ require "flaw_detector/detector/nil_false_path_flow"
 require "flaw_detector/code_model/code_document"
 require "flaw_detector/code_model/insns_frame"
 require "flaw_detector/code_model/cfg_node"
+require "flaw_detector/iseq/instruction_container"
 require File.expand_path("../../ext/insns_ext/insn_ext.rb", __FILE__)
 
 module FlawDetector
@@ -29,9 +30,17 @@ module FlawDetector
   INSNS_OF_BRANCH = ["branchif", "branchunless"]
   
   def parse(code_str, filepath="<compiled>")
-    isqns = RubyVM::InstructionSequence.new(code_str)
-    data = iseq_parse(isqns.to_a)
-    CodeDocument.create(data, filepath)
+    tmp_compile_option = RubyVM::InstructionSequence.compile_option
+    doc = nil
+    begin
+      RubyVM::InstructionSequence.compile_option = false
+      isqns = RubyVM::InstructionSequence.compile(code_str)
+      data = iseq_parse(isqns.to_a)
+      doc = CodeDocument.create(data, filepath)
+    ensure
+      RubyVM::InstructionSequence.compile_option = tmp_compile_option
+    end
+    return doc
   end
 
   def parse_file(file)
@@ -81,16 +90,15 @@ module FlawDetector
     iseq[13].each do |mixed|
       case mixed
       when Array # instruction
-        insns << mixed
+        insns << Iseq::InstructionContainer.new(mixed, header)
         opcode = mixed.first.to_s
         if INSNS_HAVE_ISEQ_IN_OPERAND.keys.include?(opcode)
-          operand_num = INSNS_HAVE_ISEQ_IN_OPERAND[opcode]
-          iseq_in_operand = iseq_parse(mixed[operand_num])
+          iseq_in_operand = iseq_parse(insns.last[:blockptr])
           insn_pos = insns.count-1
           insns_pos_to_operand_iseq[insn_pos] = iseq_in_operand
           
           #replace to link
-          mixed[operand_num] = insn_pos
+          #mixed[operand_num] = insn_pos
           
           if insns_pos_to_operand_iseq[insn_pos] &&
               insns_pos_to_operand_iseq[insn_pos][:header][:type] == ISeqHeader::TYPE_BLOCK

data/lib/flaw_detector/detector/nil_false_path_flow.rb

@@ -42,13 +42,13 @@ module FlawDetector
             klass_specified_edge = nil
             case obj_insn[0]
             when :send
-              if argnum == 0 && RCEV_KLASS_OF_METHODS.has_key?(obj_insn[1]) #varnum is the receiver and method is a nil check
+              if argnum == 0 && RCEV_KLASS_OF_METHODS.has_key?(obj_insn[:mid]) #varnum is the receiver and method is a nil check
                 next_obj_index,next_argnum = frame.find_use_insn_index_of_ret(obj_index, obj_insn)
                 next_obj_insn = frame.raw_block_data[:body][:insns][next_obj_index]
                 case next_obj_insn[0]
                 when :branchif, :branchunless
-                  klass_specified_edge = RCEV_KLASS_OF_METHODS[obj_insn[1]][:message][next_obj_insn[0]]
-                  klass = RCEV_KLASS_OF_METHODS[obj_insn[1]][:klass]
+                  klass_specified_edge = RCEV_KLASS_OF_METHODS[obj_insn[:mid]][:message][next_obj_insn[0]]
+                  klass = RCEV_KLASS_OF_METHODS[obj_insn[:mid]][:klass]
                 end
               end
             when :branchif, :branchunless
@@ -120,8 +120,10 @@ module FlawDetector
         return result
       end
 
-      # _variable_ :: nil variable on node
-      # return: check_end?, detected ngs
+      # @param variable [Hash] nil variable on node
+      # @return [Boolean] check_end?
+      # @return [Array] detected ngs
+      # @todo remove false positive detection of neither compareable or replacement operator such as "<<"
       def check_nil_var_ref(node, variable)
         ng_list = [] # each element has keys: {:variable, :index, :frame}
         unless node.prev_nodes.first == node.prev_nodes.last
@@ -147,8 +149,8 @@ module FlawDetector
               use_insn = frame.insns[use_index]
               case use_insn[0]
               when :send
-                use_insn[1]
-                if use_argnum == 0 && !NIL_METHODS.include?(use_insn[1])
+                if (use_argnum == 0 && !NIL_METHODS.include?(use_insn[:mid])) ||
+                    (use_argnum == 1 && CALC_CODE.values.include?(use_insn[:mid]) && !NIL_METHODS.include?(use_insn[:mid]))
                   ng_list << {:variable => variable, :index => use_index, :frame => frame}
                 end
               when *(CALC_CODE.keys)

data/lib/flaw_detector/iseq/instruction_container.rb

@@ -0,0 +1,83 @@
+module FlawDetector
+  module Iseq
+    class InstructionContainer
+      attr_reader :insn
+      def initialize(insn, header)
+        @insn = insn
+        @major_version = header[:major]
+      end
+
+      def major_version
+        @major_version
+      end
+
+      def inspect
+        @insn.inspect
+      end
+      
+      def [](param)
+        case param
+        when Fixnum
+          return @insn[param]
+        when Range
+          return @insn[param]
+        when Symbol
+          if param == :opcode
+            return @insn[0]
+          else
+            return send("symbol_#{self[:opcode]}_v#{self.major_version}", param)
+          end
+        else
+          raise "unknown param:#{param}"
+        end
+      end
+
+      private
+
+      def symbol_send_v1(param)
+        case param
+        when :mid
+          return @insn[1]
+        when :blockptr
+          return @insn[3]
+        end
+      end
+
+      def symbol_send_v2(param)
+        case param
+        when :mid
+          return @insn[1][:mid]
+        when :blockptr
+          return @insn[1][:blockptr]
+        else
+          return symbol_send_v1(param)
+        end
+      end
+
+      def symbol_putiseq_v1(param)
+        case param
+        when :blockptr
+          return @insn[1]
+        end
+      end
+
+      def symbol_defineclass_v1(param)
+        case param
+        when :blockptr
+          return @insn[2]
+        end
+      end
+
+      def symbol_invokesuper_v1(param)
+        case param
+        when :blockptr
+          return @insn[2]
+        end
+      end
+
+      alias :symbol_invokesuper_v2 :symbol_invokesuper_v1
+      alias :symbol_putiseq_v2 :symbol_putiseq_v1
+      alias :symbol_defineclass_v2 :symbol_defineclass_v1
+    end
+  end
+end

data/lib/flaw_detector/message.rb

@@ -11,9 +11,9 @@ module FlawDetector
       :details => "This method contains a redundant check of a known false value against the constant false."
     },
     "RCN_REDUNDANT_FALSECHECK_OF_TRUE_VALUE" => {
-      :short_desc => "Redundant falsecheck of value known to be false",
-      :long_desc => "Redundant falsecheck of %{0} which is known to be false in LINE:%{1}",
-      :details => "This method contains a redundant check of a known false value against the constant false."
+      :short_desc => "Redundant falsecheck of value known to be true",
+      :long_desc => "Redundant falsecheck of %{0} which is known to be true in LINE:%{1}",
+      :details => "This method contains a redundant check of a true value against the constant false."
     },
     "NP_ALWAYS_FALSE" => {
       :short_desc => "False value missing method received",

data/lib/flaw_detector/version.rb

@@ -1,3 +1,3 @@
 module FlawDetector
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,38 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: flaw_detector
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Rikiya Ayukawa
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: The tool detects code's flaw, which should be fixed, with static analysis of RubyVM bytecode. Therefore, it works for only ruby 1.9.x. ASAP, I will support ruby 2.0.x .
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The tool detects code's flaw, which should be fixed, with static analysis
+  of RubyVM bytecode. Therefore, it works for only ruby 1.9.x or 2.0.x .
+email:
 - dbc.ginriki@gmail.com
-executables: 
+executables:
 - flaw_detector
-extensions: 
+extensions:
 - ext/insns_ext/extconf.rb
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -42,9 +43,15 @@ files:
 - bin/flaw_detector
 - ext/insns_ext/extconf.rb
 - ext/insns_ext/insn_ext.rb
-- ext/insns_ext/insns.inc
-- ext/insns_ext/insns_ext.c
-- ext/insns_ext/insns_info.inc
+- ext/insns_ext/insns/1.9/BSDL
+- ext/insns_ext/insns/1.9/insns.inc
+- ext/insns_ext/insns/1.9/insns_ext.c
+- ext/insns_ext/insns/1.9/insns_info.inc
+- ext/insns_ext/insns/2.0/BSDL
+- ext/insns_ext/insns/2.0/insns.inc
+- ext/insns_ext/insns/2.0/insns_ext.c
+- ext/insns_ext/insns/2.0/insns_info.inc
+- ext/insns_ext/insns/2.0/vm_core_subset.h
 - flaw_detector.gemspec
 - lib/flaw_detector.rb
 - lib/flaw_detector/code_model/cfg_node.rb
@@ -54,39 +61,35 @@ files:
 - lib/flaw_detector/detector/abstract_detector.rb
 - lib/flaw_detector/detector/nil_false_path_flow.rb
 - lib/flaw_detector/formatter/csv_formatter.rb
+- lib/flaw_detector/iseq/instruction_container.rb
 - lib/flaw_detector/message.rb
 - lib/flaw_detector/version.rb
 - sample/flaw_in_code.rb
 - spec/lib/flaw_detector_spec.rb
 - spec/spec_helper.rb
-homepage: ""
+homepage: ''
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ~>
-    - !ruby/object:Gem::Version 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
       version: 1.9.0
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: flaw detector
-rubygems_version: 1.8.12
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: The tool to detect code's flaw with static analysis
-test_files: 
+test_files:
 - spec/lib/flaw_detector_spec.rb
 - spec/spec_helper.rb
-has_rdoc: