libddprof 0.2.0.beta1-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5410b5f6103dfd1b522775ca785fcddc64d690fe09bc111ac2d3a7e5ee46a26
+  data.tar.gz: e68e10cf9fb634e171df1d636bf7e69df2468f41e2e1af840bc3a2954bfb4adf
+SHA512:
+  metadata.gz: 908426356711dc9f5c71c3a450f07f46f9e5aa53b7a3af766af60360bd7ef1b312609e268cb779fc447396716d77a359db724025bca2b8b537822844eac797cf
+  data.tar.gz: 4dddd8e664ef4dda3620e03104192cf232783b6867d3133a0097cea718a8c641a3a57705ddaaff1b75d0e8253792d397fdfdc286c80471106928b396a4733728

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.1

data/README.md

@@ -0,0 +1,29 @@
+# libddprof Ruby gem
+
+`libddprof` provides a shared library containing common code used in the implementation of Datadog's
+[Continuous Profilers](https://docs.datadoghq.com/tracing/profiler/).
+
+**NOTE**: If you're building a new profiler or want to contribute to Datadog's existing profilers, you've come to the
+right place!
+Otherwise, this is possibly not the droid you were looking for.
+
+## Development
+
+Run `bundle exec rake` to run the tests and the style autofixer.
+You can also run `bundle exec pry` for an interactive prompt that will allow you to experiment.
+
+## Releasing a new version to rubygems.org
+
+Note: No Ruby needed to run this! It all runs inside docker :)
+
+1. [ ] Locate the new libddprof release on GitHub: <https://github.com/DataDog/libddprof/releases>
+2. [ ] Update the `LIB_GITHUB_RELEASES` section of the <Rakefile> with the new version
+3. [ ] Update the <lib/libddprof/version.rb> file with the `LIB_VERSION` and `VERSION` to use
+4. [ ] Commit change, open PR, get it merged
+5. [ ] Release by running `docker-compose run push_to_rubygems`.
+    (When asked for rubygems credentials, check your local friendly 1Password.)
+6. [ ] Verify that release shows up correctly on: <https://rubygems.org/gems/libddprof>
+
+## Contributing
+
+See <../CONTRIBUTING.md>.

