[apple/xnu.git] / bsd / hfs / hfs_attrlist.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_ATTRLIST_H_
#define _HFS_ATTRLIST_H_

#include <sys/appleapiopts.h>

#ifdef KERNEL
#ifdef __APPLE_API_PRIVATE
#include <sys/attr.h>
#include <sys/vnode.h>

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


struct attrblock {
	struct attrlist * ab_attrlist;
	void **		  ab_attrbufpp;
	void **		  ab_varbufpp;
	int		  ab_flags;
	int		  ab_blocksize;
	vfs_context_t	  ab_context;
};

/* 
 * The following define the attributes that HFS supports:
 */

#define HFS_ATTR_CMN_VALID				\
	(ATTR_CMN_NAME | ATTR_CMN_DEVID	|		\
	 ATTR_CMN_FSID | ATTR_CMN_OBJTYPE |		\
	 ATTR_CMN_OBJTAG | ATTR_CMN_OBJID |		\
	 ATTR_CMN_OBJPERMANENTID | ATTR_CMN_PAROBJID |	\
	 ATTR_CMN_SCRIPT | ATTR_CMN_CRTIME |		\
	 ATTR_CMN_MODTIME | ATTR_CMN_CHGTIME |		\
	 ATTR_CMN_ACCTIME | ATTR_CMN_BKUPTIME |		\
	 ATTR_CMN_FNDRINFO |ATTR_CMN_OWNERID |		\
	 ATTR_CMN_GRPID | ATTR_CMN_ACCESSMASK |		\
	 ATTR_CMN_FLAGS | ATTR_CMN_USERACCESS |		\
	 ATTR_CMN_EXTENDED_SECURITY | ATTR_CMN_UUID |	\
	 ATTR_CMN_GRPUUID | ATTR_CMN_FILEID |		\
	 ATTR_CMN_PARENTID )

#define HFS_ATTR_DIR_VALID				\
	(ATTR_DIR_LINKCOUNT | ATTR_DIR_ENTRYCOUNT | ATTR_DIR_MOUNTSTATUS)

#define HFS_ATTR_FILE_VALID				  \
	(ATTR_FILE_LINKCOUNT |ATTR_FILE_TOTALSIZE |	  \
	 ATTR_FILE_ALLOCSIZE | ATTR_FILE_IOBLOCKSIZE |	  \
	 ATTR_FILE_CLUMPSIZE | ATTR_FILE_DEVTYPE |	  \
	 ATTR_FILE_FORKCOUNT | ATTR_FILE_FORKLIST |	  \
	 ATTR_FILE_DATALENGTH | ATTR_FILE_DATAALLOCSIZE | \
	 ATTR_FILE_RSRCLENGTH | ATTR_FILE_RSRCALLOCSIZE)


extern int hfs_attrblksize(struct attrlist *attrlist);

extern unsigned long DerivePermissionSummary(uid_t obj_uid, gid_t obj_gid,
			mode_t obj_mode, struct mount *mp,
			kauth_cred_t cred, struct proc *p);

extern void hfs_packattrblk(struct attrblock *abp, struct hfsmount *hfsmp,
		struct vnode *vp, struct cat_desc *descp, struct cat_attr *attrp,
		struct cat_fork *datafork, struct cat_fork *rsrcfork, struct proc *p);

#endif /* __APPLE_API_PRIVATE */
#endif /* KERNEL */
#endif /* ! _HFS_ATTRLIST_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_ATTRLIST_H_
	29	#define _HFS_ATTRLIST_H_
	30
	31	#include <sys/appleapiopts.h>
	32
	33	#ifdef KERNEL
	34	#ifdef __APPLE_API_PRIVATE
	35	#include <sys/attr.h>
	36	#include <sys/vnode.h>
	37
	38	#include <hfs/hfs_catalog.h>
	39	#include <hfs/hfs_cnode.h>
	40
	41
	42	struct attrblock {
	43	struct attrlist * ab_attrlist;
	44	void ** ab_attrbufpp;
	45	void ** ab_varbufpp;
	46	int ab_flags;
	47	int ab_blocksize;
2d21ac55	48	vfs_context_t ab_context;
9bccf70c A	49	};
9bccf70c A	50
2d21ac55 A	51	/*
	52	* The following define the attributes that HFS supports:
	53	*/
9bccf70c	54
2d21ac55 A	55	#define HFS_ATTR_CMN_VALID \
	56	(ATTR_CMN_NAME \| ATTR_CMN_DEVID \| \
	57	ATTR_CMN_FSID \| ATTR_CMN_OBJTYPE \| \
	58	ATTR_CMN_OBJTAG \| ATTR_CMN_OBJID \| \
	59	ATTR_CMN_OBJPERMANENTID \| ATTR_CMN_PAROBJID \| \
	60	ATTR_CMN_SCRIPT \| ATTR_CMN_CRTIME \| \
	61	ATTR_CMN_MODTIME \| ATTR_CMN_CHGTIME \| \
	62	ATTR_CMN_ACCTIME \| ATTR_CMN_BKUPTIME \| \
	63	ATTR_CMN_FNDRINFO \|ATTR_CMN_OWNERID \| \
	64	ATTR_CMN_GRPID \| ATTR_CMN_ACCESSMASK \| \
	65	ATTR_CMN_FLAGS \| ATTR_CMN_USERACCESS \| \
	66	ATTR_CMN_EXTENDED_SECURITY \| ATTR_CMN_UUID \| \
	67	ATTR_CMN_GRPUUID \| ATTR_CMN_FILEID \| \
	68	ATTR_CMN_PARENTID )
9bccf70c	69
2d21ac55 A	70	#define HFS_ATTR_DIR_VALID \
2d21ac55 A	71	(ATTR_DIR_LINKCOUNT \| ATTR_DIR_ENTRYCOUNT \| ATTR_DIR_MOUNTSTATUS)
9bccf70c	72
2d21ac55 A	73	#define HFS_ATTR_FILE_VALID \
	74	(ATTR_FILE_LINKCOUNT \|ATTR_FILE_TOTALSIZE \| \
	75	ATTR_FILE_ALLOCSIZE \| ATTR_FILE_IOBLOCKSIZE \| \
	76	ATTR_FILE_CLUMPSIZE \| ATTR_FILE_DEVTYPE \| \
	77	ATTR_FILE_FORKCOUNT \| ATTR_FILE_FORKLIST \| \
	78	ATTR_FILE_DATALENGTH \| ATTR_FILE_DATAALLOCSIZE \| \
	79	ATTR_FILE_RSRCLENGTH \| ATTR_FILE_RSRCALLOCSIZE)
9bccf70c A	80
	81
	82	extern int hfs_attrblksize(struct attrlist *attrlist);
	83
	84	extern unsigned long DerivePermissionSummary(uid_t obj_uid, gid_t obj_gid,
	85	mode_t obj_mode, struct mount *mp,
2d21ac55	86	kauth_cred_t cred, struct proc *p);
9bccf70c A	87
	88	extern void hfs_packattrblk(struct attrblock abp, struct hfsmount hfsmp,
	89	struct vnode vp, struct cat_desc descp, struct cat_attr *attrp,
55e303ae	90	struct cat_fork datafork, struct cat_fork rsrcfork, struct proc *p);
9bccf70c A	91
	92	#endif /* __APPLE_API_PRIVATE */
	93	#endif /* KERNEL */
	94	#endif /* ! _HFS_ATTRLIST_H_ */