xref: /xnu-11215.41.3/osfmk/mach/doubleagent_types.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2023 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 _DOUBLEAGENT_TYPES_H_
30 #define _DOUBLEAGENT_TYPES_H_
31 
32 #define DA_XATTR_MAXNAMELEN 127 // Must match the 'XATTR_MAXNAMELEN' in <sys/xattr.h>.
33 #define DA_XATTR_FINDERINFO_NAME "com.apple.FinderInfo" // Copy of XATTR_FINDERINFO_NAME in <sys/xattr.h>.
34 #define DA_XATTR_RESOURCEFORK_NAME "com.apple.ResourceFork" // Copy of DA_XATTR_RESOURCEFORK_NAME in <sys/xattr.h>.
35 
36 #define MAX_NUM_OF_XATTRS 256
37 #define LISTXATTR_RESULT_MAX_NAMES_LEN (sizeof(DA_XATTR_RESOURCEFORK_NAME) + sizeof(DA_XATTR_FINDERINFO_NAME) + (MAX_NUM_OF_XATTRS * ((DA_XATTR_MAXNAMELEN + 1))))
38 #define LISTXATTR_RESULT_MAX_HINTS_LEN (MAX_NUM_OF_XATTRS * 2 * sizeof(uint32_t)) // hint = offset + length (per xattr).
39 #define LISTXATTR_RESULT_MAX_SIZE (LISTXATTR_RESULT_MAX_NAMES_LEN + LISTXATTR_RESULT_MAX_HINTS_LEN)
40 
41 typedef char xattrname[DA_XATTR_MAXNAMELEN + 1];
42 
43 typedef struct list_xattrs_result {
44 	/* header */
45 	uint64_t finderInfoOffset; // =0 if not present
46 	uint64_t resourceForkOffset; // =0 if not present
47 	uint64_t resourceForkLength; // Don't care if resourceForkOffset = 0
48 	uint64_t numOfXattrs;
49 
50 	/* data:
51 	 * (1) names (separated with '\0')
52 	 * (2) ranges: offset + lengths (for caching)
53 	 * (dataLength = namesLength + rangesLength)
54 	 */
55 	uint64_t dataLength;
56 	uint64_t namesLength;
57 	uint64_t rangesLength;
58 	uint8_t  data[LISTXATTR_RESULT_MAX_SIZE];
59 } listxattrs_result_t;
60 
61 #endif /* _DOUBLEAGENT_TYPES_H_ */
62