[apple/xnu.git] / bsd / isofs / cd9660 / cd9660_node.h

/*
 * Copyright (c) 2000-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@
 */
/*	$NetBSD: cd9660_node.h,v 1.10 1994/12/24 15:30:09 cgd Exp $	*/

/*-
 * Copyright (c) 1994
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley
 * by Pace Willisson (pace@blitz.com).  The Rock Ridge Extension
 * Support code is derived from software contributed to Berkeley
 * by Atsushi Murai (amurai@spec.co.jp).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)cd9660_node.h	8.4 (Berkeley) 12/5/94
 */
#ifndef _CD9660_NODE_H_
#define _CD9660_NODE_H_

#include <sys/appleapiopts.h>

#ifdef __APPLE_API_PRIVATE
/*
 * Theoretically, directories can be more than 2Gb in length,
 * however, in practice this seems unlikely. So, we define
 * the type doff_t as a long to keep down the cost of doing
 * lookup on a 32-bit machine. If you are porting to a 64-bit
 * architecture, you should make doff_t the same as off_t.
 */

#include <sys/lock.h>
#include <isofs/cd9660/iso.h>

#ifndef doff_t
#define doff_t	long
#endif

typedef	struct	{
	struct timespec	iso_atime;	/* time of last access */
	struct timespec	iso_mtime;	/* time of last modification */
	struct timespec	iso_ctime;	/* time file changed */
	uid_t		iso_uid;	/* owner user id */
	gid_t		iso_gid;	/* owner group id */
	u_short		iso_mode;	/* files access mode and type */
	short		iso_links;	/* links of file */
	dev_t		iso_rdev;	/* Major/Minor number for special */
} ISO_RRIP_INODE;

#ifdef ISODEVMAP
/*
 * FOr device# (major,minor) translation table
 */
struct iso_dnode {
	struct iso_dnode *d_next, **d_prev;	/* hash chain */
	dev_t		i_dev;		/* device where dnode resides */
	ino_t		i_number;	/* the identity of the inode */
	dev_t		d_dev;		/* device # for translation */
};
#endif

/* <ufs/inode.h> defines i_size as a macro */
#undef i_size

struct iso_node {
	struct	iso_node *i_next, **i_prev;	/* hash chain */
	struct	vnode *i_vnode;	/* vnode associated with this inode */
	struct	vnode *i_devvp;	/* vnode for block I/O */
	u_int32_t i_flag;	/* flags, see below */
	dev_t	i_dev;		/* device where inode resides */
	ino_t	i_number;	/* the identity of the inode */
				/* we use the actual starting block of the file */
	struct	iso_mnt *i_mnt;	/* filesystem associated with this inode */
	struct	lockf *i_lockf;	/* head of byte-level lock list */
	doff_t	i_endoff;	/* end of useful stuff in directory */
	doff_t	i_diroff;	/* offset in dir, where we found last entry */
	doff_t	i_offset;	/* offset of free space in directory */
	ino_t	i_ino;		/* inode number of found directory */
	struct   lock__bsd__ i_lock;    /* Inode lock. */
	long iso_extent;	/* extent of file */
	long i_size;
	long iso_start;		/* actual start of data of file (may be different */
				/* from iso_extent, if file has extended attributes) */
	ISO_RRIP_INODE  inode;
	
	ino_t	i_parent;		/* inode number of parent directory */
	u_char	*i_namep;		/* node name buffer */

	/* support Apple extensions to ISO directory rec */
	long		i_rsrcsize;	/* cached size of associated file */
	u_int32_t	i_FileType;	/* MacOS file type */
	u_int32_t	i_Creator;	/* MacOS file creator */
	u_int16_t	i_FinderFlags;	/* MacOS finder flags */

	u_int16_t	i_entries;	/* count of directory entries */
	
	struct riff_header *i_riff;
};

#define	i_forw		i_chain[0]
#define	i_back		i_chain[1]

/* These flags are kept in i_flag. */
#define	ISO_ASSOCIATED	0x0001		/* node is an associated file. */

/* <ufs/inode.h> defines VTOI and ITOV macros */
#undef VTOI
#undef ITOV

#define VTOI(vp) ((struct iso_node *)(vp)->v_data)
#define ITOV(ip) ((ip)->i_vnode)

/*
 * Prototypes for ISOFS vnode operations
 */
int cd9660_lookup __P((struct vop_lookup_args *));
int cd9660_open __P((struct vop_open_args *));
int cd9660_close __P((struct vop_close_args *));
int cd9660_access __P((struct vop_access_args *));
int cd9660_getattr __P((struct vop_getattr_args *));
int cd9660_read __P((struct vop_read_args *));
int cd9660_xa_read __P((struct vop_read_args *));
int cd9660_ioctl __P((struct vop_ioctl_args *));
int cd9660_select __P((struct vop_select_args *));
int cd9660_mmap __P((struct vop_mmap_args *));
int cd9660_seek __P((struct vop_seek_args *));
int cd9660_readdir __P((struct vop_readdir_args *));
int cd9660_readlink __P((struct vop_readlink_args *));
int cd9660_inactive __P((struct vop_inactive_args *));
int cd9660_reclaim __P((struct vop_reclaim_args *));
int cd9660_bmap __P((struct vop_bmap_args *));
int cd9660_lock __P((struct vop_lock_args *));
int cd9660_unlock __P((struct vop_unlock_args *));
int cd9660_strategy __P((struct vop_strategy_args *));
int cd9660_print __P((struct vop_print_args *));
int cd9660_islocked __P((struct vop_islocked_args *));
int cd9660_pathconf __P((struct vop_pathconf_args *));
int cd9660_blkatoff __P((struct vop_blkatoff_args *));

