xref: /xnu-11417.140.69/bsd/sys/fsgetpath_private.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1*43a90889SApple OSS Distributions /*
2*43a90889SApple OSS Distributions  * Copyright (c) 2008-2017, 2023 Apple Inc. All rights reserved.
3*43a90889SApple OSS Distributions  *
4*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*43a90889SApple OSS Distributions  *
6*43a90889SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*43a90889SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*43a90889SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*43a90889SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*43a90889SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*43a90889SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*43a90889SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*43a90889SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*43a90889SApple OSS Distributions  *
15*43a90889SApple OSS Distributions  * Please obtain a copy of the License at
16*43a90889SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*43a90889SApple OSS Distributions  *
18*43a90889SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*43a90889SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*43a90889SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*43a90889SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*43a90889SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*43a90889SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*43a90889SApple OSS Distributions  * limitations under the License.
25*43a90889SApple OSS Distributions  *
26*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*43a90889SApple OSS Distributions  */
28*43a90889SApple OSS Distributions 
29*43a90889SApple OSS Distributions #ifndef _FSGETPATH_PRIVATE_H_
30*43a90889SApple OSS Distributions #define _FSGETPATH_PRIVATE_H_
31*43a90889SApple OSS Distributions 
32*43a90889SApple OSS Distributions #ifndef KERNEL
33*43a90889SApple OSS Distributions 
34*43a90889SApple OSS Distributions #include <sys/appleapiopts.h>
35*43a90889SApple OSS Distributions #include <sys/cdefs.h>
36*43a90889SApple OSS Distributions #include <sys/_types/_ssize_t.h>
37*43a90889SApple OSS Distributions #include <sys/_types/_size_t.h>
38*43a90889SApple OSS Distributions #include <sys/_types/_fsid_t.h>
39*43a90889SApple OSS Distributions #include <_types/_uint32_t.h>
40*43a90889SApple OSS Distributions #include <_types/_uint64_t.h>
41*43a90889SApple OSS Distributions #include <Availability.h>
42*43a90889SApple OSS Distributions 
43*43a90889SApple OSS Distributions /*
44*43a90889SApple OSS Distributions  * These are only included for compatibility with previous header
45*43a90889SApple OSS Distributions  */
46*43a90889SApple OSS Distributions #include <sys/types.h>
47*43a90889SApple OSS Distributions #include <sys/mount.h>
48*43a90889SApple OSS Distributions #ifdef __APPLE_API_PRIVATE
49*43a90889SApple OSS Distributions #include <sys/attr.h>
50*43a90889SApple OSS Distributions #include <sys/syscall.h>
51*43a90889SApple OSS Distributions #include <unistd.h>
52*43a90889SApple OSS Distributions #endif  /* __APPLE_API_PRIVATE */
53*43a90889SApple OSS Distributions 
54*43a90889SApple OSS Distributions #include <sys/attr_private.h>
55*43a90889SApple OSS Distributions #include <sys/_types/_fsobj_id_t.h>
56*43a90889SApple OSS Distributions 
57*43a90889SApple OSS Distributions __BEGIN_DECLS
58*43a90889SApple OSS Distributions 
59*43a90889SApple OSS Distributions #ifdef __APPLE_API_PRIVATE
60*43a90889SApple OSS Distributions 
61*43a90889SApple OSS Distributions 
62*43a90889SApple OSS Distributions /*
63*43a90889SApple OSS Distributions  * openbyid_np: open a file given a file system id and a file system object id
64*43a90889SApple OSS Distributions  *
65*43a90889SApple OSS Distributions  * fsid :	value corresponding to getattlist ATTR_CMN_FSID attribute, or
66*43a90889SApple OSS Distributions  *			value of stat's st.st_dev ; set fsid = {st.st_dev, 0}
67*43a90889SApple OSS Distributions  *
68*43a90889SApple OSS Distributions  * objid: value (link id/node id) corresponding to getattlist ATTR_CMN_OBJID
69*43a90889SApple OSS Distributions  *		  attribute , or
70*43a90889SApple OSS Distributions  *		  value of stat's st.st_ino (node id); set objid =  st.st_ino
71*43a90889SApple OSS Distributions  *
72*43a90889SApple OSS Distributions  * For hfs the value of getattlist ATTR_CMN_FSID is a link id which uniquely identifies a
73*43a90889SApple OSS Distributions  * parent in the case of hard linked files; this allows unique path access validation.
74*43a90889SApple OSS Distributions  * Not all file systems support getattrlist ATTR_CMN_OBJID (link id).
75*43a90889SApple OSS Distributions  * A node id does not uniquely identify a parent in the case of hard linked files and may
76*43a90889SApple OSS Distributions  * resolve to a path for which access validation can fail.
77*43a90889SApple OSS Distributions  */
78*43a90889SApple OSS Distributions int openbyid_np(fsid_t* fsid, fsobj_id_t* objid, int flags);
79*43a90889SApple OSS Distributions 
80*43a90889SApple OSS Distributions ssize_t fsgetpath_ext(char *, size_t, fsid_t *, uint64_t, uint32_t) __OSX_AVAILABLE(10.15) __IOS_AVAILABLE(13.0) __TVOS_AVAILABLE(13.0) __WATCHOS_AVAILABLE(6.0);
81*43a90889SApple OSS Distributions 
82*43a90889SApple OSS Distributions #endif /* __APPLE_API_PRIVATE */
83*43a90889SApple OSS Distributions 
84*43a90889SApple OSS Distributions __END_DECLS
85*43a90889SApple OSS Distributions 
86*43a90889SApple OSS Distributions #endif /* KERNEL */
87*43a90889SApple OSS Distributions 
88*43a90889SApple OSS Distributions #endif /* !_FSGETPATH_PRIVATE_H_ */
89