simdjson 0.1.0

data/benchmark/run_benchmark.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'benchmark/ips'
+require 'json'
+require 'simdjson'
+
+files = %w[
+  apache_builds.json
+  github_events.json
+  demo.json
+]
+files = files.map do |x|
+  [x, open(File.join(__dir__, "./#{x}")).read] # rubocop:disable Security/Open (reason: inputs are safe strings)
+end
+files = files.to_h
+
+def run_report(rep, name, src)
+  rep.report("#{name} - simdjson") do
+    Simdjson.parse(src)
+  end
+  rep.report("#{name} - standard JSON") do
+    JSON.parse(src)
+  end
+end
+
+Benchmark.ips do |rep|
+  files.each do |name, src|
+    run_report(rep, name, src)
+  end
+end

data/ext/simdjson/extconf.rb

@@ -0,0 +1,22 @@
+require 'mkmf'
+
+# rubocop:disable Style/GlobalVars
+
+$CXXFLAGS += ' -std=c++1z -mpclmul -mbmi -mbmi2 -mavx -mavx2 '
+
+CWD = __dir__
+SIMDJSON_DIR = File.join(CWD, '..', '..', 'vendor', 'simdjson')
+dir_config('simdjson', "#{SIMDJSON_DIR}/singleheader", "#{SIMDJSON_DIR}/src")
+
+# build vendor/simdjson
+# TODO check availability of cmake & make (use `find_executable`)
+Dir.chdir(SIMDJSON_DIR) do
+  `cmake -DSIMDJSON_BUILD_STATIC=ON -DCMAKE_BUILD_TYPE=Release .`
+  `make`
+end
+
+$libs = '-lsimdjson'
+
+create_makefile('simdjson/simdjson')
+
+# rubocop:enable Style/GlobalVars

data/ext/simdjson/simdjson.cpp

@@ -0,0 +1,76 @@
+
+#include <string>
+#include <string_view>
+
+#include "simdjson.h"
+#include "simdjson.hpp"  // internal header
+
+VALUE rb_mSimdjson;
+
+VALUE rb_eSimdjsonParseError;
+
+using namespace simdjson;
+
+// Convert tape to Ruby's Object
+static VALUE make_ruby_object(ParsedJson::Iterator &it) {
+    if (it.is_object()) {
+        VALUE hash = rb_hash_new();
+        if (it.down()) {
+            do {
+                assert(it.is_string());
+                VALUE key = rb_str_new(it.get_string(), it.get_string_length());
+                it.next();
+                VALUE val = make_ruby_object(it);
+                rb_hash_aset(hash, key, val);
+            } while (it.next());
+            it.up();
+        }
+        return hash;
+    } else if (it.is_array()) {
+        VALUE ary = rb_ary_new();
+        if (it.down()) {
+            VALUE e0 = make_ruby_object(it);
+            rb_ary_push(ary, e0);
+            while (it.next()) {
+                VALUE e = make_ruby_object(it);
+                rb_ary_push(ary, e);
+            }
+            it.up();
+        }
+        return ary;
+    } else if (it.is_string()) {
+        return rb_str_new(it.get_string(), it.get_string_length());
+    } else if (it.is_integer()) {
+        return LONG2NUM(it.get_integer());
+    } else if (it.is_double()) {
+        return DBL2NUM(it.get_double());
+    } else if (it.get_type() == 'n') {  // TODO replace get_type()
+        return Qnil;
+    } else if (it.get_type() == 't') {  // TODO replace get_type()
+        return Qtrue;
+    } else if (it.get_type() == 'f') {  // TODO replace get_type()
+        return Qfalse;
+    }
+    // unknown case (bug)
+    rb_raise(rb_eException, "[BUG] must not happen");
+}
+
+static VALUE rb_simdjson_parse(VALUE self, VALUE arg) {
+    const padded_string p{RSTRING_PTR(arg)};
+    ParsedJson pj = build_parsed_json(p);
+    if (!pj.is_valid()) {
+        rb_raise(rb_eSimdjsonParseError, "parse error");
+        return Qnil;
+    }
+    ParsedJson::Iterator it{pj};
+    return make_ruby_object(it);
+}
+
+extern "C" {
+
+void Init_simdjson(void) {
+    rb_mSimdjson = rb_define_module("Simdjson");
+    rb_eSimdjsonParseError = rb_define_class_under(rb_mSimdjson, "ParseError", rb_eStandardError);
+    rb_define_module_function(rb_mSimdjson, "parse", reinterpret_cast<VALUE (*)(...)>(rb_simdjson_parse), 1);
+}
+}

data/ext/simdjson/simdjson.hpp

@@ -0,0 +1,6 @@
+#ifndef SIMDJSON_RUBY_H
+#define SIMDJSON_RUBY_H 1
+
+#include "ruby.h"
+
+#endif /* SIMDJSON_RUBY_H */

data/lib/simdjson/version.rb

@@ -0,0 +1,3 @@
+module Simdjson
+  VERSION = '0.1.0'.freeze
+end

data/lib/simdjson.rb

