3 .\" Copyright (c) 1996 Doug Rabson
5 .\" All rights reserved.
7 .\" This program is free software.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 .Nd get and set attributes on a file or directory
42 .Fn VOP_GETATTR "struct vnode *vp" "struct vattr *vap" "struct ucred *cred" "struct thread *td"
44 .Fn VOP_SETATTR "struct vnode *vp" "struct vattr *vap" "struct ucred *cred" "struct thread *td"
46 These entry points manipulate various attributes of a file or directory,
47 including file permissions, owner, group, size,
48 access time and modification time.
53 The vnode of the file.
55 The attributes of the file.
57 The user credentials of the calling process.
62 Attributes which are not being modified by
64 should be set to the value
67 may be used to clear all the values, and should generally be used to reset
70 prior to setting specific values.
73 expects the vnode to be locked on entry and will leave the vnode locked on
75 The lock type can be either shared or exclusive.
78 expects the vnode to be locked on entry and will leave the vnode locked on
80 The lock type must be exclusive.
83 returns 0 if it was able to retrieve the attribute data via
85 otherwise an appropriate error is returned.
87 returns zero if the attributes were changed successfully, otherwise an
88 appropriate error is returned.
92 vop_getattr(struct vnode *vp, struct vattr *vap,
93 struct ucred *cred, struct thread *td)
96 * Fill in the contents of *vap with information from
105 vop_setattr(struct vnode *vp, struct vattr *vap,
106 struct ucred *cred, struct thread *td)
109 * Check for unsettable attributes.
111 if ((vap->va_type != VNON) || (vap->va_nlink != VNOVAL) ||
112 (vap->va_fsid != VNOVAL) || (vap->va_fileid != VNOVAL) ||
113 (vap->va_blocksize != VNOVAL) || (vap->va_rdev != VNOVAL) ||
114 ((int)vap->va_bytes != VNOVAL) || (vap->va_gen != VNOVAL)) {
118 if (vap->va_flags != VNOVAL) {
120 * Set the immutable and append flags of the file.
124 if (vap->va_uid != (uid_t)VNOVAL || vap->va_gid != (gid_t)VNOVAL) {
126 * Change owner and/or group of the file.
130 if (vap->va_size != VNOVAL) {
132 * Truncate the file to the specified size.
136 if (vap->va_atime.tv_sec != VNOVAL || vap->va_mtime.tv_sec != VNOVAL) {
138 * Change access and/or modification time of file.
142 if (vap->va_mode != (mode_t)VNOVAL) {
144 * Change permissions of file.
154 The file is immutable.
156 The caller does not have permission to modify the file or directory attributes.
158 The file system is read-only.
165 This man page was written by