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  * Lustre wire protocol definitions.
  22  *
  23  * All structs passing over the wire should be declared here (lov_mds_md
  24  * being the lone exception).  Structs must be properly aligned to put
  25  * 64-bit values on an 8-byte boundary.  Any structs being added here
  26  * must also be added to utils/wirecheck.c and "make newwiretest" run
  27  * to regenerate the utils/wiretest.c sources.  This allows us to verify
  28  * that wire structs have the proper alignment/size on all architectures.
  29  *
  30  * We assume all nodes are either little-endian or big-endian, and we
  31  * always send messages in the sender's native format.  The receiver
  32  * detects the message format by checking the 'magic' field of the message
  33  * (see lustre_msg_swabbed() below).
  34  *
  35  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
  36  * implemented either here, inline (trivial implementations) or in
  37  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
  38  * endian, in-place in the message buffer.
  39  *
  40  * A swabber takes a single pointer argument.  The caller must already have
  41  * verified that the length of the message buffer >= sizeof (type).
  42  *
  43  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
  44  * may be defined that swabs just the variable part, after the caller has
  45  * verified that the message buffer is large enough.
  46  */
  47
  48 #ifndef _LUSTRE_IDL_H_
  49 #define _LUSTRE_IDL_H_
  50
  51 #ifdef __KERNEL__
  52 # include <linux/ioctl.h>
  53 # include <asm/types.h>
  54 # include <linux/types.h>
  55 # include <linux/list.h>
  56 # include <linux/string.h> /* for strncpy, below */
  57 # include <linux/fs.h> /* to check for FMODE_EXEC, lest we redefine */
  58 #else
  59 #ifdef __CYGWIN__
  60 # include <sys/types.h>
  61 #else
  62 # include <asm/types.h>
  63 # include <stdint.h>
  64 #endif
  65 # include <portals/list.h>
  66 # include <string.h>
  67 #endif
  68
  69 /* Defn's shared with user-space. */
  70 #include <lustre/lustre_user.h>
  71
  72 /*
  73  * this file contains all data structures used in Lustre interfaces:
  74  * - obdo and obd_request records
  75  * - mds_request records
  76  * - ldlm data
  77  * - ioctl's
  78  */
  79
  80 /*
  81  *  GENERAL STUFF
  82  */
  83 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
  84  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
  85  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
  86  */
  87
  88 #define CONNMGR_REQUEST_PORTAL          1
  89 #define CONNMGR_REPLY_PORTAL            2
  90 //#define OSC_REQUEST_PORTAL            3
  91 #define OSC_REPLY_PORTAL                4
  92 //#define OSC_BULK_PORTAL               5
  93 #define OST_REQUEST_PORTAL              6
  94 #define OST_CREATE_PORTAL               7
  95 #define OST_BULK_PORTAL                 8
  96 //#define MDC_REQUEST_PORTAL            9
  97 #define MDC_REPLY_PORTAL               10
  98 //#define MDC_BULK_PORTAL              11
  99 #define MDS_REQUEST_PORTAL             12
 100 //#define MDS_REPLY_PORTAL             13
 101 #define MDS_BULK_PORTAL                14
 102 #define LDLM_CB_REQUEST_PORTAL         15
 103 #define LDLM_CB_REPLY_PORTAL           16
 104 #define LDLM_CANCEL_REQUEST_PORTAL     17
 105 #define LDLM_CANCEL_REPLY_PORTAL       18
 106 #define PTLBD_REQUEST_PORTAL           19
 107 #define PTLBD_REPLY_PORTAL             20
 108 #define PTLBD_BULK_PORTAL              21
 109 #define MDS_SETATTR_PORTAL             22
 110 #define MDS_READPAGE_PORTAL            23
 111 #define MGMT_REQUEST_PORTAL            24
 112 #define MGMT_REPLY_PORTAL              25
 113 #define MGMT_CLI_REQUEST_PORTAL        26
 114 #define MGMT_CLI_REPLY_PORTAL          27
 115
 116 #define SVC_KILLED               1
 117 #define SVC_EVENT                2
 118 #define SVC_SIGNAL               4
 119 #define SVC_RUNNING              8
 120 #define SVC_STOPPING            16
 121 #define SVC_STOPPED             32
 122
 123 /* packet types */
 124 #define PTL_RPC_MSG_REQUEST 4711
 125 #define PTL_RPC_MSG_ERR     4712
 126 #define PTL_RPC_MSG_REPLY   4713
 127
 128 #define PTLRPC_MSG_MAGIC    0x0BD00BD0
 129
 130
 131 #define PTLRPC_MSG_VERSION  0x00000003
 132 #define LUSTRE_MDS_VERSION  (0x00040000|PTLRPC_MSG_VERSION)
 133 #define LUSTRE_OST_VERSION  (0x00040000|PTLRPC_MSG_VERSION)
 134 #define LUSTRE_DLM_VERSION  (0x00040000|PTLRPC_MSG_VERSION)
 135
 136 struct lustre_handle {
 137         __u64 cookie;
 138 };
 139 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
 140
 141 /* we depend on this structure to be 8-byte aligned */
 142 /* this type is only endian-adjusted in lustre_unpack_msg() */
 143 struct lustre_msg {
 144         struct lustre_handle handle;
 145         __u32 magic;
 146         __u32 type;
 147         __u32 version;
 148         __u32 opc;
 149         __u64 last_xid;
 150         __u64 last_committed;
 151         __u64 transno;
 152         __u32 status;
 153         __u32 flags;
 154         __u32 conn_cnt;
 155         __u32 bufcount;
 156         __u32 buflens[0];
 157 };
 158
 159 /* Flags that are operation-specific go in the top 16 bits. */
 160 #define MSG_OP_FLAG_MASK   0xffff0000
 161 #define MSG_OP_FLAG_SHIFT  16
 162
 163 /* Flags that apply to all requests are in the bottom 16 bits */
 164 #define MSG_GEN_FLAG_MASK      0x0000ffff
 165 #define MSG_LAST_REPLAY        1
 166 #define MSG_RESENT             2
 167 #define MSG_REPLAY             4
 168
 169 static inline int lustre_msg_get_flags(struct lustre_msg *msg)
 170 {
 171         return (msg->flags & MSG_GEN_FLAG_MASK);
 172 }
 173
 174 static inline void lustre_msg_add_flags(struct lustre_msg *msg, int flags)
 175 {
 176         msg->flags |= MSG_GEN_FLAG_MASK & flags;
 177 }
 178
 179 static inline void lustre_msg_set_flags(struct lustre_msg *msg, int flags)
 180 {
 181         msg->flags &= ~MSG_GEN_FLAG_MASK;
 182         lustre_msg_add_flags(msg, flags);
 183 }
 184
 185 static inline void lustre_msg_clear_flags(struct lustre_msg *msg, int flags)
 186 {
 187         msg->flags &= ~(MSG_GEN_FLAG_MASK & flags);
 188 }
 189
 190 static inline int lustre_msg_get_op_flags(struct lustre_msg *msg)
 191 {
 192         return (msg->flags >> MSG_OP_FLAG_SHIFT);
 193 }
 194
 195 static inline void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags)
 196 {
 197         msg->flags |= ((flags & MSG_GEN_FLAG_MASK) << MSG_OP_FLAG_SHIFT);
 198 }
 199
 200 static inline void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags)
 201 {
 202         msg->flags &= ~MSG_OP_FLAG_MASK;
 203         lustre_msg_add_op_flags(msg, flags);
 204 }
 205
 206 /*
 207  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
 208  */
 209
 210 #define MSG_CONNECT_RECOVERING  0x1
 211 #define MSG_CONNECT_RECONNECT   0x2
 212 #define MSG_CONNECT_REPLAYABLE  0x4
 213 //#define MSG_CONNECT_PEER        0x8
 214 #define MSG_CONNECT_LIBCLIENT   0x10
 215
 216 /*
 217  *   OST requests: OBDO & OBD request records
 218  */
 219
 220 /* opcodes */
 221 typedef enum {
 222         OST_REPLY      =  0,       /* reply ? */
 223         OST_GETATTR    =  1,
 224         OST_SETATTR    =  2,
 225         OST_READ       =  3,
 226         OST_WRITE      =  4,
 227         OST_CREATE     =  5,
 228         OST_DESTROY    =  6,
 229         OST_GET_INFO   =  7,
 230         OST_CONNECT    =  8,
 231         OST_DISCONNECT =  9,
 232         OST_PUNCH      = 10,
 233         OST_OPEN       = 11,
 234         OST_CLOSE      = 12,
 235         OST_STATFS     = 13,
 236         OST_SAN_READ   = 14,
 237         OST_SAN_WRITE  = 15,
 238         OST_SYNC       = 16,
 239         OST_SET_INFO   = 17,
 240         OST_LAST_OPC
 241 } ost_cmd_t;
 242 #define OST_FIRST_OPC  OST_REPLY
 243
 244 typedef uint64_t        obd_id;
 245 typedef uint64_t        obd_gr;
 246 typedef uint64_t        obd_time;
 247 typedef uint64_t        obd_size;
 248 typedef uint64_t        obd_off;
 249 typedef uint64_t        obd_blocks;
 250 typedef uint32_t        obd_blksize;
 251 typedef uint32_t        obd_mode;
 252 typedef uint32_t        obd_uid;
 253 typedef uint32_t        obd_gid;
 254 typedef uint32_t        obd_flag;
 255 typedef uint32_t        obd_count;
 256
 257 #define OBD_FL_INLINEDATA   (0x00000001)
 258 #define OBD_FL_OBDMDEXISTS  (0x00000002)
 259 #define OBD_FL_DELORPHAN    (0x00000004) /* if set in o_flags delete orphans */
 260 #define OBD_FL_NORPC        (0x00000008) // if set in o_flags set in OSC not OST
 261 #define OBD_FL_IDONLY       (0x00000010) // if set in o_flags only adjust obj id
 262 #define OBD_FL_RECREATE_OBJS (0x00000020) // recreate missing obj
 263
 264 #define OBD_INLINESZ    64
 265
 266 /* Note: 64-bit types are 64-bit aligned in structure */
 267 struct obdo {
 268         obd_id                  o_id;
 269         obd_gr                  o_gr;
 270         obd_time                o_atime;
 271         obd_time                o_mtime;
 272         obd_time                o_ctime;
 273         obd_size                o_size;
 274         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
 275         obd_size                o_grant;
 276         obd_blksize             o_blksize;      /* optimal IO blocksize */
 277         obd_mode                o_mode;         /* brw: cli sent cache remain */
 278         obd_uid                 o_uid;
 279         obd_gid                 o_gid;
 280         obd_flag                o_flags;
 281         obd_count               o_nlink;        /* brw: checksum */
 282         obd_count               o_generation;
 283         obd_flag                o_valid;        /* hot fields in this obdo */
 284         obd_count               o_misc;         /* brw: o_dropped */
 285         __u32                   o_easize;       /* epoch in ost writes */
 286         char                    o_inline[OBD_INLINESZ]; /* fid in ost writes */
 287 };
 288
 289 #define o_dirty   o_blocks
 290 #define o_undirty o_mode
 291 #define o_dropped o_misc
 292 #define o_cksum   o_nlink
 293
 294 extern void lustre_swab_obdo (struct obdo *o);
 295
 296 #define LOV_MAGIC_V1      0x0BD10BD0
 297 #define LOV_MAGIC         LOV_MAGIC_V1
 298
 299 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
 300 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
 301 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
 302
 303 #define lov_ost_data lov_ost_data_v1
 304 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
 305         __u64 l_object_id;        /* OST object ID */
 306         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 307         __u32 l_ost_gen;          /* generation of this l_ost_idx */
 308         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
 309 };
 310
 311 #define lov_mds_md lov_mds_md_v1
 312 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
 313         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
 314         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 315         __u64 lmm_object_id;      /* LOV object ID */
 316         __u64 lmm_object_gr;      /* LOV object group */
 317         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 318         __u32 lmm_stripe_count;   /* num stripes in use for this object */
 319         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 320 };
 321
 322 #define LOV_MAGIC_V0      0x0BD00BD0
 323
 324 struct lov_ost_data_v0 {          /* per-stripe data structure (little-endian)*/
 325         __u64 l_object_id;        /* OST object ID */
 326 };
 327
 328 struct lov_mds_md_v0 {            /* LOV EA mds/wire data (little-endian) */
 329         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V0 */
 330         __u64 lmm_object_id;      /* LOV object ID */
 331         __u32 lmm_stripe_size;    /* size of the stripe in bytes (not RAID1) */
 332         __u32 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 333         __u16 lmm_stripe_count;   /* number of stipes in use for this object */
 334         __u16 lmm_ost_count;      /* how many OST idx are in this LOV md */
 335         struct lov_ost_data_v0 lmm_objects[0];
 336 } __attribute__((packed));
 337
 338 #define OBD_MD_FLALL    (0xffffffff)
 339 #define OBD_MD_FLID     (0x00000001)    /* object ID */
 340 #define OBD_MD_FLATIME  (0x00000002)    /* access time */
 341 #define OBD_MD_FLMTIME  (0x00000004)    /* data modification time */
 342 #define OBD_MD_FLCTIME  (0x00000008)    /* change time */
 343 #define OBD_MD_FLSIZE   (0x00000010)    /* size */
 344 #define OBD_MD_FLBLOCKS (0x00000020)    /* allocated blocks count */
 345 #define OBD_MD_FLBLKSZ  (0x00000040)    /* block size */
 346 #define OBD_MD_FLMODE   (0x00000080)    /* access bits (mode & ~S_IFMT) */
 347 #define OBD_MD_FLTYPE   (0x00000100)    /* object type (mode & S_IFMT) */
 348 #define OBD_MD_FLUID    (0x00000200)    /* user ID */
 349 #define OBD_MD_FLGID    (0x00000400)    /* group ID */
 350 #define OBD_MD_FLFLAGS  (0x00000800)    /* flags word */
 351 #define OBD_MD_FLNLINK  (0x00002000)    /* link count */
 352 #define OBD_MD_FLGENER  (0x00004000)    /* generation number */
 353 #define OBD_MD_FLINLINE (0x00008000)    /* inline data */
 354 #define OBD_MD_FLRDEV   (0x00010000)    /* device number */
 355 #define OBD_MD_FLEASIZE (0x00020000)    /* extended attribute data */
 356 #define OBD_MD_LINKNAME (0x00040000)    /* symbolic link target */
 357 #define OBD_MD_FLHANDLE (0x00080000)    /* file handle */
 358 #define OBD_MD_FLCKSUM  (0x00100000)    /* bulk data checksum */
 359 #define OBD_MD_FLQOS    (0x00200000)    /* quality of service stats */
 360 #define OBD_MD_FLOSCOPQ (0x00400000)    /* osc opaque data */
 361 #define OBD_MD_FLCOOKIE (0x00800000)    /* log cancellation cookie */
 362 #define OBD_MD_FLGROUP  (0x01000000)    /* group */
 363 #define OBD_MD_FLIFID   (0x02000000)    /* ->ost write inline fid */
 364 #define OBD_MD_FLEPOCH  (0x04000000)    /* ->ost write easize is epoch */
 365 #define OBD_MD_FLGRANT  (0x08000000)    /* ost preallocation space grant */
 366 #define OBD_MD_FLDIREA  (0x10000000)    /* dir's extended attribute data */
 367 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLBLOCKS | OBD_MD_LINKNAME|\
 368                            OBD_MD_FLEASIZE | OBD_MD_FLHANDLE | OBD_MD_FLCKSUM|\
 369                            OBD_MD_FLQOS | OBD_MD_FLOSCOPQ | OBD_MD_FLCOOKIE))
 370
 371
 372 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
 373 {
 374         return (struct lustre_handle *)oa->o_inline;
 375 }
 376
 377 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
 378 {
 379         return (struct llog_cookie *)(oa->o_inline +
 380                                       sizeof(struct lustre_handle));
 381 }
 382 /* don't forget obdo_fid which is way down at the bottom so it can
 383  * come after the definition of llog_cookie */
 384
 385 struct obd_statfs {
 386         __u64           os_type;
 387         __u64           os_blocks;
 388         __u64           os_bfree;
 389         __u64           os_bavail;
 390         __u64           os_files;
 391         __u64           os_ffree;
 392         __u8            os_fsid[40];
 393         __u32           os_bsize;
 394         __u32           os_namelen;
 395         __u64           os_maxbytes;
 396         __u32           os_spare[10];
 397 };
 398
 399 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
 400
 401 /* ost_body.data values for OST_BRW */
 402
 403 #define OBD_BRW_READ       0x01
 404 #define OBD_BRW_WRITE      0x02
 405 #define OBD_BRW_RWMASK     (OBD_BRW_READ | OBD_BRW_WRITE)
 406 #define OBD_BRW_SYNC       0x08
 407 #define OBD_BRW_CHECK      0x10
 408 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
 409 #define OBD_BRW_GRANTED    0x40 /* the ost manages this */
 410
 411 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
 412
 413 #define OST_MIN_PRECREATE 32
 414 #define OST_MAX_PRECREATE 20000
 415
 416 struct obd_ioobj {
 417         obd_id               ioo_id;
 418         obd_gr               ioo_gr;
 419         __u32                ioo_type;
 420         __u32                ioo_bufcnt;
 421 };
 422
 423 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
 424
 425 /* multiple of 8 bytes => can array */
 426 struct niobuf_remote {
 427         __u64 offset;
 428         __u32 len;
 429         __u32 flags;
 430 };
 431
 432 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
 433
 434 /* request structure for OST's */
 435
 436 #define OST_REQ_HAS_OA1  0x1
 437
 438 struct ost_body {
 439         struct  obdo oa;
 440 };
 441
 442 extern void lustre_swab_ost_body (struct ost_body *b);
 443 extern void lustre_swab_ost_last_id(obd_id *id);
 444
 445 /* lock value block communicated between the filter and llite */
 446
 447 struct ost_lvb {
 448         __u64 lvb_size;
 449         __u64 lvb_mtime;
 450         __u64 lvb_atime;
 451         __u64 lvb_ctime;
 452         __u64 lvb_blocks;
 453 };
 454
 455 extern void lustre_swab_ost_lvb(struct ost_lvb *);
 456
 457 /*
 458  *   MDS REQ RECORDS
 459  */
 460
 461 /* opcodes */
 462 typedef enum {
 463         MDS_GETATTR      = 33,
 464         MDS_GETATTR_NAME = 34,
 465         MDS_CLOSE        = 35,
 466         MDS_REINT        = 36,
 467         MDS_READPAGE     = 37,
 468         MDS_CONNECT      = 38,
 469         MDS_DISCONNECT   = 39,
 470         MDS_GETSTATUS    = 40,
 471         MDS_STATFS       = 41,
 472         MDS_PIN          = 42,
 473         MDS_UNPIN        = 43,
 474         MDS_SYNC         = 44,
 475         MDS_DONE_WRITING = 45,
 476         MDS_LAST_OPC
 477 } mds_cmd_t;
 478
 479 #define MDS_FIRST_OPC    MDS_GETATTR
 480
 481 /*
 482  * Do not exceed 63
 483  */
 484
 485 #define REINT_SETATTR    1
 486 #define REINT_CREATE     2
 487 #define REINT_LINK       3
 488 #define REINT_UNLINK     4
 489 #define REINT_RENAME     5
 490 #define REINT_OPEN       6
 491 #define REINT_MAX        6
 492
 493 /* the disposition of the intent outlines what was executed */
 494 #define DISP_IT_EXECD     0x01
 495 #define DISP_LOOKUP_EXECD 0x02
 496 #define DISP_LOOKUP_NEG   0x04
 497 #define DISP_LOOKUP_POS   0x08
 498 #define DISP_OPEN_CREATE  0x10
 499 #define DISP_OPEN_OPEN    0x20
 500 #define DISP_ENQ_COMPLETE 0x40
 501
 502 struct ll_fid {
 503         __u64 id;
 504         __u32 generation;
 505         __u32 f_type;
 506 };
 507
 508 extern void lustre_swab_ll_fid (struct ll_fid *fid);
 509
 510 #define MDS_STATUS_CONN 1
 511 #define MDS_STATUS_LOV 2
 512
 513 struct mds_status_req {
 514         __u32  flags;
 515         __u32  repbuf;
 516 };
 517
 518 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
 519
 520 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
 521
 522 struct mds_body {
 523         struct ll_fid  fid1;
 524         struct ll_fid  fid2;
 525         struct lustre_handle handle;
 526         __u64          size;   /* Offset, in the case of MDS_READPAGE */
 527         __u64          blocks; /* XID, in the case of MDS_READPAGE */
 528         __u64          io_epoch;
 529         __u32          ino;   /* make this a __u64 */
 530         __u32          valid;
 531         __u32          fsuid;
 532         __u32          fsgid;
 533         __u32          capability;
 534         __u32          mode;
 535         __u32          uid;
 536         __u32          gid;
 537         __u32          mtime;
 538         __u32          ctime;
 539         __u32          atime;
 540         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
 541         __u32          rdev;
 542         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
 543         __u32          generation;
 544         __u32          suppgid;
 545         __u32          eadatasize;
 546         __u32          packing;
 547 };
 548
 549 extern void lustre_swab_mds_body (struct mds_body *b);
 550
 551
 552 struct mds_rec_setattr {
 553         __u32           sa_opcode;
 554         __u32           sa_fsuid;
 555         __u32           sa_fsgid;
 556         __u32           sa_cap;
 557         __u32           sa_suppgid;
 558         __u32           sa_valid;
 559         struct ll_fid   sa_fid;
 560         __u32           sa_mode;
 561         __u32           sa_uid;
 562         __u32           sa_gid;
 563         __u32           sa_attr_flags;
 564         __u64           sa_size;
 565         __u64           sa_atime;
 566         __u64           sa_mtime;
 567         __u64           sa_ctime;
 568 };
 569
 570 /* Remove this once we declare it in include/linux/fs.h (v21 kernel patch?) */
 571 #ifndef ATTR_CTIME_SET
 572 #define ATTR_CTIME_SET 0x2000
 573 #endif
 574
 575 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
 576
 577 #ifndef FMODE_READ
 578 #define FMODE_READ               00000001
 579 #define FMODE_WRITE              00000002
 580 #endif
 581 #ifndef FMODE_EXEC
 582 #define FMODE_EXEC               00000004
 583 #endif
 584 #define MDS_OPEN_CREAT           00000100
 585 #define MDS_OPEN_EXCL            00000200
 586 #define MDS_OPEN_TRUNC           00001000
 587 #define MDS_OPEN_APPEND          00002000
 588 #define MDS_OPEN_SYNC            00010000
 589 #define MDS_OPEN_DIRECTORY       00200000
 590
 591 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
 592 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
 593 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
 594
 595 struct mds_rec_create {
 596         __u32           cr_opcode;
 597         __u32           cr_fsuid;
 598         __u32           cr_fsgid;
 599         __u32           cr_cap;
 600         __u32           cr_flags; /* for use with open */
 601         __u32           cr_mode;
 602         struct ll_fid   cr_fid;
 603         struct ll_fid   cr_replayfid;
 604         __u64           cr_time;
 605         __u64           cr_rdev;
 606         __u32           cr_suppgid;
 607         __u32           cr_packing;
 608 };
 609
 610 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
 611
 612 struct mds_rec_link {
 613         __u32           lk_opcode;
 614         __u32           lk_fsuid;
 615         __u32           lk_fsgid;
 616         __u32           lk_cap;
 617         __u32           lk_suppgid1;
 618         __u32           lk_suppgid2;
 619         struct ll_fid   lk_fid1;
 620         struct ll_fid   lk_fid2;
 621         __u64           lk_time;
 622 };
 623
 624 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
 625
 626 struct mds_rec_unlink {
 627         __u32           ul_opcode;
 628         __u32           ul_fsuid;
 629         __u32           ul_fsgid;
 630         __u32           ul_cap;
 631         __u32           ul_suppgid;
 632         __u32           ul_mode;
 633         struct ll_fid   ul_fid1;
 634         struct ll_fid   ul_fid2;
 635         __u64           ul_time;
 636 };
 637
 638 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
 639
 640 struct mds_rec_rename {
 641         __u32           rn_opcode;
 642         __u32           rn_fsuid;
 643         __u32           rn_fsgid;
 644         __u32           rn_cap;
 645         __u32           rn_suppgid1;
 646         __u32           rn_suppgid2;
 647         struct ll_fid   rn_fid1;
 648         struct ll_fid   rn_fid2;
 649         __u64           rn_time;
 650 };
 651
 652 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
 653
 654 /*
 655  *  LOV data structures
 656  */
 657
 658 #define LOV_MAX_UUID_BUFFER_SIZE  8192
 659 /* The size of the buffer the lov/mdc reserves for the
 660  * array of UUIDs returned by the MDS.  With the current
 661  * protocol, this will limit the max number of OSTs per LOV */
 662
 663 struct lov_desc {
 664         __u32 ld_tgt_count;                /* how many OBD's */
 665         __u32 ld_active_tgt_count;         /* how many active */
 666         __u32 ld_default_stripe_count;     /* how many objects are used */
 667         __u32 ld_pattern;                  /* PATTERN_RAID0, PATTERN_RAID1 */
 668         __u64 ld_default_stripe_size;      /* in bytes */
 669         __u64 ld_default_stripe_offset;    /* in bytes */
 670         struct obd_uuid ld_uuid;
 671 };
 672
 673 extern void lustre_swab_lov_desc (struct lov_desc *ld);
 674
 675 /*
 676  *   LDLM requests:
 677  */
 678 /* opcodes -- MUST be distinct from OST/MDS opcodes */
 679 typedef enum {
 680         LDLM_ENQUEUE     = 101,
 681         LDLM_CONVERT     = 102,
 682         LDLM_CANCEL      = 103,
 683         LDLM_BL_CALLBACK = 104,
 684         LDLM_CP_CALLBACK = 105,
 685         LDLM_GL_CALLBACK = 106,
 686         LDLM_LAST_OPC
 687 } ldlm_cmd_t;
 688 #define LDLM_FIRST_OPC LDLM_ENQUEUE
 689
 690 #define RES_NAME_SIZE 4
 691 struct ldlm_res_id {
 692         __u64 name[RES_NAME_SIZE];
 693 };
 694
 695 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
 696
 697 /* lock types */
 698 typedef enum {
 699         LCK_EX = 1,
 700         LCK_PW = 2,
 701         LCK_PR = 4,
 702         LCK_CW = 8,
 703         LCK_CR = 16,
 704         LCK_NL = 32
 705 } ldlm_mode_t;
 706
 707 struct ldlm_extent {
 708         __u64 start;
 709         __u64 end;
 710 };
 711
 712 struct ldlm_flock {
 713         __u64 start;
 714         __u64 end;
 715         __u64 blocking_export;
 716         pid_t blocking_pid;
 717         pid_t pid;
 718 };
 719
 720 /* it's important that the fields of the ldlm_extent structure match
 721  * the first fields of the ldlm_flock structure because there is only
 722  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
 723  * this ever changes we will need to swab the union differently based
 724  * on the resource type. */
 725
 726 typedef union {
 727         struct ldlm_extent l_extent;
 728         struct ldlm_flock  l_flock;
 729 } ldlm_policy_data_t;
 730
 731 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
 732
 733 struct ldlm_intent {
 734         __u64 opc;
 735 };
 736
 737 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
 738
 739 struct ldlm_resource_desc {
 740         __u32 lr_type;
 741         __u32 lr_padding;
 742         struct ldlm_res_id lr_name;
 743 };
 744
 745 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
 746
 747 struct ldlm_lock_desc {
 748         struct ldlm_resource_desc l_resource;
 749         ldlm_mode_t l_req_mode;
 750         ldlm_mode_t l_granted_mode;
 751         ldlm_policy_data_t l_policy_data;
 752 };
 753
 754 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
 755
 756 struct ldlm_request {
 757         __u32 lock_flags;
 758         __u32 lock_padding;
 759         struct ldlm_lock_desc lock_desc;
 760         struct lustre_handle lock_handle1;
 761         struct lustre_handle lock_handle2;
 762 };
 763
 764 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
 765
 766 struct ldlm_reply {
 767         __u32 lock_flags;
 768         __u32 lock_padding;
 769         struct ldlm_lock_desc lock_desc;
 770         struct lustre_handle lock_handle;
 771         __u64  lock_policy_res1;
 772         __u64  lock_policy_res2;
 773 };
 774
 775 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
 776
 777 /*
 778  * ptlbd, portal block device requests
 779  */
 780 typedef enum {
 781         PTLBD_QUERY = 200,
 782         PTLBD_READ = 201,
 783         PTLBD_WRITE = 202,
 784         PTLBD_FLUSH = 203,
 785         PTLBD_CONNECT = 204,
 786         PTLBD_DISCONNECT = 205,
 787         PTLBD_LAST_OPC
 788 } ptlbd_cmd_t;
 789 #define PTLBD_FIRST_OPC PTLBD_QUERY
 790
 791 struct ptlbd_op {
 792         __u16 op_cmd;
 793         __u16 op_lun;
 794         __u16 op_niob_cnt;
 795         __u16 op__padding;
 796         __u32 op_block_cnt;
 797 };
 798
 799 extern void lustre_swab_ptlbd_op (struct ptlbd_op *op);
 800
 801 struct ptlbd_niob {
 802         __u64 n_xid;
 803         __u64 n_block_nr;
 804         __u32 n_offset;
 805         __u32 n_length;
 806 };
 807
 808 extern void lustre_swab_ptlbd_niob (struct ptlbd_niob *n);
 809
 810 struct ptlbd_rsp {
 811         __u16 r_status;
 812         __u16 r_error_cnt;
 813 };
 814
 815 extern void lustre_swab_ptlbd_rsp (struct ptlbd_rsp *r);
 816
 817 /*
 818  * Opcodes for management/monitoring node.
 819  */
 820 typedef enum {
 821         MGMT_CONNECT = 250,
 822         MGMT_DISCONNECT,
 823         MGMT_EXCEPTION,         /* node died, etc. */
 824         MGMT_LAST_OPC
 825 } mgmt_cmd_t;
 826 #define MGMT_FIRST_OPC MGMT_CONNECT
 827
 828 /*
 829  * Opcodes for multiple servers.
 830  */
 831
 832 typedef enum {
 833         OBD_PING = 400,
 834         OBD_LOG_CANCEL,
 835         OBD_LAST_OPC
 836 } obd_cmd_t;
 837 #define OBD_FIRST_OPC OBD_PING
 838
 839 /* catalog of log objects */
 840
 841 /* Identifier for a single log object */
 842 struct llog_logid {
 843         __u64                   lgl_oid;
 844         __u64                   lgl_ogr;
 845         __u32                   lgl_ogen;
 846 } __attribute__((packed));
 847
 848 /* Records written to the CATALOGS list */
 849 #define CATLIST "CATALOGS"
 850 struct llog_catid {
 851         struct llog_logid       lci_logid;
 852         __u32                   lci_padding[3];
 853 } __attribute__((packed));
 854
 855 /* Log data record types - there is no specific reason that these need to
 856  * be related to the RPC opcodes, but no reason not to (may be handy later?)
 857  */
 858 typedef enum {
 859         OST_SZ_REC       = 0x10600000 | (OST_SAN_WRITE << 8),
 860         OST_RAID1_REC    = 0x10600000 | ((OST_SAN_WRITE + 1) << 8),
 861         MDS_UNLINK_REC   = 0x10610000 | (MDS_REINT << 8) | REINT_UNLINK,
 862         OBD_CFG_REC      = 0x10620000,
 863         PTL_CFG_REC      = 0x10630000,
 864         LLOG_GEN_REC     = 0x10640000,
 865         LLOG_HDR_MAGIC   = 0x10645539,
 866         LLOG_LOGID_MAGIC = 0x1064553b,
 867 } llog_op_type;
 868
 869 /* Log record header - stored in little endian order.
 870  * Each record must start with this struct, end with a llog_rec_tail,
 871  * and be a multiple of 256 bits in size.
 872  */
 873 struct llog_rec_hdr {
 874         __u32                   lrh_len;
 875         __u32                   lrh_index;
 876         __u32                   lrh_type;
 877         __u32                   padding;
 878 };
 879
 880 struct llog_rec_tail {
 881         __u32 lrt_len;
 882         __u32 lrt_index;
 883 };
 884
 885 struct llog_logid_rec {
 886         struct llog_rec_hdr     lid_hdr;
 887         struct llog_logid       lid_id;
 888         __u32                   padding[5];
 889         struct llog_rec_tail    lid_tail;
 890 } __attribute__((packed));
 891
 892 struct llog_create_rec {
 893         struct llog_rec_hdr     lcr_hdr;
 894         struct ll_fid           lcr_fid;
 895         obd_id                  lcr_oid;
 896         obd_count               lcr_ogen;
 897         __u32                   padding;
 898         struct llog_rec_tail    lcr_tail;
 899 } __attribute__((packed));
 900
 901 struct llog_orphan_rec {
 902         struct llog_rec_hdr     lor_hdr;
 903         obd_id                  lor_oid;
 904         obd_count               lor_ogen;
 905         __u32                   padding;
 906         struct llog_rec_tail    lor_tail;
 907 } __attribute__((packed));
 908
 909 struct llog_unlink_rec {
 910         struct llog_rec_hdr     lur_hdr;
 911         obd_id                  lur_oid;
 912         obd_count               lur_ogen;
 913         __u32                   padding;
 914         struct llog_rec_tail    lur_tail;
 915 } __attribute__((packed));
 916
 917 struct llog_size_change_rec {
 918         struct llog_rec_hdr     lsc_hdr;
 919         struct ll_fid           lsc_fid;
 920         __u32                   lsc_io_epoch;
 921         __u32                   padding;
 922         struct llog_rec_tail    lsc_tail;
 923 } __attribute__((packed));
 924
 925 struct llog_gen {
 926         __u64 mnt_cnt;
 927         __u64 conn_cnt;
 928 } __attribute__((packed));
 929
 930 struct llog_gen_rec {
 931         struct llog_rec_hdr     lgr_hdr;
 932         struct llog_gen         lgr_gen;
 933         struct llog_rec_tail    lgr_tail;
 934 };
 935 /* On-disk header structure of each log object, stored in little endian order */
 936 #define LLOG_CHUNK_SIZE         8192
 937 #define LLOG_HEADER_SIZE        (96)
 938 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
 939
 940 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
 941
 942 /* flags for the logs */
 943 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
 944 #define LLOG_F_IS_CAT           0x2
 945 #define LLOG_F_IS_PLAIN         0x4
 946
 947 struct llog_log_hdr {
 948         struct llog_rec_hdr     llh_hdr;
 949         __u64                   llh_timestamp;
 950         __u32                   llh_count;
 951         __u32                   llh_bitmap_offset;
 952         __u32                   llh_size;
 953         __u32                   llh_flags;
 954         __u32                   llh_cat_idx;
 955         /* for a catalog the first plain slot is next to it */
 956         struct obd_uuid         llh_tgtuuid;
 957         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
 958         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
 959         struct llog_rec_tail    llh_tail;
 960 } __attribute__((packed));
 961
 962 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
 963                                  llh->llh_bitmap_offset -       \
 964                                  sizeof(llh->llh_tail)) * 8)
 965
 966 /* log cookies are used to reference a specific log file and a record therein */
 967 struct llog_cookie {
 968         struct llog_logid       lgc_lgl;
 969         __u32                   lgc_subsys;
 970         __u32                   lgc_index;
 971         __u32                   lgc_padding;
 972 } __attribute__((packed));
 973
 974 /* llog protocol */
 975 enum llogd_rpc_ops {
 976         LLOG_ORIGIN_HANDLE_CREATE       = 501,
 977         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
 978         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
 979         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
 980         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
 981         LLOG_ORIGIN_CONNECT             = 506,
 982         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
 983 };
 984
 985 struct llogd_body {
 986         struct llog_logid  lgd_logid;
 987         __u32 lgd_ctxt_idx;
 988         __u32 lgd_llh_flags;
 989         __u32 lgd_index;
 990         __u32 lgd_saved_index;
 991         __u32 lgd_len;
 992         __u64 lgd_cur_offset;
 993 } __attribute__((packed));
 994
 995 struct llogd_conn_body {
 996         struct llog_gen         lgdc_gen;
 997         struct llog_logid       lgdc_logid;
 998         __u32                   lgdc_ctxt_idx;
 999 } __attribute__((packed));
1000
1001 extern void lustre_swab_llogd_body (struct llogd_body *d);
1002 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1003 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1004
1005 static inline struct ll_fid *obdo_fid(struct obdo *oa)
1006 {
1007         return (struct ll_fid *)(oa->o_inline + sizeof(struct lustre_handle) +
1008                                  sizeof(struct llog_cookie));
1009 }
1010
1011 #endif