]> git.saurik.com Git - apple/xnu.git/blame_incremental - bsd/sys/xattr.h
xnu-1699.26.8.tar.gz
[apple/xnu.git] / bsd / sys / xattr.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2004-2010 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 _SYS_XATTR_H_
30#define _SYS_XATTR_H_
31
32#include <sys/types.h>
33
34/* Options for pathname based xattr calls */
35#define XATTR_NOFOLLOW 0x0001 /* Don't follow symbolic links */
36
37/* Options for setxattr calls */
38#define XATTR_CREATE 0x0002 /* set the value, fail if attr already exists */
39#define XATTR_REPLACE 0x0004 /* set the value, fail if attr does not exist */
40
41/* Set this to bypass authorization checking (eg. if doing auth-related work) */
42#define XATTR_NOSECURITY 0x0008
43
44/* Set this to bypass the default extended attribute file (dot-underscore file) */
45#define XATTR_NODEFAULT 0x0010
46
47/* option for f/getxattr() and f/listxattr() to expose the HFS Compression extended attributes */
48#define XATTR_SHOWCOMPRESSION 0x0020
49
50#define XATTR_MAXNAMELEN 127
51
52#define XATTR_FINDERINFO_NAME "com.apple.FinderInfo"
53
54#define XATTR_RESOURCEFORK_NAME "com.apple.ResourceFork"
55
56
57#ifdef KERNEL
58__BEGIN_DECLS
59int xattr_protected(const char *);
60int xattr_validatename(const char *);
61
62/* Maximum extended attribute size supported by VFS */
63#define XATTR_MAXSIZE (64 * 1024 * 1024)
64
65#ifdef PRIVATE
66/* Maximum extended attribute size in an Apple Double file */
67#define AD_XATTR_MAXSIZE (128 * 1024)
68
69/* Number of bits used to represent the maximum size of
70 * extended attribute stored in an Apple Double file.
71 */
72#define AD_XATTR_SIZE_BITS 18
73#endif /* PRIVATE */
74
75__END_DECLS
76#endif /* KERNEL */
77
78#ifndef KERNEL
79__BEGIN_DECLS
80
81ssize_t getxattr(const char *path, const char *name, void *value, size_t size, u_int32_t position, int options);
82
83ssize_t fgetxattr(int fd, const char *name, void *value, size_t size, u_int32_t position, int options);
84
85int setxattr(const char *path, const char *name, const void *value, size_t size, u_int32_t position, int options);
86
87int fsetxattr(int fd, const char *name, const void *value, size_t size, u_int32_t position, int options);
88
89int removexattr(const char *path, const char *name, int options);
90
91int fremovexattr(int fd, const char *name, int options);
92
93ssize_t listxattr(const char *path, char *namebuff, size_t size, int options);
94
95ssize_t flistxattr(int fd, char *namebuff, size_t size, int options);
96
97__END_DECLS
98#endif /* KERNEL */
99
100#endif /* _SYS_XATTR_H_ */