lustre/include/lustre/lustre_idl.h

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