symsym 0.8.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "jeweler", "~> 1.6.0"
+end

data/Gemfile.lock

@@ -0,0 +1,15 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ulrich Zurucker
+
+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.

data/README.md

@@ -0,0 +1,42 @@
+# symsym Crashreport Desymbolizer for Mac OS X
+
+symsym is a tool for Mac OS X that allows to de-symbolize crashlogs.
+
+### Install
+
+    sudo gem install symsym
+
+## Usage
+
+symsym will look for a dSYM bundle that matches the bundle identifier, version and short version string found in the crashreport. It will run gdb to desymbolize the addresses in the given crashlog.
+The crashlog can be read from a file or from the Mac OS X pasteboard.
+Output can be to a file, the OS X pasteboard or stdout
+
+Use symsym from the command line:
+
+* -i read crashreport from given file
+* -o write de-symbolized crashreport to given file
+* -p read crashreport from pasteboard
+* -c write de-symbolized crashreport to pasteboard
+* -d The path where symsym will look for a matching .dSYM bundle - and of course in all subfolders of this path
+
+So when you want to replace the crashreport in your pasteboard with the de-symbolized version, go to a directory that contains your dSYM bundles, type
+
+    symsym -p -c
+
+and you are done!
+
+_Note:_ gdb needs the application bundle next to the dSYM bundle to be able to desymbolize the crashlog.
+
+## Issues/TODO
+
+* Read the architecture from the crashreport
+
+## Contribute
+
+* fork me on Github - [https://github.com/sononum/symsym](https://github.com/sononum/symsym)
+* send a pull request
+
+## Copyright
+
+Copyright (c) 2011 Ulrich Zurucker. See LICENSE.txt for further details.

data/README.rdoc

@@ -0,0 +1,25 @@
+= symsym
+
+symsym is a tool for Mac OS X that allows to de-symbolize crashlogs.
+
+=== Usage
+symsym will look for a dSYM bundle that matches the bundle identifier, version and short version string found in the crashreport. It will run gdb to desymbolize the addresses in the given crashlog.
+The crashlog can be read from a file or from the Mac OS X pasteboard.
+Output can be to a file, the OS X pasteboard or stdout
+
+Use symsym from the command line:
+  -i read crashreport from given file
+  -o write de-symbolized crashreport to given file
+  -p read crashreport from pasteboard
+  -c write de-symbolized crashreport to pasteboard
+  -d The path where symsym will look for a matching .dSYM bundle - and of course in all subfolders of this path
+
+== Issues/TODO
+
+* Read the architecture from the crashreport
+
+== Copyright
+
+Copyright (c) 2011 Ulrich Zurucker. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "symsym"
+  gem.homepage = "http://github.com/sononum/symsym"
+  gem.license = "MIT"
+  gem.summary = %Q{Crashlog symbolizer for Mac OS X}
+  gem.description = %Q{symsym can be used to symbolize crashlogs from dSYM files}
+  gem.email = "ulizurucker@googlemail.com"
+  gem.authors = ["Ulrich Zurucker"]
+  gem.executables = ["symsym"]
+  gem.default_executable = 'symsym'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "symsym #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/bin/symsym

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+require 'symsym'
+
+dsymsearchpath = nil
+
+options = {}
+options[:dsymsearchpath] = "."
+options[:reportfile] = nil
+options[:copypasteboard] = false
+options[:outputfile] = nil
+report = nil
+
+optparse = OptionParser.new do|opts|
+  opts.on('-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+  opts.on('-i FILE', "Read crashlog from FILE" ) do |p|
+    options[:reportfile] = p
+  end
+  opts.on('-o FILE', "Write symbolized crashlog to FILE") do |p|
+    options[:outputfile] = p
+  end
+  opts.on('-d FILE', "dSYM Search Path - the path where symsym should look for a matching dSYM bundle. If not given, look in ." ) do |p|
+    options[:dsymsearchpath] = p
+  end
+  opts.on('-p', '--pasteboard', "Use pasteboard content as report input") do
+    report = `pbpaste`
+  end
+  opts.on('-c', '--copypasteboard', "Copy the symbolized crashlog to pasteboard") do
+    options[:copypasteboard] = true
+  end
+end
+
+optparse.parse!
+
+unless report
+  reportfile = options[:reportfile]
+  if reportfile && File.exist?(reportfile)
+    report = File.new(reportfile).read
+  else
+    puts "No input crashlog given. Use --help for usage."
+  end
+end
+
+exit(1) unless report
+
+report = Crashreport.new(report, options[:dsymsearchpath])
+report.symbolicate!
+
+if (options[:copypasteboard])
+  IO.popen('pbcopy', 'r+').puts report.report
+end
+
+if (options[:outputfile])
+  File.new(options[:outputfile], 'w+').puts report.report
+end
+
+puts report.report unless options[:copypasteboard] || options[:outputfile]

data/lib/symsym.rb

@@ -0,0 +1,150 @@
+require 'osx/cocoa'
+require 'find'
+
+# DsymFile - wrapper around a .dSYM bundle
+#
+#
+class DsymFile
+  attr_reader :identifier, :version, :shortversionstring
+  
+  # Initializes a DsymFile with a path to a dSYM Bundle
+  #
+  # Extracts CFBundleIdentifier, CFBundleVersion and CFBundleShortVersionString from the Info.plist file inside the bundle
+  def initialize(filename)
+    @info_plist = OSX::NSDictionary.dictionaryWithContentsOfFile(File.join(filename, 'Contents/Info.plist'))
+    return unless @info_plist
+    @identifier         = @info_plist['CFBundleIdentifier'].to_s
+    @version            = @info_plist['CFBundleVersion'].to_s
+    @shortversionstring = @info_plist['CFBundleShortVersionString'].to_s
+    @filename = filename
+  end # initialize
+  
+  # Matches Report?
+  #
+  # Checks if the Bundle Identifier, Bundle Version and Bundle Short Version String of a given Crashreport matches to this dSYM Bundle
+  def matches_report?(report)
+    false
+    true if @identifier =~ /#{report.identifier}/ && @version == report.version && @shortversionstring == report.shortversion
+  end
+  
+  # return the filename
+  def to_s
+    @filename
+  end
+end # class DsymFile
+
+# Symbolized
+#
+# A symbol of the Crashreport that has been desymbolized with gdb
+class Symbolized
+  attr_reader :startaddress, :endaddress, :line, :symbol, :filename
+  # Initialize with an output line from gdb. This will extract the addresses, linenumber and source-file
+  def initialize(s)
+    s.gsub(/Line (\d*) of "(.*)" starts at address (0x[0-9a-f]*) <(.*)> and ends at (0x[0-9a-f]*)/).to_a
+    @line = $1
+    @filename = $2
+    @startaddress = $3.hex if $3
+    @symbol = $4
+    @endaddress = $5.hex if $3
+  end
+end
+
+# A class representing a crashreport
+#
+# This must be initialized with the crashreport as plain text, a path where to look for .dSYM bundlles can be given.
+# The report can be de-symbolized with symbolicate!
+class Crashreport
+  
+  @addresses = nil
+  @dsymfile = nil 
+  @isSymbolicated = false;
+  @cmdfilepath = nil;
+  
+  attr_reader :identifier, :version, :shortversion, :report
+  
+  # Extracts the address from a crashreport-line
+  def self.address_from_report_line(s)
+    a = s[/(0x[0-9a-f]+)/, 1]
+    return a.hex if a
+    nil
+  end
+  
+  # Creates a new Crashreport object
+  #
+  # r is the crash report as string. dsymfile is a path where this object will look for a matching .dSYM bundle
+  def initialize(r, dsymfile=nil)
+    @report = r
+    @dsymfile = dsymfile
+    @identifier         = @report[/Identifier: (.*)/, 1]
+    @shortversion       = @report[/Version: (.*) \((.*)\)/, 1]
+    @version            = @report[/Version: (.*) \((.*)\)/, 2]
+    findDysmFile(dsymfile)
+  end
+  
+  # Find dSYM Bundle
+  #
+  # Look for a matching dSYM bundle. Use the current directory when nil
+  def findDysmFile(searchpath)
+    Find.find(searchpath || '.') do |f|
+      if f =~ /.dSYM/
+        dsymfile = DsymFile.new(f)
+        if dsymfile.matches_report? self
+          @dsymfile = dsymfile
+          return
+        end
+      end
+    end
+  end
+  
+  # returns an array of all adresses found in the crashreport  
+  def addresses
+    return @addresses if @addresses
+    @addresses = []
+    @report.lines.each do |l|
+      a = Crashreport.address_from_report_line(l)
+      @addresses << a if a
+    end
+    @addresses
+  end
+  
+  # de-symbolizes the crashreport
+  #
+  # The get the report with .report aftwards
+  def symbolicate!
+    return if @isSymbolicated
+    buildgdbcommandfile
+    gdbout = rungdb
+    @symbols = []
+    gdbout.lines.each do |l|
+      @symbols << Symbolized.new(l)
+    end
+    
+    addresses.each do |a|
+      @symbols.each do |s|
+        if s.startaddress  && a >= s.startaddress && a <= s.endaddress
+          report.gsub!(/(0x.*#{a.to_s(16)}) (.*)/, "#{$1} #{s.symbol} (#{s.filename}:#{s.line})")
+        end # address matches
+      end # @symbols.each
+    end# addresses.each
+    @isSymbolicated = true
+  end # symbolicate!
+  
+  private
+  # runs gdb with the command file created by buildgdbcommandfile
+  def rungdb
+    gdbcmd = "gdb --batch --quiet -x \"#{@cmdfilepath}\" \"#{@dsymfile}\""
+    gdbout = `#{gdbcmd}`
+    gdbout
+  end
+  
+  # build a command-file for gdb
+  def buildgdbcommandfile
+    return if @cmdfilepath
+    @cmdfilepath = '/tmp/symsymcmd.txt'
+    cmdfile = File.new(@cmdfilepath, 'w+')
+    self.addresses.each do |l|
+      cmdfile << "info line *#{l}\n"
+    end
+    cmdfile.close
+  end # buildgdbcommandfile
+end # class Crashreport

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: symsym
+version: !ruby/object:Gem::Version 
+  hash: 63
+  prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
+platform: ruby
+authors: 
+- Ulrich Zurucker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-09 00:00:00 +02:00
+default_executable: symsym
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  name: jeweler
+  version_requirements: *id001
+description: symsym can be used to symbolize crashlogs from dSYM files
+email: ulizurucker@googlemail.com
+executables: 
+- symsym
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/symsym
+- lib/symsym.rb
+has_rdoc: true
+homepage: http://github.com/sononum/symsym
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Crashlog symbolizer for Mac OS X
+test_files: []
+