lustre/include/lustre/lustre_idl.h

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