[apple/xnu.git] / bsd / hfs / hfs_cnode.h

/*
 * Copyright (c) 2002-2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
#ifndef _HFS_CNODE_H_
#define _HFS_CNODE_H_

#include <sys/appleapiopts.h>

#ifdef KERNEL
#ifdef __APPLE_API_PRIVATE
#include <sys/types.h>
#include <sys/queue.h>
#include <sys/stat.h>
#include <sys/vnode.h>
#include <sys/quota.h>

#include <kern/locks.h>

#include <hfs/hfs_catalog.h>
#include <hfs/rangelist.h>


/*
 * The filefork is used to represent an HFS file fork (data or resource).
 * Reading or writing any of these fields requires holding cnode lock.
 */
struct filefork {
	struct cnode   *ff_cp;               /* cnode associated with this fork */
	struct rl_head  ff_invalidranges;    /* Areas of disk that should read back as zeroes */
	union {
	   void        *ffu_sysfileinfo;     /* additional info for system files */
	   char        *ffu_symlinkptr;      /* symbolic link pathname */
	} ff_union;
	struct cat_fork ff_data;             /* fork data (size, extents) */
};
typedef struct filefork filefork_t;

/* Aliases for common fields */
#define ff_size          ff_data.cf_size
#define ff_clumpsize     ff_data.cf_clump
#define ff_bytesread     ff_data.cf_bytesread
#define ff_blocks        ff_data.cf_blocks
#define ff_extents       ff_data.cf_extents
#define ff_unallocblocks ff_data.cf_vblocks

#define ff_symlinkptr    ff_union.ffu_symlinkptr
#define ff_sysfileinfo   ff_union.ffu_sysfileinfo


/* The btree code still needs these... */
#define fcbEOF           ff_size
#define fcbExtents       ff_extents
#define	fcbBTCBPtr       ff_sysfileinfo

typedef u_int8_t atomicflag_t;


/*
 * Hardlink Origin (for hardlinked directories).
 */
struct linkorigin {
	TAILQ_ENTRY(linkorigin)  lo_link;  /* chain */
	void *  lo_thread;      /* thread that performed the lookup */
	cnid_t  lo_cnid;        /* hardlink's cnid */
	cnid_t  lo_parentcnid;  /* hardlink's parent cnid */
};
typedef struct linkorigin linkorigin_t;

#define MAX_CACHED_ORIGINS  10


/*
 * The cnode is used to represent each active (or recently active)
 * file or directory in the HFS filesystem.
 *
 * Reading or writing any of these fields requires holding c_lock.
 */
struct cnode {
	lck_rw_t                c_rwlock;       /* cnode's lock */
	void *                  c_lockowner;    /* cnode's lock owner (exclusive case only) */
	lck_rw_t                c_truncatelock; /* protects file from truncation during read/write */
	LIST_ENTRY(cnode)	c_hash;		/* cnode's hash chain */
	u_int32_t		c_flag;		/* cnode's runtime flags */
	u_int32_t		c_hflag;	/* cnode's flags for maintaining hash - protected by global hash lock */
	struct vnode		*c_vp;		/* vnode for data fork or dir */
	struct vnode		*c_rsrc_vp;	/* vnode for resource fork */
	dev_t			c_dev;		/* cnode's device */
        struct dquot		*c_dquot[MAXQUOTAS]; /* cnode's quota info */
	struct klist		c_knotes;	/* knotes attached to this vnode */
	u_int32_t		c_childhint;	 /* catalog hint for children (small dirs only) */
	u_int32_t		c_dirthreadhint; /* catalog hint for directory's thread rec */
	struct cat_desc		c_desc;		/* cnode's descriptor */
	struct cat_attr		c_attr;		/* cnode's attributes */
	TAILQ_HEAD(hfs_originhead, linkorigin) c_originlist;  /* hardlink origin cache */
	TAILQ_HEAD(hfs_hinthead, directoryhint) c_hintlist;  /* readdir directory hint list */
  	int16_t			c_dirhinttag;	/* directory hint tag */
	union {
	    int16_t     cu_dirhintcnt;          /* directory hint count */
	    int16_t     cu_syslockcount;        /* system file use only */
	} c_union;
	u_int32_t		c_dirchangecnt; /* changes each insert/delete (in-core only) */
 	struct filefork		*c_datafork;	/* cnode's data fork */
	struct filefork		*c_rsrcfork;	/* cnode's rsrc fork */
	atomicflag_t	c_touch_acctime;
	atomicflag_t	c_touch_chgtime;
	atomicflag_t	c_touch_modtime;
};
typedef struct cnode cnode_t;

