lustre/include/lustre/lustre_user.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *   This file is part of Lustre, http://www.lustre.org
   5  *
   6  * Lustre public user-space interface definitions.
   7  */
   8
   9 #ifndef _LUSTRE_USER_H
  10 #define _LUSTRE_USER_H
  11
  12 #if defined(__linux__)
  13 #include <linux/lustre_user.h>
  14 #elif defined(__APPLE__)
  15 #include <darwin/lustre_user.h>
  16 #elif defined(__WINNT__)
  17 #include <winnt/lustre_user.h>
  18 #else
  19 #error Unsupported operating system.
  20 #endif
  21
  22 /* for statfs() */
  23 #define LL_SUPER_MAGIC 0x0BD00BD0
  24
  25 #ifndef EXT3_IOC_GETFLAGS
  26 #define EXT3_IOC_GETFLAGS               _IOR('f', 1, long)
  27 #define EXT3_IOC_SETFLAGS               _IOW('f', 2, long)
  28 #define EXT3_IOC_GETVERSION             _IOR('f', 3, long)
  29 #define EXT3_IOC_SETVERSION             _IOW('f', 4, long)
  30 #define EXT3_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  31 #define EXT3_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  32 #endif
  33
  34 struct obd_statfs;
  35
  36 /*
  37  * The ioctl naming rules:
  38  * LL_*     - works on the currently opened filehandle instead of parent dir
  39  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
  40  * *_MDC_*  - gets/sets data related to MDC
  41  * *_LOV_*  - gets/sets data related to OSC/LOV
  42  * *FILE*   - called on parent dir and passes in a filename
  43  * *STRIPE* - set/get lov_user_md
  44  * *INFO    - set/get lov_user_mds_data
  45  */
  46 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
  47 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
  48 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
  49 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
  50 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
  51 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
  52 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
  53 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
  54 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
  55 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
  56 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
  57 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl *)
  58 #define LL_IOC_JOIN                     _IOW ('f', 163, long)
  59 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
  60 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
  61 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
  62 #define LL_IOC_GETFACL                  _IOWR('f', 167, struct rmtacl_ioctl_data *)
  63 #define LL_IOC_SETFACL                  _IOWR('f', 168, struct rmtacl_ioctl_data *)
  64
  65 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
  66 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
  67 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, long)
  68 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
  69
  70 #define LL_STATFS_MDC           1
  71 #define LL_STATFS_LOV           2
  72
  73 #define IOC_MDC_TYPE            'i'
  74 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
  75 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
  76 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
  77 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
  78
  79 /* Keep these for backward compartability. */
  80 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
  81 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
  82
  83 /* Do not define O_CHECK_STALE as 0200000000,
  84  * which is conflict with MDS_OPEN_OWNEROVERRIDE */
  85 #define O_CHECK_STALE       020000000  /* hopefully this does not conflict */
  86 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
  87 #define O_JOIN_FILE        0400000000  /* hopefully this does not conflict */
  88
  89 #define LL_FILE_IGNORE_LOCK             0x00000001
  90 #define LL_FILE_GROUP_LOCKED            0x00000002
  91 #define LL_FILE_READAHEAD               0x00000004
  92
  93 #define LOV_USER_MAGIC_V1 0x0BD10BD0
  94 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
  95
  96 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
  97
  98 #define LOV_PATTERN_RAID0 0x001
  99 #define LOV_PATTERN_RAID1 0x002
 100 #define LOV_PATTERN_FIRST 0x100
 101
 102 #define lov_user_ost_data lov_user_ost_data_v1
 103 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 104         __u64 l_object_id;        /* OST object ID */
 105         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 106         __u32 l_ost_gen;          /* generation of this OST index */
 107         __u32 l_ost_idx;          /* OST index in LOV */
 108 } __attribute__((packed));
 109
 110 #define lov_user_md lov_user_md_v1
 111 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 112         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 113         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 114         __u64 lmm_object_id;      /* LOV object ID */
 115         __u64 lmm_object_gr;      /* LOV object group */
 116         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 117         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 118         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 119         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 120 } __attribute__((packed));
 121
 122 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 123  * use this.  It is unsafe to #define those values in this header as it
 124  * is possible the application has already #included <sys/stat.h>. */
 125 #ifdef HAVE_LOV_USER_MDS_DATA
 126 #define lov_user_mds_data lov_user_mds_data_v1
 127 struct lov_user_mds_data_v1 {
 128         lstat_t lmd_st;                 /* MDS stat struct */
 129         struct lov_user_md_v1 lmd_lmm;  /* LOV EA user data */
 130 } __attribute__((packed));
 131 #endif
 132
 133 struct ll_recreate_obj {
 134         __u64 lrc_id;
 135         __u64 lrc_group;
 136         __u32 lrc_ost_idx;
 137 };
 138
 139 struct obd_uuid {
 140         __u8 uuid[40];
 141 };
 142
 143 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
 144 {
 145         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 146 }
 147
 148 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 149 {
 150         return uuid->uuid[0] == '\0';
 151 }
 152
 153 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 154 {
 155         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 156         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 157 }
 158
 159 /* For printf's only, make sure uuid is terminated */
 160 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 161 {
 162         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 163                 /* Obviously not safe, but for printfs, no real harm done...
 164                    we're always null-terminated, even in a race. */
 165                 static char temp[sizeof(*uuid)];
 166                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 167                 temp[sizeof(*uuid) - 1] = '\0';
 168                 return temp;
 169         }
 170         return (char *)(uuid->uuid);
 171 }
 172
 173 #define LUSTRE_Q_QUOTAON  0x800002     /* turn quotas on */
 174 #define LUSTRE_Q_QUOTAOFF 0x800003     /* turn quotas off */
 175 #define LUSTRE_Q_GETINFO  0x800005     /* get information about quota files */
 176 #define LUSTRE_Q_SETINFO  0x800006     /* set information about quota files */
 177 #define LUSTRE_Q_GETQUOTA 0x800007     /* get user quota structure */
 178 #define LUSTRE_Q_SETQUOTA 0x800008     /* set user quota structure */
 179
 180 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 181
 182 #define QFMT_LDISKFS 2  /* QFMT_VFS_V0(2), quota format for ldiskfs */
 183
 184 struct if_quotacheck {
 185         __u8                    obd_type[16];
 186         struct obd_uuid         obd_uuid;
 187 };
 188
 189 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
 190
 191 /* setxid permission */
 192 #define N_SETXID_PERMS_MAX      64
 193
 194 struct setxid_perm_downcall_data {
 195         __u64 pdd_nid;
 196         __u32 pdd_perm;
 197 };
 198
 199 struct identity_downcall_data {
 200         __u32                            idd_magic;
 201         __u32                            idd_err;
 202         __u32                            idd_uid;
 203         __u32                            idd_gid;
 204         __u32                            idd_nperms;
 205         struct setxid_perm_downcall_data idd_perms[N_SETXID_PERMS_MAX];
 206         __u32                            idd_ngroups;
 207         __u32                            idd_groups[0];
 208 };
 209
 210 #define RMTACL_DOWNCALL_MAGIC 0x6d6dd620
 211 #define RMTACL_SIZE_MAX     (4096)
 212
 213 struct rmtacl_downcall_data {
 214         __u32           add_magic;
 215         __u32           add_handle;
 216         __u64           add_key;
 217         __u32           add_buflen;
 218         __u32           add_padding;
 219         __u8            add_buf[0];
 220 };
 221
 222 #ifdef NEED_QUOTA_DEFS
 223 #ifndef QUOTABLOCK_BITS
 224 #define QUOTABLOCK_BITS 10
 225 #endif
 226
 227 #ifndef QUOTABLOCK_SIZE
 228 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
 229 #endif
 230
 231 #ifndef toqb
 232 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
 233 #endif
 234
 235 #ifndef QIF_BLIMITS
 236 #define QIF_BLIMITS     1
 237 #define QIF_SPACE       2
 238 #define QIF_ILIMITS     4
 239 #define QIF_INODES      8
 240 #define QIF_BTIME       16
 241 #define QIF_ITIME       32
 242 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 243 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 244 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 245 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 246 #endif
 247
 248 #endif /* !__KERNEL__ */
 249
 250 /* XXX: same as if_dqinfo struct in kernel */
 251 struct obd_dqinfo {
 252         __u64 dqi_bgrace;
 253         __u64 dqi_igrace;
 254         __u32 dqi_flags;
 255         __u32 dqi_valid;
 256 };
 257
 258 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 259 struct obd_dqblk {
 260         __u64 dqb_bhardlimit;
 261         __u64 dqb_bsoftlimit;
 262         __u64 dqb_curspace;
 263         __u64 dqb_ihardlimit;
 264         __u64 dqb_isoftlimit;
 265         __u64 dqb_curinodes;
 266         __u64 dqb_btime;
 267         __u64 dqb_itime;
 268         __u32 dqb_valid;
 269         __u32 padding;
 270 };
 271
 272 struct if_quotactl {
 273         __u32                   qc_cmd;
 274         __u32                   qc_type;
 275         __u32                   qc_id;
 276         __u32                   qc_stat;
 277         struct obd_dqinfo       qc_dqinfo;
 278         struct obd_dqblk        qc_dqblk;
 279         __u8                    obd_type[16];
 280         struct obd_uuid         obd_uuid;
 281 };
 282
 283 #ifndef offsetof
 284 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 285 #endif
 286
 287 /* remote acl ioctl */
 288 struct rmtacl_ioctl_data {
 289         char           *cmd;            /* IN */
 290         unsigned long   cmd_len;
 291         char           *res;            /* OUT */
 292         unsigned long   res_len;
 293 };
 294
 295 #endif /* _LUSTRE_USER_H */