ob64 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 932acb090f33132ef28fa4f1dd093ceb900b4968cc62550288b887f611675ace
-  data.tar.gz: 8a3d7d012a3aa3f7037ce2d01d1739dc684c482bd1c31fe2cc5f8d22e855ddfd
+  metadata.gz: cf866c04fac9e6cf9d4f8c98741f17e2109e0bd5fd545d2d0482b4c28a6dd61a
+  data.tar.gz: e6ee12aebbece01e6e1ce8181aafdfe9b32b7fbd2d1307c07d7af02d46b73f4e
 SHA512:
-  metadata.gz: cfeb76345a14522533ecd22563ecbe215c6401faf58e7d6dad5e42ead52312575ceb139d34e1af7caf37e40250df0c5af2e64a2b6fc17ff0163c8e051868641d
-  data.tar.gz: 3127896a976e19db83eceea7da174bf8e18517588a81974042581085e41555acf05308687c680a9d0c33d9c24836a2f76563e84c5f1e59114bf344f20818222a
+  metadata.gz: 280e35ae08985662cc05a26c5f30ef5e9897b8d7a641a83e7a0bc8bf91a1790dbf8c36f5129ff7dface1e5eeb8d286ef43387688202b26a254a6bad860faa65d
+  data.tar.gz: f246fed35467cce900ffb7664ca62012c6d0e7bda5c2180a99814fba558331f83ab33d21a1868a0d850fa39b59eec223e39445584703f0302f339e159ce9be83

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+# [0.5.0] - 2021-09-29
+
+- Ignore all previous versions as they weren't including libbase64 (:
+
 # [0.4.0] - 2021-09-28
 
 - Detail gemspec. Ignore.

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/ob64.svg)](http://rubygems.org/gems/ob64)
 [![Build Status](https://github.com/jcmfernandes/ob64/workflows/Test/badge.svg?branch=master&event=push)](https://github.com/jcmfernandes/ob64/actions?query=workflow:Test)
-[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/ob64/0.4.0)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/ob64/0.5.0)
 
 A *fast* Base64 encoder and decoder as a Ruby gem.
 

data/lib/ob64/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ob64
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/ob64.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   # 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{\A(?:test|spec|features)/}) }
+  end + Dir.chdir(File.join(File.expand_path(__dir__), "vendor", "libbase64")) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }.map! { |f| "vendor/libbase64/#{f}" }
   end
   spec.require_paths = ["lib"]
   spec.extensions = ["ext/ob64/extconf.rb"]

data/vendor/libbase64/.gitignore

@@ -0,0 +1,12 @@
+*.o
+bin/base64
+lib/config.h
+test/benchmark
+test/test_base64
+
+# visual studio symbol db, etc.
+.vs/
+# build directory used by CMakePresets
+out/
+# private cmake presets
+CMakeUserPresets.json

data/vendor/libbase64/.travis.yml

@@ -0,0 +1,71 @@
+language: c
+services: docker
+
+jobs:
+  allow_failures:
+    - os: osx
+    - arch: ppc64le
+
+  include:
+    - name: linux-amd64-gcc
+      os: linux
+      arch: amd64
+      compiler: gcc
+      script: test/ci/amd64.sh
+
+    - name: linux-amd64-gcc +openmp
+      os: linux
+      arch: amd64
+      compiler: gcc
+      env: OPENMP=1 OMP_NUM_THREADS=4
+      script: test/ci/amd64.sh
+
+    - name: linux-amd64-clang
+      os: linux
+      arch: amd64
+      compiler: clang
+      script: test/ci/amd64.sh
+
+    - name: linux-arm32-gcc
+      compiler: gcc
+      script: test/ci/docker-arm32.sh
+
+    - name: linux-arm32-clang
+      compiler: clang
+      script: test/ci/docker-arm32.sh
+
+    - name: linux-powerpc-gcc
+      compiler: gcc
+      script: test/ci/docker-powerpc.sh
+
+    - name: linux-arm64-gcc
+      os: linux
+      arch: arm64
+      compiler: gcc
+      env: NEON64_CFLAGS="-march=armv8-a"
+      script: test/ci/generic.sh
+
+    - name: linux-arm64-clang
+      os: linux
+      arch: arm64
+      compiler: clang
+      env: NEON64_CFLAGS="-march=armv8-a"
+      script: test/ci/generic.sh
+
+    - name: linux-s390x-gcc
+      os: linux
+      arch: s390x
+      compiler: gcc
+      script: test/ci/generic.sh
+
+    - name: linux-ppc64le-gcc
+      os: linux
+      arch: ppc64le
+      compiler: gcc
+      script: test/ci/generic.sh
+
+    - name: osx-amd64-clang
+      os: osx
+      arch: amd64
+      compiler: clang
+      script: test/ci/amd64.sh

data/vendor/libbase64/CMakeLists.txt

@@ -0,0 +1,264 @@
+# Written in 2016-2017, 2021 by Henrik Steffen Gaßmann henrik@gassmann.onl
+#
+# To the extent possible under law, the author(s) have dedicated all
+# copyright and related and neighboring rights to this software to the
+# public domain worldwide. This software is distributed without any warranty.
+#
+# You should have received a copy of the CC0 Public Domain Dedication
+# along with this software. If not, see
+#
+#     http://creativecommons.org/publicdomain/zero/1.0/
+#
+########################################################################
+cmake_minimum_required(VERSION 3.1)
+
+project(base64 LANGUAGES C VERSION 0.4.0)
+
+include(GNUInstallDirs)
+include(CMakeDependentOption)
+include(FeatureSummary)
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules")
+
+#######################################################################
+# platform detection
+include(TargetArch)
+detect_target_architecture(_TARGET_ARCH)
+
+
+###################################################################
+# optional/conditional dependencies
+find_package(OpenMP)
+set_package_properties(OpenMP PROPERTIES
+    TYPE OPTIONAL
+    PURPOSE "Allows to utilize openmp"
+)
+
+
+########################################################################
+# Compilation options
+option(BASE64_BUILD_TESTS "add test projects" ON)
+cmake_dependent_option(BASE64_WITH_OPENMP "use openmp" OFF "OPENMP_FOUND" OFF)
+add_feature_info("OpenMP codec" BASE64_WITH_OPENMP "spreads codec work accross multiple threads")
+cmake_dependent_option(BASE64_REGENERATE_TABLES "regenerate the codec tables" OFF "NOT CMAKE_CROSSCOMPILING" OFF)
+
+set(_IS_X86 "\"${_TARGET_ARCH}\" STREQUAL \"x86\" OR \"${_TARGET_ARCH}\" STREQUAL \"x64\"")
+cmake_dependent_option(BASE64_WITH_SSSE3 "add SSSE 3 codepath" ON ${_IS_X86} OFF)
+add_feature_info(SSSE3 BASE64_WITH_SSSE3 "add SSSE 3 codepath")
+cmake_dependent_option(BASE64_WITH_SSE41 "add SSE 4.1 codepath" ON ${_IS_X86} OFF)
+add_feature_info(SSE4.1 BASE64_WITH_SSE41 "add SSE 4.1 codepath")
+cmake_dependent_option(BASE64_WITH_SSE42 "add SSE 4.2 codepath" ON ${_IS_X86} OFF)
+add_feature_info(SSE4.2 BASE64_WITH_SSE42 "add SSE 4.2 codepath")
+cmake_dependent_option(BASE64_WITH_AVX "add AVX codepath" ON ${_IS_X86} OFF)
+add_feature_info(AVX BASE64_WITH_AVX "add AVX codepath")
+cmake_dependent_option(BASE64_WITH_AVX2 "add AVX 2 codepath" ON ${_IS_X86} OFF)
+add_feature_info(AVX2 BASE64_WITH_AVX2 "add AVX2 codepath")
+
+set(_IS_ARM "\"${_TARGET_ARCH}\" STREQUAL \"arm\"")
+cmake_dependent_option(BASE64_WITH_NEON32 "add NEON32 codepath" OFF ${_IS_ARM} OFF)
+add_feature_info(NEON32 BASE64_WITH_NEON32 "add NEON32 codepath")
+
+set(_IS_ARM64 "\"${_TARGET_ARCH}\" STREQUAL \"arm64\"")
+cmake_dependent_option(BASE64_WITH_NEON64 "add NEON64 codepath" ON ${_IS_ARM64} OFF)
+add_feature_info(NEON64 BASE64_WITH_NEON64 "add NEON64 codepath")
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin")
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin")
+
+########################################################################
+# Regenerate headers
+
+if (BASE64_REGENERATE_TABLES)
+    # Generate tables in build folder and copy to source tree.
+    # Don't add the tables in the source tree to the outputs, to avoid `make clean` removing them.
+    add_executable(table_generator
+        lib/tables/table_generator.c
+    )
+
+    add_custom_command(OUTPUT table_dec_32bit.h "${CMAKE_CURRENT_SOURCE_DIR}/lib/tables/table_dec_32bit.h"
+        COMMAND table_generator > table_dec_32bit.h
+        COMMAND "${CMAKE_COMMAND}" -E copy table_dec_32bit.h "${CMAKE_CURRENT_SOURCE_DIR}/lib/tables/table_dec_32bit.h"
+        DEPENDS table_generator
+    )
+    set(Python_ADDITIONAL_VERSIONS 3)
+    find_package(PythonInterp REQUIRED)
+    add_custom_command(OUTPUT table_enc_12bit.h "${CMAKE_CURRENT_SOURCE_DIR}/lib/tables/table_enc_12bit.h"
+        COMMAND "${PYTHON_EXECUTABLE}" "${CMAKE_CURRENT_SOURCE_DIR}/lib/tables/table_enc_12bit.py" > table_enc_12bit.h
+        COMMAND "${CMAKE_COMMAND}" -E copy table_enc_12bit.h "${CMAKE_CURRENT_SOURCE_DIR}/lib/tables/table_enc_12bit.h"
+        DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/lib/tables/table_enc_12bit.py"
+    )
+endif()
+
+
+########################################################################
+# library project
+add_library(base64
+    # library files
+    lib/lib.c
+    lib/codec_choose.c
+    include/libbase64.h
+
+    lib/tables/tables.c
+    # Add generated headers explicitly to target, to insert them in the dependency tree
+    lib/tables/table_dec_32bit.h
+    lib/tables/table_enc_12bit.h
+
+    # codec implementations
+    lib/arch/generic/codec.c
+
+    lib/arch/ssse3/codec.c
+    lib/arch/sse41/codec.c
+    lib/arch/sse42/codec.c
+    lib/arch/avx/codec.c
+    lib/arch/avx2/codec.c
+
+    lib/arch/neon32/codec.c
+    lib/arch/neon64/codec.c
+)
+
+target_include_directories(base64
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+    PRIVATE
+        "${CMAKE_CURRENT_BINARY_DIR}"
+)
+
+####################################################################
+# platform/compiler specific configuration
+set_target_properties(base64 PROPERTIES
+    C_STANDARD 99
+    C_STANDARD_REQUIRED YES
+    C_EXTENSIONS OFF
+    DEFINE_SYMBOL BASE64_EXPORTS
+    VERSION ${PROJECT_VERSION}
+    SOVERSION ${PROJECT_VERSION_MAJOR}
+)
+
+#generate_export_header(base64)
+# the following definitions and those in libbase64.h have been
+# kept forward compatible in case we ever switch to generate_export_header
+if (BUILD_SHARED_LIBS)
+    set_target_properties(base64 PROPERTIES
+        C_VISIBILITY_PRESET hidden
+    )
+else()
+    target_compile_definitions(base64
+        PUBLIC
+            BASE64_STATIC_DEFINE
+    )
+endif()
+
+target_compile_options(base64 PRIVATE
+  $<$<C_COMPILER_ID:MSVC>:
+    /W4
+    /WX # All warnings as error
+    /we4013 # Error warning C4013: 'function' undefined; assuming extern returning int
+    /we4700 # Error warning C4700: uninitialized local variable
+    /we4715 # not all control paths return a value
+    /we4003 # not enough actual parameters for macro
+    /wd4456 # disable warning C4456: declaration of 'xxx' hides previous local declaration
+  >
+  $<$<NOT:$<C_COMPILER_ID:MSVC>>:
+    -Wall
+    -Wextra
+    -Wpedantic
+    -O3
+  >
+)
+
+target_compile_definitions(base64 PRIVATE
+  $<$<C_COMPILER_ID:MSVC>:
+    # remove unnecessary warnings about unchecked iterators
+    _SCL_SECURE_NO_WARNINGS
+  >
+)
+
+########################################################################
+# SIMD settings
+include(TargetSIMDInstructionSet)
+define_SIMD_compile_flags()
+
+if (_TARGET_ARCH STREQUAL "x86" OR _TARGET_ARCH STREQUAL "x64")
+    macro(configure_codec _TYPE)
+        if (BASE64_WITH_${_TYPE})
+            message(STATUS "Add codec: lib/arch/${_DIR}/codec.c")
+            string(TOLOWER "${_TYPE}" _DIR)
+            set_source_files_properties("lib/arch/${_DIR}/codec.c" PROPERTIES
+                COMPILE_FLAGS "${COMPILE_FLAGS_${_TYPE}}"
+            )
+
+            if (${ARGC} GREATER 1 AND MSVC)
+                set_source_files_properties("lib/arch/${_DIR}/codec.c" PROPERTIES
+                    COMPILE_DEFINITIONS ${ARGV1}
+                )
+            endif()
+        endif()
+    endmacro()
+
+    configure_codec(SSSE3 __SSSE3__)
+    configure_codec(SSE41 __SSSE4_1__)
+    configure_codec(SSE42 __SSSE4_2__)
+    configure_codec(AVX)
+    configure_codec(AVX2)
+
+elseif (_TARGET_ARCH STREQUAL "arm")
+    set(BASE64_NEON32_CFLAGS "${COMPILE_FLAGS_NEON32}" CACHE STRING "the NEON32 compile flags (for 'lib/arch/neon32/codec.c')")
+    mark_as_advanced(BASE64_NEON32_CFLAGS)
+
+    if (BASE64_WITH_NEON32)
+        set_source_files_properties("lib/arch/neon32/codec.c" PROPERTIES
+            COMPILE_FLAGS "${BASE64_NEON32_CFLAGS} "
+        )
+    endif()
+
+#elseif (_TARGET_ARCH STREQUAL "arm64" AND BASE64_WITH_NEON64)
+
+endif()
+
+configure_file("${CMAKE_CURRENT_LIST_DIR}/cmake/config.h.in" "${CMAKE_CURRENT_BINARY_DIR}/config.h" @ONLY)
+
+########################################################################
+# OpenMP Settings
+if (BASE64_WITH_OpenMP)
+    target_compile_options(base64
+        PRIVATE
+            ${OpenMP_C_FLAGS}
+    )
+endif()
+
+########################################################################
+if (BASE64_BUILD_TESTS)
+    enable_testing()
+    add_subdirectory(test)
+endif()
+
+########################################################################
+# cmake install
+install(DIRECTORY include/ TYPE INCLUDE)
+install(TARGETS base64 EXPORT base64-targets)
+
+include(CMakePackageConfigHelpers)
+configure_package_config_file(cmake/base64-config.cmake.in
+    "${CMAKE_CURRENT_BINARY_DIR}/base64-config.cmake"
+
+    INSTALL_DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+)
+write_basic_package_version_file(
+    "${CMAKE_CURRENT_BINARY_DIR}/base64-config-version.cmake"
+    VERSION ${BASE64_VERSION}
+    COMPATIBILITY ExactVersion
+)
+
+install(FILES
+        "${CMAKE_CURRENT_BINARY_DIR}/base64-config.cmake"
+        "${CMAKE_CURRENT_BINARY_DIR}/base64-config-version.cmake"
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+)
+
+install(EXPORT base64-targets
+    NAMESPACE aklomp::
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+)
+
+########################################################################
+feature_summary(WHAT PACKAGES_FOUND PACKAGES_NOT_FOUND ENABLED_FEATURES DISABLED_FEATURES)

data/vendor/libbase64/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2005-2007, Nick Galbreath
+Copyright (c) 2013-2019, Alfred Klomp
+Copyright (c) 2015-2017, Wojciech Mula
+Copyright (c) 2016-2017, Matthieu Darbois
+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.
+
+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.

data/vendor/libbase64/Makefile

@@ -0,0 +1,93 @@
+CFLAGS += -std=c99 -O3 -Wall -Wextra -pedantic
+
+# Set OBJCOPY if not defined by environment:
+OBJCOPY ?= objcopy
+
+OBJS = \
+  lib/arch/avx2/codec.o \
+  lib/arch/generic/codec.o \
+  lib/arch/neon32/codec.o \
+  lib/arch/neon64/codec.o \
+  lib/arch/ssse3/codec.o \
+  lib/arch/sse41/codec.o \
+  lib/arch/sse42/codec.o \
+  lib/arch/avx/codec.o \
+  lib/lib.o \
+  lib/codec_choose.o \
+  lib/tables/tables.o
+
+HAVE_AVX2   = 0
+HAVE_NEON32 = 0
+HAVE_NEON64 = 0
+HAVE_SSSE3  = 0
+HAVE_SSE41  = 0
+HAVE_SSE42  = 0
+HAVE_AVX    = 0
+
+# The user should supply compiler flags for the codecs they want to build.
+# Check which codecs we're going to include:
+ifdef AVX2_CFLAGS
+  HAVE_AVX2 = 1
+endif
+ifdef NEON32_CFLAGS
+  HAVE_NEON32 = 1
+endif
+ifdef NEON64_CFLAGS
+  HAVE_NEON64 = 1
+endif
+ifdef SSSE3_CFLAGS
+  HAVE_SSSE3 = 1
+endif
+ifdef SSE41_CFLAGS
+  HAVE_SSE41 = 1
+endif
+ifdef SSE42_CFLAGS
+  HAVE_SSE42 = 1
+endif
+ifdef AVX_CFLAGS
+  HAVE_AVX = 1
+endif
+ifdef OPENMP
+  CFLAGS += -fopenmp
+endif
+
+
+.PHONY: all analyze clean
+
+all: bin/base64 lib/libbase64.o
+
+bin/base64: bin/base64.o lib/libbase64.o
+	$(CC) $(CFLAGS) -o $@ $^
+
+lib/libbase64.o: $(OBJS)
+	$(LD) -r -o $@ $^
+	$(OBJCOPY) --keep-global-symbols=lib/exports.txt $@
+
+lib/config.h:
+	@echo "#define HAVE_AVX2   $(HAVE_AVX2)"    > $@
+	@echo "#define HAVE_NEON32 $(HAVE_NEON32)" >> $@
+	@echo "#define HAVE_NEON64 $(HAVE_NEON64)" >> $@
+	@echo "#define HAVE_SSSE3  $(HAVE_SSSE3)"  >> $@
+	@echo "#define HAVE_SSE41  $(HAVE_SSE41)"  >> $@
+	@echo "#define HAVE_SSE42  $(HAVE_SSE42)"  >> $@
+	@echo "#define HAVE_AVX    $(HAVE_AVX)"    >> $@
+
+$(OBJS): lib/config.h
+$(OBJS): CFLAGS += -Ilib
+
+lib/arch/avx2/codec.o:   CFLAGS += $(AVX2_CFLAGS)
+lib/arch/neon32/codec.o: CFLAGS += $(NEON32_CFLAGS)
+lib/arch/neon64/codec.o: CFLAGS += $(NEON64_CFLAGS)
+lib/arch/ssse3/codec.o:  CFLAGS += $(SSSE3_CFLAGS)
+lib/arch/sse41/codec.o:  CFLAGS += $(SSE41_CFLAGS)
+lib/arch/sse42/codec.o:  CFLAGS += $(SSE42_CFLAGS)
+lib/arch/avx/codec.o:    CFLAGS += $(AVX_CFLAGS)
+
+%.o: %.c
+	$(CC) $(CFLAGS) -o $@ -c $<
+
+analyze: clean
+	scan-build --use-analyzer=`which clang` --status-bugs make
+
+clean:
+	rm -f bin/base64 bin/base64.o lib/libbase64.o lib/config.h $(OBJS)