/* Aliases for common cnode fields */
#define c_cnid		c_desc.cd_cnid
#define c_hint		c_desc.cd_hint
#define c_parentcnid	c_desc.cd_parentcnid
#define c_encoding	c_desc.cd_encoding

#define c_fileid	c_attr.ca_fileid
#define c_mode		c_attr.ca_mode
#define c_linkcount	c_attr.ca_linkcount
#define c_uid		c_attr.ca_uid
#define c_gid		c_attr.ca_gid
#define c_rdev		c_attr.ca_union1.cau_rdev
#define c_atime		c_attr.ca_atime
#define c_mtime		c_attr.ca_mtime
#define c_ctime		c_attr.ca_ctime
#define c_itime		c_attr.ca_itime
#define c_btime		c_attr.ca_btime
#define c_flags		c_attr.ca_flags
#define c_finderinfo	c_attr.ca_finderinfo
#define c_blocks	c_attr.ca_union2.cau_blocks
#define c_entries	c_attr.ca_union2.cau_entries
#define c_zftimeout	c_childhint

#define c_dirhintcnt    c_union.cu_dirhintcnt
#define c_syslockcount  c_union.cu_syslockcount


/* hash maintenance flags kept in c_hflag and protected by hfs_chash_mutex */
#define H_ALLOC		0x00001	/* CNode is being allocated */
#define H_ATTACH	0x00002	/* CNode is being attached to by another vnode */
#define	H_TRANSIT	0x00004	/* CNode is getting recycled  */
#define H_WAITING	0x00008	/* CNode is being waited for */


/* Runtime cnode flags (kept in c_flag) */
#define C_NEED_RVNODE_PUT  0x00001  /* Need to do a vnode_put on c_rsrc_vp after the unlock */
#define C_NEED_DVNODE_PUT  0x00002  /* Need to do a vnode_put on c_vp after the unlock */
#define C_ZFWANTSYNC	   0x00004  /* fsync requested and file has holes */
#define C_FROMSYNC         0x00008  /* fsync was called from sync */ 

#define C_MODIFIED         0x00010  /* CNode has been modified */
#define C_NOEXISTS         0x00020  /* CNode has been deleted, catalog entry is gone */
#define C_DELETED          0x00040  /* CNode has been marked to be deleted */
#define C_HARDLINK         0x00080  /* CNode is a hard link (file or dir) */

#define C_FORCEUPDATE      0x00100  /* force the catalog entry update */
#define C_HASXATTRS        0x00200  /* cnode has extended attributes */
#define C_NEG_ENTRIES      0x00400  /* directory has negative name entries */
#define C_WARNED_RSRC      0x00800  /* cnode lookup warning has been issued */ 

#define C_NEED_DATA_SETSIZE  0x01000  /* Do a ubc_setsize(0) on c_rsrc_vp after the unlock */
#define C_NEED_RSRC_SETSIZE  0x02000  /* Do a ubc_setsize(0) on c_vp after the unlock */
#define C_DIR_MODIFICATION   0x04000  /* Directory is being modified, wait for lookups */

#define ZFTIMELIMIT	(5 * 60)

/*
 * The following is the "invisible" bit from the fdFlags field
 * in the FndrFileInfo.
 */
enum { kFinderInvisibleMask = 1 << 14 };


/*
 * Convert between cnode pointers and vnode pointers
 */
#define VTOC(vp)	((struct cnode *)vnode_fsnode((vp)))

#define CTOV(cp,rsrc)	(((rsrc) && S_ISREG((cp)->c_mode)) ? \
			(cp)->c_rsrc_vp : (cp)->c_vp)

/*
 * Convert between vnode pointers and file forks
 *
 * Note: no CTOF since that is ambiguous
 */

#define FTOC(fp)	((fp)->ff_cp)

