master
1/* $NetBSD: extattr.h,v 1.11 2021/06/19 13:56:34 christos Exp $ */
2
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: src/sys/sys/extattr.h,v 1.12 2003/06/04 04:04:24 rwatson Exp
31 */
32
33/*
34 * Support for file system extended attributes. Originally developed by
35 * the TrustedBSD Project. For a Linux-compatible interface to the same
36 * subsystem, see <sys/xattr.h>.
37 */
38
39#ifndef _SYS_EXTATTR_H_
40#define _SYS_EXTATTR_H_
41
42#include <sys/types.h>
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
63#define EXTATTR_MAXNAMELEN KERNEL_NAME_MAX
64
65/* for sys_extattrctl */
66#define EXTATTR_CMD_START 0x00000001
67#define EXTATTR_CMD_STOP 0x00000002
68
69#ifdef _KERNEL
70
71#include <sys/param.h>
72
73/* VOP_LISTEXTATTR flags */
74#define EXTATTR_LIST_LENPREFIX 1 /* names with length prefix */
75
76struct lwp;
77struct vnode;
78int extattr_check_cred(struct vnode *, int, kauth_cred_t, int);
79
80#else
81
82#include <sys/cdefs.h>
83__BEGIN_DECLS
84int extattrctl(const char *_path, int _cmd, const char *_filename,
85 int _attrnamespace, const char *_attrname);
86
87int extattr_delete_fd(int _fd, int _attrnamespace, const char *_attrname);
88int extattr_delete_file(const char *_path, int _attrnamespace,
89 const char *_attrname);
90int extattr_delete_link(const char *_path, int _attrnamespace,
91 const char *_attrname);
92ssize_t extattr_get_fd(int _fd, int _attrnamespace, const char *_attrname,
93 void *_data, size_t _nbytes);
94ssize_t extattr_get_file(const char *_path, int _attrnamespace,
95 const char *_attrname, void *_data, size_t _nbytes);
96ssize_t extattr_get_link(const char *_path, int _attrnamespace,
97 const char *_attrname, void *_data, size_t _nbytes);
98ssize_t extattr_list_fd(int _fd, int _attrnamespace, void *_data,
99 size_t _nbytes);
100ssize_t extattr_list_file(const char *_path, int _attrnamespace, void *_data,
101 size_t _nbytes);
102ssize_t extattr_list_link(const char *_path, int _attrnamespace, void *_data,
103 size_t _nbytes);
104int extattr_set_fd(int _fd, int _attrnamespace, const char *_attrname,
105 const void *_data, size_t _nbytes);
106int extattr_set_file(const char *_path, int _attrnamespace,
107 const char *_attrname, const void *_data, size_t _nbytes);
108int extattr_set_link(const char *_path, int _attrnamespace,
109 const char *_attrname, const void *_data, size_t _nbytes);
110
111extern const int extattr_namespaces[];
112
113int extattr_namespace_to_string(int, char **);
114int extattr_string_to_namespace(const char *, int *);
115int extattr_copy_fd(int _from_fd, int _to_fd, int _namespace);
116int extattr_copy_file(const char *_from, const char *_to, int _namespace);
117int extattr_copy_link(const char *_from, const char *_to, int _namespace);
118
119int fcpxattr(int _from_fd, int _to_fd);
120int cpxattr(const char *_from, const char *_to);
121int lcpxattr(const char *_from, const char *_to);
122__END_DECLS
123
124#endif /* !_KERNEL */
125#endif /* !_SYS_EXTATTR_H_ */