data/Rakefile

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake" unless RUBY_VERSION < "2.5"
+
+require "fileutils"
+require "http"
+require "pry"
+require "rubygems/package"
+
+RSpec::Core::RakeTask.new(:spec)
+
+LIB_GITHUB_RELEASES = {
+  "0.2.0" => [
+    {
+      file: "libddprof-x86_64-unknown-linux-gnu.tar.gz",
+      sha256: "cba0f24074d44781d7252b912faff50d330957e84a8f40a172a8138e81001f27",
+      ruby_platform: "x86_64-linux"
+    },
+    {
+      file: "libddprof-x86_64-alpine-linux-musl.tar.gz",
+      sha256: "d519a6241d78260522624b8e79e98502510f11d5d9551f5f80fc1134e95fa146",
+      ruby_platform: "x86_64-linux-musl"
+    }
+  ]
+  # Add more versions here
+}
+
+task default: [
+  :spec,
+  (:'standard:fix' unless RUBY_VERSION < "2.5")
+].compact
+
+desc "Download lib release from github"
+task :fetch do
+  Helpers.each_github_release_variant do |file:, sha256:, target_directory:, target_file:, **_|
+    target_url = "https://github.com/DataDog/libddprof/releases/download/v#{Libddprof::LIB_VERSION}/#{file}"
+
+    if File.exist?(target_file)
+      if Digest::SHA256.hexdigest(File.read(target_file)) == sha256
+        puts "Found #{target_file} matching the expected sha256, skipping download"
+        next
+      else
+        puts "Found #{target_file} BUT IT DID NOT MATCH THE EXPECTED sha256, skipping download"
+      end
+    end
+
+    puts "Going to download #{target_url} into #{target_file}"
+
+    File.open(target_file, "wb") do |file|
+      HTTP.follow.get(target_url).body.each { |chunk| file.write(chunk) }
+    end
+
+    if Digest::SHA256.hexdigest(File.read(target_file)) == sha256
+      puts "Success!"
+    else
+      raise "Downloaded file is corrupt, does not match expected sha256"
+    end
+  end
+end
+
+desc "Extract lib downloaded releases"
+task extract: [:fetch] do
+  Helpers.each_github_release_variant do |target_directory:, target_file:, **_|
+    puts "Extracting #{target_file}"
+    File.open(target_file, "rb") do |file|
+      Gem::Package.new("").extract_tar_gz(file, target_directory)
+    end
+  end
+end
+
+desc "Package lib downloaded releases as gems"
+task package: [:spec, :'standard:fix', :extract] do
+  gemspec = eval(File.read("libddprof.gemspec"), nil, "libddprof.gemspec") # standard:disable Security/Eval
+  FileUtils.mkdir_p("pkg")
+
+  Helpers.package_without_binaries(gemspec)
+  Helpers.package_linux_x86_64(gemspec)
+end
+
+desc "Release all packaged gems"
+task push_to_rubygems: [
+  :package,
+  :'release:guard_clean'
+] do
+  system("gem signout") # make sure there are no existing credentials in use
+
+  system("gem push pkg/libddprof-#{Libddprof::VERSION}.gem")
+  system("gem push pkg/libddprof-#{Libddprof::VERSION}-x86_64-linux.gem")
+
+  system("gem signout") # leave no credentials behind
+end
+
+module Helpers
+  def self.each_github_release_variant(version: Libddprof::LIB_VERSION)
+    LIB_GITHUB_RELEASES.fetch(version).each do |variant|
+      file = variant.fetch(:file)
+      sha256 = variant.fetch(:sha256)
+      ruby_platform = variant.fetch(:ruby_platform)
+
+      # These two are so common that we just centralize them here
+      target_directory = "vendor/libddprof-#{version}/#{ruby_platform}"
+      target_file = "#{target_directory}/#{file}"
+
+      FileUtils.mkdir_p(target_directory)
+
+      yield(file: file, sha256: sha256, ruby_platform: ruby_platform, target_directory: target_directory, target_file: target_file)
+    end
+  end
+
+  def self.package_without_binaries(gemspec)
+    target_gemspec = gemspec.dup
+
+    puts "Building a variant without binaries including:"
+    pp target_gemspec.files
+
+    package = Gem::Package.build(target_gemspec)
+    FileUtils.mv(package, "pkg")
+    puts("-" * 80)
+  end
+
+  def self.package_linux_x86_64(gemspec)
+    # We include both glibc and musl variants in the same binary gem to avoid the issues
+    # documented in https://github.com/rubygems/rubygems/issues/3174
+    target_gemspec = gemspec.dup
+    target_gemspec.files += files_for("x86_64-linux", "x86_64-linux-musl")
+    target_gemspec.platform = "x86_64-linux"
+
+    puts "Building for x86_64-linux including: (this can take a while)"
+    pp target_gemspec.files
+
+    package = Gem::Package.build(target_gemspec)
+    FileUtils.mv(package, "pkg")
+    puts("-" * 80)
+  end
+
+  def self.files_for(*included_platforms, version: Libddprof::LIB_VERSION)
+    files = []
+
+    each_github_release_variant(version: version) do |ruby_platform:, target_directory:, target_file:, **_|
+      next unless included_platforms.include?(ruby_platform)
+
+      files += Dir.glob("#{target_directory}/**/*").select { |path| File.file?(path) } - [target_file]
+    end
+
+    files
+  end
+end

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '3.2'
+services:
+  push_to_rubygems:
+    image: ruby:3.1
+    platform: linux/x86_64
+    stdin_open: true
+    tty: true
+    command: bash -c 'cd /libddprof/ruby && bundle install && bundle exec rake push_to_rubygems'
+    volumes:
+      - ..:/libddprof
+      - bundle-3.1:/usr/local/bundle
+
+volumes:
+  bundle-3.1:

data/gems.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in libddprof.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.10"
+gem "standard", "~> 1.3" unless RUBY_VERSION < "2.5"
+gem "http", "~> 5.0"
+gem "pry"
+gem "pry-byebug"

data/lib/libddprof/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Libddprof
+  # Current libddprof version
+  LIB_VERSION = "0.2.0"
+
+  # This is the Ruby gem version -- often it will match LIB_VERSION, but sometimes it may not
+  VERSION = "#{LIB_VERSION}.beta1"
+end

data/lib/libddprof.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "libddprof/version"
+
+module Libddprof
+  # Is this a no-op libddprof release without binaries?
+  def self.no_binaries?
+    available_binaries.empty?
+  end
+
+  def self.available_binaries
+    Dir.children(vendor_directory)
+  end
+
+  def self.pkgconfig_folder
+    current_platform = Gem::Platform.local.to_s
+
+    return unless available_binaries.include?(current_platform)
+
+    pkgconfig_file = Dir.glob("#{vendor_directory}/#{current_platform}/**/ddprof_ffi.pc").first
+
+    return unless pkgconfig_file
+
+    File.absolute_path(File.dirname(pkgconfig_file))
+  end
+
+  private_class_method def self.vendor_directory
+    ENV["LIBDDPROF_VENDOR_OVERRIDE"] || "#{__dir__}/../vendor/libddprof-#{Libddprof::LIB_VERSION}/"
+  end
+end

data/vendor/libddprof-0.2.0/x86_64-linux/libddprof-x86_64-unknown-linux-gnu/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.