@@ -0,0 +1,2 @@
+require 'simdjson/version'
+require 'simdjson/simdjson'

data/simdjson.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simdjson/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simdjson'
+  spec.version       = Simdjson::VERSION
+  spec.authors       = ['saka1']
+  spec.email         = ['github@saka1.net']
+
+  spec.summary       = 'Ruby binding to simdjson.'
+  spec.description   = "simdjson gem is a binding to use simdjson, which is a Lemire's fast JSON parser."
+  spec.homepage      = 'https://github.com/saka1/simdjson_ruby'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  # TODO: remove unnecessary files
+  spec.files        += Dir.glob('vendor/simdjson/**/*').delete_if { |f| f =~ /json$/ }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions    = ['ext/simdjson/extconf.rb']
+
+  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+end

data/vendor/simdjson/AUTHORS

@@ -0,0 +1,3 @@
+# List of authors for copyright purposes
+Daniel Lemire
+Geoff Langdale

data/vendor/simdjson/CMakeLists.txt

@@ -0,0 +1,63 @@
+cmake_minimum_required(VERSION 3.9) # CMP0069 NEW
+include(CheckIPOSupported)
+check_ipo_supported(RESULT ltoresult)
+if(ltoresult)
+set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
+endif()
+
+# usage: cmake -DSIMDJSON_DISABLE_AVX=on ..
+option(SIMDJSON_DISABLE_AVX "Forcefully disable AVX even if hardware supports it" OFF)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_MACOSX_RPATH OFF)
+if (NOT CMAKE_BUILD_TYPE)
+                message(STATUS "No build type selected, default to Release")
+                set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build." FORCE)
+endif()
+
+project(simdjson)
+set(SIMDJSON_LIB_NAME simdjson)
+set(PROJECT_VERSION_MAJOR 0)
+set(PROJECT_VERSION_MINOR 2)
+set(PROJECT_VERSION_PATCH 1)
+set(SIMDJSON_LIB_VERSION "0.2.1" CACHE STRING "simdjson library version")
+set(SIMDJSON_LIB_SOVERSION "0" CACHE STRING "simdjson library soversion")
+
+if(NOT MSVC)
+option(SIMDJSON_BUILD_STATIC "Build a static library" OFF) # turning it on disables the production of a dynamic library
+else()
+option(SIMDJSON_BUILD_STATIC "Build a static library" ON) # turning it on disables the production of a dynamic library
+endif()
+option(SIMDJSON_SANITIZE "Sanitize addresses" OFF)
+
+set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/tools/cmake")
+
+find_package(CTargets)
+find_package(Options)
+
+install(DIRECTORY include/${SIMDJSON_LIB_NAME} DESTINATION include)
+set (TEST_DATA_DIR "${CMAKE_CURRENT_SOURCE_DIR}/jsonchecker/")
+set (BENCHMARK_DATA_DIR "${CMAKE_CURRENT_SOURCE_DIR}/jsonexamples/")
+add_definitions(-DSIMDJSON_TEST_DATA_DIR="${TEST_DATA_DIR}")
+add_definitions(-DSIMDJSON_BENCHMARK_DATA_DIR="${TEST_DATA_DIR}")
+enable_testing()
+add_subdirectory(src)
+add_subdirectory(tools)
+add_subdirectory(tests)
+add_subdirectory(benchmark)
+
+set(CPACK_PACKAGE_VENDOR "Daniel Lemire")
+set(CPACK_PACKAGE_CONTACT "lemire@gmail.com")
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Parsing gigabytes of JSON per second")
+set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR})
+set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR})
+set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH})
+set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
+set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
+
+set(CPACK_RPM_PACKAGE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
+
+set(CPACK_SOURCE_GENERATOR "TGZ;ZIP")
+
+include(CPack)

data/vendor/simdjson/CONTRIBUTORS

@@ -0,0 +1,27 @@
+# contributors (in no particular order)
+Thomas Navennec
+Kai Wolf
+Tyler Kennedy
+Frank Wessels
+George Fotopoulos
+Heinz N. Gies
+Emil Gedda
+Wojciech Muła
+Georgios Floros
+Dong Xie
+Nan Xiao
+Egor Bogatov
+Jinxi Wang
+Luiz Fernando Peres
+Wouter Bolsterlee
+Anish Karandikar
+Reini Urban
+Tom Dyson
+Ihor Dotsenko
+Alexey Milovidov
+Chang Liu
+Sunny Gleason
+John Keiser
+Zach Bjornson
+# if you have contributed to the project and your name does not 
+# appear in this list, please let us know!

data/vendor/simdjson/Dockerfile

@@ -0,0 +1,10 @@
+# docker build -t simdjson . && docker run --privileged -t simdjson
+FROM gcc:8.3
+COPY . /usr/src/
+WORKDIR /usr/src/
+RUN make clean
+RUN make amalgamate
+RUN make
+RUN make test
+RUN make parsingcompetition
+CMD ["bash", "scripts/selectparser.sh"]

data/vendor/simdjson/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2019 The simdjson authors 
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.