1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 1999-2001 Robert N. M. Watson
5 * All rights reserved.
6 *
7 * This software was developed by Robert Watson for the TrustedBSD Project.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
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#define EXTATTR_MAXNAMELEN NAME_MAX
61
62#ifdef _KERNEL
63#include <sys/types.h>
64
65struct thread;
66struct ucred;
67struct vnode;
68int extattr_check_cred(struct vnode *vp, int attrnamespace,
69 struct ucred *cred, struct thread *td, accmode_t accmode);
70
71#else
72#include <sys/cdefs.h>
73
74struct iovec;
75
76__BEGIN_DECLS
77int extattrctl(const char *_path, int _cmd, const char *_filename,
78 int _attrnamespace, const char *_attrname);
79int extattr_delete_fd(int _fd, int _attrnamespace, const char *_attrname);
80int extattr_delete_file(const char *_path, int _attrnamespace,
81 const char *_attrname);
82int extattr_delete_link(const char *_path, int _attrnamespace,
83 const char *_attrname);
84ssize_t extattr_get_fd(int _fd, int _attrnamespace, const char *_attrname,
85 void *_data, size_t _nbytes);
86ssize_t extattr_get_file(const char *_path, int _attrnamespace,
87 const char *_attrname, void *_data, size_t _nbytes);
88ssize_t extattr_get_link(const char *_path, int _attrnamespace,
89 const char *_attrname, void *_data, size_t _nbytes);
90ssize_t extattr_list_fd(int _fd, int _attrnamespace, void *_data,
91 size_t _nbytes);
92ssize_t extattr_list_file(const char *_path, int _attrnamespace, void *_data,
93 size_t _nbytes);
94ssize_t extattr_list_link(const char *_path, int _attrnamespace, void *_data,
95 size_t _nbytes);
96ssize_t extattr_set_fd(int _fd, int _attrnamespace, const char *_attrname,
97 const void *_data, size_t _nbytes);
98ssize_t extattr_set_file(const char *_path, int _attrnamespace,
99 const char *_attrname, const void *_data, size_t _nbytes);
100ssize_t extattr_set_link(const char *_path, int _attrnamespace,
101 const char *_attrname, const void *_data, size_t _nbytes);
102__END_DECLS
103
104#endif /* !_KERNEL */
105#endif /* !_SYS_EXTATTR_H_ */