Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorris...
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / Documentation / filesystems / ocfs2.txt
blobc2a0871280a02eeaa6c027300207881b4a8825cf
1 OCFS2 filesystem
2 ==================
3 OCFS2 is a general purpose extent based shared disk cluster file
4 system with many similarities to ext3. It supports 64 bit inode
5 numbers, and has automatically extending metadata groups which may
6 also make it attractive for non-clustered use.
8 You'll want to install the ocfs2-tools package in order to at least
9 get "mount.ocfs2" and "ocfs2_hb_ctl".
11 Project web page:    http://oss.oracle.com/projects/ocfs2
12 Tools web page:      http://oss.oracle.com/projects/ocfs2-tools
13 OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/
15 All code copyright 2005 Oracle except when otherwise noted.
17 CREDITS:
18 Lots of code taken from ext3 and other projects.
20 Authors in alphabetical order:
21 Joel Becker   <joel.becker@oracle.com>
22 Zach Brown    <zach.brown@oracle.com>
23 Mark Fasheh   <mark.fasheh@oracle.com>
24 Kurt Hackel   <kurt.hackel@oracle.com>
25 Sunil Mushran <sunil.mushran@oracle.com>
26 Manish Singh  <manish.singh@oracle.com>
28 Caveats
29 =======
30 Features which OCFS2 does not support yet:
31         - quotas
32         - Directory change notification (F_NOTIFY)
33         - Distributed Caching (F_SETLEASE/F_GETLEASE/break_lease)
35 Mount options
36 =============
38 OCFS2 supports the following mount options:
39 (*) == default
41 barrier=1               This enables/disables barriers. barrier=0 disables it,
42                         barrier=1 enables it.
43 errors=remount-ro(*)    Remount the filesystem read-only on an error.
44 errors=panic            Panic and halt the machine if an error occurs.
45 intr            (*)     Allow signals to interrupt cluster operations.
46 nointr                  Do not allow signals to interrupt cluster
47                         operations.
48 atime_quantum=60(*)     OCFS2 will not update atime unless this number
49                         of seconds has passed since the last update.
50                         Set to zero to always update atime.
51 data=ordered    (*)     All data are forced directly out to the main file
52                         system prior to its metadata being committed to the
53                         journal.
54 data=writeback          Data ordering is not preserved, data may be written
55                         into the main file system after its metadata has been
56                         committed to the journal.
57 preferred_slot=0(*)     During mount, try to use this filesystem slot first. If
58                         it is in use by another node, the first empty one found
59                         will be chosen. Invalid values will be ignored.
60 commit=nrsec    (*)     Ocfs2 can be told to sync all its data and metadata
61                         every 'nrsec' seconds. The default value is 5 seconds.
62                         This means that if you lose your power, you will lose
63                         as much as the latest 5 seconds of work (your
64                         filesystem will not be damaged though, thanks to the
65                         journaling).  This default value (or any low value)
66                         will hurt performance, but it's good for data-safety.
67                         Setting it to 0 will have the same effect as leaving
68                         it at the default (5 seconds).
69                         Setting it to very large values will improve
70                         performance.
71 localalloc=8(*)         Allows custom localalloc size in MB. If the value is too
72                         large, the fs will silently revert it to the default.
73                         Localalloc is not enabled for local mounts.
74 localflocks             This disables cluster aware flock.
75 inode64                 Indicates that Ocfs2 is allowed to create inodes at
76                         any location in the filesystem, including those which
77                         will result in inode numbers occupying more than 32
78                         bits of significance.
79 user_xattr      (*)     Enables Extended User Attributes.
80 nouser_xattr            Disables Extended User Attributes.
81 acl                     Enables POSIX Access Control Lists support.
82 noacl           (*)     Disables POSIX Access Control Lists support.