2 * Copyright (c) 2011-2013 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@dragonflybsd.org>
6 * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * 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
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #include <sys/cdefs.h>
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/types.h>
44 RB_GENERATE2(hammer2_inode_tree, hammer2_inode, rbnode, hammer2_inode_cmp,
48 hammer2_inode_cmp(hammer2_inode_t *ip1, hammer2_inode_t *ip2)
50 if (ip1->inum < ip2->inum)
52 if (ip1->inum > ip2->inum)
60 * HAMMER2 offers shared locks and exclusive locks on inodes.
62 * An inode's ip->chain pointer is resolved and stable while an inode is
63 * locked, and can be cleaned out at any time (become NULL) when an inode
66 * This function handles duplication races which can cause ip's cached
67 * chain to become stale.
69 * The underlying chain is also locked and returned.
71 * NOTE: We don't combine the inode/chain lock because putting away an
72 * inode would otherwise confuse multiple lock holders of the inode.
75 hammer2_inode_lock_ex(hammer2_inode_t *ip)
77 hammer2_chain_t *chain;
78 hammer2_chain_core_t *core;
80 hammer2_inode_ref(ip);
81 ccms_thread_lock(&ip->topo_cst, CCMS_STATE_EXCLUSIVE);
86 if (chain->flags & HAMMER2_CHAIN_DUPLICATED) {
87 spin_lock(&core->cst.spin);
88 while (chain->flags & HAMMER2_CHAIN_DUPLICATED)
89 chain = TAILQ_NEXT(chain, core_entry);
90 hammer2_chain_ref(chain);
91 spin_unlock(&core->cst.spin);
92 hammer2_inode_repoint(ip, NULL, chain);
93 hammer2_chain_drop(chain);
95 hammer2_chain_lock(chain, HAMMER2_RESOLVE_ALWAYS);
96 if ((chain->flags & HAMMER2_CHAIN_DUPLICATED) == 0)
98 hammer2_chain_unlock(chain);
104 hammer2_inode_unlock_ex(hammer2_inode_t *ip, hammer2_chain_t *chain)
107 * XXX this will catch parent directories too which we don't
111 hammer2_chain_unlock(chain);
112 ccms_thread_unlock(&ip->topo_cst);
113 hammer2_inode_drop(ip);
117 * NOTE: We don't combine the inode/chain lock because putting away an
118 * inode would otherwise confuse multiple lock holders of the inode.
120 * Shared locks are especially sensitive to having too many shared
121 * lock counts (from the same thread) on certain paths which might
122 * need to upgrade them. Only one count of a shared lock can be
126 hammer2_inode_lock_sh(hammer2_inode_t *ip)
128 hammer2_chain_t *chain;
130 hammer2_inode_ref(ip);
132 ccms_thread_lock(&ip->topo_cst, CCMS_STATE_SHARED);
135 KKASSERT(chain != NULL); /* for now */
136 hammer2_chain_lock(chain, HAMMER2_RESOLVE_ALWAYS |
137 HAMMER2_RESOLVE_SHARED);
140 * Resolve duplication races
142 if ((chain->flags & HAMMER2_CHAIN_DUPLICATED) == 0)
144 hammer2_chain_unlock(chain);
145 ccms_thread_unlock(&ip->topo_cst);
146 chain = hammer2_inode_lock_ex(ip);
147 hammer2_inode_unlock_ex(ip, chain);
153 hammer2_inode_unlock_sh(hammer2_inode_t *ip, hammer2_chain_t *chain)
156 hammer2_chain_unlock(chain);
157 ccms_thread_unlock(&ip->topo_cst);
158 hammer2_inode_drop(ip);
162 hammer2_inode_lock_temp_release(hammer2_inode_t *ip)
164 return(ccms_thread_lock_temp_release(&ip->topo_cst));
168 hammer2_inode_lock_temp_restore(hammer2_inode_t *ip, ccms_state_t ostate)
170 ccms_thread_lock_temp_restore(&ip->topo_cst, ostate);
174 hammer2_inode_lock_upgrade(hammer2_inode_t *ip)
176 return(ccms_thread_lock_upgrade(&ip->topo_cst));
180 hammer2_inode_lock_downgrade(hammer2_inode_t *ip, ccms_state_t ostate)
182 ccms_thread_lock_downgrade(&ip->topo_cst, ostate);
186 * Lookup an inode by inode number
189 hammer2_inode_lookup(hammer2_pfsmount_t *pmp, hammer2_tid_t inum)
194 spin_lock(&pmp->inum_spin);
195 ip = RB_LOOKUP(hammer2_inode_tree, &pmp->inum_tree, inum);
197 hammer2_inode_ref(ip);
198 spin_unlock(&pmp->inum_spin);
206 * Adding a ref to an inode is only legal if the inode already has at least
210 hammer2_inode_ref(hammer2_inode_t *ip)
212 atomic_add_int(&ip->refs, 1);
216 * Drop an inode reference, freeing the inode when the last reference goes
220 hammer2_inode_drop(hammer2_inode_t *ip)
222 hammer2_pfsmount_t *pmp;
223 hammer2_inode_t *pip;
231 * Transition to zero, must interlock with
232 * the inode inumber lookup tree (if applicable).
234 * NOTE: The super-root inode has no pmp.
238 spin_lock(&pmp->inum_spin);
240 if (atomic_cmpset_int(&ip->refs, 1, 0)) {
241 KKASSERT(ip->topo_cst.count == 0);
242 if (ip->flags & HAMMER2_INODE_ONRBTREE) {
243 atomic_clear_int(&ip->flags,
244 HAMMER2_INODE_ONRBTREE);
245 RB_REMOVE(hammer2_inode_tree,
246 &pmp->inum_tree, ip);
249 spin_unlock(&pmp->inum_spin);
256 * Cleaning out ip->chain isn't entirely
259 hammer2_inode_repoint(ip, NULL, NULL);
262 * We have to drop pip (if non-NULL) to
263 * dispose of our implied reference from
264 * ip->pip. We can simply loop on it.
267 KKASSERT((ip->flags &
268 HAMMER2_INODE_SROOT) == 0);
269 kfree(ip, pmp->minode);
270 atomic_add_long(&pmp->inmem_inodes, -1);
273 HAMMER2_INODE_SROOT);
274 kfree(ip, M_HAMMER2);
277 /* continue with pip (can be NULL) */
280 spin_unlock(&ip->pmp->inum_spin);
284 * Non zero transition
286 if (atomic_cmpset_int(&ip->refs, refs, refs - 1))
293 * Get the vnode associated with the given inode, allocating the vnode if
294 * necessary. The vnode will be returned exclusively locked.
296 * The caller must lock the inode (shared or exclusive).
298 * Great care must be taken to avoid deadlocks and vnode acquisition/reclaim
302 hammer2_igetv(hammer2_inode_t *ip, int *errorp)
304 hammer2_inode_data_t *ipdata;
305 hammer2_pfsmount_t *pmp;
310 KKASSERT(pmp != NULL);
312 ipdata = &ip->chain->data->ipdata;
316 * Attempt to reuse an existing vnode assignment. It is
317 * possible to race a reclaim so the vget() may fail. The
318 * inode must be unlocked during the vget() to avoid a
319 * deadlock against a reclaim.
324 * Inode must be unlocked during the vget() to avoid
325 * possible deadlocks, but leave the ip ref intact.
327 * vnode is held to prevent destruction during the
328 * vget(). The vget() can still fail if we lost
329 * a reclaim race on the vnode.
332 ostate = hammer2_inode_lock_temp_release(ip);
333 if (vget(vp, LK_EXCLUSIVE)) {
335 hammer2_inode_lock_temp_restore(ip, ostate);
338 hammer2_inode_lock_temp_restore(ip, ostate);
340 /* vp still locked and ref from vget */
342 kprintf("hammer2: igetv race %p/%p\n",
352 * No vnode exists, allocate a new vnode. Beware of
353 * allocation races. This function will return an
354 * exclusively locked and referenced vnode.
356 *errorp = getnewvnode(VT_HAMMER2, pmp->mp, &vp, 0, 0);
358 kprintf("hammer2: igetv getnewvnode failed %d\n",
365 * Lock the inode and check for an allocation race.
367 ostate = hammer2_inode_lock_upgrade(ip);
368 if (ip->vp != NULL) {
371 hammer2_inode_lock_downgrade(ip, ostate);
375 switch (ipdata->type) {
376 case HAMMER2_OBJTYPE_DIRECTORY:
379 case HAMMER2_OBJTYPE_REGFILE:
381 vinitvmio(vp, ipdata->size,
383 (int)ipdata->size & HAMMER2_LBUFMASK);
385 case HAMMER2_OBJTYPE_SOFTLINK:
387 * XXX for now we are using the generic file_read
388 * and file_write code so we need a buffer cache
392 vinitvmio(vp, ipdata->size,
394 (int)ipdata->size & HAMMER2_LBUFMASK);
398 panic("hammer2: unhandled objtype %d", ipdata->type);
402 if (ip == pmp->iroot)
403 vsetflags(vp, VROOT);
407 hammer2_inode_ref(ip); /* vp association */
408 hammer2_inode_lock_downgrade(ip, ostate);
413 * Return non-NULL vp and *errorp == 0, or NULL vp and *errorp != 0.
415 if (hammer2_debug & 0x0002) {
416 kprintf("igetv vp %p refs 0x%08x aux 0x%08x\n",
417 vp, vp->v_refcnt, vp->v_auxrefs);
423 * The passed-in chain must be locked and the returned inode will also be
424 * locked. This routine typically locates or allocates the inode, assigns
425 * ip->chain (adding a ref to chain if necessary), and returns the inode.
427 * The hammer2_inode structure regulates the interface between the high level
428 * kernel VNOPS API and the filesystem backend (the chains).
430 * WARNING! This routine sucks up the chain's lock (makes it part of the
431 * inode lock from the point of view of the inode lock API),
432 * so callers need to be careful.
434 * WARNING! The mount code is allowed to pass dip == NULL for iroot and
435 * is allowed to pass pmp == NULL and dip == NULL for sroot.
438 hammer2_inode_get(hammer2_pfsmount_t *pmp, hammer2_inode_t *dip,
439 hammer2_chain_t *chain)
441 hammer2_inode_t *nip;
443 KKASSERT(chain->bref.type == HAMMER2_BREF_TYPE_INODE);
446 * Interlocked lookup/ref of the inode. This code is only needed
447 * when looking up inodes with nlinks != 0 (TODO: optimize out
448 * otherwise and test for duplicates).
452 nip = hammer2_inode_lookup(pmp, chain->data->ipdata.inum);
455 ccms_thread_lock(&nip->topo_cst, CCMS_STATE_EXCLUSIVE);
456 if ((nip->flags & HAMMER2_INODE_ONRBTREE) == 0) { /* race */
457 ccms_thread_unlock(&nip->topo_cst);
458 hammer2_inode_drop(nip);
461 if (nip->chain != chain)
462 hammer2_inode_repoint(nip, NULL, chain);
465 * Consolidated nip/nip->chain is locked (chain locked
472 * We couldn't find the inode number, create a new inode.
475 nip = kmalloc(sizeof(*nip), pmp->minode, M_WAITOK | M_ZERO);
476 atomic_add_long(&pmp->inmem_inodes, 1);
477 hammer2_chain_memory_wakeup(pmp);
479 nip = kmalloc(sizeof(*nip), M_HAMMER2, M_WAITOK | M_ZERO);
480 nip->flags = HAMMER2_INODE_SROOT;
482 nip->inum = chain->data->ipdata.inum;
483 nip->size = chain->data->ipdata.size;
484 nip->mtime = chain->data->ipdata.mtime;
485 hammer2_inode_repoint(nip, NULL, chain);
486 nip->pip = dip; /* can be NULL */
488 hammer2_inode_ref(dip); /* ref dip for nip->pip */
493 * ref and lock on nip gives it state compatible to after a
494 * hammer2_inode_lock_ex() call.
497 ccms_cst_init(&nip->topo_cst, &nip->chain);
498 ccms_thread_lock(&nip->topo_cst, CCMS_STATE_EXCLUSIVE);
499 /* combination of thread lock and chain lock == inode lock */
502 * Attempt to add the inode. If it fails we raced another inode
503 * get. Undo all the work and try again.
506 spin_lock(&pmp->inum_spin);
507 if (RB_INSERT(hammer2_inode_tree, &pmp->inum_tree, nip)) {
508 spin_unlock(&pmp->inum_spin);
509 ccms_thread_unlock(&nip->topo_cst);
510 hammer2_inode_drop(nip);
513 atomic_set_int(&nip->flags, HAMMER2_INODE_ONRBTREE);
514 spin_unlock(&pmp->inum_spin);
521 * Create a new inode in the specified directory using the vattr to
522 * figure out the type of inode.
524 * If no error occurs the new inode with its chain locked is returned in
525 * *nipp, otherwise an error is returned and *nipp is set to NULL.
527 * If vap and/or cred are NULL the related fields are not set and the
528 * inode type defaults to a directory. This is used when creating PFSs
529 * under the super-root, so the inode number is set to 1 in this case.
531 * dip is not locked on entry.
534 hammer2_inode_create(hammer2_trans_t *trans, hammer2_inode_t *dip,
535 struct vattr *vap, struct ucred *cred,
536 const uint8_t *name, size_t name_len,
537 hammer2_chain_t **chainp, int *errorp)
539 hammer2_inode_data_t *dipdata;
540 hammer2_inode_data_t *nipdata;
541 hammer2_chain_t *chain;
542 hammer2_chain_t *parent;
543 hammer2_inode_t *nip;
544 hammer2_key_t key_dummy;
552 int cache_index = -1;
554 lhc = hammer2_dirhash(name, name_len);
558 * Locate the inode or indirect block to create the new
559 * entry in. At the same time check for key collisions
560 * and iterate until we don't get one.
562 * NOTE: hidden inodes do not have iterators.
565 parent = hammer2_inode_lock_ex(dip);
566 dipdata = &dip->chain->data->ipdata;
567 dip_uid = dipdata->uid;
568 dip_gid = dipdata->gid;
569 dip_mode = dipdata->mode;
570 dip_algo = dipdata->comp_algo;
574 chain = hammer2_chain_lookup(&parent, &key_dummy,
575 lhc, lhc, &cache_index, 0);
578 if ((lhc & HAMMER2_DIRHASH_VISIBLE) == 0)
580 if ((lhc & HAMMER2_DIRHASH_LOMASK) == HAMMER2_DIRHASH_LOMASK)
582 hammer2_chain_unlock(chain);
588 error = hammer2_chain_create(trans, &parent, &chain,
590 HAMMER2_BREF_TYPE_INODE,
591 HAMMER2_INODE_BYTES);
595 * Cleanup and handle retries.
597 if (error == EAGAIN) {
598 hammer2_chain_ref(parent);
599 hammer2_inode_unlock_ex(dip, parent);
600 hammer2_chain_wait(parent);
601 hammer2_chain_drop(parent);
604 hammer2_inode_unlock_ex(dip, parent);
607 KKASSERT(chain == NULL);
613 * Set up the new inode.
615 * NOTE: *_get() integrates chain's lock into the inode lock.
617 * NOTE: Only one new inode can currently be created per
618 * transaction. If the need arises we can adjust
619 * hammer2_trans_init() to allow more.
621 * NOTE: nipdata will have chain's blockset data.
623 chain->data->ipdata.inum = trans->sync_tid;
624 nip = hammer2_inode_get(dip->pmp, dip, chain);
625 nipdata = &chain->data->ipdata;
628 KKASSERT(trans->inodes_created == 0);
629 nipdata->type = hammer2_get_obj_type(vap->va_type);
630 nipdata->inum = trans->sync_tid;
631 ++trans->inodes_created;
633 nipdata->type = HAMMER2_OBJTYPE_DIRECTORY;
637 /* Inherit parent's inode compression mode. */
638 nip->comp_heuristic = 0;
639 nipdata->comp_algo = dip_algo;
640 nipdata->version = HAMMER2_INODE_VERSION_ONE;
641 hammer2_update_time(&nipdata->ctime);
642 nipdata->mtime = nipdata->ctime;
644 nipdata->mode = vap->va_mode;
647 if (dip && dip->pmp) {
648 xuid = hammer2_to_unix_xid(&dip_uid);
649 xuid = vop_helper_create_uid(dip->pmp->mp,
655 /* super-root has no dip and/or pmp */
658 if (vap->va_vaflags & VA_UID_UUID_VALID)
659 nipdata->uid = vap->va_uid_uuid;
660 else if (vap->va_uid != (uid_t)VNOVAL)
661 hammer2_guid_to_uuid(&nipdata->uid, vap->va_uid);
663 hammer2_guid_to_uuid(&nipdata->uid, xuid);
665 if (vap->va_vaflags & VA_GID_UUID_VALID)
666 nipdata->gid = vap->va_gid_uuid;
667 else if (vap->va_gid != (gid_t)VNOVAL)
668 hammer2_guid_to_uuid(&nipdata->gid, vap->va_gid);
670 nipdata->gid = dip_gid;
674 * Regular files and softlinks allow a small amount of data to be
675 * directly embedded in the inode. This flag will be cleared if
676 * the size is extended past the embedded limit.
678 if (nipdata->type == HAMMER2_OBJTYPE_REGFILE ||
679 nipdata->type == HAMMER2_OBJTYPE_SOFTLINK) {
680 nipdata->op_flags |= HAMMER2_OPFLAG_DIRECTDATA;
683 KKASSERT(name_len < HAMMER2_INODE_MAXNAME);
684 bcopy(name, nipdata->filename, name_len);
685 nipdata->name_key = lhc;
686 nipdata->name_len = name_len;
693 * chain may have been moved around by the create.
697 hammer2_chain_refactor(hammer2_chain_t **chainp)
699 hammer2_chain_t *chain = *chainp;
700 hammer2_chain_core_t *core;
703 while (chain->flags & HAMMER2_CHAIN_DUPLICATED) {
704 spin_lock(&core->cst.spin);
705 chain = TAILQ_NEXT(chain, core_entry);
706 while (chain->flags & HAMMER2_CHAIN_DUPLICATED)
707 chain = TAILQ_NEXT(chain, core_entry);
708 hammer2_chain_ref(chain);
709 spin_unlock(&core->cst.spin);
710 KKASSERT(chain->core == core);
712 hammer2_chain_unlock(*chainp);
713 hammer2_chain_lock(chain, HAMMER2_RESOLVE_ALWAYS |
714 HAMMER2_RESOLVE_NOREF); /* eat ref */
720 * ochain represents the target file inode. We need to move it to the
721 * specified common parent directory (dip) and rename it to a special
722 * invisible "0xINODENUMBER" filename.
724 * We use chain_duplicate and duplicate ochain at the new location,
725 * renaming it appropriately. We create a temporary chain and
726 * then delete it to placemark where the duplicate will go. Both of
727 * these use the inode number for (lhc) (the key), generating the
728 * invisible filename.
732 hammer2_hardlink_shiftup(hammer2_trans_t *trans, hammer2_chain_t **ochainp,
733 hammer2_inode_t *dip, int *errorp)
735 hammer2_inode_data_t *nipdata;
736 hammer2_chain_t *parent;
737 hammer2_chain_t *ochain;
738 hammer2_chain_t *nchain;
739 hammer2_chain_t *tmp;
740 hammer2_key_t key_dummy;
742 hammer2_blockref_t bref;
743 int cache_index = -1;
747 lhc = ochain->data->ipdata.inum;
748 KKASSERT((lhc & HAMMER2_DIRHASH_VISIBLE) == 0);
751 * Locate the inode or indirect block to create the new
752 * entry in. lhc represents the inode number so there is
753 * no collision iteration.
755 * There should be no key collisions with invisible inode keys.
757 * WARNING! Must use inode_lock_ex() on dip to handle a stale
761 parent = hammer2_inode_lock_ex(dip);
762 /*parent = hammer2_chain_lookup_init(dip->chain, 0);*/
763 nchain = hammer2_chain_lookup(&parent, &key_dummy,
764 lhc, lhc, &cache_index, 0);
766 kprintf("X3 chain %p parent %p dip %p dip->chain %p\n",
767 nchain, parent, dip, dip->chain);
768 hammer2_chain_unlock(nchain);
777 * Create entry in common parent directory using the seek position
781 KKASSERT(nchain == NULL);
782 *errorp = hammer2_chain_create(trans, &parent, &nchain,
784 HAMMER2_BREF_TYPE_INODE,/* n/a */
785 HAMMER2_INODE_BYTES); /* n/a */
786 hammer2_chain_refactor(&ochain);
791 * Cleanup and handle retries.
793 if (*errorp == EAGAIN) {
794 hammer2_chain_ref(parent);
795 /* hammer2_chain_lookup_done(parent); */
796 hammer2_inode_unlock_ex(dip, parent);
797 hammer2_chain_wait(parent);
798 hammer2_chain_drop(parent);
803 * Handle the error case
806 KKASSERT(nchain == NULL);
807 hammer2_inode_unlock_ex(dip, parent);
808 /*hammer2_chain_lookup_done(parent);*/
813 * Use chain as a placeholder for (lhc), delete it and replace
814 * it with our duplication.
816 * Gain a second lock on ochain for the duplication function to
817 * unlock, maintain the caller's original lock across the call.
819 * This is a bit messy.
821 hammer2_chain_delete(trans, nchain, HAMMER2_DELETE_WILLDUP);
822 hammer2_chain_lock(ochain, HAMMER2_RESOLVE_ALWAYS);
825 bref.key = lhc; /* invisible dir entry key */
827 hammer2_chain_duplicate(trans, parent, &tmp, &bref, 0);
828 hammer2_inode_unlock_ex(dip, parent);
829 /*hammer2_chain_lookup_done(parent);*/
830 hammer2_chain_unlock(nchain); /* no longer needed */
833 * Now set chain to our duplicate and modify it appropriately.
835 * Directory entries are inodes but this is a hidden hardlink
836 * target. The name isn't used but to ease debugging give it
837 * a name after its inode number.
840 tmp = NULL; /* safety */
842 hammer2_chain_modify(trans, &nchain, HAMMER2_MODIFY_ASSERTNOCOPY);
843 nipdata = &nchain->data->ipdata;
844 ksnprintf(nipdata->filename, sizeof(nipdata->filename),
845 "0x%016jx", (intmax_t)nipdata->inum);
846 nipdata->name_len = strlen(nipdata->filename);
847 nipdata->name_key = lhc;
853 * Connect the target inode represented by (*chainp) to the media topology
854 * at (dip, name, len).
856 * If hlink is TRUE this function creates an OBJTYPE_HARDLINK directory
857 * entry instead of connecting (*chainp).
859 * If hlink is FALSE this function uses chain_duplicate() to make a copy
860 * if (*chainp) in the directory entry. (*chainp) is likely to be deleted
861 * by the caller in this case (e.g. rename).
864 hammer2_inode_connect(hammer2_trans_t *trans, int hlink,
865 hammer2_inode_t *dip, hammer2_chain_t **chainp,
866 const uint8_t *name, size_t name_len)
868 hammer2_inode_data_t *ipdata;
869 hammer2_chain_t *nchain;
870 hammer2_chain_t *parent;
871 hammer2_chain_t *ochain;
872 hammer2_key_t key_dummy;
874 int cache_index = -1;
880 * Since ochain is either disconnected from the topology or represents
881 * a hardlink terminus which is always a parent of or equal to dip,
882 * we should be able to safely lock dip->chain for our setup.
884 * WARNING! Must use inode_lock_ex() on dip to handle a stale
887 parent = hammer2_inode_lock_ex(dip);
888 /*parent = hammer2_chain_lookup_init(dip->chain, 0);*/
890 lhc = hammer2_dirhash(name, name_len);
893 * Locate the inode or indirect block to create the new
894 * entry in. At the same time check for key collisions
895 * and iterate until we don't get one.
899 nchain = hammer2_chain_lookup(&parent, &key_dummy,
900 lhc, lhc, &cache_index, 0);
903 if ((lhc & HAMMER2_DIRHASH_LOMASK) == HAMMER2_DIRHASH_LOMASK)
905 hammer2_chain_unlock(nchain);
913 * Hardlink pointer needed, create totally fresh
916 KKASSERT(nchain == NULL);
917 error = hammer2_chain_create(trans, &parent, &nchain,
919 HAMMER2_BREF_TYPE_INODE,
920 HAMMER2_INODE_BYTES);
921 hammer2_chain_refactor(&ochain);
924 * Reconnect the original chain and rename. Use
925 * chain_duplicate(). The caller will likely delete
926 * or has already deleted the original chain in
929 * NOTE: chain_duplicate() generates a new chain
930 * with CHAIN_DELETED cleared (ochain typically
931 * has it set from the file unlink).
935 hammer2_chain_duplicate(trans, NULL, &nchain, NULL, 0);
936 error = hammer2_chain_create(trans, &parent, &nchain,
938 HAMMER2_BREF_TYPE_INODE,
939 HAMMER2_INODE_BYTES);
946 KKASSERT(error != EAGAIN);
947 hammer2_inode_unlock_ex(dip, parent);
948 /*hammer2_chain_lookup_done(parent);*/
952 * nchain should be NULL on error, leave ochain (== *chainp) alone.
955 KKASSERT(nchain == NULL);
960 * Directory entries are inodes so if the name has changed we have
961 * to update the inode.
963 * When creating an OBJTYPE_HARDLINK entry remember to unlock the
964 * chain, the caller will access the hardlink via the actual hardlink
965 * target file and not the hardlink pointer entry, so we must still
968 if (hlink && hammer2_hardlink_enable >= 0) {
970 * Create the HARDLINK pointer. oip represents the hardlink
971 * target in this situation.
973 * We will return ochain (the hardlink target).
975 hammer2_chain_modify(trans, &nchain,
976 HAMMER2_MODIFY_ASSERTNOCOPY);
977 KKASSERT(name_len < HAMMER2_INODE_MAXNAME);
978 ipdata = &nchain->data->ipdata;
979 bcopy(name, ipdata->filename, name_len);
980 ipdata->name_key = lhc;
981 ipdata->name_len = name_len;
982 ipdata->target_type = ochain->data->ipdata.type;
983 ipdata->type = HAMMER2_OBJTYPE_HARDLINK;
984 ipdata->inum = ochain->data->ipdata.inum;
986 hammer2_chain_unlock(nchain);
989 } else if (hlink && hammer2_hardlink_enable < 0) {
991 * Create a snapshot (hardlink fake mode for debugging).
992 * (ochain already flushed above so we can just copy the
995 * Since this is a snapshot we return nchain in the fake
998 hammer2_chain_modify(trans, &nchain,
999 HAMMER2_MODIFY_ASSERTNOCOPY);
1000 KKASSERT(name_len < HAMMER2_INODE_MAXNAME);
1001 ipdata = &nchain->data->ipdata;
1002 *ipdata = ochain->data->ipdata;
1003 bcopy(name, ipdata->filename, name_len);
1004 ipdata->name_key = lhc;
1005 ipdata->name_len = name_len;
1006 kprintf("created fake hardlink %*.*s\n",
1007 (int)name_len, (int)name_len, name);
1010 * nchain is a duplicate of ochain at the new location.
1011 * We must fixup the name stored in oip. The bref key
1012 * has already been set up.
1014 hammer2_chain_modify(trans, &nchain,
1015 HAMMER2_MODIFY_ASSERTNOCOPY);
1016 ipdata = &nchain->data->ipdata;
1018 KKASSERT(name_len < HAMMER2_INODE_MAXNAME);
1019 bcopy(name, ipdata->filename, name_len);
1020 ipdata->name_key = lhc;
1021 ipdata->name_len = name_len;
1026 * We are replacing ochain with nchain, unlock ochain. In the
1027 * case where ochain is left unchanged the code above sets
1028 * nchain to ochain and ochain to NULL, resulting in a NOP here.
1031 hammer2_chain_unlock(ochain);
1038 * Repoint ip->chain to nchain. Caller must hold the inode exclusively
1041 * ip->chain is set to nchain. The prior chain in ip->chain is dropped
1042 * and nchain is ref'd.
1045 hammer2_inode_repoint(hammer2_inode_t *ip, hammer2_inode_t *pip,
1046 hammer2_chain_t *nchain)
1048 hammer2_chain_t *ochain;
1049 hammer2_inode_t *opip;
1052 * Repoint ip->chain if requested.
1057 hammer2_chain_ref(nchain);
1059 hammer2_chain_drop(ochain);
1062 * Repoint ip->pip if requested (non-NULL pip).
1064 if (pip && ip->pip != pip) {
1066 hammer2_inode_ref(pip);
1069 hammer2_inode_drop(opip);
1074 * Unlink the file from the specified directory inode. The directory inode
1075 * does not need to be locked.
1077 * isdir determines whether a directory/non-directory check should be made.
1078 * No check is made if isdir is set to -1.
1080 * NOTE! The underlying file can still be active with open descriptors
1081 * or if the chain is being manually held (e.g. for rename).
1083 * The caller is responsible for fixing up ip->chain if e.g. a
1084 * rename occurs (see chain_duplicate()).
1087 hammer2_unlink_file(hammer2_trans_t *trans, hammer2_inode_t *dip,
1088 const uint8_t *name, size_t name_len,
1089 int isdir, int *hlinkp)
1091 hammer2_inode_data_t *ipdata;
1092 hammer2_chain_t *parent;
1093 hammer2_chain_t *ochain;
1094 hammer2_chain_t *chain;
1095 hammer2_chain_t *dparent;
1096 hammer2_chain_t *dchain;
1097 hammer2_key_t key_dummy;
1098 hammer2_key_t key_next;
1101 int cache_index = -1;
1106 lhc = hammer2_dirhash(name, name_len);
1109 * Search for the filename in the directory
1113 parent = hammer2_inode_lock_ex(dip);
1114 chain = hammer2_chain_lookup(&parent, &key_next,
1115 lhc, lhc + HAMMER2_DIRHASH_LOMASK,
1118 if (chain->bref.type == HAMMER2_BREF_TYPE_INODE &&
1119 name_len == chain->data->ipdata.name_len &&
1120 bcmp(name, chain->data->ipdata.filename, name_len) == 0) {
1123 chain = hammer2_chain_next(&parent, chain, &key_next,
1125 lhc + HAMMER2_DIRHASH_LOMASK,
1128 hammer2_inode_unlock_ex(dip, NULL); /* retain parent */
1131 * Not found or wrong type (isdir < 0 disables the type check).
1132 * If a hardlink pointer, type checks use the hardlink target.
1134 if (chain == NULL) {
1138 if ((type = chain->data->ipdata.type) == HAMMER2_OBJTYPE_HARDLINK) {
1141 type = chain->data->ipdata.target_type;
1144 if (type == HAMMER2_OBJTYPE_DIRECTORY && isdir == 0) {
1148 if (type != HAMMER2_OBJTYPE_DIRECTORY && isdir >= 1) {
1154 * Hardlink must be resolved. We can't hold parent locked while we
1155 * do this or we could deadlock.
1157 * On success chain will be adjusted to point at the hardlink target
1158 * and ochain will point to the hardlink pointer in the original
1159 * directory. Otherwise chain remains pointing to the original.
1161 if (chain->data->ipdata.type == HAMMER2_OBJTYPE_HARDLINK) {
1162 hammer2_chain_unlock(parent);
1164 error = hammer2_hardlink_find(dip, &chain, &ochain);
1168 * If this is a directory the directory must be empty. However, if
1169 * isdir < 0 we are doing a rename and the directory does not have
1170 * to be empty, and if isdir > 1 we are deleting a PFS/snapshot
1171 * and the directory does not have to be empty.
1173 * NOTE: We check the full key range here which covers both visible
1174 * and invisible entries. Theoretically there should be no
1175 * invisible (hardlink target) entries if there are no visible
1178 if (type == HAMMER2_OBJTYPE_DIRECTORY && isdir == 1) {
1179 dparent = hammer2_chain_lookup_init(chain, 0);
1180 dchain = hammer2_chain_lookup(&dparent, &key_dummy,
1181 0, (hammer2_key_t)-1,
1183 HAMMER2_LOOKUP_NODATA);
1185 hammer2_chain_unlock(dchain);
1186 hammer2_chain_lookup_done(dparent);
1190 hammer2_chain_lookup_done(dparent);
1196 * Ok, we can now unlink the chain. We always decrement nlinks even
1197 * if the entry can be deleted in case someone has the file open and
1200 * The chain itself will no longer be in the on-media topology but
1201 * can still be flushed to the media (e.g. if an open descriptor
1202 * remains). When the last vnode/ip ref goes away the chain will
1203 * be marked unmodified, avoiding any further (now unnecesary) I/O.
1205 * A non-NULL ochain indicates a hardlink.
1209 * Delete the original hardlink pointer.
1211 * NOTE: parent from above is NULL when ochain != NULL
1212 * so we can reuse it.
1214 hammer2_chain_lock(ochain, HAMMER2_RESOLVE_ALWAYS);
1215 hammer2_chain_delete(trans, ochain, 0);
1216 hammer2_chain_unlock(ochain);
1219 * Then decrement nlinks on hardlink target, deleting
1220 * the target when nlinks drops to 0.
1222 hammer2_chain_modify(trans, &chain, 0);
1223 --chain->data->ipdata.nlinks;
1224 if (chain->data->ipdata.nlinks == 0)
1225 hammer2_chain_delete(trans, chain, 0);
1228 * Otherwise this was not a hardlink and we can just
1229 * remove the entry and decrement nlinks.
1231 * NOTE: *_get() integrates chain's lock into the inode lock.
1233 hammer2_chain_modify(trans, &chain, 0);
1234 ipdata = &chain->data->ipdata;
1236 hammer2_chain_delete(trans, chain, 0);
1242 hammer2_chain_unlock(chain);
1244 hammer2_chain_lookup_done(parent);
1246 hammer2_chain_drop(ochain);
1252 * Given an exclusively locked inode we consolidate its chain for hardlink
1253 * creation, adding (nlinks) to the file's link count and potentially
1254 * relocating the inode to a directory common to ip->pip and tdip.
1256 * Replaces (*chainp) if consolidation occurred, unlocking the old chain
1257 * and returning a new locked chain.
1259 * NOTE! This function will also replace ip->chain.
1262 hammer2_hardlink_consolidate(hammer2_trans_t *trans, hammer2_inode_t *ip,
1263 hammer2_chain_t **chainp,
1264 hammer2_inode_t *tdip, int nlinks)
1266 hammer2_inode_data_t *ipdata;
1267 hammer2_inode_t *fdip;
1268 hammer2_inode_t *cdip;
1269 hammer2_chain_t *chain;
1270 hammer2_chain_t *nchain;
1274 if (nlinks == 0 && /* no hardlink needed */
1275 (chain->data->ipdata.name_key & HAMMER2_DIRHASH_VISIBLE)) {
1278 if (hammer2_hardlink_enable < 0) { /* fake hardlinks */
1282 if (hammer2_hardlink_enable == 0) { /* disallow hardlinks */
1283 hammer2_chain_unlock(chain);
1289 * cdip will be returned with a ref, but not locked.
1292 cdip = hammer2_inode_common_parent(fdip, tdip);
1295 * If no change in the hardlink's target directory is required and
1296 * this is already a hardlink target, all we need to do is adjust
1299 * XXX The common parent is a big wiggly due to duplication from
1300 * renames. Compare the core (RBTREE) pointer instead of the
1304 (chain->data->ipdata.name_key & HAMMER2_DIRHASH_VISIBLE) == 0) {
1306 hammer2_chain_modify(trans, &chain, 0);
1307 chain->data->ipdata.nlinks += nlinks;
1314 * We either have to move an existing hardlink target or we have
1315 * to create a fresh hardlink target.
1317 * Hardlink targets are hidden inodes in a parent directory common
1318 * to all directory entries referencing the hardlink.
1320 nchain = hammer2_hardlink_shiftup(trans, &chain, cdip, &error);
1324 * Bump nlinks on duplicated hidden inode, repoint
1327 hammer2_chain_modify(trans, &nchain, 0);
1328 nchain->data->ipdata.nlinks += nlinks;
1329 hammer2_inode_repoint(ip, cdip, nchain);
1332 * If the old chain is not a hardlink target then replace
1333 * it with a OBJTYPE_HARDLINK pointer.
1335 * If the old chain IS a hardlink target then delete it.
1337 if (chain->data->ipdata.name_key & HAMMER2_DIRHASH_VISIBLE) {
1339 * Replace original non-hardlink that's been dup'd
1340 * with a special hardlink directory entry. We must
1341 * set the DIRECTDATA flag to prevent sub-chains
1342 * from trying to synchronize to the inode if the
1343 * file is extended afterwords.
1345 * DELDUP_RECORE causes the new chain to NOT inherit
1346 * the old chain's core (sub-tree).
1348 /*hammer2_chain_modify(trans, &chain, 0);*/
1349 hammer2_chain_delete_duplicate(trans, &chain,
1350 HAMMER2_DELDUP_RECORE);
1351 hammer2_chain_modify(trans, &chain, 0);
1352 ipdata = &chain->data->ipdata;
1353 ipdata->target_type = ipdata->type;
1354 ipdata->type = HAMMER2_OBJTYPE_HARDLINK;
1362 bzero(&ipdata->uid, sizeof(ipdata->uid));
1363 bzero(&ipdata->gid, sizeof(ipdata->gid));
1364 ipdata->op_flags = HAMMER2_OPFLAG_DIRECTDATA;
1365 ipdata->cap_flags = 0;
1369 ipdata->iparent = 0; /* XXX */
1370 ipdata->pfs_type = 0;
1371 ipdata->pfs_inum = 0;
1372 bzero(&ipdata->pfs_clid, sizeof(ipdata->pfs_clid));
1373 bzero(&ipdata->pfs_fsid, sizeof(ipdata->pfs_fsid));
1374 ipdata->data_quota = 0;
1375 ipdata->data_count = 0;
1376 ipdata->inode_quota = 0;
1377 ipdata->inode_count = 0;
1378 ipdata->attr_tid = 0;
1379 ipdata->dirent_tid = 0;
1380 bzero(&ipdata->u, sizeof(ipdata->u));
1381 /* XXX transaction ids */
1383 hammer2_chain_delete(trans, chain, 0);
1387 * Return the new chain.
1389 hammer2_chain_unlock(chain);
1395 hammer2_chain_unlock(chain);
1400 * Cleanup, chain/nchain already dealt with.
1404 hammer2_inode_drop(cdip);
1410 * If (*ochainp) is non-NULL it points to the forward OBJTYPE_HARDLINK
1411 * inode while (*chainp) points to the resolved (hidden hardlink
1412 * target) inode. In this situation when nlinks is 1 we wish to
1413 * deconsolidate the hardlink, moving it back to the directory that now
1414 * represents the only remaining link.
1417 hammer2_hardlink_deconsolidate(hammer2_trans_t *trans,
1418 hammer2_inode_t *dip,
1419 hammer2_chain_t **chainp,
1420 hammer2_chain_t **ochainp)
1422 if (*ochainp == NULL)
1429 * The caller presents a locked *chainp pointing to a HAMMER2_BREF_TYPE_INODE
1430 * with an obj_type of HAMMER2_OBJTYPE_HARDLINK. This routine will gobble
1431 * the *chainp and return a new locked *chainp representing the file target
1432 * (the original *chainp will be unlocked).
1434 * When a match is found the chain representing the original HARDLINK
1435 * will be returned in *ochainp with a ref, but not locked.
1437 * When no match is found *chainp is set to NULL and EIO is returned.
1438 * (*ochainp) will still be set to the original chain with a ref but not
1442 hammer2_hardlink_find(hammer2_inode_t *dip, hammer2_chain_t **chainp,
1443 hammer2_chain_t **ochainp)
1445 hammer2_chain_t *chain = *chainp;
1446 hammer2_chain_t *parent;
1447 hammer2_inode_t *ip;
1448 hammer2_inode_t *pip;
1449 hammer2_key_t key_dummy;
1451 int cache_index = -1;
1454 hammer2_inode_ref(pip); /* for loop */
1455 hammer2_chain_ref(chain); /* for (*ochainp) */
1459 * Locate the hardlink. pip is referenced and not locked,
1464 lhc = chain->data->ipdata.inum;
1465 hammer2_chain_unlock(chain);
1468 while ((ip = pip) != NULL) {
1469 parent = hammer2_inode_lock_ex(ip);
1470 hammer2_inode_drop(ip); /* loop */
1471 KKASSERT(parent->bref.type == HAMMER2_BREF_TYPE_INODE);
1472 chain = hammer2_chain_lookup(&parent, &key_dummy,
1473 lhc, lhc, &cache_index, 0);
1474 hammer2_chain_lookup_done(parent); /* discard parent */
1477 pip = ip->pip; /* safe, ip held locked */
1479 hammer2_inode_ref(pip); /* loop */
1480 hammer2_inode_unlock_ex(ip, NULL);
1484 * chain is locked, ip is locked. Unlock ip, return the locked
1485 * chain. *ipp is already set w/a ref count and not locked.
1487 * (parent is already unlocked).
1490 hammer2_inode_unlock_ex(ip, NULL);
1493 KKASSERT(chain->bref.type == HAMMER2_BREF_TYPE_INODE);
1494 /* already locked */
1502 * Find the directory common to both fdip and tdip, hold and return
1506 hammer2_inode_common_parent(hammer2_inode_t *fdip, hammer2_inode_t *tdip)
1508 hammer2_inode_t *scan1;
1509 hammer2_inode_t *scan2;
1512 * We used to have a depth field but it complicated matters too
1513 * much for directory renames. So now its ugly. Check for
1514 * simple cases before giving up and doing it the expensive way.
1516 * XXX need a bottom-up topology stability lock
1518 if (fdip == tdip || fdip == tdip->pip) {
1519 hammer2_inode_ref(fdip);
1522 if (fdip->pip == tdip) {
1523 hammer2_inode_ref(tdip);
1530 for (scan1 = fdip; scan1->pmp == fdip->pmp; scan1 = scan1->pip) {
1532 while (scan2->pmp == tdip->pmp) {
1533 if (scan1 == scan2) {
1534 hammer2_inode_ref(scan1);
1542 panic("hammer2_inode_common_parent: no common parent %p %p\n",
1549 * Synchronize the inode's frontend state with the chain state prior
1550 * to any explicit flush of the inode or any strategy write call.
1552 * Called with a locked inode.
1555 hammer2_inode_fsync(hammer2_trans_t *trans, hammer2_inode_t *ip,
1556 hammer2_chain_t **chainp)
1558 hammer2_inode_data_t *ipdata;
1559 hammer2_chain_t *parent;
1560 hammer2_chain_t *chain;
1561 hammer2_key_t lbase;
1562 hammer2_key_t key_next;
1565 ipdata = &ip->chain->data->ipdata;
1567 if (ip->flags & HAMMER2_INODE_MTIME) {
1568 ipdata = hammer2_chain_modify_ip(trans, ip, chainp, 0);
1569 atomic_clear_int(&ip->flags, HAMMER2_INODE_MTIME);
1570 ipdata->mtime = ip->mtime;
1572 if ((ip->flags & HAMMER2_INODE_RESIZED) && ip->size < ipdata->size) {
1573 ipdata = hammer2_chain_modify_ip(trans, ip, chainp, 0);
1574 ipdata->size = ip->size;
1575 atomic_clear_int(&ip->flags, HAMMER2_INODE_RESIZED);
1578 * We must delete any chains beyond the EOF. The chain
1579 * straddling the EOF will be pending in the bioq.
1581 lbase = (ipdata->size + HAMMER2_PBUFMASK64) &
1582 ~HAMMER2_PBUFMASK64;
1583 parent = hammer2_chain_lookup_init(ip->chain, 0);
1584 chain = hammer2_chain_lookup(&parent, &key_next,
1585 lbase, (hammer2_key_t)-1,
1587 HAMMER2_LOOKUP_NODATA);
1590 * Degenerate embedded case, nothing to loop on
1592 if (chain->bref.type == HAMMER2_BREF_TYPE_INODE) {
1593 hammer2_chain_unlock(chain);
1596 if (chain->bref.type == HAMMER2_BREF_TYPE_DATA) {
1597 hammer2_chain_delete(trans, chain, 0);
1599 chain = hammer2_chain_next(&parent, chain, &key_next,
1600 key_next, (hammer2_key_t)-1,
1602 HAMMER2_LOOKUP_NODATA);
1604 hammer2_chain_lookup_done(parent);
1606 if ((ip->flags & HAMMER2_INODE_RESIZED) && ip->size > ipdata->size) {
1607 ipdata = hammer2_chain_modify_ip(trans, ip, chainp, 0);
1608 ipdata->size = ip->size;
1609 atomic_clear_int(&ip->flags, HAMMER2_INODE_RESIZED);
1612 * When resizing larger we may not have any direct-data
1615 if ((ipdata->op_flags & HAMMER2_OPFLAG_DIRECTDATA) &&
1616 ip->size > HAMMER2_EMBEDDED_BYTES) {
1617 ipdata->op_flags &= ~HAMMER2_OPFLAG_DIRECTDATA;
1618 bzero(&ipdata->u.blockset, sizeof(ipdata->u.blockset));