void cd9660_defattr __P((struct iso_directory_record *,
			struct iso_node *, struct buf *));
void cd9660_deftstamp __P((struct iso_directory_record *,
			struct iso_node *, struct buf *));
struct vnode *cd9660_ihashget __P((dev_t, ino_t, struct proc *));
void cd9660_ihashins __P((struct iso_node *));
void cd9660_ihashrem __P((struct iso_node *));
int cd9660_tstamp_conv7 __P((u_char *, struct timespec *));
int cd9660_tstamp_conv17 __P((u_char *, struct timespec *));
ino_t isodirino __P((struct iso_directory_record *, struct iso_mnt *));
#ifdef	ISODEVMAP
struct iso_dnode *iso_dmap __P((dev_t, ino_t, int));
void iso_dunmap __P((dev_t));
#endif

#endif /* __APPLE_API_PRIVATE */
#endif /* ! _CD9660_NODE_H_ */
Commit	Line	Data
1c79356b	1	/*
55e303ae	2	* Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	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
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b 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.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/* $NetBSD: cd9660_node.h,v 1.10 1994/12/24 15:30:09 cgd Exp $ */
	26
	27	/*-
	28	* Copyright (c) 1994
	29	* The Regents of the University of California. All rights reserved.
	30	*
	31	* This code is derived from software contributed to Berkeley
	32	* by Pace Willisson (pace@blitz.com). The Rock Ridge Extension
	33	* Support code is derived from software contributed to Berkeley
	34	* by Atsushi Murai (amurai@spec.co.jp).
	35	*
	36	* Redistribution and use in source and binary forms, with or without
	37	* modification, are permitted provided that the following conditions
	38	* are met:
	39	* 1. Redistributions of source code must retain the above copyright
	40	* notice, this list of conditions and the following disclaimer.
	41	* 2. Redistributions in binary form must reproduce the above copyright
	42	* notice, this list of conditions and the following disclaimer in the
	43	* documentation and/or other materials provided with the distribution.
	44	* 3. All advertising materials mentioning features or use of this software
	45	* must display the following acknowledgement:
	46	* This product includes software developed by the University of
	47	* California, Berkeley and its contributors.
	48	* 4. Neither the name of the University nor the names of its contributors
	49	* may be used to endorse or promote products derived from this software
	50	* without specific prior written permission.
	51	*
	52	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	53	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	54	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	55	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	56	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	57	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	58	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	59	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	60	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	61	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	62	* SUCH DAMAGE.
	63	*
	64	* @(#)cd9660_node.h 8.4 (Berkeley) 12/5/94
	65	*/
	66	#ifndef _CD9660_NODE_H_
	67	#define _CD9660_NODE_H_
	68
9bccf70c A	69	#include <sys/appleapiopts.h>
	70
	71	#ifdef __APPLE_API_PRIVATE
