lustre/include/linux/lustre_idl.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * (Un)packing of OST requests
  22  */
  23
  24 #ifndef __LUSTRE_IDL_H__
  25 #define __LUSTRE_IDL_H__
  26 #ifdef __KERNEL__
  27 #include <linux/ioctl.h>
  28 #include <asm/types.h>
  29
  30 #include <linux/types.h>
  31 #else
  32 #define __KERNEL__
  33 #include <linux/list.h>
  34 #undef __KERNEL__
  35 #include <stdint.h>
  36 #endif
  37 /*
  38  * this file contains all data structures used in Lustre interfaces:
  39  * - obdo and obd_request records
  40  * - mds_request records
  41  * - ioctl's
  42  */
  43
  44 /*
  45  *   OST requests: OBDO & OBD request records
  46  */
  47
  48
  49 /* opcodes */
  50 #define OST_GET_INFO  6
  51 #define OST_CONNECT  7
  52 #define OST_DISCONNECT 8
  53 #define OST_GETATTR  1
  54 #define OST_SETATTR  2
  55 #define OST_BRW      3
  56 #define OST_CREATE   4
  57 #define OST_DESTROY  5
  58
  59 /* packet types */
  60 #define OST_TYPE_REQ 1
  61 #define OST_TYPE_REP 2
  62 #define OST_TYPE_ERR 3
  63
  64 struct ost_req_hdr {
  65         __u32 opc;
  66         __u64 seqno;
  67         __u32 status;
  68         __u32 type;
  69 };
  70
  71 struct ost_rep_hdr {
  72         __u32 opc;
  73         __u64 seqno;
  74         __u32 status;
  75         __u32 type;
  76 };
  77
  78 typedef uint64_t        obd_id;
  79 typedef uint64_t        obd_gr;
  80 typedef uint64_t        obd_time;
  81 typedef uint64_t        obd_size;
  82 typedef uint64_t        obd_off;
  83 typedef uint64_t        obd_blocks;
  84 typedef uint32_t        obd_blksize;
  85 typedef uint32_t        obd_mode;
  86 typedef uint32_t        obd_uid;
  87 typedef uint32_t        obd_gid;
  88 typedef uint32_t        obd_rdev;
  89 typedef uint32_t        obd_flag;
  90 typedef uint32_t        obd_count;
  91
  92 #define OBD_FL_INLINEDATA       (0x00000001UL)
  93 #define OBD_FL_OBDMDEXISTS      (0x00000002UL)
  94
  95 #define OBD_INLINESZ    60
  96 #define OBD_OBDMDSZ     60
  97 /* Note: 64-bit types are 64-bit aligned in structure */
  98 struct obdo {
  99         obd_id                  o_id;
 100         obd_gr                  o_gr;
 101         obd_time                o_atime;
 102         obd_time                o_mtime;
 103         obd_time                o_ctime;
 104         obd_size                o_size;
 105         obd_blocks              o_blocks;
 106         obd_blksize             o_blksize;
 107         obd_mode                o_mode;
 108         obd_uid                 o_uid;
 109         obd_gid                 o_gid;
 110         obd_flag                o_flags;
 111         obd_flag                o_obdflags;
 112         obd_count               o_nlink;
 113         obd_count               o_generation;
 114         obd_flag                o_valid;        /* hot fields in this obdo */
 115         char                    o_inline[OBD_INLINESZ];
 116         char                    o_obdmd[OBD_OBDMDSZ];
 117         struct list_head        o_list;
 118         struct obd_ops          *o_op;
 119 };
 120
 121 #define OBD_MD_FLALL    (~0UL)
 122 #define OBD_MD_FLID     (0x00000001UL)
 123 #define OBD_MD_FLATIME  (0x00000002UL)
 124 #define OBD_MD_FLMTIME  (0x00000004UL)
 125 #define OBD_MD_FLCTIME  (0x00000008UL)
 126 #define OBD_MD_FLSIZE   (0x00000010UL)
 127 #define OBD_MD_FLBLOCKS (0x00000020UL)
 128 #define OBD_MD_FLBLKSZ  (0x00000040UL)
 129 #define OBD_MD_FLMODE   (0x00000080UL)
 130 #define OBD_MD_FLTYPE   (0x00000100UL)
 131 #define OBD_MD_FLUID    (0x00000200UL)
 132 #define OBD_MD_FLGID    (0x00000400UL)
 133 #define OBD_MD_FLFLAGS  (0x00000800UL)
 134 #define OBD_MD_FLOBDFLG (0x00001000UL)
 135 #define OBD_MD_FLNLINK  (0x00002000UL)
 136 #define OBD_MD_FLGENER  (0x00004000UL)
 137 #define OBD_MD_FLINLINE (0x00008000UL)
 138 #define OBD_MD_FLOBDMD  (0x00010000UL)
 139 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS))
 140
 141 /* request structure for OST's */
 142
 143 #define OST_REQ_HAS_OA1  0x1
 144
 145 struct ost_req_packed {
 146         __u32   connid;
 147         __u32   cmd;
 148         struct obdo oa;
 149         __u32   buflen1;
 150         __u32   buflen2;
 151         __u32   bufoffset1;
 152         __u32   bufoffset2;
 153 };
 154
 155 struct ost_rep_packed {
 156         __u32   result;
 157         __u32   connid;
 158         struct obdo oa;
 159         __u32   buflen1;
 160         __u32   buflen2;
 161         __u32   bufoffset1;
 162         __u32   bufoffset2;
 163 };
 164
 165 struct obd_buf {
 166         __u64 addr;       // address
 167         __u64 handle;     // DMA handle
 168         __u64 matchbits;  // portals match bits
 169         __u32 offset;     // first bit after addr that is relevant
 170         __u32 size;       // size from addr + offset that needs moving
 171 };
 172
 173 struct obd_bufref {
 174         obd_id    obj_id;
 175         obd_gr    obj_gr;
 176         __u64     offset;
 177         __u32     size;
 178         __u32     flags;
 179 };
 180
 181 /* reply structure for OST's */
 182
 183
 184
 185
 186
 187 /*
 188  *   MDS REQ RECORDS
 189  */
 190
 191
 192 #define MDS_TYPE_REQ 1
 193 #define MDS_TYPE_REP 2
 194 #define MDS_TYPE_ERR 3
 195
 196 struct mds_req_hdr {
 197         __u32 opc;
 198         __u64 seqno;
 199         __u32 status;
 200         __u32 type;
 201 };
 202
 203 struct lustre_fid {
 204         __u64 id;
 205         __u32 generation;
 206         __u32 f_type;
 207 };
 208
 209
 210 struct mds_rep_hdr {
 211         __u32 opc;
 212         __u64 seqno;
 213         __u32 status;
 214         __u32 type;
 215 };
 216
 217 struct mds_req_packed {
 218         struct lustre_fid        fid1;
 219         struct lustre_fid        fid2;
 220         int                        namelen;
 221         int                        tgtlen;
 222         __u32                       valid;
 223         __u32                       mode;
 224         __u32                       uid;
 225         __u32                       gid;
 226         __u64                       size;
 227         __u32                       mtime;
 228         __u32                       ctime;
 229         __u32                       atime;
 230         __u32                       flags;
 231         __u32                       major;
 232         __u32                       minor;
 233         __u32                       ino;
 234         __u32                       generation;
 235         __u32                       name_offset;
 236         __u32                       tgt_offset;
 237 };
 238
 239 struct mds_rep_packed {
 240         struct lustre_fid        fid1;
 241         struct lustre_fid        fid2;
 242         int                        namelen;
 243         int                        tgtlen;
 244         __u32                       valid;
 245         __u32                       mode;
 246         __u32                       uid;
 247         __u32                       gid;
 248         __u64                       size;
 249         __u32                       mtime;
 250         __u32                       ctime;
 251         __u32                       atime;
 252         __u32                       flags;
 253         __u32                       major;
 254         __u32                       minor;
 255         __u32                       ino;
 256         __u32                       generation;
 257         __u32                       name_offset;
 258         __u32                       tgt_offset;
 259 };
 260
 261 /*
 262  *   OBD IOCTLS
 263  */
 264
 265
 266 #define OBD_IOCTL_VERSION 0x00010001
 267
 268 struct obd_ioctl_data {
 269         uint32_t ioc_len;
 270         uint32_t ioc_version;
 271         uint32_t ioc_conn1;
 272         uint32_t ioc_conn2;
 273         struct obdo ioc_obdo1;
 274         struct obdo ioc_obdo2;
 275         obd_size         ioc_count;
 276         obd_off          ioc_offset;
 277         uint32_t         ioc_dev;
 278
 279         /* buffers the kernel will treat as user pointers */
 280         uint32_t ioc_plen1;
 281         char    *ioc_pbuf1;
 282         uint32_t ioc_plen2;
 283         char    *ioc_pbuf2;
 284
 285         /* two inline buffers */
 286         uint32_t ioc_inllen1;
 287         char    *ioc_inlbuf1;
 288         uint32_t ioc_inllen2;
 289         char    *ioc_inlbuf2;
 290
 291         char    ioc_bulk[0];
 292 };
 293
 294 struct obd_ioctl_hdr {
 295         uint32_t ioc_len;
 296         uint32_t ioc_version;
 297 };
 298
 299 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
 300 {
 301         int len = sizeof(struct obd_ioctl_data);
 302         len += size_round(data->ioc_inllen1);
 303         len += size_round(data->ioc_inllen2);
 304         return len;
 305 }
 306
 307 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 308 {
 309         if (data->ioc_len > (1<<30)) {
 310                 printk("OBD ioctl: ioc_len larger than 1<<30\n");
 311                 return 1;
 312         }
 313         if (data->ioc_inllen1 > (1<<30)) {
 314                 printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
 315                 return 1;
 316         }
 317         if (data->ioc_inllen2 > (1<<30)) {
 318                 printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
 319                 return 1;
 320         }
 321         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 322                 printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
 323                 return 1;
 324         }
 325         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 326                 printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
 327                 return 1;
 328         }
 329         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 330                 printk("OBD ioctl: pbuf1 pointer but 0 length\n");
 331                 return 1;
 332         }
 333         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 334                 printk("OBD ioctl: pbuf2 pointer but 0 length\n");
 335                 return 1;
 336         }
 337         if (obd_ioctl_packlen(data) != data->ioc_len ) {
 338                 printk("OBD ioctl: packlen exceeds ioc_len\n");
 339                 return 1;
 340         }
 341         if (data->ioc_inllen1 &&
 342             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
 343                 printk("OBD ioctl: inlbuf1 not 0 terminated\n");
 344                 return 1;
 345         }
 346         if (data->ioc_inllen2 &&
 347             data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') {
 348                 printk("OBD ioctl: inlbuf2 not 0 terminated\n");
 349                 return 1;
 350         }
 351         return 0;
 352 }
 353
 354 #ifndef __KERNEL__
 355 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max)
 356 {
 357         char *ptr;
 358         struct obd_ioctl_data *overlay;
 359         data->ioc_len = obd_ioctl_packlen(data);
 360         data->ioc_version = OBD_IOCTL_VERSION;
 361
 362         if (*pbuf && obd_ioctl_packlen(data) > max)
 363                 return 1;
 364         if (*pbuf == NULL) {
 365                 *pbuf = malloc(data->ioc_len);
 366         }
 367         if (!*pbuf)
 368                 return 1;
 369         overlay = (struct obd_ioctl_data *)*pbuf;
 370         memcpy(*pbuf, data, sizeof(*data));
 371
 372         ptr = overlay->ioc_bulk;
 373         if (data->ioc_inlbuf1)
 374                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 375         if (data->ioc_inlbuf2)
 376                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 377         if (obd_ioctl_is_invalid(overlay))
 378                 return 1;
 379
 380         return 0;
 381 }
 382 #else
 383
 384
 385 /* buffer MUST be at least the size of obd_ioctl_hdr */
 386 static inline int obd_ioctl_getdata(char *buf, char *end, void *arg)
 387 {
 388         struct obd_ioctl_hdr *hdr;
 389         struct obd_ioctl_data *data;
 390         int err;
 391         ENTRY;
 392
 393         hdr = (struct obd_ioctl_hdr *)buf;
 394         data = (struct obd_ioctl_data *)buf;
 395
 396         err = copy_from_user(buf, (void *)arg, sizeof(*hdr));
 397         if ( err ) {
 398                 EXIT;
 399                 return err;
 400         }
 401
 402         if (hdr->ioc_version != OBD_IOCTL_VERSION) {
 403                 printk("OBD: version mismatch kernel vs application\n");
 404                 return -EINVAL;
 405         }
 406
 407         if (hdr->ioc_len + buf >= end) {
 408                 printk("OBD: user buffer exceeds kernel buffer\n");
 409                 return -EINVAL;
 410         }
 411
 412
 413         if (hdr->ioc_len < sizeof(struct obd_ioctl_data)) {
 414                 printk("OBD: user buffer too small for ioctl\n");
 415                 return -EINVAL;
 416         }
 417
 418         err = copy_from_user(buf, (void *)arg, hdr->ioc_len);
 419         if ( err ) {
 420                 EXIT;
 421                 return err;
 422         }
 423
 424         if (obd_ioctl_is_invalid(data)) {
 425                 printk("OBD: ioctl not correctly formatted\n");
 426                 return -EINVAL;
 427         }
 428
 429         if (data->ioc_inllen1) {
 430                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 431         }
 432
 433         if (data->ioc_inllen2) {
 434                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
 435         }
 436
 437         EXIT;
 438         return 0;
 439 }
 440 #endif
 441
 442
 443 #define OBD_IOC_CREATE                 _IOR ('f',  3, long)
 444 #define OBD_IOC_SETUP                  _IOW ('f',  4, long)
 445 #define OBD_IOC_CLEANUP                _IO  ('f',  5      )
 446 #define OBD_IOC_DESTROY                _IOW ('f',  6, long)
 447 #define OBD_IOC_PREALLOCATE            _IOWR('f',  7, long)
 448 #define OBD_IOC_DEC_USE_COUNT          _IO  ('f',  8      )
 449 #define OBD_IOC_SETATTR                _IOW ('f',  9, long)
 450 #define OBD_IOC_GETATTR                _IOR ('f', 10, long)
 451 #define OBD_IOC_READ                   _IOWR('f', 11, long)
 452 #define OBD_IOC_WRITE                  _IOWR('f', 12, long)
 453 #define OBD_IOC_CONNECT                _IOR ('f', 13, long)
 454 #define OBD_IOC_DISCONNECT             _IOW ('f', 14, long)
 455 #define OBD_IOC_STATFS                 _IOWR('f', 15, long)
 456 #define OBD_IOC_SYNC                   _IOR ('f', 16, long)
 457 #define OBD_IOC_READ2                  _IOWR('f', 17, long)
 458 #define OBD_IOC_FORMAT                 _IOWR('f', 18, long)
 459 #define OBD_IOC_PARTITION              _IOWR('f', 19, long)
 460 #define OBD_IOC_ATTACH                 _IOWR('f', 20, long)
 461 #define OBD_IOC_DETACH                 _IOWR('f', 21, long)
 462 #define OBD_IOC_COPY                   _IOWR('f', 22, long)
 463 #define OBD_IOC_MIGR                   _IOWR('f', 23, long)
 464 #define OBD_IOC_PUNCH                  _IOWR('f', 24, long)
 465 #define OBD_IOC_DEVICE                 _IOWR('f', 25, long)
 466
 467 #define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 32      )
 468
 469
 470
 471 #endif