lustre/include/lustre/lustre_idl.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/lustre/lustre_idl.h
  37  *
  38  * Lustre wire protocol definitions.
  39  */
  40
  41 /** \defgroup lustreidl lustreidl
  42  *
  43  * Lustre wire protocol definitions.
  44  *
  45  * ALL structs passing over the wire should be declared here.  Structs
  46  * that are used in interfaces with userspace should go in lustre_user.h.
  47  *
  48  * All structs being declared here should be built from simple fixed-size
  49  * types (__u8, __u16, __u32, __u64) or be built from other types or
  50  * structs also declared in this file.  Similarly, all flags and magic
  51  * values in those structs should also be declared here.  This ensures
  52  * that the Lustre wire protocol is not influenced by external dependencies.
  53  *
  54  * The only other acceptable items in this file are VERY SIMPLE accessor
  55  * functions to avoid callers grubbing inside the structures, and the
  56  * prototypes of the swabber functions for each struct.  Nothing that
  57  * depends on external functions or definitions should be in here.
  58  *
  59  * Structs must be properly aligned to put 64-bit values on an 8-byte
  60  * boundary.  Any structs being added here must also be added to
  61  * utils/wirecheck.c and "make newwiretest" run to regenerate the
  62  * utils/wiretest.c sources.  This allows us to verify that wire structs
  63  * have the proper alignment/size on all architectures.
  64  *
  65  * DO NOT CHANGE any of the structs, flags, values declared here and used
  66  * in released Lustre versions.  Some structs may have padding fields that
  67  * can be used.  Some structs might allow addition at the end (verify this
  68  * in the code to ensure that new/old clients that see this larger struct
  69  * do not fail, otherwise you need to implement protocol compatibility).
  70  *
  71  * We assume all nodes are either little-endian or big-endian, and we
  72  * always send messages in the sender's native format.  The receiver
  73  * detects the message format by checking the 'magic' field of the message
  74  * (see lustre_msg_swabbed() below).
  75  *
  76  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
  77  * implemented either here, inline (trivial implementations) or in
  78  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
  79  * endian, in-place in the message buffer.
  80  *
  81  * A swabber takes a single pointer argument.  The caller must already have
  82  * verified that the length of the message buffer >= sizeof (type).
  83  *
  84  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
  85  * may be defined that swabs just the variable part, after the caller has
  86  * verified that the message buffer is large enough.
  87  *
  88  * @{
  89  */
  90
  91 #ifndef _LUSTRE_IDL_H_
  92 #define _LUSTRE_IDL_H_
  93
  94 #if !defined(LASSERT) && !defined(LPU64)
  95 #include <libcfs/libcfs.h> /* for LASSERT, LPUX64, etc */
  96 #endif
  97
  98 /* Defn's shared with user-space. */
  99 #include <lustre/lustre_user.h>
 100
 101 /*
 102  *  GENERAL STUFF
 103  */
 104 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
 105  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
 106  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
 107  */
 108
 109 #define CONNMGR_REQUEST_PORTAL          1
 110 #define CONNMGR_REPLY_PORTAL            2
 111 //#define OSC_REQUEST_PORTAL            3
 112 #define OSC_REPLY_PORTAL                4
 113 //#define OSC_BULK_PORTAL               5
 114 #define OST_IO_PORTAL                   6
 115 #define OST_CREATE_PORTAL               7
 116 #define OST_BULK_PORTAL                 8
 117 //#define MDC_REQUEST_PORTAL            9
 118 #define MDC_REPLY_PORTAL               10
 119 //#define MDC_BULK_PORTAL              11
 120 #define MDS_REQUEST_PORTAL             12
 121 //#define MDS_REPLY_PORTAL             13
 122 #define MDS_BULK_PORTAL                14
 123 #define LDLM_CB_REQUEST_PORTAL         15
 124 #define LDLM_CB_REPLY_PORTAL           16
 125 #define LDLM_CANCEL_REQUEST_PORTAL     17
 126 #define LDLM_CANCEL_REPLY_PORTAL       18
 127 //#define PTLBD_REQUEST_PORTAL           19
 128 //#define PTLBD_REPLY_PORTAL             20
 129 //#define PTLBD_BULK_PORTAL              21
 130 #define MDS_SETATTR_PORTAL             22
 131 #define MDS_READPAGE_PORTAL            23
 132 #define MDS_MDS_PORTAL                 24
 133
 134 #define MGC_REPLY_PORTAL               25
 135 #define MGS_REQUEST_PORTAL             26
 136 #define MGS_REPLY_PORTAL               27
 137 #define OST_REQUEST_PORTAL             28
 138 #define FLD_REQUEST_PORTAL             29
 139 #define SEQ_METADATA_PORTAL            30
 140 #define SEQ_DATA_PORTAL                31
 141 #define SEQ_CONTROLLER_PORTAL          32
 142 #define MGS_BULK_PORTAL                33
 143
 144 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
 145
 146 /* packet types */
 147 #define PTL_RPC_MSG_REQUEST 4711
 148 #define PTL_RPC_MSG_ERR     4712
 149 #define PTL_RPC_MSG_REPLY   4713
 150
 151 /* DON'T use swabbed values of MAGIC as magic! */
 152 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
 153 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
 154
 155 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
 156 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
 157
 158 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
 159
 160 #define PTLRPC_MSG_VERSION  0x00000003
 161 #define LUSTRE_VERSION_MASK 0xffff0000
 162 #define LUSTRE_OBD_VERSION  0x00010000
 163 #define LUSTRE_MDS_VERSION  0x00020000
 164 #define LUSTRE_OST_VERSION  0x00030000
 165 #define LUSTRE_DLM_VERSION  0x00040000
 166 #define LUSTRE_LOG_VERSION  0x00050000
 167 #define LUSTRE_MGS_VERSION  0x00060000
 168
 169 typedef __u32 mdsno_t;
 170 typedef __u64 seqno_t;
 171 typedef __u64 obd_id;
 172 typedef __u64 obd_seq;
 173 typedef __s64 obd_time;
 174 typedef __u64 obd_size;
 175 typedef __u64 obd_off;
 176 typedef __u64 obd_blocks;
 177 typedef __u64 obd_valid;
 178 typedef __u32 obd_blksize;
 179 typedef __u32 obd_mode;
 180 typedef __u32 obd_uid;
 181 typedef __u32 obd_gid;
 182 typedef __u32 obd_flag;
 183 typedef __u32 obd_count;
 184
 185 /**
 186  * Describes a range of sequence, lsr_start is included but lsr_end is
 187  * not in the range.
 188  * Same structure is used in fld module where lsr_index field holds mdt id
 189  * of the home mdt.
 190  */
 191
 192 #define LU_SEQ_RANGE_MDT        0x0
 193 #define LU_SEQ_RANGE_OST        0x1
 194
 195 struct lu_seq_range {
 196         __u64 lsr_start;
 197         __u64 lsr_end;
 198         __u32 lsr_index;
 199         __u32 lsr_flags;
 200 };
 201
 202 /**
 203  * returns  width of given range \a r
 204  */
 205
 206 static inline __u64 range_space(const struct lu_seq_range *range)
 207 {
 208         return range->lsr_end - range->lsr_start;
 209 }
 210
 211 /**
 212  * initialize range to zero
 213  */
 214
 215 static inline void range_init(struct lu_seq_range *range)
 216 {
 217         range->lsr_start = range->lsr_end = range->lsr_index = 0;
 218 }
 219
 220 /**
 221  * check if given seq id \a s is within given range \a r
 222  */
 223
 224 static inline int range_within(const struct lu_seq_range *range,
 225                                __u64 s)
 226 {
 227         return s >= range->lsr_start && s < range->lsr_end;
 228 }
 229
 230 static inline int range_is_sane(const struct lu_seq_range *range)
 231 {
 232         return (range->lsr_end >= range->lsr_start);
 233 }
 234
 235 static inline int range_is_zero(const struct lu_seq_range *range)
 236 {
 237         return (range->lsr_start == 0 && range->lsr_end == 0);
 238 }
 239
 240 static inline int range_is_exhausted(const struct lu_seq_range *range)
 241
 242 {
 243         return range_space(range) == 0;
 244 }
 245
 246 /* return 0 if two range have the same location */
 247 static inline int range_compare_loc(const struct lu_seq_range *r1,
 248                                     const struct lu_seq_range *r2)
 249 {
 250         return r1->lsr_index != r2->lsr_index ||
 251                r1->lsr_flags != r2->lsr_flags;
 252 }
 253
 254 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x):%x:%s"
 255
 256 #define PRANGE(range)      \
 257         (range)->lsr_start, \
 258         (range)->lsr_end,    \
 259         (range)->lsr_index,  \
 260         (range)->lsr_flags == LU_SEQ_RANGE_MDT ? "mdt" : "ost"
 261
 262
 263 /** \defgroup lu_fid lu_fid
 264  * @{ */
 265
 266 /**
 267  * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
 268  * Deprecated since HSM and SOM attributes are now stored in separate on-disk
 269  * xattr.
 270  */
 271 enum lma_compat {
 272         LMAC_HSM = 0x00000001,
 273         LMAC_SOM = 0x00000002,
 274 };
 275
 276 /**
 277  * Masks for all features that should be supported by a Lustre version to
 278  * access a specific file.
 279  * This information is stored in lustre_mdt_attrs::lma_incompat.
 280  */
 281 enum lma_incompat {
 282         LMAI_RELEASED = 0x0000001, /* file is released */
 283 };
 284 #define LMA_INCOMPAT_SUPP 0x0
 285
 286 /**
 287  * Following struct for MDT attributes, that will be kept inode's EA.
 288  * Introduced in 2.0 release (please see b15993, for details)
 289  */
 290 struct lustre_mdt_attrs {
 291         /**
 292          * Bitfield for supported data in this structure. From enum lma_compat.
 293          * lma_self_fid and lma_flags are always available.
 294          */
 295         __u32   lma_compat;
 296         /**
 297          * Per-file incompat feature list. Lustre version should support all
 298          * flags set in this field. The supported feature mask is available in
 299          * LMA_INCOMPAT_SUPP.
 300          */
 301         __u32   lma_incompat;
 302         /** FID of this inode */
 303         struct lu_fid  lma_self_fid;
 304         /** mdt/ost type, others */
 305         __u64   lma_flags;
 306 };
 307
 308 /**
 309  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 310  * been moved to a dedicated xattr
 311  */
 312 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 4 * sizeof(__u64))
 313
 314 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
 315 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
 316                             const struct lu_fid *fid);
 317 /**
 318  * SOM on-disk attributes stored in a separate xattr.
 319  */
 320 struct som_attrs {
 321         /** Bitfield for supported data in this structure. For future use. */
 322         __u32   som_compat;
 323
 324         /** Incompat feature list. The supported feature mask is availabe in
 325          * SOM_INCOMPAT_SUPP */
 326         __u32   som_incompat;
 327
 328         /** IO Epoch SOM attributes belongs to */
 329         __u64   som_ioepoch;
 330         /** total file size in objects */
 331         __u64   som_size;
 332         /** total fs blocks in objects */
 333         __u64   som_blocks;
 334         /** mds mount id the size is valid for */
 335         __u64   som_mountid;
 336 };
 337 extern void lustre_som_swab(struct som_attrs *attrs);
 338
 339 #define SOM_INCOMPAT_SUPP 0x0
 340
 341 /**
 342  * HSM on-disk attributes stored in a separate xattr.
 343  */
 344 struct hsm_attrs {
 345         /** Bitfield for supported data in this structure. For future use. */
 346         __u32   hsm_compat;
 347
 348         /** HSM flags, see hsm_flags enum below */
 349         __u32   hsm_flags;
 350         /** backend archive id associated with the file */
 351         __u64   hsm_arch_id;
 352         /** version associated with the last archiving, if any */
 353         __u64   hsm_arch_ver;
 354 };
 355 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
 356
 357 /* This is the maximum number of MDTs allowed in CMD testing until such
 358  * a time that FID-on-OST is implemented.  This is due to the limitations
 359  * of packing non-0-MDT numbers into the FID SEQ namespace.  Once FID-on-OST
 360  * is implemented this limit will be virtually unlimited. */
 361 #define MAX_MDT_COUNT 8
 362
 363
 364 /**
 365  * fid constants
 366  */
 367 enum {
 368         /** initial fid id value */
 369         LUSTRE_FID_INIT_OID  = 1UL
 370 };
 371
 372 /** returns fid object sequence */
 373 static inline __u64 fid_seq(const struct lu_fid *fid)
 374 {
 375         return fid->f_seq;
 376 }
 377
 378 /** returns fid object id */
 379 static inline __u32 fid_oid(const struct lu_fid *fid)
 380 {
 381         return fid->f_oid;
 382 }
 383
 384 /** returns fid object version */
 385 static inline __u32 fid_ver(const struct lu_fid *fid)
 386 {
 387         return fid->f_ver;
 388 }
 389
 390 static inline void fid_zero(struct lu_fid *fid)
 391 {
 392         memset(fid, 0, sizeof(*fid));
 393 }
 394
 395 static inline obd_id fid_ver_oid(const struct lu_fid *fid)
 396 {
 397         return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
 398 }
 399
 400 /**
 401  * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
 402  * inodes in the IGIF namespace, so these reserved SEQ numbers can be
 403  * used for other purposes and not risk collisions with existing inodes.
 404  *
 405  * Different FID Format
 406  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
 407  */
 408 enum fid_seq {
 409         FID_SEQ_OST_MDT0   = 0,
 410         FID_SEQ_LLOG       = 1,
 411         FID_SEQ_ECHO       = 2,
 412         FID_SEQ_OST_MDT1   = 3,
 413         FID_SEQ_OST_MAX    = 9, /* Max MDT count before OST_on_FID */
 414         FID_SEQ_RSVD       = 11,
 415         FID_SEQ_IGIF       = 12,
 416         FID_SEQ_IGIF_MAX   = 0x0ffffffffULL,
 417         FID_SEQ_IDIF       = 0x100000000ULL,
 418         FID_SEQ_IDIF_MAX   = 0x1ffffffffULL,
 419         /* Normal FID sequence starts from this value, i.e. 1<<33 */
 420         FID_SEQ_START      = 0x200000000ULL,
 421         /* sequence for local pre-defined FIDs listed in local_oid */
 422         FID_SEQ_LOCAL_FILE = 0x200000001ULL,
 423         FID_SEQ_DOT_LUSTRE = 0x200000002ULL,
 424         /* sequence is used for local named objects FIDs generated
 425          * by local_object_storage library */
 426         FID_SEQ_LOCAL_NAME = 0x200000003ULL,
 427         FID_SEQ_SPECIAL    = 0x200000004ULL,
 428         FID_SEQ_QUOTA      = 0x200000005ULL,
 429         FID_SEQ_QUOTA_GLB  = 0x200000006ULL,
 430         FID_SEQ_NORMAL     = 0x200000400ULL,
 431         FID_SEQ_LOV_DEFAULT= 0xffffffffffffffffULL
 432 };
 433
 434 #define OBIF_OID_MAX_BITS           32
 435 #define OBIF_MAX_OID                (1ULL << OBIF_OID_MAX_BITS)
 436 #define OBIF_OID_MASK               ((1ULL << OBIF_OID_MAX_BITS) - 1)
 437 #define IDIF_OID_MAX_BITS           48
 438 #define IDIF_MAX_OID                (1ULL << IDIF_OID_MAX_BITS)
 439 #define IDIF_OID_MASK               ((1ULL << IDIF_OID_MAX_BITS) - 1)
 440
 441 /** OID for FID_SEQ_SPECIAL */
 442 enum special_oid {
 443         /* Big Filesystem Lock to serialize rename operations */
 444         FID_OID_SPECIAL_BFL     = 1UL,
 445 };
 446
 447 /** OID for FID_SEQ_DOT_LUSTRE */
 448 enum dot_lustre_oid {
 449         FID_OID_DOT_LUSTRE  = 1UL,
 450         FID_OID_DOT_LUSTRE_OBF = 2UL,
 451 };
 452
 453 static inline int fid_seq_is_mdt0(obd_seq seq)
 454 {
 455         return (seq == FID_SEQ_OST_MDT0);
 456 }
 457
 458 static inline int fid_seq_is_cmd(const __u64 seq)
 459 {
 460         return (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
 461 };
 462
 463 static inline int fid_seq_is_mdt(const __u64 seq)
 464 {
 465         return seq == FID_SEQ_OST_MDT0 ||
 466                (seq >= FID_SEQ_OST_MDT1 && seq <= FID_SEQ_OST_MAX);
 467 };
 468
 469 static inline int fid_seq_is_rsvd(const __u64 seq)
 470 {
 471         return (seq > FID_SEQ_OST_MDT0 && seq <= FID_SEQ_RSVD);
 472 };
 473
 474 static inline int fid_is_mdt0(const struct lu_fid *fid)
 475 {
 476         return fid_seq_is_mdt0(fid_seq(fid));
 477 }
 478
 479 /**
 480  * Check if a fid is igif or not.
 481  * \param fid the fid to be tested.
 482  * \return true if the fid is a igif; otherwise false.
 483  */
 484 static inline int fid_seq_is_igif(const __u64 seq)
 485 {
 486         return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
 487 }
 488
 489 static inline int fid_is_igif(const struct lu_fid *fid)
 490 {
 491         return fid_seq_is_igif(fid_seq(fid));
 492 }
 493
 494 /**
 495  * Check if a fid is idif or not.
 496  * \param fid the fid to be tested.
 497  * \return true if the fid is a idif; otherwise false.
 498  */
 499 static inline int fid_seq_is_idif(const __u64 seq)
 500 {
 501         return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
 502 }
 503
 504 static inline int fid_is_idif(const struct lu_fid *fid)
 505 {
 506         return fid_seq_is_idif(fid_seq(fid));
 507 }
 508
 509 struct ost_id {
 510         obd_id                 oi_id;
 511         obd_seq                oi_seq;
 512 };
 513
 514 static inline int fid_seq_is_norm(const __u64 seq)
 515 {
 516         return (seq >= FID_SEQ_NORMAL);
 517 }
 518
 519 static inline int fid_is_norm(const struct lu_fid *fid)
 520 {
 521         return fid_seq_is_norm(fid_seq(fid));
 522 }
 523
 524 /* convert an OST objid into an IDIF FID SEQ number */
 525 static inline obd_seq fid_idif_seq(obd_id id, __u32 ost_idx)
 526 {
 527         return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
 528 }
 529
 530 /* convert a packed IDIF FID into an OST objid */
 531 static inline obd_id fid_idif_id(obd_seq seq, __u32 oid, __u32 ver)
 532 {
 533         return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
 534 }
 535
 536 /* extract ost index from IDIF FID */
 537 static inline __u32 fid_idif_ost_idx(const struct lu_fid *fid)
 538 {
 539         LASSERT(fid_is_idif(fid));
 540         return (fid_seq(fid) >> 16) & 0xffff;
 541 }
 542
 543 /* unpack an ostid (id/seq) from a wire/disk structure into an IDIF FID */
 544 static inline void ostid_idif_unpack(struct ost_id *ostid,
 545                                      struct lu_fid *fid, __u32 ost_idx)
 546 {
 547         fid->f_seq = fid_idif_seq(ostid->oi_id, ost_idx);
 548         fid->f_oid = ostid->oi_id;       /* truncate to 32 bits by assignment */
 549         fid->f_ver = ostid->oi_id >> 48; /* in theory, not currently used */
 550 }
 551
 552 /* unpack an ostid (id/seq) from a wire/disk structure into a non-IDIF FID */
 553 static inline void ostid_fid_unpack(struct ost_id *ostid, struct lu_fid *fid)
 554 {
 555         fid->f_seq = ostid->oi_seq;
 556         fid->f_oid = ostid->oi_id;       /* truncate to 32 bits by assignment */
 557         fid->f_ver = ostid->oi_id >> 32; /* in theory, not currently used */
 558 }
 559
 560 /* Unpack an OST object id/seq (group) into a FID.  This is needed for
 561  * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
 562  * FIDs.  Note that if an id/seq is already in FID/IDIF format it will
 563  * be passed through unchanged.  Only legacy OST objects in "group 0"
 564  * will be mapped into the IDIF namespace so that they can fit into the
 565  * struct lu_fid fields without loss.  For reference see:
 566  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
 567  */
 568 static inline int fid_ostid_unpack(struct lu_fid *fid, struct ost_id *ostid,
 569                                    __u32 ost_idx)
 570 {
 571         if (ost_idx > 0xffff) {
 572                 CERROR("bad ost_idx, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
 573                        ostid->oi_seq, ostid->oi_id, ost_idx);
 574                 return -EBADF;
 575         }
 576
 577         if (fid_seq_is_mdt0(ostid->oi_seq)) {
 578                 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
 579                  * that we map into the IDIF namespace.  It allows up to 2^48
 580                  * objects per OST, as this is the object namespace that has
 581                  * been in production for years.  This can handle create rates
 582                  * of 1M objects/s/OST for 9 years, or combinations thereof. */
 583                 if (ostid->oi_id >= IDIF_MAX_OID) {
 584                          CERROR("bad MDT0 id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
 585                                 ostid->oi_seq, ostid->oi_id, ost_idx);
 586                          return -EBADF;
 587                 }
 588                 ostid_idif_unpack(ostid, fid, ost_idx);
 589
 590         } else if (fid_seq_is_rsvd(ostid->oi_seq)) {
 591                 /* These are legacy OST objects for LLOG/ECHO and CMD testing.
 592                  * We only support 2^32 objects in these groups, and cannot
 593                  * uniquely identify them in the system (i.e. they are the
 594                  * duplicated on all OSTs), but this is not strictly required
 595                  * for the old object protocol, which has a separate ost_idx. */
 596                 if (ostid->oi_id >= 0xffffffffULL) {
 597                          CERROR("bad RSVD id, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
 598                                 ostid->oi_seq, ostid->oi_id, ost_idx);
 599                          return -EBADF;
 600                 }
 601                 ostid_fid_unpack(ostid, fid);
 602
 603         } else if (unlikely(fid_seq_is_igif(ostid->oi_seq))) {
 604                 /* This is an MDT inode number, which should never collide with
 605                  * proper OST object IDs, and is probably a broken filesystem */
 606                 CERROR("bad IGIF, seq:"LPU64" id:"LPU64" ost_idx:%u\n",
 607                        ostid->oi_seq, ostid->oi_id, ost_idx);
 608                 return -EBADF;
 609
 610         } else /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
 611                /* This is either an IDIF object, which identifies objects across
 612                 * all OSTs, or a regular FID.  The IDIF namespace maps legacy
 613                 * OST objects into the FID namespace.  In both cases, we just
 614                 * pass the FID through, no conversion needed. */
 615                 ostid_fid_unpack(ostid, fid);
 616         }
 617
 618         return 0;
 619 }
 620
 621 /* pack an IDIF FID into an ostid (id/seq) for the wire/disk */
 622 static inline void ostid_idif_pack(const struct lu_fid *fid,
 623                                    struct ost_id *ostid)
 624 {
 625         ostid->oi_seq = FID_SEQ_OST_MDT0;
 626         ostid->oi_id  = fid_idif_id(fid->f_seq, fid->f_oid, fid->f_ver);
 627 }
 628
 629 /* pack a non-IDIF FID into an ostid (id/seq) for the wire/disk */
 630 static inline void ostid_fid_pack(const struct lu_fid *fid,
 631                                   struct ost_id *ostid)
 632 {
 633         ostid->oi_seq = fid_seq(fid);
 634         ostid->oi_id  = fid_ver_oid(fid);
 635 }
 636
 637 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
 638 static inline int fid_ostid_pack(const struct lu_fid *fid,
 639                                  struct ost_id *ostid)
 640 {
 641         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
 642                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
 643                 return -EBADF;
 644         }
 645
 646         if (fid_is_idif(fid))
 647                 ostid_idif_pack(fid, ostid);
 648         else
 649                 ostid_fid_pack(fid, ostid);
 650
 651         return 0;
 652 }
 653
 654 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
 655 static inline obd_seq ostid_seq(struct ost_id *ostid)
 656 {
 657         if (unlikely(fid_seq_is_igif(ostid->oi_seq)))
 658                 CWARN("bad IGIF, oi_seq: "LPU64" oi_id: "LPX64"\n",
 659                       ostid->oi_seq, ostid->oi_id);
 660
 661         if (unlikely(fid_seq_is_idif(ostid->oi_seq)))
 662                 return FID_SEQ_OST_MDT0;
 663
 664         return ostid->oi_seq;
 665 }
 666
 667 /* extract OST objid from a wire ost_id (id/seq) pair */
 668 static inline obd_id ostid_id(struct ost_id *ostid)
 669 {
 670         if (ostid->oi_seq == FID_SEQ_OST_MDT0)
 671                 return ostid->oi_id & IDIF_OID_MASK;
 672
 673         if (fid_seq_is_rsvd(ostid->oi_seq))
 674                 return ostid->oi_id & OBIF_OID_MASK;
 675
 676         if (fid_seq_is_idif(ostid->oi_seq))
 677                 return fid_idif_id(ostid->oi_seq, ostid->oi_id, 0);
 678
 679         return ostid->oi_id;
 680 }
 681
 682 /**
 683  * Get inode number from a igif.
 684  * \param fid a igif to get inode number from.
 685  * \return inode number for the igif.
 686  */
 687 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
 688 {
 689         return fid_seq(fid);
 690 }
 691
 692 /**
 693  * Build igif from the inode number/generation.
 694  */
 695 #define LU_IGIF_BUILD(fid, ino, gen)                    \
 696 do {                                                    \
 697         fid->f_seq = ino;                               \
 698         fid->f_oid = gen;                               \
 699         fid->f_ver = 0;                                 \
 700 } while(0)
 701 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
 702 {
 703         LU_IGIF_BUILD(fid, ino, gen);
 704         LASSERT(fid_is_igif(fid));
 705 }
 706
 707 /**
 708  * Get inode generation from a igif.
 709  * \param fid a igif to get inode generation from.
 710  * \return inode generation for the igif.
 711  */
 712 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
 713 {
 714         return fid_oid(fid);
 715 }
 716
 717 /*
 718  * Fids are transmitted across network (in the sender byte-ordering),
 719  * and stored on disk in big-endian order.
 720  */
 721 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
 722 {
 723         /* check that all fields are converted */
 724         CLASSERT(sizeof *src ==
 725                  sizeof fid_seq(src) +
 726                  sizeof fid_oid(src) + sizeof fid_ver(src));
 727         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
 728         dst->f_seq = cpu_to_le64(fid_seq(src));
 729         dst->f_oid = cpu_to_le32(fid_oid(src));
 730         dst->f_ver = cpu_to_le32(fid_ver(src));
 731 }
 732
 733 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
 734 {
 735         /* check that all fields are converted */
 736         CLASSERT(sizeof *src ==
 737                  sizeof fid_seq(src) +
 738                  sizeof fid_oid(src) + sizeof fid_ver(src));
 739         dst->f_seq = le64_to_cpu(fid_seq(src));
 740         dst->f_oid = le32_to_cpu(fid_oid(src));
 741         dst->f_ver = le32_to_cpu(fid_ver(src));
 742         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
 743 }
 744
 745 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
 746 {
 747         /* check that all fields are converted */
 748         CLASSERT(sizeof *src ==
 749                  sizeof fid_seq(src) +
 750                  sizeof fid_oid(src) + sizeof fid_ver(src));
 751         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
 752         dst->f_seq = cpu_to_be64(fid_seq(src));
 753         dst->f_oid = cpu_to_be32(fid_oid(src));
 754         dst->f_ver = cpu_to_be32(fid_ver(src));
 755 }
 756
 757 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
 758 {
 759         /* check that all fields are converted */
 760         CLASSERT(sizeof *src ==
 761                  sizeof fid_seq(src) +
 762                  sizeof fid_oid(src) + sizeof fid_ver(src));
 763         dst->f_seq = be64_to_cpu(fid_seq(src));
 764         dst->f_oid = be32_to_cpu(fid_oid(src));
 765         dst->f_ver = be32_to_cpu(fid_ver(src));
 766         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
 767 }
 768
 769 static inline int fid_is_sane(const struct lu_fid *fid)
 770 {
 771         return
 772                 fid != NULL &&
 773                 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
 774                                                 && fid_ver(fid) == 0) ||
 775                 fid_is_igif(fid) || fid_seq_is_rsvd(fid_seq(fid)));
 776 }
 777
 778 static inline int fid_is_zero(const struct lu_fid *fid)
 779 {
 780         return fid_seq(fid) == 0 && fid_oid(fid) == 0;
 781 }
 782
 783 extern void lustre_swab_lu_fid(struct lu_fid *fid);
 784 extern void lustre_swab_lu_seq_range(struct lu_seq_range *range);
 785
 786 static inline int lu_fid_eq(const struct lu_fid *f0,
 787                             const struct lu_fid *f1)
 788 {
 789         /* Check that there is no alignment padding. */
 790         CLASSERT(sizeof *f0 ==
 791                  sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
 792         LASSERTF((fid_is_igif(f0) || fid_is_idif(f0)) ||
 793                  fid_ver(f0) == 0, DFID, PFID(f0));
 794         LASSERTF((fid_is_igif(f1) || fid_is_idif(f1)) ||
 795                  fid_ver(f1) == 0, DFID, PFID(f1));
 796         return memcmp(f0, f1, sizeof *f0) == 0;
 797 }
 798
 799 #define __diff_normalize(val0, val1)                            \
 800 ({                                                              \
 801         typeof(val0) __val0 = (val0);                           \
 802         typeof(val1) __val1 = (val1);                           \
 803                                                                 \
 804         (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1);     \
 805 })
 806
 807 static inline int lu_fid_cmp(const struct lu_fid *f0,
 808                              const struct lu_fid *f1)
 809 {
 810         return
 811                 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
 812                 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
 813                 __diff_normalize(fid_ver(f0), fid_ver(f1));
 814 }
 815
 816 /** @} lu_fid */
 817
 818 /** \defgroup lu_dir lu_dir
 819  * @{ */
 820
 821 /**
 822  * Enumeration of possible directory entry attributes.
 823  *
 824  * Attributes follow directory entry header in the order they appear in this
 825  * enumeration.
 826  */
 827 enum lu_dirent_attrs {
 828         LUDA_FID        = 0x0001,
 829         LUDA_TYPE       = 0x0002,
 830         LUDA_64BITHASH  = 0x0004,
 831 };
 832
 833 /**
 834  * Layout of readdir pages, as transmitted on wire.
 835  */
 836 struct lu_dirent {
 837         /** valid if LUDA_FID is set. */
 838         struct lu_fid lde_fid;
 839         /** a unique entry identifier: a hash or an offset. */
 840         __u64         lde_hash;
 841         /** total record length, including all attributes. */
 842         __u16         lde_reclen;
 843         /** name length */
 844         __u16         lde_namelen;
 845         /** optional variable size attributes following this entry.
 846          *  taken from enum lu_dirent_attrs.
 847          */
 848         __u32         lde_attrs;
 849         /** name is followed by the attributes indicated in ->ldp_attrs, in
 850          *  their natural order. After the last attribute, padding bytes are
 851          *  added to make ->lde_reclen a multiple of 8.
 852          */
 853         char          lde_name[0];
 854 };
 855
 856 /*
 857  * Definitions of optional directory entry attributes formats.
 858  *
 859  * Individual attributes do not have their length encoded in a generic way. It
 860  * is assumed that consumer of an attribute knows its format. This means that
 861  * it is impossible to skip over an unknown attribute, except by skipping over all
 862  * remaining attributes (by using ->lde_reclen), which is not too
 863  * constraining, because new server versions will append new attributes at
 864  * the end of an entry.
 865  */
 866
 867 /**
 868  * Fid directory attribute: a fid of an object referenced by the entry. This
 869  * will be almost always requested by the client and supplied by the server.
 870  *
 871  * Aligned to 8 bytes.
 872  */
 873 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
 874
 875 /**
 876  * File type.
 877  *
 878  * Aligned to 2 bytes.
 879  */
 880 struct luda_type {
 881         __u16 lt_type;
 882 };
 883
 884 struct lu_dirpage {
 885         __u64            ldp_hash_start;
 886         __u64            ldp_hash_end;
 887         __u32            ldp_flags;
 888         __u32            ldp_pad0;
 889         struct lu_dirent ldp_entries[0];
 890 };
 891
 892 enum lu_dirpage_flags {
 893         /**
 894          * dirpage contains no entry.
 895          */
 896         LDF_EMPTY   = 1 << 0,
 897         /**
 898          * last entry's lde_hash equals ldp_hash_end.
 899          */
 900         LDF_COLLIDE = 1 << 1
 901 };
 902
 903 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
 904 {
 905         if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
 906                 return NULL;
 907         else
 908                 return dp->ldp_entries;
 909 }
 910
 911 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
 912 {
 913         struct lu_dirent *next;
 914
 915         if (le16_to_cpu(ent->lde_reclen) != 0)
 916                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
 917         else
 918                 next = NULL;
 919
 920         return next;
 921 }
 922
 923 static inline int lu_dirent_calc_size(int namelen, __u16 attr)
 924 {
 925         int size;
 926
 927         if (attr & LUDA_TYPE) {
 928                 const unsigned align = sizeof(struct luda_type) - 1;
 929                 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
 930                 size += sizeof(struct luda_type);
 931         } else
 932                 size = sizeof(struct lu_dirent) + namelen;
 933
 934         return (size + 7) & ~7;
 935 }
 936
 937 static inline int lu_dirent_size(struct lu_dirent *ent)
 938 {
 939         if (le16_to_cpu(ent->lde_reclen) == 0) {
 940                 return lu_dirent_calc_size(le16_to_cpu(ent->lde_namelen),
 941                                            le32_to_cpu(ent->lde_attrs));
 942         }
 943         return le16_to_cpu(ent->lde_reclen);
 944 }
 945
 946 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
 947
 948 /**
 949  * MDS_READPAGE page size
 950  *
 951  * This is the directory page size packed in MDS_READPAGE RPC.
 952  * It's different than CFS_PAGE_SIZE because the client needs to
 953  * access the struct lu_dirpage header packed at the beginning of
 954  * the "page" and without this there isn't any way to know find the
 955  * lu_dirpage header is if client and server CFS_PAGE_SIZE differ.
 956  */
 957 #define LU_PAGE_SHIFT 12
 958 #define LU_PAGE_SIZE  (1UL << LU_PAGE_SHIFT)
 959 #define LU_PAGE_MASK  (~(LU_PAGE_SIZE - 1))
 960
 961 #define LU_PAGE_COUNT (1 << (CFS_PAGE_SHIFT - LU_PAGE_SHIFT))
 962
 963 /** @} lu_dir */
 964
 965 struct lustre_handle {
 966         __u64 cookie;
 967 };
 968 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
 969
 970 static inline int lustre_handle_is_used(struct lustre_handle *lh)
 971 {
 972         return lh->cookie != 0ull;
 973 }
 974
 975 static inline int lustre_handle_equal(const struct lustre_handle *lh1,
 976                                       const struct lustre_handle *lh2)
 977 {
 978         return lh1->cookie == lh2->cookie;
 979 }
 980
 981 static inline void lustre_handle_copy(struct lustre_handle *tgt,
 982                                       struct lustre_handle *src)
 983 {
 984         tgt->cookie = src->cookie;
 985 }
 986
 987 /* flags for lm_flags */
 988 #define MSGHDR_AT_SUPPORT               0x1
 989 #define MSGHDR_CKSUM_INCOMPAT18         0x2
 990
 991 #define lustre_msg lustre_msg_v2
 992 /* we depend on this structure to be 8-byte aligned */
 993 /* this type is only endian-adjusted in lustre_unpack_msg() */
 994 struct lustre_msg_v2 {
 995         __u32 lm_bufcount;
 996         __u32 lm_secflvr;
 997         __u32 lm_magic;
 998         __u32 lm_repsize;
 999         __u32 lm_cksum;
1000         __u32 lm_flags;
1001         __u32 lm_padding_2;
1002         __u32 lm_padding_3;
1003         __u32 lm_buflens[0];
1004 };
1005
1006 /* without gss, ptlrpc_body is put at the first buffer. */
1007 #define PTLRPC_NUM_VERSIONS     4
1008 #define JOBSTATS_JOBID_SIZE     32  /* 32 bytes string */
1009 struct ptlrpc_body_v3 {
1010         struct lustre_handle pb_handle;
1011         __u32 pb_type;
1012         __u32 pb_version;
1013         __u32 pb_opc;
1014         __u32 pb_status;
1015         __u64 pb_last_xid;
1016         __u64 pb_last_seen;
1017         __u64 pb_last_committed;
1018         __u64 pb_transno;
1019         __u32 pb_flags;
1020         __u32 pb_op_flags;
1021         __u32 pb_conn_cnt;
1022         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1023         __u32 pb_service_time; /* for rep, actual service time */
1024         __u32 pb_limit;
1025         __u64 pb_slv;
1026         /* VBR: pre-versions */
1027         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1028         /* padding for future needs */
1029         __u64 pb_padding[4];
1030         char  pb_jobid[JOBSTATS_JOBID_SIZE];
1031 };
1032 #define ptlrpc_body     ptlrpc_body_v3
1033
1034 struct ptlrpc_body_v2 {
1035         struct lustre_handle pb_handle;
1036         __u32 pb_type;
1037         __u32 pb_version;
1038         __u32 pb_opc;
1039         __u32 pb_status;
1040         __u64 pb_last_xid;
1041         __u64 pb_last_seen;
1042         __u64 pb_last_committed;
1043         __u64 pb_transno;
1044         __u32 pb_flags;
1045         __u32 pb_op_flags;
1046         __u32 pb_conn_cnt;
1047         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1048         __u32 pb_service_time; /* for rep, actual service time, also used for
1049                                   net_latency of req */
1050         __u32 pb_limit;
1051         __u64 pb_slv;
1052         /* VBR: pre-versions */
1053         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1054         /* padding for future needs */
1055         __u64 pb_padding[4];
1056 };
1057
1058 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
1059
1060 /* message body offset for lustre_msg_v2 */
1061 /* ptlrpc body offset in all request/reply messages */
1062 #define MSG_PTLRPC_BODY_OFF             0
1063
1064 /* normal request/reply message record offset */
1065 #define REQ_REC_OFF                     1
1066 #define REPLY_REC_OFF                   1
1067
1068 /* ldlm request message body offset */
1069 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
1070 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
1071
1072 /* ldlm intent lock message body offset */
1073 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
1074 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
1075
1076 /* ldlm reply message body offset */
1077 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
1078 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
1079
1080 /** only use in req->rq_{req,rep}_swab_mask */
1081 #define MSG_PTLRPC_HEADER_OFF           31
1082
1083 /* Flags that are operation-specific go in the top 16 bits. */
1084 #define MSG_OP_FLAG_MASK   0xffff0000
1085 #define MSG_OP_FLAG_SHIFT  16
1086
1087 /* Flags that apply to all requests are in the bottom 16 bits */
1088 #define MSG_GEN_FLAG_MASK     0x0000ffff
1089 #define MSG_LAST_REPLAY           0x0001
1090 #define MSG_RESENT                0x0002
1091 #define MSG_REPLAY                0x0004
1092 /* #define MSG_AT_SUPPORT         0x0008
1093  * This was used in early prototypes of adaptive timeouts, and while there
1094  * shouldn't be any users of that code there also isn't a need for using this
1095  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1096 #define MSG_DELAY_REPLAY          0x0010
1097 #define MSG_VERSION_REPLAY        0x0020
1098 #define MSG_REQ_REPLAY_DONE       0x0040
1099 #define MSG_LOCK_REPLAY_DONE      0x0080
1100
1101 /*
1102  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1103  */
1104
1105 #define MSG_CONNECT_RECOVERING  0x00000001
1106 #define MSG_CONNECT_RECONNECT   0x00000002
1107 #define MSG_CONNECT_REPLAYABLE  0x00000004
1108 //#define MSG_CONNECT_PEER        0x8
1109 #define MSG_CONNECT_LIBCLIENT   0x00000010
1110 #define MSG_CONNECT_INITIAL     0x00000020
1111 #define MSG_CONNECT_ASYNC       0x00000040
1112 #define MSG_CONNECT_NEXT_VER    0x00000080 /* use next version of lustre_msg */
1113 #define MSG_CONNECT_TRANSNO     0x00000100 /* report transno */
1114
1115 /* Connect flags */
1116 #define OBD_CONNECT_RDONLY                0x1ULL /*client has read-only access*/
1117 #define OBD_CONNECT_INDEX                 0x2ULL /*connect specific LOV idx */
1118 #define OBD_CONNECT_MDS                   0x4ULL /*connect from MDT to OST */
1119 #define OBD_CONNECT_GRANT                 0x8ULL /*OSC gets grant at connect */
1120 #define OBD_CONNECT_SRVLOCK              0x10ULL /*server takes locks for cli */
1121 #define OBD_CONNECT_VERSION              0x20ULL /*Lustre versions in ocd */
1122 #define OBD_CONNECT_REQPORTAL            0x40ULL /*Separate non-IO req portal */
1123 #define OBD_CONNECT_ACL                  0x80ULL /*access control lists */
1124 #define OBD_CONNECT_XATTR               0x100ULL /*client use extended attr */
1125 #define OBD_CONNECT_CROW                0x200ULL /*MDS+OST create obj on write*/
1126 #define OBD_CONNECT_TRUNCLOCK           0x400ULL /*locks on server for punch */
1127 #define OBD_CONNECT_TRANSNO             0x800ULL /*replay sends init transno */
1128 #define OBD_CONNECT_IBITS              0x1000ULL /*support for inodebits locks*/
1129 #define OBD_CONNECT_JOIN               0x2000ULL /*files can be concatenated.
1130                                                   *We do not support JOIN FILE
1131                                                   *anymore, reserve this flags
1132                                                   *just for preventing such bit
1133                                                   *to be reused.*/
1134 #define OBD_CONNECT_ATTRFID            0x4000ULL /*Server can GetAttr By Fid*/
1135 #define OBD_CONNECT_NODEVOH            0x8000ULL /*No open hndl on specl nodes*/
1136 #define OBD_CONNECT_RMT_CLIENT        0x10000ULL /*Remote client */
1137 #define OBD_CONNECT_RMT_CLIENT_FORCE  0x20000ULL /*Remote client by force */
1138 #define OBD_CONNECT_BRW_SIZE          0x40000ULL /*Max bytes per rpc */
1139 #define OBD_CONNECT_QUOTA64           0x80000ULL /*Not used since 2.4 */
1140 #define OBD_CONNECT_MDS_CAPA         0x100000ULL /*MDS capability */
1141 #define OBD_CONNECT_OSS_CAPA         0x200000ULL /*OSS capability */
1142 #define OBD_CONNECT_CANCELSET        0x400000ULL /*Early batched cancels. */
1143 #define OBD_CONNECT_SOM              0x800000ULL /*Size on MDS */
1144 #define OBD_CONNECT_AT              0x1000000ULL /*client uses AT */
1145 #define OBD_CONNECT_LRU_RESIZE      0x2000000ULL /*LRU resize feature. */
1146 #define OBD_CONNECT_MDS_MDS         0x4000000ULL /*MDS-MDS connection */
1147 #define OBD_CONNECT_REAL            0x8000000ULL /*real connection */
1148 #define OBD_CONNECT_CHANGE_QS      0x10000000ULL /*Not used since 2.4 */
1149 #define OBD_CONNECT_CKSUM          0x20000000ULL /*support several cksum algos*/
1150 #define OBD_CONNECT_FID            0x40000000ULL /*FID is supported by server */
1151 #define OBD_CONNECT_VBR            0x80000000ULL /*version based recovery */
1152 #define OBD_CONNECT_LOV_V3        0x100000000ULL /*client supports LOV v3 EA */
1153 #define OBD_CONNECT_GRANT_SHRINK  0x200000000ULL /* support grant shrink */
1154 #define OBD_CONNECT_SKIP_ORPHAN   0x400000000ULL /* don't reuse orphan objids */
1155 #define OBD_CONNECT_MAX_EASIZE    0x800000000ULL /* preserved for large EA */
1156 #define OBD_CONNECT_FULL20       0x1000000000ULL /* it is 2.0 client */
1157 #define OBD_CONNECT_LAYOUTLOCK   0x2000000000ULL /* client uses layout lock */
1158 #define OBD_CONNECT_64BITHASH    0x4000000000ULL /* client supports 64-bits
1159                                                   * directory hash */
1160 #define OBD_CONNECT_MAXBYTES     0x8000000000ULL /* max stripe size */
1161 #define OBD_CONNECT_IMP_RECOV   0x10000000000ULL /* imp recovery support */
1162 #define OBD_CONNECT_JOBSTATS    0x20000000000ULL /* jobid in ptlrpc_body */
1163 #define OBD_CONNECT_UMASK       0x40000000000ULL /* create uses client umask */
1164 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1165                                                   * RPC error properly */
1166 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1167                                                   * finer space reservation */
1168 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
1169                                                    * policy and 2.x server */
1170 #define OBD_CONNECT_LVB_TYPE    0x400000000000ULL /* variable type of LVB */
1171 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
1172 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1173 #define OBD_CONNECT_SHORTIO     0x2000000000000ULL/* short io */
1174 /* XXX README XXX:
1175  * Please DO NOT add flag values here before first ensuring that this same
1176  * flag value is not in use on some other branch.  Please clear any such
1177  * changes with senior engineers before starting to use a new flag.  Then,
1178  * submit a small patch against EVERY branch that ONLY adds the new flag
1179  * and updates obd_connect_names[] for lprocfs_rd_connect_flags(), so it
1180  * can be approved and landed easily to reserve the flag for future use. */
1181
1182 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1183  * connection.  It is a temporary bug fix for Imperative Recovery interop
1184  * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1185  * 2.2 clients/servers is no longer needed.  LU-1252/LU-1644. */
1186 #define OBD_CONNECT_MNE_SWAB             OBD_CONNECT_MDS_MDS
1187
1188 #define OCD_HAS_FLAG(ocd, flg)  \
1189         (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1190
1191
1192 #ifdef HAVE_LRU_RESIZE_SUPPORT
1193 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1194 #else
1195 #define LRU_RESIZE_CONNECT_FLAG 0
1196 #endif
1197
1198 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1199                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1200                                 OBD_CONNECT_IBITS | \
1201                                 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1202                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1203                                 OBD_CONNECT_RMT_CLIENT | \
1204                                 OBD_CONNECT_RMT_CLIENT_FORCE | \
1205                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_CAPA | \
1206                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_MDS_MDS | \
1207                                 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1208                                 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1209                                 OBD_CONNECT_SOM | OBD_CONNECT_FULL20 | \
1210                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1211                                 OBD_CONNECT_EINPROGRESS | \
1212                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
1213                                 OBD_CONNECT_LVB_TYPE)
1214 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1215                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1216                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1217                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_OSS_CAPA | \
1218                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1219                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1220                                 OBD_CONNECT_RMT_CLIENT | \
1221                                 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1222                                 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1223                                 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1224                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1225                                 OBD_CONNECT_MAX_EASIZE | \
1226                                 OBD_CONNECT_EINPROGRESS | \
1227                                 OBD_CONNECT_JOBSTATS | \
1228                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE)
1229 #define ECHO_CONNECT_SUPPORTED (0)
1230 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1231                                 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1232                                 OBD_CONNECT_MNE_SWAB)
1233
1234 /* Features required for this version of the client to work with server */
1235 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1236                                  OBD_CONNECT_FULL20)
1237
1238 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
1239                                                 ((patch)<<8) + (fix))
1240 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
1241 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
1242 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
1243 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
1244
1245 /* This structure is used for both request and reply.
1246  *
1247  * If we eventually have separate connect data for different types, which we
1248  * almost certainly will, then perhaps we stick a union in here. */
1249 struct obd_connect_data_v1 {
1250         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1251         __u32 ocd_version;       /* lustre release version number */
1252         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1253         __u32 ocd_index;         /* LOV index to connect to */
1254         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1255         __u64 ocd_ibits_known;   /* inode bits this client understands */
1256         __u8  ocd_blocksize;     /* log2 of the backend filesystem blocksize */
1257         __u8  ocd_inodespace;    /* log2 of the per-inode space consumption */
1258         __u16 ocd_grant_extent;  /* per-extent grant overhead, in 1K blocks */
1259         __u32 ocd_unused;        /* also fix lustre_swab_connect */
1260         __u64 ocd_transno;       /* first transno from client to be replayed */
1261         __u32 ocd_group;         /* MDS group on OST */
1262         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1263         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1264         __u32 ocd_instance;      /* also fix lustre_swab_connect */
1265         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1266 };
1267
1268 struct obd_connect_data {
1269         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1270         __u32 ocd_version;       /* lustre release version number */
1271         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1272         __u32 ocd_index;         /* LOV index to connect to */
1273         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1274         __u64 ocd_ibits_known;   /* inode bits this client understands */
1275         __u8  ocd_blocksize;     /* log2 of the backend filesystem blocksize */
1276         __u8  ocd_inodespace;    /* log2 of the per-inode space consumption */
1277         __u16 ocd_grant_extent;  /* per-extent grant overhead, in 1K blocks */
1278         __u32 ocd_unused;        /* also fix lustre_swab_connect */
1279         __u64 ocd_transno;       /* first transno from client to be replayed */
1280         __u32 ocd_group;         /* MDS group on OST */
1281         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1282         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1283         __u32 ocd_instance;      /* instance # of this target */
1284         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1285         /* Fields after ocd_maxbytes are only accessible by the receiver
1286          * if the corresponding flag in ocd_connect_flags is set. Accessing
1287          * any field after ocd_maxbytes on the receiver without a valid flag
1288          * may result in out-of-bound memory access and kernel oops. */
1289         __u64 padding1;          /* added 2.1.0. also fix lustre_swab_connect */
1290         __u64 padding2;          /* added 2.1.0. also fix lustre_swab_connect */
1291         __u64 padding3;          /* added 2.1.0. also fix lustre_swab_connect */
1292         __u64 padding4;          /* added 2.1.0. also fix lustre_swab_connect */
1293         __u64 padding5;          /* added 2.1.0. also fix lustre_swab_connect */
1294         __u64 padding6;          /* added 2.1.0. also fix lustre_swab_connect */
1295         __u64 padding7;          /* added 2.1.0. also fix lustre_swab_connect */
1296         __u64 padding8;          /* added 2.1.0. also fix lustre_swab_connect */
1297         __u64 padding9;          /* added 2.1.0. also fix lustre_swab_connect */
1298         __u64 paddingA;          /* added 2.1.0. also fix lustre_swab_connect */
1299         __u64 paddingB;          /* added 2.1.0. also fix lustre_swab_connect */
1300         __u64 paddingC;          /* added 2.1.0. also fix lustre_swab_connect */
1301         __u64 paddingD;          /* added 2.1.0. also fix lustre_swab_connect */
1302         __u64 paddingE;          /* added 2.1.0. also fix lustre_swab_connect */
1303         __u64 paddingF;          /* added 2.1.0. also fix lustre_swab_connect */
1304 };
1305 /* XXX README XXX:
1306  * Please DO NOT use any fields here before first ensuring that this same
1307  * field is not in use on some other branch.  Please clear any such changes
1308  * with senior engineers before starting to use a new field.  Then, submit
1309  * a small patch against EVERY branch that ONLY adds the new field along with
1310  * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1311  * reserve the flag for future use. */
1312
1313
1314 extern void lustre_swab_connect(struct obd_connect_data *ocd);
1315
1316 /*
1317  * Supported checksum algorithms. Up to 32 checksum types are supported.
1318  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1319  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1320  * algorithm and also the OBD_FL_CKSUM* flags.
1321  */
1322 typedef enum {
1323         OBD_CKSUM_CRC32 = 0x00000001,
1324         OBD_CKSUM_ADLER = 0x00000002,
1325         OBD_CKSUM_CRC32C= 0x00000004,
1326 } cksum_type_t;
1327
1328 /*
1329  *   OST requests: OBDO & OBD request records
1330  */
1331
1332 /* opcodes */
1333 typedef enum {
1334         OST_REPLY      =  0,       /* reply ? */
1335         OST_GETATTR    =  1,
1336         OST_SETATTR    =  2,
1337         OST_READ       =  3,
1338         OST_WRITE      =  4,
1339         OST_CREATE     =  5,
1340         OST_DESTROY    =  6,
1341         OST_GET_INFO   =  7,
1342         OST_CONNECT    =  8,
1343         OST_DISCONNECT =  9,
1344         OST_PUNCH      = 10,
1345         OST_OPEN       = 11,
1346         OST_CLOSE      = 12,
1347         OST_STATFS     = 13,
1348         OST_SYNC       = 16,
1349         OST_SET_INFO   = 17,
1350         OST_QUOTACHECK = 18,
1351         OST_QUOTACTL   = 19,
1352         OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1353         OST_LAST_OPC
1354 } ost_cmd_t;
1355 #define OST_FIRST_OPC  OST_REPLY
1356
1357 enum obdo_flags {
1358         OBD_FL_INLINEDATA   = 0x00000001,
1359         OBD_FL_OBDMDEXISTS  = 0x00000002,
1360         OBD_FL_DELORPHAN    = 0x00000004, /* if set in o_flags delete orphans */
1361         OBD_FL_NORPC        = 0x00000008, /* set in o_flags do in OSC not OST */
1362         OBD_FL_IDONLY       = 0x00000010, /* set in o_flags only adjust obj id*/
1363         OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1364         OBD_FL_DEBUG_CHECK  = 0x00000040, /* echo client/server debug check */
1365         OBD_FL_NO_USRQUOTA  = 0x00000100, /* the object's owner is over quota */
1366         OBD_FL_NO_GRPQUOTA  = 0x00000200, /* the object's group is over quota */
1367         OBD_FL_CREATE_CROW  = 0x00000400, /* object should be create on write */
1368         OBD_FL_SRVLOCK      = 0x00000800, /* delegate DLM locking to server */
1369         OBD_FL_CKSUM_CRC32  = 0x00001000, /* CRC32 checksum type */
1370         OBD_FL_CKSUM_ADLER  = 0x00002000, /* ADLER checksum type */
1371         OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1372         OBD_FL_CKSUM_RSVD2  = 0x00008000, /* for future cksum types */
1373         OBD_FL_CKSUM_RSVD3  = 0x00010000, /* for future cksum types */
1374         OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1375         OBD_FL_MMAP         = 0x00040000, /* object is mmapped on the client.
1376                                            * XXX: obsoleted - reserved for old
1377                                            * clients prior than 2.2 */
1378         OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1379         OBD_FL_NOSPC_BLK    = 0x00100000, /* no more block space on OST */
1380
1381         /* Note that while these checksum values are currently separate bits,
1382          * in 2.x we can actually allow all values from 1-31 if we wanted. */
1383         OBD_FL_CKSUM_ALL    = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1384                               OBD_FL_CKSUM_CRC32C,
1385
1386         /* mask for local-only flag, which won't be sent over network */
1387         OBD_FL_LOCAL_MASK   = 0xF0000000,
1388 };
1389
1390 #define LOV_MAGIC_V1      0x0BD10BD0
1391 #define LOV_MAGIC         LOV_MAGIC_V1
1392 #define LOV_MAGIC_JOIN_V1 0x0BD20BD0
1393 #define LOV_MAGIC_V3      0x0BD30BD0
1394
1395 /*
1396  * magic for fully defined striping
1397  * the idea is that we should have different magics for striping "hints"
1398  * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1399  * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1400  * we can't just change it w/o long way preparation, but we still need a
1401  * mechanism to allow LOD to differentiate hint versus ready striping.
1402  * so, at the moment we do a trick: MDT knows what to expect from request
1403  * depending on the case (replay uses ready striping, non-replay req uses
1404  * hints), so MDT replaces magic with appropriate one and now LOD can
1405  * easily understand what's inside -bzzz
1406  */
1407 #define LOV_MAGIC_V1_DEF  0x0CD10BD0
1408 #define LOV_MAGIC_V3_DEF  0x0CD30BD0
1409
1410 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
1411 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
1412 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
1413 #define LOV_PATTERN_CMOBD 0x200
1414
1415 #define lov_ost_data lov_ost_data_v1
1416 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
1417         __u64 l_object_id;        /* OST object ID */
1418         __u64 l_object_seq;       /* OST object seq number */
1419         __u32 l_ost_gen;          /* generation of this l_ost_idx */
1420         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
1421 };
1422
1423 #define lov_mds_md lov_mds_md_v1
1424 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
1425         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
1426         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1427         __u64 lmm_object_id;      /* LOV object ID */
1428         __u64 lmm_object_seq;     /* LOV object seq number */
1429         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1430         /* lmm_stripe_count used to be __u32 */
1431         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1432         __u16 lmm_layout_gen;     /* layout generation number */
1433         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1434 };
1435
1436 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
1437
1438 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1439 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1440
1441 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
1442 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
1443 #define XATTR_USER_PREFIX       "user."
1444 #define XATTR_TRUSTED_PREFIX    "trusted."
1445 #define XATTR_SECURITY_PREFIX   "security."
1446 #define XATTR_LUSTRE_PREFIX     "lustre."
1447
1448 #define XATTR_NAME_LOV          "trusted.lov"
1449 #define XATTR_NAME_LMA          "trusted.lma"
1450 #define XATTR_NAME_LMV          "trusted.lmv"
1451 #define XATTR_NAME_LINK         "trusted.link"
1452 #define XATTR_NAME_FID          "trusted.fid"
1453 #define XATTR_NAME_VERSION      "trusted.version"
1454 #define XATTR_NAME_SOM          "trusted.som"
1455 #define XATTR_NAME_HSM          "trusted.hsm"
1456
1457
1458 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
1459         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
1460         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1461         __u64 lmm_object_id;      /* LOV object ID */
1462         __u64 lmm_object_seq;     /* LOV object seq number */
1463         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1464         /* lmm_stripe_count used to be __u32 */
1465         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1466         __u16 lmm_layout_gen;     /* layout generation number */
1467         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
1468         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1469 };
1470
1471
1472 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
1473 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
1474 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
1475 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
1476 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
1477 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
1478 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
1479 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1480 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
1481 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
1482 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
1483 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
1484 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
1485 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
1486 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
1487 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
1488 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
1489 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
1490 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
1491 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
1492 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
1493 /*#define OBD_MD_FLOSCOPQ    (0x00400000ULL) osc opaque data, never used */
1494 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
1495 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
1496 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
1497 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write with ioepoch */
1498                                            /* ->mds if epoch opens or closes */
1499 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
1500 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
1501 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
1502 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
1503 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1504
1505 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
1506 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
1507 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
1508
1509 /* OBD_MD_MDTIDX is used to get MDT index, but it is never been used overwire,
1510  * and it is already obsolete since 2.3 */
1511 /* #define OBD_MD_MDTIDX      (0x0000000800000000ULL) */
1512
1513 #define OBD_MD_FLXATTR       (0x0000001000000000ULL) /* xattr */
1514 #define OBD_MD_FLXATTRLS     (0x0000002000000000ULL) /* xattr list */
1515 #define OBD_MD_FLXATTRRM     (0x0000004000000000ULL) /* xattr remove */
1516 #define OBD_MD_FLACL         (0x0000008000000000ULL) /* ACL */
1517 #define OBD_MD_FLRMTPERM     (0x0000010000000000ULL) /* remote permission */
1518 #define OBD_MD_FLMDSCAPA     (0x0000020000000000ULL) /* MDS capability */
1519 #define OBD_MD_FLOSSCAPA     (0x0000040000000000ULL) /* OSS capability */
1520 #define OBD_MD_FLCKSPLIT     (0x0000080000000000ULL) /* Check split on server */
1521 #define OBD_MD_FLCROSSREF    (0x0000100000000000ULL) /* Cross-ref case */
1522 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1523                                                       * under lock */
1524 #define OBD_MD_FLOBJCOUNT    (0x0000400000000000ULL) /* for multiple destroy */
1525
1526 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1527 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1528 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1529 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1530
1531 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1532
1533 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1534                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
1535                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
1536                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1537                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
1538
1539 /* don't forget obdo_fid which is way down at the bottom so it can
1540  * come after the definition of llog_cookie */
1541
1542
1543 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
1544
1545 /* ost_body.data values for OST_BRW */
1546
1547 #define OBD_BRW_READ            0x01
1548 #define OBD_BRW_WRITE           0x02
1549 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
1550 #define OBD_BRW_SYNC            0x08 /* this page is a part of synchronous
1551                                       * transfer and is not accounted in
1552                                       * the grant. */
1553 #define OBD_BRW_CHECK           0x10
1554 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
1555 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
1556 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
1557 #define OBD_BRW_NOQUOTA        0x100
1558 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
1559 #define OBD_BRW_ASYNC          0x400 /* Server may delay commit to disk */
1560 #define OBD_BRW_MEMALLOC       0x800 /* Client runs in the "kswapd" context */
1561 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1562 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1563
1564 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
1565
1566 #define OST_MIN_PRECREATE 32
1567 #define OST_MAX_PRECREATE 20000
1568
1569 struct obd_ioobj {
1570         obd_id               ioo_id;
1571         obd_seq              ioo_seq;
1572         __u32                ioo_type;
1573         __u32                ioo_bufcnt;
1574 };
1575
1576 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1577
1578 /* multiple of 8 bytes => can array */
1579 struct niobuf_remote {
1580         __u64 offset;
1581         __u32 len;
1582         __u32 flags;
1583 };
1584
1585 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1586
1587 /* lock value block communicated between the filter and llite */
1588
1589 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1590  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1591 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1592 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1593 #define OST_LVB_IS_ERR(blocks)                                          \
1594         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1595 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1596         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1597 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1598
1599 struct ost_lvb_v1 {
1600         __u64           lvb_size;
1601         obd_time        lvb_mtime;
1602         obd_time        lvb_atime;
1603         obd_time        lvb_ctime;
1604         __u64           lvb_blocks;
1605 };
1606
1607 extern void lustre_swab_ost_lvb_v1(struct ost_lvb_v1 *lvb);
1608
1609 struct ost_lvb {
1610         __u64           lvb_size;
1611         obd_time        lvb_mtime;
1612         obd_time        lvb_atime;
1613         obd_time        lvb_ctime;
1614         __u64           lvb_blocks;
1615         __u32           lvb_mtime_ns;
1616         __u32           lvb_atime_ns;
1617         __u32           lvb_ctime_ns;
1618         __u32           lvb_padding;
1619 };
1620
1621 extern void lustre_swab_ost_lvb(struct ost_lvb *lvb);
1622
1623 /*
1624  *   lquota data structures
1625  */
1626
1627 #ifndef QUOTABLOCK_BITS
1628 #define QUOTABLOCK_BITS 10
1629 #endif
1630
1631 #ifndef QUOTABLOCK_SIZE
1632 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
1633 #endif
1634
1635 #ifndef toqb
1636 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
1637 #endif
1638
1639 /* The lquota_id structure is an union of all the possible identifier types that
1640  * can be used with quota, this includes:
1641  * - 64-bit user ID
1642  * - 64-bit group ID
1643  * - a FID which can be used for per-directory quota in the future */
1644 union lquota_id {
1645         struct lu_fid   qid_fid; /* FID for per-directory quota */
1646         __u64           qid_uid; /* user identifier */
1647         __u64           qid_gid; /* group identifier */
1648 };
1649
1650 /* quotactl management */
1651 struct obd_quotactl {
1652         __u32                   qc_cmd;
1653         __u32                   qc_type; /* see Q_* flag below */
1654         __u32                   qc_id;
1655         __u32                   qc_stat;
1656         struct obd_dqinfo       qc_dqinfo;
1657         struct obd_dqblk        qc_dqblk;
1658 };
1659
1660 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1661
1662 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
1663 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
1664 #define Q_GETOINFO      0x800102 /* get obd quota info */
1665 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
1666 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
1667
1668 #define Q_COPY(out, in, member) (out)->member = (in)->member
1669
1670 #define QCTL_COPY(out, in)              \
1671 do {                                    \
1672         Q_COPY(out, in, qc_cmd);        \
1673         Q_COPY(out, in, qc_type);       \
1674         Q_COPY(out, in, qc_id);         \
1675         Q_COPY(out, in, qc_stat);       \
1676         Q_COPY(out, in, qc_dqinfo);     \
1677         Q_COPY(out, in, qc_dqblk);      \
1678 } while (0)
1679
1680 /* Body of quota request used for quota acquire/release RPCs between quota
1681  * master (aka QMT) and slaves (ak QSD). */
1682 struct quota_body {
1683         struct lu_fid   qb_fid;     /* FID of global index packing the pool ID
1684                                       * and type (data or metadata) as well as
1685                                       * the quota type (user or group). */
1686         union lquota_id qb_id;      /* uid or gid or directory FID */
1687         __u32           qb_flags;   /* see below */
1688         __u32           qb_padding;
1689         __u64           qb_count;   /* acquire/release count (kbytes/inodes) */
1690         __u64           qb_usage;   /* current slave usage (kbytes/inodes) */
1691         __u64           qb_slv_ver; /* slave index file version */
1692         struct lustre_handle    qb_lockh;     /* per-ID lock handle */
1693         struct lustre_handle    qb_glb_lockh; /* global lock handle */
1694         __u64           qb_padding1[4];
1695 };
1696
1697 /* When the quota_body is used in the reply of quota global intent
1698  * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1699 #define qb_slv_fid      qb_fid
1700 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1701  * quota reply */
1702 #define qb_qunit        qb_usage
1703
1704 #define QUOTA_DQACQ_FL_ACQ      0x1  /* acquire quota */
1705 #define QUOTA_DQACQ_FL_PREACQ   0x2  /* pre-acquire */
1706 #define QUOTA_DQACQ_FL_REL      0x4  /* release quota */
1707 #define QUOTA_DQACQ_FL_REPORT   0x8  /* report usage */
1708
1709 extern void lustre_swab_quota_body(struct quota_body *b);
1710
1711 /* Quota types currently supported */
1712 enum {
1713         LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1714         LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1715         LQUOTA_TYPE_MAX
1716 };
1717
1718 /* There are 2 different resource types on which a quota limit can be enforced:
1719  * - inodes on the MDTs
1720  * - blocks on the OSTs */
1721 enum {
1722         LQUOTA_RES_MD           = 0x01, /* skip 0 to avoid null oid in FID */
1723         LQUOTA_RES_DT           = 0x02,
1724         LQUOTA_LAST_RES,
1725         LQUOTA_FIRST_RES        = LQUOTA_RES_MD
1726 };
1727 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1728
1729 /*
1730  * Space accounting support
1731  * Format of an accounting record, providing disk usage information for a given
1732  * user or group
1733  */
1734 struct lquota_acct_rec { /* 16 bytes */
1735         __u64 bspace;  /* current space in use */
1736         __u64 ispace;  /* current # inodes in use */
1737 };
1738
1739 /*
1740  * Global quota index support
1741  * Format of a global record, providing global quota settings for a given quota
1742  * identifier
1743  */
1744 struct lquota_glb_rec { /* 32 bytes */
1745         __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1746         __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1747         __u64 qbr_time;      /* grace time, in seconds */
1748         __u64 qbr_granted;   /* how much is granted to slaves, in #inodes or
1749                               * kbytes */
1750 };
1751
1752 /*
1753  * Slave index support
1754  * Format of a slave record, recording how much space is granted to a given
1755  * slave
1756  */
1757 struct lquota_slv_rec { /* 8 bytes */
1758         __u64 qsr_granted; /* space granted to the slave for the key=ID,
1759                             * in #inodes or kbytes */
1760 };
1761
1762 /* Data structures associated with the quota locks */
1763
1764 /* Glimpse descriptor used for the index & per-ID quota locks */
1765 struct ldlm_gl_lquota_desc {
1766         union lquota_id gl_id;    /* quota ID subject to the glimpse */
1767         __u64           gl_flags; /* see LQUOTA_FL* below */
1768         __u64           gl_ver;   /* new index version */
1769         __u64           gl_hardlimit; /* new hardlimit or qunit value */
1770         __u64           gl_softlimit; /* new softlimit */
1771         __u64           gl_pad1;
1772         __u64           gl_pad2;
1773 };
1774 #define gl_qunit        gl_hardlimit /* current qunit value used when
1775                                       * glimpsing per-ID quota locks */
1776
1777 /* quota glimpse flags */
1778 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
1779
1780 /* LVB used with quota (global and per-ID) locks */
1781 struct lquota_lvb {
1782         __u64   lvb_flags;      /* see LQUOTA_FL* above */
1783         __u64   lvb_id_may_rel; /* space that might be released later */
1784         __u64   lvb_id_rel;     /* space released by the slave for this ID */
1785         __u64   lvb_id_qunit;   /* current qunit value */
1786         __u64   lvb_pad1;
1787 };
1788
1789 extern void lustre_swab_lquota_lvb(struct lquota_lvb *lvb);
1790
1791 /* LVB used with global quota lock */
1792 #define lvb_glb_ver  lvb_id_may_rel /* current version of the global index */
1793
1794 /* op codes */
1795 typedef enum {
1796         QUOTA_DQACQ     = 601,
1797         QUOTA_DQREL     = 602,
1798         QUOTA_LAST_OPC
1799 } quota_cmd_t;
1800 #define QUOTA_FIRST_OPC QUOTA_DQACQ
1801
1802 /*
1803  *   MDS REQ RECORDS
1804  */
1805
1806 /* opcodes */
1807 typedef enum {
1808         MDS_GETATTR      = 33,
1809         MDS_GETATTR_NAME = 34,
1810         MDS_CLOSE        = 35,
1811         MDS_REINT        = 36,
1812         MDS_READPAGE     = 37,
1813         MDS_CONNECT      = 38,
1814         MDS_DISCONNECT   = 39,
1815         MDS_GETSTATUS    = 40,
1816         MDS_STATFS       = 41,
1817         MDS_PIN          = 42,
1818         MDS_UNPIN        = 43,
1819         MDS_SYNC         = 44,
1820         MDS_DONE_WRITING = 45,
1821         MDS_SET_INFO     = 46,
1822         MDS_QUOTACHECK   = 47,
1823         MDS_QUOTACTL     = 48,
1824         MDS_GETXATTR     = 49,
1825         MDS_SETXATTR     = 50, /* obsolete, now it's MDS_REINT op */
1826         MDS_WRITEPAGE    = 51,
1827         MDS_IS_SUBDIR    = 52,
1828         MDS_GET_INFO     = 53,
1829         MDS_LAST_OPC
1830 } mds_cmd_t;
1831
1832 #define MDS_FIRST_OPC    MDS_GETATTR
1833
1834 /*
1835  * Do not exceed 63
1836  */
1837
1838 typedef enum {
1839         REINT_SETATTR  = 1,
1840         REINT_CREATE   = 2,
1841         REINT_LINK     = 3,
1842         REINT_UNLINK   = 4,
1843         REINT_RENAME   = 5,
1844         REINT_OPEN     = 6,
1845         REINT_SETXATTR = 7,
1846 //      REINT_CLOSE    = 8,
1847 //      REINT_WRITE    = 9,
1848         REINT_MAX
1849 } mds_reint_t, mdt_reint_t;
1850
1851 extern void lustre_swab_generic_32s (__u32 *val);
1852
1853 /* the disposition of the intent outlines what was executed */
1854 #define DISP_IT_EXECD        0x00000001
1855 #define DISP_LOOKUP_EXECD    0x00000002
1856 #define DISP_LOOKUP_NEG      0x00000004
1857 #define DISP_LOOKUP_POS      0x00000008
1858 #define DISP_OPEN_CREATE     0x00000010
1859 #define DISP_OPEN_OPEN       0x00000020
1860 #define DISP_ENQ_COMPLETE    0x00400000
1861 #define DISP_ENQ_OPEN_REF    0x00800000
1862 #define DISP_ENQ_CREATE_REF  0x01000000
1863 #define DISP_OPEN_LOCK       0x02000000
1864
1865 /* INODE LOCK PARTS */
1866 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
1867 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
1868 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
1869 #define MDS_INODELOCK_LAYOUT 0x000008       /* for layout */
1870
1871 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits
1872  * XXX: MDS_INODELOCK_MAXSHIFT should be increased to 3 once the layout lock is
1873  * supported */
1874 #define MDS_INODELOCK_MAXSHIFT 2
1875 /* This FULL lock is useful to take on unlink sort of operations */
1876 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1877
1878 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1879
1880 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
1881  * but was moved into name[1] along with the OID to avoid consuming the
1882  * name[2,3] fields that need to be used for the quota id (also a FID). */
1883 enum {
1884         LUSTRE_RES_ID_SEQ_OFF = 0,
1885         LUSTRE_RES_ID_VER_OID_OFF = 1,
1886         LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
1887         LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
1888         LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
1889         LUSTRE_RES_ID_HSH_OFF = 3
1890 };
1891
1892 #define MDS_STATUS_CONN 1
1893 #define MDS_STATUS_LOV 2
1894
1895 /* mdt_thread_info.mti_flags. */
1896 enum md_op_flags {
1897         /* The flag indicates Size-on-MDS attributes are changed. */
1898         MF_SOM_CHANGE           = (1 << 0),
1899         /* Flags indicates an epoch opens or closes. */
1900         MF_EPOCH_OPEN           = (1 << 1),
1901         MF_EPOCH_CLOSE          = (1 << 2),
1902         MF_MDC_CANCEL_FID1      = (1 << 3),
1903         MF_MDC_CANCEL_FID2      = (1 << 4),
1904         MF_MDC_CANCEL_FID3      = (1 << 5),
1905         MF_MDC_CANCEL_FID4      = (1 << 6),
1906         /* There is a pending attribute update. */
1907         MF_SOM_AU               = (1 << 7),
1908         /* Cancel OST locks while getattr OST attributes. */
1909         MF_GETATTR_LOCK         = (1 << 8),
1910         MF_GET_MDT_IDX          = (1 << 9),
1911 };
1912
1913 #define MF_SOM_LOCAL_FLAGS (MF_SOM_CHANGE | MF_EPOCH_OPEN | MF_EPOCH_CLOSE)
1914
1915 #define LUSTRE_BFLAG_UNCOMMITTED_WRITES   0x1
1916
1917 /* these should be identical to their EXT4_*_FL counterparts, they are
1918  * redefined here only to avoid dragging in fs/ext4/ext4.h */
1919 #define LUSTRE_SYNC_FL         0x00000008 /* Synchronous updates */
1920 #define LUSTRE_IMMUTABLE_FL    0x00000010 /* Immutable file */
1921 #define LUSTRE_APPEND_FL       0x00000020 /* writes to file may only append */
1922 #define LUSTRE_NOATIME_FL      0x00000080 /* do not update atime */
1923 #define LUSTRE_DIRSYNC_FL      0x00010000 /* dirsync behaviour (dir only) */
1924
1925 #ifdef __KERNEL__
1926 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
1927  * for the client inode i_flags.  The LUSTRE_*_FL are the Lustre wire
1928  * protocol equivalents of LDISKFS_*_FL values stored on disk, while
1929  * the S_* flags are kernel-internal values that change between kernel
1930  * versions.  These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
1931  * See b=16526 for a full history. */
1932 static inline int ll_ext_to_inode_flags(int flags)
1933 {
1934         return (((flags & LUSTRE_SYNC_FL)      ? S_SYNC      : 0) |
1935                 ((flags & LUSTRE_NOATIME_FL)   ? S_NOATIME   : 0) |
1936                 ((flags & LUSTRE_APPEND_FL)    ? S_APPEND    : 0) |
1937 #if defined(S_DIRSYNC)
1938                 ((flags & LUSTRE_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1939 #endif
1940                 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
1941 }
1942
1943 static inline int ll_inode_to_ext_flags(int iflags)
1944 {
1945         return (((iflags & S_SYNC)      ? LUSTRE_SYNC_FL      : 0) |
1946                 ((iflags & S_NOATIME)   ? LUSTRE_NOATIME_FL   : 0) |
1947                 ((iflags & S_APPEND)    ? LUSTRE_APPEND_FL    : 0) |
1948 #if defined(S_DIRSYNC)
1949                 ((iflags & S_DIRSYNC)   ? LUSTRE_DIRSYNC_FL   : 0) |
1950 #endif
1951                 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
1952 }
1953 #endif
1954
1955 struct mdt_body {
1956         struct lu_fid  fid1;
1957         struct lu_fid  fid2;
1958         struct lustre_handle handle;
1959         __u64          valid;
1960         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1961        obd_time        mtime;
1962        obd_time        atime;
1963        obd_time        ctime;
1964         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1965         __u64          ioepoch;
1966         __u64          ino;
1967         __u32          fsuid;
1968         __u32          fsgid;
1969         __u32          capability;
1970         __u32          mode;
1971         __u32          uid;
1972         __u32          gid;
1973         __u32          flags; /* from vfs for pin/unpin, LUSTRE_BFLAG close */
1974         __u32          rdev;
1975         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1976         __u32          generation;
1977         __u32          suppgid;
1978         __u32          eadatasize;
1979         __u32          aclsize;
1980         __u32          max_mdsize;
1981         __u32          max_cookiesize;
1982         __u32          uid_h; /* high 32-bits of uid, for FUID */
1983         __u32          gid_h; /* high 32-bits of gid, for FUID */
1984         __u32          padding_5; /* also fix lustre_swab_mdt_body */
1985         __u64          padding_6;
1986         __u64          padding_7;
1987         __u64          padding_8;
1988         __u64          padding_9;
1989         __u64          padding_10;
1990 }; /* 216 */
1991
1992 extern void lustre_swab_mdt_body (struct mdt_body *b);
1993
1994 struct mdt_ioepoch {
1995         struct lustre_handle handle;
1996         __u64  ioepoch;
1997         __u32  flags;
1998         __u32  padding;
1999 };
2000
2001 extern void lustre_swab_mdt_ioepoch (struct mdt_ioepoch *b);
2002
2003 /* permissions for md_perm.mp_perm */
2004 enum {
2005         CFS_SETUID_PERM = 0x01,
2006         CFS_SETGID_PERM = 0x02,
2007         CFS_SETGRP_PERM = 0x04,
2008         CFS_RMTACL_PERM = 0x08,
2009         CFS_RMTOWN_PERM = 0x10
2010 };
2011
2012 /* inode access permission for remote user, the inode info are omitted,
2013  * for client knows them. */
2014 struct mdt_remote_perm {
2015         __u32           rp_uid;
2016         __u32           rp_gid;
2017         __u32           rp_fsuid;
2018         __u32           rp_fsuid_h;
2019         __u32           rp_fsgid;
2020         __u32           rp_fsgid_h;
2021         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
2022         __u32           rp_padding;
2023 };
2024
2025 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
2026
2027 struct mdt_rec_setattr {
2028         __u32           sa_opcode;
2029         __u32           sa_cap;
2030         __u32           sa_fsuid;
2031         __u32           sa_fsuid_h;
2032         __u32           sa_fsgid;
2033         __u32           sa_fsgid_h;
2034         __u32           sa_suppgid;
2035         __u32           sa_suppgid_h;
2036         __u32           sa_padding_1;
2037         __u32           sa_padding_1_h;
2038         struct lu_fid   sa_fid;
2039         __u64           sa_valid;
2040         __u32           sa_uid;
2041         __u32           sa_gid;
2042         __u64           sa_size;
2043         __u64           sa_blocks;
2044         obd_time        sa_mtime;
2045         obd_time        sa_atime;
2046         obd_time        sa_ctime;
2047         __u32           sa_attr_flags;
2048         __u32           sa_mode;
2049         __u32           sa_padding_2;
2050         __u32           sa_padding_3;
2051         __u32           sa_padding_4;
2052         __u32           sa_padding_5;
2053 };
2054
2055 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
2056
2057 /*
2058  * Attribute flags used in mdt_rec_setattr::sa_valid.
2059  * The kernel's #defines for ATTR_* should not be used over the network
2060  * since the client and MDS may run different kernels (see bug 13828)
2061  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
2062  */
2063 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
2064 #define MDS_ATTR_UID           0x2ULL /* = 2 */
2065 #define MDS_ATTR_GID           0x4ULL /* = 4 */
2066 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
2067 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
2068 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
2069 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
2070 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
2071 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
2072 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
2073 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
2074 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
2075 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
2076 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
2077 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
2078 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
2079
2080 #ifndef FMODE_READ
2081 #define FMODE_READ               00000001
2082 #define FMODE_WRITE              00000002
2083 #endif
2084
2085 #define MDS_FMODE_CLOSED         00000000
2086 #define MDS_FMODE_EXEC           00000004
2087 /* IO Epoch is opened on a closed file. */
2088 #define MDS_FMODE_EPOCH          01000000
2089 /* IO Epoch is opened on a file truncate. */
2090 #define MDS_FMODE_TRUNC          02000000
2091 /* Size-on-MDS Attribute Update is pending. */
2092 #define MDS_FMODE_SOM            04000000
2093
2094 #define MDS_OPEN_CREATED         00000010
2095 #define MDS_OPEN_CROSS           00000020
2096
2097 #define MDS_OPEN_CREAT           00000100
2098 #define MDS_OPEN_EXCL            00000200
2099 #define MDS_OPEN_TRUNC           00001000
2100 #define MDS_OPEN_APPEND          00002000
2101 #define MDS_OPEN_SYNC            00010000
2102 #define MDS_OPEN_DIRECTORY       00200000
2103
2104 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
2105 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
2106 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
2107 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
2108                                            * We do not support JOIN FILE
2109                                            * anymore, reserve this flags
2110                                            * just for preventing such bit
2111                                            * to be reused. */
2112
2113 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
2114 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
2115 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
2116 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
2117 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
2118                                               * hsm restore) */
2119
2120 /* permission for create non-directory file */
2121 #define MAY_CREATE      (1 << 7)
2122 /* permission for create directory file */
2123 #define MAY_LINK        (1 << 8)
2124 /* permission for delete from the directory */
2125 #define MAY_UNLINK      (1 << 9)
2126 /* source's permission for rename */
2127 #define MAY_RENAME_SRC  (1 << 10)
2128 /* target's permission for rename */
2129 #define MAY_RENAME_TAR  (1 << 11)
2130 /* part (parent's) VTX permission check */
2131 #define MAY_VTX_PART    (1 << 12)
2132 /* full VTX permission check */
2133 #define MAY_VTX_FULL    (1 << 13)
2134 /* lfs rgetfacl permission check */
2135 #define MAY_RGETFACL    (1 << 14)
2136
2137 enum {
2138         MDS_CHECK_SPLIT   = 1 << 0,
2139         MDS_CROSS_REF     = 1 << 1,
2140         MDS_VTX_BYPASS    = 1 << 2,
2141         MDS_PERM_BYPASS   = 1 << 3,
2142         MDS_SOM           = 1 << 4,
2143         MDS_QUOTA_IGNORE  = 1 << 5,
2144         MDS_CLOSE_CLEANUP = 1 << 6,
2145         MDS_KEEP_ORPHAN   = 1 << 7,
2146         MDS_RECOV_OPEN    = 1 << 8,
2147 };
2148
2149 /* instance of mdt_reint_rec */
2150 struct mdt_rec_create {
2151         __u32           cr_opcode;
2152         __u32           cr_cap;
2153         __u32           cr_fsuid;
2154         __u32           cr_fsuid_h;
2155         __u32           cr_fsgid;
2156         __u32           cr_fsgid_h;
2157         __u32           cr_suppgid1;
2158         __u32           cr_suppgid1_h;
2159         __u32           cr_suppgid2;
2160         __u32           cr_suppgid2_h;
2161         struct lu_fid   cr_fid1;
2162         struct lu_fid   cr_fid2;
2163         struct lustre_handle cr_old_handle; /* handle in case of open replay */
2164         obd_time        cr_time;
2165         __u64           cr_rdev;
2166         __u64           cr_ioepoch;
2167         __u64           cr_padding_1;   /* rr_blocks */
2168         __u32           cr_mode;
2169         __u32           cr_bias;
2170         /* use of helpers set/get_mrc_cr_flags() is needed to access
2171          * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
2172          * extend cr_flags size without breaking 1.8 compat */
2173         __u32           cr_flags_l;     /* for use with open, low  32 bits  */
2174         __u32           cr_flags_h;     /* for use with open, high 32 bits */
2175         __u32           cr_umask;       /* umask for create */
2176         __u32           cr_padding_4;   /* rr_padding_4 */
2177 };
2178
2179 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
2180 {
2181         mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
2182         mrc->cr_flags_h = (__u32)(flags >> 32);
2183 }
2184
2185 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
2186 {
2187         return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
2188 }
2189
2190 /* instance of mdt_reint_rec */
2191 struct mdt_rec_link {
2192         __u32           lk_opcode;
2193         __u32           lk_cap;
2194         __u32           lk_fsuid;
2195         __u32           lk_fsuid_h;
2196         __u32           lk_fsgid;
2197         __u32           lk_fsgid_h;
2198         __u32           lk_suppgid1;
2199         __u32           lk_suppgid1_h;
2200         __u32           lk_suppgid2;
2201         __u32           lk_suppgid2_h;
2202         struct lu_fid   lk_fid1;
2203         struct lu_fid   lk_fid2;
2204         obd_time        lk_time;
2205         __u64           lk_padding_1;   /* rr_atime */
2206         __u64           lk_padding_2;   /* rr_ctime */
2207         __u64           lk_padding_3;   /* rr_size */
2208         __u64           lk_padding_4;   /* rr_blocks */
2209         __u32           lk_bias;
2210         __u32           lk_padding_5;   /* rr_mode */
2211         __u32           lk_padding_6;   /* rr_flags */
2212         __u32           lk_padding_7;   /* rr_padding_2 */
2213         __u32           lk_padding_8;   /* rr_padding_3 */
2214         __u32           lk_padding_9;   /* rr_padding_4 */
2215 };
2216
2217 /* instance of mdt_reint_rec */
2218 struct mdt_rec_unlink {
2219         __u32           ul_opcode;
2220         __u32           ul_cap;
2221         __u32           ul_fsuid;
2222         __u32           ul_fsuid_h;
2223         __u32           ul_fsgid;
2224         __u32           ul_fsgid_h;
2225         __u32           ul_suppgid1;
2226         __u32           ul_suppgid1_h;
2227         __u32           ul_suppgid2;
2228         __u32           ul_suppgid2_h;
2229         struct lu_fid   ul_fid1;
2230         struct lu_fid   ul_fid2;
2231         obd_time        ul_time;
2232         __u64           ul_padding_2;   /* rr_atime */
2233         __u64           ul_padding_3;   /* rr_ctime */
2234         __u64           ul_padding_4;   /* rr_size */
2235         __u64           ul_padding_5;   /* rr_blocks */
2236         __u32           ul_bias;
2237         __u32           ul_mode;
2238         __u32           ul_padding_6;   /* rr_flags */
2239         __u32           ul_padding_7;   /* rr_padding_2 */
2240         __u32           ul_padding_8;   /* rr_padding_3 */
2241         __u32           ul_padding_9;   /* rr_padding_4 */
2242 };
2243
2244 /* instance of mdt_reint_rec */
2245 struct mdt_rec_rename {
2246         __u32           rn_opcode;
2247         __u32           rn_cap;
2248         __u32           rn_fsuid;
2249         __u32           rn_fsuid_h;
2250         __u32           rn_fsgid;
2251         __u32           rn_fsgid_h;
2252         __u32           rn_suppgid1;
2253         __u32           rn_suppgid1_h;
2254         __u32           rn_suppgid2;
2255         __u32           rn_suppgid2_h;
2256         struct lu_fid   rn_fid1;
2257         struct lu_fid   rn_fid2;
2258         obd_time        rn_time;
2259         __u64           rn_padding_1;   /* rr_atime */
2260         __u64           rn_padding_2;   /* rr_ctime */
2261         __u64           rn_padding_3;   /* rr_size */
2262         __u64           rn_padding_4;   /* rr_blocks */
2263         __u32           rn_bias;        /* some operation flags */
2264         __u32           rn_mode;        /* cross-ref rename has mode */
2265         __u32           rn_padding_5;   /* rr_flags */
2266         __u32           rn_padding_6;   /* rr_padding_2 */
2267         __u32           rn_padding_7;   /* rr_padding_3 */
2268         __u32           rn_padding_8;   /* rr_padding_4 */
2269 };
2270
2271 /* instance of mdt_reint_rec */
2272 struct mdt_rec_setxattr {
2273         __u32           sx_opcode;
2274         __u32           sx_cap;
2275         __u32           sx_fsuid;
2276         __u32           sx_fsuid_h;
2277         __u32           sx_fsgid;
2278         __u32           sx_fsgid_h;
2279         __u32           sx_suppgid1;
2280         __u32           sx_suppgid1_h;
2281         __u32           sx_suppgid2;
2282         __u32           sx_suppgid2_h;
2283         struct lu_fid   sx_fid;
2284         __u64           sx_padding_1;   /* These three are rr_fid2 */
2285         __u32           sx_padding_2;
2286         __u32           sx_padding_3;
2287         __u64           sx_valid;
2288         obd_time        sx_time;
2289         __u64           sx_padding_5;   /* rr_ctime */
2290         __u64           sx_padding_6;   /* rr_size */
2291         __u64           sx_padding_7;   /* rr_blocks */
2292         __u32           sx_size;
2293         __u32           sx_flags;
2294         __u32           sx_padding_8;   /* rr_flags */
2295         __u32           sx_padding_9;   /* rr_padding_2 */
2296         __u32           sx_padding_10;  /* rr_padding_3 */
2297         __u32           sx_padding_11;  /* rr_padding_4 */
2298 };
2299
2300 /*
2301  * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2302  * Do NOT change the size of various members, otherwise the value
2303  * will be broken in lustre_swab_mdt_rec_reint().
2304  *
2305  * If you add new members in other mdt_reint_xxx structres and need to use the
2306  * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2307  */
2308 struct mdt_rec_reint {
2309         __u32           rr_opcode;
2310         __u32           rr_cap;
2311         __u32           rr_fsuid;
2312         __u32           rr_fsuid_h;
2313         __u32           rr_fsgid;
2314         __u32           rr_fsgid_h;
2315         __u32           rr_suppgid1;
2316         __u32           rr_suppgid1_h;
2317         __u32           rr_suppgid2;
2318         __u32           rr_suppgid2_h;
2319         struct lu_fid   rr_fid1;
2320         struct lu_fid   rr_fid2;
2321         obd_time        rr_mtime;
2322         obd_time        rr_atime;
2323         obd_time        rr_ctime;
2324         __u64           rr_size;
2325         __u64           rr_blocks;
2326         __u32           rr_bias;
2327         __u32           rr_mode;
2328         __u32           rr_flags;
2329         __u32           rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
2330         __u32           rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
2331         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2332 };
2333
2334 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
2335
2336 struct lmv_desc {
2337         __u32 ld_tgt_count;                /* how many MDS's */
2338         __u32 ld_active_tgt_count;         /* how many active */
2339         __u32 ld_default_stripe_count;     /* how many objects are used */
2340         __u32 ld_pattern;                  /* default MEA_MAGIC_* */
2341         __u64 ld_default_hash_size;
2342         __u64 ld_padding_1;                /* also fix lustre_swab_lmv_desc */
2343         __u32 ld_padding_2;                /* also fix lustre_swab_lmv_desc */
2344         __u32 ld_qos_maxage;               /* in second */
2345         __u32 ld_padding_3;                /* also fix lustre_swab_lmv_desc */
2346         __u32 ld_padding_4;                /* also fix lustre_swab_lmv_desc */
2347         struct obd_uuid ld_uuid;
2348 };
2349
2350 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
2351
2352 /* TODO: lmv_stripe_md should contain mds capabilities for all slave fids */
2353 struct lmv_stripe_md {
2354         __u32         mea_magic;
2355         __u32         mea_count;
2356         __u32         mea_master;
2357         __u32         mea_padding;
2358         char          mea_pool_name[LOV_MAXPOOLNAME];
2359         struct lu_fid mea_ids[0];
2360 };
2361
2362 extern void lustre_swab_lmv_stripe_md(struct lmv_stripe_md *mea);
2363
2364 /* lmv structures */
2365 #define MEA_MAGIC_LAST_CHAR      0xb2221ca1
2366 #define MEA_MAGIC_ALL_CHARS      0xb222a11c
2367 #define MEA_MAGIC_HASH_SEGMENT   0xb222a11b
2368
2369 #define MAX_HASH_SIZE_32         0x7fffffffUL
2370 #define MAX_HASH_SIZE            0x7fffffffffffffffULL
2371 #define MAX_HASH_HIGHEST_BIT     0x1000000000000000ULL
2372
2373 enum fld_rpc_opc {
2374         FLD_QUERY                       = 900,
2375         FLD_LAST_OPC,
2376         FLD_FIRST_OPC                   = FLD_QUERY
2377 };
2378
2379 enum seq_rpc_opc {
2380         SEQ_QUERY                       = 700,
2381         SEQ_LAST_OPC,
2382         SEQ_FIRST_OPC                   = SEQ_QUERY
2383 };
2384
2385 enum seq_op {
2386         SEQ_ALLOC_SUPER = 0,
2387         SEQ_ALLOC_META = 1
2388 };
2389
2390 /*
2391  *  LOV data structures
2392  */
2393
2394 #define LOV_MAX_UUID_BUFFER_SIZE  8192
2395 /* The size of the buffer the lov/mdc reserves for the
2396  * array of UUIDs returned by the MDS.  With the current
2397  * protocol, this will limit the max number of OSTs per LOV */
2398
2399 #define LOV_DESC_MAGIC 0xB0CCDE5C
2400
2401 /* LOV settings descriptor (should only contain static info) */
2402 struct lov_desc {
2403         __u32 ld_tgt_count;                /* how many OBD's */
2404         __u32 ld_active_tgt_count;         /* how many active */
2405         __u32 ld_default_stripe_count;     /* how many objects are used */
2406         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
2407         __u64 ld_default_stripe_size;      /* in bytes */
2408         __u64 ld_default_stripe_offset;    /* in bytes */
2409         __u32 ld_padding_0;                /* unused */
2410         __u32 ld_qos_maxage;               /* in second */
2411         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
2412         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
2413         struct obd_uuid ld_uuid;
2414 };
2415
2416 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
2417
2418 extern void lustre_swab_lov_desc (struct lov_desc *ld);
2419
2420 /*
2421  *   LDLM requests:
2422  */
2423 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2424 typedef enum {
2425         LDLM_ENQUEUE     = 101,
2426         LDLM_CONVERT     = 102,
2427         LDLM_CANCEL      = 103,
2428         LDLM_BL_CALLBACK = 104,
2429         LDLM_CP_CALLBACK = 105,
2430         LDLM_GL_CALLBACK = 106,
2431         LDLM_SET_INFO    = 107,
2432         LDLM_LAST_OPC
2433 } ldlm_cmd_t;
2434 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2435
2436 #define RES_NAME_SIZE 4
2437 struct ldlm_res_id {
2438         __u64 name[RES_NAME_SIZE];
2439 };
2440
2441 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
2442
2443 static inline int ldlm_res_eq(const struct ldlm_res_id *res0,
2444                               const struct ldlm_res_id *res1)
2445 {
2446         return !memcmp(res0, res1, sizeof(*res0));
2447 }
2448
2449 /* lock types */
2450 typedef enum {
2451         LCK_MINMODE = 0,
2452         LCK_EX      = 1,
2453         LCK_PW      = 2,
2454         LCK_PR      = 4,
2455         LCK_CW      = 8,
2456         LCK_CR      = 16,
2457         LCK_NL      = 32,
2458         LCK_GROUP   = 64,
2459         LCK_COS     = 128,
2460         LCK_MAXMODE
2461 } ldlm_mode_t;
2462
2463 #define LCK_MODE_NUM    8
2464
2465 typedef enum {
2466         LDLM_PLAIN     = 10,
2467         LDLM_EXTENT    = 11,
2468         LDLM_FLOCK     = 12,
2469         LDLM_IBITS     = 13,
2470         LDLM_MAX_TYPE
2471 } ldlm_type_t;
2472
2473 #define LDLM_MIN_TYPE LDLM_PLAIN
2474
2475 struct ldlm_extent {
2476         __u64 start;
2477         __u64 end;
2478         __u64 gid;
2479 };
2480
2481 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
2482                                       struct ldlm_extent *ex2)
2483 {
2484         return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
2485 }
2486
2487 /* check if @ex1 contains @ex2 */
2488 static inline int ldlm_extent_contain(struct ldlm_extent *ex1,
2489                                       struct ldlm_extent *ex2)
2490 {
2491         return (ex1->start <= ex2->start) && (ex1->end >= ex2->end);
2492 }
2493
2494 struct ldlm_inodebits {
2495         __u64 bits;
2496 };
2497
2498 struct ldlm_flock_wire {
2499         __u64 lfw_start;
2500         __u64 lfw_end;
2501         __u64 lfw_owner;
2502         __u32 lfw_padding;
2503         __u32 lfw_pid;
2504 };
2505
2506 /* it's important that the fields of the ldlm_extent structure match
2507  * the first fields of the ldlm_flock structure because there is only
2508  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2509  * this ever changes we will need to swab the union differently based
2510  * on the resource type. */
2511
2512 typedef union {
2513         struct ldlm_extent l_extent;
2514         struct ldlm_flock_wire l_flock;
2515         struct ldlm_inodebits l_inodebits;
2516 } ldlm_wire_policy_data_t;
2517
2518 extern void lustre_swab_ldlm_policy_data (ldlm_wire_policy_data_t *d);
2519
2520 union ldlm_gl_desc {
2521         struct ldlm_gl_lquota_desc      lquota_desc;
2522 };
2523
2524 extern void lustre_swab_gl_desc(union ldlm_gl_desc *);
2525
2526 struct ldlm_intent {
2527         __u64 opc;
2528 };
2529
2530 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
2531
2532 struct ldlm_resource_desc {
2533         ldlm_type_t lr_type;
2534         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
2535         struct ldlm_res_id lr_name;
2536 };
2537
2538 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
2539
2540 struct ldlm_lock_desc {
2541         struct ldlm_resource_desc l_resource;
2542         ldlm_mode_t l_req_mode;
2543         ldlm_mode_t l_granted_mode;
2544         ldlm_wire_policy_data_t l_policy_data;
2545 };
2546
2547 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
2548
2549 #define LDLM_LOCKREQ_HANDLES 2
2550 #define LDLM_ENQUEUE_CANCEL_OFF 1
2551
2552 struct ldlm_request {
2553         __u32 lock_flags;
2554         __u32 lock_count;
2555         struct ldlm_lock_desc lock_desc;
2556         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2557 };
2558
2559 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
2560
2561 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2562  * Otherwise, 2 are available. */
2563 #define ldlm_request_bufsize(count,type)                                \
2564 ({                                                                      \
2565         int _avail = LDLM_LOCKREQ_HANDLES;                              \
2566         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2567         sizeof(struct ldlm_request) +                                   \
2568         (count > _avail ? count - _avail : 0) *                         \
2569         sizeof(struct lustre_handle);                                   \
2570 })
2571
2572 struct ldlm_reply {
2573         __u32 lock_flags;
2574         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
2575         struct ldlm_lock_desc lock_desc;
2576         struct lustre_handle lock_handle;
2577         __u64  lock_policy_res1;
2578         __u64  lock_policy_res2;
2579 };
2580
2581 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
2582
2583 #define ldlm_flags_to_wire(flags)    ((__u32)(flags))
2584 #define ldlm_flags_from_wire(flags)  ((__u64)(flags))
2585
2586 /*
2587  * Opcodes for mountconf (mgs and mgc)
2588  */
2589 typedef enum {
2590         MGS_CONNECT = 250,
2591         MGS_DISCONNECT,
2592         MGS_EXCEPTION,         /* node died, etc. */
2593         MGS_TARGET_REG,        /* whenever target starts up */
2594         MGS_TARGET_DEL,
2595         MGS_SET_INFO,
2596         MGS_CONFIG_READ,
2597         MGS_LAST_OPC
2598 } mgs_cmd_t;
2599 #define MGS_FIRST_OPC MGS_CONNECT
2600
2601 #define MGS_PARAM_MAXLEN 1024
2602 #define KEY_SET_INFO "set_info"
2603
2604 struct mgs_send_param {
2605         char             mgs_param[MGS_PARAM_MAXLEN];
2606 };
2607
2608 /* We pass this info to the MGS so it can write config logs */
2609 #define MTI_NAME_MAXLEN  64
2610 #define MTI_PARAM_MAXLEN 4096
2611 #define MTI_NIDS_MAX     32
2612 struct mgs_target_info {
2613         __u32            mti_lustre_ver;
2614         __u32            mti_stripe_index;
2615         __u32            mti_config_ver;
2616         __u32            mti_flags;
2617         __u32            mti_nid_count;
2618         __u32            mti_instance; /* Running instance of target */
2619         char             mti_fsname[MTI_NAME_MAXLEN];
2620         char             mti_svname[MTI_NAME_MAXLEN];
2621         char             mti_uuid[sizeof(struct obd_uuid)];
2622         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
2623         char             mti_params[MTI_PARAM_MAXLEN];
2624 };
2625 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
2626
2627 struct mgs_nidtbl_entry {
2628         __u64           mne_version;    /* table version of this entry */
2629         __u32           mne_instance;   /* target instance # */
2630         __u32           mne_index;      /* target index */
2631         __u32           mne_length;     /* length of this entry - by bytes */
2632         __u8            mne_type;       /* target type LDD_F_SV_TYPE_OST/MDT */
2633         __u8            mne_nid_type;   /* type of nid(mbz). for ipv6. */
2634         __u8            mne_nid_size;   /* size of each NID, by bytes */
2635         __u8            mne_nid_count;  /* # of NIDs in buffer */
2636         union {
2637                 lnet_nid_t nids[0];     /* variable size buffer for NIDs. */
2638         } u;
2639 };
2640 extern void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
2641
2642 struct mgs_config_body {
2643         char     mcb_name[MTI_NAME_MAXLEN]; /* logname */
2644         __u64    mcb_offset;    /* next index of config log to request */
2645         __u16    mcb_type;      /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2646         __u8     mcb_reserved;
2647         __u8     mcb_bits;      /* bits unit size of config log */
2648         __u32    mcb_units;     /* # of units for bulk transfer */
2649 };
2650 extern void lustre_swab_mgs_config_body(struct mgs_config_body *body);
2651
2652 struct mgs_config_res {
2653         __u64    mcr_offset;    /* index of last config log */
2654         __u64    mcr_size;      /* size of the log */
2655 };
2656 extern void lustre_swab_mgs_config_res(struct mgs_config_res *body);
2657
2658 /* Config marker flags (in config log) */
2659 #define CM_START       0x01
2660 #define CM_END         0x02
2661 #define CM_SKIP        0x04
2662 #define CM_UPGRADE146  0x08
2663 #define CM_EXCLUDE     0x10
2664 #define CM_START_SKIP (CM_START | CM_SKIP)
2665
2666 struct cfg_marker {
2667         __u32             cm_step;       /* aka config version */
2668         __u32             cm_flags;
2669         __u32             cm_vers;       /* lustre release version number */
2670         __u32             cm_padding;    /* 64 bit align */
2671         obd_time          cm_createtime; /*when this record was first created */
2672         obd_time          cm_canceltime; /*when this record is no longer valid*/
2673         char              cm_tgtname[MTI_NAME_MAXLEN];
2674         char              cm_comment[MTI_NAME_MAXLEN];
2675 };
2676
2677 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2678                                    int swab, int size);
2679
2680 /*
2681  * Opcodes for multiple servers.
2682  */
2683
2684 typedef enum {
2685         OBD_PING = 400,
2686         OBD_LOG_CANCEL,
2687         OBD_QC_CALLBACK,
2688         OBD_IDX_READ,
2689         OBD_LAST_OPC
2690 } obd_cmd_t;
2691 #define OBD_FIRST_OPC OBD_PING
2692
2693 /* catalog of log objects */
2694
2695 /** Identifier for a single log object */
2696 struct llog_logid {
2697         __u64                   lgl_oid;
2698         __u64                   lgl_oseq;
2699         __u32                   lgl_ogen;
2700 } __attribute__((packed));
2701
2702 /** Records written to the CATALOGS list */
2703 #define CATLIST "CATALOGS"
2704 struct llog_catid {
2705         struct llog_logid       lci_logid;
2706         __u32                   lci_padding1;
2707         __u32                   lci_padding2;
2708         __u32                   lci_padding3;
2709 } __attribute__((packed));
2710
2711 /* Log data record types - there is no specific reason that these need to
2712  * be related to the RPC opcodes, but no reason not to (may be handy later?)
2713  */
2714 #define LLOG_OP_MAGIC 0x10600000
2715 #define LLOG_OP_MASK  0xfff00000
2716
2717 typedef enum {
2718         LLOG_PAD_MAGIC          = LLOG_OP_MAGIC | 0x00000,
2719         OST_SZ_REC              = LLOG_OP_MAGIC | 0x00f00,
2720         /* OST_RAID1_REC        = LLOG_OP_MAGIC | 0x01000, never used */
2721         MDS_UNLINK_REC          = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
2722                                   REINT_UNLINK, /* obsolete after 2.5.0 */
2723         MDS_UNLINK64_REC        = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2724                                   REINT_UNLINK,
2725         /* MDS_SETATTR_REC      = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
2726         MDS_SETATTR64_REC       = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
2727                                   REINT_SETATTR,
2728         OBD_CFG_REC             = LLOG_OP_MAGIC | 0x20000,
2729         /* PTL_CFG_REC          = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
2730         LLOG_GEN_REC            = LLOG_OP_MAGIC | 0x40000,
2731         /* LLOG_JOIN_REC        = LLOG_OP_MAGIC | 0x50000, obsolete  1.8.0 */
2732         CHANGELOG_REC           = LLOG_OP_MAGIC | 0x60000,
2733         CHANGELOG_USER_REC      = LLOG_OP_MAGIC | 0x70000,
2734         LLOG_HDR_MAGIC          = LLOG_OP_MAGIC | 0x45539,
2735         LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
2736 } llog_op_type;
2737
2738 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
2739         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
2740
2741 /** Log record header - stored in little endian order.
2742  * Each record must start with this struct, end with a llog_rec_tail,
2743  * and be a multiple of 256 bits in size.
2744  */
2745 struct llog_rec_hdr {
2746         __u32   lrh_len;
2747         __u32   lrh_index;
2748         __u32   lrh_type;
2749         __u32   lrh_id;
2750 };
2751
2752 struct llog_rec_tail {
2753         __u32   lrt_len;
2754         __u32   lrt_index;
2755 };
2756
2757 struct llog_logid_rec {
2758         struct llog_rec_hdr     lid_hdr;
2759         struct llog_logid       lid_id;
2760         __u32                   lid_padding1;
2761         __u64                   lid_padding2;
2762         __u64                   lid_padding3;
2763         struct llog_rec_tail    lid_tail;
2764 } __attribute__((packed));
2765
2766 struct llog_unlink_rec {
2767         struct llog_rec_hdr     lur_hdr;
2768         obd_id                  lur_oid;
2769         obd_count               lur_oseq;
2770         obd_count               lur_count;
2771         struct llog_rec_tail    lur_tail;
2772 } __attribute__((packed));
2773
2774 struct llog_unlink64_rec {
2775         struct llog_rec_hdr     lur_hdr;
2776         struct lu_fid           lur_fid;
2777         obd_count               lur_count; /* to destroy the lost precreated */
2778         __u32                   lur_padding1;
2779         __u64                   lur_padding2;
2780         __u64                   lur_padding3;
2781         struct llog_rec_tail    lur_tail;
2782 } __attribute__((packed));
2783
2784 struct llog_setattr64_rec {
2785         struct llog_rec_hdr     lsr_hdr;
2786         obd_id                  lsr_oid;
2787         obd_seq                 lsr_oseq;
2788         __u32                   lsr_uid;
2789         __u32                   lsr_uid_h;
2790         __u32                   lsr_gid;
2791         __u32                   lsr_gid_h;
2792         __u64                   lsr_padding;
2793         struct llog_rec_tail    lsr_tail;
2794 } __attribute__((packed));
2795
2796 struct llog_size_change_rec {
2797         struct llog_rec_hdr     lsc_hdr;
2798         struct ll_fid           lsc_fid;
2799         __u32                   lsc_ioepoch;
2800         __u32                   lsc_padding1;
2801         __u64                   lsc_padding2;
2802         __u64                   lsc_padding3;
2803         struct llog_rec_tail    lsc_tail;
2804 } __attribute__((packed));
2805
2806 #define CHANGELOG_MAGIC 0xca103000
2807
2808 /** \a changelog_rec_type's that can't be masked */
2809 #define CHANGELOG_MINMASK (1 << CL_MARK)
2810 /** bits covering all \a changelog_rec_type's */
2811 #define CHANGELOG_ALLMASK 0XFFFFFFFF
2812 /** default \a changelog_rec_type mask */
2813 #define CHANGELOG_DEFMASK CHANGELOG_ALLMASK & ~(1 << CL_ATIME | 1 << CL_CLOSE)
2814
2815 /* changelog llog name, needed by client replicators */
2816 #define CHANGELOG_CATALOG "changelog_catalog"
2817
2818 struct changelog_setinfo {
2819         __u64 cs_recno;
2820         __u32 cs_id;
2821 } __attribute__((packed));
2822
2823 /** changelog record */
2824 struct llog_changelog_rec {
2825         struct llog_rec_hdr  cr_hdr;
2826         struct changelog_rec cr;
2827         struct llog_rec_tail cr_tail; /**< for_sizezof_only */
2828 } __attribute__((packed));
2829
2830 struct llog_changelog_ext_rec {
2831         struct llog_rec_hdr      cr_hdr;
2832         struct changelog_ext_rec cr;
2833         struct llog_rec_tail     cr_tail; /**< for_sizezof_only */
2834 } __attribute__((packed));
2835
2836 #define CHANGELOG_USER_PREFIX "cl"
2837
2838 struct llog_changelog_user_rec {
2839         struct llog_rec_hdr   cur_hdr;
2840         __u32                 cur_id;
2841         __u32                 cur_padding;
2842         __u64                 cur_endrec;
2843         struct llog_rec_tail  cur_tail;
2844 } __attribute__((packed));
2845
2846 /* Old llog gen for compatibility */
2847 struct llog_gen {
2848         __u64 mnt_cnt;
2849         __u64 conn_cnt;
2850 } __attribute__((packed));
2851
2852 struct llog_gen_rec {
2853         struct llog_rec_hdr     lgr_hdr;
2854         struct llog_gen         lgr_gen;
2855         __u64                   padding1;
2856         __u64                   padding2;
2857         __u64                   padding3;
2858         struct llog_rec_tail    lgr_tail;
2859 };
2860
2861 /* On-disk header structure of each log object, stored in little endian order */
2862 #define LLOG_CHUNK_SIZE         8192
2863 #define LLOG_HEADER_SIZE        (96)
2864 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2865
2866 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
2867
2868 /* flags for the logs */
2869 enum llog_flag {
2870         LLOG_F_ZAP_WHEN_EMPTY   = 0x1,
2871         LLOG_F_IS_CAT           = 0x2,
2872         LLOG_F_IS_PLAIN         = 0x4,
2873 };
2874
2875 struct llog_log_hdr {
2876         struct llog_rec_hdr     llh_hdr;
2877         obd_time                llh_timestamp;
2878         __u32                   llh_count;
2879         __u32                   llh_bitmap_offset;
2880         __u32                   llh_size;
2881         __u32                   llh_flags;
2882         __u32                   llh_cat_idx;
2883         /* for a catalog the first plain slot is next to it */
2884         struct obd_uuid         llh_tgtuuid;
2885         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2886         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2887         struct llog_rec_tail    llh_tail;
2888 } __attribute__((packed));
2889
2890 #define LLOG_BITMAP_SIZE(llh)  (__u32)((llh->llh_hdr.lrh_len -          \
2891                                         llh->llh_bitmap_offset -        \
2892                                         sizeof(llh->llh_tail)) * 8)
2893
2894 /** log cookies are used to reference a specific log file and a record therein */
2895 struct llog_cookie {
2896         struct llog_logid       lgc_lgl;
2897         __u32                   lgc_subsys;
2898         __u32                   lgc_index;
2899         __u32                   lgc_padding;
2900 } __attribute__((packed));
2901
2902 /** llog protocol */
2903 enum llogd_rpc_ops {
2904         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2905         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2906         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2907         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2908         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2909         LLOG_ORIGIN_CONNECT             = 506,
2910         LLOG_CATINFO                    = 507,  /* deprecated */
2911         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2912         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2913         LLOG_LAST_OPC,
2914         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2915 };
2916
2917 struct llogd_body {
2918         struct llog_logid  lgd_logid;
2919         __u32 lgd_ctxt_idx;
2920         __u32 lgd_llh_flags;
2921         __u32 lgd_index;
2922         __u32 lgd_saved_index;
2923         __u32 lgd_len;
2924         __u64 lgd_cur_offset;
2925 } __attribute__((packed));
2926
2927 struct llogd_conn_body {
2928         struct llog_gen         lgdc_gen;
2929         struct llog_logid       lgdc_logid;
2930         __u32                   lgdc_ctxt_idx;
2931 } __attribute__((packed));
2932
2933 /* Note: 64-bit types are 64-bit aligned in structure */
2934 struct obdo {
2935         obd_valid               o_valid;        /* hot fields in this obdo */
2936         struct ost_id           o_oi;
2937         obd_id                  o_parent_seq;
2938         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
2939         obd_time                o_mtime;
2940         obd_time                o_atime;
2941         obd_time                o_ctime;
2942         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
2943         obd_size                o_grant;
2944
2945         /* 32-bit fields start here: keep an even number of them via padding */
2946         obd_blksize             o_blksize;      /* optimal IO blocksize */
2947         obd_mode                o_mode;         /* brw: cli sent cache remain */
2948         obd_uid                 o_uid;
2949         obd_gid                 o_gid;
2950         obd_flag                o_flags;
2951         obd_count               o_nlink;        /* brw: checksum */
2952         obd_count               o_parent_oid;
2953         obd_count               o_misc;         /* brw: o_dropped */
2954         __u64                   o_ioepoch;      /* epoch in ost writes */
2955         __u32                   o_stripe_idx;   /* holds stripe idx */
2956         __u32                   o_parent_ver;
2957         struct lustre_handle    o_handle;       /* brw: lock handle to prolong
2958                                                  * locks */
2959         struct llog_cookie      o_lcookie;      /* destroy: unlink cookie from
2960                                                  * MDS */
2961         __u32                   o_uid_h;
2962         __u32                   o_gid_h;
2963
2964         __u64                   o_data_version; /* getattr: sum of iversion for
2965                                                  * each stripe.
2966                                                  * brw: grant space consumed on
2967                                                  * the client for the write */
2968         __u64                   o_padding_4;
2969         __u64                   o_padding_5;
2970         __u64                   o_padding_6;
2971 };
2972
2973 #define o_id     o_oi.oi_id
2974 #define o_seq    o_oi.oi_seq
2975 #define o_dirty   o_blocks
2976 #define o_undirty o_mode
2977 #define o_dropped o_misc
2978 #define o_cksum   o_nlink
2979 #define o_grant_used o_data_version
2980
2981 static inline void lustre_set_wire_obdo(struct obdo *wobdo, struct obdo *lobdo)
2982 {
2983         memcpy(wobdo, lobdo, sizeof(*lobdo));
2984         wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
2985 }
2986
2987 static inline void lustre_get_wire_obdo(struct obdo *lobdo, struct obdo *wobdo)
2988 {
2989         obd_flag local_flags = 0;
2990
2991         if (lobdo->o_valid & OBD_MD_FLFLAGS)
2992                  local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
2993
2994         LASSERT(!(wobdo->o_flags & OBD_FL_LOCAL_MASK));
2995
2996         memcpy(lobdo, wobdo, sizeof(*lobdo));
2997         if (local_flags != 0) {
2998                  lobdo->o_valid |= OBD_MD_FLFLAGS;
2999                  lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3000                  lobdo->o_flags |= local_flags;
3001         }
3002 }
3003
3004 extern void lustre_swab_obdo (struct obdo *o);
3005
3006 /* request structure for OST's */
3007 struct ost_body {
3008         struct  obdo oa;
3009 };
3010
3011 /* Key for FIEMAP to be used in get_info calls */
3012 struct ll_fiemap_info_key {
3013         char    name[8];
3014         struct  obdo oa;
3015         struct  ll_user_fiemap fiemap;
3016 };
3017
3018 extern void lustre_swab_ost_body (struct ost_body *b);
3019 extern void lustre_swab_ost_last_id(obd_id *id);
3020 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
3021
3022 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
3023 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
3024 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
3025                                             int stripe_count);
3026 extern void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
3027
3028 /* llog_swab.c */
3029 extern void lustre_swab_llogd_body (struct llogd_body *d);
3030 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
3031 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
3032 extern void lustre_swab_llog_rec(struct llog_rec_hdr *rec);
3033
3034 struct lustre_cfg;
3035 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
3036
3037 /* Functions for dumping PTLRPC fields */
3038 void dump_rniobuf(struct niobuf_remote *rnb);
3039 void dump_ioo(struct obd_ioobj *nb);
3040 void dump_obdo(struct obdo *oa);
3041 void dump_ost_body(struct ost_body *ob);
3042 void dump_rcs(__u32 *rc);
3043
3044 #define IDX_INFO_MAGIC 0x3D37CC37
3045
3046 /* Index file transfer through the network. The server serializes the index into
3047  * a byte stream which is sent to the client via a bulk transfer */
3048 struct idx_info {
3049         __u32           ii_magic;
3050
3051         /* reply: see idx_info_flags below */
3052         __u32           ii_flags;
3053
3054         /* request & reply: number of lu_idxpage (to be) transferred */
3055         __u16           ii_count;
3056         __u16           ii_pad0;
3057
3058         /* request: requested attributes passed down to the iterator API */
3059         __u32           ii_attrs;
3060
3061         /* request & reply: index file identifier (FID) */
3062         struct lu_fid   ii_fid;
3063
3064         /* reply: version of the index file before starting to walk the index.
3065          * Please note that the version can be modified at any time during the
3066          * transfer */
3067         __u64           ii_version;
3068
3069         /* request: hash to start with:
3070          * reply: hash of the first entry of the first lu_idxpage and hash
3071          *        of the entry to read next if any */
3072         __u64           ii_hash_start;
3073         __u64           ii_hash_end;
3074
3075         /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3076          * set */
3077         __u16           ii_keysize;
3078
3079         /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3080          * is set */
3081         __u16           ii_recsize;
3082
3083         __u32           ii_pad1;
3084         __u64           ii_pad2;
3085         __u64           ii_pad3;
3086 };
3087 extern void lustre_swab_idx_info(struct idx_info *ii);
3088
3089 #define II_END_OFF      MDS_DIR_END_OFF /* all entries have been read */
3090
3091 /* List of flags used in idx_info::ii_flags */
3092 enum idx_info_flags {
3093         II_FL_NOHASH    = 1 << 0, /* client doesn't care about hash value */
3094         II_FL_VARKEY    = 1 << 1, /* keys can be of variable size */
3095         II_FL_VARREC    = 1 << 2, /* records can be of variable size */
3096         II_FL_NONUNQ    = 1 << 3, /* index supports non-unique keys */
3097 };
3098
3099 #define LIP_MAGIC 0x8A6D6B6C
3100
3101 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3102 struct lu_idxpage {
3103         /* 16-byte header */
3104         __u32   lip_magic;
3105         __u16   lip_flags;
3106         __u16   lip_nr;   /* number of entries in the container */
3107         __u64   lip_pad0; /* additional padding for future use */
3108
3109         /* key/record pairs are stored in the remaining 4080 bytes.
3110          * depending upon the flags in idx_info::ii_flags, each key/record
3111          * pair might be preceded by:
3112          * - a hash value
3113          * - the key size (II_FL_VARKEY is set)
3114          * - the record size (II_FL_VARREC is set)
3115          *
3116          * For the time being, we only support fixed-size key & record. */
3117         char    lip_entries[0];
3118 };
3119 extern void lustre_swab_lip_header(struct lu_idxpage *lip);
3120
3121 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3122
3123 /* Gather all possible type associated with a 4KB container */
3124 union lu_page {
3125         struct lu_dirpage       lp_dir; /* for MDS_READPAGE */
3126         struct lu_idxpage       lp_idx; /* for OBD_IDX_READ */
3127         char                    lp_array[LU_PAGE_SIZE];
3128 };
3129
3130 /* security opcodes */
3131 typedef enum {
3132         SEC_CTX_INIT            = 801,
3133         SEC_CTX_INIT_CONT       = 802,
3134         SEC_CTX_FINI            = 803,
3135         SEC_LAST_OPC,
3136         SEC_FIRST_OPC           = SEC_CTX_INIT
3137 } sec_cmd_t;
3138
3139 /*
3140  * capa related definitions
3141  */
3142 #define CAPA_HMAC_MAX_LEN       64
3143 #define CAPA_HMAC_KEY_MAX_LEN   56
3144
3145 /* NB take care when changing the sequence of elements this struct,
3146  * because the offset info is used in find_capa() */
3147 struct lustre_capa {
3148         struct lu_fid   lc_fid;         /** fid */
3149         __u64           lc_opc;         /** operations allowed */
3150         __u64           lc_uid;         /** file owner */
3151         __u64           lc_gid;         /** file group */
3152         __u32           lc_flags;       /** HMAC algorithm & flags */
3153         __u32           lc_keyid;       /** key# used for the capability */
3154         __u32           lc_timeout;     /** capa timeout value (sec) */
3155         __u32           lc_expiry;      /** expiry time (sec) */
3156         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
3157 } __attribute__((packed));
3158
3159 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
3160
3161 /** lustre_capa::lc_opc */
3162 enum {
3163         CAPA_OPC_BODY_WRITE   = 1<<0,  /**< write object data */
3164         CAPA_OPC_BODY_READ    = 1<<1,  /**< read object data */
3165         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /**< lookup object fid */
3166         CAPA_OPC_INDEX_INSERT = 1<<3,  /**< insert object fid */
3167         CAPA_OPC_INDEX_DELETE = 1<<4,  /**< delete object fid */
3168         CAPA_OPC_OSS_WRITE    = 1<<5,  /**< write oss object data */
3169         CAPA_OPC_OSS_READ     = 1<<6,  /**< read oss object data */
3170         CAPA_OPC_OSS_TRUNC    = 1<<7,  /**< truncate oss object */
3171         CAPA_OPC_OSS_DESTROY  = 1<<8,  /**< destroy oss object */
3172         CAPA_OPC_META_WRITE   = 1<<9,  /**< write object meta data */
3173         CAPA_OPC_META_READ    = 1<<10, /**< read object meta data */
3174 };
3175
3176 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3177 #define CAPA_OPC_MDS_ONLY                                                   \
3178         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3179          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3180 #define CAPA_OPC_OSS_ONLY                                                   \
3181         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC |      \
3182          CAPA_OPC_OSS_DESTROY)
3183 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3184 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3185
3186 /* MDS capability covers object capability for operations of body r/w
3187  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
3188  * while OSS capability only covers object capability for operations of
3189  * oss data(file content) r/w/truncate.
3190  */
3191 static inline int capa_for_mds(struct lustre_capa *c)
3192 {
3193         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
3194 }
3195
3196 static inline int capa_for_oss(struct lustre_capa *c)
3197 {
3198         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
3199 }
3200
3201 /* lustre_capa::lc_hmac_alg */
3202 enum {
3203         CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3204         CAPA_HMAC_ALG_MAX,
3205 };
3206
3207 #define CAPA_FL_MASK            0x00ffffff
3208 #define CAPA_HMAC_ALG_MASK      0xff000000
3209
3210 struct lustre_capa_key {
3211         __u64   lk_seq;       /**< mds# */
3212         __u32   lk_keyid;     /**< key# */
3213         __u32   lk_padding;
3214         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /**< key */
3215 } __attribute__((packed));
3216
3217 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
3218
3219 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3220 #define LINK_EA_MAGIC 0x11EAF1DFUL
3221 struct link_ea_header {
3222         __u32 leh_magic;
3223         __u32 leh_reccount;
3224         __u64 leh_len;      /* total size */
3225         /* future use */
3226         __u32 padding1;
3227         __u32 padding2;
3228 };
3229
3230 /** Hardlink data is name and parent fid.
3231  * Stored in this crazy struct for maximum packing and endian-neutrality
3232  */
3233 struct link_ea_entry {
3234         /** __u16 stored big-endian, unaligned */
3235         unsigned char      lee_reclen[2];
3236         unsigned char      lee_parent_fid[sizeof(struct lu_fid)];
3237         char               lee_name[0];
3238 }__attribute__((packed));
3239
3240 /** fid2path request/reply structure */
3241 struct getinfo_fid2path {
3242         struct lu_fid   gf_fid;
3243         __u64           gf_recno;
3244         __u32           gf_linkno;
3245         __u32           gf_pathlen;
3246         char            gf_path[0];
3247 } __attribute__((packed));
3248
3249 void lustre_swab_fid2path (struct getinfo_fid2path *gf);
3250
3251
3252 #endif
3253 /** @} lustreidl */