#define VTOF(vp)	((vp) == VTOC((vp))->c_rsrc_vp ?	\
			 VTOC((vp))->c_rsrcfork :		\
			 VTOC((vp))->c_datafork)

#define VCTOF(vp, cp)	((vp) == (cp)->c_rsrc_vp ?	\
			 (cp)->c_rsrcfork :		\
			 (cp)->c_datafork)

#define FTOV(fp)	((fp) == FTOC(fp)->c_rsrcfork ?		\
			 FTOC(fp)->c_rsrc_vp :			\
			 FTOC(fp)->c_vp)


/*
 * Test for a resource fork
 */
#define FORK_IS_RSRC(fp)	((fp) == FTOC(fp)->c_rsrcfork)

#define VNODE_IS_RSRC(vp)	((vp) == VTOC((vp))->c_rsrc_vp)


#define ATIME_ONDISK_ACCURACY	300


/* This overlays the FileID portion of NFS file handles. */
struct hfsfid {
	u_int32_t hfsfid_cnid;	/* Catalog node ID. */
	u_int32_t hfsfid_gen;	/* Generation number (create date). */
};


/* Get new default vnode */
extern int hfs_getnewvnode(struct hfsmount *hfsmp, struct vnode *dvp, struct componentname *cnp,
                           struct cat_desc *descp, int flags, struct cat_attr *attrp,
                           struct cat_fork *forkp, struct vnode **vpp);


#define GNV_WANTRSRC   0x01  /* Request the resource fork vnode. */
#define GNV_SKIPLOCK   0x02  /* Skip taking the cnode lock (when getting resource fork). */
#define GNV_CREATE     0x04  /* The vnode is for a newly created item. */


/* Touch cnode times based on c_touch_xxx flags */
extern void hfs_touchtimes(struct hfsmount *, struct cnode *);

/*
 * HFS cnode hash functions.
 */
extern void  hfs_chashinit(void);
extern void  hfs_chashinit_finish(void);
extern void  hfs_chashinsert(struct cnode *cp);
extern int   hfs_chashremove(struct cnode *cp);
extern void  hfs_chash_abort(struct cnode *cp);
extern void  hfs_chash_rehash(struct cnode *cp1, struct cnode *cp2);
extern void  hfs_chashwakeup(struct cnode *cp, int flags);
extern void  hfs_chash_mark_in_transit(struct cnode *cp);

extern struct vnode * hfs_chash_getvnode(dev_t dev, ino_t inum, int wantrsrc, int skiplock);
extern struct cnode * hfs_chash_getcnode(dev_t dev, ino_t inum, struct vnode **vpp, int wantrsrc, int skiplock);
extern int hfs_chash_snoop(dev_t, ino_t, int (*)(const struct cat_desc *,
                            const struct cat_attr *, void *), void *);
extern int hfs_valid_cnode(struct hfsmount *hfsmp, struct vnode *dvp, struct componentname *cnp, cnid_t cnid);
				
extern int hfs_chash_set_childlinkbit(dev_t dev, cnid_t cnid);

/*
 * HFS cnode lock functions.
 *
 *  HFS Locking Order:
 *
 *  1. cnode truncate lock (if needed)
 *  2. cnode lock (in parent-child order if related, otherwise by address order)
 *  3. journal (if needed)
 *  4. system files (as needed)
 *       A. Catalog B-tree file
 *       B. Attributes B-tree file
 *       C. Startup file (if there is one)
 *       D. Allocation Bitmap file (always exclusive, supports recursion)
 *       E. Overflow Extents B-tree file (always exclusive, supports recursion)
 *  5. hfs mount point (always last)
 *
 */
enum hfslocktype  {HFS_SHARED_LOCK = 1, HFS_EXCLUSIVE_LOCK = 2, HFS_FORCE_LOCK = 3};
#define HFS_SHARED_OWNER  (void *)0xffffffff

extern int hfs_lock(struct cnode *, enum hfslocktype);
extern int hfs_lockpair(struct cnode *, struct cnode *, enum hfslocktype);
extern int hfs_lockfour(struct cnode *, struct cnode *, struct cnode *, struct cnode *,
                        enum hfslocktype);

