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

/*
 * Copyright (c) 2002-2003 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_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/lock.h>
#include <sys/queue.h>
#include <sys/stat.h>
#include <sys/vnode.h>
#include <sys/quota.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 */
	long			ff_evtonly_refs;	/* number of vnode references used solely for events (O_EVTONLY) */
	union {
	  struct hfslockf *ffu_lockf;	/* Head of byte-level lock list. */
	  void *ffu_sysdata;		/* private data for system files */
	  char *ffu_symlinkptr;		/* symbolic link pathname */
	} ff_un;
	struct cat_fork	ff_data;
};
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_un.ffu_symlinkptr
#define	ff_lockf	ff_un.ffu_lockf


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


/*
 * Directory index entry
 */
struct	hfs_index {
	SLIST_ENTRY(hfs_index) hi_link;
	int	hi_index;
	void	*hi_thread;	/* thread that created index entry */
	char	hi_name[1];
};

/*
 * 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 {
	struct lock__bsd__	c_lock;		/* cnode's lock */
	LIST_ENTRY(cnode)	c_hash;		/* cnode's hash chain */
	u_int32_t		c_flag;		/* cnode's runtime flags */
	struct vnode		*c_vp;		/* vnode for data fork or dir */
	struct vnode		*c_rsrc_vp;	/* vnode for resource fork */
	struct vnode		*c_devvp;	/* vnode for block I/O */
	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 */
	cnid_t			c_childhint;	/* catalog hint for children */
	struct cat_desc		c_desc;		/* cnode's descriptor */
	struct cat_attr		c_attr;		/* cnode's attributes */
	SLIST_HEAD(hfs_indexhead, hfs_index) c_indexlist;  /* directory index list */
	long                c_evtonly_refs;	/* number of vnode references used solely for events (O_EVTONLY) */
 	struct filefork		*c_datafork;	/* cnode's data fork */
	struct filefork		*c_rsrcfork;	/* cnode's rsrc fork */
};
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_nlink		c_attr.ca_nlink
#define c_uid		c_attr.ca_uid
#define c_gid		c_attr.ca_gid
#define c_rdev		c_attr.ca_rdev
#define c_atime		c_attr.ca_atime
#define c_mtime		c_attr.ca_mtime
#define c_mtime_nsec	c_attr.ca_mtime_nsec
#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_blocks
#define c_entries	c_attr.ca_entries
#define c_zftimeout	c_childhint


/* Runtime cnode flags (kept in c_flag) */
#define C_ACCESS	0x00001	/* Access time update request */
#define C_CHANGE	0x00002	/* Change time update request */
#define C_UPDATE	0x00004	/* Modification time update request */
#define C_MODIFIED 	0x00008	/* CNode has been modified */

#define C_RELOCATING	0x00010	/* CNode's fork is being relocated */
#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 */

#define C_ALLOC		0x00100	/* CNode is being allocated */
#define C_WALLOC	0x00200	/* Waiting for allocation to finish */
#define	C_TRANSIT	0x00400	/* CNode is getting recycled  */
#define	C_WTRANSIT	0x00800	/* Waiting for cnode getting recycled  */
#define C_NOBLKMAP	0x01000	/* CNode blocks cannot be mapped */
#define C_WBLKMAP	0x02000	/* Waiting for block map */

#define C_ZFWANTSYNC	0x04000	/* fsync requested and file has holes */
#define C_VPREFHELD     0x08000 /* resource fork has done a vget() on c_vp (for its parent ptr) */

#define C_FROMSYNC      0x10000 /* fsync was called from sync */ 
#define C_FORCEUPDATE   0x20000 /* force the catalog entry update */


#define ZFTIMELIMIT	(5 * 60)

/*
 * Convert between cnode pointers and vnode pointers
 */
#define VTOC(vp)	((struct cnode *)(vp)->v_data)

#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 FTOV(fp)	((fp) == FTOC(fp)->c_rsrcfork ?		\
			 FTOC(fp)->c_rsrc_vp :			\
			 FTOC(fp)->c_vp)

#define EVTONLYREFS(vp) ((vp->v_type == VREG) ? VTOF(vp)->ff_evtonly_refs : VTOC(vp)->c_evtonly_refs)

/*
 * 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)


/*
 * CTIMES should be an inline function...
 */
#define C_TIMEMASK	(C_ACCESS | C_CHANGE | C_UPDATE)

#define C_CHANGEMASK	(C_ACCESS | C_CHANGE | C_UPDATE | C_MODIFIED)

#define ATIME_ACCURACY	        1
#define ATIME_ONDISK_ACCURACY	300

