-
Notifications
You must be signed in to change notification settings - Fork 23
/
Copy pathxattrs.h
177 lines (139 loc) · 6.77 KB
/
xattrs.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
This file is part of GUFI, which is part of MarFS, which is released
under the BSD license.
Copyright (c) 2017, Los Alamos National Security (LANS), LLC
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
From Los Alamos National Security, LLC:
LA-CC-15-039
Copyright (c) 2017, Los Alamos National Security, LLC All rights reserved.
Copyright 2017. Los Alamos National Security, LLC. This software was produced
under U.S. Government contract DE-AC52-06NA25396 for Los Alamos National
Laboratory (LANL), which is operated by Los Alamos National Security, LLC for
the U.S. Department of Energy. The U.S. Government has rights to use,
reproduce, and distribute this software. NEITHER THE GOVERNMENT NOR LOS
ALAMOS NATIONAL SECURITY, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR
ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is
modified to produce derivative works, such modified software should be
clearly marked, so as not to confuse it with the version available from
LANL.
THIS SOFTWARE IS PROVIDED BY LOS ALAMOS NATIONAL SECURITY, LLC AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL LOS ALAMOS NATIONAL SECURITY, LLC OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
*/
#ifndef GUFI_XATTR_H
#define GUFI_XATTR_H
#include <stdio.h>
#include <sys/stat.h>
/* Include platform-specific xattr */
#if CONFIG_SYS_XATTR_H
#include <sys/types.h>
#include <sys/xattr.h>
#elif CONFIG_ATTR_XATTR_H
#include <attr/xattr.h>
#else
#include <sys/xattr.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* Alias xattr functions to standard subset of GNU and BSD */
#if defined(CONFIG_DARWIN_XATTRS)
# define LISTXATTR(PATH, BUF, SIZE) listxattr((PATH), (BUF), (SIZE), XATTR_NOFOLLOW)
# define GETXATTR(PATH, KEY, BUF, SIZE) getxattr((PATH), (KEY), (BUF), (SIZE), 0, XATTR_NOFOLLOW)
# define SETXATTR(PATH, KEY, VALUE, SIZE) setxattr((PATH), (KEY), (VALUE), (SIZE), 0, 0)
#elif defined(CONFIG_GNU_XATTRS)
# define LISTXATTR(PATH, BUF, SIZE) llistxattr((PATH), (BUF), (SIZE))
# define GETXATTR(PATH, KEY, BUF, SIZE) lgetxattr((PATH), (KEY), (BUF), (SIZE))
# define SETXATTR(PATH, KEY, VALUE, SIZE) lsetxattr((PATH), (KEY), (VALUE), (SIZE), 0)
#elif defined(CONFIG_CYGWIN_XATTRS)
# define LISTXATTR(PATH, BUF, SIZE) listxattr((PATH), (BUF), (SIZE))
# define GETXATTR(PATH, KEY, BUF, SIZE) lgetxattr((PATH), (KEY), (BUF), (SIZE))
# define SETXATTR(PATH, KEY, VALUE, SIZE) lsetxattr((PATH), (KEY), (VALUE), (SIZE), 0)
#endif
#define MAXXATTR 1024
extern const char XATTRDELIM;
/* each db.db, per-user db, and per-group db will have a table with this name */
/* this table contains xattrs that are local to the current directory */
#define XATTRS_PWD "xattrs_pwd"
extern const char XATTRS_PWD_CREATE[];
extern const char XATTRS_PWD_INSERT[];
/* each db.db, per-user db, and per-group db will have a table with this name */
/* this table will be empty before rollups */
#define XATTRS_ROLLUP "xattrs_rollup"
extern const char XATTRS_ROLLUP_CREATE[];
/* each db.db, per-user db, and per-group db will have a view with this name */
/* this is the combination of xattrs_pwd and xattrs_rollup */
#define XATTRS_AVAIL "xattrs_avail"
extern const char XATTRS_AVAIL_CREATE[];
/* the view of all xattrs available to the caller */
#define XATTRS "xattrs"
#define XATTRS_TEMPLATE "xattrs_template"
extern const char XATTRS_TEMPLATE_CREATE[];
/* format to pass into snprintf */
extern const char XATTR_UID_FILENAME_FORMAT[];
extern const char XATTR_GID_W_READ_FILENAME_FORMAT[];
extern const char XATTR_GID_WO_READ_FILENAME_FORMAT[];
#define XENTRIES "xentries"
#define XPENTRIES "xpentries"
#define XSUMMARY "xsummary"
/* no vrxentries */
#define VRXPENTRIES "vrxpentries"
#define VRXSUMMARY "vrxsummary"
/* single xattr name-value pair */
struct xattr {
char name[MAXXATTR];
size_t name_len;
char value[MAXXATTR];
size_t value_len;
};
/* check if entry xattr can be put into db.db */
int xattr_can_rollin(struct stat *parent, struct stat *entry);
/* list of xattr pairs */
struct xattrs {
struct xattr *pairs;
size_t name_len; /* name lengths only - no separators */
size_t len; /* name + value lengths only - no separators */
size_t count;
};
/* sets up and clean up internal structure only, not the pointer itself */
int xattrs_setup(struct xattrs *xattrs);
int xattrs_alloc(struct xattrs *xattrs);
void xattrs_cleanup(struct xattrs *xattrs);
/* filesystem xattr interactions */
int xattrs_get(const char *path, struct xattrs *xattrs);
ssize_t xattr_get_names(const struct xattrs *xattrs, char *buf, size_t buf_len, const char delim);
/* GUFI trace functions */
int xattrs_to_file(FILE *file, const struct xattrs *xattrs, const char delim);
int xattrs_from_line(char *start, const char *end, struct xattrs *xattrs, const char delim);
#ifdef __cplusplus
}
#endif
#endif