extern void hfs_unlock(struct cnode *);
extern void hfs_unlockpair(struct cnode *, struct cnode *);
extern void hfs_unlockfour(struct cnode *, struct cnode *, struct cnode *, struct cnode *);

extern void hfs_lock_truncate(struct cnode *, int);
extern void hfs_unlock_truncate(struct cnode *, int);

#endif /* __APPLE_API_PRIVATE */
#endif /* KERNEL */

#endif /* ! _HFS_CNODE_H_ */
Commit	Line	Data
9bccf70c	1	/*
2d21ac55	2	* Copyright (c) 2002-2007 Apple Inc. All rights reserved.
9bccf70c	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
9bccf70c	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
9bccf70c A	27	*/
	28	#ifndef _HFS_CNODE_H_
	29	#define _HFS_CNODE_H_
	30
	31	#include <sys/appleapiopts.h>
	32
	33	#ifdef KERNEL
	34	#ifdef __APPLE_API_PRIVATE
	35	#include <sys/types.h>
9bccf70c A	36	#include <sys/queue.h>
	37	#include <sys/stat.h>
	38	#include <sys/vnode.h>
	39	#include <sys/quota.h>
	40
91447636 A	41	#include <kern/locks.h>
91447636 A	42
9bccf70c A	43	#include <hfs/hfs_catalog.h>
	44	#include <hfs/rangelist.h>
	45
	46
	47	/*
	48	* The filefork is used to represent an HFS file fork (data or resource).
	49	* Reading or writing any of these fields requires holding cnode lock.
	50	*/
	51	struct filefork {
91447636 A	52	struct cnode ff_cp; / cnode associated with this fork */
91447636 A	53	struct rl_head ff_invalidranges; /* Areas of disk that should read back as zeroes */
9bccf70c	54	union {
91447636 A	55	void ffu_sysfileinfo; / additional info for system files */
	56	char ffu_symlinkptr; / symbolic link pathname */
	57	} ff_union;
	58	struct cat_fork ff_data; /* fork data (size, extents) */
9bccf70c	59	};
55e303ae	60	typedef struct filefork filefork_t;
9bccf70c A	61
9bccf70c A	62	/* Aliases for common fields */
91447636 A	63	#define ff_size ff_data.cf_size
	64	#define ff_clumpsize ff_data.cf_clump
	65	#define ff_bytesread ff_data.cf_bytesread
	66	#define ff_blocks ff_data.cf_blocks
	67	#define ff_extents ff_data.cf_extents
55e303ae A	68	#define ff_unallocblocks ff_data.cf_vblocks
55e303ae A	69
91447636 A	70	#define ff_symlinkptr ff_union.ffu_symlinkptr
91447636 A	71	#define ff_sysfileinfo ff_union.ffu_sysfileinfo
9bccf70c A	72
	73
	74	/* The btree code still needs these... */
91447636 A	75	#define fcbEOF ff_size
	76	#define fcbExtents ff_extents
	77	#define fcbBTCBPtr ff_sysfileinfo
9bccf70c	78
91447636	79	typedef u_int8_t atomicflag_t;
2d21ac55 A	80
	81
	82	/*
	83	* Hardlink Origin (for hardlinked directories).
	84	*/
	85	struct linkorigin {
	86	TAILQ_ENTRY(linkorigin) lo_link; /* chain */
	87	void * lo_thread; /* thread that performed the lookup */
	88	cnid_t lo_cnid; /* hardlink's cnid */
	89	cnid_t lo_parentcnid; /* hardlink's parent cnid */
	90	};
	91	typedef struct linkorigin linkorigin_t;
	92
	93	#define MAX_CACHED_ORIGINS 10
	94
	95
