filters/blocksize/nbdkit-blocksize-filter.pod

   1 =head1 NAME
   2
   3 nbdkit-blocksize-filter - nbdkit blocksize filter
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit --filter=blocksize plugin [minblock=SIZE] [maxdata=SIZE] \
   8      [maxlen=SIZE] [plugin-args...]
   9
  10 =head1 DESCRIPTION
  11
  12 C<nbdkit-blocksize-filter> is a filter that ensures various block size
  13 limits are met on transactions presented to the plugin.  The NBD
  14 protocol permits clients to send requests with a granularity as small
  15 as 1 byte or as large as nearly 4 gigabytes, although it suggests that
  16 portable clients should align requests to 512 bytes and not exceed 32
  17 megabytes without prior coordination with the server.
  18
  19 Meanwhile, some plugins require requests to be aligned to 512-byte
  20 multiples, or may enforce a maximum transaction size to bound the time
  21 or memory resources spent by any one command (note that nbdkit itself
  22 refuses a read or write larger than 64 megabytes, while many other NBD
  23 servers limit things to 32 megabytes).  The blocksize filter can be
  24 used to modify the client requests to meet the plugin restrictions.
  25
  26 =head1 PARAMETERS
  27
  28 The nbdkit-blocksize-filter accepts the following parameters.
  29
  30 =over 4
  31
  32 =item B<minblock=>SIZE
  33
  34 The minimum block size and alignment to pass to the plugin.  This must
  35 be a power of two, and no larger than 64k.  If omitted, this defaults
  36 to 1 (that is, no minimum size restrictions).  The filter rounds up
  37 read requests to alignment boundaries, performs read-modify-write
  38 cycles for any unaligned head or tail of a write or zero request, and
  39 silently ignores any unaligned head or tail of a trim request.  The
  40 filter also truncates the plugin size down to an aligned value (as it
  41 cannot safely operate on the unaligned tail).  If you need to round
  42 the image size up instead to access the last few bytes, combine this
  43 filter with L<nbdkit-truncate-filter(1)>.
  44
  45 This parameter understands the suffix 'k' for 1024.
  46
  47 =item B<maxdata=>SIZE
  48
  49 The maximum block size for any single transaction with data (read and
  50 write).  If omitted, this defaults to 64 megabytes (that is, the
  51 nbdkit maximum).  This need not be a power of two, but must be an
  52 integer multiple of C<minblock>.  The filter fragments any larger
  53 client request into multiple plugin requests.
  54
  55 This parameter understands the suffixes 'k', 'M', and 'G' for powers
  56 of 1024.
  57
  58 =item B<maxlen=>SIZE
  59
  60 The maximum length for any single transaction without data (trim, zero
  61 or extents).  If omitted, this defaults to 0xffffffff rounded down to
  62 C<minsize> alignment (that is, the inherent 32-bit limit of the NBD
  63 protocol).  This need not be a power of two, but must be an integer
  64 multiple of C<minblock>, and should be at least as large as
  65 C<maxdata>.  The filter fragments any larger client request into
  66 multiple plugin requests.
  67
  68 This parameter understands the suffixes 'k', 'M', and 'G' for powers
  69 of 1024.
  70
  71 =back
  72
  73 =head1 EXAMPLES
  74
  75 Allow an arbitrary client to use the VDDK plugin (which is limited to
  76 512-byte blocks), without having to fix the client to avoid sending
  77 unaligned requests:
  78
  79  nbdkit --filter=blocksize vddk minblock=512 file=/absolute/path/to/file.vmdk
  80
  81 Allow an arbitrary client tuned to nbdkit's 64 megabyte sizing to
  82 connect to a remote server that insists on 32 megabyte sizing, via the
  83 nbd plugin:
  84
  85  nbdkit --filter=blocksize nbd maxdata=32M socket=/path/to/socket
  86
  87 Serve a file as if it were a block device that insists on 4k
  88 alignment, while still allowing access to any unaligned bytes at the
  89 end of the file:
  90
  91  nbdkit --filter=blocksize --filter=truncate file /path/to/file \
  92  minblock=4k round-up=4k
  93
  94 =head1 FILES
  95
  96 =over 4
  97
  98 =item F<$filterdir/nbdkit-blocksize-filter.so>
  99
 100 The filter.
 101
 102 Use C<nbdkit --dump-config> to find the location of C<$filterdir>.
 103
 104 =back
 105
 106 =head1 VERSION
 107
 108 C<nbdkit-blocksize-filter> first appeared in nbdkit 1.4.
 109
 110 =head1 SEE ALSO
 111
 112 L<nbdkit(1)>,
 113 L<nbdkit-nbd-plugin(1)>,
 114 L<nbdkit-vddk-plugin(1)>,
 115 L<nbdkit-filter(3)>,
 116 L<nbdkit-truncate-filter(1)>.
 117
 118 =head1 AUTHORS
 119
 120 Eric Blake
 121
 122 =head1 COPYRIGHT
 123
 124 Copyright (C) 2018 Red Hat Inc.