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