| 1 | '\" t
|
|---|
| 2 | .\" Title: vfs_preopen
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 12/14/2012
|
|---|
| 6 | .\" Manual: System Administration tools
|
|---|
| 7 | .\" Source: Samba 3.5
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "VFS_PREOPEN" "8" "12/14/2012" "Samba 3\&.5" "System Administration tools"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * set default formatting
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" disable hyphenation
|
|---|
| 15 | .nh
|
|---|
| 16 | .\" disable justification (adjust text to left margin only)
|
|---|
| 17 | .ad l
|
|---|
| 18 | .\" -----------------------------------------------------------------
|
|---|
| 19 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .SH "NAME"
|
|---|
| 22 | vfs_preopen \- Hide read latencies for applications reading numbered files
|
|---|
| 23 | .SH "SYNOPSIS"
|
|---|
| 24 | .HP \w'\ 'u
|
|---|
| 25 | vfs objects = preopen
|
|---|
| 26 | .SH "DESCRIPTION"
|
|---|
| 27 | .PP
|
|---|
| 28 | This VFS module is part of the
|
|---|
| 29 | \fBsamba\fR(7)
|
|---|
| 30 | suite\&.
|
|---|
| 31 | .PP
|
|---|
| 32 | This module assists applications that want to read numbered files in sequence with very strict latency requirements\&. One area where this happens in video streaming applications that want to read one file per frame\&.
|
|---|
| 33 | .PP
|
|---|
| 34 | When you use this module, a number of helper processes is started that speculatively open files and read a number of bytes to prime the file system cache, so that later on when the real application\'s request comes along, no disk access is necessary\&.
|
|---|
| 35 | .PP
|
|---|
| 36 | This module is stackable\&.
|
|---|
| 37 | .SH "OPTIONS"
|
|---|
| 38 | .PP
|
|---|
| 39 | preopen:names = /pattern/
|
|---|
| 40 | .RS 4
|
|---|
| 41 | preopen:names specifies the file name pattern which should trigger the preopen helpers to do their work\&. We assume that the files are numbered incrementally\&. So if your file names are numbered FRAME00000\&.frm FRAME00001\&.frm and so on you would list them as
|
|---|
| 42 | preopen:names=/FRAME*\&.frm/
|
|---|
| 43 | .RE
|
|---|
| 44 | .PP
|
|---|
| 45 | preopen:num_bytes = BYTES
|
|---|
| 46 | .RS 4
|
|---|
| 47 | Specifies the number of bytes the helpers should speculatively read, defaults to 1\&.
|
|---|
| 48 | .RE
|
|---|
| 49 | .PP
|
|---|
| 50 | preopen:helpers = NUM\-PROCS
|
|---|
| 51 | .RS 4
|
|---|
| 52 | Number of forked helper processes, defaults to 1\&.
|
|---|
| 53 | .RE
|
|---|
| 54 | .PP
|
|---|
| 55 | preopen:queuelen = NUM\-FILES
|
|---|
| 56 | .RS 4
|
|---|
| 57 | Number of files that should be speculatively opened\&. Defaults to the 10 subsequent files\&.
|
|---|
| 58 | .RE
|
|---|
| 59 | .SH "VERSION"
|
|---|
| 60 | .PP
|
|---|
| 61 | This man page is correct for version 3\&.3 of the Samba suite\&.
|
|---|
| 62 | .SH "AUTHOR"
|
|---|
| 63 | .PP
|
|---|
| 64 | The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
|
|---|
| 65 | .PP
|
|---|
| 66 | The PREOPEN VFS module was created with contributions from Volker Lendecke and the developers at IBM\&.
|
|---|
