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_STATFS_MDC           1
  66 #define LL_STATFS_LOV           2
  67
  68 #define IOC_MDC_TYPE            'i'
  69 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
  70 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
  71 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
  72 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
  73
  74 /* Keep these for backward compartability. */
  75 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
  76 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
  77
  78 /* Do not define O_CHECK_STALE as 0200000000,
  79  * which is conflict with MDS_OPEN_OWNEROVERRIDE */
  80 #define O_CHECK_STALE       020000000  /* hopefully this does not conflict */
  81 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
  82 #define O_JOIN_FILE        0400000000  /* hopefully this does not conflict */
  83
  84 #define LL_FILE_IGNORE_LOCK             0x00000001
  85 #define LL_FILE_GROUP_LOCKED            0x00000002
  86 #define LL_FILE_READAHEAD               0x00000004
  87
  88 #define LOV_USER_MAGIC_V1 0x0BD10BD0
  89 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
  90
  91 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
  92
  93 #define LOV_PATTERN_RAID0 0x001
  94 #define LOV_PATTERN_RAID1 0x002
  95 #define LOV_PATTERN_FIRST 0x100
  96
  97 #define lov_user_ost_data lov_user_ost_data_v1
  98 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
  99         __u64 l_object_id;        /* OST object ID */
 100         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 101         __u32 l_ost_gen;          /* generation of this OST index */
 102         __u32 l_ost_idx;          /* OST index in LOV */
 103 } __attribute__((packed));
 104
 105 #define lov_user_md lov_user_md_v1
 106 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 107         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 108         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 109         __u64 lmm_object_id;      /* LOV object ID */
 110         __u64 lmm_object_gr;      /* LOV object group */
 111         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 112         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 113         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 114         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 115 } __attribute__((packed));
 116
 117 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 118  * use this.  It is unsafe to #define those values in this header as it
 119  * is possible the application has already #included <sys/stat.h>. */
 120 #ifdef HAVE_LOV_USER_MDS_DATA
 121 #define lov_user_mds_data lov_user_mds_data_v1
 122 struct lov_user_mds_data_v1 {
 123         lstat_t lmd_st;                 /* MDS stat struct */
 124         struct lov_user_md_v1 lmd_lmm;  /* LOV EA user data */
 125 } __attribute__((packed));
 126 #endif
 127
 128 struct ll_recreate_obj {
 129         __u64 lrc_id;
 130         __u64 lrc_group;
 131         __u32 lrc_ost_idx;
 132 };
 133
 134 struct obd_uuid {
 135         __u8 uuid[40];
 136 };
 137
 138 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
 139 {
 140         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 141 }
 142
 143 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 144 {
 145         return uuid->uuid[0] == '\0';
 146 }
 147
 148 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 149 {
 150         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 151         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 152 }
 153
 154 /* For printf's only, make sure uuid is terminated */
 155 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 156 {
 157         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 158                 /* Obviously not safe, but for printfs, no real harm done...
 159                    we're always null-terminated, even in a race. */
 160                 static char temp[sizeof(*uuid)];
 161                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 162                 temp[sizeof(*uuid) - 1] = '\0';
 163                 return temp;
 164         }
 165         return (char *)(uuid->uuid);
 166 }
 167
 168 #define LUSTRE_Q_QUOTAON  0x800002     /* turn quotas on */
 169 #define LUSTRE_Q_QUOTAOFF 0x800003     /* turn quotas off */
 170 #define LUSTRE_Q_GETINFO  0x800005     /* get information about quota files */
 171 #define LUSTRE_Q_SETINFO  0x800006     /* set information about quota files */
 172 #define LUSTRE_Q_GETQUOTA 0x800007     /* get user quota structure */
 173 #define LUSTRE_Q_SETQUOTA 0x800008     /* set user quota structure */
 174
 175 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 176
 177 #define QFMT_LDISKFS 2  /* QFMT_VFS_V0(2), quota format for ldiskfs */
 178
 179 struct if_quotacheck {
 180         __u8                    obd_type[16];
 181         struct obd_uuid         obd_uuid;
 182 };
 183
 184 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
 185
 186 /* setxid permission */
 187 #define N_SETXID_PERMS_MAX      64
 188
 189 struct setxid_perm_downcall_data {
 190         __u64 pdd_nid;
 191         __u32 pdd_perm;
 192 };
 193
 194 struct identity_downcall_data {
 195         __u32                            idd_magic;
 196         __u32                            idd_err;
 197         __u32                            idd_uid;
 198         __u32                            idd_gid;
 199         __u32                            idd_nperms;
 200         struct setxid_perm_downcall_data idd_perms[N_SETXID_PERMS_MAX];
 201         __u32                            idd_ngroups;
 202         __u32                            idd_groups[0];
 203 };
 204
 205 #define RMTACL_DOWNCALL_MAGIC 0x6d6dd620
 206 #define RMTACL_SIZE_MAX     (4096)
 207
 208 struct rmtacl_downcall_data {
 209         __u32           add_magic;
 210         __u32           add_handle;
 211         __u64           add_key;
 212         __u32           add_buflen;
 213         __u32           add_padding;
 214         __u8            add_buf[0];
 215 };
 216
 217 #ifdef NEED_QUOTA_DEFS
 218 #ifndef QUOTABLOCK_BITS
 219 #define QUOTABLOCK_BITS 10
 220 #endif
 221
 222 #ifndef QUOTABLOCK_SIZE
 223 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
 224 #endif
 225
 226 #ifndef toqb
 227 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
 228 #endif
 229
 230 #ifndef QIF_BLIMITS
 231 #define QIF_BLIMITS     1
 232 #define QIF_SPACE       2
 233 #define QIF_ILIMITS     4
 234 #define QIF_INODES      8
 235 #define QIF_BTIME       16
 236 #define QIF_ITIME       32
 237 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 238 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 239 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 240 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 241 #endif
 242
 243 #endif /* !__KERNEL__ */
 244
 245 /* XXX: same as if_dqinfo struct in kernel */
 246 struct obd_dqinfo {
 247         __u64 dqi_bgrace;
 248         __u64 dqi_igrace;
 249         __u32 dqi_flags;
 250         __u32 dqi_valid;
 251 };
 252
 253 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 254 struct obd_dqblk {
 255         __u64 dqb_bhardlimit;
 256         __u64 dqb_bsoftlimit;
 257         __u64 dqb_curspace;
 258         __u64 dqb_ihardlimit;
 259         __u64 dqb_isoftlimit;
 260         __u64 dqb_curinodes;
 261         __u64 dqb_btime;
 262         __u64 dqb_itime;
 263         __u32 dqb_valid;
 264         __u32 padding;
 265 };
 266
 267 struct if_quotactl {
 268         __u32                   qc_cmd;
 269         __u32                   qc_type;
 270         __u32                   qc_id;
 271         __u32                   qc_stat;
 272         struct obd_dqinfo       qc_dqinfo;
 273         struct obd_dqblk        qc_dqblk;
 274         __u8                    obd_type[16];
 275         struct obd_uuid         obd_uuid;
 276 };
 277
 278 #ifndef offsetof
 279 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 280 #endif
 281
 282 /* remote acl ioctl */
 283 struct rmtacl_ioctl_data {
 284         char           *cmd;            /* IN */
 285         unsigned long   cmd_len;
 286         char           *res;            /* OUT */
 287         unsigned long   res_len;
 288 };
 289
 290 #endif /* _LUSTRE_USER_H */