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