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