1/*
2 * Copyright (c) 2008-2017 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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.
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,
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.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29#ifndef _FSGETPATH_H_
30#define _FSGETPATH_H_
31
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 */
45#include <sys/types.h>
46#include <sys/mount.h>
47#ifdef __APPLE_API_PRIVATE
48#include <sys/attr.h>
49#include <sys/syscall.h>
50#include <unistd.h>
51#endif /* __APPLE_API_PRIVATE */
52#endif /* PRIVATE */
53
54__BEGIN_DECLS
55
56/*
57 * Obtain the full pathname of a file system object by id.
58 */
59ssize_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);
60
61#ifdef PRIVATE
62#include <sys/_types/_fsobj_id_t.h>
63
64#ifndef FSOPT_NOFIRMLINKPATH /* also in attr.h */
65#define FSOPT_NOFIRMLINKPATH 0x00000080
66#endif
67
68#ifndef FSOPT_ISREALFSID /* also in attr.h */
69#ifdef FSOPT_RETURN_REALDEV
70#define FSOPT_ISREALFSID FSOPT_RETURN_REALDEV
71#else
72#define FSOPT_ISREALFSID 0x00000200
73#endif
74#endif /* FSOPT_ISREALFSID */
75
76#ifdef __APPLE_API_PRIVATE
77
78
79/*
80 * openbyid_np: open a file given a file system id and a file system object id
81 *
82 * fsid : value corresponding to getattlist ATTR_CMN_FSID attribute, or
83 * value of stat's st.st_dev ; set fsid = {st.st_dev, 0}
84 *
85 * objid: value (link id/node id) corresponding to getattlist ATTR_CMN_OBJID
86 * attribute , or
87 * value of stat's st.st_ino (node id); set objid = st.st_ino
88 *
89 * For hfs the value of getattlist ATTR_CMN_FSID is a link id which uniquely identifies a
90 * parent in the case of hard linked files; this allows unique path access validation.
91 * Not all file systems support getattrlist ATTR_CMN_OBJID (link id).
92 * A node id does not uniquely identify a parent in the case of hard linked files and may
93 * resolve to a path for which access validation can fail.
94 */
95int openbyid_np(fsid_t* fsid, fsobj_id_t* objid, int flags);
96
97ssize_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);
98
99#endif /* __APPLE_API_PRIVATE */
100#endif /* PRIVATE */
101
102__END_DECLS
103
104#endif /* KERNEL */
105
106#endif /* !_FSGETPATH_H_ */
107