2 * Copyright (c) 1999-2013 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
30 #include <sys/systm.h>
31 #include <sys/kernel.h>
32 #include <sys/malloc.h>
33 #include <sys/mount.h>
35 #include <sys/vnode.h>
36 #include <vfs/vfs_support.h>
37 #include <libkern/libkern.h>
38 #include <sys/fsctl.h>
41 #include "hfs_catalog.h"
42 #include "hfs_format.h"
43 #include "hfs_endian.h"
46 static int cur_link_id
= 0;
49 * Private directories where hardlink inodes reside.
51 const char *hfs_private_names
[] = {
52 HFSPLUSMETADATAFOLDER
, /* FILE HARDLINKS */
53 HFSPLUS_DIR_METADATA_FOLDER
/* DIRECTORY HARDLINKS */
58 * Hardlink inodes save the head of their link chain in a
59 * private extended attribute. The following calls are
60 * used to access this attribute.
62 static int setfirstlink(struct hfsmount
* hfsmp
, cnid_t fileid
, cnid_t firstlink
);
63 static int getfirstlink(struct hfsmount
* hfsmp
, cnid_t fileid
, cnid_t
*firstlink
);
65 int hfs_makelink(struct hfsmount
*hfsmp
, struct vnode
*src_vp
, struct cnode
*cp
,
66 struct cnode
*dcp
, struct componentname
*cnp
);
68 * Create a new catalog link record
70 * An indirect link is a reference to an inode (the real
71 * file or directory record).
73 * All the indirect links for a given inode are chained
74 * together in a doubly linked list.
76 * Pre-Leopard file hard links do not have kHFSHasLinkChainBit
77 * set and do not have first/prev/next link IDs i.e. the values
78 * are zero. If a new link is being added to an existing
79 * pre-Leopard file hard link chain, do not set kHFSHasLinkChainBit.
82 createindirectlink(struct hfsmount
*hfsmp
, u_int32_t linknum
, struct cat_desc
*descp
,
83 cnid_t nextcnid
, cnid_t
*linkcnid
, int is_inode_linkchain_set
)
85 struct FndrFileInfo
*fip
;
89 printf("hfs: createindirectlink: linknum is zero!\n");
93 /* Setup the default attributes */
94 bzero(&attr
, sizeof(attr
));
96 /* Links are matched to inodes by link ID and to volumes by create date */
97 attr
.ca_linkref
= linknum
;
98 attr
.ca_itime
= hfsmp
->hfs_metadata_createdate
;
99 attr
.ca_mode
= S_IFREG
| S_IRUSR
| S_IRGRP
| S_IROTH
;
100 attr
.ca_recflags
= kHFSHasLinkChainMask
| kHFSThreadExistsMask
;
101 attr
.ca_flags
= UF_IMMUTABLE
;
102 fip
= (struct FndrFileInfo
*)&attr
.ca_finderinfo
;
104 if (descp
->cd_flags
& CD_ISDIR
) {
105 fip
->fdType
= SWAP_BE32 (kHFSAliasType
);
106 fip
->fdCreator
= SWAP_BE32 (kHFSAliasCreator
);
107 fip
->fdFlags
= SWAP_BE16 (kIsAlias
);
109 fip
->fdType
= SWAP_BE32 (kHardLinkFileType
);
110 fip
->fdCreator
= SWAP_BE32 (kHFSPlusCreator
);
111 fip
->fdFlags
= SWAP_BE16 (kHasBeenInited
);
112 /* If the file inode does not have kHFSHasLinkChainBit set
113 * and the next link chain ID is zero, assume that this
114 * is pre-Leopard file inode. Therefore clear the bit.
116 if ((is_inode_linkchain_set
== 0) && (nextcnid
== 0)) {
117 attr
.ca_recflags
&= ~kHFSHasLinkChainMask
;
120 /* Create the indirect link directly in the catalog */
121 return cat_createlink(hfsmp
, descp
, &attr
, nextcnid
, linkcnid
);
126 * Make a link to the cnode cp in the directory dp
127 * using the name in cnp. src_vp is the vnode that
128 * corresponds to 'cp' which was part of the arguments to
131 * The cnodes cp and dcp must be locked.
134 hfs_makelink(struct hfsmount
*hfsmp
, struct vnode
*src_vp
, struct cnode
*cp
,
135 struct cnode
*dcp
, struct componentname
*cnp
)
137 vfs_context_t ctx
= cnp
->cn_context
;
138 struct proc
*p
= vfs_context_proc(ctx
);
139 u_int32_t indnodeno
= 0;
141 struct cat_desc to_desc
;
142 struct cat_desc link_desc
;
149 cnid_t orig_firstlink
;
150 enum privdirtype type
;
152 type
= S_ISDIR(cp
->c_mode
) ? DIR_HARDLINKS
: FILE_HARDLINKS
;
154 if (cur_link_id
== 0) {
155 cur_link_id
= ((random() & 0x3fffffff) + 100);
158 /* We don't allow link nodes in our private system directories. */
159 if (dcp
->c_fileid
== hfsmp
->hfs_private_desc
[FILE_HARDLINKS
].cd_cnid
||
160 dcp
->c_fileid
== hfsmp
->hfs_private_desc
[DIR_HARDLINKS
].cd_cnid
) {
164 bzero(&cookie
, sizeof(cat_cookie_t
));
165 /* Reserve some space in the Catalog file. */
166 if ((retval
= cat_preflight(hfsmp
, (2 * CAT_CREATE
)+ CAT_RENAME
, &cookie
, p
))) {
170 lockflags
= SFL_CATALOG
| SFL_ATTRIBUTE
;
171 /* Directory hard links allocate space for a symlink. */
172 if (type
== DIR_HARDLINKS
) {
173 lockflags
|= SFL_BITMAP
;
175 lockflags
= hfs_systemfile_lock(hfsmp
, lockflags
, HFS_EXCLUSIVE_LOCK
);
177 /* Save the current cnid value so we restore it if an error occurs. */
178 orig_cnid
= cp
->c_desc
.cd_cnid
;
181 * If this is a new hardlink then we need to create the inode
182 * and replace the original file/dir object with a link node.
184 if ((cp
->c_linkcount
== 2) && !(cp
->c_flag
& C_HARDLINK
)) {
186 bzero(&to_desc
, sizeof(to_desc
));
187 to_desc
.cd_parentcnid
= hfsmp
->hfs_private_desc
[type
].cd_cnid
;
188 to_desc
.cd_cnid
= cp
->c_fileid
;
189 to_desc
.cd_flags
= (type
== DIR_HARDLINKS
) ? CD_ISDIR
: 0;
192 if (type
== DIR_HARDLINKS
) {
193 /* Directory hardlinks always use the cnid. */
194 indnodeno
= cp
->c_fileid
;
195 MAKE_DIRINODE_NAME(inodename
, sizeof(inodename
),
198 /* Get a unique indirect node number */
200 indnodeno
= cp
->c_fileid
;
202 indnodeno
= cur_link_id
++;
204 MAKE_INODE_NAME(inodename
, sizeof(inodename
),
207 /* Move original file/dir to data node directory */
208 to_desc
.cd_nameptr
= (const u_int8_t
*)inodename
;
209 to_desc
.cd_namelen
= strlen(inodename
);
211 retval
= cat_rename(hfsmp
, &cp
->c_desc
, &hfsmp
->hfs_private_desc
[type
],
214 if (retval
!= 0 && retval
!= EEXIST
) {
215 printf("hfs_makelink: cat_rename to %s failed (%d) fileid=%d, vol=%s\n",
216 inodename
, retval
, cp
->c_fileid
, hfsmp
->vcbVN
);
218 } while ((retval
== EEXIST
) && (type
== FILE_HARDLINKS
));
223 * Replace original file/dir with a link record.
226 bzero(&link_desc
, sizeof(link_desc
));
227 link_desc
.cd_nameptr
= cp
->c_desc
.cd_nameptr
;
228 link_desc
.cd_namelen
= cp
->c_desc
.cd_namelen
;
229 link_desc
.cd_parentcnid
= cp
->c_parentcnid
;
230 link_desc
.cd_flags
= S_ISDIR(cp
->c_mode
) ? CD_ISDIR
: 0;
232 retval
= createindirectlink(hfsmp
, indnodeno
, &link_desc
, 0, &linkcnid
, true);
236 /* Restore the cnode's cnid. */
237 cp
->c_desc
.cd_cnid
= orig_cnid
;
239 /* Put the original file back. */
240 err
= cat_rename(hfsmp
, &to_desc
, &dcp
->c_desc
, &cp
->c_desc
, NULL
);
241 if (err
&& err
!= EIO
&& err
!= ENXIO
)
242 panic("hfs_makelink: error %d from cat_rename backout 1", err
);
245 cp
->c_attr
.ca_linkref
= indnodeno
;
246 cp
->c_desc
.cd_cnid
= linkcnid
;
247 /* Directory hard links store the first link in an attribute. */
248 if (type
== DIR_HARDLINKS
) {
249 if (setfirstlink(hfsmp
, cp
->c_fileid
, linkcnid
) == 0)
250 cp
->c_attr
.ca_recflags
|= kHFSHasAttributesMask
;
251 } else /* FILE_HARDLINKS */ {
252 cp
->c_attr
.ca_firstlink
= linkcnid
;
254 cp
->c_attr
.ca_recflags
|= kHFSHasLinkChainMask
;
256 indnodeno
= cp
->c_attr
.ca_linkref
;
260 * Create a catalog entry for the new link (parentID + name).
263 bzero(&link_desc
, sizeof(link_desc
));
264 link_desc
.cd_nameptr
= (const u_int8_t
*)cnp
->cn_nameptr
;
265 link_desc
.cd_namelen
= strlen(cnp
->cn_nameptr
);
266 link_desc
.cd_parentcnid
= dcp
->c_fileid
;
267 link_desc
.cd_flags
= S_ISDIR(cp
->c_mode
) ? CD_ISDIR
: 0;
269 /* Directory hard links store the first link in an attribute. */
270 if (type
== DIR_HARDLINKS
) {
271 retval
= getfirstlink(hfsmp
, cp
->c_fileid
, &orig_firstlink
);
272 } else /* FILE_HARDLINKS */ {
273 orig_firstlink
= cp
->c_attr
.ca_firstlink
;
276 retval
= createindirectlink(hfsmp
, indnodeno
, &link_desc
,
277 orig_firstlink
, &linkcnid
,
278 (cp
->c_attr
.ca_recflags
& kHFSHasLinkChainMask
));
279 if (retval
&& newlink
) {
282 /* Get rid of new link */
283 (void) cat_delete(hfsmp
, &cp
->c_desc
, &cp
->c_attr
);
285 /* Restore the cnode's cnid. */
286 cp
->c_desc
.cd_cnid
= orig_cnid
;
288 /* Put the original file back. */
289 err
= cat_rename(hfsmp
, &to_desc
, &dcp
->c_desc
, &cp
->c_desc
, NULL
);
290 if (err
&& err
!= EIO
&& err
!= ENXIO
)
291 panic("hfs_makelink: error %d from cat_rename backout 2", err
);
293 cp
->c_attr
.ca_linkref
= 0;
295 } else if (retval
== 0) {
297 /* Update the original first link to point back to the new first link. */
298 if (cp
->c_attr
.ca_recflags
& kHFSHasLinkChainMask
) {
299 (void) cat_update_siblinglinks(hfsmp
, orig_firstlink
, linkcnid
, HFS_IGNORABLE_LINK
);
301 /* Update the inode's first link value. */
302 if (type
== DIR_HARDLINKS
) {
303 if (setfirstlink(hfsmp
, cp
->c_fileid
, linkcnid
) == 0)
304 cp
->c_attr
.ca_recflags
|= kHFSHasAttributesMask
;
306 cp
->c_attr
.ca_firstlink
= linkcnid
;
310 * Finally, if this is a new hardlink then:
311 * - update the private system directory
312 * - mark the cnode as a hard link
318 panic("hfs_makelink: retval %d but newlink = 1!\n", retval
);
321 hfsmp
->hfs_private_attr
[type
].ca_entries
++;
322 /* From application perspective, directory hard link is a
323 * normal directory. Therefore count the new directory
324 * hard link for folder count calculation.
326 if (type
== DIR_HARDLINKS
) {
327 INC_FOLDERCOUNT(hfsmp
, hfsmp
->hfs_private_attr
[type
]);
329 retval
= cat_update(hfsmp
, &hfsmp
->hfs_private_desc
[type
],
330 &hfsmp
->hfs_private_attr
[type
], NULL
, NULL
);
331 if (retval
!= 0 && retval
!= EIO
&& retval
!= ENXIO
) {
332 panic("hfs_makelink: cat_update of privdir failed! (%d)\n", retval
);
334 cp
->c_flag
|= C_HARDLINK
;
337 * Now we need to mark the vnodes as being hardlinks via the vnode_setmultipath call.
338 * Note that we're calling vnode_get here, which should simply add an iocount if possible, without
339 * doing much checking. It's safe to call this because we are protected by the cnode lock, which
340 * ensures that anyone trying to reclaim it will block until we release it. vnode_get will usually
341 * give us an extra iocount, unless the vnode is about to be reclaimed (and has no iocounts).
342 * In that case, we'd error out, but we'd also not care if we added the VISHARDLINK bit to the vnode.
344 * As for the iocount we're about to add, we can't necessarily always call vnode_put here.
345 * If the one we add is the only iocount on the vnode, and there was
346 * sufficient vnode pressure, it could go through VNOP_INACTIVE immediately, which would
347 * require the cnode lock and cause us to double-lock panic. We can only call vnode_put if we know
348 * that the vnode we're operating on is the one with which we came into hfs_vnop_link, because
349 * that means VFS took an iocount on it for us. If it's *not* the one that we came into the call
350 * with, then mark it as NEED_VNODE_PUT to have hfs_unlock drop it for us. hfs_vnop_link will
351 * unlock the cnode when it is finished.
353 if ((vp
= cp
->c_vp
) != NULLVP
) {
354 if (vnode_get(vp
) == 0) {
355 vnode_setmultipath(vp
);
357 /* we have an iocount on data fork vnode already. */
361 cp
->c_flag
|= C_NEED_DVNODE_PUT
;
365 if ((vp
= cp
->c_rsrc_vp
) != NULLVP
) {
366 if (vnode_get(vp
) == 0) {
367 vnode_setmultipath(vp
);
372 cp
->c_flag
|= C_NEED_RVNODE_PUT
;
376 cp
->c_touch_chgtime
= TRUE
;
377 cp
->c_flag
|= C_FORCEUPDATE
;
379 dcp
->c_flag
|= C_FORCEUPDATE
;
382 hfs_systemfile_unlock(hfsmp
, lockflags
);
384 cat_postflight(hfsmp
, &cookie
, p
);
386 if (retval
== 0 && newlink
) {
387 hfs_volupdate(hfsmp
, VOL_MKFILE
, 0);
394 * link vnode operation
398 * IN struct componentname *a_cnp;
399 * IN vfs_context_t a_context;
402 hfs_vnop_link(struct vnop_link_args
*ap
)
404 struct hfsmount
*hfsmp
;
405 struct vnode
*vp
= ap
->a_vp
;
406 struct vnode
*tdvp
= ap
->a_tdvp
;
407 struct vnode
*fdvp
= NULLVP
;
408 struct componentname
*cnp
= ap
->a_cnp
;
411 struct cnode
*fdcp
= NULL
;
412 struct cat_desc todesc
;
420 v_type
= vnode_vtype(vp
);
422 /* No hard links in HFS standard file systems. */
423 if (hfsmp
->hfs_flags
& HFS_STANDARD
) {
426 /* Linking to a special file is not permitted. */
427 if (v_type
== VBLK
|| v_type
== VCHR
) {
430 if (v_type
== VDIR
) {
431 #if CONFIG_HFS_DIRLINK
432 /* Make sure our private directory exists. */
433 if (hfsmp
->hfs_private_desc
[DIR_HARDLINKS
].cd_cnid
== 0) {
437 * Directory hardlinks (ADLs) have only been qualified on
438 * journaled HFS+. If/when they are tested on non-journaled
439 * file systems then this test can be removed.
441 if (hfsmp
->jnl
== NULL
) {
444 /* Directory hardlinks also need the parent of the original directory. */
445 if ((error
= hfs_vget(hfsmp
, hfs_currentparent(VTOC(vp
)), &fdvp
, 1, 0))) {
449 /* some platforms don't support directory hardlinks. */
453 /* Make sure our private directory exists. */
454 if (hfsmp
->hfs_private_desc
[FILE_HARDLINKS
].cd_cnid
== 0) {
458 if (hfs_freeblks(hfsmp
, 0) == 0) {
465 check_for_tracked_file(vp
, VTOC(vp
)->c_ctime
, NAMESPACE_HANDLER_LINK_CREATE
, NULL
);
468 /* Lock the cnodes. */
470 if ((error
= hfs_lockfour(VTOC(tdvp
), VTOC(vp
), VTOC(fdvp
), NULL
, HFS_EXCLUSIVE_LOCK
, NULL
))) {
478 if ((error
= hfs_lockpair(VTOC(tdvp
), VTOC(vp
), HFS_EXCLUSIVE_LOCK
))) {
484 /* grab the parent CNID from originlist after grabbing cnode locks */
485 parentcnid
= hfs_currentparent(cp
);
488 * Make sure we didn't race the src or dst parent directories with rmdir.
489 * Note that we should only have a src parent directory cnode lock
490 * if we're dealing with a directory hardlink here.
493 if (fdcp
->c_flag
& (C_NOEXISTS
| C_DELETED
)) {
499 if (tdcp
->c_flag
& (C_NOEXISTS
| C_DELETED
)) {
504 /* Check the source for errors:
505 * too many links, immutable, race with unlink
507 if (cp
->c_linkcount
>= HFS_LINK_MAX
) {
511 if (cp
->c_bsdflags
& (IMMUTABLE
| APPEND
)) {
515 if (cp
->c_flag
& (C_NOEXISTS
| C_DELETED
)) {
520 tdcp
->c_flag
|= C_DIR_MODIFICATION
;
522 if (hfs_start_transaction(hfsmp
) != 0) {
528 todesc
.cd_flags
= (v_type
== VDIR
) ? CD_ISDIR
: 0;
529 todesc
.cd_encoding
= 0;
530 todesc
.cd_nameptr
= (const u_int8_t
*)cnp
->cn_nameptr
;
531 todesc
.cd_namelen
= cnp
->cn_namelen
;
532 todesc
.cd_parentcnid
= tdcp
->c_fileid
;
536 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_CATALOG
, HFS_SHARED_LOCK
);
538 /* If destination exists then we lost a race with create. */
539 if (cat_lookup(hfsmp
, &todesc
, 0, 0, NULL
, NULL
, NULL
, NULL
) == 0) {
543 if (cp
->c_flag
& C_HARDLINK
) {
544 struct cat_attr cattr
;
546 /* If inode is missing then we lost a race with unlink. */
547 if ((cat_idlookup(hfsmp
, cp
->c_fileid
, 0, 0, NULL
, &cattr
, NULL
) != 0) ||
548 (cattr
.ca_fileid
!= cp
->c_fileid
)) {
555 /* If source is missing then we lost a race with unlink. */
556 if ((cat_lookup(hfsmp
, &cp
->c_desc
, 0, 0, NULL
, NULL
, NULL
, &fileid
) != 0) ||
557 (fileid
!= cp
->c_fileid
)) {
563 * All directory links must reside in an non-ARCHIVED hierarchy.
565 if (v_type
== VDIR
) {
567 * - Source parent and destination parent cannot match
568 * - A link is not permitted in the root directory
569 * - Parent of 'pointed at' directory is not the root directory
570 * - The 'pointed at' directory (source) is not an ancestor
571 * of the new directory hard link (destination).
572 * - No ancestor of the new directory hard link (destination)
573 * is a directory hard link.
575 if ((parentcnid
== tdcp
->c_fileid
) ||
576 (tdcp
->c_fileid
== kHFSRootFolderID
) ||
577 (parentcnid
== kHFSRootFolderID
) ||
578 cat_check_link_ancestry(hfsmp
, tdcp
->c_fileid
, cp
->c_fileid
)) {
579 error
= EPERM
; /* abide by the rules, you did not */
583 hfs_systemfile_unlock(hfsmp
, lockflags
);
587 cp
->c_touch_chgtime
= TRUE
;
588 error
= hfs_makelink(hfsmp
, vp
, cp
, tdcp
, cnp
);
591 hfs_volupdate(hfsmp
, VOL_UPDATE
, 0);
593 /* Invalidate negative cache entries in the destination directory */
594 if (tdcp
->c_flag
& C_NEG_ENTRIES
) {
595 cache_purge_negatives(tdvp
);
596 tdcp
->c_flag
&= ~C_NEG_ENTRIES
;
599 /* Update the target directory and volume stats */
601 if (v_type
== VDIR
) {
602 INC_FOLDERCOUNT(hfsmp
, tdcp
->c_attr
);
603 tdcp
->c_attr
.ca_recflags
|= kHFSHasChildLinkMask
;
605 /* Set kHFSHasChildLinkBit in the destination hierarchy */
606 error
= cat_set_childlinkbit(hfsmp
, tdcp
->c_parentcnid
);
608 printf ("hfs_vnop_link: error updating destination parent chain for id=%u, vol=%s\n", tdcp
->c_cnid
, hfsmp
->vcbVN
);
612 tdcp
->c_dirchangecnt
++;
613 hfs_incr_gencount(tdcp
);
614 tdcp
->c_touch_chgtime
= TRUE
;
615 tdcp
->c_touch_modtime
= TRUE
;
616 tdcp
->c_flag
|= C_FORCEUPDATE
;
618 error
= hfs_update(tdvp
, 0);
619 if (error
&& error
!= EIO
&& error
!= ENXIO
) {
620 panic("hfs_vnop_link: error %d updating tdvp %p\n", error
, tdvp
);
623 if ((v_type
== VDIR
) &&
625 ((fdcp
->c_attr
.ca_recflags
& kHFSHasChildLinkMask
) == 0)) {
627 fdcp
->c_attr
.ca_recflags
|= kHFSHasChildLinkMask
;
628 fdcp
->c_touch_chgtime
= TRUE
;
629 fdcp
->c_flag
|= C_FORCEUPDATE
;
630 error
= hfs_update(fdvp
, 0);
631 if (error
&& error
!= EIO
&& error
!= ENXIO
) {
632 panic("hfs_vnop_link: error %d updating fdvp %p\n", error
, fdvp
);
635 /* Set kHFSHasChildLinkBit in the source hierarchy */
636 error
= cat_set_childlinkbit(hfsmp
, fdcp
->c_parentcnid
);
638 printf ("hfs_vnop_link: error updating source parent chain for id=%u, vol=%s\n", fdcp
->c_cnid
, hfsmp
->vcbVN
);
642 hfs_volupdate(hfsmp
, VOL_MKFILE
,
643 (tdcp
->c_cnid
== kHFSRootFolderID
));
645 /* Make sure update occurs inside transaction */
646 cp
->c_flag
|= C_FORCEUPDATE
;
648 if ((error
== 0) && (ret
= hfs_update(vp
, TRUE
)) != 0 && ret
!= EIO
&& ret
!= ENXIO
) {
649 panic("hfs_vnop_link: error %d updating vp @ %p\n", ret
, vp
);
654 hfs_systemfile_unlock(hfsmp
, lockflags
);
657 hfs_end_transaction(hfsmp
);
660 tdcp
->c_flag
&= ~C_DIR_MODIFICATION
;
661 wakeup((caddr_t
)&tdcp
->c_flag
);
664 hfs_unlockfour(tdcp
, cp
, fdcp
, NULL
);
666 hfs_unlockpair(tdcp
, cp
);
676 * Remove a link to a hardlink file/dir.
678 * Note: dvp and vp cnodes are already locked.
681 hfs_unlink(struct hfsmount
*hfsmp
, struct vnode
*dvp
, struct vnode
*vp
, struct componentname
*cnp
, int skip_reserve
)
685 struct cat_desc cndesc
;
694 if (hfsmp
->hfs_flags
& HFS_STANDARD
) {
700 dcp
->c_flag
|= C_DIR_MODIFICATION
;
702 /* Remove the entry from the namei cache: */
705 if ((error
= hfs_start_transaction(hfsmp
)) != 0) {
712 * Protect against a race with rename by using the component
713 * name passed in and parent id from dvp (instead of using
714 * the cp->c_desc which may have changed).
716 * Re-lookup the component name so we get the correct cnid
717 * for the name (as opposed to the c_cnid in the cnode which
718 * could have changed before the cnode was locked).
720 cndesc
.cd_flags
= vnode_isdir(vp
) ? CD_ISDIR
: 0;
721 cndesc
.cd_encoding
= cp
->c_desc
.cd_encoding
;
722 cndesc
.cd_nameptr
= (const u_int8_t
*)cnp
->cn_nameptr
;
723 cndesc
.cd_namelen
= cnp
->cn_namelen
;
724 cndesc
.cd_parentcnid
= dcp
->c_fileid
;
725 cndesc
.cd_hint
= dcp
->c_childhint
;
727 lockflags
= SFL_CATALOG
| SFL_ATTRIBUTE
;
728 if (cndesc
.cd_flags
& CD_ISDIR
) {
729 /* We'll be removing the alias resource allocation blocks. */
730 lockflags
|= SFL_BITMAP
;
732 lockflags
= hfs_systemfile_lock(hfsmp
, lockflags
, HFS_EXCLUSIVE_LOCK
);
734 if ((error
= cat_lookuplink(hfsmp
, &cndesc
, &cndesc
.cd_cnid
, &prevlinkid
, &nextlinkid
))) {
738 /* Reserve some space in the catalog file. */
739 if (!skip_reserve
&& (error
= cat_preflight(hfsmp
, 2 * CAT_DELETE
, NULL
, 0))) {
743 /* Purge any cached origin entries for a directory or file hard link. */
744 hfs_relorigin(cp
, dcp
->c_fileid
);
745 if (dcp
->c_fileid
!= dcp
->c_cnid
) {
746 hfs_relorigin(cp
, dcp
->c_cnid
);
749 /* Delete the link record. */
750 if ((error
= cat_deletelink(hfsmp
, &cndesc
))) {
754 /* Update the parent directory. */
755 if (dcp
->c_entries
> 0) {
758 if (cndesc
.cd_flags
& CD_ISDIR
) {
759 DEC_FOLDERCOUNT(hfsmp
, dcp
->c_attr
);
761 dcp
->c_dirchangecnt
++;
762 hfs_incr_gencount(dcp
);
764 dcp
->c_ctime
= tv
.tv_sec
;
765 dcp
->c_mtime
= tv
.tv_sec
;
766 (void ) cat_update(hfsmp
, &dcp
->c_desc
, &dcp
->c_attr
, NULL
, NULL
);
769 * If this is the last link then we need to process the inode.
770 * Otherwise we need to fix up the link chain.
773 if (cp
->c_linkcount
< 1) {
775 struct cat_desc to_desc
;
776 struct cat_desc from_desc
;
779 * If a file inode or directory inode is being deleted, rename
780 * it to an open deleted file. This ensures that deletion
781 * of inode and its corresponding extended attributes does
782 * not overflow the journal. This inode will be deleted
783 * either in hfs_vnop_inactive() or in hfs_remove_orphans().
784 * Note: a rename failure here is not fatal.
786 bzero(&from_desc
, sizeof(from_desc
));
787 bzero(&to_desc
, sizeof(to_desc
));
788 if (vnode_isdir(vp
)) {
789 if (cp
->c_entries
!= 0) {
790 panic("hfs_unlink: dir not empty (id %d, %d entries)", cp
->c_fileid
, cp
->c_entries
);
792 MAKE_DIRINODE_NAME(inodename
, sizeof(inodename
),
793 cp
->c_attr
.ca_linkref
);
794 from_desc
.cd_parentcnid
= hfsmp
->hfs_private_desc
[DIR_HARDLINKS
].cd_cnid
;
795 from_desc
.cd_flags
= CD_ISDIR
;
796 to_desc
.cd_flags
= CD_ISDIR
;
798 MAKE_INODE_NAME(inodename
, sizeof(inodename
),
799 cp
->c_attr
.ca_linkref
);
800 from_desc
.cd_parentcnid
= hfsmp
->hfs_private_desc
[FILE_HARDLINKS
].cd_cnid
;
801 from_desc
.cd_flags
= 0;
802 to_desc
.cd_flags
= 0;
804 from_desc
.cd_nameptr
= (const u_int8_t
*)inodename
;
805 from_desc
.cd_namelen
= strlen(inodename
);
806 from_desc
.cd_cnid
= cp
->c_fileid
;
808 MAKE_DELETED_NAME(delname
, sizeof(delname
), cp
->c_fileid
);
809 to_desc
.cd_nameptr
= (const u_int8_t
*)delname
;
810 to_desc
.cd_namelen
= strlen(delname
);
811 to_desc
.cd_parentcnid
= hfsmp
->hfs_private_desc
[FILE_HARDLINKS
].cd_cnid
;
812 to_desc
.cd_cnid
= cp
->c_fileid
;
814 error
= cat_rename(hfsmp
, &from_desc
, &hfsmp
->hfs_private_desc
[FILE_HARDLINKS
],
815 &to_desc
, (struct cat_desc
*)NULL
);
817 cp
->c_flag
|= C_DELETED
;
818 cp
->c_attr
.ca_recflags
&= ~kHFSHasLinkChainMask
;
819 cp
->c_attr
.ca_firstlink
= 0;
820 if (vnode_isdir(vp
)) {
821 hfsmp
->hfs_private_attr
[DIR_HARDLINKS
].ca_entries
--;
822 DEC_FOLDERCOUNT(hfsmp
, hfsmp
->hfs_private_attr
[DIR_HARDLINKS
]);
824 hfsmp
->hfs_private_attr
[FILE_HARDLINKS
].ca_entries
++;
825 INC_FOLDERCOUNT(hfsmp
, hfsmp
->hfs_private_attr
[FILE_HARDLINKS
]);
827 (void)cat_update(hfsmp
, &hfsmp
->hfs_private_desc
[DIR_HARDLINKS
],
828 &hfsmp
->hfs_private_attr
[DIR_HARDLINKS
], NULL
, NULL
);
829 (void)cat_update(hfsmp
, &hfsmp
->hfs_private_desc
[FILE_HARDLINKS
],
830 &hfsmp
->hfs_private_attr
[FILE_HARDLINKS
], NULL
, NULL
);
833 error
= 0; /* rename failure here is not fatal */
835 } else /* Still some links left */ {
839 * Update the start of the link chain.
840 * Note: Directory hard links store the first link in an attribute.
842 if (vnode_isdir(vp
) &&
843 getfirstlink(hfsmp
, cp
->c_fileid
, &firstlink
) == 0 &&
844 firstlink
== cndesc
.cd_cnid
) {
845 if (setfirstlink(hfsmp
, cp
->c_fileid
, nextlinkid
) == 0)
846 cp
->c_attr
.ca_recflags
|= kHFSHasAttributesMask
;
847 } else if (vnode_isreg(vp
) && cp
->c_attr
.ca_firstlink
== cndesc
.cd_cnid
) {
848 cp
->c_attr
.ca_firstlink
= nextlinkid
;
850 /* Update previous link. */
852 (void) cat_update_siblinglinks(hfsmp
, prevlinkid
, HFS_IGNORABLE_LINK
, nextlinkid
);
854 /* Update next link. */
856 (void) cat_update_siblinglinks(hfsmp
, nextlinkid
, prevlinkid
, HFS_IGNORABLE_LINK
);
860 * The call to cat_releasedesc below will only release the name buffer;
861 * it does not zero out the rest of the fields in the 'cat_desc' data structure.
863 * As a result, since there are still other links at this point, we need
864 * to make the current cnode descriptor point to the raw inode. If a path-based
865 * system call comes along first, it will replace the descriptor with a valid link
866 * ID. If a userland process already has a file descriptor open, then they will
867 * bypass that lookup, though. Replacing the descriptor CNID with the raw
868 * inode will force it to generate a new full path.
870 cp
->c_cnid
= cp
->c_fileid
;
874 /* Push new link count to disk. */
875 cp
->c_ctime
= tv
.tv_sec
;
876 (void) cat_update(hfsmp
, &cp
->c_desc
, &cp
->c_attr
, NULL
, NULL
);
878 /* All done with the system files. */
879 hfs_systemfile_unlock(hfsmp
, lockflags
);
882 /* Update file system stats. */
883 hfs_volupdate(hfsmp
, VOL_RMFILE
, (dcp
->c_cnid
== kHFSRootFolderID
));
886 * All done with this cnode's descriptor...
888 * Note: all future catalog calls for this cnode may be
889 * by fileid only. This is OK for HFS (which doesn't have
890 * file thread records) since HFS doesn't support hard links.
892 cat_releasedesc(&cp
->c_desc
);
896 hfs_systemfile_unlock(hfsmp
, lockflags
);
899 hfs_end_transaction(hfsmp
);
902 dcp
->c_flag
&= ~C_DIR_MODIFICATION
;
903 wakeup((caddr_t
)&dcp
->c_flag
);
910 * Initialize the HFS+ private system directories.
912 * These directories are used to hold the inodes
913 * for file and directory hardlinks as well as
914 * open-unlinked files.
916 * If they don't yet exist they will get created.
918 * This call is assumed to be made during mount.
921 hfs_privatedir_init(struct hfsmount
* hfsmp
, enum privdirtype type
)
923 struct vnode
* dvp
= NULLVP
;
924 struct cnode
* dcp
= NULL
;
925 struct cat_desc
*priv_descp
;
926 struct cat_attr
*priv_attrp
;
927 struct FndrDirInfo
* fndrinfo
;
933 if (hfsmp
->hfs_flags
& HFS_STANDARD
) {
937 priv_descp
= &hfsmp
->hfs_private_desc
[type
];
938 priv_attrp
= &hfsmp
->hfs_private_attr
[type
];
940 /* Check if directory already exists. */
941 if (priv_descp
->cd_cnid
!= 0) {
945 priv_descp
->cd_parentcnid
= kRootDirID
;
946 priv_descp
->cd_nameptr
= (const u_int8_t
*)hfs_private_names
[type
];
947 priv_descp
->cd_namelen
= strlen((const char *)priv_descp
->cd_nameptr
);
948 priv_descp
->cd_flags
= CD_ISDIR
| CD_DECOMPOSED
;
950 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_CATALOG
, HFS_SHARED_LOCK
);
951 error
= cat_lookup(hfsmp
, priv_descp
, 0, 0, NULL
, priv_attrp
, NULL
, NULL
);
952 hfs_systemfile_unlock(hfsmp
, lockflags
);
955 if (type
== FILE_HARDLINKS
) {
956 hfsmp
->hfs_metadata_createdate
= priv_attrp
->ca_itime
;
958 priv_descp
->cd_cnid
= priv_attrp
->ca_fileid
;
962 /* Directory is missing, if this is read-only then we're done. */
963 if (hfsmp
->hfs_flags
& HFS_READ_ONLY
) {
967 /* Grab the root directory so we can update it later. */
968 if (hfs_vget(hfsmp
, kRootDirID
, &dvp
, 0, 0) != 0) {
973 /* Setup the default attributes */
974 bzero(priv_attrp
, sizeof(struct cat_attr
));
975 priv_attrp
->ca_flags
= UF_IMMUTABLE
| UF_HIDDEN
;
976 priv_attrp
->ca_mode
= S_IFDIR
;
977 if (type
== DIR_HARDLINKS
) {
978 priv_attrp
->ca_mode
|= S_ISVTX
| S_IRUSR
| S_IXUSR
| S_IRGRP
|
979 S_IXGRP
| S_IROTH
| S_IXOTH
;
981 priv_attrp
->ca_linkcount
= 1;
982 priv_attrp
->ca_itime
= hfsmp
->hfs_itime
;
983 priv_attrp
->ca_recflags
= kHFSHasFolderCountMask
;
985 fndrinfo
= (struct FndrDirInfo
*)&priv_attrp
->ca_finderinfo
;
986 fndrinfo
->frLocation
.v
= SWAP_BE16(16384);
987 fndrinfo
->frLocation
.h
= SWAP_BE16(16384);
988 fndrinfo
->frFlags
= SWAP_BE16(kIsInvisible
+ kNameLocked
);
990 if (hfs_start_transaction(hfsmp
) != 0) {
995 /* Need the catalog and EA b-trees for CNID acquisition */
996 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_CATALOG
| SFL_ATTRIBUTE
, HFS_EXCLUSIVE_LOCK
);
998 /* Make sure there's space in the Catalog file. */
999 if (cat_preflight(hfsmp
, CAT_CREATE
, NULL
, 0) != 0) {
1000 hfs_systemfile_unlock(hfsmp
, lockflags
);
1004 /* Get the CNID for use */
1006 if ((error
= cat_acquire_cnid(hfsmp
, &new_id
))) {
1007 hfs_systemfile_unlock (hfsmp
, lockflags
);
1011 /* Create the private directory on disk. */
1012 error
= cat_create(hfsmp
, new_id
, priv_descp
, priv_attrp
, NULL
);
1014 priv_descp
->cd_cnid
= priv_attrp
->ca_fileid
;
1016 /* Update the parent directory */
1018 INC_FOLDERCOUNT(hfsmp
, dcp
->c_attr
);
1019 dcp
->c_dirchangecnt
++;
1020 hfs_incr_gencount(dcp
);
1022 dcp
->c_ctime
= tv
.tv_sec
;
1023 dcp
->c_mtime
= tv
.tv_sec
;
1024 (void) cat_update(hfsmp
, &dcp
->c_desc
, &dcp
->c_attr
, NULL
, NULL
);
1027 hfs_systemfile_unlock(hfsmp
, lockflags
);
1032 if (type
== FILE_HARDLINKS
) {
1033 hfsmp
->hfs_metadata_createdate
= priv_attrp
->ca_itime
;
1035 hfs_volupdate(hfsmp
, VOL_MKDIR
, 1);
1038 hfs_end_transaction(hfsmp
);
1044 if ((error
== 0) && (type
== DIR_HARDLINKS
)) {
1045 hfs_xattr_init(hfsmp
);
1051 * Lookup a hardlink link (from chain)
1054 hfs_lookup_siblinglinks(struct hfsmount
*hfsmp
, cnid_t linkfileid
, cnid_t
*prevlinkid
, cnid_t
*nextlinkid
)
1062 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_CATALOG
, HFS_SHARED_LOCK
);
1064 error
= cat_lookup_siblinglinks(hfsmp
, linkfileid
, prevlinkid
, nextlinkid
);
1065 if (error
== ENOLINK
) {
1066 hfs_systemfile_unlock(hfsmp
, lockflags
);
1067 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_ATTRIBUTE
, HFS_SHARED_LOCK
);
1069 error
= getfirstlink(hfsmp
, linkfileid
, nextlinkid
);
1071 hfs_systemfile_unlock(hfsmp
, lockflags
);
1077 /* Find the oldest / last hardlink in the link chain */
1079 hfs_lookup_lastlink (struct hfsmount
*hfsmp
, cnid_t linkfileid
,
1080 cnid_t
*lastid
, struct cat_desc
*cdesc
) {
1086 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_CATALOG
, HFS_SHARED_LOCK
);
1088 error
= cat_lookup_lastlink(hfsmp
, linkfileid
, lastid
, cdesc
);
1090 hfs_systemfile_unlock(hfsmp
, lockflags
);
1093 * cat_lookup_lastlink will zero out the lastid/cdesc arguments as needed
1101 * Cache the origin of a directory or file hard link
1103 * cnode must be lock on entry
1107 hfs_savelinkorigin(cnode_t
*cp
, cnid_t parentcnid
)
1109 linkorigin_t
*origin
= NULL
;
1110 void * thread
= current_thread();
1112 int maxorigins
= (S_ISDIR(cp
->c_mode
)) ? MAX_CACHED_ORIGINS
: MAX_CACHED_FILE_ORIGINS
;
1114 * Look for an existing origin first. If not found, create/steal one.
1116 TAILQ_FOREACH(origin
, &cp
->c_originlist
, lo_link
) {
1118 if (origin
->lo_thread
== thread
) {
1119 TAILQ_REMOVE(&cp
->c_originlist
, origin
, lo_link
);
1123 if (origin
== NULL
) {
1124 /* Recycle the last (i.e., the oldest) if we have too many. */
1125 if (count
> maxorigins
) {
1126 origin
= TAILQ_LAST(&cp
->c_originlist
, hfs_originhead
);
1127 TAILQ_REMOVE(&cp
->c_originlist
, origin
, lo_link
);
1129 MALLOC(origin
, linkorigin_t
*, sizeof(linkorigin_t
), M_TEMP
, M_WAITOK
);
1131 origin
->lo_thread
= thread
;
1133 origin
->lo_cnid
= cp
->c_cnid
;
1134 origin
->lo_parentcnid
= parentcnid
;
1135 TAILQ_INSERT_HEAD(&cp
->c_originlist
, origin
, lo_link
);
1139 * Release any cached origins for a directory or file hard link
1141 * cnode must be lock on entry
1145 hfs_relorigins(struct cnode
*cp
)
1147 linkorigin_t
*origin
, *prev
;
1149 TAILQ_FOREACH_SAFE(origin
, &cp
->c_originlist
, lo_link
, prev
) {
1150 FREE(origin
, M_TEMP
);
1152 TAILQ_INIT(&cp
->c_originlist
);
1156 * Release a specific origin for a directory or file hard link
1158 * cnode must be lock on entry
1162 hfs_relorigin(struct cnode
*cp
, cnid_t parentcnid
)
1164 linkorigin_t
*origin
, *prev
;
1165 void * thread
= current_thread();
1167 TAILQ_FOREACH_SAFE(origin
, &cp
->c_originlist
, lo_link
, prev
) {
1168 if ((origin
->lo_thread
== thread
) ||
1169 (origin
->lo_parentcnid
== parentcnid
)) {
1170 TAILQ_REMOVE(&cp
->c_originlist
, origin
, lo_link
);
1171 FREE(origin
, M_TEMP
);
1178 * Test if a directory or file hard link has a cached origin
1180 * cnode must be lock on entry
1184 hfs_haslinkorigin(cnode_t
*cp
)
1186 if (cp
->c_flag
& C_HARDLINK
) {
1187 linkorigin_t
*origin
;
1188 void * thread
= current_thread();
1190 TAILQ_FOREACH(origin
, &cp
->c_originlist
, lo_link
) {
1191 if (origin
->lo_thread
== thread
) {
1200 * Obtain the current parent cnid of a directory or file hard link
1202 * cnode must be lock on entry
1206 hfs_currentparent(cnode_t
*cp
)
1208 if (cp
->c_flag
& C_HARDLINK
) {
1209 linkorigin_t
*origin
;
1210 void * thread
= current_thread();
1212 TAILQ_FOREACH(origin
, &cp
->c_originlist
, lo_link
) {
1213 if (origin
->lo_thread
== thread
) {
1214 return (origin
->lo_parentcnid
);
1218 return (cp
->c_parentcnid
);
1222 * Obtain the current cnid of a directory or file hard link
1224 * cnode must be lock on entry
1228 hfs_currentcnid(cnode_t
*cp
)
1230 if (cp
->c_flag
& C_HARDLINK
) {
1231 linkorigin_t
*origin
;
1232 void * thread
= current_thread();
1234 TAILQ_FOREACH(origin
, &cp
->c_originlist
, lo_link
) {
1235 if (origin
->lo_thread
== thread
) {
1236 return (origin
->lo_cnid
);
1240 return (cp
->c_cnid
);
1245 * Set the first link attribute for a given file id.
1247 * The attributes b-tree must already be locked.
1248 * If journaling is enabled, a transaction must already be started.
1251 setfirstlink(struct hfsmount
* hfsmp
, cnid_t fileid
, cnid_t firstlink
)
1254 BTreeIterator
* iterator
;
1255 FSBufferDescriptor btdata
;
1256 u_int8_t attrdata
[FIRST_LINK_XATTR_REC_SIZE
];
1257 HFSPlusAttrData
*dataptr
;
1261 if (hfsmp
->hfs_attribute_cp
== NULL
) {
1264 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1265 bzero(iterator
, sizeof(*iterator
));
1267 result
= hfs_buildattrkey(fileid
, FIRST_LINK_XATTR_NAME
, (HFSPlusAttrKey
*)&iterator
->key
);
1271 dataptr
= (HFSPlusAttrData
*)&attrdata
[0];
1272 dataptr
->recordType
= kHFSPlusAttrInlineData
;
1273 dataptr
->reserved
[0] = 0;
1274 dataptr
->reserved
[1] = 0;
1277 * Since attrData is variable length, we calculate the size of
1278 * attrData by subtracting the size of all other members of
1279 * structure HFSPlusAttData from the size of attrdata.
1281 (void)snprintf((char *)&dataptr
->attrData
[0],
1282 sizeof(dataptr
) - (4 * sizeof(uint32_t)),
1283 "%lu", (unsigned long)firstlink
);
1284 dataptr
->attrSize
= 1 + strlen((char *)&dataptr
->attrData
[0]);
1286 /* Calculate size of record rounded up to multiple of 2 bytes. */
1287 datasize
= sizeof(HFSPlusAttrData
) - 2 + dataptr
->attrSize
+ ((dataptr
->attrSize
& 1) ? 1 : 0);
1289 btdata
.bufferAddress
= dataptr
;
1290 btdata
.itemSize
= datasize
;
1291 btdata
.itemCount
= 1;
1293 btfile
= hfsmp
->hfs_attribute_cp
->c_datafork
;
1295 /* Insert the attribute. */
1296 result
= BTInsertRecord(btfile
, iterator
, &btdata
, datasize
);
1297 if (result
== btExists
) {
1298 result
= BTReplaceRecord(btfile
, iterator
, &btdata
, datasize
);
1300 (void) BTFlushPath(btfile
);
1302 FREE(iterator
, M_TEMP
);
1304 return MacToVFSError(result
);
1308 * Get the first link attribute for a given file id.
1310 * The attributes b-tree must already be locked.
1313 getfirstlink(struct hfsmount
* hfsmp
, cnid_t fileid
, cnid_t
*firstlink
)
1316 BTreeIterator
* iterator
;
1317 FSBufferDescriptor btdata
;
1318 u_int8_t attrdata
[FIRST_LINK_XATTR_REC_SIZE
];
1319 HFSPlusAttrData
*dataptr
;
1323 if (hfsmp
->hfs_attribute_cp
== NULL
) {
1326 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1327 bzero(iterator
, sizeof(*iterator
));
1329 result
= hfs_buildattrkey(fileid
, FIRST_LINK_XATTR_NAME
, (HFSPlusAttrKey
*)&iterator
->key
);
1333 dataptr
= (HFSPlusAttrData
*)&attrdata
[0];
1334 datasize
= sizeof(attrdata
);
1336 btdata
.bufferAddress
= dataptr
;
1337 btdata
.itemSize
= sizeof(attrdata
);
1338 btdata
.itemCount
= 1;
1340 btfile
= hfsmp
->hfs_attribute_cp
->c_datafork
;
1342 result
= BTSearchRecord(btfile
, iterator
, &btdata
, NULL
, NULL
);
1346 if (dataptr
->attrSize
< 3) {
1350 *firstlink
= strtoul((char*)&dataptr
->attrData
[0], NULL
, 10);
1352 FREE(iterator
, M_TEMP
);
1354 return MacToVFSError(result
);