1c79356b A	72	/*
	73	* Theoretically, directories can be more than 2Gb in length,
	74	* however, in practice this seems unlikely. So, we define
	75	* the type doff_t as a long to keep down the cost of doing
	76	* lookup on a 32-bit machine. If you are porting to a 64-bit
	77	* architecture, you should make doff_t the same as off_t.
	78	*/
	79
	80	#include <sys/lock.h>
	81	#include <isofs/cd9660/iso.h>
	82
	83	#ifndef doff_t
	84	#define doff_t long
	85	#endif
	86
	87	typedef struct {
	88	struct timespec iso_atime; /* time of last access */
	89	struct timespec iso_mtime; /* time of last modification */
	90	struct timespec iso_ctime; /* time file changed */
	91	uid_t iso_uid; /* owner user id */
	92	gid_t iso_gid; /* owner group id */
	93	u_short iso_mode; /* files access mode and type */
	94	short iso_links; /* links of file */
	95	dev_t iso_rdev; /* Major/Minor number for special */
	96	} ISO_RRIP_INODE;
	97
	98	#ifdef ISODEVMAP
	99	/*
	100	* FOr device# (major,minor) translation table
	101	*/
	102	struct iso_dnode {
	103	struct iso_dnode d_next, d_prev; / hash chain */
	104	dev_t i_dev; /* device where dnode resides */
	105	ino_t i_number; /* the identity of the inode */
	106	dev_t d_dev; /* device # for translation */
	107	};
	108	#endif
	109
	110	/* <ufs/inode.h> defines i_size as a macro */
	111	#undef i_size
	112
	113	struct iso_node {
	114	struct iso_node i_next, i_prev; / hash chain */
	115	struct vnode i_vnode; / vnode associated with this inode */
	116	struct vnode i_devvp; / vnode for block I/O */
55e303ae	117	u_int32_t i_flag; /* flags, see below */
1c79356b A	118	dev_t i_dev; /* device where inode resides */
	119	ino_t i_number; /* the identity of the inode */
	120	/* we use the actual starting block of the file */
	121	struct iso_mnt i_mnt; / filesystem associated with this inode */
	122	struct lockf i_lockf; / head of byte-level lock list */
	123	doff_t i_endoff; /* end of useful stuff in directory */
	124	doff_t i_diroff; /* offset in dir, where we found last entry */
	125	doff_t i_offset; /* offset of free space in directory */
	126	ino_t i_ino; /* inode number of found directory */
	127	struct lock__bsd__ i_lock; /* Inode lock. */
	128	long iso_extent; /* extent of file */
	129	long i_size;
	130	long iso_start; /* actual start of data of file (may be different */
	131	/* from iso_extent, if file has extended attributes) */
	132	ISO_RRIP_INODE inode;
	133
	134	ino_t i_parent; /* inode number of parent directory */
	135	u_char i_namep; / node name buffer */
	136
	137	/* support Apple extensions to ISO directory rec */
	138	long i_rsrcsize; /* cached size of associated file */
	139	u_int32_t i_FileType; /* MacOS file type */
	140	u_int32_t i_Creator; /* MacOS file creator */
	141	u_int16_t i_FinderFlags; /* MacOS finder flags */
	142
	143	u_int16_t i_entries; /* count of directory entries */
55e303ae A	144
55e303ae A	145	struct riff_header *i_riff;
1c79356b A	146	};
	147
	148	#define i_forw i_chain[0]
	149	#define i_back i_chain[1]
	150
55e303ae A	151	/* These flags are kept in i_flag. */
55e303ae A	152	#define ISO_ASSOCIATED 0x0001 /* node is an associated file. */
1c79356b A	153
	154	/* <ufs/inode.h> defines VTOI and ITOV macros */
	155	#undef VTOI
	156	#undef ITOV
	157
	158	#define VTOI(vp) ((struct iso_node *)(vp)->v_data)
	159	#define ITOV(ip) ((ip)->i_vnode)
	160
	161	/*
	162	* Prototypes for ISOFS vnode operations
	163	*/
	164	int cd9660_lookup __P((struct vop_lookup_args *));
	165	int cd9660_open __P((struct vop_open_args *));
	166	int cd9660_close __P((struct vop_close_args *));
	167	int cd9660_access __P((struct vop_access_args *));
	168	int cd9660_getattr __P((struct vop_getattr_args *));
	169	int cd9660_read __P((struct vop_read_args *));
55e303ae	170	int cd9660_xa_read __P((struct vop_read_args *));
1c79356b A	171	int cd9660_ioctl __P((struct vop_ioctl_args *));
	172	int cd9660_select __P((struct vop_select_args *));
	173	int cd9660_mmap __P((struct vop_mmap_args *));
	174	int cd9660_seek __P((struct vop_seek_args *));
	175	int cd9660_readdir __P((struct vop_readdir_args *));
	176	int cd9660_readlink __P((struct vop_readlink_args *));
1c79356b A	177	int cd9660_inactive __P((struct vop_inactive_args *));
	178	int cd9660_reclaim __P((struct vop_reclaim_args *));
	179	int cd9660_bmap __P((struct vop_bmap_args *));
	180	int cd9660_lock __P((struct vop_lock_args *));
	181	int cd9660_unlock __P((struct vop_unlock_args *));
	182	int cd9660_strategy __P((struct vop_strategy_args *));
	183	int cd9660_print __P((struct vop_print_args *));
	184	int cd9660_islocked __P((struct vop_islocked_args *));
	185	int cd9660_pathconf __P((struct vop_pathconf_args *));
	186	int cd9660_blkatoff __P((struct vop_blkatoff_args *));
	187
	188	void cd9660_defattr __P((struct iso_directory_record *,
	189	struct iso_node , struct buf ));
	190	void cd9660_deftstamp __P((struct iso_directory_record *,
	191	struct iso_node , struct buf ));
	192	struct vnode cd9660_ihashget __P((dev_t, ino_t, struct proc ));
	193	void cd9660_ihashins __P((struct iso_node *));
	194	void cd9660_ihashrem __P((struct iso_node *));
	195	int cd9660_tstamp_conv7 __P((u_char , struct timespec ));
	196	int cd9660_tstamp_conv17 __P((u_char , struct timespec ));
	197	ino_t isodirino __P((struct iso_directory_record , struct iso_mnt ));
	198	#ifdef ISODEVMAP
	199	struct iso_dnode *iso_dmap __P((dev_t, ino_t, int));
	200	void iso_dunmap __P((dev_t));
	201	#endif
	202
9bccf70c	203	#endif /* __APPLE_API_PRIVATE */
1c79356b	204	#endif /* ! _CD9660_NODE_H_ */