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)
116 sx_xlock(&ump->um_extattr.uepm_lock);
120 ufs_extattr_uepm_unlock(struct ufsmount *ump)
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);
219 error = ufs_extattr_start_locked(ump, td);
220 ufs_extattr_uepm_unlock(ump);
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);
340 CTR3(KTR_VFS, "%s: vp %p v_writecount increased to %d", __func__, vp,
347 error = ufs_extattr_enable(ump, attrnamespace, attrname, vp, td);
349 vn_close(vp, FREAD|FWRITE, td->td_ucred, td);
353 #ifdef UFS_EXTATTR_AUTOSTART
355 * Given a locked directory vnode, iterate over the names in the directory
356 * and use ufs_extattr_lookup() to retrieve locked vnodes of potential
357 * attribute files. Then invoke ufs_extattr_enable_with_open() on each
358 * to attempt to start the attribute. Leaves the directory locked on
362 ufs_extattr_iterate_directory(struct ufsmount *ump, struct vnode *dvp,
363 int attrnamespace, struct thread *td)
365 struct vop_readdir_args vargs;
366 struct dirent *dp, *edp;
367 struct vnode *attr_vp;
371 int error, eofflag = 0;
373 if (dvp->v_type != VDIR)
376 dirbuf = malloc(DIRBLKSIZ, M_TEMP, M_WAITOK);
378 auio.uio_iov = &aiov;
380 auio.uio_rw = UIO_READ;
381 auio.uio_segflg = UIO_SYSSPACE;
385 vargs.a_gen.a_desc = NULL;
388 vargs.a_cred = td->td_ucred;
389 vargs.a_eofflag = &eofflag;
390 vargs.a_ncookies = NULL;
391 vargs.a_cookies = NULL;
394 auio.uio_resid = DIRBLKSIZ;
395 aiov.iov_base = dirbuf;
396 aiov.iov_len = DIRBLKSIZ;
397 error = ufs_readdir(&vargs);
399 printf("ufs_extattr_iterate_directory: ufs_readdir "
404 edp = (struct dirent *)&dirbuf[DIRBLKSIZ - auio.uio_resid];
405 for (dp = (struct dirent *)dirbuf; dp < edp; ) {
406 if (dp->d_reclen == 0)
408 error = ufs_extattr_lookup(dvp, UE_GETDIR_LOCKPARENT,
409 dp->d_name, &attr_vp, td);
411 printf("ufs_extattr_iterate_directory: lookup "
412 "%s %d\n", dp->d_name, error);
413 } else if (attr_vp == dvp) {
415 } else if (attr_vp->v_type != VREG) {
418 error = ufs_extattr_enable_with_open(ump,
419 attr_vp, attrnamespace, dp->d_name, td);
422 printf("ufs_extattr_iterate_directory: "
423 "enable %s %d\n", dp->d_name,
425 } else if (bootverbose) {
426 printf("UFS autostarted EA %s\n",
430 dp = (struct dirent *) ((char *)dp + dp->d_reclen);
435 free(dirbuf, M_TEMP);
441 * Auto-start of extended attributes, to be executed (optionally) at
445 ufs_extattr_autostart(struct mount *mp, struct thread *td)
447 struct ufsmount *ump;
451 ufs_extattr_uepm_lock(ump);
452 error = ufs_extattr_autostart_locked(mp, td);
453 ufs_extattr_uepm_unlock(ump);
458 ufs_extattr_autostart_locked(struct mount *mp, struct thread *td)
460 struct vnode *rvp, *attr_dvp, *attr_system_dvp, *attr_user_dvp;
461 struct ufsmount *ump = VFSTOUFS(mp);
465 * UFS_EXTATTR applies only to UFS1, as UFS2 uses native extended
466 * attributes, so don't autostart.
468 if (ump->um_fstype != UFS1)
472 * Does UFS_EXTATTR_FSROOTSUBDIR exist off the filesystem root?
473 * If so, automatically start EA's.
475 error = VFS_ROOT(mp, LK_EXCLUSIVE, &rvp);
477 printf("ufs_extattr_autostart.VFS_ROOT() returned %d\n",
482 error = ufs_extattr_lookup(rvp, UE_GETDIR_LOCKPARENT_DONT,
483 UFS_EXTATTR_FSROOTSUBDIR, &attr_dvp, td);
485 /* rvp ref'd but now unlocked */
489 if (rvp == attr_dvp) {
490 /* Should never happen. */
497 if (attr_dvp->v_type != VDIR) {
498 printf("ufs_extattr_autostart: %s != VDIR\n",
499 UFS_EXTATTR_FSROOTSUBDIR);
500 goto return_vput_attr_dvp;
503 error = ufs_extattr_start_locked(ump, td);
505 printf("ufs_extattr_autostart: ufs_extattr_start failed (%d)\n",
507 goto return_vput_attr_dvp;
511 * Look for two subdirectories: UFS_EXTATTR_SUBDIR_SYSTEM,
512 * UFS_EXTATTR_SUBDIR_USER. For each, iterate over the sub-directory,
513 * and start with appropriate type. Failures in either don't
514 * result in an over-all failure. attr_dvp is left locked to
515 * be cleaned up on exit.
517 error = ufs_extattr_lookup(attr_dvp, UE_GETDIR_LOCKPARENT,
518 UFS_EXTATTR_SUBDIR_SYSTEM, &attr_system_dvp, td);
520 error = ufs_extattr_iterate_directory(VFSTOUFS(mp),
521 attr_system_dvp, EXTATTR_NAMESPACE_SYSTEM, td);
523 printf("ufs_extattr_iterate_directory returned %d\n",
525 vput(attr_system_dvp);
528 error = ufs_extattr_lookup(attr_dvp, UE_GETDIR_LOCKPARENT,
529 UFS_EXTATTR_SUBDIR_USER, &attr_user_dvp, td);
531 error = ufs_extattr_iterate_directory(VFSTOUFS(mp),
532 attr_user_dvp, EXTATTR_NAMESPACE_USER, td);
534 printf("ufs_extattr_iterate_directory returned %d\n",
539 /* Mask startup failures in sub-directories. */
542 return_vput_attr_dvp:
547 #endif /* !UFS_EXTATTR_AUTOSTART */
550 * Stop extended attribute support on an FS.
553 ufs_extattr_stop(struct mount *mp, struct thread *td)
555 struct ufs_extattr_list_entry *uele;
556 struct ufsmount *ump = VFSTOUFS(mp);
559 ufs_extattr_uepm_lock(ump);
561 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED)) {
566 while ((uele = LIST_FIRST(&ump->um_extattr.uepm_list)) != NULL) {
567 ufs_extattr_disable(ump, uele->uele_attrnamespace,
568 uele->uele_attrname, td);
571 ump->um_extattr.uepm_flags &= ~UFS_EXTATTR_UEPM_STARTED;
573 crfree(ump->um_extattr.uepm_ucred);
574 ump->um_extattr.uepm_ucred = NULL;
577 ufs_extattr_uepm_unlock(ump);
583 * Enable a named attribute on the specified filesystem; provide an
584 * unlocked backing vnode to hold the attribute data.
587 ufs_extattr_enable(struct ufsmount *ump, int attrnamespace,
588 const char *attrname, struct vnode *backing_vnode, struct thread *td)
590 struct ufs_extattr_list_entry *attribute;
595 if (!ufs_extattr_valid_attrname(attrnamespace, attrname))
597 if (backing_vnode->v_type != VREG)
600 attribute = malloc(sizeof(struct ufs_extattr_list_entry),
601 M_UFS_EXTATTR, M_WAITOK);
603 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED)) {
608 if (ufs_extattr_find_attr(ump, attrnamespace, attrname)) {
613 strncpy(attribute->uele_attrname, attrname,
614 UFS_EXTATTR_MAXEXTATTRNAME);
615 attribute->uele_attrnamespace = attrnamespace;
616 bzero(&attribute->uele_fileheader,
617 sizeof(struct ufs_extattr_fileheader));
619 attribute->uele_backing_vnode = backing_vnode;
621 auio.uio_iov = &aiov;
623 aiov.iov_base = (caddr_t) &attribute->uele_fileheader;
624 aiov.iov_len = sizeof(struct ufs_extattr_fileheader);
625 auio.uio_resid = sizeof(struct ufs_extattr_fileheader);
626 auio.uio_offset = (off_t) 0;
627 auio.uio_segflg = UIO_SYSSPACE;
628 auio.uio_rw = UIO_READ;
631 vn_lock(backing_vnode, LK_SHARED | LK_RETRY);
632 error = VOP_READ(backing_vnode, &auio, IO_NODELOCKED,
633 ump->um_extattr.uepm_ucred);
636 goto unlock_free_exit;
638 if (auio.uio_resid != 0) {
639 printf("ufs_extattr_enable: malformed attribute header\n");
641 goto unlock_free_exit;
644 if (attribute->uele_fileheader.uef_magic != UFS_EXTATTR_MAGIC) {
645 printf("ufs_extattr_enable: invalid attribute header magic\n");
647 goto unlock_free_exit;
650 if (attribute->uele_fileheader.uef_version != UFS_EXTATTR_VERSION) {
651 printf("ufs_extattr_enable: incorrect attribute header "
654 goto unlock_free_exit;
657 ASSERT_VOP_LOCKED(backing_vnode, "ufs_extattr_enable");
658 LIST_INSERT_HEAD(&ump->um_extattr.uepm_list, attribute,
661 VOP_UNLOCK(backing_vnode, 0);
665 VOP_UNLOCK(backing_vnode, 0);
668 free(attribute, M_UFS_EXTATTR);
673 * Disable extended attribute support on an FS.
676 ufs_extattr_disable(struct ufsmount *ump, int attrnamespace,
677 const char *attrname, struct thread *td)
679 struct ufs_extattr_list_entry *uele;
682 if (!ufs_extattr_valid_attrname(attrnamespace, attrname))
685 uele = ufs_extattr_find_attr(ump, attrnamespace, attrname);
689 LIST_REMOVE(uele, uele_entries);
691 vn_lock(uele->uele_backing_vnode, LK_SHARED | LK_RETRY);
692 ASSERT_VOP_LOCKED(uele->uele_backing_vnode, "ufs_extattr_disable");
693 VOP_UNLOCK(uele->uele_backing_vnode, 0);
694 error = vn_close(uele->uele_backing_vnode, FREAD|FWRITE,
697 free(uele, M_UFS_EXTATTR);
703 * VFS call to manage extended attributes in UFS. If filename_vp is
704 * non-NULL, it must be passed in locked, and regardless of errors in
705 * processing, will be unlocked.
708 ufs_extattrctl(struct mount *mp, int cmd, struct vnode *filename_vp,
709 int attrnamespace, const char *attrname)
711 struct ufsmount *ump = VFSTOUFS(mp);
712 struct thread *td = curthread;
716 * Processes with privilege, but in jail, are not allowed to
717 * configure extended attributes.
719 error = priv_check(td, PRIV_UFS_EXTATTRCTL);
721 if (filename_vp != NULL)
722 VOP_UNLOCK(filename_vp, 0);
727 * We only allow extattrctl(2) on UFS1 file systems, as UFS2 uses
728 * native extended attributes.
730 if (ump->um_fstype != UFS1) {
731 if (filename_vp != NULL)
732 VOP_UNLOCK(filename_vp, 0);
737 case UFS_EXTATTR_CMD_START:
738 if (filename_vp != NULL) {
739 VOP_UNLOCK(filename_vp, 0);
742 if (attrname != NULL)
745 error = ufs_extattr_start(mp, td);
749 case UFS_EXTATTR_CMD_STOP:
750 if (filename_vp != NULL) {
751 VOP_UNLOCK(filename_vp, 0);
754 if (attrname != NULL)
757 error = ufs_extattr_stop(mp, td);
761 case UFS_EXTATTR_CMD_ENABLE:
763 if (filename_vp == NULL)
765 if (attrname == NULL) {
766 VOP_UNLOCK(filename_vp, 0);
771 * ufs_extattr_enable_with_open() will always unlock the
772 * vnode, regardless of failure.
774 ufs_extattr_uepm_lock(ump);
775 error = ufs_extattr_enable_with_open(ump, filename_vp,
776 attrnamespace, attrname, td);
777 ufs_extattr_uepm_unlock(ump);
781 case UFS_EXTATTR_CMD_DISABLE:
783 if (filename_vp != NULL) {
784 VOP_UNLOCK(filename_vp, 0);
787 if (attrname == NULL)
790 ufs_extattr_uepm_lock(ump);
791 error = ufs_extattr_disable(ump, attrnamespace, attrname,
793 ufs_extattr_uepm_unlock(ump);
803 * Vnode operating to retrieve a named extended attribute.
806 ufs_getextattr(struct vop_getextattr_args *ap)
809 IN struct vnode *a_vp;
810 IN int a_attrnamespace;
811 IN const char *a_name;
812 INOUT struct uio *a_uio;
814 IN struct ucred *a_cred;
815 IN struct thread *a_td;
819 struct mount *mp = ap->a_vp->v_mount;
820 struct ufsmount *ump = VFSTOUFS(mp);
823 ufs_extattr_uepm_lock(ump);
825 error = ufs_extattr_get(ap->a_vp, ap->a_attrnamespace, ap->a_name,
826 ap->a_uio, ap->a_size, ap->a_cred, ap->a_td);
828 ufs_extattr_uepm_unlock(ump);
834 * Real work associated with retrieving a named attribute--assumes that
835 * the attribute lock has already been grabbed.
838 ufs_extattr_get(struct vnode *vp, int attrnamespace, const char *name,
839 struct uio *uio, size_t *size, struct ucred *cred, struct thread *td)
841 struct ufs_extattr_list_entry *attribute;
842 struct ufs_extattr_header ueh;
843 struct iovec local_aiov;
844 struct uio local_aio;
845 struct mount *mp = vp->v_mount;
846 struct ufsmount *ump = VFSTOUFS(mp);
847 struct inode *ip = VTOI(vp);
852 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED))
855 if (strlen(name) == 0)
858 error = extattr_check_cred(vp, attrnamespace, cred, td, VREAD);
862 attribute = ufs_extattr_find_attr(ump, attrnamespace, name);
867 * Allow only offsets of zero to encourage the read/replace
868 * extended attribute semantic. Otherwise we can't guarantee
869 * atomicity, as we don't provide locks for extended attributes.
871 if (uio != NULL && uio->uio_offset != 0)
875 * Find base offset of header in file based on file header size, and
876 * data header size + maximum data size, indexed by inode number.
878 base_offset = sizeof(struct ufs_extattr_fileheader) +
879 ip->i_number * (sizeof(struct ufs_extattr_header) +
880 attribute->uele_fileheader.uef_size);
883 * Read in the data header to see if the data is defined, and if so
886 bzero(&ueh, sizeof(struct ufs_extattr_header));
887 local_aiov.iov_base = (caddr_t) &ueh;
888 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
889 local_aio.uio_iov = &local_aiov;
890 local_aio.uio_iovcnt = 1;
891 local_aio.uio_rw = UIO_READ;
892 local_aio.uio_segflg = UIO_SYSSPACE;
893 local_aio.uio_td = td;
894 local_aio.uio_offset = base_offset;
895 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
900 * Don't need to get a lock on the backing file if the getattr is
901 * being applied to the backing file, as the lock is already held.
903 if (attribute->uele_backing_vnode != vp)
904 vn_lock(attribute->uele_backing_vnode, LK_SHARED | LK_RETRY);
906 error = VOP_READ(attribute->uele_backing_vnode, &local_aio,
907 IO_NODELOCKED, ump->um_extattr.uepm_ucred);
912 if ((ueh.ueh_flags & UFS_EXTATTR_ATTR_FLAG_INUSE) == 0) {
917 /* Valid for the current inode generation? */
918 if (ueh.ueh_i_gen != ip->i_gen) {
920 * The inode itself has a different generation number
921 * than the attribute data. For now, the best solution
922 * is to coerce this to undefined, and let it get cleaned
923 * up by the next write or extattrctl clean.
925 printf("ufs_extattr_get (%s): inode number inconsistency (%d, %ju)\n",
926 mp->mnt_stat.f_mntonname, ueh.ueh_i_gen, (uintmax_t)ip->i_gen);
931 /* Local size consistency check. */
932 if (ueh.ueh_len > attribute->uele_fileheader.uef_size) {
937 /* Return full data size if caller requested it. */
941 /* Return data if the caller requested it. */
943 /* Allow for offset into the attribute data. */
944 uio->uio_offset = base_offset + sizeof(struct
948 * Figure out maximum to transfer -- use buffer size and
951 len = MIN(uio->uio_resid, ueh.ueh_len);
952 old_len = uio->uio_resid;
953 uio->uio_resid = len;
955 error = VOP_READ(attribute->uele_backing_vnode, uio,
956 IO_NODELOCKED, ump->um_extattr.uepm_ucred);
960 uio->uio_resid = old_len - (len - uio->uio_resid);
968 if (attribute->uele_backing_vnode != vp)
969 VOP_UNLOCK(attribute->uele_backing_vnode, 0);
975 * Vnode operation to remove a named attribute.
978 ufs_deleteextattr(struct vop_deleteextattr_args *ap)
981 IN struct vnode *a_vp;
982 IN int a_attrnamespace;
983 IN const char *a_name;
984 IN struct ucred *a_cred;
985 IN struct thread *a_td;
989 struct mount *mp = ap->a_vp->v_mount;
990 struct ufsmount *ump = VFSTOUFS(mp);
993 ufs_extattr_uepm_lock(ump);
995 error = ufs_extattr_rm(ap->a_vp, ap->a_attrnamespace, ap->a_name,
996 ap->a_cred, ap->a_td);
999 ufs_extattr_uepm_unlock(ump);
1005 * Vnode operation to set a named attribute.
1008 ufs_setextattr(struct vop_setextattr_args *ap)
1011 IN struct vnode *a_vp;
1012 IN int a_attrnamespace;
1013 IN const char *a_name;
1014 INOUT struct uio *a_uio;
1015 IN struct ucred *a_cred;
1016 IN struct thread *a_td;
1020 struct mount *mp = ap->a_vp->v_mount;
1021 struct ufsmount *ump = VFSTOUFS(mp);
1025 * XXX: No longer a supported way to delete extended attributes.
1027 if (ap->a_uio == NULL)
1030 ufs_extattr_uepm_lock(ump);
1032 error = ufs_extattr_set(ap->a_vp, ap->a_attrnamespace, ap->a_name,
1033 ap->a_uio, ap->a_cred, ap->a_td);
1035 ufs_extattr_uepm_unlock(ump);
1041 * Real work associated with setting a vnode's extended attributes;
1042 * assumes that the attribute lock has already been grabbed.
1045 ufs_extattr_set(struct vnode *vp, int attrnamespace, const char *name,
1046 struct uio *uio, struct ucred *cred, struct thread *td)
1048 struct ufs_extattr_list_entry *attribute;
1049 struct ufs_extattr_header ueh;
1050 struct iovec local_aiov;
1051 struct uio local_aio;
1052 struct mount *mp = vp->v_mount;
1053 struct ufsmount *ump = VFSTOUFS(mp);
1054 struct inode *ip = VTOI(vp);
1056 int error = 0, ioflag;
1058 if (vp->v_mount->mnt_flag & MNT_RDONLY)
1060 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED))
1061 return (EOPNOTSUPP);
1062 if (!ufs_extattr_valid_attrname(attrnamespace, name))
1065 error = extattr_check_cred(vp, attrnamespace, cred, td, VWRITE);
1069 attribute = ufs_extattr_find_attr(ump, attrnamespace, name);
1074 * Early rejection of invalid offsets/length.
1075 * Reject: any offset but 0 (replace)
1076 * Any size greater than attribute size limit
1078 if (uio->uio_offset != 0 ||
1079 uio->uio_resid > attribute->uele_fileheader.uef_size)
1083 * Find base offset of header in file based on file header size, and
1084 * data header size + maximum data size, indexed by inode number.
1086 base_offset = sizeof(struct ufs_extattr_fileheader) +
1087 ip->i_number * (sizeof(struct ufs_extattr_header) +
1088 attribute->uele_fileheader.uef_size);
1091 * Write out a data header for the data.
1093 ueh.ueh_len = uio->uio_resid;
1094 ueh.ueh_flags = UFS_EXTATTR_ATTR_FLAG_INUSE;
1095 ueh.ueh_i_gen = ip->i_gen;
1096 local_aiov.iov_base = (caddr_t) &ueh;
1097 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
1098 local_aio.uio_iov = &local_aiov;
1099 local_aio.uio_iovcnt = 1;
1100 local_aio.uio_rw = UIO_WRITE;
1101 local_aio.uio_segflg = UIO_SYSSPACE;
1102 local_aio.uio_td = td;
1103 local_aio.uio_offset = base_offset;
1104 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
1109 * Don't need to get a lock on the backing file if the setattr is
1110 * being applied to the backing file, as the lock is already held.
1112 if (attribute->uele_backing_vnode != vp)
1113 vn_lock(attribute->uele_backing_vnode, LK_EXCLUSIVE | LK_RETRY);
1115 ioflag = IO_NODELOCKED;
1116 if (ufs_extattr_sync)
1118 error = VOP_WRITE(attribute->uele_backing_vnode, &local_aio, ioflag,
1119 ump->um_extattr.uepm_ucred);
1121 goto vopunlock_exit;
1123 if (local_aio.uio_resid != 0) {
1125 goto vopunlock_exit;
1129 * Write out user data.
1131 uio->uio_offset = base_offset + sizeof(struct ufs_extattr_header);
1133 ioflag = IO_NODELOCKED;
1134 if (ufs_extattr_sync)
1136 error = VOP_WRITE(attribute->uele_backing_vnode, uio, ioflag,
1137 ump->um_extattr.uepm_ucred);
1140 uio->uio_offset = 0;
1142 if (attribute->uele_backing_vnode != vp)
1143 VOP_UNLOCK(attribute->uele_backing_vnode, 0);
1149 * Real work associated with removing an extended attribute from a vnode.
1150 * Assumes the attribute lock has already been grabbed.
1153 ufs_extattr_rm(struct vnode *vp, int attrnamespace, const char *name,
1154 struct ucred *cred, struct thread *td)
1156 struct ufs_extattr_list_entry *attribute;
1157 struct ufs_extattr_header ueh;
1158 struct iovec local_aiov;
1159 struct uio local_aio;
1160 struct mount *mp = vp->v_mount;
1161 struct ufsmount *ump = VFSTOUFS(mp);
1162 struct inode *ip = VTOI(vp);
1164 int error = 0, ioflag;
1166 if (vp->v_mount->mnt_flag & MNT_RDONLY)
1168 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED))
1169 return (EOPNOTSUPP);
1170 if (!ufs_extattr_valid_attrname(attrnamespace, name))
1173 error = extattr_check_cred(vp, attrnamespace, cred, td, VWRITE);
1177 attribute = ufs_extattr_find_attr(ump, attrnamespace, name);
1182 * Find base offset of header in file based on file header size, and
1183 * data header size + maximum data size, indexed by inode number.
1185 base_offset = sizeof(struct ufs_extattr_fileheader) +
1186 ip->i_number * (sizeof(struct ufs_extattr_header) +
1187 attribute->uele_fileheader.uef_size);
1190 * Check to see if currently defined.
1192 bzero(&ueh, sizeof(struct ufs_extattr_header));
1194 local_aiov.iov_base = (caddr_t) &ueh;
1195 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
1196 local_aio.uio_iov = &local_aiov;
1197 local_aio.uio_iovcnt = 1;
1198 local_aio.uio_rw = UIO_READ;
1199 local_aio.uio_segflg = UIO_SYSSPACE;
1200 local_aio.uio_td = td;
1201 local_aio.uio_offset = base_offset;
1202 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
1205 * Don't need to get the lock on the backing vnode if the vnode we're
1206 * modifying is it, as we already hold the lock.
1208 if (attribute->uele_backing_vnode != vp)
1209 vn_lock(attribute->uele_backing_vnode, LK_EXCLUSIVE | LK_RETRY);
1211 error = VOP_READ(attribute->uele_backing_vnode, &local_aio,
1212 IO_NODELOCKED, ump->um_extattr.uepm_ucred);
1214 goto vopunlock_exit;
1217 if ((ueh.ueh_flags & UFS_EXTATTR_ATTR_FLAG_INUSE) == 0) {
1219 goto vopunlock_exit;
1222 /* Valid for the current inode generation? */
1223 if (ueh.ueh_i_gen != ip->i_gen) {
1225 * The inode itself has a different generation number than
1226 * the attribute data. For now, the best solution is to
1227 * coerce this to undefined, and let it get cleaned up by
1228 * the next write or extattrctl clean.
1230 printf("ufs_extattr_rm (%s): inode number inconsistency (%d, %jd)\n",
1231 mp->mnt_stat.f_mntonname, ueh.ueh_i_gen, (intmax_t)ip->i_gen);
1233 goto vopunlock_exit;
1236 /* Flag it as not in use. */
1240 local_aiov.iov_base = (caddr_t) &ueh;
1241 local_aiov.iov_len = sizeof(struct ufs_extattr_header);
1242 local_aio.uio_iov = &local_aiov;
1243 local_aio.uio_iovcnt = 1;
1244 local_aio.uio_rw = UIO_WRITE;
1245 local_aio.uio_segflg = UIO_SYSSPACE;
1246 local_aio.uio_td = td;
1247 local_aio.uio_offset = base_offset;
1248 local_aio.uio_resid = sizeof(struct ufs_extattr_header);
1250 ioflag = IO_NODELOCKED;
1251 if (ufs_extattr_sync)
1253 error = VOP_WRITE(attribute->uele_backing_vnode, &local_aio, ioflag,
1254 ump->um_extattr.uepm_ucred);
1256 goto vopunlock_exit;
1258 if (local_aio.uio_resid != 0)
1262 VOP_UNLOCK(attribute->uele_backing_vnode, 0);
1268 * Called by UFS when an inode is no longer active and should have its
1269 * attributes stripped.
1272 ufs_extattr_vnode_inactive(struct vnode *vp, struct thread *td)
1274 struct ufs_extattr_list_entry *uele;
1275 struct mount *mp = vp->v_mount;
1276 struct ufsmount *ump = VFSTOUFS(mp);
1279 * In that case, we cannot lock. We should not have any active vnodes
1280 * on the fs if this is not yet initialized but is going to be, so
1281 * this can go unlocked.
1283 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_INITIALIZED))
1286 ufs_extattr_uepm_lock(ump);
1288 if (!(ump->um_extattr.uepm_flags & UFS_EXTATTR_UEPM_STARTED)) {
1289 ufs_extattr_uepm_unlock(ump);
1293 LIST_FOREACH(uele, &ump->um_extattr.uepm_list, uele_entries)
1294 ufs_extattr_rm(vp, uele->uele_attrnamespace,
1295 uele->uele_attrname, NULL, td);
1297 ufs_extattr_uepm_unlock(ump);
1300 #endif /* !UFS_EXTATTR */