9bccf70c A	96	/*
	97	* The cnode is used to represent each active (or recently active)
	98	* file or directory in the HFS filesystem.
	99	*
	100	* Reading or writing any of these fields requires holding c_lock.
	101	*/
	102	struct cnode {
91447636 A	103	lck_rw_t c_rwlock; /* cnode's lock */
	104	void * c_lockowner; /* cnode's lock owner (exclusive case only) */
	105	lck_rw_t c_truncatelock; /* protects file from truncation during read/write */
9bccf70c A	106	LIST_ENTRY(cnode) c_hash; /* cnode's hash chain */
9bccf70c A	107	u_int32_t c_flag; /* cnode's runtime flags */
91447636	108	u_int32_t c_hflag; /* cnode's flags for maintaining hash - protected by global hash lock */
9bccf70c A	109	struct vnode c_vp; / vnode for data fork or dir */
9bccf70c A	110	struct vnode c_rsrc_vp; / vnode for resource fork */
9bccf70c A	111	dev_t c_dev; /* cnode's device */
9bccf70c A	112	struct dquot c_dquot[MAXQUOTAS]; / cnode's quota info */
55e303ae	113	struct klist c_knotes; /* knotes attached to this vnode */
2d21ac55 A	114	u_int32_t c_childhint; /* catalog hint for children (small dirs only) */
2d21ac55 A	115	u_int32_t c_dirthreadhint; /* catalog hint for directory's thread rec */
9bccf70c A	116	struct cat_desc c_desc; /* cnode's descriptor */
9bccf70c A	117	struct cat_attr c_attr; /* cnode's attributes */
2d21ac55 A	118	TAILQ_HEAD(hfs_originhead, linkorigin) c_originlist; /* hardlink origin cache */
2d21ac55 A	119	TAILQ_HEAD(hfs_hinthead, directoryhint) c_hintlist; /* readdir directory hint list */
91447636 A	120	int16_t c_dirhinttag; /* directory hint tag */
	121	union {
	122	int16_t cu_dirhintcnt; /* directory hint count */
	123	int16_t cu_syslockcount; /* system file use only */
	124	} c_union;
2d21ac55	125	u_int32_t c_dirchangecnt; /* changes each insert/delete (in-core only) */
9bccf70c A	126	struct filefork c_datafork; / cnode's data fork */
9bccf70c A	127	struct filefork c_rsrcfork; / cnode's rsrc fork */
91447636 A	128	atomicflag_t c_touch_acctime;
	129	atomicflag_t c_touch_chgtime;
	130	atomicflag_t c_touch_modtime;
9bccf70c	131	};
55e303ae	132	typedef struct cnode cnode_t;
9bccf70c A	133
	134	/* Aliases for common cnode fields */
	135	#define c_cnid c_desc.cd_cnid
	136	#define c_hint c_desc.cd_hint
	137	#define c_parentcnid c_desc.cd_parentcnid
	138	#define c_encoding c_desc.cd_encoding
	139
	140	#define c_fileid c_attr.ca_fileid
	141	#define c_mode c_attr.ca_mode
2d21ac55	142	#define c_linkcount c_attr.ca_linkcount
9bccf70c A	143	#define c_uid c_attr.ca_uid
9bccf70c A	144	#define c_gid c_attr.ca_gid
2d21ac55	145	#define c_rdev c_attr.ca_union1.cau_rdev
9bccf70c A	146	#define c_atime c_attr.ca_atime
9bccf70c A	147	#define c_mtime c_attr.ca_mtime
9bccf70c A	148	#define c_ctime c_attr.ca_ctime
	149	#define c_itime c_attr.ca_itime
	150	#define c_btime c_attr.ca_btime
	151	#define c_flags c_attr.ca_flags
	152	#define c_finderinfo c_attr.ca_finderinfo
2d21ac55 A	153	#define c_blocks c_attr.ca_union2.cau_blocks
2d21ac55 A	154	#define c_entries c_attr.ca_union2.cau_entries
9bccf70c A	155	#define c_zftimeout c_childhint
9bccf70c A	156
91447636 A	157	#define c_dirhintcnt c_union.cu_dirhintcnt
91447636 A	158	#define c_syslockcount c_union.cu_syslockcount
9bccf70c	159
55e303ae	160
91447636 A	161	/* hash maintenance flags kept in c_hflag and protected by hfs_chash_mutex */
	162	#define H_ALLOC 0x00001 /* CNode is being allocated */
	163	#define H_ATTACH 0x00002 /* CNode is being attached to by another vnode */
	164	#define H_TRANSIT 0x00004 /* CNode is getting recycled */
	165	#define H_WAITING 0x00008 /* CNode is being waited for */
	166
