plugins/ruby/example.rb

   1 # Example Ruby plugin.
   2 #
   3 # This example can be freely used for any purpose.
   4
   5 # Run it from the build directory like this:
   6 #
   7 #   ./nbdkit -f -v ruby ./plugins/ruby/example.rb test1=foo test2=bar
   8 #
   9 # Or run it after installing nbdkit like this:
  10 #
  11 #   nbdkit -f -v ruby ./plugins/ruby/example.rb test1=foo test2=bar
  12 #
  13 # The -f -v arguments are optional.  They cause the server to stay in
  14 # the foreground and print debugging, which is useful when testing.
  15 #
  16 # You can connect to the server using guestfish or qemu, eg:
  17 #
  18 #   guestfish --format=raw -a nbd://localhost
  19 #   ><fs> run
  20 #   ><fs> part-disk /dev/sda mbr
  21 #   ><fs> mkfs ext2 /dev/sda1
  22 #   ><fs> list-filesystems
  23 #   ><fs> mount /dev/sda1 /
  24 #   ><fs> [etc]
  25
  26 include Nbdkit
  27
  28 $disk = "\0" * (1024 * 1024)
  29
  30 def config(key, value)
  31   printf("%s = %s\n", key, value)
  32 end
  33
  34 def open(readonly)
  35   # You can return any non-nil Ruby object as a handle.  The
  36   # same object is passed as the first argument to the other
  37   # callbacks.
  38   h = {}
  39   return h
  40 end
  41
  42 def get_size(h)
  43   return $disk.bytesize
  44 end
  45
  46 def pread(h, count, offset)
  47   return $disk.byteslice(offset, count)
  48 end
  49
  50 def pwrite(h, buf, offset)
  51   # Hmm, is this using bytes or chars? XXX
  52   $disk[offset, buf.length] = buf
  53 end
  54
  55 def zero(h, count, offset, may_trim)
  56   if may_trim
  57     $disk[offset, count] = "\0" * count
  58   else
  59     set_error(Errno::EOPNOTSUPP)
  60     raise "falling back to pwrite"
  61   end
  62 end