blob: c2a0871280a02eeaa6c027300207881b4a8825cf [file] [log] [blame]
Mark Fashehccd979b2005-12-15 14:31:24 -08001OCFS2 filesystem
2==================
3OCFS2 is a general purpose extent based shared disk cluster file
4system with many similarities to ext3. It supports 64 bit inode
5numbers, and has automatically extending metadata groups which may
6also make it attractive for non-clustered use.
7
8You'll want to install the ocfs2-tools package in order to at least
9get "mount.ocfs2" and "ocfs2_hb_ctl".
10
11Project web page: http://oss.oracle.com/projects/ocfs2
12Tools web page: http://oss.oracle.com/projects/ocfs2-tools
13OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/
14
15All code copyright 2005 Oracle except when otherwise noted.
16
17CREDITS:
18Lots of code taken from ext3 and other projects.
19
20Authors in alphabetical order:
21Joel Becker <joel.becker@oracle.com>
22Zach Brown <zach.brown@oracle.com>
23Mark Fasheh <mark.fasheh@oracle.com>
24Kurt Hackel <kurt.hackel@oracle.com>
25Sunil Mushran <sunil.mushran@oracle.com>
26Manish Singh <manish.singh@oracle.com>
27
28Caveats
29=======
30Features which OCFS2 does not support yet:
Mark Fashehccd979b2005-12-15 14:31:24 -080031 - quotas
Mark Fashehccd979b2005-12-15 14:31:24 -080032 - Directory change notification (F_NOTIFY)
33 - Distributed Caching (F_SETLEASE/F_GETLEASE/break_lease)
Mark Fashehccd979b2005-12-15 14:31:24 -080034
35Mount options
36=============
37
38OCFS2 supports the following mount options:
39(*) == default
40
41barrier=1 This enables/disables barriers. barrier=0 disables it,
42 barrier=1 enables it.
43errors=remount-ro(*) Remount the filesystem read-only on an error.
44errors=panic Panic and halt the machine if an error occurs.
45intr (*) Allow signals to interrupt cluster operations.
46nointr Do not allow signals to interrupt cluster
47 operations.
Tiger Yangbcd56252006-12-05 10:09:17 +080048atime_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.
Mark Fasheh10b08452007-08-23 11:17:55 -070051data=ordered (*) All data are forced directly out to the main file
52 system prior to its metadata being committed to the
53 journal.
54data=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.
57preferred_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.
Mark Fashehd147b3d2007-11-07 14:40:36 -080060commit=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.
Sunil Mushran2fbe8d12007-12-20 14:58:11 -080071localalloc=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.
Mark Fasheh53fc6222007-12-20 16:49:04 -080074localflocks This disables cluster aware flock.
Joel Becker12462f12008-09-03 20:03:40 -070075inode64 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.
Mark Fasheh696b55d2008-10-07 11:09:24 -070079user_xattr (*) Enables Extended User Attributes.
80nouser_xattr Disables Extended User Attributes.
Tiger Yanga68979b2008-11-14 11:17:52 +080081acl Enables POSIX Access Control Lists support.
82noacl (*) Disables POSIX Access Control Lists support.