#define CTIMES(cp, t1, t2) {							\
	if ((cp)->c_flag & C_TIMEMASK) {					\
		/*								\
		 * Only do the update if it is more than just			\
		 * the C_ACCESS field being updated.				\
		 */								\
		if (((cp)->c_flag & C_CHANGEMASK) != C_ACCESS) {		\
			if ((cp)->c_flag & C_ACCESS) {				\
				(cp)->c_atime = (t1)->tv_sec;			\
			}							\
			if ((cp)->c_flag & C_UPDATE) {				\
				(cp)->c_mtime = (t2)->tv_sec;			\
				(cp)->c_mtime_nsec = (t2)->tv_usec * 1000;	\
			}							\
			if ((cp)->c_flag & C_CHANGE) {				\
				(cp)->c_ctime = time.tv_sec;			\
			}							\
			(cp)->c_flag |= C_MODIFIED;				\
			(cp)->c_flag &= ~C_TIMEMASK;				\
		}								\
	}									\
}

/* This overlays the fid structure (see mount.h). */
struct hfsfid {
	u_int16_t hfsfid_len;	/* Length of structure. */
	u_int16_t hfsfid_pad;	/* Force 32-bit alignment. */
	/* The following data is filesystem-dependent, up to MAXFIDSZ (16) bytes: */
	u_int32_t hfsfid_cnid;	/* Catalog node ID. */
	u_int32_t hfsfid_gen;	/* Generation number (create date). */
};


/*
 * HFS cnode hash functions.
 */
extern void  hfs_chashinit(void);
extern void  hfs_chashinsert(struct cnode *cp);
extern void  hfs_chashremove(struct cnode *cp);
extern struct cnode * hfs_chashget(dev_t dev, ino_t inum, int wantrsrc,
				struct vnode **vpp, struct vnode **rvpp);

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

#endif /* ! _HFS_CNODE_H_ */
Commit	Line	Data
9bccf70c	1	/*
55e303ae	2	* Copyright (c) 2002-2003 Apple Computer, Inc. All rights reserved.
9bccf70c A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
9bccf70c	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
9bccf70c A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
9bccf70c A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
9bccf70c A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	#ifndef _HFS_CNODE_H_
	26	#define _HFS_CNODE_H_
	27
	28	#include <sys/appleapiopts.h>
	29
	30	#ifdef KERNEL
	31	#ifdef __APPLE_API_PRIVATE
	32	#include <sys/types.h>
	33	#include <sys/lock.h>
	34	#include <sys/queue.h>
	35	#include <sys/stat.h>
	36	#include <sys/vnode.h>
	37	#include <sys/quota.h>
	38
	39	#include <hfs/hfs_catalog.h>
	40	#include <hfs/rangelist.h>
	41
	42
	43	/*
	44	* The filefork is used to represent an HFS file fork (data or resource).
	45	* Reading or writing any of these fields requires holding cnode lock.
	46	*/
	47	struct filefork {
	48	struct cnode ff_cp; / cnode associated with this fork */
	49	struct rl_head ff_invalidranges; /* Areas of disk that should read back as zeroes */
55e303ae	50	long ff_evtonly_refs; /* number of vnode references used solely for events (O_EVTONLY) */
9bccf70c A	51	union {
	52	struct hfslockf ffu_lockf; / Head of byte-level lock list. */
	53	void ffu_sysdata; / private data for system files */
	54	char ffu_symlinkptr; / symbolic link pathname */
	55	} ff_un;
	56	struct cat_fork ff_data;
9bccf70c	57	};
55e303ae	58	typedef struct filefork filefork_t;
9bccf70c A	59
	60	/* Aliases for common fields */
	61	#define ff_size ff_data.cf_size
	62	#define ff_clumpsize ff_data.cf_clump
55e303ae	63	#define ff_bytesread ff_data.cf_bytesread
9bccf70c A	64	#define ff_blocks ff_data.cf_blocks
9bccf70c A	65	#define ff_extents ff_data.cf_extents
55e303ae A	66	#define ff_unallocblocks ff_data.cf_vblocks
55e303ae A	67
9bccf70c A	68	#define ff_symlinkptr ff_un.ffu_symlinkptr
	69	#define ff_lockf ff_un.ffu_lockf
	70
	71
	72	/* The btree code still needs these... */
	73	#define fcbEOF ff_size
