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

/*
 * Copyright (c) 2000-2003 Apple Computer, 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@
 */
/*	$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 <sys/kauth.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 */
        daddr_t	i_lastr;	/* last read (read ahead) */
	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. */
#define ISO_INALLOC	0x0002
#define ISO_INWALLOC	0x0004


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

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

/* similar in <hfs/hfs_mount.h> as default UID and GID */
#define ISO_UNKNOWNUID 	((uid_t)99)
#define ISO_UNKNOWNGID	((gid_t)99)

int cd9660_access_internal(vnode_t, mode_t, kauth_cred_t);

/*
 * Prototypes for ISOFS vnode operations
 */
int cd9660_blktooff(struct vnop_blktooff_args *);
int cd9660_offtoblk(struct vnop_offtoblk_args *);
int cd9660_blockmap(struct vnop_blockmap_args *);
int cd9660_lookup (struct vnop_lookup_args *);
int cd9660_open (struct vnop_open_args *);
int cd9660_close (struct vnop_close_args *);
int cd9660_access (struct vnop_access_args *);
int cd9660_getattr (struct vnop_getattr_args *);
int cd9660_read (struct vnop_read_args *);
int cd9660_xa_read (struct vnop_read_args *);
int cd9660_ioctl (struct vnop_ioctl_args *);
int cd9660_select (struct vnop_select_args *);
int cd9660_mmap (struct vnop_mmap_args *);
int cd9660_readdir (struct vnop_readdir_args *);
int cd9660_readlink (struct vnop_readlink_args *);
int cd9660_inactive (struct vnop_inactive_args *);
int cd9660_reclaim (struct vnop_reclaim_args *);
int cd9660_strategy (struct vnop_strategy_args *);
int cd9660_pathconf (struct vnop_pathconf_args *);
int cd9660_enotsupp(void);
int cd9660_pagein(struct vnop_pagein_args *ap);
int cd9660_remove(struct vnop_remove_args *ap);
int cd9660_rmdir(struct vnop_rmdir_args *ap);

__private_extern__ void cd9660_xa_init(struct iso_node *ip,
				       struct iso_directory_record *isodir);
__private_extern__ int cd9660_blkatoff (vnode_t, off_t, char **, buf_t *);

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