2 * Copyright (c) 1999-2002 Robert N. M. Watson
3 * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
6 * This software was developed by Robert Watson for the TrustedBSD Project.
8 * This software was developed for the FreeBSD Project in part by Network
9 * Associates Laboratories, the Security Research Division of Network
10 * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
11 * as part of the DARPA CHATS research program.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Support for filesystem extended attribute: UFS-specific support functions.
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
48 #include <sys/namei.h>
49 #include <sys/malloc.h>
50 #include <sys/fcntl.h>
53 #include <sys/vnode.h>
54 #include <sys/mount.h>
56 #include <sys/dirent.h>
57 #include <sys/extattr.h>
59 #include <sys/sysctl.h>
63 #include <ufs/ufs/dir.h>
64 #include <ufs/ufs/extattr.h>
65 #include <ufs/ufs/quota.h>
66 #include <ufs/ufs/ufsmount.h>
67 #include <ufs/ufs/inode.h>
68 #include <ufs/ufs/ufs_extern.h>
72 FEATURE(ufs_extattr, "ufs extended attribute support");
74 static MALLOC_DEFINE(M_UFS_EXTATTR, "ufs_extattr", "ufs extended attribute");
76 static int ufs_extattr_sync = 0;
77 SYSCTL_INT(_debug, OID_AUTO, ufs_extattr_sync, CTLFLAG_RW, &ufs_extattr_sync,
80 static int ufs_extattr_valid_attrname(int attrnamespace,
81 const char *attrname);
82 static int ufs_extattr_enable_with_open(struct ufsmount *ump,
83 struct vnode *vp, int attrnamespace, const char *attrname,
85 static int ufs_extattr_enable(struct ufsmount *ump, int attrnamespace,
86 const char *attrname, struct vnode *backing_vnode,
88 static int ufs_extattr_disable(struct ufsmount *ump, int attrnamespace,
89 const char *attrname, struct thread *td);
90 static int ufs_extattr_get(struct vnode *vp, int attrnamespace,
91 const char *name, struct uio *uio, size_t *size,
92 struct ucred *cred, struct thread *td);
93 static int ufs_extattr_set(struct vnode *vp, int attrnamespace,
94 const char *name, struct uio *uio, struct ucred *cred,
96 static int ufs_extattr_rm(struct vnode *vp, int attrnamespace,
97 const char *name, struct ucred *cred, struct thread *td);
98 #ifdef UFS_EXTATTR_AUTOSTART
99 static int ufs_extattr_autostart_locked(struct mount *mp,
102 static int ufs_extattr_start_locked(struct ufsmount *ump,
106 * Per-FS attribute lock protecting attribute operations.
108 * XXXRW: Perhaps something more fine-grained would be appropriate, but at
109 * the end of the day we're going to contend on the vnode lock for the
110 * backing file anyway.
113 ufs_extattr_uepm_lock(struct ufsmount *ump, struct thread *td)
116 sx_xlock(&ump->um_extattr.uepm_lock);
120 ufs_extattr_uepm_unlock(struct ufsmount *ump, struct thread *td)
123 sx_xunlock(&ump->um_extattr.uepm_lock);
127 * Determine whether the name passed is a valid name for an actual
130 * Invalid currently consists of:
131 * NULL pointer for attrname
132 * zero-length attrname (used to retrieve application attribute list)
135 ufs_extattr_valid_attrname(int attrnamespace, const char *attrname)
138 if (attrname == NULL)
140 if (strlen(attrname) == 0)
146 * Locate an attribute given a name and mountpoint.
147 * Must be holding uepm lock for the mount point.
149 static struct ufs_extattr_list_entry *
150 ufs_extattr_find_attr(struct ufsmount *ump, int attrnamespace,
151 const char *attrname)
153 struct ufs_extattr_list_entry *search_attribute;
155 sx_assert(&ump->um_extattr.uepm_lock, SA_XLOCKED);
157 for (search_attribute = LIST_FIRST(&ump->um_extattr.uepm_list);
158 search_attribute != NULL;
159 search_attribute = LIST_NEXT(search_attribute, uele_entries)) {
160 if (!(strncmp(attrname, search_attribute->uele_attrname,
161 UFS_EXTATTR_MAXEXTATTRNAME)) &&
162 (attrnamespace == search_attribute->uele_attrnamespace)) {
163 return (search_attribute);
171 * Initialize per-FS structures supporting extended attributes. Do not
172 * start extended attributes yet.
175 ufs_extattr_uepm_init(struct ufs_extattr_per_mount *uepm)
178 uepm->uepm_flags = 0;
179 LIST_INIT(&uepm->uepm_list);
180 sx_init(&uepm->uepm_lock, "ufs_extattr_sx");
181 uepm->uepm_flags |= UFS_EXTATTR_UEPM_INITIALIZED;
185 * Destroy per-FS structures supporting extended attributes. Assumes
186 * that EAs have already been stopped, and will panic if not.
189 ufs_extattr_uepm_destroy(struct ufs_extattr_per_mount *uepm)
192 if (!(uepm->uepm_flags & UFS_EXTATTR_UEPM_INITIALIZED))
193 panic("ufs_extattr_uepm_destroy: not initialized");
195 if ((uepm->uepm_flags & UFS_EXTATTR_UEPM_STARTED))
196 panic("ufs_extattr_uepm_destroy: called while still started");
199 * It's not clear that either order for the next two lines is
200 * ideal, and it should never be a problem if this is only called
201 * during unmount, and with vfs_busy().
203 uepm->uepm_flags &= ~UFS_EXTATTR_UEPM_INITIALIZED;
204 sx_destroy(&uepm->uepm_lock);
208 * Start extended attribute support on an FS.
211 ufs_extattr_start(struct mount *mp, struct thread *td)
213 struct ufsmount *ump;
218 ufs_extattr_uepm_lock(ump, td);
219 error = ufs_extattr_start_locked(ump, td);
220 ufs_extattr_uepm_unlock(ump, td);
225 ufs_extattr_start_locked(struct ufsmount *ump, struct thread *td)
227 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_INITIALIZED))
229 if (ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED)
232 ump->um_extattr.uepm_flags |= UFS_EXTATTR_UEPM_STARTED;
233 ump->um_extattr.uepm_ucred = crhold(td->td_ucred);
237 #ifdef UFS_EXTATTR_AUTOSTART
239 * Helper routine: given a locked parent directory and filename, return
240 * the locked vnode of the inode associated with the name. Will not
241 * follow symlinks, may return any type of vnode. Lock on parent will
242 * be released even in the event of a failure. In the event that the
243 * target is the parent (i.e., "."), there will be two references and
244 * one lock, requiring the caller to possibly special-case.
246 #define UE_GETDIR_LOCKPARENT 1
247 #define UE_GETDIR_LOCKPARENT_DONT 2
249 ufs_extattr_lookup(struct vnode *start_dvp, int lockparent, char *dirname,
250 struct vnode **vp, struct thread *td)
252 struct vop_cachedlookup_args vargs;
253 struct componentname cnp;
254 struct vnode *target_vp;
257 bzero(&cnp, sizeof(cnp));
258 cnp.cn_nameiop = LOOKUP;
259 cnp.cn_flags = ISLASTCN;
260 if (lockparent == UE_GETDIR_LOCKPARENT)
261 cnp.cn_flags |= LOCKPARENT;
262 cnp.cn_lkflags = LK_EXCLUSIVE;
264 cnp.cn_cred = td->td_ucred;
265 cnp.cn_pnbuf = uma_zalloc(namei_zone, M_WAITOK);
266 cnp.cn_nameptr = cnp.cn_pnbuf;
267 error = copystr(dirname, cnp.cn_pnbuf, MAXPATHLEN,
268 (size_t *) &cnp.cn_namelen);
270 if (lockparent == UE_GETDIR_LOCKPARENT_DONT) {
271 VOP_UNLOCK(start_dvp, 0);
273 uma_zfree(namei_zone, cnp.cn_pnbuf);
274 printf("ufs_extattr_lookup: copystr failed\n");
277 cnp.cn_namelen--; /* trim nul termination */
278 vargs.a_gen.a_desc = NULL;
279 vargs.a_dvp = start_dvp;
280 vargs.a_vpp = &target_vp;
282 error = ufs_lookup(&vargs);
283 uma_zfree(namei_zone, cnp.cn_pnbuf);
286 * Error condition, may have to release the lock on the parent
287 * if ufs_lookup() didn't.
289 if (lockparent == UE_GETDIR_LOCKPARENT_DONT)
290 VOP_UNLOCK(start_dvp, 0);
293 * Check that ufs_lookup() didn't release the lock when we
296 if (lockparent == UE_GETDIR_LOCKPARENT)
297 ASSERT_VOP_LOCKED(start_dvp, "ufs_extattr_lookup");
302 if (target_vp == start_dvp)
303 panic("ufs_extattr_lookup: target_vp == start_dvp");
306 if (target_vp != start_dvp && lockparent == UE_GETDIR_LOCKPARENT_DONT)
307 VOP_UNLOCK(start_dvp, 0);
309 if (lockparent == UE_GETDIR_LOCKPARENT)
310 ASSERT_VOP_LOCKED(start_dvp, "ufs_extattr_lookup");
312 /* printf("ufs_extattr_lookup: success\n"); */
316 #endif /* !UFS_EXTATTR_AUTOSTART */
319 * Enable an EA using the passed filesystem, backing vnode, attribute name,
320 * namespace, and proc. Will perform a VOP_OPEN() on the vp, so expects vp
321 * to be locked when passed in. The vnode will be returned unlocked,
322 * regardless of success/failure of the function. As a result, the caller
323 * will always need to vrele(), but not vput().
326 ufs_extattr_enable_with_open(struct ufsmount *ump, struct vnode *vp,
327 int attrnamespace, const char *attrname, struct thread *td)
331 error = VOP_OPEN(vp, FREAD|FWRITE, td->td_ucred, td, NULL);
333 printf("ufs_extattr_enable_with_open.VOP_OPEN(): failed "
339 VOP_ADD_WRITECOUNT(vp, 1);
345 error = ufs_extattr_enable(ump, attrnamespace, attrname, vp, td);
347 vn_close(vp, FREAD|FWRITE, td->td_ucred, td);
351 #ifdef UFS_EXTATTR_AUTOSTART
353 * Given a locked directory vnode, iterate over the names in the directory
354 * and use ufs_extattr_lookup() to retrieve locked vnodes of potential
355 * attribute files. Then invoke ufs_extattr_enable_with_open() on each
356 * to attempt to start the attribute. Leaves the directory locked on
360 ufs_extattr_iterate_directory(struct ufsmount *ump, struct vnode *dvp,
361 int attrnamespace, struct thread *td)
363 struct vop_readdir_args vargs;
364 struct dirent *dp, *edp;
365 struct vnode *attr_vp;
369 int error, eofflag = 0;
371 if (dvp->v_type != VDIR)
374 dirbuf = malloc(DIRBLKSIZ, M_TEMP, M_WAITOK);
376 auio.uio_iov = &aiov;
378 auio.uio_rw = UIO_READ;
379 auio.uio_segflg = UIO_SYSSPACE;
383 vargs.a_gen.a_desc = NULL;
386 vargs.a_cred = td->td_ucred;
387 vargs.a_eofflag = &eofflag;
388 vargs.a_ncookies = NULL;
389 vargs.a_cookies = NULL;
392 auio.uio_resid = DIRBLKSIZ;
393 aiov.iov_base = dirbuf;
394 aiov.iov_len = DIRBLKSIZ;
395 error = ufs_readdir(&vargs);
397 printf("ufs_extattr_iterate_directory: ufs_readdir "
403 * XXXRW: While in UFS, we always get DIRBLKSIZ returns from
404 * the directory code on success, on other file systems this
405 * may not be the case. For portability, we should check the
406 * read length on return from ufs_readdir().
408 edp = (struct dirent *)&dirbuf[DIRBLKSIZ];
409 for (dp = (struct dirent *)dirbuf; dp < edp; ) {
410 #if (BYTE_ORDER == LITTLE_ENDIAN)
411 dp->d_type = dp->d_namlen;
416 if (dp->d_reclen == 0)
418 error = ufs_extattr_lookup(dvp, UE_GETDIR_LOCKPARENT,
419 dp->d_name, &attr_vp, td);
421 printf("ufs_extattr_iterate_directory: lookup "
422 "%s %d\n", dp->d_name, error);
423 } else if (attr_vp == dvp) {
425 } else if (attr_vp->v_type != VREG) {
428 error = ufs_extattr_enable_with_open(ump,
429 attr_vp, attrnamespace, dp->d_name, td);
432 printf("ufs_extattr_iterate_directory: "
433 "enable %s %d\n", dp->d_name,
435 } else if (bootverbose) {
436 printf("UFS autostarted EA %s\n",
440 dp = (struct dirent *) ((char *)dp + dp->d_reclen);
445 free(dirbuf, M_TEMP);
451 * Auto-start of extended attributes, to be executed (optionally) at
455 ufs_extattr_autostart(struct mount *mp, struct thread *td)
457 struct ufsmount *ump;
461 ufs_extattr_uepm_lock(ump, td);
462 error = ufs_extattr_autostart_locked(mp, td);
463 ufs_extattr_uepm_unlock(ump, td);
468 ufs_extattr_autostart_locked(struct mount *mp, struct thread *td)
470 struct vnode *rvp, *attr_dvp, *attr_system_dvp, *attr_user_dvp;
471 struct ufsmount *ump = VFSTOUFS(mp);
475 * UFS_EXTATTR applies only to UFS1, as UFS2 uses native extended
476 * attributes, so don't autostart.
478 if (ump->um_fstype != UFS1)
482 * Does UFS_EXTATTR_FSROOTSUBDIR exist off the filesystem root?
483 * If so, automatically start EA's.
485 error = VFS_ROOT(mp, LK_EXCLUSIVE, &rvp);
487 printf("ufs_extattr_autostart.VFS_ROOT() returned %d\n",
492 error = ufs_extattr_lookup(rvp, UE_GETDIR_LOCKPARENT_DONT,
493 UFS_EXTATTR_FSROOTSUBDIR, &attr_dvp, td);
495 /* rvp ref'd but now unlocked */
499 if (rvp == attr_dvp) {
500 /* Should never happen. */
507 if (attr_dvp->v_type != VDIR) {
508 printf("ufs_extattr_autostart: %s != VDIR\n",
509 UFS_EXTATTR_FSROOTSUBDIR);
510 goto return_vput_attr_dvp;
513 error = ufs_extattr_start_locked(ump, td);
515 printf("ufs_extattr_autostart: ufs_extattr_start failed (%d)\n",
517 goto return_vput_attr_dvp;
521 * Look for two subdirectories: UFS_EXTATTR_SUBDIR_SYSTEM,
522 * UFS_EXTATTR_SUBDIR_USER. For each, iterate over the sub-directory,
523 * and start with appropriate type. Failures in either don't
524 * result in an over-all failure. attr_dvp is left locked to
525 * be cleaned up on exit.
527 error = ufs_extattr_lookup(attr_dvp, UE_GETDIR_LOCKPARENT,
528 UFS_EXTATTR_SUBDIR_SYSTEM, &attr_system_dvp, td);
530 error = ufs_extattr_iterate_directory(VFSTOUFS(mp),
531 attr_system_dvp, EXTATTR_NAMESPACE_SYSTEM, td);
533 printf("ufs_extattr_iterate_directory returned %d\n",
535 vput(attr_system_dvp);
538 error = ufs_extattr_lookup(attr_dvp, UE_GETDIR_LOCKPARENT,
539 UFS_EXTATTR_SUBDIR_USER, &attr_user_dvp, td);
541 error = ufs_extattr_iterate_directory(VFSTOUFS(mp),
542 attr_user_dvp, EXTATTR_NAMESPACE_USER, td);
544 printf("ufs_extattr_iterate_directory returned %d\n",
549 /* Mask startup failures in sub-directories. */
552 return_vput_attr_dvp:
557 #endif /* !UFS_EXTATTR_AUTOSTART */
560 * Stop extended attribute support on an FS.
563 ufs_extattr_stop(struct mount *mp, struct thread *td)
565 struct ufs_extattr_list_entry *uele;
566 struct ufsmount *ump = VFSTOUFS(mp);
569 ufs_extattr_uepm_lock(ump, td);
571 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED)) {
576 while ((uele = LIST_FIRST(&ump->um_extattr.uepm_list)) != NULL) {
577 ufs_extattr_disable(ump, uele->uele_attrnamespace,
578 uele->uele_attrname, td);
581 ump->um_extattr.uepm_flags &= ~UFS_EXTATTR_UEPM_STARTED;
583 crfree(ump->um_extattr.uepm_ucred);
584 ump->um_extattr.uepm_ucred = NULL;
587 ufs_extattr_uepm_unlock(ump, td);
593 * Enable a named attribute on the specified filesystem; provide an
594 * unlocked backing vnode to hold the attribute data.
597 ufs_extattr_enable(struct ufsmount *ump, int attrnamespace,
598 const char *attrname, struct vnode *backing_vnode, struct thread *td)
600 struct ufs_extattr_list_entry *attribute;
605 if (!ufs_extattr_valid_attrname(attrnamespace, attrname))
607 if (backing_vnode->v_type != VREG)
610 attribute = malloc(sizeof(struct ufs_extattr_list_entry),
611 M_UFS_EXTATTR, M_WAITOK);
612 if (attribute == NULL)
615 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED)) {
620 if (ufs_extattr_find_attr(ump, attrnamespace, attrname)) {
625 strncpy(attribute->uele_attrname, attrname,
626 UFS_EXTATTR_MAXEXTATTRNAME);
627 attribute->uele_attrnamespace = attrnamespace;
628 bzero(&attribute->uele_fileheader,
629 sizeof(struct ufs_extattr_fileheader));
631 attribute->uele_backing_vnode = backing_vnode;
633 auio.uio_iov = &aiov;
635 aiov.iov_base = (caddr_t) &attribute->uele_fileheader;
636 aiov.iov_len = sizeof(struct ufs_extattr_fileheader);
637 auio.uio_resid = sizeof(struct ufs_extattr_fileheader);
638 auio.uio_offset = (off_t) 0;
639 auio.uio_segflg = UIO_SYSSPACE;
640 auio.uio_rw = UIO_READ;
643 vn_lock(backing_vnode, LK_SHARED | LK_RETRY);
644 error = VOP_READ(backing_vnode, &auio, IO_NODELOCKED,
645 ump->um_extattr.uepm_ucred);
648 goto unlock_free_exit;
650 if (auio.uio_resid != 0) {
651 printf("ufs_extattr_enable: malformed attribute header\n");
653 goto unlock_free_exit;
656 if (attribute->uele_fileheader.uef_magic != UFS_EXTATTR_MAGIC) {
657 printf("ufs_extattr_enable: invalid attribute header magic\n");
659 goto unlock_free_exit;
662 if (attribute->uele_fileheader.uef_version != UFS_EXTATTR_VERSION) {
663 printf("ufs_extattr_enable: incorrect attribute header "
666 goto unlock_free_exit;
669 ASSERT_VOP_LOCKED(backing_vnode, "ufs_extattr_enable");
670 LIST_INSERT_HEAD(&ump->um_extattr.uepm_list, attribute,
673 VOP_UNLOCK(backing_vnode, 0);
677 VOP_UNLOCK(backing_vnode, 0);
680 free(attribute, M_UFS_EXTATTR);
685 * Disable extended attribute support on an FS.
688 ufs_extattr_disable(struct ufsmount *ump, int attrnamespace,
689 const char *attrname, struct thread *td)
691 struct ufs_extattr_list_entry *uele;
694 if (!ufs_extattr_valid_attrname(attrnamespace, attrname))
697 uele = ufs_extattr_find_attr(ump, attrnamespace, attrname);
701 LIST_REMOVE(uele, uele_entries);
703 vn_lock(uele->uele_backing_vnode, LK_SHARED | LK_RETRY);
704 ASSERT_VOP_LOCKED(uele->uele_backing_vnode, "ufs_extattr_disable");
705 VOP_UNLOCK(uele->uele_backing_vnode, 0);
706 error = vn_close(uele->uele_backing_vnode, FREAD|FWRITE,
709 free(uele, M_UFS_EXTATTR);
715 * VFS call to manage extended attributes in UFS. If filename_vp is
716 * non-NULL, it must be passed in locked, and regardless of errors in
717 * processing, will be unlocked.
720 ufs_extattrctl(struct mount *mp, int cmd, struct vnode *filename_vp,
721 int attrnamespace, const char *attrname)
723 struct ufsmount *ump = VFSTOUFS(mp);
724 struct thread *td = curthread;
728 * Processes with privilege, but in jail, are not allowed to
729 * configure extended attributes.
731 error = priv_check(td, PRIV_UFS_EXTATTRCTL);
733 if (filename_vp != NULL)
734 VOP_UNLOCK(filename_vp, 0);
739 * We only allow extattrctl(2) on UFS1 file systems, as UFS2 uses
740 * native extended attributes.
742 if (ump->um_fstype != UFS1) {
743 if (filename_vp != NULL)
744 VOP_UNLOCK(filename_vp, 0);
749 case UFS_EXTATTR_CMD_START:
750 if (filename_vp != NULL) {
751 VOP_UNLOCK(filename_vp, 0);
754 if (attrname != NULL)
757 error = ufs_extattr_start(mp, td);
761 case UFS_EXTATTR_CMD_STOP:
762 if (filename_vp != NULL) {
763 VOP_UNLOCK(filename_vp, 0);
766 if (attrname != NULL)
769 error = ufs_extattr_stop(mp, td);
773 case UFS_EXTATTR_CMD_ENABLE:
775 if (filename_vp == NULL)
777 if (attrname == NULL) {
778 VOP_UNLOCK(filename_vp, 0);
783 * ufs_extattr_enable_with_open() will always unlock the
784 * vnode, regardless of failure.
786 ufs_extattr_uepm_lock(ump, td);
787 error = ufs_extattr_enable_with_open(ump, filename_vp,
788 attrnamespace, attrname, td);
789 ufs_extattr_uepm_unlock(ump, td);
793 case UFS_EXTATTR_CMD_DISABLE:
795 if (filename_vp != NULL) {
796 VOP_UNLOCK(filename_vp, 0);
799 if (attrname == NULL)
802 ufs_extattr_uepm_lock(ump, td);
803 error = ufs_extattr_disable(ump, attrnamespace, attrname,
805 ufs_extattr_uepm_unlock(ump, td);
815 * Vnode operating to retrieve a named extended attribute.
818 ufs_getextattr(struct vop_getextattr_args *ap)
821 IN struct vnode *a_vp;
822 IN int a_attrnamespace;
823 IN const char *a_name;
824 INOUT struct uio *a_uio;
826 IN struct ucred *a_cred;
827 IN struct thread *a_td;
831 struct mount *mp = ap->a_vp->v_mount;
832 struct ufsmount *ump = VFSTOUFS(mp);
835 ufs_extattr_uepm_lock(ump, ap->a_td);
837 error = ufs_extattr_get(ap->a_vp, ap->a_attrnamespace, ap->a_name,
838 ap->a_uio, ap->a_size, ap->a_cred, ap->a_td);
840 ufs_extattr_uepm_unlock(ump, ap->a_td);
846 * Real work associated with retrieving a named attribute--assumes that
847 * the attribute lock has already been grabbed.
850 ufs_extattr_get(struct vnode *vp, int attrnamespace, const char *name,
851 struct uio *uio, size_t *size, struct ucred *cred, struct thread *td)
853 struct ufs_extattr_list_entry *attribute;
854 struct ufs_extattr_header ueh;
855 struct iovec local_aiov;
856 struct uio local_aio;
857 struct mount *mp = vp->v_mount;
858 struct ufsmount *ump = VFSTOUFS(mp);
859 struct inode *ip = VTOI(vp);
864 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED))
867 if (strlen(name) == 0)
870 error = extattr_check_cred(vp, attrnamespace, cred, td, VREAD);
874 attribute = ufs_extattr_find_attr(ump, attrnamespace, name);
879 * Allow only offsets of zero to encourage the read/replace
880 * extended attribute semantic. Otherwise we can't guarantee
881 * atomicity, as we don't provide locks for extended attributes.
883 if (uio != NULL && uio->uio_offset != 0)
887 * Find base offset of header in file based on file header size, and
888 * data header size + maximum data size, indexed by inode number.
890 base_offset = sizeof(struct ufs_extattr_fileheader) +
891 ip->i_number * (sizeof(struct ufs_extattr_header) +
892 attribute->uele_fileheader.uef_size);
895 * Read in the data header to see if the data is defined, and if so
898 bzero(&ueh, sizeof(struct ufs_extattr_header));
899 local_aiov.iov_base = (caddr_t) &ueh;
900 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
901 local_aio.uio_iov = &local_aiov;
902 local_aio.uio_iovcnt = 1;
903 local_aio.uio_rw = UIO_READ;
904 local_aio.uio_segflg = UIO_SYSSPACE;
905 local_aio.uio_td = td;
906 local_aio.uio_offset = base_offset;
907 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
912 * Don't need to get a lock on the backing file if the getattr is
913 * being applied to the backing file, as the lock is already held.
915 if (attribute->uele_backing_vnode != vp)
916 vn_lock(attribute->uele_backing_vnode, LK_SHARED | LK_RETRY);
918 error = VOP_READ(attribute->uele_backing_vnode, &local_aio,
919 IO_NODELOCKED, ump->um_extattr.uepm_ucred);
924 if ((ueh.ueh_flags & UFS_EXTATTR_ATTR_FLAG_INUSE) == 0) {
929 /* Valid for the current inode generation? */
930 if (ueh.ueh_i_gen != ip->i_gen) {
932 * The inode itself has a different generation number
933 * than the attribute data. For now, the best solution
934 * is to coerce this to undefined, and let it get cleaned
935 * up by the next write or extattrctl clean.
937 printf("ufs_extattr_get (%s): inode number inconsistency (%d, %ju)\n",
938 mp->mnt_stat.f_mntonname, ueh.ueh_i_gen, (uintmax_t)ip->i_gen);
943 /* Local size consistency check. */
944 if (ueh.ueh_len > attribute->uele_fileheader.uef_size) {
949 /* Return full data size if caller requested it. */
953 /* Return data if the caller requested it. */
955 /* Allow for offset into the attribute data. */
956 uio->uio_offset = base_offset + sizeof(struct
960 * Figure out maximum to transfer -- use buffer size and
963 len = MIN(uio->uio_resid, ueh.ueh_len);
964 old_len = uio->uio_resid;
965 uio->uio_resid = len;
967 error = VOP_READ(attribute->uele_backing_vnode, uio,
968 IO_NODELOCKED, ump->um_extattr.uepm_ucred);
972 uio->uio_resid = old_len - (len - uio->uio_resid);
980 if (attribute->uele_backing_vnode != vp)
981 VOP_UNLOCK(attribute->uele_backing_vnode, 0);
987 * Vnode operation to remove a named attribute.
990 ufs_deleteextattr(struct vop_deleteextattr_args *ap)
993 IN struct vnode *a_vp;
994 IN int a_attrnamespace;
995 IN const char *a_name;
996 IN struct ucred *a_cred;
997 IN struct thread *a_td;
1001 struct mount *mp = ap->a_vp->v_mount;
1002 struct ufsmount *ump = VFSTOUFS(mp);
1005 ufs_extattr_uepm_lock(ump, ap->a_td);
1007 error = ufs_extattr_rm(ap->a_vp, ap->a_attrnamespace, ap->a_name,
1008 ap->a_cred, ap->a_td);
1011 ufs_extattr_uepm_unlock(ump, ap->a_td);
1017 * Vnode operation to set a named attribute.
1020 ufs_setextattr(struct vop_setextattr_args *ap)
1023 IN struct vnode *a_vp;
1024 IN int a_attrnamespace;
1025 IN const char *a_name;
1026 INOUT struct uio *a_uio;
1027 IN struct ucred *a_cred;
1028 IN struct thread *a_td;
1032 struct mount *mp = ap->a_vp->v_mount;
1033 struct ufsmount *ump = VFSTOUFS(mp);
1037 * XXX: No longer a supported way to delete extended attributes.
1039 if (ap->a_uio == NULL)
1042 ufs_extattr_uepm_lock(ump, ap->a_td);
1044 error = ufs_extattr_set(ap->a_vp, ap->a_attrnamespace, ap->a_name,
1045 ap->a_uio, ap->a_cred, ap->a_td);
1047 ufs_extattr_uepm_unlock(ump, ap->a_td);
1053 * Real work associated with setting a vnode's extended attributes;
1054 * assumes that the attribute lock has already been grabbed.
1057 ufs_extattr_set(struct vnode *vp, int attrnamespace, const char *name,
1058 struct uio *uio, struct ucred *cred, struct thread *td)
1060 struct ufs_extattr_list_entry *attribute;
1061 struct ufs_extattr_header ueh;
1062 struct iovec local_aiov;
1063 struct uio local_aio;
1064 struct mount *mp = vp->v_mount;
1065 struct ufsmount *ump = VFSTOUFS(mp);
1066 struct inode *ip = VTOI(vp);
1068 int error = 0, ioflag;
1070 if (vp->v_mount->mnt_flag & MNT_RDONLY)
1072 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED))
1073 return (EOPNOTSUPP);
1074 if (!ufs_extattr_valid_attrname(attrnamespace, name))
1077 error = extattr_check_cred(vp, attrnamespace, cred, td, VWRITE);
1081 attribute = ufs_extattr_find_attr(ump, attrnamespace, name);
1086 * Early rejection of invalid offsets/length.
1087 * Reject: any offset but 0 (replace)
1088 * Any size greater than attribute size limit
1090 if (uio->uio_offset != 0 ||
1091 uio->uio_resid > attribute->uele_fileheader.uef_size)
1095 * Find base offset of header in file based on file header size, and
1096 * data header size + maximum data size, indexed by inode number.
1098 base_offset = sizeof(struct ufs_extattr_fileheader) +
1099 ip->i_number * (sizeof(struct ufs_extattr_header) +
1100 attribute->uele_fileheader.uef_size);
1103 * Write out a data header for the data.
1105 ueh.ueh_len = uio->uio_resid;
1106 ueh.ueh_flags = UFS_EXTATTR_ATTR_FLAG_INUSE;
1107 ueh.ueh_i_gen = ip->i_gen;
1108 local_aiov.iov_base = (caddr_t) &ueh;
1109 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
1110 local_aio.uio_iov = &local_aiov;
1111 local_aio.uio_iovcnt = 1;
1112 local_aio.uio_rw = UIO_WRITE;
1113 local_aio.uio_segflg = UIO_SYSSPACE;
1114 local_aio.uio_td = td;
1115 local_aio.uio_offset = base_offset;
1116 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
1121 * Don't need to get a lock on the backing file if the setattr is
1122 * being applied to the backing file, as the lock is already held.
1124 if (attribute->uele_backing_vnode != vp)
1125 vn_lock(attribute->uele_backing_vnode, LK_EXCLUSIVE | LK_RETRY);
1127 ioflag = IO_NODELOCKED;
1128 if (ufs_extattr_sync)
1130 error = VOP_WRITE(attribute->uele_backing_vnode, &local_aio, ioflag,
1131 ump->um_extattr.uepm_ucred);
1133 goto vopunlock_exit;
1135 if (local_aio.uio_resid != 0) {
1137 goto vopunlock_exit;
1141 * Write out user data.
1143 uio->uio_offset = base_offset + sizeof(struct ufs_extattr_header);
1145 ioflag = IO_NODELOCKED;
1146 if (ufs_extattr_sync)
1148 error = VOP_WRITE(attribute->uele_backing_vnode, uio, ioflag,
1149 ump->um_extattr.uepm_ucred);
1152 uio->uio_offset = 0;
1154 if (attribute->uele_backing_vnode != vp)
1155 VOP_UNLOCK(attribute->uele_backing_vnode, 0);
1161 * Real work associated with removing an extended attribute from a vnode.
1162 * Assumes the attribute lock has already been grabbed.
1165 ufs_extattr_rm(struct vnode *vp, int attrnamespace, const char *name,
1166 struct ucred *cred, struct thread *td)
1168 struct ufs_extattr_list_entry *attribute;
1169 struct ufs_extattr_header ueh;
1170 struct iovec local_aiov;
1171 struct uio local_aio;
1172 struct mount *mp = vp->v_mount;
1173 struct ufsmount *ump = VFSTOUFS(mp);
1174 struct inode *ip = VTOI(vp);
1176 int error = 0, ioflag;
1178 if (vp->v_mount->mnt_flag & MNT_RDONLY)
1180 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED))
1181 return (EOPNOTSUPP);
1182 if (!ufs_extattr_valid_attrname(attrnamespace, name))
1185 error = extattr_check_cred(vp, attrnamespace, cred, td, VWRITE);
1189 attribute = ufs_extattr_find_attr(ump, attrnamespace, name);
1194 * Find base offset of header in file based on file header size, and
1195 * data header size + maximum data size, indexed by inode number.
1197 base_offset = sizeof(struct ufs_extattr_fileheader) +
1198 ip->i_number * (sizeof(struct ufs_extattr_header) +
1199 attribute->uele_fileheader.uef_size);
1202 * Check to see if currently defined.
1204 bzero(&ueh, sizeof(struct ufs_extattr_header));
1206 local_aiov.iov_base = (caddr_t) &ueh;
1207 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
1208 local_aio.uio_iov = &local_aiov;
1209 local_aio.uio_iovcnt = 1;
1210 local_aio.uio_rw = UIO_READ;
1211 local_aio.uio_segflg = UIO_SYSSPACE;
1212 local_aio.uio_td = td;
1213 local_aio.uio_offset = base_offset;
1214 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
1217 * Don't need to get the lock on the backing vnode if the vnode we're
1218 * modifying is it, as we already hold the lock.
1220 if (attribute->uele_backing_vnode != vp)
1221 vn_lock(attribute->uele_backing_vnode, LK_EXCLUSIVE | LK_RETRY);
1223 error = VOP_READ(attribute->uele_backing_vnode, &local_aio,
1224 IO_NODELOCKED, ump->um_extattr.uepm_ucred);
1226 goto vopunlock_exit;
1229 if ((ueh.ueh_flags & UFS_EXTATTR_ATTR_FLAG_INUSE) == 0) {
1231 goto vopunlock_exit;
1234 /* Valid for the current inode generation? */
1235 if (ueh.ueh_i_gen != ip->i_gen) {
1237 * The inode itself has a different generation number than
1238 * the attribute data. For now, the best solution is to
1239 * coerce this to undefined, and let it get cleaned up by
1240 * the next write or extattrctl clean.
1242 printf("ufs_extattr_rm (%s): inode number inconsistency (%d, %jd)\n",
1243 mp->mnt_stat.f_mntonname, ueh.ueh_i_gen, (intmax_t)ip->i_gen);
1245 goto vopunlock_exit;
1248 /* Flag it as not in use. */
1252 local_aiov.iov_base = (caddr_t) &ueh;
1253 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
1254 local_aio.uio_iov = &local_aiov;
1255 local_aio.uio_iovcnt = 1;
1256 local_aio.uio_rw = UIO_WRITE;
1257 local_aio.uio_segflg = UIO_SYSSPACE;
1258 local_aio.uio_td = td;
1259 local_aio.uio_offset = base_offset;
1260 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
1262 ioflag = IO_NODELOCKED;
1263 if (ufs_extattr_sync)
1265 error = VOP_WRITE(attribute->uele_backing_vnode, &local_aio, ioflag,
1266 ump->um_extattr.uepm_ucred);
1268 goto vopunlock_exit;
1270 if (local_aio.uio_resid != 0)
1274 VOP_UNLOCK(attribute->uele_backing_vnode, 0);
1280 * Called by UFS when an inode is no longer active and should have its
1281 * attributes stripped.
1284 ufs_extattr_vnode_inactive(struct vnode *vp, struct thread *td)
1286 struct ufs_extattr_list_entry *uele;
1287 struct mount *mp = vp->v_mount;
1288 struct ufsmount *ump = VFSTOUFS(mp);
1291 * In that case, we cannot lock. We should not have any active vnodes
1292 * on the fs if this is not yet initialized but is going to be, so
1293 * this can go unlocked.
1295 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_INITIALIZED))
1298 ufs_extattr_uepm_lock(ump, td);
1300 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED)) {
1301 ufs_extattr_uepm_unlock(ump, td);
1305 LIST_FOREACH(uele, &ump->um_extattr.uepm_list, uele_entries)
1306 ufs_extattr_rm(vp, uele->uele_attrnamespace,
1307 uele->uele_attrname, NULL, td);
1309 ufs_extattr_uepm_unlock(ump, td);
1312 #endif /* !UFS_EXTATTR */