Top Level Namespace

Defined Under Namespace

Modules: MultiCompress

Constant Summary collapse

USE_SYSTEM = 
arg_config("--use-system-libraries") ||
ENV["COMPRESS_USE_SYSTEM_LIBRARIES"]
FORCE_VENDORED = 
arg_config("--force-vendored") ||
ENV["COMPRESS_FORCE_VENDORED"]
ZSTD_SUBDIRS = 
%w[lib/common lib/compress lib/decompress lib/dictBuilder].freeze
BROTLI_SUBDIRS = 
%w[c/common c/enc c/dec].freeze
LZ4_SOURCES = 
%w[lz4.c lz4hc.c lz4frame.c].freeze
VENDOR_DIR =

— Main —

find_vendor_dir
VENDORED = 
!VENDOR_DIR.nil?

Instance Method Summary collapse

Instance Method Details

#add_include_dirs(zstd_dir, lz4_dir, brotli_dir) ⇒ Object 



122
123
124
125
126
127
128
129
 
# File 'ext/multi_compress/extconf.rb', line 122

def add_include_dirs(zstd_dir, lz4_dir, brotli_dir)
  [
    File.join(zstd_dir, "lib"),
    File.join(zstd_dir, "lib", "common"),
    File.join(lz4_dir, "lib"),
    File.join(brotli_dir, "c", "include"),
  ].each { |d| $CPPFLAGS += " -I#{d}" }
end

#build_vpath_dirs(zstd_dir, lz4_dir, brotli_dir) ⇒ Object 



131
132
133
134
135
 
# File 'ext/multi_compress/extconf.rb', line 131

def build_vpath_dirs(zstd_dir, lz4_dir, brotli_dir)
  ZSTD_SUBDIRS.map { |d| File.join(zstd_dir, d) } +
    [File.join(lz4_dir, "lib")] +
    BROTLI_SUBDIRS.map { |d| File.join(brotli_dir, d) }
end

#collect_vendor_sources(zstd_dir, lz4_dir, brotli_dir) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'ext/multi_compress/extconf.rb', line 109

def collect_vendor_sources(zstd_dir, lz4_dir, brotli_dir)
  zstd_srcs = ZSTD_SUBDIRS.flat_map { |d| Dir[File.join(zstd_dir, d, "*.c")] }

  lz4_srcs = LZ4_SOURCES.filter_map do |f|
    path = File.join(lz4_dir, "lib", f)
    path if File.exist?(path)
  end

  brotli_srcs = BROTLI_SUBDIRS.flat_map { |d| Dir[File.join(brotli_dir, d, "*.c")] }

  zstd_srcs + lz4_srcs + brotli_srcs
end

#configure_homebrew ⇒ Object 



66
67
68
69
70
 
# File 'ext/multi_compress/extconf.rb', line 66

def configure_homebrew
  dir_config("homebrew", "/opt/homebrew")
  $CPPFLAGS += " -I/opt/homebrew/include"
  $LDFLAGS  += " -L/opt/homebrew/lib"
end

#configure_system_libraries ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'ext/multi_compress/extconf.rb', line 48

def configure_system_libraries
  puts "Building with SYSTEM libraries"

  configure_homebrew if RUBY_PLATFORM.include?("darwin")

  require_system_lib("zstd",   header: "zstd.h",           func: "ZSTD_compress")
  require_system_lib("lz4",    header: "lz4.h",            func: "LZ4_compress_default")
  require_system_lib("brotli", header: "brotli/encode.h",  func: "BrotliEncoderCreateInstance", lib: "brotlienc")

  have_header("zdict.h")
  have_header("lz4hc.h")
  have_header("lz4frame.h")
  have_library("lz4", "LZ4_compress_HC")
  have_library("lz4", "LZ4F_compressFrame")
  have_header("brotli/decode.h")
  have_library("brotlidec", "BrotliDecoderCreateInstance")
end

#configure_vendored_libraries(vendor_dir) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'ext/multi_compress/extconf.rb', line 78

