cumo 0.1.0

data/3rd_party/mkmf-cu/test/test_mkmf-cu.rb

@@ -0,0 +1,67 @@
+require "test/unit"
+require "mkmf-cu/opt"
+require "mkmf-cu"
+
+class TestMkmfCuOpt < Test::Unit::TestCase
+
+  def setup
+    @opt, @opt_h = build_optparser()
+  end
+
+  def test_opt
+    argv = ["-pipe", "-Os", "-x", "cu", "-O2", "-Wall", "-arch", "x86_64"]
+    parse_ill_short(argv, @opt_h)
+    assert_equal(["-Os", "-x", "cu", "-O2", "-Wall", "--arch", "x86_64"],
+                 argv)
+  end
+
+  def test_Gg
+    argv = ["-g", "-G"]
+    parse_ill_short(argv, @opt_h)
+    @opt.parse(argv)
+    assert_equal({"-g" => [""], "-G" => [""]}, @opt_h)
+  end
+
+  def test_compiler_option
+    @opt_h.merge!({"-shared"=>[""], "-pipe"=>[""]})
+    assert_equal(" --compiler-options -pipe", compiler_option(@opt_h))
+  end
+
+  def test_Wl
+    argv = ["-Wl,-headerpad_max_install_names", "-fstack-protector", "-L/opt/local/lib",
+            "-Wl,-undefined,dynamic_lookup", "-Wl,-multiply_defined,suppress"]
+    parse_ill_short_with_arg(argv, @opt_h)
+    assert_equal(["--Wl=-headerpad_max_install_names", "-fstack-protector", "-L/opt/local/lib",
+                  "--Wl=-undefined,dynamic_lookup", "--Wl=-multiply_defined,suppress"],
+                 argv)
+  end
+
+  def test_linker_option
+    @opt_h.merge!({"-Wl"=>["-a", "-b"]})
+    assert_equal(" --linker-options -a --linker-options -b",
+                 linker_option(@opt_h))
+  end
+
+  def test_std
+    argv = ["-std=c++11"]
+    parse_ill_short_with_arg(argv, @opt_h)
+    @opt.parse(argv)
+    assert_equal({"-std" => ["c++11"]}, @opt_h)
+  end
+
+  def test_compiler_bin
+    h = Hash.new{|h, k| h[k] = [] }.merge({"-shared"=>[""], "-pipe"=>[""], "--mkmf-cu-ext"=>["c"]})
+    assert_equal(" --compiler-bindir " + RbConfig::CONFIG["CC"],
+                 compiler_bin(h))
+  end
+
+  def test_mkmf_cu
+    assert MakeMakefile::C_EXT.include?("cu")
+    assert MakeMakefile::SRC_EXT.include?("cu")
+
+    treat_cu_as_cxx()
+    assert !MakeMakefile::C_EXT.include?("cu")
+    assert MakeMakefile::CXX_EXT.include?("cu")
+  end
+
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at sonots@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'test-unit'
+gem 'yard'
+gem 'pry-byebug'
+gem 'power_assert', git: 'https://github.com/k-tsj/power_assert'

data/LICENSE.txt