9bccf70c	167
91447636 A	168	/* Runtime cnode flags (kept in c_flag) */
	169	#define C_NEED_RVNODE_PUT 0x00001 /* Need to do a vnode_put on c_rsrc_vp after the unlock */
	170	#define C_NEED_DVNODE_PUT 0x00002 /* Need to do a vnode_put on c_vp after the unlock */
	171	#define C_ZFWANTSYNC 0x00004 /* fsync requested and file has holes */
	172	#define C_FROMSYNC 0x00008 /* fsync was called from sync */
9bccf70c	173
91447636 A	174	#define C_MODIFIED 0x00010 /* CNode has been modified */
	175	#define C_NOEXISTS 0x00020 /* CNode has been deleted, catalog entry is gone */
	176	#define C_DELETED 0x00040 /* CNode has been marked to be deleted */
2d21ac55	177	#define C_HARDLINK 0x00080 /* CNode is a hard link (file or dir) */
9bccf70c	178
91447636 A	179	#define C_FORCEUPDATE 0x00100 /* force the catalog entry update */
91447636 A	180	#define C_HASXATTRS 0x00200 /* cnode has extended attributes */
2d21ac55 A	181	#define C_NEG_ENTRIES 0x00400 /* directory has negative name entries */
2d21ac55 A	182	#define C_WARNED_RSRC 0x00800 /* cnode lookup warning has been issued */
9bccf70c	183
0c530ab8 A	184	#define C_NEED_DATA_SETSIZE 0x01000 /* Do a ubc_setsize(0) on c_rsrc_vp after the unlock */
0c530ab8 A	185	#define C_NEED_RSRC_SETSIZE 0x02000 /* Do a ubc_setsize(0) on c_vp after the unlock */
2d21ac55	186	#define C_DIR_MODIFICATION 0x04000 /* Directory is being modified, wait for lookups */
9bccf70c A	187
	188	#define ZFTIMELIMIT (5 * 60)
	189
2d21ac55 A	190	/*
	191	* The following is the "invisible" bit from the fdFlags field
	192	* in the FndrFileInfo.
	193	*/
	194	enum { kFinderInvisibleMask = 1 << 14 };
	195
	196
9bccf70c A	197	/*
	198	* Convert between cnode pointers and vnode pointers
	199	*/
91447636	200	#define VTOC(vp) ((struct cnode *)vnode_fsnode((vp)))
9bccf70c A	201
	202	#define CTOV(cp,rsrc) (((rsrc) && S_ISREG((cp)->c_mode)) ? \
	203	(cp)->c_rsrc_vp : (cp)->c_vp)
	204
	205	/*
	206	* Convert between vnode pointers and file forks
	207	*
	208	* Note: no CTOF since that is ambiguous
	209	*/
	210
	211	#define FTOC(fp) ((fp)->ff_cp)
	212
	213	#define VTOF(vp) ((vp) == VTOC((vp))->c_rsrc_vp ? \
	214	VTOC((vp))->c_rsrcfork : \
	215	VTOC((vp))->c_datafork)
	216
2d21ac55 A	217	#define VCTOF(vp, cp) ((vp) == (cp)->c_rsrc_vp ? \
	218	(cp)->c_rsrcfork : \
	219	(cp)->c_datafork)
	220
9bccf70c A	221	#define FTOV(fp) ((fp) == FTOC(fp)->c_rsrcfork ? \
	222	FTOC(fp)->c_rsrc_vp : \
	223	FTOC(fp)->c_vp)
	224
55e303ae	225
9bccf70c A	226	/*
	227	* Test for a resource fork
	228	*/
	229	#define FORK_IS_RSRC(fp) ((fp) == FTOC(fp)->c_rsrcfork)
	230
	231	#define VNODE_IS_RSRC(vp) ((vp) == VTOC((vp))->c_rsrc_vp)
	232
	233
55e303ae	234	#define ATIME_ONDISK_ACCURACY 300
9bccf70c	235
91447636 A	236
91447636 A	237	/* This overlays the FileID portion of NFS file handles. */
9bccf70c	238	struct hfsfid {
9bccf70c A	239	u_int32_t hfsfid_cnid; /* Catalog node ID. */
	240	u_int32_t hfsfid_gen; /* Generation number (create date). */
	241	};
	242
	243