def configure_vendored_libraries(vendor_dir)
  versions = File.read(File.join(vendor_dir, ".vendored"))
  puts "Building with VENDORED libraries from #{vendor_dir}"
  puts "  forced vendored mode enabled" if FORCE_VENDORED
  puts "  #{versions.tr("\n", ", ")}"

  zstd_dir   = File.join(vendor_dir, "zstd")
  lz4_dir    = File.join(vendor_dir, "lz4")
  brotli_dir = File.join(vendor_dir, "brotli")

  all_vendor_srcs = collect_vendor_sources(zstd_dir, lz4_dir, brotli_dir)

  puts "  #{all_vendor_srcs.length} vendored C files"

  add_include_dirs(zstd_dir, lz4_dir, brotli_dir)
  $CPPFLAGS += " -DZSTD_DISABLE_ASM"

  vpath_dirs = build_vpath_dirs(zstd_dir, lz4_dir, brotli_dir)

  deduplicate_sources!(all_vendor_srcs)

  compress_c_dir = find_compress_c_dir

  $srcs  = ["multi_compress.c"] + all_vendor_srcs.map { |s| File.basename(s) }
  $VPATH = [compress_c_dir] + vpath_dirs

  $warnflags = ""

  vpath_dirs
end

#deduplicate_sources!(sources) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
 
# File 'ext/multi_compress/extconf.rb', line 137

def deduplicate_sources!(sources)
  seen = {}

  sources.reject! do |src|
    basename = File.basename(src)
    duplicate = seen.key?(basename)
    puts "  SKIP duplicate: #{src}" if duplicate
    seen[basename] = true
    duplicate
  end
end

#find_compress_c_dir ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'ext/multi_compress/extconf.rb', line 32

def find_compress_c_dir
  candidates = [
    __dir__,
    File.join(__dir__, "..", "..", "..", "..", "ext", "multi_compress"),
  ]

  dir = __dir__
  6.times do
    candidates << File.join(dir, "ext", "multi_compress")
    dir = File.dirname(dir)
  end

  candidates.find { |path| File.exist?(File.join(path, "multi_compress.c")) }
            &.then { |path| File.expand_path(path) } || __dir__
end

#find_vendor_dir ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'ext/multi_compress/extconf.rb', line 14

def find_vendor_dir
  candidates = [
    File.join(__dir__, "vendor"),
    File.join(__dir__, "..", "..", "..", "..", "ext", "multi_compress", "vendor"),
    File.expand_path("../../ext/multi_compress/vendor", __dir__),
    File.join(Dir.pwd, "ext", "multi_compress", "vendor"),
  ]

  dir = __dir__
  6.times do
    candidates << File.join(dir, "ext", "multi_compress", "vendor")
    dir = File.dirname(dir)
  end

  candidates.find { |path| File.exist?(File.join(path, ".vendored")) }
            &.then { |path| File.expand_path(path) }
end

#patch_makefile_vpath!(vpath_dirs) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
 
# File 'ext/multi_compress/extconf.rb', line 149

def patch_makefile_vpath!(vpath_dirs)
  makefile = File.read("Makefile")
  return if makefile.include?("# vendored vpath")

  vpath_lines = vpath_dirs.map { |d| "vpath %.c #{d}" }.join("\n")

  makefile.sub!(/^(VPATH\s*=.*)$/m) { "#{Regexp.last_match(1)}\n# vendored vpath\n#{vpath_lines}" }
  File.write("Makefile", makefile)
  puts "  Patched Makefile with #{vpath_dirs.length} VPATH entries"
end

#require_system_lib(name, header:, func:, lib: name) ⇒ Object 



72
73
74
75
76
 
# File 'ext/multi_compress/extconf.rb', line 72

def require_system_lib(name, header:, func:, lib: name)
  return if have_header(header) && have_library(lib, func)

  abort "Missing #{name}. Install: apt install lib#{name}-dev / brew install #{name}"
end