`io-blk.so`

Block I/O support

Syntax:

driver [blk option[,option...]] [fstype [options]]

Options:

The driver is one of the devb-* drivers, such as devb-eide, and option is one of the options described below.

The optional fstype argument is one of the filesystem drivers (fs-*); you can follow it with options specific to the filesystem.

Suffixes for memory sizes

You can specify the memory sizes used by io-blk.so with any of the following suffixes:

b -- bytes
k -- kilobytes
m -- megabytes
p -- pages
% -- percent of the total amount of cache, alloc, etc., depending on the option

`blk` options

You can specify the following options only in the blk section:

alloc=mode

Set the cache/memory allocation policy to one of the following:

cache (the default) -- allocate all of the buffer cache (the cache=size) at startup, but allocate all other caches (e.g. names) on demand and let them grow to their specified limit, and then start LRUing.
demand -- allocate the buffer cache the same way, on-demand (it will grow from 0 to the size specified by the cache option as you access the disk).
upfront -- pregrow all caches to their full size. This option can be useful in RAM-tuning a system, to see how much memory the filesystem will eventually consume (things such as the name and vnode caches tend to grow over time).

auto=amount

Set the amount of automounting to be performed; amount is one of:

none -- only raw block devices appear.
partition -- enumerate any partition tables.

The default is partition.

automount=dev[:mountpoint[:fstype[:options]]] automount=@filename

Create a mountpoint for dev at mountpoint. If you don't specify a full path for the device, io-blk.so uses the value of its devdir option as a prefix. For example, if devdir is /dev (the default), an option of automount=hd0t77:/disk mounts /dev/hd0t77 at /disk.

The optional fstype specifies the filesystem type, after which you can set options. The choices of filesystem and the associated shared objects are:

cd: fs-cd.so
dos: fs-dos.so
ext2: fs-ext2.so
qnx4: fs-qnx4.so
qnx6: fs-qnx6.so
udf: fs-udf.so

If not specified, the library tries to determine the filesystem automatically.

If the @filename version of this option is used, the automounts are as specified in the given file. The file is a list of mounts (using the same syntax as above), separated by newline characters or commas.

You can't locate the filename file in the filesystem to be automounted: it has to be available in an existing filesystem such as the image filesystem. Optionally, you could locate it in any devb filesystem that's already running.

To mount multiple filesystems on a (removable) device, specify that the device is shared with a + prefix. For example,

automount=+fd0:/dos/a:dos,automount=+fd0:/fd:qnx4

For a list of common partition types, see the Filesystems chapter of the System Architecture guide.

bufsz=min:max

The size, in bytes, of the smallest and largest physical sector. The default is 512:8K.

cache=total

The total in-memory cache size allowed. Cache memory is allocated as necessary beyond the initial amount specified by the alloc= option until the total size is reached. The memory size uses the suffixes described above; the default is 15% of system RAM.

The default cache size is excessive for devb-fdc. You'll probably want to reduce it to something more reasonable:

devb-fdc blk cache=128k &

delwri=delay

Specify the delay time for delayed writes. A dirty disk block remains in the cache without being physically written to the disk for up to delay seconds. The default is 2 seconds. For more information, see "Controlling writing operations," below.

devdir=path

The directory in which io-blk presents the physical devices as block-special files. The default is /dev.

devno=type

Controls how major device numbers are requested; type is one of:

name -- use the name of the device (e.g. hd, cd).
class -- use the CAM class of the device (e.g. direct, readonly).
common -- use a single class for all block devices.

fdinfo=mode

Specify the storing of open file names for the iofdinfo() query. The options for mode are:

ncache: Try to reconstruct the file name from the contents of the directory name cache. Don't rely on this option to supply the names of all open files (a file's name is supplied only if all components of its pathname are in the name cache).
always: The default. Store the name used in each open() call to ensure that this name is always available.
never: Never supply the name of an open file.

hash=size

Set the number of entries in the buffer cache hash list. If this option isn't specified, the default is the value of the cache option.

map=size

Set the number of entries in a cache used to map translations from logical blocks to physical ones. If this option isn't specified, the size is based in the value of the vnode option.

naming=scheme

Set the device/partition naming scheme. The default is 0#.

ncache=size

Specify a name cache of size entries. Using more name cache entries speeds up path/file lookups at the expense of memory. Setting the size to 0 disables name caching. If this option isn't specified, the size is determined from the vnode option.

noaiod

Disable asynchronous iodone processing, doing the processing instead in the context of the driver thread. By default, this is handled by a dedicated thread.

nora

Disable read-ahead. If read-ahead is enabled (the default), sequential file access patterns are noted and cause a preread of the blocks most likely to be requested next.

postpone=time

Keep a dirty disk block in memory for time seconds if it's being continuously modified before physically writing it to the disk. Setting the postpone= option ensures that the continuously modified block gets written to disk periodically (every time seconds). The default is determined from the delwri option.

protect=number

Set the number of protected extra LRU passes. The default is 2.

ramdisk=size

Create an internal ramdisk device (/dev/ramX) of the specified size. The size variable can use the suffixes described above. The initial contents of this memory device are unspecified, so it must be formatted before use as a filesystem (see dinit in the Utilities Reference).

