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, dev_t, 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;
 285         __u32                   o_easize;       /* epoch in ost writes */
 286         __u32                   o_mds;
 287         char                    o_inline[OBD_INLINESZ]; /* fid in ost writes */
 288 };
 289
 290 #define o_dirty   o_blocks
 291 #define o_undirty o_mode
 292 #define o_dropped o_misc
 293 #define o_cksum   o_nlink
 294
 295 extern void lustre_swab_obdo (struct obdo *o);
 296
 297 #define LOV_MAGIC_V1      0x0BD10BD0
 298 #define LOV_MAGIC         LOV_MAGIC_V1
 299
 300 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
 301 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
 302 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
 303 #define LOV_PATTERN_CMOBD 0x200
 304
 305 #define lov_ost_data lov_ost_data_v1
 306 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
 307         __u64 l_object_id;        /* OST object ID */
 308         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 309         __u32 l_ost_gen;          /* generation of this l_ost_idx */
 310         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
 311 };
 312
 313 #define lov_mds_md lov_mds_md_v1
 314 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
 315         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
 316         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 317         __u64 lmm_object_id;      /* LOV object ID */
 318         __u64 lmm_object_gr;      /* LOV object group */
 319         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 320         __u32 lmm_stripe_count;   /* num stripes in use for this object */
 321         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 322 };
 323
 324 #define LOV_MAGIC_V0      0x0BD00BD0
 325
 326 struct lov_ost_data_v0 {          /* per-stripe data structure (little-endian)*/
 327         __u64 l_object_id;        /* OST object ID */
 328 };
 329
 330 struct lov_mds_md_v0 {            /* LOV EA mds/wire data (little-endian) */
 331         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V0 */
 332         __u64 lmm_object_id;      /* LOV object ID */
 333         __u32 lmm_stripe_size;    /* size of the stripe in bytes (not RAID1) */
 334         __u32 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 335         __u16 lmm_stripe_count;   /* number of stipes in use for this object */
 336         __u16 lmm_ost_count;      /* how many OST idx are in this LOV md */
 337         struct lov_ost_data_v0 lmm_objects[0];
 338 } __attribute__((packed));
 339
 340 #define OBD_MD_FLALL    (0xffffffff)
 341 #define OBD_MD_FLID     (0x00000001)    /* object ID */
 342 #define OBD_MD_FLATIME  (0x00000002)    /* access time */
 343 #define OBD_MD_FLMTIME  (0x00000004)    /* data modification time */
 344 #define OBD_MD_FLCTIME  (0x00000008)    /* change time */
 345 #define OBD_MD_FLSIZE   (0x00000010)    /* size */
 346 #define OBD_MD_FLBLOCKS (0x00000020)    /* allocated blocks count */
 347 #define OBD_MD_FLBLKSZ  (0x00000040)    /* block size */
 348 #define OBD_MD_FLMODE   (0x00000080)    /* access bits (mode & ~S_IFMT) */
 349 #define OBD_MD_FLTYPE   (0x00000100)    /* object type (mode & S_IFMT) */
 350 #define OBD_MD_FLUID    (0x00000200)    /* user ID */
 351 #define OBD_MD_FLGID    (0x00000400)    /* group ID */
 352 #define OBD_MD_FLFLAGS  (0x00000800)    /* flags word */
 353 #define OBD_MD_FLNLINK  (0x00002000)    /* link count */
 354 #define OBD_MD_FLGENER  (0x00004000)    /* generation number */
 355 #define OBD_MD_FLINLINE (0x00008000)    /* inline data */
 356 #define OBD_MD_FLRDEV   (0x00010000)    /* device number */
 357 #define OBD_MD_FLEASIZE (0x00020000)    /* extended attribute data */
 358 #define OBD_MD_LINKNAME (0x00040000)    /* symbolic link target */
 359 #define OBD_MD_FLHANDLE (0x00080000)    /* file handle */
 360 #define OBD_MD_FLCKSUM  (0x00100000)    /* bulk data checksum */
 361 #define OBD_MD_FLQOS    (0x00200000)    /* quality of service stats */
 362 #define OBD_MD_FLOSCOPQ (0x00400000)    /* osc opaque data */
 363 #define OBD_MD_FLCOOKIE (0x00800000)    /* log cancellation cookie */
 364 #define OBD_MD_FLGROUP  (0x01000000)    /* group */
 365 #define OBD_MD_FLIFID   (0x02000000)    /* ->ost write inline fid */
 366 #define OBD_MD_FLEPOCH  (0x04000000)    /* ->ost write easize is epoch */
 367 #define OBD_MD_FLGRANT  (0x08000000)    /* ost preallocation space grant */
 368 #define OBD_MD_MDS      (0x10000000)    /* where an inode lives on */
 369 #define OBD_MD_FLDIREA  (0x20000000)    /* dir's extended attribute data */
 370 #define OBD_MD_REINT    (0x40000000)    /* reintegrate oa*/
 371 #define OBD_MD_FLNOTOBD (~(OBD_MD_FLBLOCKS | OBD_MD_LINKNAME|\
 372                            OBD_MD_FLEASIZE | OBD_MD_FLHANDLE | OBD_MD_FLCKSUM|\
 373                            OBD_MD_FLQOS | OBD_MD_FLOSCOPQ | OBD_MD_FLCOOKIE|\
 374                            OBD_MD_MDS))
 375
 376
 377 static inline struct lustre_handle *obdo_handle(struct obdo *oa)
 378 {
 379         return (struct lustre_handle *)oa->o_inline;
 380 }
 381
 382 static inline struct llog_cookie *obdo_logcookie(struct obdo *oa)
 383 {
 384         return (struct llog_cookie *)(oa->o_inline +
 385                                       sizeof(struct lustre_handle));
 386 }
 387 /* don't forget obdo_fid which is way down at the bottom so it can
 388  * come after the definition of llog_cookie */
 389
 390 struct obd_statfs {
 391         __u64           os_type;
 392         __u64           os_blocks;
 393         __u64           os_bfree;
 394         __u64           os_bavail;
 395         __u64           os_files;
 396         __u64           os_ffree;
 397         __u8            os_fsid[40];
 398         __u32           os_bsize;
 399         __u32           os_namelen;
 400         __u64           os_maxbytes;
 401         __u32           os_spare[10];
 402 };
 403
 404 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
 405
 406 /* ost_body.data values for OST_BRW */
 407
 408 #define OBD_BRW_READ       0x01
 409 #define OBD_BRW_WRITE      0x02
 410 #define OBD_BRW_RWMASK     (OBD_BRW_READ | OBD_BRW_WRITE)
 411 #define OBD_BRW_SYNC       0x08
 412 #define OBD_BRW_CHECK      0x10
 413 #define OBD_BRW_FROM_GRANT 0x20 /* the osc manages this under llite */
 414 #define OBD_BRW_GRANTED    0x40 /* the ost manages this */
 415
 416 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
 417
 418 struct obd_ioobj {
 419         obd_id               ioo_id;
 420         obd_gr               ioo_gr;
 421         __u32                ioo_type;
 422         __u32                ioo_bufcnt;
 423 };
 424
 425 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
 426
 427 /* multiple of 8 bytes => can array */
 428 struct niobuf_remote {
 429         __u64 offset;
 430         __u32 len;
 431         __u32 flags;
 432 };
 433
 434 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
 435
 436 /* request structure for OST's */
 437
 438 #define OST_REQ_HAS_OA1  0x1
 439
 440 struct ost_body {
 441         struct  obdo oa;
 442 };
 443
 444 extern void lustre_swab_ost_body (struct ost_body *b);
 445 extern void lustre_swab_ost_last_id(obd_id *id);
 446
 447 /* lock value block communicated between the filter and llite */
 448
 449 struct ost_lvb {
 450         __u64 lvb_size;
 451         __u64 lvb_mtime;
 452         __u64 lvb_atime;
 453         __u64 lvb_ctime;
 454         __u64 lvb_blocks;
 455 };
 456
 457 extern void lustre_swab_ost_lvb(struct ost_lvb *);
 458
 459 /*
 460  *   MDS REQ RECORDS
 461  */
 462
 463 /* opcodes */
 464 typedef enum {
 465         MDS_GETATTR      = 33,
 466         MDS_GETATTR_NAME = 34,
 467         MDS_CLOSE        = 35,
 468         MDS_REINT        = 36,
 469         MDS_READPAGE     = 37,
 470         MDS_CONNECT      = 38,
 471         MDS_DISCONNECT   = 39,
 472         MDS_GETSTATUS    = 40,
 473         MDS_STATFS       = 41,
 474         MDS_PIN          = 42,
 475         MDS_UNPIN        = 43,
 476         MDS_SYNC         = 44,
 477         MDS_DONE_WRITING = 45,
 478         MDS_LAST_OPC
 479 } mds_cmd_t;
 480
 481 #define MDS_FIRST_OPC    MDS_GETATTR
 482
 483 /*
 484  * Do not exceed 63
 485  */
 486
 487 #define REINT_SETATTR    1
 488 #define REINT_CREATE     2
 489 #define REINT_LINK       3
 490 #define REINT_UNLINK     4
 491 #define REINT_RENAME     5
 492 #define REINT_OPEN       6
 493 #define REINT_CLOSE      7
 494 #define REINT_WRITE      8
 495 #define REINT_MAX        8
 496
 497 /* the disposition of the intent outlines what was executed */
 498 #define DISP_IT_EXECD   1
 499 #define DISP_LOOKUP_EXECD  (1 << 1)
 500 #define DISP_LOOKUP_NEG     (1 << 2)
 501 #define DISP_LOOKUP_POS     (1 << 3)
 502 #define DISP_OPEN_CREATE  (1 << 4)
 503 #define DISP_OPEN_OPEN    (1 << 5)
 504 #define DISP_ENQ_COMPLETE (1<<6)
 505
 506 /* INODE LOCK PARTS */
 507 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
 508 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
 509 //#define MDS_INODELOCK_MAXSHIFT 1
 510 //#define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
 511
 512 struct ll_fid {
 513         __u64 id;
 514         __u32 generation;
 515         __u32 f_type;
 516         __u32 mds;
 517         __u32 padding;
 518 };
 519
 520 struct mea {
 521         __u32 mea_count;
 522         __u32 mea_master;
 523         struct ll_fid mea_fids[0];
 524 };
 525
 526 extern void lustre_swab_ll_fid (struct ll_fid *fid);
 527
 528 #define MDS_STATUS_CONN 1
 529 #define MDS_STATUS_LOV 2
 530
 531 struct mds_status_req {
 532         __u32  flags;
 533         __u32  repbuf;
 534 };
 535
 536 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
 537
 538 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
 539
 540 struct mds_body {
 541         struct ll_fid  fid1;
 542         struct ll_fid  fid2;
 543         struct lustre_handle handle;
 544         __u64          size;   /* Offset, in the case of MDS_READPAGE */
 545         __u64          blocks; /* XID, in the case of MDS_READPAGE */
 546         __u64          io_epoch;
 547         __u32          ino;   /* make this a __u64 */
 548         __u32          valid;
 549         __u32          fsuid;
 550         __u32          fsgid;
 551         __u32          capability;
 552         __u32          mode;
 553         __u32          uid;
 554         __u32          gid;
 555         __u32          mtime;
 556         __u32          ctime;
 557         __u32          atime;
 558         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
 559         __u32          rdev;
 560         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
 561         __u32          generation;
 562         __u32          suppgid;
 563         __u32          eadatasize;
 564         __u32          mds;
 565 };
 566
 567 extern void lustre_swab_mds_body (struct mds_body *b);
 568
 569 struct lustre_md {
 570         struct mds_body *body;
 571         struct lov_stripe_md *lsm;
 572         struct mea *mea;
 573 };
 574
 575 struct ll_uctxt {
 576         __u32 gid1;
 577         __u32 gid2;
 578 };
 579
 580 struct mdc_op_data {
 581         struct ll_fid fid1;
 582         struct ll_fid fid2;
 583         struct ll_uctxt ctxt;
 584         __u64 mod_time;
 585         const char *name;
 586         int namelen;
 587         __u32 create_mode;
 588         struct mea *mea1;       /* mea of inode1 */
 589         struct mea *mea2;       /* mea of inode2 */
 590 };
 591
 592 struct mds_rec_setattr {
 593         __u32           sa_opcode;
 594         __u32           sa_fsuid;
 595         __u32           sa_fsgid;
 596         __u32           sa_cap;
 597         __u32           sa_suppgid;
 598         __u32           sa_valid;
 599         struct ll_fid   sa_fid;
 600         __u32           sa_mode;
 601         __u32           sa_uid;
 602         __u32           sa_gid;
 603         __u32           sa_attr_flags;
 604         __u64           sa_size;
 605         __u64           sa_atime;
 606         __u64           sa_mtime;
 607         __u64           sa_ctime;
 608 };
 609
 610 /* Remove this once we declare it in include/linux/fs.h (v21 kernel patch?) */
 611 #ifndef ATTR_CTIME_SET
 612 #define ATTR_CTIME_SET 0x2000
 613 #endif
 614
 615 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
 616
 617 #ifndef FMODE_READ
 618 #define FMODE_READ               00000001
 619 #define FMODE_WRITE              00000002
 620 #endif
 621 #ifndef FMODE_EXEC
 622 #define FMODE_EXEC               00000004
 623 #endif
 624 #define MDS_OPEN_CREAT           00000100
 625 #define MDS_OPEN_EXCL            00000200
 626 #define MDS_OPEN_TRUNC           00001000
 627 #define MDS_OPEN_APPEND          00002000
 628 #define MDS_OPEN_SYNC            00010000
 629 #define MDS_OPEN_DIRECTORY       00200000
 630
 631 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
 632 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
 633 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
 634
 635 struct mds_rec_create {
 636         __u32           cr_opcode;
 637         __u32           cr_fsuid;
 638         __u32           cr_fsgid;
 639         __u32           cr_cap;
 640         __u32           cr_flags; /* for use with open */
 641         __u32           cr_mode;
 642         struct ll_fid   cr_fid;
 643         struct ll_fid   cr_replayfid;
 644         __u64           cr_time;
 645         __u64           cr_rdev;
 646         __u32           cr_suppgid;
 647         __u32           cr_packing;
 648 };
 649
 650 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
 651
 652 struct mds_rec_link {
 653         __u32           lk_opcode;
 654         __u32           lk_fsuid;
 655         __u32           lk_fsgid;
 656         __u32           lk_cap;
 657         __u32           lk_suppgid1;
 658         __u32           lk_suppgid2;
 659         struct ll_fid   lk_fid1;
 660         struct ll_fid   lk_fid2;
 661         __u64           lk_time;
 662 };
 663
 664 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
 665
 666 struct mds_rec_unlink {
 667         __u32           ul_opcode;
 668         __u32           ul_fsuid;
 669         __u32           ul_fsgid;
 670         __u32           ul_cap;
 671         __u32           ul_suppgid;
 672         __u32           ul_mode;
 673         struct ll_fid   ul_fid1;
 674         struct ll_fid   ul_fid2;
 675         __u64           ul_time;
 676 };
 677
 678 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
 679
 680 struct mds_rec_rename {
 681         __u32           rn_opcode;
 682         __u32           rn_fsuid;
 683         __u32           rn_fsgid;
 684         __u32           rn_cap;
 685         __u32           rn_suppgid1;
 686         __u32           rn_suppgid2;
 687         struct ll_fid   rn_fid1;
 688         struct ll_fid   rn_fid2;
 689         __u64           rn_time;
 690 };
 691
 692 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
 693
 694 /*
 695  *  LOV data structures
 696  */
 697
 698 #define LOV_MAX_UUID_BUFFER_SIZE  8192
 699 /* The size of the buffer the lov/mdc reserves for the
 700  * array of UUIDs returned by the MDS.  With the current
 701  * protocol, this will limit the max number of OSTs per LOV */
 702
 703 struct lov_desc {
 704         __u32 ld_tgt_count;                /* how many OBD's */
 705         __u32 ld_active_tgt_count;         /* how many active */
 706         __u32 ld_default_stripe_count;     /* how many objects are used */
 707         __u32 ld_pattern;                  /* PATTERN_RAID0, PATTERN_RAID1 */
 708         __u64 ld_default_stripe_size;      /* in bytes */
 709         __u64 ld_default_stripe_offset;    /* in bytes */
 710         struct obd_uuid ld_uuid;
 711 };
 712
 713 struct lmv_desc {
 714         __u32 ld_count;                    /* how many MDS's */
 715         struct obd_uuid ld_uuid;
 716 };
 717
 718 extern void lustre_swab_lov_desc (struct lov_desc *ld);
 719
 720 /*
 721  *   LDLM requests:
 722  */
 723 /* opcodes -- MUST be distinct from OST/MDS opcodes */
 724 typedef enum {
 725         LDLM_ENQUEUE     = 101,
 726         LDLM_CONVERT     = 102,
 727         LDLM_CANCEL      = 103,
 728         LDLM_BL_CALLBACK = 104,
 729         LDLM_CP_CALLBACK = 105,
 730         LDLM_GL_CALLBACK = 106,
 731         LDLM_LAST_OPC
 732 } ldlm_cmd_t;
 733 #define LDLM_FIRST_OPC LDLM_ENQUEUE
 734
 735 #define RES_NAME_SIZE 4
 736 struct ldlm_res_id {
 737         __u64 name[RES_NAME_SIZE];
 738 };
 739
 740 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
 741
 742 /* lock types */
 743 typedef enum {
 744         LCK_EX = 1,
 745         LCK_PW = 2,
 746         LCK_PR = 4,
 747         LCK_CW = 8,
 748         LCK_CR = 16,
 749         LCK_NL = 32,
 750         LCK_GROUP = 64
 751 } ldlm_mode_t;
 752
 753 struct ldlm_extent {
 754         __u64 start;
 755         __u64 end;
 756         __u64 gid;
 757 };
 758 struct ldlm_inodebits {
 759         __u64 bits;
 760 };
 761
 762 struct ldlm_flock {
 763         __u64 start;
 764         __u64 end;
 765         __u64 pid;
 766         __u64 blocking_pid;
 767         __u64 blocking_export;
 768 };
 769
 770 /* it's important that the fields of the ldlm_extent structure match
 771  * the first fields of the ldlm_flock structure because there is only
 772  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
 773  * this ever changes we will need to swab the union differently based
 774  * on the resource type. */
 775
 776 typedef union {
 777         struct ldlm_extent l_extent;
 778         struct ldlm_flock  l_flock;
 779         struct ldlm_inodebits l_inodebits;
 780 } ldlm_policy_data_t;
 781
 782 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
 783
 784 struct ldlm_intent {
 785         __u64 opc;
 786 };
 787
 788 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
 789
 790 struct ldlm_resource_desc {
 791         __u32 lr_type;
 792         __u32 lr_padding;
 793         struct ldlm_res_id lr_name;
 794 };
 795
 796 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
 797
 798 struct ldlm_lock_desc {
 799         struct ldlm_resource_desc l_resource;
 800         ldlm_mode_t l_req_mode;
 801         ldlm_mode_t l_granted_mode;
 802         ldlm_policy_data_t l_policy_data;
 803 };
 804
 805 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
 806
 807 struct ldlm_request {
 808         __u32 lock_flags;
 809         __u32 lock_padding;
 810         struct ldlm_lock_desc lock_desc;
 811         struct lustre_handle lock_handle1;
 812         struct lustre_handle lock_handle2;
 813 };
 814
 815 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
 816
 817 struct ldlm_reply {
 818         __u32 lock_flags;
 819         __u32 lock_padding;
 820         struct ldlm_lock_desc lock_desc;
 821         struct lustre_handle lock_handle;
 822         __u64  lock_policy_res1;
 823         __u64  lock_policy_res2;
 824 };
 825
 826 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
 827
 828 /*
 829  * ptlbd, portal block device requests
 830  */
 831 typedef enum {
 832         PTLBD_QUERY = 200,
 833         PTLBD_READ = 201,
 834         PTLBD_WRITE = 202,
 835         PTLBD_FLUSH = 203,
 836         PTLBD_CONNECT = 204,
 837         PTLBD_DISCONNECT = 205,
 838         PTLBD_LAST_OPC
 839 } ptlbd_cmd_t;
 840 #define PTLBD_FIRST_OPC PTLBD_QUERY
 841
 842 struct ptlbd_op {
 843         __u16 op_cmd;
 844         __u16 op_lun;
 845         __u16 op_niob_cnt;
 846         __u16 op__padding;
 847         __u32 op_block_cnt;
 848 };
 849
 850 extern void lustre_swab_ptlbd_op (struct ptlbd_op *op);
 851
 852 struct ptlbd_niob {
 853         __u64 n_xid;
 854         __u64 n_block_nr;
 855         __u32 n_offset;
 856         __u32 n_length;
 857 };
 858
 859 extern void lustre_swab_ptlbd_niob (struct ptlbd_niob *n);
 860
 861 struct ptlbd_rsp {
 862         __u16 r_status;
 863         __u16 r_error_cnt;
 864 };
 865
 866 extern void lustre_swab_ptlbd_rsp (struct ptlbd_rsp *r);
 867
 868 /*
 869  * Opcodes for management/monitoring node.
 870  */
 871 typedef enum {
 872         MGMT_CONNECT = 250,
 873         MGMT_DISCONNECT,
 874         MGMT_EXCEPTION,         /* node died, etc. */
 875         MGMT_LAST_OPC
 876 } mgmt_cmd_t;
 877 #define MGMT_FIRST_OPC MGMT_CONNECT
 878
 879 /*
 880  * Opcodes for multiple servers.
 881  */
 882
 883 typedef enum {
 884         OBD_PING = 400,
 885         OBD_LOG_CANCEL,
 886         OBD_LAST_OPC
 887 } obd_cmd_t;
 888 #define OBD_FIRST_OPC OBD_PING
 889
 890 /* catalog of log objects */
 891
 892 /* Identifier for a single log object */
 893 struct llog_logid {
 894         __u64                   lgl_oid;
 895         __u64                   lgl_ogr;
 896         __u32                   lgl_ogen;
 897 } __attribute__((packed));
 898
 899 /* Records written to the CATALOGS list */
 900 #define CATLIST "CATALOGS"
 901 struct llog_catid {
 902         struct llog_logid       lci_logid;
 903         __u32                   lci_padding[3];
 904 } __attribute__((packed));
 905
 906 /* Log data record types - there is no specific reason that these need to
 907  * be related to the RPC opcodes, but no reason not to (may be handy later?)
 908  */
 909 typedef enum {
 910         OST_SZ_REC       = 0x10600000 | (OST_SAN_WRITE << 8),
 911         OST_RAID1_REC    = 0x10600000 | ((OST_SAN_WRITE + 1) << 8),
 912         MDS_UNLINK_REC   = 0x10610000 | (MDS_REINT << 8) | REINT_UNLINK,
 913         OBD_CFG_REC      = 0x10620000,
 914         PTL_CFG_REC      = 0x10630000,
 915         LLOG_GEN_REC     = 0x10640000,
 916         LLOG_HDR_MAGIC   = 0x10645539,
 917         LLOG_LOGID_MAGIC = 0x1064553b,
 918         SMFS_UPDATE_REC  = 0x10650000,
 919         CACHE_LRU_REC    = 0x10660000,
 920 } llog_op_type;
 921
 922 /* Log record header - stored in little endian order.
 923  * Each record must start with this struct, end with a llog_rec_tail,
 924  * and be a multiple of 256 bits in size.
 925  */
 926 struct llog_rec_hdr {
 927         __u32                   lrh_len;
 928         __u32                   lrh_index;
 929         __u32                   lrh_type;
 930         __u32                   padding;
 931 };
 932
 933 struct llog_rec_tail {
 934         __u32 lrt_len;
 935         __u32 lrt_index;
 936 };
 937
 938 struct llog_logid_rec {
 939         struct llog_rec_hdr     lid_hdr;
 940         struct llog_logid       lid_id;
 941         __u32                   padding[5];
 942         struct llog_rec_tail    lid_tail;
 943 } __attribute__((packed));
 944
 945 struct llog_create_rec {
 946         struct llog_rec_hdr     lcr_hdr;
 947         struct ll_fid           lcr_fid;
 948         obd_id                  lcr_oid;
 949         obd_count               lcr_ogen;
 950         __u32                   padding;
 951         struct llog_rec_tail    lcr_tail;
 952 } __attribute__((packed));
 953
 954 struct llog_orphan_rec {
 955         struct llog_rec_hdr     lor_hdr;
 956         obd_id                  lor_oid;
 957         obd_count               lor_ogen;
 958         __u32                   padding;
 959         struct llog_rec_tail    lor_tail;
 960 } __attribute__((packed));
 961
 962 struct llog_unlink_rec {
 963         struct llog_rec_hdr     lur_hdr;
 964         obd_id                  lur_oid;
 965         obd_count               lur_ogen;
 966         __u32                   padding;
 967         struct llog_rec_tail    lur_tail;
 968 } __attribute__((packed));
 969
 970 struct llog_size_change_rec {
 971         struct llog_rec_hdr     lsc_hdr;
 972         struct ll_fid           lsc_fid;
 973         __u32                   lsc_io_epoch;
 974         __u32                   padding;
 975         struct llog_rec_tail    lsc_tail;
 976 } __attribute__((packed));
 977
 978 struct llog_gen {
 979         __u64 mnt_cnt;
 980         __u64 conn_cnt;
 981 };
 982
 983 struct llog_gen_rec {
 984         struct llog_rec_hdr     lgr_hdr;
 985         struct llog_gen         lgr_gen;
 986         struct llog_rec_tail    lgr_tail;
 987 } __attribute__((packed));
 988
 989 struct llog_lru_rec {
 990         struct llog_rec_hdr     llr_hdr;
 991         struct ll_fid           llr_cfid;
 992         struct ll_fid           llr_pfid;
 993         struct llog_rec_tail    llr_tail;
 994 } __attribute__((packed));
 995
 996 /* On-disk header structure of each log object, stored in little endian order */
 997 #define LLOG_CHUNK_SIZE         8192
 998 #define LLOG_HEADER_SIZE        (96)
 999 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