@@ -0,0 +1,82 @@
+BSD 3-Clause License
+
+Copyright (c) 2017 Naotoshi Seo
+
+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.
+
+######################################################################
+# The Cumo is a fork of Numo NArray v0.9.0.9.
+# Cumo's source code and documents contain the original Ruby/Numo ones.
+######################################################################
+BSD 3-Clause License
+
+Copyright (c) 1999-2017, Masahiro TANAKA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+######################################################################
+# The Cumo refers some implementations of CuPy such as memory pool.
+# Cumo's source code and documents contain the original CuPy ones.
+######################################################################
+MIT License
+
+Copyright (c) 2015 Preferred Infrastructure, Inc.
+Copyright (c) 2015 Preferred Networks, Inc.
+
+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,252 @@
+**This project is still under development. This project received grant from [Ruby Association Grant 2017](http://www.ruby.or.jp/ja/news/20171206).**
+
+# Cumo
+
+Cumo (pronounced like "koomo") is CUDA-aware numerical library whose interface is highly compatible with [Ruby Numo](https://github.com/ruby-numo).
+This library provides the benefit of speedup using GPU by replacing Numo with only a small piece of codes.
+
+
+## Requirements
+
+* Ruby 2.0 or later
+* NVIDIA GPU Compute Capability 6.0 (Pascal) or later
+* CUDA 9.0 or later
+
+## Preparation
+
+Install CUDA and setup environment variables as follows:
+
+```bash
+export CUDA_PATH="/usr/local/cuda"
+export CPATH="$CUDA_PATH/include:$CPATH"
+export LD_LIBRARY_PATH="$CUDA_PATH/lib64:$CUDA_PATH/lib:$LD_LIBRARY_PATH"
+export PATH="$CUDA_PATH/bin:$PATH"
+export LIBRARY_PATH="$CUDA_PATH/lib64:$CUDA_PATH/lib:$LIBRARY_PATH"
+```
+
+## Installation
+
+Add a following line to your Gemfile:
+
+```ruby
+gem 'cumo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cumo
+
+## How To Use
+
+### Quick start
+
+An example:
+
+```ruby
+[1] pry(main)> require "cumo/narray"
+=> true
+[2] pry(main)> a = Cumo::DFloat.new(3,5).seq
+=> Cumo::DFloat#shape=[3,5]
+[[0, 1, 2, 3, 4],
+ [5, 6, 7, 8, 9],
+ [10, 11, 12, 13, 14]]
+[3] pry(main)> a.shape
+=> [3, 5]
+[4] pry(main)> a.ndim
+=> 2
+[5] pry(main)> a.class
+=> Cumo::DFloat
+[6] pry(main)> a.size
+=> 15
+```
+
+### How to switch from Numo to Cumo
+
+Basically, following command should make it work with Cumo.
+
+```
+find . -type f | xargs sed -i -e 's/Numo/Cumo/g' -e 's/numo/cumo/g'
+```
+
+If you want to switch Numo and Cumo dynamically, following snippets should work:
+
+```ruby
+if gpu
+  require 'cumo/narray'
+  Xumo = Cumo
+else
+  require 'numo/narray'
+  Xumo = Numo
+end
+
+a = Xumo::DFloat.new(3,5).seq
+```
+
+### Incompatibility With Numo
+
+Following methods behave incompatibly with Numo as default for performance.
+
+* `extract`
+* `[]`
+* `count_true`
+* `count_false`
+
+Numo returns a Ruby numeric object for 0-dimensional NArray, but Cumo returns the 0-dimensional NArray instead of a Ruby numeric object.
+This is to avoid synchnoziation between CPU and GPU for performance.
+
+You may set `CUMO_COMPATIBLE_MODE=ON` environment variable to force Cumo NArray behave compatibly with Numo NArray.
+
+You may enable or disable `compatible_mode` as:
+
+```
+require 'cumo'
+Cumo.enable_compatible_mode # enable
+Cumo.compattible_mode_enabled? #=> true
+Cumo.disable_compatible_mode # disable
+Cumo.compattible_mode_enabled? #=> false
+```
+
+You can also use following methods which behaves as Numo NArray's methods. Behaviors of these methods do not depend on `compatible_mode`.
+
+* `extract_cpu`
+* `aref_cpu(*idx)`
+* `count_true_cpu`
+* `count_false_cpu`
+
+### Select a GPU device ID
+
+Set `CUDA_VISIBLE_DEVICES=id` environment variable, or
+
+```
+require 'cumo'
+Cumo::CUDA::Runtime.cudaSetDevice(id)
+```
+
+where `id` is an integer.
+
+### Disable GPU Memory Pool
+
+Set `CUMO_MEMORY_POOL=OFF` environment variable , or
+
+```
+require 'cumo'
+Cumo::CUDA::MemoryPool.disable
+```
+
+if you found GPU memory pool implementation has a bug.
+
+## Documentation
+
+See https://github.com/ruby-numo/numo-narray#documentation and replace Numo to Cumo.
+
+## Development
+
+Install ruby dependencies:
+
+```
+bundle install --path vendor/bundle
+```
+
+Compile:
+
+```
+bundle exec rake compile
+```
+
+Run tests:
+
+```
+bundle exec rake test
+```
+
+Generate docs:
+
+```
+bundle exec rake docs
+```
+
+## Source code organizations
+
+* `*_kernel.{h,cuh,cu}` files are for device (CUDA kernels).
+    * .cu files are compiled via nvcc.
+    * .cu files define C wrapper functions to launch CUDA kernels to enable to be called from .c files.
+    * Technically, it is not possible to use CRuby API such as `VALUE` in .cu files.
+        * CRuby API is not callable from CUDA kernel because they do not have `__device__` modifier.
+        * nvcc does not support `#include RUBY_EXTCONF_H`, so can not include `ruby.h`.
+    * (RULE) It is allowed to use C++14 codes in .cu files.
+* Rest of `*.{h,c}` files are for host (CPU).
+    * Call C wrapper functions defined in .cu files.
+    * It can use CRuby API.
+    * (RULE) It is not allowed to use C++ codes in host files.
+
+Ruby's `mkmf` (or `extconf.rb`) does not support to specify 3rd compiler such as NVCC for another files of extensions `.cu`.
+Therefore, cumo specify a wrapper command `bin/mkmf-cu-nvcc` as a compiler and changes its behavor depending on extensions of files to compile.
+
+## Advanced Tips on Development
+
+### ccache
+
+[ccache](https://ccache.samba.org/) would be useful to speedup compilation time.
+Install ccache and setup as:
+
+
+```bash
+export PATH="$HOME/opt/ccache/bin:$PATH"
+ln -sf "$HOME/opt/ccache/bin/ccache" "$HOME/opt/ccache/bin/gcc"
+ln -sf "$HOME/opt/ccache/bin/ccache" "$HOME/opt/ccache/bin/g++"
+ln -sf "$HOME/opt/ccache/bin/ccache" "$HOME/opt/ccache/bin/nvcc"
+```
+
+## Run tests only a specific line
+
+`--location` option is available as:
+
+```
+bundle exec ruby test/narray_test.rb --location 121
+```
+
+### Compile and run tests only a specific type
+
+`DTYPE` environment variable is available as:
+
+```
+bundle exec DTYPE=dfloat rake compile
+```
+
+```
+bundle exec DTYPE=dfloat ruby test/narray_test.rb
+```
+
+### Run tests with gdb
+
+Compile with debug option:
+
+```
+bundle exec DEBUG=1 rake compile
+```
+
+Run tests with gdb:
+
+```
+bundle exec gdb -x run.gdb --args ruby test/narray_test.rb
+```
+
+You may put a breakpoint by calling `cumo_debug_breakpoint()` at C source codes.
+
+### Run program always synchronizing CPU and GPU
+
+```
+bundle exec CUDA_LAUNCH_BLOCKING=1
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/cumo.
+
+## License
+
+[LICENSE.txt](./LICENSE.txt)