LXR linux/fs/orangefs/protocol.h

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