extattr.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 * $FreeBSD: stable/11/sys/sys/extattr.h 330897 2018-03-14 03:19:51Z eadler $
31 */
32/*
33 * Developed by the TrustedBSD Project.
34 * Support for extended filesystem attributes.
35 */
36
37#ifndef _SYS_EXTATTR_H_
38#define	_SYS_EXTATTR_H_
39
40/*
41 * Defined name spaces for extended attributes.  Numeric constants are passed
42 * via system calls, but a user-friendly string is also defined.
43 */
44#define	EXTATTR_NAMESPACE_EMPTY		0x00000000
45#define	EXTATTR_NAMESPACE_EMPTY_STRING	"empty"
46#define	EXTATTR_NAMESPACE_USER		0x00000001
47#define	EXTATTR_NAMESPACE_USER_STRING	"user"
48#define	EXTATTR_NAMESPACE_SYSTEM	0x00000002
49#define	EXTATTR_NAMESPACE_SYSTEM_STRING	"system"
50
51/*
52 * The following macro is designed to initialize an array that maps
53 * extended-attribute namespace values to their names, e.g.:
54 *
55 * char *extattr_namespace_names[] = EXTATTR_NAMESPACE_NAMES;
56 */
57#define EXTATTR_NAMESPACE_NAMES { \
58	EXTATTR_NAMESPACE_EMPTY_STRING, \
59	EXTATTR_NAMESPACE_USER_STRING, \
60	EXTATTR_NAMESPACE_SYSTEM_STRING }
61
62#ifdef _KERNEL
63#include <sys/types.h>
64
65#define	EXTATTR_MAXNAMELEN	NAME_MAX
66struct thread;
67struct ucred;
68struct vnode;
69int	extattr_check_cred(struct vnode *vp, int attrnamespace,
70	    struct ucred *cred, struct thread *td, accmode_t accmode);
71
72#else
73#include <sys/cdefs.h>
74
75struct iovec;
76
77__BEGIN_DECLS
78int	extattrctl(const char *_path, int _cmd, const char *_filename,
79	    int _attrnamespace, const char *_attrname);
80int	extattr_delete_fd(int _fd, int _attrnamespace, const char *_attrname);
81int	extattr_delete_file(const char *_path, int _attrnamespace,
82	    const char *_attrname);
83int	extattr_delete_link(const char *_path, int _attrnamespace,
84	    const char *_attrname);
85ssize_t	extattr_get_fd(int _fd, int _attrnamespace, const char *_attrname,
86	    void *_data, size_t _nbytes);
87ssize_t	extattr_get_file(const char *_path, int _attrnamespace,
88	    const char *_attrname, void *_data, size_t _nbytes);
89ssize_t	extattr_get_link(const char *_path, int _attrnamespace,
90	    const char *_attrname, void *_data, size_t _nbytes);
91ssize_t	extattr_list_fd(int _fd, int _attrnamespace, void *_data,
92	    size_t _nbytes);
93ssize_t	extattr_list_file(const char *_path, int _attrnamespace, void *_data,
94	    size_t _nbytes);
95ssize_t	extattr_list_link(const char *_path, int _attrnamespace, void *_data,
96	    size_t _nbytes);
97ssize_t	extattr_set_fd(int _fd, int _attrnamespace, const char *_attrname,
98	    const void *_data, size_t _nbytes);
99ssize_t	extattr_set_file(const char *_path, int _attrnamespace,
100	    const char *_attrname, const void *_data, size_t _nbytes);
101ssize_t	extattr_set_link(const char *_path, int _attrnamespace,
102	    const char *_attrname, const void *_data, size_t _nbytes);
103__END_DECLS
104
105#endif /* !_KERNEL */
106#endif /* !_SYS_EXTATTR_H_ */
107