segv-handler-gdb 1.0.0

data/.yardopts

@@ -0,0 +1,4 @@
+--output-dir doc/reference/en
+--files doc/text/*.*
+lib/**/*.rb
+ext/**/*.c

data/Gemfile

@@ -0,0 +1,20 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,3 @@
+# License
+
+LGPLv3 or later. See doc/text/lgpl-3.txt for details.

data/README.md

@@ -0,0 +1,86 @@
+# README
+
+segv-handler-gdb is a gem for debugging C extension that causes
+SEGV. It dumps C level backtrace by GDB on SEGV. If your C extension
+is built with `gcc -O0 -g3`, the backtrace includes useful information
+for debug.
+
+## Supported platform
+
+segv-handler-gdb works on Linux. It may also work on other POSIX
+systems such as FreeBSD and OS X but it is not tested yet.
+
+Here is a list of supported platform:
+
+  * Debian GNU/Linux
+  * (If you confirm that segv-handler-gdb works on your platform,
+    please report it.)
+
+## Requirments
+
+Here is a list of required programs:
+
+  * gdb
+
+## Install
+
+    % gem install segv-handler-gdb
+
+## Usage
+
+You just require segv-handler-gdb library like the following:
+
+    require "segv-handler-gdb"
+
+You can use segv-handler-gdb without changing your Ruby script:
+
+    % ruby -rsegv-handler-gdb YOUR-RUBY-SCRIPT.rb
+
+If your Ruby script crashes, you find C level backtrace at
+`/tmp/segv-handler-gdb.#{Process.pid}.log`.
+
+## Customization
+
+You can customize segv-handler-gdb behavior by some environment
+variables.
+
+### Backtrace dump path
+
+Backtrace is dumped to `/tmp/segv-handler-gdb.#{Process.pid}.log` by
+default. You can customize the path by `SEGV_HANDLER_GDB_PATH`
+environment variable.
+
+There are some special values for the environment variable:
+
+  * `-`: Backtrace is dumped to the standard output.
+  * `+`: Backtrace is dumped to the standard error output.
+
+Here is a sample command line to dump backtrace to the standard
+output:
+
+    % SEGV_HANDLER_GDB_PATH=- ruby -rsegv-handlder-gdb YOUR-RUBY-SCRIPT.rb
+
+### Temporary directory path
+
+segv-handler-gdb creates a temporary file to temporary
+directory. `/tmp` directory is used as the temporary directory by
+default. You can customize the temporary directory by the following
+environment variables:
+
+  * `TMPDIR`
+  * `TMP`
+  * `TEMP`
+
+The order of the above list shows priority. If `TMPDIR` is specified,
+`TMP` is not used.
+
+If all of these environment variables aren't specified, `/tmp` is used
+as the temporary directory.
+
+## Author
+
+  * Kouhei Sutou \<kou@clear-code.com\>
+
+## License
+
+LGPLv3 or later. See doc/text/lgpl-3.txt for details.

data/Rakefile

@@ -0,0 +1,26 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bundler/gem_helper"
+
+base_dir = File.dirname(__FILE__)
+
+helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
+end
+helper.install

data/doc/text/lgpl-3.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/ext/segv-handler-gdb/extconf.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "mkmf"
+
+create_makefile("segv_handler_gdb")

data/ext/segv-handler-gdb/segv-handler-gdb.c

