1 .\" Copyright (c) 1996 Doug Rabson
3 .\" All rights reserved.
5 .\" This program is free software.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\" $FreeBSD: src/share/man/man9/VOP_ATTRIB.9,v 1.9.2.2 2001/12/17 11:30:18 ru Exp $
35 .Nd get and set attributes on a file or directory
40 .Fn VOP_GETATTR "struct vnode *vp" "struct vattr *vap" "struct ucred *cred" "struct proc *p"
42 .Fn VOP_SETATTR "struct vnode *vp" "struct vattr *vap" "struct ucred *cred" "struct proc *p"
44 These entry points manipulate various attributes of a file or directory,
45 including file permissions, owner, group, size,
46 access time and modification time.
53 the attributes of the file
55 the user credentials of the calling process
60 Attributes which are not being modified by
62 should be set to the value
66 expects the vnode to be locked on entry and will leave the vnode locked on
70 expects the vnode to be locked on entry and will leave the vnode locked on
74 returns information about the file in
77 returns zero if the attributes were changed successfully, otherwise an
78 appropriate error is returned.
82 vop_getattr(struct vnode *vp, struct vattr *vap,
83 struct ucred *cred, struct proc *p)
86 * Fill in the contents of *vap with information from
95 vop_setattr(struct vnode *vp, struct vattr *vap,
96 struct ucred *cred, struct proc *p)
99 * Check for unsettable attributes.
101 if ((vap->va_type != VNON) || (vap->va_nlink != VNOVAL) ||
102 (vap->va_fsid != VNOVAL) || (vap->va_fileid != VNOVAL) ||
103 (vap->va_blocksize != VNOVAL) || (vap->va_rdev != VNOVAL) ||
104 ((int)vap->va_bytes != VNOVAL) || (vap->va_gen != VNOVAL)) {
108 if (vap->va_flags != VNOVAL) {
110 * Set the immutable and append flags of the file.
114 if (vap->va_uid != (uid_t)VNOVAL || vap->va_gid != (gid_t)VNOVAL) {
116 * Change owner and/or group of the file.
120 if (vap->va_size != VNOVAL) {
122 * Truncate the file to the specified size.
126 if (vap->va_atime.tv_sec != VNOVAL || vap->va_mtime.tv_sec != VNOVAL) {
128 * Change access and/or modification time of file.
132 if (vap->va_mode != (mode_t)VNOVAL) {
134 * Change permissions of file.
144 The file is immutable
148 The filesystem is readonly
154 This man page was written by