[apple/xnu.git] / bsd / sys / fsgetpath.h

/*
 * Copyright (c) 2008 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	_FSGETPATH_H_
#define _FSGETPATH_H_

#include <sys/types.h>
#include <sys/mount.h>

#ifdef __APPLE_API_PRIVATE

#ifndef KERNEL
__BEGIN_DECLS

#include <sys/syscall.h>
#include <unistd.h>

/*
 * Obtain the full pathname of a file system object by id.
 *
 * This is a private SPI used by the File Manager.
 *
 * ssize_t fsgetpath_np(char *restrict buf, size_t bufsize, fsid_t fsid, uint64_t objid);
 */
#define	fsgetpath(buf, bufsize, fsid, objid)  \
	(ssize_t)syscall(SYS_fsgetpath, buf, (size_t)bufsize, fsid, (uint64_t)objid)

/*
 * openbyid_np: open a file given a file system id and a file system object id 
 * 
 * fsid :	value corresponding to getattlist ATTR_CMN_FSID attribute, or
 *			value of stat's st.st_dev ; set fsid = {st.st_dev, 0} 
 *
 * objid: value (link id/node id) corresponding to getattlist ATTR_CMN_OBJID 
 *		  attribute , or
 *		  value of stat's st.st_ino (node id); set objid =  st.st_ino
 *
 * For hfs the value of getattlist ATTR_CMN_FSID is a link id which uniquely identifies a
 * parent in the case of hard linked files; this allows unique path access validation.
 * Not all file systems support getattrlist ATTR_CMN_OBJID (link id).
 * A node id does not uniquely identify a parent in the case of hard linked files and may 
 * resolve to a path for which access validation can fail.
 */
int openbyid_np(fsid_t* fsid, fsobj_id_t* objid, int flags);

__END_DECLS
#endif /* KERNEL */

#endif /* __APPLE_API_PRIVATE */

#endif /* !_FSGETPATH_H_ */
Commit	Line	Data
9bccf70c	1	/*
b0d623f7	2	* Copyright (c) 2008 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.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
8f6c56a5 A	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
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	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	27	*/
9bccf70c	28
b0d623f7 A	29	#ifndef _FSGETPATH_H_
	30	#define _FSGETPATH_H_
	31
	32	#include <sys/types.h>
	33	#include <sys/mount.h>
9bccf70c	34
b0d623f7	35	#ifdef __APPLE_API_PRIVATE
9bccf70c	36
b0d623f7	37	#ifndef KERNEL
9bccf70c A	38	__BEGIN_DECLS
9bccf70c A	39
b0d623f7 A	40	#include <sys/syscall.h>
	41	#include <unistd.h>
	42
	43	/*
	44	* Obtain the full pathname of a file system object by id.
	45	*
	46	* This is a private SPI used by the File Manager.
	47	*
	48	* ssize_t fsgetpath_np(char *restrict buf, size_t bufsize, fsid_t fsid, uint64_t objid);
	49	*/
	50	#define fsgetpath(buf, bufsize, fsid, objid) \
	51	(ssize_t)syscall(SYS_fsgetpath, buf, (size_t)bufsize, fsid, (uint64_t)objid)
9bccf70c	52
fe8ab488 A	53	/*
	54	* openbyid_np: open a file given a file system id and a file system object id
	55	*
	56	* fsid : value corresponding to getattlist ATTR_CMN_FSID attribute, or
	57	* value of stat's st.st_dev ; set fsid = {st.st_dev, 0}
	58	*
	59	* objid: value (link id/node id) corresponding to getattlist ATTR_CMN_OBJID
	60	* attribute , or
	61	* value of stat's st.st_ino (node id); set objid = st.st_ino
	62	*
	63	* For hfs the value of getattlist ATTR_CMN_FSID is a link id which uniquely identifies a
	64	* parent in the case of hard linked files; this allows unique path access validation.
	65	* Not all file systems support getattrlist ATTR_CMN_OBJID (link id).
	66	* A node id does not uniquely identify a parent in the case of hard linked files and may
	67	* resolve to a path for which access validation can fail.
	68	*/
	69	int openbyid_np(fsid_t* fsid, fsobj_id_t* objid, int flags);
	70
9bccf70c	71	__END_DECLS
b0d623f7 A	72	#endif /* KERNEL */
	73
	74	#endif /* __APPLE_API_PRIVATE */
	75
	76	#endif /* !_FSGETPATH_H_ */