rmvpoll=period

The polling period, in seconds, for removable media (default: 0).

rmvto=delay

Specify a removable media timeout of delay seconds (default: 2 seconds). After delay seconds of inactivity, a disk access prompts validation of the media with the driver; if it reports that the media has been changed, all data blocks and cached information for that device are discarded and relearned.

thread=[max]:[low]:[high]

Set the thread pool parameters (maximum, low water, and high water). The default is 12:2:5.

verbose[=level]

Be verbose. The output is sent to the system logger, slogger.

The optional level argument is a series of alphabetic characters that indicates the categories of event to log:

b -- bad blocks
c -- configuration
i -- input
o -- output
d -- direct I/O
r -- removable
v -- virtual filesystem (VFS)
f -- fsys module (fs-*)

An option of blk verbose means all, blk verbose=io means input plus output, blk verbose=!r means everything except removable, and so on.

vnode=size

Specify the number of vnode entries (default: 1280 entries). Up to size vnodes may be active. Vnodes remain in this cache when the corresponding file is closed, making subsequent opens faster.

wipe=size

Set the amount of cache that may be occupied by a single file. This option is used to prevent the "cache wiping" phenomenon, where reading a large file may flush a large proportion of buffer cache. The size can use the suffixes described above; the default is 100% (i.e. no limit is enforced).

Filesystem options

You can apply the following options globally (in the blk section) or to a specific filesystem (for example, in the qnx4 section for a QNX 4 filesystem):

after

Mount the filesystem so that it's resolved after any other filesystems mounted at the same pathname (in other words, it's placed behind any existing mount). When you access a file, the system looks on this filesystem last, and only if the file wasn't found on any other filesystems.

before

Mount the filesytem so that it's resolved before any other filesystems mounted at the same pathname (in other words, it's placed in front of any existing mount). When you access a file, the system looks on this filesystem first.

commit=level

Set the committing level of the filesystem, which controls how dirty system/user blocks are written to disk. The level is one of none, low, medium (the default), and high. If it's none, all writes are time-delayed (as specified by the delwri option); at high, all writes are performed synchronously. For more information, see "Controlling writing operations," below.

error=action

Set the action to perform when a fs-* filesystem module detects an internal error. The action is one of:

ebadfsys -- simply return EBADFSYS to the client.
mountro -- return EBADFSYS to the client and remount the affected filesystem as read-only.

The default is ebadfsys.

marking=mode

Set the filesystem-dirty marking behavior. The mode must be one of none, mount (the default), or dynamic.

[no]atime

Update/don't update the file's directory entry if the only change is the access time. The noatime option isn't strict POSIX 1003.2 behavior, but it's faster.

[no]creat

Allow/don't allow files to be created on this filesystem.

[no]exec

Allow/don't allow file execution from this filesystem.

[no]lock

Lock/don't lock removable media. If locked, the medium is treated as fixed.

[no]suid

Ignore/don't ignore the set-user ID bit on files in this filesystem.

ro

Mount all drives/filesystems as read-only.

rw

Mount all drives/filesystems as read-write (if the physical media permit).

For more information about the before and after options, see "Ordering mountpoints" in the Process Manager chapter of the System Architecture guide.

Description:

The io-blk.so library provides block I/O support, as used by the devb-*, drivers, and loads filesystem drivers (fs-*) as necessary.

The default values of the map and ncache options are based on the value of the vnode option, and the default value of the hash option depends on the cache option. This arrangement lets you configure a system by specifying the cache size and the number of files, and letting the library set the other options.

Controlling writing operations

There are various types of writing operations:

Synchronous (SYNC): Start immediately and wait for completion.
Asynchronous (ASYNC): Start immediately but don't wait for completion.
Delayed (DELWRI): Don't start until after a timeout period and then perform as asynchronous. The blk delwri= option controls the timeout for the delayed format; if you set this option to 0, a delayed writing operation is the same as asynchronous.
As required: Write only if you have to.

The types of data include:

User: What you read() and write().
Metadata: Things associated with stat(), such as times and IDs.
Filesystem: Things such as bitmaps, extents, etc.

If a file has no links, the "as required" form of write operation is used, never going to disk unless the buffer or cache is needed (since the file has no links, the data isn't expected to be accessable after a power failure). If you open a file with O_SYNC, the synchronous format is always used.

Otherwise, the blk commit level controls the type of write to use for each level of data:

`commit=`	Filesystem data	Metadata	User data
`none`	DELWRI	DELWRI	DELWRI
`low`	ASYNC	DELWRI	DELWRI
`medium`	SYNC	DELWRI	DELWRI
`high`	SYNC	SYNC	SYNC

If you specify commit=none, you lose all write ordering (both for single multiblock updates and multiple-user operations). Hence, your chances of a useful recovery following a power failure are poor. We recommend that you use this option only if you have a uninterruptible power supply (UPS), or if you don't mind using dinit on your filesystem as a recovery tool.

Calling close() might force a metadata update, but does nothing to the user data. Calling fsync() always forces out any delayed-write blocks for the file, and so is useful only when commit isn't high.

io-blk.so