@@ -0,0 +1,198 @@
+/* -*- coding: utf-8; mode: C; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+  Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include <ruby.h>
+
+#include <stdio.h>
+#include <signal.h>
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <errno.h>
+
+#define MESSAGE_BUFFER_SIZE 4096
+
+typedef int shg_bool;
+
+#define SHG_TRUE  (!SHG_FALSE)
+#define SHG_FALSE (0)
+
+static struct sigaction original_segv_action;
+
+static const char *
+temporary_diretory_path (void)
+{
+    const char *path = NULL;
+
+    if (!path) {
+        path = getenv("TMPDIR");
+    }
+    if (!path) {
+        path = getenv("TMP");
+    }
+    if (!path) {
+        path = getenv("TEMP");
+    }
+    if (!path) {
+        path = "/tmp";
+    }
+
+    return path;
+}
+
+static void
+print_system_error (int output_fd, const char *message)
+{
+    FILE *output;
+    output = fdopen(dup(output_fd), "w");
+    fprintf(output, "%s: %s\n", message, strerror(errno));
+    fclose(output);
+}
+
+static shg_bool
+create_gdb_command_file (char *gdb_command_path, int output_fd)
+{
+    int gdb_command_fd;
+    const char *gdb_command =
+        "thread apply all backtrace full\n"
+        "quit\n";
+    ssize_t written;
+
+    gdb_command_fd = mkstemp(gdb_command_path);
+    if (gdb_command_fd == -1) {
+        print_system_error(output_fd,
+                           "[segv-handler-gdb] failed to create temporary file");
+        return SHG_FALSE;
+    }
+
+    written = write(gdb_command_fd, gdb_command, strlen(gdb_command));
+    close(gdb_command_fd);
+
+    if (written == -1) {
+        print_system_error(output_fd,
+                           "[segv-handler-gdb] failed to write GDB command");
+        unlink(gdb_command_path);
+        return SHG_FALSE;
+    }
+
+    return SHG_TRUE;
+}
+
+static void
+run_gdb (const char *gdb_command_path, int output_fd)
+{
+    pid_t gdb_pid;
+
+    gdb_pid = fork();
+    if (gdb_pid == 0) {
+        char target_pid[256];
+        sprintf(target_pid, "%u", getppid());
+        dup2(output_fd, STDOUT_FILENO);
+        dup2(output_fd, STDERR_FILENO);
+        execlp("gdb",
+               "gdb",
+               "--batch",
+               "--command", gdb_command_path,
+               "--pid", target_pid,
+               NULL);
+        _exit(EXIT_FAILURE);
+    } else if (gdb_pid == -1) {
+        print_system_error(output_fd,
+                           "[segv-handler-gdb] failed to fork gdb");
+    } else {
+        int status;
+        int options = 0;
+        waitpid(gdb_pid, &status, options);
+    }
+}
+
+static void
+show_gdb_backtrace (void)
+{
+    const char *segv_handler_gdb_path;
+    char segv_handler_gdb_path_default[PATH_MAX];
+    char gdb_command_path[PATH_MAX];
+    int output_fd;
+    shg_bool output_fd_need_close = SHG_FALSE;
+
+    sprintf(gdb_command_path,
+            "%s/segv-handler-gdb-XXXXXX",
+            temporary_diretory_path());
+    segv_handler_gdb_path = getenv("SEGV_HANDLER_GDB_PATH");
+    if (!segv_handler_gdb_path) {
+        sprintf(segv_handler_gdb_path_default,
+                "%s/segv-handler-gdb.%u.log",
+                temporary_diretory_path(),
+                getpid());
+        segv_handler_gdb_path = segv_handler_gdb_path_default;
+    }
+    if (strcmp(segv_handler_gdb_path, "-") == 0) {
+        output_fd = STDOUT_FILENO;
+    } else if (strcmp(segv_handler_gdb_path, "+") == 0) {
+        output_fd = STDERR_FILENO;
+    } else {
+        output_fd = open(segv_handler_gdb_path,
+                         O_WRONLY | O_CREAT | O_APPEND,
+                         S_IRUSR | S_IWUSR);
+        if (output_fd == -1) {
+            char message[MESSAGE_BUFFER_SIZE];
+            snprintf(message,
+                     MESSAGE_BUFFER_SIZE,
+                     "[segv-handler-gdb] failed to open output path. "
+                     "stderr is used instead: <%s>",
+                     segv_handler_gdb_path);
+            perror(message);
+            output_fd = STDERR_FILENO;
+        } else {
+            output_fd_need_close = SHG_TRUE;
+        }
+    }
+
+    if (create_gdb_command_file(gdb_command_path, output_fd)) {
+        run_gdb(gdb_command_path, output_fd);
+        unlink(gdb_command_path);
+    }
+
+    if (output_fd_need_close) {
+        close(output_fd);
+    }
+}
+
+static void
+show_gdb_backtrace_handler (int signum)
+{
+    show_gdb_backtrace();
+    if (sigaction(signum, &original_segv_action, NULL) == 0) {
+        kill(getpid(), signum);
+    }
+}
+
+void
+Init_segv_handler_gdb (void)
+{
+    struct sigaction segv_action;
+
+    segv_action.sa_handler = show_gdb_backtrace_handler;
+    sigemptyset(&(segv_action.sa_mask));
+    segv_action.sa_flags = 0;
+    if (sigaction(SIGSEGV, &segv_action, &original_segv_action) == -1) {
+        rb_sys_fail("[segv-handler-gdb] failed to set SEGV handler");
+    }
+}

data/lib/segv-handler-gdb.rb

@@ -0,0 +1,17 @@
+# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "segv_handler_gdb.so"
+require "segv-handler-gdb/version"

data/lib/segv-handler-gdb/version.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module SEGVHandlerGDB
+  VERSION = "1.0.0"
+end

data/segv-handler-gdb.gemspec

@@ -0,0 +1,51 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+base_dir = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift(File.join(base_dir, "lib"))
+require "segv-handler-gdb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "segv-handler-gdb"
+  spec.version = SEGVHandlerGDB::VERSION
+
+  spec.authors = ["Kouhei Sutou"]
+  spec.email = ["kou@clear-code.com"]
+
+  spec.summary = "Dump C level backtrace by GDB on SEGV"
+  spec.description = "It helps that you debug C extension that causes SEGV."
+
+  spec.files = ["README.md", "LICENSE.md", "Rakefile", "Gemfile", ".yardopts"]
+  spec.files += Dir.glob("doc/text/*.*")
+  spec.files += ["#{spec.name}.gemspec"]
+  Dir.chdir(base_dir) do
+    spec.files += Dir.glob("lib/**/*.rb")
+    spec.files += Dir.glob("ext/**/*.{c,rb}")
+    spec.extensions = ["ext/segv-handler-gdb/extconf.rb"]
+  end
+
+  spec.homepage = "https://github.com/kou/segv-handler-gdb"
+  spec.licenses = ["LGPLv3"]
+  spec.require_paths = ["lib", "ext/segv-handler-gdb"]
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("bundler")
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: segv-handler-gdb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kouhei Sutou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It helps that you debug C extension that causes SEGV.
+email:
+- kou@clear-code.com
+executables: []
+extensions:
+- ext/segv-handler-gdb/extconf.rb
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE.md
+- Rakefile
+- Gemfile
+- .yardopts
+- doc/text/lgpl-3.txt
+- segv-handler-gdb.gemspec
+- lib/segv-handler-gdb/version.rb
+- lib/segv-handler-gdb.rb
+- ext/segv-handler-gdb/segv-handler-gdb.c
+- ext/segv-handler-gdb/extconf.rb
+homepage: https://github.com/kou/segv-handler-gdb
+licenses:
+- LGPLv3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext/segv-handler-gdb
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Dump C level backtrace by GDB on SEGV
+test_files: []
+has_rdoc: