initial commit

11 files changed, 400 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..fc5bd90
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/pkg
diff --git a/GNUmakefile b/GNUmakefile
new file mode 100644
index 0000000..6eb2be0
--- /dev/null
+++ b/GNUmakefile
@@ -0,0 +1,19 @@
+
+all: ext/mall/mall.so
+
+ext/mall/Makefile: ext/mall/mall.c ext/mall/extconf.rb
+        cd ext/mall && ruby extconf.rb
+
+ext/mall/mall.so: ext/mall/Makefile
+        $(MAKE) -C ext/mall
+
+ext/mall/mall.c: ext/mall/mall.c.erb
+        erb < $< > $@+
+        mv $@+ $@
+clean:
+        -$(MAKE) -C ext/mall clean
+
+test: ext/mall/mall.so
+        ruby -Iext/mall -rmall test/test_mall.rb
+
+.PHONY: test
diff --git a/History.txt b/History.txt
new file mode 100644
index 0000000..df659f2
--- /dev/null
+++ b/History.txt
@@ -0,0 +1,5 @@
+=== 0.0.1 / 2009-06-02
+
+* 1 major enhancement
+
+  * initial release
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..cca7fc2
--- /dev/null
+++ b/LICENSE.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.
diff --git a/Manifest.txt b/Manifest.txt
new file mode 100644
index 0000000..c5d3a4e
--- /dev/null
+++ b/Manifest.txt
@@ -0,0 +1,10 @@
+GNUmakefile
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+ext/mall/.gitignore
+ext/mall/extconf.rb
+ext/mall/mall.c.erb
+test/test_mall.rb
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..2e8d86b
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,74 @@
+= Mall - access the mallinfo(3) and mallopt(3) functions
+
+* http://bogomips.org/mall
+
+== DESCRIPTION:
+
+This library provides access to the mallinfo(3) and mallopt(3)
+functions.  mallinfo(3) is used for reporting malloc statistics and
+mallopt(3) can be used to tune malloc(3) implementations.  See the
+corresponding documentation for the C library functions before
+proceeding.
+
+These functions are implementation-specific, so tuning options that
+work for one implementation of malloc may not work at all for another
+implementation.
+
+Constants defined in the the malloc.h header with a "M_" prefix are
+defined without the prefix in the Mall namespace (e.g. "M_TRIM_THRESHOLD
+=> Mall::TRIM_THRESHOLD).
+
+
+== FEATURES/PROBLEMS:
+
+* This has only been tested with glibc (ptmalloc2) malloc, although
+  it is likely to work with ptmalloc3.  Reports of success/failure
+  on other systems are greatly appreciated.
+
+* Mall.info does not work reliably when your application using more
+  than 2G of memory (this is probably a bad idea anyways).
+
+* Neither Mall.info nor Mall.opt are supported by all malloc
+  implementations, nor are all constants always defined or useful
+  if they're defined.
+
+* Constants and functionality are defined at build time, so changing
+  your malloc implementation may require rebuilding and reinstalling
+  this library.
+
+== SYNOPSIS:
+
+  # Assuming a glibc/ptmalloc system:
+
+  require 'mall'
+
+  Mall.opt(Mall::TRIM_THRESHOLD, 1024*1024)
+  Mall.opt(Mall::TOP_PAD, 1024*1024)
+  Mall.opt(Mall::MXFAST, 80)
+
+  hash = Mall.info
+
+== REQUIREMENTS:
+
+* A malloc implementation supporting mallinfo(3) and/or mallopt(3).
+
+== INSTALL:
+
+* gem install mall
+
+== LICENSE:
+
+Copyright (C) 2009 Eric Wong <normalperson@yhbt.net>
+
+Mall 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, version 3.0
+
+Mall 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 the GNU C Library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
diff --git a/Rakefile b/Rakefile
new file mode 100644
index 0000000..723c794
--- /dev/null
+++ b/Rakefile
@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'hoe'
+
+Hoe.new('mall', '0.0.1') do |p|
+  p.rubyforge_name = 'qrp'
+  p.developer('Eric Wong', 'normalperson@yhbt.net')
+  p.spec_extras = { :extensions => ['ext/mall/extconf.rb'] }
+end
diff --git a/ext/mall/.gitignore b/ext/mall/.gitignore
new file mode 100644
index 0000000..b170619
--- /dev/null
+++ b/ext/mall/.gitignore
@@ -0,0 +1,5 @@
+Makefile
+mall.c
+*.log
+*.o
+*.so
diff --git a/ext/mall/extconf.rb b/ext/mall/extconf.rb
new file mode 100644
index 0000000..c11d28f
--- /dev/null
+++ b/ext/mall/extconf.rb
@@ -0,0 +1,16 @@
+require 'mkmf'
+
+st_r = File.stat('mall.c.erb')
+st_c = File.stat('mall.c') rescue nil
+if st_c.nil? || st_c.ctime < st_r.ctime
+  require 'erb'
+  File.open('mall.c+', 'wb') { |fp|
+    fp.syswrite(ERB.new(File.read('mall.c.erb')).result)
+  }
+  File.rename('mall.c+', 'mall.c')
+end
+
+have_header('malloc.h') or abort "malloc.h header missing"
+have_type('struct mallinfo', 'malloc.h') or warn 'struct mallinfo missing'
+dir_config('mall')
+create_makefile('mall')
diff --git a/ext/mall/mall.c.erb b/ext/mall/mall.c.erb
new file mode 100644
index 0000000..aeef74f
--- /dev/null
+++ b/ext/mall/mall.c.erb
@@ -0,0 +1,76 @@
+#include <ruby.h>
+#include <malloc.h>
+
+static VALUE cMall;
+
+/*
+ * struct mallinfo {
+ *        int arena;    // non-mmapped space allocated from system
+ *        int ordblks;  // number of free chunks
+ *        int smblks;   // number of fastbin blocks
+ *        int hblks;    // number of mmapped regions
+ *        int hblkhd;   // space in mmapped regions
+ *        int usmblks;  // maximum total allocated space
+ *        int fsmblks;  // space available in freed fastbin blocks
+ *        int uordblks; // total allocated space
+ *        int fordblks; // total free space
+ *        int keepcost; // top-most, releasable (via malloc_trim) space
+ * };
+ */
+
+
+static VALUE info(VALUE klass)
+{
+        VALUE rv = rb_hash_new();
+        struct mallinfo stats = mallinfo(); /* whee aggregate returns :( */
+
+#define MALLINFO_SET(KEY) \
+        rb_hash_aset(rv, ID2SYM(rb_intern(#KEY)), INT2FIX(stats.KEY))
+
+        MALLINFO_SET(arena);
+        MALLINFO_SET(ordblks);
+        MALLINFO_SET(smblks);
+        MALLINFO_SET(hblks);
+        MALLINFO_SET(hblkhd);
+        MALLINFO_SET(usmblks);
+        MALLINFO_SET(fsmblks);
+        MALLINFO_SET(uordblks);
+        MALLINFO_SET(fordblks);
+        MALLINFO_SET(keepcost);
+
+#undef MALLINFO_SET
+
+        return rv;
+}
+
+/*
+ * some malloc implementations may not like mallopt() being called after
+ * malloc has been initialized (first call to malloc()).  This is not
+ * the case with glibc malloc.
+ */
+static VALUE opt(VALUE klass, VALUE param, VALUE value)
+{
+        int rv = mallopt(FIX2INT(param), FIX2INT(value));
+
+        return rv == 0 ? Qfalse : Qtrue;
+}
+
+void Init_mall(void)
+{
+        cMall = rb_define_class("Mall", rb_cObject);
+        rb_define_singleton_method(cMall, "opt", opt, 2);
+        rb_define_singleton_method(cMall, "info", info, 0);
+
+<% %w(
+mxfast nlblks grain keep
+trim_threshold top_pad mmap_threshold mmap_max
+check_action perturb
+).each { |opt|
+  opt.upcase!
+  m_opt = "M_#{opt}"
+%>
+#ifdef <%= m_opt %>
+        rb_define_const(cMall, "<%= opt %>", INT2FIX(<%= m_opt %>));
+#endif /* <%= m_opt %> */
+<% } %>
+}
diff --git a/test/test_mall.rb b/test/test_mall.rb
new file mode 100644
index 0000000..437b619
--- /dev/null
+++ b/test/test_mall.rb
@@ -0,0 +1,21 @@
+require "test/unit"
+require "mall"
+
+class TestMall < Test::Unit::TestCase
+
+  def test_mallinfo
+    assert Hash === Mall.info
+    Mall.info.each { |key,value|
+      assert Symbol === key
+      assert Fixnum === value
+    }
+  end
+
+  def test_mallopt
+    Mall.constants.each { |konst|
+      rv = Mall.opt(Mall.const_get(konst), 0)
+      assert(TrueClass === rv || FalseClass === rv)
+    }
+  end
+
+end