rbbcc 0.3.0 → 0.5.0

data/lib/rbbcc/bcc.rb

@@ -1,6 +1,7 @@
 require 'rbbcc/consts'
 require 'rbbcc/table'
 require 'rbbcc/symbol_cache'
+require 'rbbcc/debug'
 
 module RbBCC
   SYSCALL_PREFIXES = [
@@ -14,6 +15,20 @@ module RbBCC
 
   class BCC
     class << self
+      def _find_file(filename)
+        if filename
+          unless File.exist?(filename)
+            t = File.expand_path "../#{filename}", $0
+            if File.exist?(t)
+              filename = t
+            else
+              raise "Could not find file #{filename}"
+            end
+          end
+        end
+        return filename
+      end
+
       def ksym(addr, show_module: false, show_offset: false)
         self.sym(addr, -1, show_module: show_module, show_offset: show_offset, demangle: false)
       end
@@ -161,25 +176,57 @@ module RbBCC
         module_ = (show_module && module_) ? " [#{File.basename.basename(module_)}]" : ""
         return name + module_
       end
+
+      def attach_raw_socket(fn, dev)
+        unless fn.is_a?(Hash)
+          raise "arg 1 must be of BPF.Function Hash"
+        end
+        sock = Clib.bpf_open_raw_sock(dev)
+        if sock < 0
+          raise SystemCallError.new("Failed to open raw device %s" % dev, Fiddle.last_error)
+        end
+
+        res = Clib.bpf_attach_socket(sock, fn[:fd])
+        if res < 0
+          raise SystemCallError.new("Failed to attach BPF to device %s" % dev, Fiddle.last_error)
+        end
+        fn[:sock] = sock
+        fn
+      end
     end
 
-    def initialize(text:, debug: 0, cflags: [], usdt_contexts: [], allow_rlimit: 0)
+    def initialize(text: "", src_file: nil, hdr_file: nil, debug: 0, cflags: [], usdt_contexts: [], allow_rlimit: 0)
       @kprobe_fds = {}
       @uprobe_fds = {}
       @tracepoint_fds = {}
       @raw_tracepoint_fds = {}
-      @usdt_contexts = usdt_contexts
-      if code = gen_args_from_usdt
-        text = code + text
-      end
-
-      @module = Clib.bpf_module_create_c_from_string(
-        text,
-        debug,
-        cflags.pack('p*'),
-        cflags.size,
-        allow_rlimit
-      )
+
+      if src_file
+        src_file = BCC._find_file(src_file)
+        hdr_file = BCC._find_file(hdr_file)
+      end
+
+      if src_file && src_file.end_with?(".b")
+        @module = Clib.bpf_module_create_b(src_file, hdr_file, debug, device)
+      else
+        if src_file
+          text = File.read(src_file)
+        end
+
+        @usdt_contexts = usdt_contexts
+        if code = gen_args_from_usdt
+          text = code + text
+        end
+
+        # Util.debug text
+        @module = Clib.bpf_module_create_c_from_string(
+          text,
+          debug,
+          cflags.pack('p*'),
+          cflags.size,
+          allow_rlimit
+        )
+      end
       @funcs = {}
       @tables = {}
       @perf_buffers = {}
@@ -237,7 +284,7 @@ module RbBCC
       if fd < 0
         raise SystemCallError.new("Failed to attach BPF program #{fn_name} to tracepoint #{tp}", Fiddle.last_error)
       end
-      puts "Attach: #{tp}"
+      Util.debug "Attach: #{tp}"
       @tracepoint_fds[tp] = fd
       self
     end
@@ -252,7 +299,7 @@ module RbBCC
       if fd < 0
         raise SystemCallError.new("Failed to attach BPF program #{fn_name} to raw tracepoint #{tp}", Fiddle.last_error)
       end
-      puts "Attach: #{tp}"
+      Util.debug "Attach: #{tp}"
       @raw_tracepoint_fds[tp] = fd
       self
     end
@@ -264,7 +311,7 @@ module RbBCC
       if fd < 0
         raise SystemCallError.new("Failed to attach BPF program #{fn_name} to kprobe #{event}", Fiddle.last_error)
       end
-      puts "Attach: #{ev_name}"
+      Util.debug "Attach: #{ev_name}"
       @kprobe_fds[ev_name] = fd
       [ev_name, fd]
     end
@@ -277,7 +324,7 @@ module RbBCC
       if fd < 0
         raise SystemCallError.new("Failed to attach BPF program #{fn_name} to kretprobe #{event}", Fiddle.last_error)
       end
-      puts "Attach: #{ev_name}"
+      Util.debug "Attach: #{ev_name}"
       @kprobe_fds[ev_name] = fd
       [ev_name, fd]
     end
@@ -291,7 +338,7 @@ module RbBCC
       if fd < 0
         raise SystemCallError.new(Fiddle.last_error)
       end
-      puts "Attach: #{ev_name}"
+      Util.debug "Attach: #{ev_name}"
 
       @uprobe_fds[ev_name] = fd
       [ev_name, fd]
@@ -306,7 +353,7 @@ module RbBCC
       if fd < 0
         raise SystemCallError.new(Fiddle.last_error)
       end
-      puts "Attach: #{ev_name}"
+      Util.debug "Attach: #{ev_name}"
 
       @uprobe_fds[ev_name] = fd
       [ev_name, fd]
@@ -507,7 +554,7 @@ module RbBCC
         else
           next
         end
-        puts "Found fnc: #{func_name}"
+        Util.debug "Found fnc: #{func_name}"
         if func_name.start_with?("kprobe__")
           fn = load_func(func_name, BPF::KPROBE)
           attach_kprobe(

data/lib/rbbcc/clib.rb

@@ -25,19 +25,27 @@ module RbBCC
     end
 
     extend Fiddle::Importer
-    begin
-      default_load = ENV['LIBBCC_VERSION'] || "0.11.0"
-
-      dlload "libbcc.so.#{default_load}"
-      self.libbcc_version = default_load
-    rescue Fiddle::DLError => e
-      warn "Fall back to libbcc 0.10.0: #{e.inspect}"
-      dlload "libbcc.so.0.10.0"
-      self.libbcc_version = "0.10.0"
+    targets = %w(0.14.0 0.13.0 0.12.0 0.11.0 0.10.0)
+    if default_load = ENV['LIBBCC_VERSION']
+      targets.unshift(default_load)
+      targets.uniq!
+    end
+
+    targets.each do |to_load|
+      begin
+        dlload "libbcc.so.#{to_load}"
+        self.libbcc_version = to_load
+        break
+      rescue Fiddle::DLError => e
+        if targets.last == to_load
+          raise LoadError, "no target libbcc to load"
+        end
+      end
     end
     typealias "size_t", "int"
 
     extern 'void * bpf_module_create_c_from_string(char *, unsigned int, char **, int, long)'
+    extern 'void * bpf_module_create_b(char *filename, char *proto_filename, unsigned int flags, char *dev_name)'
     extern 'int bpf_num_functions(void *)'
     extern 'char * bpf_function_name(void *, int)'
     extern 'void bpf_module_destroy(void *)'
@@ -70,6 +78,7 @@ module RbBCC
     extern 'char * bpf_table_key_desc(void *, char *)'
     extern 'char * bpf_table_leaf_desc(void *, char *)'
     extern 'int bpf_update_elem(int fd, void *key, void *value, unsigned long long flags)'
+    extern 'int bpf_delete_elem(int fd, void *key)'
 
     extern 'int bpf_attach_kprobe(int, int, char *, char *, unsigned long, int)'
     extern 'int bpf_detach_kprobe(char *)'
@@ -111,10 +120,11 @@ module RbBCC
     extern 'char * bpf_perf_event_field(void *program, const char *event, size_t i)'
 
     extern 'void * bcc_usdt_new_frompid(int, char *)'
+    extern 'void * bcc_usdt_new_frompath(char *path)'
     extern 'int bcc_usdt_enable_probe(void *, char *, char *)'
     extern 'char * bcc_usdt_genargs(void **, int)'
     extern 'void bcc_usdt_foreach_uprobe(void *, void *)'
-
+    extern 'void bcc_usdt_close(void *usdt)'
     BCCSymbol = struct([
                          "const char *name",
                          "const char *demangle_name",
@@ -147,6 +157,9 @@ module RbBCC
     extern 'int perf_reader_poll(int num_readers, struct perf_reader **readers, int timeout)'
 
     extern 'void bcc_procutils_free(const char *ptr)'
+
+    extern 'int bpf_open_raw_sock(const char *name)'
+    extern 'int bpf_attach_socket(int sockfd, int progfd)'
   end
 end
 

data/lib/rbbcc/debug.rb

@@ -0,0 +1,17 @@
+if ENV['RBBCC_DEBUG'] || ENV['BCC_DEBUG']
+  module RbBCC
+    module Util
+      def self.debug(msg)
+        puts msg
+      end
+    end
+  end
+else
+  module RbBCC
+    module Util
+      def self.debug(msg)
+        # nop
+      end
+    end
+  end
+end

data/lib/rbbcc/table.rb

@@ -78,7 +78,9 @@ module RbBCC
       return next_key
     end
 
-    def [](key)
+    def [](_key)
+      key = normalize_key(_key)
+
       leaf = Fiddle::Pointer.malloc(self.leafsize)
       res = Clib.bpf_lookup_elem(self.map_fd, key, leaf)
       if res < 0
@@ -91,11 +93,20 @@ module RbBCC
       self[key] || raise(KeyError, "key not found")
     end
 
-    def []=(key, leaf)
+    def []=(_key, leaf)
+      key = normalize_key(_key)
       res = Clib.bpf_update_elem(self.map_fd, key, leaf, 0)
       if res < 0
         raise SystemCallError.new("Could not update table", Fiddle.last_error)
       end
+      leaf
+    end
+
+    def delete(key)
+      res = Clib.bpf_delete_elem(self.map_fd, key)
+      if res < 0
+        raise KeyError, "key not found"
+      end
       res
     end
 
@@ -127,6 +138,11 @@ module RbBCC
       enum_for(:each_pair).to_a
     end
 
+    def clear
+      each_key {|key| self.delete(key) }
+      return items # reload contents
+    end
+
     def print_log2_hist(val_type="value",
                         section_header: "Bucket ptr",
                         section_print_fn: nil,
@@ -167,6 +183,17 @@ module RbBCC
     end
 
     private
+    def normalize_key(key)
+      case key
+      when Fiddle::Pointer
+        key
+      when Integer
+        byref(key, keysize)
+      else
+        raise KeyError, "#{key.inspect} must be integer or pointor"
+      end
+    end
+
     def byref(value, size=sizeof("int"))
       pack_fmt = case size
                  when sizeof("int") ; "i!"
@@ -194,8 +221,13 @@ module RbBCC
     end
     alias length size
 
-    def [](key)
-      super(normalize_key(key))
+    def clearitem(key)
+      self[key] = byref(0, @leafsize)
+    end
+
+    def delete(key)
+      # Delete in Array type does not have an effect, so zero out instead
+      clearitem(key)
     end
 
     def each(&b)
@@ -203,18 +235,6 @@ module RbBCC
         b.call(v.to_bcc_value)
       end
     end
-
-    private
-    def normalize_key(key)
-      case key
-      when Fiddle::Pointer
-        key
-      when Integer
-        byref(key, keysize)
-      else
-        raise KeyError, "#{key.inspect} must be integer or pointor"
-      end
-    end
   end
 
   class PerfEventArray < TableBase

data/lib/rbbcc/usdt.rb

@@ -4,15 +4,21 @@ module RbBCC
   USDTProbe = Struct.new(:binpath, :fn_name, :addr, :pid)
 
   class USDT
-    # TODO path:
-    def initialize(pid:)
+    def initialize(pid: nil, path: nil)
       @pid = pid
-      @context = Clib.bcc_usdt_new_frompid(pid, nil)
+      @path = path
+      if pid
+        @context = Clib.bcc_usdt_new_frompid(pid, path)
+      elsif path
+        @context = Clib.bcc_usdt_new_frompath(path)
+      else
+        raise "Either a pid or a binary path must be specified"
+      end
       if !@context || @context.null?
         raise SystemCallError.new(Fiddle.last_error)
       end
     end
-    attr_reader :pid, :context
+    attr_reader :pid, :path, :context
 
     def enable_probe(probe:, fn_name:)
       ret = Clib.bcc_usdt_enable_probe(@context, probe, fn_name)
@@ -33,5 +39,16 @@ module RbBCC
 
       return probes
     end
+
+    private
+    def __del__
+      lambda { Clib.bcc_usdt_close(@context); Util.debug("USDT GC'ed.") }
+    end
+  end
+end
+
+at_exit do
+  ObjectSpace.each_object(RbBCC::USDT) do |o|
+    o.send(:__del__).call
   end
 end

data/lib/rbbcc/version.rb

@@ -1,3 +1,3 @@
 module RbBCC
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/rbbcc.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = RbBCC::VERSION
   spec.authors       = ["Uchio Kondo"]
   spec.email         = ["udzura@udzura.jp"]
+  spec.license       = "Apache-2.0"
 
   spec.summary       = %q{BCC port for MRI}
   spec.description   = %q{BCC port for MRI. See https://github.com/iovisor/bcc}
@@ -20,8 +21,4 @@ Gem::Specification.new do |spec|
   #spec.bindir        = "exe"
   #spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry"
 end

data/semaphore.sh

@@ -0,0 +1,73 @@
+#!/bin/bash
+
+# packages
+
+sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 4052245BD4284CDD
+echo "deb https://repo.iovisor.org/apt/$(lsb_release -cs) $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/iovisor.list
+sudo apt -y update
+sudo apt -y install libbcc
+
+# build libbcc 0.11/0.12
+ORIG_DIR=$(pwd)
+sudo mkdir -p /opt/bcc
+
+cd /
+sudo chown $(whoami) /opt/bcc
+cache has_key libbcc-so && cache restore libbcc-so
+sudo chown -R root /opt/bcc
+cd -
+
+if test "$(ls /opt/bcc | wc -l)" -le "0"; then
+  sudo apt -y install bison build-essential cmake flex git libedit-dev \
+    libllvm6.0 llvm-6.0-dev libclang-6.0-dev python zlib1g-dev libelf-dev
+
+  sudo mkdir -p /opt/bcc-work
+  sudo chown $(whoami) /opt/bcc-work
+  cd /opt/bcc-work
+  git clone https://github.com/iovisor/bcc.git
+  mkdir bcc/build
+  cd bcc
+
+  git checkout v0.11.0
+  git submodule init
+  git submodule sync
+  git submodule update
+  cd build
+  cmake .. -DCMAKE_INSTALL_PREFIX=/opt/bcc
+  make -j$(nproc)
+  sudo make install
+  make clean
+  cd ..
+
+  V0_12_HASH=2d099cd8c5cb1598d6e911c0b389132ebc7c101b
+  git checkout $V0_12_HASH
+  git submodule init
+  git submodule sync
+  git submodule update
+  cd build
+  cmake .. -DCMAKE_INSTALL_PREFIX=/opt/bcc
+  make -j$(nproc)
+  sudo make install
+
+  cd /
+  cache has_key libbcc-so && cache clear libbcc-so
+  cache store libbcc-so opt/bcc
+  cd -
+fi
+cd $ORIG_DIR
+
+# link all tha objects under /lib from /opt/bcc
+sudo ln -sf /opt/bcc/lib/libbcc.so.0.11.0 /opt/bcc/lib/libbcc.so.0.12.0 /usr/lib/x86_64-linux-gnu/
+
+# Doing tests
+set -e
+
+bundle install --path vendor/bundle
+
+bundle exec ruby -e "require 'rbbcc'; puts 'Using rbbcc: %s && libbcc: %s' % [RbBCC::VERSION, RbBCC::Clib.libbcc_version.to_s]"
+if test "$(bundle exec ruby -e 'require %q(rbbcc); print RbBCC::Clib.libbcc_version.to_s')" != "${LIBBCC_VERSION}"; then
+  echo "Test target mismatch"
+  exit 127
+fi
+
+sudo -E env PATH=$PATH bundle exec rake test