xref: /dragonfly/sys/sys/extattr.h (revision 3170ffd7)
1 /*-
2  * Copyright (c) 1999-2001 Robert N. M. Watson
3  * All rights reserved.
4  *
5  * This software was developed by Robert Watson for the TrustedBSD Project.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD: src/sys/sys/extattr.h,v 1.19 2008/10/28 13:44:11 trasz Exp $
29  */
30 /*
31  * Developed by the TrustedBSD Project.
32  * Support for extended filesystem attributes.
33  */
34 
35 #ifndef _SYS_EXTATTR_H_
36 #define	_SYS_EXTATTR_H_
37 
38 /*
39  * Defined name spaces for extended attributes.  Numeric constants are passed
40  * via system calls, but a user-friendly string is also defined.
41  */
42 #define	EXTATTR_NAMESPACE_EMPTY		0x00000000
43 #define	EXTATTR_NAMESPACE_EMPTY_STRING	"empty"
44 #define	EXTATTR_NAMESPACE_USER		0x00000001
45 #define	EXTATTR_NAMESPACE_USER_STRING	"user"
46 #define	EXTATTR_NAMESPACE_SYSTEM	0x00000002
47 #define	EXTATTR_NAMESPACE_SYSTEM_STRING	"system"
48 
49 /*
50  * The following macro is designed to initialize an array that maps
51  * extended-attribute namespace values to their names, e.g.:
52  *
53  * char *extattr_namespace_names[] = EXTATTR_NAMESPACE_NAMES;
54  */
55 #define EXTATTR_NAMESPACE_NAMES { \
56 	EXTATTR_NAMESPACE_EMPTY_STRING, \
57 	EXTATTR_NAMESPACE_USER_STRING, \
58 	EXTATTR_NAMESPACE_SYSTEM_STRING }
59 
60 #ifdef _KERNEL
61 
62 #define	EXTATTR_MAXNAMELEN	NAME_MAX
63 struct thread;
64 struct ucred;
65 struct vnode;
66 
67 #else
68 #include <sys/cdefs.h>
69 
70 struct iovec;
71 
72 __BEGIN_DECLS
73 int	extattrctl(const char *_path, int _cmd, const char *_filename,
74 	    int _attrnamespace, const char *_attrname);
75 int	extattr_delete_fd(int _fd, int _attrnamespace, const char *_attrname);
76 int	extattr_delete_file(const char *_path, int _attrnamespace,
77 	    const char *_attrname);
78 int	extattr_delete_link(const char *_path, int _attrnamespace,
79 	    const char *_attrname);
80 ssize_t	extattr_get_fd(int _fd, int _attrnamespace, const char *_attrname,
81 	    void *_data, size_t _nbytes);
82 ssize_t	extattr_get_file(const char *_path, int _attrnamespace,
83 	    const char *_attrname, void *_data, size_t _nbytes);
84 ssize_t	extattr_get_link(const char *_path, int _attrnamespace,
85 	    const char *_attrname, void *_data, size_t _nbytes);
86 ssize_t	extattr_list_fd(int _fd, int _attrnamespace, void *_data,
87 	    size_t _nbytes);
88 ssize_t	extattr_list_file(const char *_path, int _attrnamespace, void *_data,
89 	    size_t _nbytes);
90 ssize_t	extattr_list_link(const char *_path, int _attrnamespace, void *_data,
91 	    size_t _nbytes);
92 int	extattr_set_fd(int _fd, int _attrnamespace, const char *_attrname,
93 	    const void *_data, size_t _nbytes);
94 int	extattr_set_file(const char *_path, int _attrnamespace,
95 	    const char *_attrname, const void *_data, size_t _nbytes);
96 int	extattr_set_link(const char *_path, int _attrnamespace,
97 	    const char *_attrname, const void *_data, size_t _nbytes);
98 __END_DECLS
99 
100 #endif /* !_KERNEL */
101 #endif /* !_SYS_EXTATTR_H_ */
102