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