1VFS_FILEID(8) System Administration tools VFS_FILEID(8)
2
6 vfs_fileid - Generates file_id structs with unique device id values for
7 cluster setups
8
10 vfs objects = fileid
11
13 This VFS module is part of the samba(7) suite.
14 Samba uses file_id structs to uniquely identify files for locking
16 purpose. By default the file_id contains the device and inode number
17 returned by the stat() system call. As the file_id is a unique
18 identifier of a file, it must be the same on all nodes in a cluster
19 setup. This module overloads the SMB_VFS_FILE_ID_CREATE() operation and
20 generates the device number based on the configured algorithm (see the
21 "fileid:algorithm" option).
22 When using the fsname or fsid algorithm a stat() and statfs() call is
24 required for all mounted file systems to generate the file_id. If e.g.
25 an NFS file system is unresponsive such a call might block and the smbd
26 process will become unresponsive. Use the "fileid:fstype deny",
27 "fileid:fstype allow", "fileid:mntdir deny", or "fileid:mntdir allow"
28 options to ignore potentially unresponsive file systems.
29
31 fileid:algorithm = ALGORITHM
32 Available algorithms are fsname, fsname_nodirs, fsid and hostname.
33 The default value is fsname.
34 The fsname algorithm generates device id by hashing the kernel
36 device name.
37 The fsname_nodirs algorithm generates device id by hashing the
39 kernel device name for files and by hashing the hostname for
40 directories. This can be used to deliberately break lock coherency
41 for directories in a cluster.
42 The fsid algorithm generates the device id from the f_fsid returned
44 from the statfs() syscall.
45 The hostname algorithm generates device id by hashing the hostname.
47 This can be used to deliberately break lock coherency in a cluster.
48 The fsname_norootdir algorithm generates device ids by hashing the
50 kernel device name, except for the root directory of shares where
51 it will use the hostname algorithm. This can be used to
52 deliberately break lock coherency in a cluster for the root
53 directory of a share.
54 The fsname_norootdir_ext algorithm generates device ids by hashing
56 the kernel device name, except for the root directory of shares
57 where it will use the hostname algorithm. Additionally it generates
58 an extid based on the process pid. This can be used to deliberately
59 break lock coherency between all smbd processes in the whole
60 cluster for the root directory of a share.
61 fileid:mapping = ALGORITHM
63 This option is the legacy version of the fileid:algorithm option,
64 which was used in earlier versions of fileid mapping feature in
65 custom Samba 3.0 versions.
66 fileid:fstype deny = LIST
68 List of file system types to be ignored for file_id generation.
69 fileid:fstype allow = LIST
71 List of file system types to be allowed for file_id generation. If
72 this option is set, file system types not listed here are ignored.
73 fileid:mntdir deny = LIST
75 List of file system mount points to be ignored for file_id
76 generation.
77 fileid:mntdir allow = LIST
79 List of file system mount points to be allowed for file_id
80 generation. If this option is set, file system mount points not
81 listed here are ignored.
82 fileid:nolockinode
84 This option triggers use of the fileid hostname algorithm for the
85 configured inode which can be used to deliberately break lock
86 coherency for the corresponding file or directory in a cluster.
87
89 Usage of the fileid module with the fsid algorithm:
90 [global]
92 vfs objects = fileid
93 fileid:algorithm = fsid
94
96 This man page is part of version 4.12.2 of the Samba suite.
97
99 The original Samba software and related utilities were created by
100 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
101 Source project similar to the way the Linux kernel is developed.
102Samba 4.12.2 04/28/2020 VFS_FILEID(8)