Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#include <linux/kernel.h>
3#include <linux/types.h>
4#include <linux/spinlock_types.h>
5#include <linux/slab.h>
6#include <linux/ioctl.h>
7
8/* pvfs2-config.h ***********************************************************/
9#define ORANGEFS_VERSION_MAJOR 2
10#define ORANGEFS_VERSION_MINOR 9
11#define ORANGEFS_VERSION_SUB 0
12
13/* khandle stuff ***********************************************************/
14
15/*
16 * The 2.9 core will put 64 bit handles in here like this:
17 * 1234 0000 0000 5678
18 * The 3.0 and beyond cores will put 128 bit handles in here like this:
19 * 1234 5678 90AB CDEF
20 * The kernel module will always use the first four bytes and
21 * the last four bytes as an inum.
22 */
23struct orangefs_khandle {
24 unsigned char u[16];
25} __aligned(8);
26
27/*
28 * kernel version of an object ref.
29 */
30struct orangefs_object_kref {
31 struct orangefs_khandle khandle;
32 __s32 fs_id;
33 __s32 __pad1;
34};
35
36/*
37 * compare 2 khandles assumes little endian thus from large address to
38 * small address
39 */
40static inline int ORANGEFS_khandle_cmp(const struct orangefs_khandle *kh1,
41 const struct orangefs_khandle *kh2)
42{
43 int i;
44
45 for (i = 15; i >= 0; i--) {
46 if (kh1->u[i] > kh2->u[i])
47 return 1;
48 if (kh1->u[i] < kh2->u[i])
49 return -1;
50 }
51
52 return 0;
53}
54
55static inline void ORANGEFS_khandle_to(const struct orangefs_khandle *kh,
56 void *p, int size)
57{
58
59 memcpy(p, kh->u, 16);
60 memset(p + 16, 0, size - 16);
61
62}
63
64static inline void ORANGEFS_khandle_from(struct orangefs_khandle *kh,
65 void *p, int size)
66{
67 memset(kh, 0, 16);
68 memcpy(kh->u, p, 16);
69
70}
71
72/* pvfs2-types.h ************************************************************/
73typedef __u32 ORANGEFS_uid;
74typedef __u32 ORANGEFS_gid;
75typedef __s32 ORANGEFS_fs_id;
76typedef __u32 ORANGEFS_permissions;
77typedef __u64 ORANGEFS_time;
78typedef __s64 ORANGEFS_size;
79typedef __u64 ORANGEFS_flags;
80typedef __u64 ORANGEFS_ds_position;
81typedef __s32 ORANGEFS_error;
82typedef __s64 ORANGEFS_offset;
83
84#define ORANGEFS_SUPER_MAGIC 0x20030528
85
86/*
87 * ORANGEFS error codes are a signed 32-bit integer. Error codes are negative, but
88 * the sign is stripped before decoding.
89 */
90
91/* Bit 31 is not used since it is the sign. */
92
93/*
94 * Bit 30 specifies that this is a ORANGEFS error. A ORANGEFS error is either an
95 * encoded errno value or a ORANGEFS protocol error.
96 */
97#define ORANGEFS_ERROR_BIT (1 << 30)
98
99/*
100 * Bit 29 specifies that this is a ORANGEFS protocol error and not an encoded
101 * errno value.
102 */
103#define ORANGEFS_NON_ERRNO_ERROR_BIT (1 << 29)
104
105/*
106 * Bits 9, 8, and 7 specify the error class, which encodes the section of
107 * server code the error originated in for logging purposes. It is not used
108 * in the kernel except to be masked out.
109 */
110#define ORANGEFS_ERROR_CLASS_BITS 0x380
111
112/* Bits 6 - 0 are reserved for the actual error code. */
113#define ORANGEFS_ERROR_NUMBER_BITS 0x7f
114
115/* Encoded errno values decoded by PINT_errno_mapping in orangefs-utils.c. */
116
117/* Our own ORANGEFS protocol error codes. */
118#define ORANGEFS_ECANCEL (1|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
119#define ORANGEFS_EDEVINIT (2|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
120#define ORANGEFS_EDETAIL (3|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
121#define ORANGEFS_EHOSTNTFD (4|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
122#define ORANGEFS_EADDRNTFD (5|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
123#define ORANGEFS_ENORECVR (6|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
124#define ORANGEFS_ETRYAGAIN (7|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
125#define ORANGEFS_ENOTPVFS (8|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
126#define ORANGEFS_ESECURITY (9|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
127
128/* permission bits */
129#define ORANGEFS_O_EXECUTE (1 << 0)
130#define ORANGEFS_O_WRITE (1 << 1)
131#define ORANGEFS_O_READ (1 << 2)
132#define ORANGEFS_G_EXECUTE (1 << 3)
133#define ORANGEFS_G_WRITE (1 << 4)
134#define ORANGEFS_G_READ (1 << 5)
135#define ORANGEFS_U_EXECUTE (1 << 6)
136#define ORANGEFS_U_WRITE (1 << 7)
137#define ORANGEFS_U_READ (1 << 8)
138/* no ORANGEFS_U_VTX (sticky bit) */
139#define ORANGEFS_G_SGID (1 << 10)
140#define ORANGEFS_U_SUID (1 << 11)
141
142#define ORANGEFS_ITERATE_START 2147483646
143#define ORANGEFS_ITERATE_END 2147483645
144#define ORANGEFS_IMMUTABLE_FL FS_IMMUTABLE_FL
145#define ORANGEFS_APPEND_FL FS_APPEND_FL
146#define ORANGEFS_NOATIME_FL FS_NOATIME_FL
147#define ORANGEFS_MIRROR_FL 0x01000000ULL
148#define ORANGEFS_O_EXECUTE (1 << 0)
149#define ORANGEFS_FS_ID_NULL ((__s32)0)
150#define ORANGEFS_ATTR_SYS_UID (1 << 0)
151#define ORANGEFS_ATTR_SYS_GID (1 << 1)
152#define ORANGEFS_ATTR_SYS_PERM (1 << 2)
153#define ORANGEFS_ATTR_SYS_ATIME (1 << 3)
154#define ORANGEFS_ATTR_SYS_CTIME (1 << 4)
155#define ORANGEFS_ATTR_SYS_MTIME (1 << 5)
156#define ORANGEFS_ATTR_SYS_TYPE (1 << 6)
157#define ORANGEFS_ATTR_SYS_ATIME_SET (1 << 7)
158#define ORANGEFS_ATTR_SYS_MTIME_SET (1 << 8)
159#define ORANGEFS_ATTR_SYS_SIZE (1 << 20)
160#define ORANGEFS_ATTR_SYS_LNK_TARGET (1 << 24)
161#define ORANGEFS_ATTR_SYS_DFILE_COUNT (1 << 25)
162#define ORANGEFS_ATTR_SYS_DIRENT_COUNT (1 << 26)
163#define ORANGEFS_ATTR_SYS_BLKSIZE (1 << 28)
164#define ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT (1 << 29)
165#define ORANGEFS_ATTR_SYS_COMMON_ALL \
166 (ORANGEFS_ATTR_SYS_UID | \
167 ORANGEFS_ATTR_SYS_GID | \
168 ORANGEFS_ATTR_SYS_PERM | \
169 ORANGEFS_ATTR_SYS_ATIME | \
170 ORANGEFS_ATTR_SYS_CTIME | \
171 ORANGEFS_ATTR_SYS_MTIME | \
172 ORANGEFS_ATTR_SYS_TYPE)
173
174#define ORANGEFS_ATTR_SYS_ALL_SETABLE \
175(ORANGEFS_ATTR_SYS_COMMON_ALL-ORANGEFS_ATTR_SYS_TYPE)
176
177#define ORANGEFS_ATTR_SYS_ALL_NOHINT \
178 (ORANGEFS_ATTR_SYS_COMMON_ALL | \
179 ORANGEFS_ATTR_SYS_SIZE | \
180 ORANGEFS_ATTR_SYS_LNK_TARGET | \
181 ORANGEFS_ATTR_SYS_DFILE_COUNT | \
182 ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT | \
183 ORANGEFS_ATTR_SYS_DIRENT_COUNT | \
184 ORANGEFS_ATTR_SYS_BLKSIZE)
185
186#define ORANGEFS_XATTR_REPLACE 0x2
187#define ORANGEFS_XATTR_CREATE 0x1
188#define ORANGEFS_MAX_SERVER_ADDR_LEN 256
189#define ORANGEFS_NAME_MAX 256
190/*
191 * max extended attribute name len as imposed by the VFS and exploited for the
192 * upcall request types.
193 * NOTE: Please retain them as multiples of 8 even if you wish to change them
194 * This is *NECESSARY* for supporting 32 bit user-space binaries on a 64-bit
195 * kernel. Due to implementation within DBPF, this really needs to be
196 * ORANGEFS_NAME_MAX, which it was the same value as, but no reason to let it
197 * break if that changes in the future.
198 */
199#define ORANGEFS_MAX_XATTR_NAMELEN ORANGEFS_NAME_MAX /* Not the same as
200 * XATTR_NAME_MAX defined
201 * by <linux/xattr.h>
202 */
203#define ORANGEFS_MAX_XATTR_VALUELEN 8192 /* Not the same as XATTR_SIZE_MAX
204 * defined by <linux/xattr.h>
205 */
206#define ORANGEFS_MAX_XATTR_LISTLEN 16 /* Not the same as XATTR_LIST_MAX
207 * defined by <linux/xattr.h>
208 */
209/*
210 * ORANGEFS I/O operation types, used in both system and server interfaces.
211 */
212enum ORANGEFS_io_type {
213 ORANGEFS_IO_READ = 1,
214 ORANGEFS_IO_WRITE = 2
215};
216
217/*
218 * If this enum is modified the server parameters related to the precreate pool
219 * batch and low threshold sizes may need to be modified to reflect this
220 * change.
221 */
222enum orangefs_ds_type {
223 ORANGEFS_TYPE_NONE = 0,
224 ORANGEFS_TYPE_METAFILE = (1 << 0),
225 ORANGEFS_TYPE_DATAFILE = (1 << 1),
226 ORANGEFS_TYPE_DIRECTORY = (1 << 2),
227 ORANGEFS_TYPE_SYMLINK = (1 << 3),
228 ORANGEFS_TYPE_DIRDATA = (1 << 4),
229 ORANGEFS_TYPE_INTERNAL = (1 << 5) /* for the server's private use */
230};
231
232/*
233 * ORANGEFS_certificate simply stores a buffer with the buffer size.
234 * The buffer can be converted to an OpenSSL X509 struct for use.
235 */
236struct ORANGEFS_certificate {
237 __u32 buf_size;
238 unsigned char *buf;
239};
240
241/*
242 * A credential identifies a user and is signed by the client/user
243 * private key.
244 */
245struct ORANGEFS_credential {
246 __u32 userid; /* user id */
247 __u32 num_groups; /* length of group_array */
248 __u32 *group_array; /* groups for which the user is a member */
249 char *issuer; /* alias of the issuing server */
250 __u64 timeout; /* seconds after epoch to time out */
251 __u32 sig_size; /* length of the signature in bytes */
252 unsigned char *signature; /* digital signature */
253 struct ORANGEFS_certificate certificate; /* user certificate buffer */
254};
255#define extra_size_ORANGEFS_credential (ORANGEFS_REQ_LIMIT_GROUPS * \
256 sizeof(__u32) + \
257 ORANGEFS_REQ_LIMIT_ISSUER + \
258 ORANGEFS_REQ_LIMIT_SIGNATURE + \
259 extra_size_ORANGEFS_certificate)
260
261/* This structure is used by the VFS-client interaction alone */
262struct ORANGEFS_keyval_pair {
263 char key[ORANGEFS_MAX_XATTR_NAMELEN];
264 __s32 key_sz; /* __s32 for portable, fixed-size structures */
265 __s32 val_sz;
266 char val[ORANGEFS_MAX_XATTR_VALUELEN];
267};
268
269/* pvfs2-sysint.h ***********************************************************/
270/* Describes attributes for a file, directory, or symlink. */
271struct ORANGEFS_sys_attr_s {
272 __u32 owner;
273 __u32 group;
274 __u32 perms;
275 __u64 atime;
276 __u64 mtime;
277 __u64 ctime;
278 __s64 size;
279
280 /* NOTE: caller must free if valid */
281 char *link_target;
282
283 /* Changed to __s32 so that size of structure does not change */
284 __s32 dfile_count;
285
286 /* Changed to __s32 so that size of structure does not change */
287 __s32 distr_dir_servers_initial;
288
289 /* Changed to __s32 so that size of structure does not change */
290 __s32 distr_dir_servers_max;
291
292 /* Changed to __s32 so that size of structure does not change */
293 __s32 distr_dir_split_size;
294
295 __u32 mirror_copies_count;
296
297 /* NOTE: caller must free if valid */
298 char *dist_name;
299
300 /* NOTE: caller must free if valid */
301 char *dist_params;
302
303 __s64 dirent_count;
304 enum orangefs_ds_type objtype;
305 __u64 flags;
306 __u32 mask;
307 __s64 blksize;
308};
309
310#define ORANGEFS_LOOKUP_LINK_NO_FOLLOW 0
311
312/* pint-dev.h ***************************************************************/
313
314/* parameter structure used in ORANGEFS_DEV_DEBUG ioctl command */
315struct dev_mask_info_s {
316 enum {
317 KERNEL_MASK,
318 CLIENT_MASK,
319 } mask_type;
320 __u64 mask_value;
321};
322
323struct dev_mask2_info_s {
324 __u64 mask1_value;
325 __u64 mask2_value;
326};
327
328/* pvfs2-util.h *************************************************************/
329__s32 ORANGEFS_util_translate_mode(int mode);
330
331/* pvfs2-debug.h ************************************************************/
332#include "orangefs-debug.h"
333
334/* pvfs2-internal.h *********************************************************/
335#define llu(x) (unsigned long long)(x)
336#define lld(x) (long long)(x)
337
338/* pint-dev-shared.h ********************************************************/
339#define ORANGEFS_DEV_MAGIC 'k'
340
341#define ORANGEFS_READDIR_DEFAULT_DESC_COUNT 5
342
343#define DEV_GET_MAGIC 0x1
344#define DEV_GET_MAX_UPSIZE 0x2
345#define DEV_GET_MAX_DOWNSIZE 0x3
346#define DEV_MAP 0x4
347#define DEV_REMOUNT_ALL 0x5
348#define DEV_DEBUG 0x6
349#define DEV_UPSTREAM 0x7
350#define DEV_CLIENT_MASK 0x8
351#define DEV_CLIENT_STRING 0x9
352#define DEV_MAX_NR 0xa
353
354/* supported ioctls, codes are with respect to user-space */
355enum {
356 ORANGEFS_DEV_GET_MAGIC = _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAGIC, __s32),
357 ORANGEFS_DEV_GET_MAX_UPSIZE =
358 _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_UPSIZE, __s32),
359 ORANGEFS_DEV_GET_MAX_DOWNSIZE =
360 _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_DOWNSIZE, __s32),
361 ORANGEFS_DEV_MAP = _IO(ORANGEFS_DEV_MAGIC, DEV_MAP),
362 ORANGEFS_DEV_REMOUNT_ALL = _IO(ORANGEFS_DEV_MAGIC, DEV_REMOUNT_ALL),
363 ORANGEFS_DEV_DEBUG = _IOR(ORANGEFS_DEV_MAGIC, DEV_DEBUG, __s32),
364 ORANGEFS_DEV_UPSTREAM = _IOW(ORANGEFS_DEV_MAGIC, DEV_UPSTREAM, int),
365 ORANGEFS_DEV_CLIENT_MASK = _IOW(ORANGEFS_DEV_MAGIC,
366 DEV_CLIENT_MASK,
367 struct dev_mask2_info_s),
368 ORANGEFS_DEV_CLIENT_STRING = _IOW(ORANGEFS_DEV_MAGIC,
369 DEV_CLIENT_STRING,
370 char *),
371 ORANGEFS_DEV_MAXNR = DEV_MAX_NR,
372};
373
374/*
375 * version number for use in communicating between kernel space and user
376 * space. Zero signifies the upstream version of the kernel module.
377 */
378#define ORANGEFS_KERNEL_PROTO_VERSION 0
379#define ORANGEFS_MINIMUM_USERSPACE_VERSION 20903
380
381/*
382 * describes memory regions to map in the ORANGEFS_DEV_MAP ioctl.
383 * NOTE: See devorangefs-req.c for 32 bit compat structure.
384 * Since this structure has a variable-sized layout that is different
385 * on 32 and 64 bit platforms, we need to normalize to a 64 bit layout
386 * on such systems before servicing ioctl calls from user-space binaries
387 * that may be 32 bit!
388 */
389struct ORANGEFS_dev_map_desc {
390 void *ptr;
391 __s32 total_size;
392 __s32 size;
393 __s32 count;
394};
395
396/* gossip.h *****************************************************************/
397
398#ifdef GOSSIP_DISABLE_DEBUG
399#define gossip_debug(mask, fmt, ...) \
400do { \
401 if (0) \
402 printk(KERN_DEBUG fmt, ##__VA_ARGS__); \
403} while (0)
404#else
405extern __u64 orangefs_gossip_debug_mask;
406
407/* try to avoid function call overhead by checking masks in macro */
408#define gossip_debug(mask, fmt, ...) \
409do { \
410 if (orangefs_gossip_debug_mask & (mask)) \
411 printk(KERN_DEBUG fmt, ##__VA_ARGS__); \
412} while (0)
413#endif /* GOSSIP_DISABLE_DEBUG */
414
415/* do file and line number printouts w/ the GNU preprocessor */
416#define gossip_ldebug(mask, fmt, ...) \
417 gossip_debug(mask, "%s: " fmt, __func__, ##__VA_ARGS__)
418
419#define gossip_err pr_err
420#define gossip_lerr(fmt, ...) \
421 gossip_err("%s line %d: " fmt, \
422 __FILE__, __LINE__, ##__VA_ARGS__)