2d21ac55 A	244	/* Get new default vnode */
	245	extern int hfs_getnewvnode(struct hfsmount hfsmp, struct vnode dvp, struct componentname *cnp,
	246	struct cat_desc descp, int flags, struct cat_attr attrp,
	247	struct cat_fork forkp, struct vnode *vpp);
	248
	249
	250	#define GNV_WANTRSRC 0x01 /* Request the resource fork vnode. */
	251	#define GNV_SKIPLOCK 0x02 /* Skip taking the cnode lock (when getting resource fork). */
	252	#define GNV_CREATE 0x04 /* The vnode is for a newly created item. */
	253
	254
	255	/* Touch cnode times based on c_touch_xxx flags */
91447636 A	256	extern void hfs_touchtimes(struct hfsmount , struct cnode );
91447636 A	257
9bccf70c A	258	/*
	259	* HFS cnode hash functions.
	260	*/
	261	extern void hfs_chashinit(void);
2d21ac55	262	extern void hfs_chashinit_finish(void);
9bccf70c	263	extern void hfs_chashinsert(struct cnode *cp);
91447636 A	264	extern int hfs_chashremove(struct cnode *cp);
	265	extern void hfs_chash_abort(struct cnode *cp);
	266	extern void hfs_chash_rehash(struct cnode cp1, struct cnode cp2);
	267	extern void hfs_chashwakeup(struct cnode *cp, int flags);
	268	extern void hfs_chash_mark_in_transit(struct cnode *cp);
	269
	270	extern struct vnode * hfs_chash_getvnode(dev_t dev, ino_t inum, int wantrsrc, int skiplock);
	271	extern struct cnode * hfs_chash_getcnode(dev_t dev, ino_t inum, struct vnode **vpp, int wantrsrc, int skiplock);
	272	extern int hfs_chash_snoop(dev_t, ino_t, int ()(const struct cat_desc ,
	273	const struct cat_attr , void ), void *);
2d21ac55	274	extern int hfs_valid_cnode(struct hfsmount hfsmp, struct vnode dvp, struct componentname *cnp, cnid_t cnid);
91447636	275
2d21ac55	276	extern int hfs_chash_set_childlinkbit(dev_t dev, cnid_t cnid);
91447636 A	277
	278	/*
	279	* HFS cnode lock functions.
	280	*
	281	* HFS Locking Order:
	282	*
	283	* 1. cnode truncate lock (if needed)
	284	* 2. cnode lock (in parent-child order if related, otherwise by address order)
	285	* 3. journal (if needed)
	286	* 4. system files (as needed)
	287	* A. Catalog B-tree file
	288	* B. Attributes B-tree file
2d21ac55 A	289	* C. Startup file (if there is one)
	290	* D. Allocation Bitmap file (always exclusive, supports recursion)
	291	* E. Overflow Extents B-tree file (always exclusive, supports recursion)
91447636 A	292	* 5. hfs mount point (always last)
	293	*
	294	*/
	295	enum hfslocktype {HFS_SHARED_LOCK = 1, HFS_EXCLUSIVE_LOCK = 2, HFS_FORCE_LOCK = 3};
	296	#define HFS_SHARED_OWNER (void *)0xffffffff
	297
	298	extern int hfs_lock(struct cnode *, enum hfslocktype);
	299	extern int hfs_lockpair(struct cnode , struct cnode , enum hfslocktype);
	300	extern int hfs_lockfour(struct cnode , struct cnode , struct cnode , struct cnode ,
	301	enum hfslocktype);
	302
	303	extern void hfs_unlock(struct cnode *);
	304	extern void hfs_unlockpair(struct cnode , struct cnode );
	305	extern void hfs_unlockfour(struct cnode , struct cnode , struct cnode , struct cnode );
	306
	307	extern void hfs_lock_truncate(struct cnode *, int);
2d21ac55	308	extern void hfs_unlock_truncate(struct cnode *, int);
9bccf70c A	309
	310	#endif /* __APPLE_API_PRIVATE */
	311	#endif /* KERNEL */
	312
	313	#endif /* ! _HFS_CNODE_H_ */