9bccf70c A	74	#define fcbExtents ff_extents
	75	#define fcbBTCBPtr ff_un.ffu_sysdata
	76
	77
	78	/*
	79	* Directory index entry
	80	*/
	81	struct hfs_index {
	82	SLIST_ENTRY(hfs_index) hi_link;
	83	int hi_index;
	84	void hi_thread; / thread that created index entry */
	85	char hi_name[1];
	86	};
	87
	88	/*
	89	* The cnode is used to represent each active (or recently active)
	90	* file or directory in the HFS filesystem.
	91	*
	92	* Reading or writing any of these fields requires holding c_lock.
	93	*/
	94	struct cnode {
	95	struct lock__bsd__ c_lock; /* cnode's lock */
	96	LIST_ENTRY(cnode) c_hash; /* cnode's hash chain */
	97	u_int32_t c_flag; /* cnode's runtime flags */
	98	struct vnode c_vp; / vnode for data fork or dir */
	99	struct vnode c_rsrc_vp; / vnode for resource fork */
	100	struct vnode c_devvp; / vnode for block I/O */
	101	dev_t c_dev; /* cnode's device */
	102	struct dquot c_dquot[MAXQUOTAS]; / cnode's quota info */
55e303ae	103	struct klist c_knotes; /* knotes attached to this vnode */
9bccf70c A	104	cnid_t c_childhint; /* catalog hint for children */
	105	struct cat_desc c_desc; /* cnode's descriptor */
	106	struct cat_attr c_attr; /* cnode's attributes */
	107	SLIST_HEAD(hfs_indexhead, hfs_index) c_indexlist; /* directory index list */
55e303ae	108	long c_evtonly_refs; /* number of vnode references used solely for events (O_EVTONLY) */
9bccf70c A	109	struct filefork c_datafork; / cnode's data fork */
	110	struct filefork c_rsrcfork; / cnode's rsrc fork */
	111	};
55e303ae	112	typedef struct cnode cnode_t;
9bccf70c A	113
	114	/* Aliases for common cnode fields */
	115	#define c_cnid c_desc.cd_cnid
	116	#define c_hint c_desc.cd_hint
	117	#define c_parentcnid c_desc.cd_parentcnid
	118	#define c_encoding c_desc.cd_encoding
	119
	120	#define c_fileid c_attr.ca_fileid
	121	#define c_mode c_attr.ca_mode
	122	#define c_nlink c_attr.ca_nlink
	123	#define c_uid c_attr.ca_uid
	124	#define c_gid c_attr.ca_gid
	125	#define c_rdev c_attr.ca_rdev
	126	#define c_atime c_attr.ca_atime
	127	#define c_mtime c_attr.ca_mtime
	128	#define c_mtime_nsec c_attr.ca_mtime_nsec
	129	#define c_ctime c_attr.ca_ctime
	130	#define c_itime c_attr.ca_itime
	131	#define c_btime c_attr.ca_btime
	132	#define c_flags c_attr.ca_flags
	133	#define c_finderinfo c_attr.ca_finderinfo
	134	#define c_blocks c_attr.ca_blocks
	135	#define c_entries c_attr.ca_entries
	136	#define c_zftimeout c_childhint
	137
	138
	139	/* Runtime cnode flags (kept in c_flag) */
55e303ae A	140	#define C_ACCESS 0x00001 /* Access time update request */
	141	#define C_CHANGE 0x00002 /* Change time update request */
	142	#define C_UPDATE 0x00004 /* Modification time update request */
	143	#define C_MODIFIED 0x00008 /* CNode has been modified */
	144
	145	#define C_RELOCATING 0x00010 /* CNode's fork is being relocated */
	146	#define C_NOEXISTS 0x00020 /* CNode has been deleted, catalog entry is gone */
	147	#define C_DELETED 0x00040 /* CNode has been marked to be deleted */
	148	#define C_HARDLINK 0x00080 /* CNode is a hard link */
9bccf70c	149
55e303ae A	150	#define C_ALLOC 0x00100 /* CNode is being allocated */
	151	#define C_WALLOC 0x00200 /* Waiting for allocation to finish */
	152	#define C_TRANSIT 0x00400 /* CNode is getting recycled */
	153	#define C_WTRANSIT 0x00800 /* Waiting for cnode getting recycled */
	154	#define C_NOBLKMAP 0x01000 /* CNode blocks cannot be mapped */
	155	#define C_WBLKMAP 0x02000 /* Waiting for block map */
