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 /*
  46  *   OST requests: OBDO & OBD request records
  47  */
  48
  49 /* opcodes */
  50 #define OST_GETATTR    1
  51 #define OST_SETATTR    2
  52 #define OST_BRW        3
  53 #define OST_CREATE     4
  54 #define OST_DESTROY    5
  55 #define OST_GET_INFO   6
  56 #define OST_CONNECT    7
  57 #define OST_DISCONNECT 8
  58 #define OST_PUNCH      9
  59 #define OST_OPEN      10
  60 #define OST_CLOSE     11
  61
  62 /* packet types */
  63 #define OST_TYPE_REQ 1
  64 #define OST_TYPE_REP 2
  65 #define OST_TYPE_ERR 3
  66
  67 struct ptlreq_hdr {
  68         __u32 opc;
  69         __u32 xid;
  70         __u32 status;
  71         __u32 type;
  72 };
  73
  74 struct ptlrep_hdr {
  75         __u32 opc;
  76         __u32 xid;
  77         __u32 status;
  78         __u32 type;
  79 };
  80
  81 typedef uint64_t        obd_id;
  82 typedef uint64_t        obd_gr;
  83 typedef uint64_t        obd_time;
  84 typedef uint64_t        obd_size;
  85 typedef uint64_t        obd_off;
  86 typedef uint64_t        obd_blocks;
  87 typedef uint32_t        obd_blksize;
  88 typedef uint32_t        obd_mode;
  89 typedef uint32_t        obd_uid;
  90 typedef uint32_t        obd_gid;
  91 typedef uint32_t        obd_rdev;
  92 typedef uint32_t        obd_flag;
  93 typedef uint32_t        obd_count;
  94
  95 #define OBD_FL_INLINEDATA       (0x00000001UL)
  96 #define OBD_FL_OBDMDEXISTS      (0x00000002UL)
  97
  98 #define OBD_INLINESZ    60
  99 #define OBD_OBDMDSZ     60
 100 /* Note: 64-bit types are 64-bit aligned in structure */
 101 struct obdo {
 102         obd_id                  o_id;
 103         obd_gr                  o_gr;
 104         obd_time                o_atime;
 105         obd_time                o_mtime;
 106         obd_time                o_ctime;
 107         obd_size                o_size;
 108         obd_blocks              o_blocks;
 109         obd_blksize             o_blksize;
 110         obd_mode                o_mode;
 111         obd_uid                 o_uid;
 112         obd_gid                 o_gid;
 113         obd_flag                o_flags;
 114         obd_flag                o_obdflags;
 115         obd_count               o_nlink;
 116         obd_count               o_generation;
 117         obd_flag                o_valid;        /* hot fields in this obdo */
 118         char                    o_inline[OBD_INLINESZ];
 119         char                    o_obdmd[OBD_OBDMDSZ];
 120         struct list_head        o_list;
 121         struct obd_ops          *o_op;
 122 };
 123
 124 #define OBD_MD_FLALL    (~0UL)
 125 #define OBD_MD_FLID     (0x00000001UL)
 126 #define OBD_MD_FLATIME  (0x00000002UL)
 127 #define OBD_MD_FLMTIME  (0x00000004UL)
 128 #define OBD_MD_FLCTIME  (0x00000008UL)
 129 #define OBD_MD_FLSIZE   (0x00000010UL)
 130 #define OBD_MD_FLBLOCKS (0x00000020UL)
 131 #define OBD_MD_FLBLKSZ  (0x00000040UL)
 132 #define OBD_MD_FLMODE   (0x00000080UL)
 133 #define OBD_MD_FLTYPE   (0x00000100UL)
 134 #define OBD_MD_FLUID    (0x00000200UL)
 135 #define OBD_MD_FLGID    (0x00000400UL)
 136 #define OBD_MD_FLFLAGS  (0x00000800UL)
 137 #define OBD_MD_FLOBDFLG (0x00001000UL)
 138 #define OBD_MD_FLNLINK  (0x00002000UL)
 139 #define OBD_MD_FLGENER  (0x00004000UL)
 140 #define OBD_MD_FLINLINE (0x00008000UL)
 141 #define OBD_MD_FLOBDMD  (0x00010000UL)
 142 #define OBD_MD_FLOBJID  (0x00020000UL)
 143 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDMD | OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS))
 144
 145 /* request structure for OST's */
 146
 147 #define OST_REQ_HAS_OA1  0x1
 148
 149 struct ost_req {
 150         __u32   connid;
 151         __u32   cmd;
 152         struct  obdo oa;
 153         __u32   buflen1;
 154         __u32   buflen2;
 155 };
 156
 157 struct ost_rep {
 158         __u32   result;
 159         __u32   connid;
 160         struct  obdo oa;
 161         __u32   buflen1;
 162         __u32   buflen2;
 163 };
 164
 165 struct obd_ioobj {
 166         obd_id    ioo_id;
 167         obd_gr    ioo_gr;
 168         __u32     ioo_type;
 169         __u32     ioo_bufcnt;
 170 };
 171
 172
 173 /*
 174  *   MDS REQ RECORDS
 175  */
 176
 177
 178 #define MDS_TYPE_REQ 1
 179 #define MDS_TYPE_REP 2
 180 #define MDS_TYPE_ERR 3
 181
 182 #define MDS_GETATTR   1
 183 #define MDS_OPEN      2
 184 #define MDS_CLOSE     3
 185 #define MDS_REINT     4
 186 #define MDS_READPAGE  5
 187
 188 #define REINT_SETATTR 0
 189 #define REINT_CREATE  1
 190 #define REINT_LINK    2
 191 #define REINT_UNLINK  3
 192 #define REINT_RENAME  4
 193 #define REINT_MAX     4
 194
 195 struct ll_fid {
 196         __u64 id;
 197         __u32 generation;
 198         __u32 f_type;
 199 };
 200
 201 struct niobuf {
 202         __u64 addr;
 203         __u64 offset;
 204         __u32 len;
 205         __u32 flags;
 206         __u32 xid;
 207         void *page;
 208 };
 209
 210 struct mds_req {
 211         struct ll_fid        fid1;
 212         struct ll_fid        fid2;
 213         __u32                       namelen;
 214         __u32                       tgtlen;
 215         __u32                       opcode;
 216         __u32                       valid;
 217         __u32                       mode;
 218         __u32                       uid;
 219         __u32                       gid;
 220         __u64                       size;
 221         __u32                       mtime;
 222         __u32                       ctime;
 223         __u32                       atime;
 224         __u32                       flags;
 225         __u32                       major;
 226         __u32                       minor;
 227         __u32                       ino;
 228         __u32                       nlink;
 229         __u32                       generation;
 230         __u64                       objid;
 231 };
 232
 233 struct mds_rep {
 234         struct ll_fid               fid1;
 235         struct ll_fid               fid2;
 236         __u32                       namelen;
 237         __u32                       tgtlen;
 238         __u32                       valid;
 239         __u32                       mode;
 240         __u32                       uid;
 241         __u32                       gid;
 242         __u64                       size;
 243         __u32                       mtime;
 244         __u32                       ctime;
 245         __u32                       atime;
 246         __u32                       flags;
 247         __u32                       major;
 248         __u32                       minor;
 249         __u32                       ino;
 250         __u32                       nlink;
 251         __u32                       generation;
 252         __u64                       objid;
 253 };
 254
 255 /* MDS update records */
 256 struct mds_update_record_hdr {
 257         __u32 ur_reclen;
 258         __u32 ur_opcode;
 259 };
 260
 261 struct mds_rec_setattr {
 262         __u32           sa_reclen;
 263         __u32           sa_opcode;
 264         struct ll_fid   sa_fid;
 265         __u32           sa_valid;
 266         __u32           sa_mode;
 267         __u32           sa_uid;
 268         __u32           sa_gid;
 269         __u64           sa_size;
 270         __u64           sa_atime;
 271         __u64           sa_mtime;
 272         __u64           sa_ctime;
 273         __u32           sa_attr_flags;
 274 };
 275
 276 struct mds_rec_create {
 277         __u32           cr_reclen;
 278         __u32           cr_opcode;
 279         struct ll_fid   cr_fid;
 280         __u32           cr_uid;
 281         __u32           cr_gid;
 282         __u64           cr_time;
 283         __u32           cr_mode;
 284         /* overloaded: id for create, tgtlen for symlink, rdev for mknod */
 285         __u64           cr_id;
 286         __u32           cr_namelen;
 287         __u32           cr_tgtlen;
 288         /* name here */
 289         /* symlink target here */
 290 };
 291
 292 struct mds_rec_link {
 293         __u32           lk_reclen;
 294         __u32           lk_opcode;
 295         struct ll_fid   lk_fid1;
 296         struct ll_fid   lk_fid2;
 297         __u32           lk_namelen;
 298 };
 299
 300 struct mds_rec_unlink {
 301         __u32           ul_reclen;
 302         __u32           ul_opcode;
 303         struct ll_fid   ul_fid1;
 304         __u32           ul_namelen;
 305 };
 306
 307 struct mds_rec_rename {
 308         __u32           rn_reclen;
 309         __u32           rn_opcode;
 310         struct ll_fid   rn_fid1;
 311         struct ll_fid   rn_fid2;
 312         __u32           rn_namelen;
 313         __u32           rn_tgtlen;
 314 };
 315
 316 #ifdef __KERNEL__
 317
 318 static inline void ll_ino2fid(struct ll_fid *fid, ino_t ino, __u32 generation, int type)
 319 {
 320         fid->id = HTON__u64((__u64)ino);
 321         fid->generation = HTON__u32(generation);
 322         fid->f_type = HTON__u32(type);
 323 }
 324
 325 static inline void ll_inode2fid(struct ll_fid *fid, struct inode *inode)
 326 {
 327         fid->id = HTON__u64((__u64)inode->i_ino);
 328         fid->generation = HTON__u32(inode->i_generation);
 329         fid->f_type = HTON__u32(inode->i_mode & S_IFMT);
 330 }
 331
 332 #endif
 333
 334 /*
 335  *   OBD IOCTLS
 336  */
 337
 338
 339 #define OBD_IOCTL_VERSION 0x00010001
 340
 341 struct obd_ioctl_data {
 342         uint32_t ioc_len;
 343         uint32_t ioc_version;
 344         uint32_t ioc_conn1;
 345         uint32_t ioc_conn2;
 346         struct obdo ioc_obdo1;
 347         struct obdo ioc_obdo2;
 348         obd_size         ioc_count;
 349         obd_off          ioc_offset;
 350         uint32_t         ioc_dev;
 351
 352         /* buffers the kernel will treat as user pointers */
 353         uint32_t ioc_plen1;
 354         char    *ioc_pbuf1;
 355         uint32_t ioc_plen2;
 356         char    *ioc_pbuf2;
 357
 358         /* two inline buffers */
 359         uint32_t ioc_inllen1;
 360         char    *ioc_inlbuf1;
 361         uint32_t ioc_inllen2;
 362         char    *ioc_inlbuf2;
 363
 364         char    ioc_bulk[0];
 365 };
 366
 367 struct obd_ioctl_hdr {
 368         uint32_t ioc_len;
 369         uint32_t ioc_version;
 370 };
 371
 372 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
 373 {
 374         int len = sizeof(struct obd_ioctl_data);
 375         len += size_round(data->ioc_inllen1);
 376         len += size_round(data->ioc_inllen2);
 377         return len;
 378 }
 379
 380 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 381 {
 382         if (data->ioc_len > (1<<30)) {
 383                 printk("OBD ioctl: ioc_len larger than 1<<30\n");
 384                 return 1;
 385         }
 386         if (data->ioc_inllen1 > (1<<30)) {
 387                 printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
 388                 return 1;
 389         }
 390         if (data->ioc_inllen2 > (1<<30)) {
 391                 printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
 392                 return 1;
 393         }
 394         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 395                 printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
 396                 return 1;
 397         }
 398         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 399                 printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
 400                 return 1;
 401         }
 402         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 403                 printk("OBD ioctl: pbuf1 pointer but 0 length\n");
 404                 return 1;
 405         }
 406         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 407                 printk("OBD ioctl: pbuf2 pointer but 0 length\n");
 408                 return 1;
 409         }
 410         /*
 411         if (data->ioc_inllen1 && !data->ioc_inlbuf1) {
 412                 printk("OBD ioctl: inllen1 set but NULL pointer\n");
 413                 return 1;
 414         }
 415         if (data->ioc_inllen2 && !data->ioc_inlbuf2) {
 416                 printk("OBD ioctl: inllen2 set but NULL pointer\n");
 417                 return 1;
 418         }
 419         if (data->ioc_plen1 && !data->ioc_pbuf1) {
 420                 printk("OBD ioctl: plen1 set but NULL pointer\n");
 421                 return 1;
 422         }
 423         if (data->ioc_plen2 && !data->ioc_pbuf2) {
 424                 printk("OBD ioctl: plen2 set but NULL pointer\n");
 425                 return 1;
 426         }
 427         */
 428         if (obd_ioctl_packlen(data) != data->ioc_len ) {
 429                 printk("OBD ioctl: packlen exceeds ioc_len\n");
 430                 return 1;
 431         }
 432         if (data->ioc_inllen1 &&
 433             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
 434                 printk("OBD ioctl: inlbuf1 not 0 terminated\n");
 435                 return 1;
 436         }
 437         if (data->ioc_inllen2 &&
 438             data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') {
 439                 printk("OBD ioctl: inlbuf2 not 0 terminated\n");
 440                 return 1;
 441         }
 442         return 0;
 443 }
 444
 445 #ifndef __KERNEL__
 446 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max)
 447 {
 448         char *ptr;
 449         struct obd_ioctl_data *overlay;
 450         data->ioc_len = obd_ioctl_packlen(data);
 451         data->ioc_version = OBD_IOCTL_VERSION;
 452
 453         if (*pbuf && obd_ioctl_packlen(data) > max)
 454                 return 1;
 455         if (*pbuf == NULL) {
 456                 *pbuf = malloc(data->ioc_len);
 457         }
 458         if (!*pbuf)
 459                 return 1;
 460         overlay = (struct obd_ioctl_data *)*pbuf;
 461         memcpy(*pbuf, data, sizeof(*data));
 462
 463         ptr = overlay->ioc_bulk;
 464         if (data->ioc_inlbuf1)
 465                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 466         if (data->ioc_inlbuf2)
 467                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 468         if (obd_ioctl_is_invalid(overlay))
 469                 return 1;
 470
 471         return 0;
 472 }
 473 #else
 474
 475
 476 /* buffer MUST be at least the size of obd_ioctl_hdr */
 477 static inline int obd_ioctl_getdata(char *buf, char *end, void *arg)
 478 {
 479         struct obd_ioctl_hdr *hdr;
 480         struct obd_ioctl_data *data;
 481         int err;
 482         ENTRY;
 483
 484         hdr = (struct obd_ioctl_hdr *)buf;
 485         data = (struct obd_ioctl_data *)buf;
 486
 487         err = copy_from_user(buf, (void *)arg, sizeof(*hdr));
 488         if ( err ) {
 489                 EXIT;
 490                 return err;
 491         }
 492
 493         if (hdr->ioc_version != OBD_IOCTL_VERSION) {
 494                 printk("OBD: version mismatch kernel vs application\n");
 495                 return -EINVAL;
 496         }
 497
 498         if (hdr->ioc_len + buf >= end) {
 499                 printk("OBD: user buffer exceeds kernel buffer\n");
 500                 return -EINVAL;
 501         }
 502
 503
 504         if (hdr->ioc_len < sizeof(struct obd_ioctl_data)) {
 505                 printk("OBD: user buffer too small for ioctl\n");
 506                 return -EINVAL;
 507         }
 508
 509         err = copy_from_user(buf, (void *)arg, hdr->ioc_len);
 510         if ( err ) {
 511                 EXIT;
 512                 return err;
 513         }
 514
 515         if (obd_ioctl_is_invalid(data)) {
 516                 printk("OBD: ioctl not correctly formatted\n");
 517                 return -EINVAL;
 518         }
 519
 520         if (data->ioc_inllen1) {
 521                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 522         }
 523
 524         if (data->ioc_inllen2) {
 525                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
 526         }
 527
 528         EXIT;
 529         return 0;
 530 }
 531 #endif
 532
 533
 534 #define OBD_IOC_CREATE                 _IOR ('f',  3, long)
 535 #define OBD_IOC_SETUP                  _IOW ('f',  4, long)
 536 #define OBD_IOC_CLEANUP                _IO  ('f',  5      )
 537 #define OBD_IOC_DESTROY                _IOW ('f',  6, long)
 538 #define OBD_IOC_PREALLOCATE            _IOWR('f',  7, long)
 539 #define OBD_IOC_DEC_USE_COUNT          _IO  ('f',  8      )
 540 #define OBD_IOC_SETATTR                _IOW ('f',  9, long)
 541 #define OBD_IOC_GETATTR                _IOR ('f', 10, long)
 542 #define OBD_IOC_READ                   _IOWR('f', 11, long)
 543 #define OBD_IOC_WRITE                  _IOWR('f', 12, long)
 544 #define OBD_IOC_CONNECT                _IOR ('f', 13, long)
 545 #define OBD_IOC_DISCONNECT             _IOW ('f', 14, long)
 546 #define OBD_IOC_STATFS                 _IOWR('f', 15, long)
 547 #define OBD_IOC_SYNC                   _IOR ('f', 16, long)
 548 #define OBD_IOC_READ2                  _IOWR('f', 17, long)
 549 #define OBD_IOC_FORMAT                 _IOWR('f', 18, long)
 550 #define OBD_IOC_PARTITION              _IOWR('f', 19, long)
 551 #define OBD_IOC_ATTACH                 _IOWR('f', 20, long)
 552 #define OBD_IOC_DETACH                 _IOWR('f', 21, long)
 553 #define OBD_IOC_COPY                   _IOWR('f', 22, long)
 554 #define OBD_IOC_MIGR                   _IOWR('f', 23, long)
 555 #define OBD_IOC_PUNCH                  _IOWR('f', 24, long)
 556 #define OBD_IOC_DEVICE                 _IOWR('f', 25, long)
 557 #define OBD_IOC_MODULE_DEBUG           _IOWR('f', 26, long)
 558 #define OBD_IOC_BRW_READ               _IOWR('f', 27, long)
 559 #define OBD_IOC_BRW_WRITE              _IOWR('f', 28, long)
 560
 561 #define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 32      )
 562
 563
 564 /* GENERAL THINGS */
 565 union ptl_rep {
 566         struct mds_rep *mds;
 567         struct ost_rep *ost;
 568 };
 569
 570 union ptl_req {
 571         struct mds_req *mds;
 572         struct ost_req *ost;
 573 };
 574
 575
 576 #endif