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
  27 #ifdef __KERNEL__
  28 # include <linux/ioctl.h>
  29 # include <asm/types.h>
  30 # include <linux/types.h>
  31 # include <linux/list.h>
  32 #else
  33 # define __KERNEL__
  34 # include <linux/list.h>
  35 # undef __KERNEL__
  36 # include <stdint.h>
  37 #endif
  38 /*
  39  * this file contains all data structures used in Lustre interfaces:
  40  * - obdo and obd_request records
  41  * - mds_request records
  42  * - ldlm data
  43  * - ioctl's
  44  */
  45
  46 /*
  47  *  GENERAL STUFF
  48  */
  49 typedef __u8 uuid_t[37];
  50
  51 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
  52  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
  53  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
  54  */
  55
  56 #define CONNMGR_REQUEST_PORTAL  1
  57 #define CONNMGR_REPLY_PORTAL    2
  58 #define OSC_REQUEST_PORTAL      3
  59 #define OSC_REPLY_PORTAL        4
  60 #define OSC_BULK_PORTAL         5
  61 #define OST_REQUEST_PORTAL      6
  62 #define OST_REPLY_PORTAL        7
  63 #define OST_BULK_PORTAL         8
  64 #define MDC_REQUEST_PORTAL      9
  65 #define MDC_REPLY_PORTAL        10
  66 #define MDC_BULK_PORTAL         11
  67 #define MDS_REQUEST_PORTAL      12
  68 #define MDS_REPLY_PORTAL        13
  69 #define MDS_BULK_PORTAL         14
  70 #define LDLM_REQUEST_PORTAL     15
  71 #define LDLM_REPLY_PORTAL       16
  72 #define LDLM_CLI_REQUEST_PORTAL 17
  73 #define LDLM_CLI_REPLY_PORTAL   18
  74
  75 #define SVC_KILLED               1
  76 #define SVC_EVENT                2
  77 #define SVC_SIGNAL               4
  78 #define SVC_RUNNING              8
  79 #define SVC_STOPPING            16
  80 #define SVC_STOPPED             32
  81
  82 #define RECOVD_STOPPING          1  /* how cleanup tells recovd to quit */
  83 #define RECOVD_IDLE              2  /* normal state */
  84 #define RECOVD_STOPPED           4  /* after recovd has stopped */
  85 #define RECOVD_FAIL              8  /* RPC timeout: wakeup recovd, sets flag */
  86 #define RECOVD_TIMEOUT          16  /* set when recovd detects a timeout */
  87 #define RECOVD_UPCALL_WAIT      32  /* an upcall has been placed */
  88 #define RECOVD_UPCALL_ANSWER    64  /* an upcall has been answered */
  89
  90 #define LUSTRE_CONN_NEW          1
  91 #define LUSTRE_CONN_CON          2
  92 #define LUSTRE_CONN_RECOVD       3
  93 #define LUSTRE_CONN_FULL         4
  94
  95 /* packet types */
  96 #define PTL_RPC_MSG_REQUEST 4711
  97 #define PTL_RPC_MSG_ERR 4712
  98 #define PTL_RPC_MSG_OK           0
  99
 100 #define PTL_RPC_TYPE_REQUEST     2
 101 #define PTL_RPC_TYPE_REPLY       3
 102
 103 #define PTLRPC_MSG_MAGIC (cpu_to_le32(0x0BD00BD0))
 104 #define PTLRPC_MSG_VERSION (cpu_to_le32(0x00040001))
 105
 106 struct lustre_handle {
 107         __u64 addr;
 108         __u64 cookie;
 109 };
 110
 111 /* we depend on this structure to be 8-byte aligned */
 112 struct lustre_msg {
 113         __u64 addr;
 114         __u64 cookie; /* security token */
 115         __u32 magic;
 116         __u32 type;
 117         __u32 version;
 118         __u32 opc;
 119         __u64 last_rcvd;
 120         __u64 last_committed;
 121         __u64 transno;
 122         __u32 status;
 123         __u32   bufcount;
 124         __u32   buflens[0];
 125 };
 126
 127 #define CONNMGR_REPLY   0
 128 #define CONNMGR_CONNECT 1
 129
 130 /*
 131  *   OST requests: OBDO & OBD request records
 132  */
 133
 134 /* opcodes */
 135 #define OST_REPLY      0        /* reply ? */
 136 #define OST_GETATTR    1
 137 #define OST_SETATTR    2
 138 #define OST_READ       3
 139 #define OST_WRITE      4
 140 #define OST_CREATE     5
 141 #define OST_DESTROY    6
 142 #define OST_GET_INFO   7
 143 #define OST_CONNECT    8
 144 #define OST_DISCONNECT 9
 145 #define OST_PUNCH      10
 146 #define OST_OPEN       11
 147 #define OST_CLOSE      12
 148 #define OST_STATFS     13
 149
 150
 151 typedef uint64_t        obd_id;
 152 typedef uint64_t        obd_gr;
 153 typedef uint64_t        obd_time;
 154 typedef uint64_t        obd_size;
 155 typedef uint64_t        obd_off;
 156 typedef uint64_t        obd_blocks;
 157 typedef uint32_t        obd_blksize;
 158 typedef uint32_t        obd_mode;
 159 typedef uint32_t        obd_uid;
 160 typedef uint32_t        obd_gid;
 161 typedef uint64_t        obd_rdev;
 162 typedef uint32_t        obd_flag;
 163 typedef uint32_t        obd_count;
 164
 165 #define OBD_FL_INLINEDATA       (0x00000001)
 166 #define OBD_FL_OBDMDEXISTS      (0x00000002)
 167 #define OBD_FL_CREATEONOPEN     (0x00000004)
 168
 169 #define OBD_INLINESZ    60
 170 #define OBD_OBDMDSZ     60
 171 /* Note: 64-bit types are 64-bit aligned in structure */
 172 struct obdo {
 173         obd_id                  o_id;
 174         obd_gr                  o_gr;
 175         obd_time                o_atime;
 176         obd_time                o_mtime;
 177         obd_time                o_ctime;
 178         obd_size                o_size;
 179         obd_blocks              o_blocks;
 180         obd_rdev                o_rdev;
 181         obd_blksize             o_blksize;
 182         obd_mode                o_mode;
 183         obd_uid                 o_uid;
 184         obd_gid                 o_gid;
 185         obd_flag                o_flags;
 186         obd_count               o_nlink;
 187         obd_count               o_generation;
 188         obd_flag                o_valid;        /* hot fields in this obdo */
 189         obd_flag                o_obdflags;
 190         __u32                   o_easize;
 191         char                    o_inline[OBD_INLINESZ];
 192 };
 193
 194 struct lov_object_id { /* per-child structure */
 195         __u64 l_object_id;
 196 };
 197
 198 struct lov_stripe_md {
 199         __u64 lmd_magic;
 200         __u64 lmd_object_id;     /* lov object id */
 201         __u64 lmd_stripe_count;
 202         __u32 lmd_size;
 203         __u32 lmd_stripe_size;
 204         __u32 lmd_stripe_pattern;  /* per-lov object stripe pattern */
 205         struct lov_object_id lmd_objects[0];
 206 };
 207
 208 #define OBD_MD_FLALL    (0xffffffff)
 209 #define OBD_MD_FLID     (0x00000001)
 210 #define OBD_MD_FLATIME  (0x00000002)
 211 #define OBD_MD_FLMTIME  (0x00000004)
 212 #define OBD_MD_FLCTIME  (0x00000008)
 213 #define OBD_MD_FLSIZE   (0x00000010)
 214 #define OBD_MD_FLBLOCKS (0x00000020)
 215 #define OBD_MD_FLBLKSZ  (0x00000040)
 216 #define OBD_MD_FLMODE   (0x00000080)
 217 #define OBD_MD_FLTYPE   (0x00000100)
 218 #define OBD_MD_FLUID    (0x00000200)
 219 #define OBD_MD_FLGID    (0x00000400)
 220 #define OBD_MD_FLFLAGS  (0x00000800)
 221 #define OBD_MD_FLOBDFLG (0x00001000)
 222 #define OBD_MD_FLNLINK  (0x00002000)
 223 #define OBD_MD_FLGENER  (0x00004000)
 224 #define OBD_MD_FLINLINE (0x00008000)
 225 #define OBD_MD_FLRDEV   (0x00010000)
 226 #define OBD_MD_FLOBJID  (0x00020000)
 227 #define OBD_MD_LINKNAME (0x00040000)
 228 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLOBDFLG | OBD_MD_FLBLOCKS | OBD_MD_LINKNAME))
 229
 230 struct obd_statfs {
 231         __u64           os_type;
 232         __u64           os_blocks;
 233         __u64           os_bfree;
 234         __u64           os_bavail;
 235         __u64           os_files;
 236         __u64           os_ffree;
 237         __u8            os_fsid[40];
 238         __u32           os_bsize;
 239         __u32           os_namelen;
 240         __u32           os_spare[12];
 241 };
 242
 243 /* ost_body.data values for OST_BRW */
 244
 245 #define OBD_BRW_READ    0x1
 246 #define OBD_BRW_WRITE   0x2
 247 #define OBD_BRW_RWMASK  (OBD_BRW_READ | OBD_BRW_WRITE)
 248 #define OBD_BRW_CREATE  0x4
 249
 250 struct obd_ioobj {
 251         obd_id    ioo_id;
 252         obd_gr    ioo_gr;
 253         __u32     ioo_type;
 254         __u32     ioo_bufcnt;
 255 };
 256
 257 struct niobuf_remote {
 258         __u64 offset;
 259         __u32 len;
 260         __u32 xid;
 261         __u32 flags;
 262 };
 263
 264 #define CONNMGR_REPLY   0
 265 #define CONNMGR_CONNECT 1
 266
 267 struct connmgr_body {
 268         __u64 conn;
 269         __u64 conn_token;
 270         __u32 generation;
 271         __u8  conn_uuid[37];
 272 };
 273
 274 /* request structure for OST's */
 275
 276 #define OST_REQ_HAS_OA1  0x1
 277
 278 struct ost_body {
 279         struct  obdo oa;
 280 };
 281
 282 /*
 283  *   MDS REQ RECORDS
 284  */
 285
 286 /* opcodes */
 287 #define MDS_GETATTR    1
 288 #define MDS_OPEN       2
 289 #define MDS_CLOSE      3
 290 #define MDS_REINT      4
 291 #define MDS_READPAGE   6
 292 #define MDS_CONNECT    7
 293 #define MDS_DISCONNECT 8
 294 #define MDS_GETSTATUS  9
 295 #define MDS_STATFS     10
 296 #define MDS_GETLOVINFO 11
 297
 298 #define REINT_SETATTR  1
 299 #define REINT_CREATE   2
 300 #define REINT_LINK     3
 301 #define REINT_UNLINK   4
 302 #define REINT_RENAME   5
 303 #define REINT_RECREATE 6
 304 #define REINT_MAX      6
 305
 306 struct ll_fid {
 307         __u64 id;
 308         __u32 generation;
 309         __u32 f_type;
 310 };
 311
 312
 313 #define MDS_STATUS_CONN 1
 314 #define MDS_STATUS_LOV 2
 315
 316 struct mds_status_req {
 317         __u32  flags;
 318         __u32  repbuf;
 319 };
 320
 321 struct mds_conn_status {
 322         struct ll_fid rootfid;
 323         __u64          xid;
 324         __u64          last_committed;
 325         __u64          last_rcvd;
 326         /* XXX preallocated quota & obj fields here */
 327 };
 328
 329 struct mds_body {
 330         struct ll_fid  fid1;
 331         struct ll_fid  fid2;
 332         __u64          size;
 333         __u64          extra;
 334         __u32          valid;
 335         __u32          mode;
 336         __u32          uid;
 337         __u32          gid;
 338         __u32          mtime;
 339         __u32          ctime;
 340         __u32          atime;
 341         __u32          flags;
 342         __u32          major;
 343         __u32          minor;
 344         __u32          ino;
 345         __u32          nlink;
 346         __u32          generation;
 347         __u32          last_xid;
 348 };
 349
 350 /* MDS update records */
 351 struct mds_update_record_hdr {
 352         __u32 ur_opcode;
 353 };
 354
 355 struct mds_rec_setattr {
 356         __u32           sa_opcode;
 357         struct ll_fid   sa_fid;
 358         __u32           sa_valid;
 359         __u32           sa_mode;
 360         __u32           sa_uid;
 361         __u32           sa_gid;
 362         __u64           sa_size;
 363         __u64           sa_atime;
 364         __u64           sa_mtime;
 365         __u64           sa_ctime;
 366         __u32           sa_attr_flags;
 367 };
 368
 369 struct mds_rec_create {
 370         __u32           cr_opcode;
 371         struct ll_fid   cr_fid;
 372         __u32           cr_uid;
 373         __u32           cr_gid;
 374         __u64           cr_time;
 375         __u32           cr_mode;
 376         __u64           cr_rdev;
 377 };
 378
 379 struct mds_rec_link {
 380         __u32           lk_opcode;
 381         struct ll_fid   lk_fid1;
 382         struct ll_fid   lk_fid2;
 383 };
 384
 385 struct mds_rec_unlink {
 386         __u32           ul_opcode;
 387         struct ll_fid   ul_fid1;
 388         struct ll_fid   ul_fid2;
 389 };
 390
 391 struct mds_rec_rename {
 392         __u32           rn_opcode;
 393         struct ll_fid   rn_fid1;
 394         struct ll_fid   rn_fid2;
 395 };
 396
 397
 398 /*
 399  *  LOV data structures
 400  */
 401
 402 #define LOV_RAID0  0
 403 struct lov_desc {
 404         __u32 ld_tgt_count; /* how many OBD's */
 405         __u32 ld_default_stripecount;
 406         __u32 ld_default_stripesize;   /* in bytes */
 407         __u32 ld_pattern; /* RAID 0,1 etc */
 408          uuid_t ld_uuid;
 409 };
 410
 411 /*
 412  *   LDLM requests:
 413  */
 414
 415 /* opcodes */
 416 #define LDLM_REPLY         0
 417 #define LDLM_ENQUEUE       1
 418 #define LDLM_CONVERT       2
 419 #define LDLM_CANCEL        3
 420 #define LDLM_CALLBACK      4
 421
 422 #define RES_NAME_SIZE 3
 423 #define RES_VERSION_SIZE 4
 424
 425 /* lock types */
 426 typedef enum {
 427         LCK_EX = 1,
 428         LCK_PW,
 429         LCK_PR,
 430         LCK_CW,
 431         LCK_CR,
 432         LCK_NL
 433 } ldlm_mode_t;
 434
 435 struct ldlm_extent {
 436         __u64 start;
 437         __u64 end;
 438 };
 439
 440 struct ldlm_intent {
 441         __u64 opc;
 442 };
 443
 444 struct ldlm_resource_desc {
 445         __u32 lr_type;
 446         __u64 lr_name[RES_NAME_SIZE];
 447         __u32 lr_version[RES_VERSION_SIZE];
 448 };
 449
 450 struct ldlm_lock_desc {
 451         struct ldlm_resource_desc l_resource;
 452         ldlm_mode_t l_req_mode;
 453         ldlm_mode_t l_granted_mode;
 454         struct ldlm_extent l_extent;
 455         __u32 l_version[RES_VERSION_SIZE];
 456 };
 457
 458 struct ldlm_request {
 459         __u32 lock_flags;
 460         struct ldlm_lock_desc lock_desc;
 461         struct lustre_handle lock_handle1;
 462         struct lustre_handle lock_handle2;
 463 };
 464
 465 struct ldlm_reply {
 466         __u32 lock_flags;
 467         __u64 lock_resource_name[RES_NAME_SIZE];
 468         struct lustre_handle lock_handle;
 469         struct ldlm_extent lock_extent;   /* XXX make this policy 1 &2 */
 470         __u64  lock_policy_res1;
 471         __u64  lock_policy_res2;
 472 };
 473 #endif