9bccf70c	156
55e303ae A	157	#define C_ZFWANTSYNC 0x04000 /* fsync requested and file has holes */
55e303ae A	158	#define C_VPREFHELD 0x08000 /* resource fork has done a vget() on c_vp (for its parent ptr) */
9bccf70c	159
55e303ae A	160	#define C_FROMSYNC 0x10000 /* fsync was called from sync */
55e303ae A	161	#define C_FORCEUPDATE 0x20000 /* force the catalog entry update */
9bccf70c A	162
	163
	164	#define ZFTIMELIMIT (5 * 60)
	165
	166	/*
	167	* Convert between cnode pointers and vnode pointers
	168	*/
	169	#define VTOC(vp) ((struct cnode *)(vp)->v_data)
	170
	171	#define CTOV(cp,rsrc) (((rsrc) && S_ISREG((cp)->c_mode)) ? \
	172	(cp)->c_rsrc_vp : (cp)->c_vp)
	173
	174	/*
	175	* Convert between vnode pointers and file forks
	176	*
	177	* Note: no CTOF since that is ambiguous
	178	*/
	179
	180	#define FTOC(fp) ((fp)->ff_cp)
	181
	182	#define VTOF(vp) ((vp) == VTOC((vp))->c_rsrc_vp ? \
	183	VTOC((vp))->c_rsrcfork : \
	184	VTOC((vp))->c_datafork)
	185
	186	#define FTOV(fp) ((fp) == FTOC(fp)->c_rsrcfork ? \
	187	FTOC(fp)->c_rsrc_vp : \
	188	FTOC(fp)->c_vp)
	189
55e303ae A	190	#define EVTONLYREFS(vp) ((vp->v_type == VREG) ? VTOF(vp)->ff_evtonly_refs : VTOC(vp)->c_evtonly_refs)
55e303ae A	191
9bccf70c A	192	/*
	193	* Test for a resource fork
	194	*/
	195	#define FORK_IS_RSRC(fp) ((fp) == FTOC(fp)->c_rsrcfork)
	196
	197	#define VNODE_IS_RSRC(vp) ((vp) == VTOC((vp))->c_rsrc_vp)
	198
	199
	200	/*
	201	* CTIMES should be an inline function...
	202	*/
	203	#define C_TIMEMASK (C_ACCESS \| C_CHANGE \| C_UPDATE)
	204
55e303ae A	205	#define C_CHANGEMASK (C_ACCESS \| C_CHANGE \| C_UPDATE \| C_MODIFIED)
	206
	207	#define ATIME_ACCURACY 1
	208	#define ATIME_ONDISK_ACCURACY 300
9bccf70c A	209
	210	#define CTIMES(cp, t1, t2) { \
	211	if ((cp)->c_flag & C_TIMEMASK) { \
	212	/* \
55e303ae A	213	* Only do the update if it is more than just \
55e303ae A	214	* the C_ACCESS field being updated. \
9bccf70c	215	*/ \
55e303ae	216	if (((cp)->c_flag & C_CHANGEMASK) != C_ACCESS) { \
9bccf70c A	217	if ((cp)->c_flag & C_ACCESS) { \
	218	(cp)->c_atime = (t1)->tv_sec; \
	219	} \
	220	if ((cp)->c_flag & C_UPDATE) { \
	221	(cp)->c_mtime = (t2)->tv_sec; \
	222	(cp)->c_mtime_nsec = (t2)->tv_usec * 1000; \
	223	} \
	224	if ((cp)->c_flag & C_CHANGE) { \
	225	(cp)->c_ctime = time.tv_sec; \
	226	} \
	227	(cp)->c_flag \|= C_MODIFIED; \
	228	(cp)->c_flag &= ~C_TIMEMASK; \
	229	} \
	230	} \
	231	}
	232
	233	/* This overlays the fid structure (see mount.h). */
	234	struct hfsfid {
	235	u_int16_t hfsfid_len; /* Length of structure. */
	236	u_int16_t hfsfid_pad; /* Force 32-bit alignment. */
	237	/* The following data is filesystem-dependent, up to MAXFIDSZ (16) bytes: */
	238	u_int32_t hfsfid_cnid; /* Catalog node ID. */
	239	u_int32_t hfsfid_gen; /* Generation number (create date). */
	240	};
	241
	242
	243	/*
	244	* HFS cnode hash functions.
	245	*/
	246	extern void hfs_chashinit(void);
	247	extern void hfs_chashinsert(struct cnode *cp);
	248	extern void hfs_chashremove(struct cnode *cp);
	249	extern struct cnode * hfs_chashget(dev_t dev, ino_t inum, int wantrsrc,
	250	struct vnode vpp, struct vnode rvpp);
	251
	252	#endif /* __APPLE_API_PRIVATE */
	253	#endif /* KERNEL */
	254
	255	#endif /* ! _HFS_CNODE_H_ */