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

/*
 * Copyright (c) 2008-2017 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_

#ifndef KERNEL

#include <machine/_types.h>
#include <sys/_types/_ssize_t.h>
#include <sys/_types/_size_t.h>
#include <sys/_types/_fsid_t.h>
#include <_types/_uint64_t.h>
#include <Availability.h>

#ifdef PRIVATE
/*
 * These are only included for compatibility with previous header
 */
#include <sys/types.h>
#include <sys/mount.h>
#ifdef __APPLE_API_PRIVATE
#include <sys/syscall.h>
#include <unistd.h>
#endif  /* __APPLE_API_PRIVATE */
#endif /* PRIVATE */

__BEGIN_DECLS

/*
 * Obtain the full pathname of a file system object by id.
 */
ssize_t fsgetpath(char *, size_t, fsid_t *, uint64_t) __OSX_AVAILABLE(10.13) __IOS_AVAILABLE(11.0) __TVOS_AVAILABLE(11.0) __WATCHOS_AVAILABLE(4.0);

#ifdef PRIVATE
#include <sys/_types/_fsobj_id_t.h>

#ifdef __APPLE_API_PRIVATE


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

#endif /* __APPLE_API_PRIVATE */
#endif /* PRIVATE */

__END_DECLS

#endif /* KERNEL */

#endif /* !_FSGETPATH_H_ */
Commit	Line	Data
9bccf70c	1	/*
5ba3f43e	2	* Copyright (c) 2008-2017 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
5ba3f43e A	32	#ifndef KERNEL
	33
	34	#include <machine/_types.h>
	35	#include <sys/_types/_ssize_t.h>
	36	#include <sys/_types/_size_t.h>
	37	#include <sys/_types/_fsid_t.h>
	38	#include <_types/_uint64_t.h>
	39	#include <Availability.h>
	40
	41	#ifdef PRIVATE
	42	/*
	43	* These are only included for compatibility with previous header
	44	*/
b0d623f7 A	45	#include <sys/types.h>
b0d623f7 A	46	#include <sys/mount.h>
b0d623f7	47	#ifdef __APPLE_API_PRIVATE
b0d623f7 A	48	#include <sys/syscall.h>
b0d623f7 A	49	#include <unistd.h>
5ba3f43e A	50	#endif /* __APPLE_API_PRIVATE */
	51	#endif /* PRIVATE */
	52
	53	__BEGIN_DECLS
b0d623f7 A	54
	55	/*
	56	* Obtain the full pathname of a file system object by id.
b0d623f7	57	*/
5ba3f43e A	58	ssize_t fsgetpath(char , size_t, fsid_t , uint64_t) __OSX_AVAILABLE(10.13) __IOS_AVAILABLE(11.0) __TVOS_AVAILABLE(11.0) __WATCHOS_AVAILABLE(4.0);
	59
	60	#ifdef PRIVATE
	61	#include <sys/_types/_fsobj_id_t.h>
	62
	63	#ifdef __APPLE_API_PRIVATE
	64
9bccf70c	65
fe8ab488 A	66	/*
	67	* openbyid_np: open a file given a file system id and a file system object id
	68	*
	69	* fsid : value corresponding to getattlist ATTR_CMN_FSID attribute, or
	70	* value of stat's st.st_dev ; set fsid = {st.st_dev, 0}
	71	*
	72	* objid: value (link id/node id) corresponding to getattlist ATTR_CMN_OBJID
	73	* attribute , or
	74	* value of stat's st.st_ino (node id); set objid = st.st_ino
	75	*
	76	* For hfs the value of getattlist ATTR_CMN_FSID is a link id which uniquely identifies a
	77	* parent in the case of hard linked files; this allows unique path access validation.
	78	* Not all file systems support getattrlist ATTR_CMN_OBJID (link id).
	79	* A node id does not uniquely identify a parent in the case of hard linked files and may
	80	* resolve to a path for which access validation can fail.
	81	*/
	82	int openbyid_np(fsid_t* fsid, fsobj_id_t* objid, int flags);
	83
5ba3f43e A	84	#endif /* __APPLE_API_PRIVATE */
	85	#endif /* PRIVATE */
	86
9bccf70c	87	__END_DECLS
b0d623f7	88
5ba3f43e	89	#endif /* KERNEL */
b0d623f7 A	90
b0d623f7 A	91	#endif /* !_FSGETPATH_H_ */