1000
1001 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
1002
1003 /* flags for the logs */
1004 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
1005 #define LLOG_F_IS_CAT           0x2
1006 #define LLOG_F_IS_PLAIN         0x4
1007
1008 struct llog_log_hdr {
1009         struct llog_rec_hdr     llh_hdr;
1010         __u64                   llh_timestamp;
1011         __u32                   llh_count;
1012         __u32                   llh_bitmap_offset;
1013         __u32                   llh_size;
1014         __u32                   llh_flags;
1015         __u32                   llh_cat_idx;
1016         /* for a catalog the first plain slot is next to it */
1017         struct obd_uuid         llh_tgtuuid;
1018         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
1019         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
1020         struct llog_rec_tail    llh_tail;
1021 } __attribute__((packed));
1022
1023 /* log cookies are used to reference a specific log file and a record therein */
1024 struct llog_cookie {
1025         struct llog_logid       lgc_lgl;
1026         __u32                   lgc_subsys;
1027         __u32                   lgc_index;
1028         __u32                   lgc_padding;
1029 } __attribute__((packed));
1030
1031 /* llog protocol */
1032 enum llogd_rpc_ops {
1033         LLOG_ORIGIN_HANDLE_CREATE       = 501,
1034         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
1035         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
1036         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
1037         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
1038         LLOG_ORIGIN_CONNECT             = 506,
1039         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
1040         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
1041 };
1042
1043 struct llogd_body {
1044         struct llog_logid  lgd_logid;
1045         __u32 lgd_ctxt_idx;
1046         __u32 lgd_llh_flags;
1047         __u32 lgd_index;
1048         __u32 lgd_saved_index;
1049         __u32 lgd_len;
1050         __u64 lgd_cur_offset;
1051 } __attribute__((packed));
1052
1053 struct llogd_conn_body {
1054         struct llog_gen         lgdc_gen;
1055         struct llog_logid       lgdc_logid;
1056         __u32                   lgdc_ctxt_idx;
1057 } __attribute__((packed));
1058
1059 extern void lustre_swab_llogd_body (struct llogd_body *d);
1060 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
1061 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
1062
1063 static inline struct ll_fid *obdo_fid(struct obdo *oa)
1064 {
1065         return (struct ll_fid *)(oa->o_inline + sizeof(struct lustre_handle) +
1066                                  sizeof(struct llog_cookie));
1067 }
1068
1069 #endif