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, 2015, 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. Nothing that
  56  * depends on external functions or definitions should be in here.
  57  *
  58  * Structs must be properly aligned to put 64-bit values on an 8-byte
  59  * boundary.  Any structs being added here must also be added to
  60  * utils/wirecheck.c and "make newwiretest" run to regenerate the
  61  * utils/wiretest.c sources.  This allows us to verify that wire structs
  62  * have the proper alignment/size on all architectures.
  63  *
  64  * DO NOT CHANGE any of the structs, flags, values declared here and used
  65  * in released Lustre versions.  Some structs may have padding fields that
  66  * can be used.  Some structs might allow addition at the end (verify this
  67  * in the code to ensure that new/old clients that see this larger struct
  68  * do not fail, otherwise you need to implement protocol compatibility).
  69  *
  70  * @{
  71  */
  72
  73 #ifndef _LUSTRE_IDL_H_
  74 #define _LUSTRE_IDL_H_
  75
  76 #include <libcfs/libcfs.h>
  77 #include <lnet/types.h>
  78 #include <lustre/lustre_user.h> /* Defn's shared with user-space. */
  79 #include <lustre/lustre_errno.h>
  80 #include <lustre_ver.h>
  81
  82 /*
  83  *  GENERAL STUFF
  84  */
  85 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
  86  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
  87  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
  88  */
  89
  90 #define CONNMGR_REQUEST_PORTAL          1
  91 #define CONNMGR_REPLY_PORTAL            2
  92 //#define OSC_REQUEST_PORTAL            3
  93 #define OSC_REPLY_PORTAL                4
  94 //#define OSC_BULK_PORTAL               5
  95 #define OST_IO_PORTAL                   6
  96 #define OST_CREATE_PORTAL               7
  97 #define OST_BULK_PORTAL                 8
  98 //#define MDC_REQUEST_PORTAL            9
  99 #define MDC_REPLY_PORTAL               10
 100 //#define MDC_BULK_PORTAL              11
 101 #define MDS_REQUEST_PORTAL             12
 102 //#define MDS_REPLY_PORTAL             13
 103 #define MDS_BULK_PORTAL                14
 104 #define LDLM_CB_REQUEST_PORTAL         15
 105 #define LDLM_CB_REPLY_PORTAL           16
 106 #define LDLM_CANCEL_REQUEST_PORTAL     17
 107 #define LDLM_CANCEL_REPLY_PORTAL       18
 108 //#define PTLBD_REQUEST_PORTAL           19
 109 //#define PTLBD_REPLY_PORTAL             20
 110 //#define PTLBD_BULK_PORTAL              21
 111 #define MDS_SETATTR_PORTAL             22
 112 #define MDS_READPAGE_PORTAL            23
 113 #define OUT_PORTAL                      24
 114 #define MGC_REPLY_PORTAL               25
 115 #define MGS_REQUEST_PORTAL             26
 116 #define MGS_REPLY_PORTAL               27
 117 #define OST_REQUEST_PORTAL             28
 118 #define FLD_REQUEST_PORTAL             29
 119 #define SEQ_METADATA_PORTAL            30
 120 #define SEQ_DATA_PORTAL                31
 121 #define SEQ_CONTROLLER_PORTAL          32
 122 #define MGS_BULK_PORTAL                33
 123
 124 /* Portal 63 is reserved for the Cray Inc DVS - nic@cray.com, roe@cray.com, n8851@cray.com */
 125
 126 /* packet types */
 127 #define PTL_RPC_MSG_REQUEST 4711
 128 #define PTL_RPC_MSG_ERR     4712
 129 #define PTL_RPC_MSG_REPLY   4713
 130
 131 /* DON'T use swabbed values of MAGIC as magic! */
 132 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
 133 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
 134
 135 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
 136
 137 #define PTLRPC_MSG_VERSION  0x00000003
 138 #define LUSTRE_VERSION_MASK 0xffff0000
 139 #define LUSTRE_OBD_VERSION  0x00010000
 140 #define LUSTRE_MDS_VERSION  0x00020000
 141 #define LUSTRE_OST_VERSION  0x00030000
 142 #define LUSTRE_DLM_VERSION  0x00040000
 143 #define LUSTRE_LOG_VERSION  0x00050000
 144 #define LUSTRE_MGS_VERSION  0x00060000
 145
 146 /**
 147  * Describes a range of sequence, lsr_start is included but lsr_end is
 148  * not in the range.
 149  * Same structure is used in fld module where lsr_index field holds mdt id
 150  * of the home mdt.
 151  */
 152 struct lu_seq_range {
 153         __u64 lsr_start;
 154         __u64 lsr_end;
 155         __u32 lsr_index;
 156         __u32 lsr_flags;
 157 };
 158
 159 struct lu_seq_range_array {
 160         __u32 lsra_count;
 161         __u32 lsra_padding;
 162         struct lu_seq_range lsra_lsr[0];
 163 };
 164
 165 #define LU_SEQ_RANGE_MDT        0x0
 166 #define LU_SEQ_RANGE_OST        0x1
 167 #define LU_SEQ_RANGE_ANY        0x3
 168
 169 #define LU_SEQ_RANGE_MASK       0x3
 170
 171 /** \defgroup lu_fid lu_fid
 172  * @{ */
 173
 174 /**
 175  * Flags for lustre_mdt_attrs::lma_compat and lustre_mdt_attrs::lma_incompat.
 176  * Deprecated since HSM and SOM attributes are now stored in separate on-disk
 177  * xattr.
 178  */
 179 enum lma_compat {
 180         LMAC_HSM        = 0x00000001,
 181 /*      LMAC_SOM        = 0x00000002, obsolete since 2.8.0 */
 182         LMAC_NOT_IN_OI  = 0x00000004, /* the object does NOT need OI mapping */
 183         LMAC_FID_ON_OST = 0x00000008, /* For OST-object, its OI mapping is
 184                                        * under /O/<seq>/d<x>. */
 185 };
 186
 187 /**
 188  * Masks for all features that should be supported by a Lustre version to
 189  * access a specific file.
 190  * This information is stored in lustre_mdt_attrs::lma_incompat.
 191  */
 192 enum lma_incompat {
 193         LMAI_RELEASED           = 0x00000001, /* file is released */
 194         LMAI_AGENT              = 0x00000002, /* agent inode */
 195         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
 196                                                  is on the remote MDT */
 197         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
 198         LMAI_ORPHAN             = 0x00000010, /* inode is orphan */
 199         LMA_INCOMPAT_SUPP       = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
 200                                    LMAI_STRIPED | LMAI_ORPHAN)
 201 };
 202
 203 extern void lustre_lma_swab(struct lustre_mdt_attrs *lma);
 204 extern void lustre_lma_init(struct lustre_mdt_attrs *lma,
 205                             const struct lu_fid *fid,
 206                             __u32 compat, __u32 incompat);
 207
 208 /* copytool uses a 32b bitmask field to encode archive-Ids during register
 209  * with MDT thru kuc.
 210  * archive num = 0 => all
 211  * archive num from 1 to 32
 212  */
 213 #define LL_HSM_MAX_ARCHIVE (sizeof(__u32) * 8)
 214
 215 /**
 216  * HSM on-disk attributes stored in a separate xattr.
 217  */
 218 struct hsm_attrs {
 219         /** Bitfield for supported data in this structure. For future use. */
 220         __u32   hsm_compat;
 221
 222         /** HSM flags, see hsm_flags enum below */
 223         __u32   hsm_flags;
 224         /** backend archive id associated with the file */
 225         __u64   hsm_arch_id;
 226         /** version associated with the last archiving, if any */
 227         __u64   hsm_arch_ver;
 228 };
 229 extern void lustre_hsm_swab(struct hsm_attrs *attrs);
 230
 231 /**
 232  * fid constants
 233  */
 234 enum {
 235         /** LASTID file has zero OID */
 236         LUSTRE_FID_LASTID_OID = 0UL,
 237         /** initial fid id value */
 238         LUSTRE_FID_INIT_OID  = 1UL
 239 };
 240
 241 /** returns fid object sequence */
 242 static inline __u64 fid_seq(const struct lu_fid *fid)
 243 {
 244         return fid->f_seq;
 245 }
 246
 247 /** returns fid object id */
 248 static inline __u32 fid_oid(const struct lu_fid *fid)
 249 {
 250         return fid->f_oid;
 251 }
 252
 253 /** returns fid object version */
 254 static inline __u32 fid_ver(const struct lu_fid *fid)
 255 {
 256         return fid->f_ver;
 257 }
 258
 259 static inline void fid_zero(struct lu_fid *fid)
 260 {
 261         memset(fid, 0, sizeof(*fid));
 262 }
 263
 264 static inline __u64 fid_ver_oid(const struct lu_fid *fid)
 265 {
 266         return ((__u64)fid_ver(fid) << 32 | fid_oid(fid));
 267 }
 268
 269 /**
 270  * Note that reserved SEQ numbers below 12 will conflict with ldiskfs
 271  * inodes in the IGIF namespace, so these reserved SEQ numbers can be
 272  * used for other purposes and not risk collisions with existing inodes.
 273  *
 274  * Different FID Format
 275  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs#NEW.0
 276  */
 277 enum fid_seq {
 278         FID_SEQ_OST_MDT0        = 0,
 279         FID_SEQ_LLOG            = 1, /* unnamed llogs */
 280         FID_SEQ_ECHO            = 2,
 281         FID_SEQ_UNUSED_START    = 3,
 282         FID_SEQ_UNUSED_END      = 9,
 283         FID_SEQ_LLOG_NAME       = 10, /* named llogs */
 284         FID_SEQ_RSVD            = 11,
 285         FID_SEQ_IGIF            = 12,
 286         FID_SEQ_IGIF_MAX        = 0x0ffffffffULL,
 287         FID_SEQ_IDIF            = 0x100000000ULL,
 288         FID_SEQ_IDIF_MAX        = 0x1ffffffffULL,
 289         /* Normal FID sequence starts from this value, i.e. 1<<33 */
 290         FID_SEQ_START           = 0x200000000ULL,
 291         /* sequence for local pre-defined FIDs listed in local_oid */
 292         FID_SEQ_LOCAL_FILE      = 0x200000001ULL,
 293         FID_SEQ_DOT_LUSTRE      = 0x200000002ULL,
 294         /* sequence is used for local named objects FIDs generated
 295          * by local_object_storage library */
 296         FID_SEQ_LOCAL_NAME      = 0x200000003ULL,
 297         /* Because current FLD will only cache the fid sequence, instead
 298          * of oid on the client side, if the FID needs to be exposed to
 299          * clients sides, it needs to make sure all of fids under one
 300          * sequence will be located in one MDT. */
 301         FID_SEQ_SPECIAL         = 0x200000004ULL,
 302         FID_SEQ_QUOTA           = 0x200000005ULL,
 303         FID_SEQ_QUOTA_GLB       = 0x200000006ULL,
 304         FID_SEQ_ROOT            = 0x200000007ULL,  /* Located on MDT0 */
 305         FID_SEQ_LAYOUT_RBTREE   = 0x200000008ULL,
 306         /* sequence is used for update logs of cross-MDT operation */
 307         FID_SEQ_UPDATE_LOG      = 0x200000009ULL,
 308         /* Sequence is used for the directory under which update logs
 309          * are created. */
 310         FID_SEQ_UPDATE_LOG_DIR  = 0x20000000aULL,
 311         FID_SEQ_NORMAL          = 0x200000400ULL,
 312         FID_SEQ_LOV_DEFAULT     = 0xffffffffffffffffULL
 313 };
 314
 315 #define OBIF_OID_MAX_BITS           32
 316 #define OBIF_MAX_OID                (1ULL << OBIF_OID_MAX_BITS)
 317 #define OBIF_OID_MASK               ((1ULL << OBIF_OID_MAX_BITS) - 1)
 318 #define IDIF_OID_MAX_BITS           48
 319 #define IDIF_MAX_OID                (1ULL << IDIF_OID_MAX_BITS)
 320 #define IDIF_OID_MASK               ((1ULL << IDIF_OID_MAX_BITS) - 1)
 321
 322 /** OID for FID_SEQ_SPECIAL */
 323 enum special_oid {
 324         /* Big Filesystem Lock to serialize rename operations */
 325         FID_OID_SPECIAL_BFL     = 1UL,
 326 };
 327
 328 /** OID for FID_SEQ_DOT_LUSTRE */
 329 enum dot_lustre_oid {
 330         FID_OID_DOT_LUSTRE      = 1UL,
 331         FID_OID_DOT_LUSTRE_OBF  = 2UL,
 332         FID_OID_DOT_LUSTRE_LPF  = 3UL,
 333 };
 334
 335 /** OID for FID_SEQ_ROOT */
 336 enum root_oid {
 337         FID_OID_ROOT            = 1UL,
 338         FID_OID_ECHO_ROOT       = 2UL,
 339 };
 340
 341 static inline bool fid_seq_is_mdt0(__u64 seq)
 342 {
 343         return seq == FID_SEQ_OST_MDT0;
 344 }
 345
 346 static inline bool fid_seq_is_mdt(__u64 seq)
 347 {
 348         return seq == FID_SEQ_OST_MDT0 || seq >= FID_SEQ_NORMAL;
 349 };
 350
 351 static inline bool fid_seq_is_echo(__u64 seq)
 352 {
 353         return seq == FID_SEQ_ECHO;
 354 }
 355
 356 static inline bool fid_is_echo(const struct lu_fid *fid)
 357 {
 358         return fid_seq_is_echo(fid_seq(fid));
 359 }
 360
 361 static inline bool fid_seq_is_llog(__u64 seq)
 362 {
 363         return seq == FID_SEQ_LLOG;
 364 }
 365
 366 static inline bool fid_is_llog(const struct lu_fid *fid)
 367 {
 368         /* file with OID == 0 is not llog but contains last oid */
 369         return fid_seq_is_llog(fid_seq(fid)) && fid_oid(fid) > 0;
 370 }
 371
 372 static inline bool fid_seq_is_rsvd(__u64 seq)
 373 {
 374         return seq > FID_SEQ_OST_MDT0 && seq <= FID_SEQ_RSVD;
 375 };
 376
 377 static inline bool fid_seq_is_special(__u64 seq)
 378 {
 379         return seq == FID_SEQ_SPECIAL;
 380 };
 381
 382 static inline bool fid_seq_is_local_file(__u64 seq)
 383 {
 384         return seq == FID_SEQ_LOCAL_FILE ||
 385                seq == FID_SEQ_LOCAL_NAME;
 386 };
 387
 388 static inline bool fid_seq_is_root(__u64 seq)
 389 {
 390         return seq == FID_SEQ_ROOT;
 391 }
 392
 393 static inline bool fid_seq_is_dot(__u64 seq)
 394 {
 395         return seq == FID_SEQ_DOT_LUSTRE;
 396 }
 397
 398 static inline bool fid_seq_is_default(__u64 seq)
 399 {
 400         return seq == FID_SEQ_LOV_DEFAULT;
 401 }
 402
 403 static inline bool fid_is_mdt0(const struct lu_fid *fid)
 404 {
 405         return fid_seq_is_mdt0(fid_seq(fid));
 406 }
 407
 408 static inline void lu_root_fid(struct lu_fid *fid)
 409 {
 410         fid->f_seq = FID_SEQ_ROOT;
 411         fid->f_oid = FID_OID_ROOT;
 412         fid->f_ver = 0;
 413 }
 414
 415 static inline void lu_echo_root_fid(struct lu_fid *fid)
 416 {
 417         fid->f_seq = FID_SEQ_ROOT;
 418         fid->f_oid = FID_OID_ECHO_ROOT;
 419         fid->f_ver = 0;
 420 }
 421
 422 static inline void lu_update_log_fid(struct lu_fid *fid, __u32 index)
 423 {
 424         fid->f_seq = FID_SEQ_UPDATE_LOG;
 425         fid->f_oid = index;
 426         fid->f_ver = 0;
 427 }
 428
 429 static inline void lu_update_log_dir_fid(struct lu_fid *fid, __u32 index)
 430 {
 431         fid->f_seq = FID_SEQ_UPDATE_LOG_DIR;
 432         fid->f_oid = index;
 433         fid->f_ver = 0;
 434 }
 435
 436 /**
 437  * Check if a fid is igif or not.
 438  * \param fid the fid to be tested.
 439  * \return true if the fid is an igif; otherwise false.
 440  */
 441 static inline bool fid_seq_is_igif(__u64 seq)
 442 {
 443         return seq >= FID_SEQ_IGIF && seq <= FID_SEQ_IGIF_MAX;
 444 }
 445
 446 static inline bool fid_is_igif(const struct lu_fid *fid)
 447 {
 448         return fid_seq_is_igif(fid_seq(fid));
 449 }
 450
 451 /**
 452  * Check if a fid is idif or not.
 453  * \param fid the fid to be tested.
 454  * \return true if the fid is an idif; otherwise false.
 455  */
 456 static inline bool fid_seq_is_idif(__u64 seq)
 457 {
 458         return seq >= FID_SEQ_IDIF && seq <= FID_SEQ_IDIF_MAX;
 459 }
 460
 461 static inline bool fid_is_idif(const struct lu_fid *fid)
 462 {
 463         return fid_seq_is_idif(fid_seq(fid));
 464 }
 465
 466 static inline bool fid_is_local_file(const struct lu_fid *fid)
 467 {
 468         return fid_seq_is_local_file(fid_seq(fid));
 469 }
 470
 471 static inline bool fid_seq_is_norm(__u64 seq)
 472 {
 473         return (seq >= FID_SEQ_NORMAL);
 474 }
 475
 476 static inline bool fid_is_norm(const struct lu_fid *fid)
 477 {
 478         return fid_seq_is_norm(fid_seq(fid));
 479 }
 480
 481 static inline int fid_is_layout_rbtree(const struct lu_fid *fid)
 482 {
 483         return fid_seq(fid) == FID_SEQ_LAYOUT_RBTREE;
 484 }
 485
 486 static inline bool fid_seq_is_update_log(__u64 seq)
 487 {
 488         return seq == FID_SEQ_UPDATE_LOG;
 489 }
 490
 491 static inline bool fid_is_update_log(const struct lu_fid *fid)
 492 {
 493         return fid_seq_is_update_log(fid_seq(fid));
 494 }
 495
 496 static inline bool fid_seq_is_update_log_dir(__u64 seq)
 497 {
 498         return seq == FID_SEQ_UPDATE_LOG_DIR;
 499 }
 500
 501 static inline bool fid_is_update_log_dir(const struct lu_fid *fid)
 502 {
 503         return fid_seq_is_update_log_dir(fid_seq(fid));
 504 }
 505
 506 /* convert an OST objid into an IDIF FID SEQ number */
 507 static inline __u64 fid_idif_seq(__u64 id, __u32 ost_idx)
 508 {
 509         return FID_SEQ_IDIF | (ost_idx << 16) | ((id >> 32) & 0xffff);
 510 }
 511
 512 /* convert a packed IDIF FID into an OST objid */
 513 static inline __u64 fid_idif_id(__u64 seq, __u32 oid, __u32 ver)
 514 {
 515         return ((__u64)ver << 48) | ((seq & 0xffff) << 32) | oid;
 516 }
 517
 518 static inline __u32 idif_ost_idx(__u64 seq)
 519 {
 520         return (seq >> 16) & 0xffff;
 521 }
 522
 523 /* extract ost index from IDIF FID */
 524 static inline __u32 fid_idif_ost_idx(const struct lu_fid *fid)
 525 {
 526         return idif_ost_idx(fid_seq(fid));
 527 }
 528
 529 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
 530 static inline __u64 ostid_seq(const struct ost_id *ostid)
 531 {
 532         if (fid_seq_is_mdt0(ostid->oi.oi_seq))
 533                 return FID_SEQ_OST_MDT0;
 534
 535         if (unlikely(fid_seq_is_default(ostid->oi.oi_seq)))
 536                 return FID_SEQ_LOV_DEFAULT;
 537
 538         if (fid_is_idif(&ostid->oi_fid))
 539                 return FID_SEQ_OST_MDT0;
 540
 541         return fid_seq(&ostid->oi_fid);
 542 }
 543
 544 /* extract OST objid from a wire ost_id (id/seq) pair */
 545 static inline __u64 ostid_id(const struct ost_id *ostid)
 546 {
 547         if (fid_seq_is_mdt0(ostid->oi.oi_seq))
 548                 return ostid->oi.oi_id & IDIF_OID_MASK;
 549
 550         if (unlikely(fid_seq_is_default(ostid->oi.oi_seq)))
 551                 return ostid->oi.oi_id;
 552
 553         if (fid_is_idif(&ostid->oi_fid))
 554                 return fid_idif_id(fid_seq(&ostid->oi_fid),
 555                                    fid_oid(&ostid->oi_fid), 0);
 556
 557         return fid_oid(&ostid->oi_fid);
 558 }
 559
 560 static inline void ostid_set_seq(struct ost_id *oi, __u64 seq)
 561 {
 562         if (fid_seq_is_mdt0(seq) || fid_seq_is_default(seq)) {
 563                 oi->oi.oi_seq = seq;
 564         } else {
 565                 oi->oi_fid.f_seq = seq;
 566                 /* Note: if f_oid + f_ver is zero, we need init it
 567                  * to be 1, otherwise, ostid_seq will treat this
 568                  * as old ostid (oi_seq == 0) */
 569                 if (oi->oi_fid.f_oid == 0 && oi->oi_fid.f_ver == 0)
 570                         oi->oi_fid.f_oid = LUSTRE_FID_INIT_OID;
 571         }
 572 }
 573
 574 static inline void ostid_set_seq_mdt0(struct ost_id *oi)
 575 {
 576         ostid_set_seq(oi, FID_SEQ_OST_MDT0);
 577 }
 578
 579 static inline void ostid_set_seq_echo(struct ost_id *oi)
 580 {
 581         ostid_set_seq(oi, FID_SEQ_ECHO);
 582 }
 583
 584 static inline void ostid_set_seq_llog(struct ost_id *oi)
 585 {
 586         ostid_set_seq(oi, FID_SEQ_LLOG);
 587 }
 588
 589 /**
 590  * Note: we need check oi_seq to decide where to set oi_id,
 591  * so oi_seq should always be set ahead of oi_id.
 592  */
 593 static inline void ostid_set_id(struct ost_id *oi, __u64 oid)
 594 {
 595         if (fid_seq_is_mdt0(oi->oi.oi_seq)) {
 596                 if (oid >= IDIF_MAX_OID) {
 597                         CERROR("Too large OID %#llx to set MDT0 "DOSTID"\n",
 598                                (unsigned long long)oid, POSTID(oi));
 599                         return;
 600                 }
 601                 oi->oi.oi_id = oid;
 602         } else if (fid_is_idif(&oi->oi_fid)) {
 603                 if (oid >= IDIF_MAX_OID) {
 604                         CERROR("Too large OID %#llx to set IDIF "DOSTID"\n",
 605                                (unsigned long long)oid, POSTID(oi));
 606                         return;
 607                 }
 608                 oi->oi_fid.f_seq = fid_idif_seq(oid,
 609                                                 fid_idif_ost_idx(&oi->oi_fid));
 610                 oi->oi_fid.f_oid = oid;
 611                 oi->oi_fid.f_ver = oid >> 48;
 612         } else {
 613                 if (oid > OBIF_MAX_OID) {
 614                         CERROR("Too large oid %#llx to set REG "DOSTID"\n",
 615                                (unsigned long long)oid, POSTID(oi));
 616                         return;
 617                 }
 618                 oi->oi_fid.f_oid = oid;
 619         }
 620 }
 621
 622 static inline int fid_set_id(struct lu_fid *fid, __u64 oid)
 623 {
 624         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
 625                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
 626                 return -EBADF;
 627         }
 628
 629         if (fid_is_idif(fid)) {
 630                 if (oid >= IDIF_MAX_OID) {
 631                         CERROR("Too large OID %#llx to set IDIF "DFID"\n",
 632                                (unsigned long long)oid, PFID(fid));
 633                         return -EBADF;
 634                 }
 635                 fid->f_seq = fid_idif_seq(oid, fid_idif_ost_idx(fid));
 636                 fid->f_oid = oid;
 637                 fid->f_ver = oid >> 48;
 638         } else {
 639                 if (oid > OBIF_MAX_OID) {
 640                         CERROR("Too large OID %#llx to set REG "DFID"\n",
 641                                (unsigned long long)oid, PFID(fid));
 642                         return -EBADF;
 643                 }
 644                 fid->f_oid = oid;
 645         }
 646         return 0;
 647 }
 648
 649 /**
 650  * Unpack an OST object id/seq (group) into a FID.  This is needed for
 651  * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
 652  * FIDs.  Note that if an id/seq is already in FID/IDIF format it will
 653  * be passed through unchanged.  Only legacy OST objects in "group 0"
 654  * will be mapped into the IDIF namespace so that they can fit into the
 655  * struct lu_fid fields without loss.  For reference see:
 656  * http://arch.lustre.org/index.php?title=Interoperability_fids_zfs
 657  */
 658 static inline int ostid_to_fid(struct lu_fid *fid, const struct ost_id *ostid,
 659                                __u32 ost_idx)
 660 {
 661         __u64 seq = ostid_seq(ostid);
 662
 663         if (ost_idx > 0xffff) {
 664                 CERROR("bad ost_idx, "DOSTID" ost_idx:%u\n", POSTID(ostid),
 665                        ost_idx);
 666                 return -EBADF;
 667         }
 668
 669         if (fid_seq_is_mdt0(seq)) {
 670                 __u64 oid = ostid_id(ostid);
 671
 672                 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
 673                  * that we map into the IDIF namespace.  It allows up to 2^48
 674                  * objects per OST, as this is the object namespace that has
 675                  * been in production for years.  This can handle create rates
 676                  * of 1M objects/s/OST for 9 years, or combinations thereof. */
 677                 if (oid >= IDIF_MAX_OID) {
 678                         CERROR("bad MDT0 id(1), "DOSTID" ost_idx:%u\n",
 679                                POSTID(ostid), ost_idx);
 680                         return -EBADF;
 681                 }
 682                 fid->f_seq = fid_idif_seq(oid, ost_idx);
 683                 /* truncate to 32 bits by assignment */
 684                 fid->f_oid = oid;
 685                 /* in theory, not currently used */
 686                 fid->f_ver = oid >> 48;
 687         } else if (likely(!fid_seq_is_default(seq)))
 688                 /* if (fid_seq_is_idif(seq) || fid_seq_is_norm(seq)) */ {
 689                 /* This is either an IDIF object, which identifies objects
 690                  * across all OSTs, or a regular FID.  The IDIF namespace maps
 691                  * legacy OST objects into the FID namespace.  In both cases,
 692                  * we just pass the FID through, no conversion needed. */
 693                 if (ostid->oi_fid.f_ver != 0) {
 694                         CERROR("bad MDT0 id(2), "DOSTID" ost_idx:%u\n",
 695                                 POSTID(ostid), ost_idx);
 696                         return -EBADF;
 697                 }
 698                 *fid = ostid->oi_fid;
 699         }
 700
 701         return 0;
 702 }
 703
 704 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
 705 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
 706 {
 707         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
 708                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
 709                 return -EBADF;
 710         }
 711
 712         if (fid_is_idif(fid)) {
 713                 ostid_set_seq_mdt0(ostid);
 714                 ostid_set_id(ostid, fid_idif_id(fid_seq(fid), fid_oid(fid),
 715                                                 fid_ver(fid)));
 716         } else {
 717                 ostid->oi_fid = *fid;
 718         }
 719
 720         return 0;
 721 }
 722
 723 /* Check whether the fid is for LAST_ID */
 724 static inline bool fid_is_last_id(const struct lu_fid *fid)
 725 {
 726         return fid_oid(fid) == 0 && fid_seq(fid) != FID_SEQ_UPDATE_LOG &&
 727                fid_seq(fid) != FID_SEQ_UPDATE_LOG_DIR;
 728 }
 729
 730 /**
 731  * Get inode number from an igif.
 732  * \param fid an igif to get inode number from.
 733  * \return inode number for the igif.
 734  */
 735 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
 736 {
 737         return fid_seq(fid);
 738 }
 739
 740 /**
 741  * Get inode generation from an igif.
 742  * \param fid an igif to get inode generation from.
 743  * \return inode generation for the igif.
 744  */
 745 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
 746 {
 747         return fid_oid(fid);
 748 }
 749
 750 /**
 751  * Build igif from the inode number/generation.
 752  */
 753 static inline void lu_igif_build(struct lu_fid *fid, __u32 ino, __u32 gen)
 754 {
 755         fid->f_seq = ino;
 756         fid->f_oid = gen;
 757         fid->f_ver = 0;
 758 }
 759
 760 /*
 761  * Fids are transmitted across network (in the sender byte-ordering),
 762  * and stored on disk in big-endian order.
 763  */
 764 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
 765 {
 766         dst->f_seq = cpu_to_le64(fid_seq(src));
 767         dst->f_oid = cpu_to_le32(fid_oid(src));
 768         dst->f_ver = cpu_to_le32(fid_ver(src));
 769 }
 770
 771 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
 772 {
 773         dst->f_seq = le64_to_cpu(fid_seq(src));
 774         dst->f_oid = le32_to_cpu(fid_oid(src));
 775         dst->f_ver = le32_to_cpu(fid_ver(src));
 776 }
 777
 778 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
 779 {
 780         dst->f_seq = cpu_to_be64(fid_seq(src));
 781         dst->f_oid = cpu_to_be32(fid_oid(src));
 782         dst->f_ver = cpu_to_be32(fid_ver(src));
 783 }
 784
 785 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
 786 {
 787         dst->f_seq = be64_to_cpu(fid_seq(src));
 788         dst->f_oid = be32_to_cpu(fid_oid(src));
 789         dst->f_ver = be32_to_cpu(fid_ver(src));
 790 }
 791
 792 static inline bool fid_is_sane(const struct lu_fid *fid)
 793 {
 794         return fid != NULL &&
 795                ((fid_seq(fid) >= FID_SEQ_START && fid_ver(fid) == 0) ||
 796                 fid_is_igif(fid) || fid_is_idif(fid) ||
 797                 fid_seq_is_rsvd(fid_seq(fid)));
 798 }
 799
 800 static inline bool lu_fid_eq(const struct lu_fid *f0, const struct lu_fid *f1)
 801 {
 802         return memcmp(f0, f1, sizeof *f0) == 0;
 803 }
 804
 805 #define __diff_normalize(val0, val1)                            \
 806 ({                                                              \
 807         typeof(val0) __val0 = (val0);                           \
 808         typeof(val1) __val1 = (val1);                           \
 809                                                                 \
 810         (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1);     \
 811 })
 812
 813 static inline int lu_fid_cmp(const struct lu_fid *f0,
 814                              const struct lu_fid *f1)
 815 {
 816         return
 817                 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
 818                 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
 819                 __diff_normalize(fid_ver(f0), fid_ver(f1));
 820 }
 821
 822 static inline void ostid_cpu_to_le(const struct ost_id *src_oi,
 823                                    struct ost_id *dst_oi)
 824 {
 825         if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
 826                 dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
 827                 dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
 828         } else {
 829                 fid_cpu_to_le(&dst_oi->oi_fid, &src_oi->oi_fid);
 830         }
 831 }
 832
 833 static inline void ostid_le_to_cpu(const struct ost_id *src_oi,
 834                                    struct ost_id *dst_oi)
 835 {
 836         if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
 837                 dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
 838                 dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
 839         } else {
 840                 fid_le_to_cpu(&dst_oi->oi_fid, &src_oi->oi_fid);
 841         }
 842 }
 843
 844 struct lu_orphan_rec {
 845         /* The MDT-object's FID referenced by the orphan OST-object */
 846         struct lu_fid   lor_fid;
 847         __u32           lor_uid;
 848         __u32           lor_gid;
 849 };
 850
 851 struct lu_orphan_ent {
 852         /* The orphan OST-object's FID */
 853         struct lu_fid           loe_key;
 854         struct lu_orphan_rec    loe_rec;
 855 };
 856
 857 /** @} lu_fid */
 858
 859 /** \defgroup lu_dir lu_dir
 860  * @{ */
 861
 862 /**
 863  * Enumeration of possible directory entry attributes.
 864  *
 865  * Attributes follow directory entry header in the order they appear in this
 866  * enumeration.
 867  */
 868 enum lu_dirent_attrs {
 869         LUDA_FID                = 0x0001,
 870         LUDA_TYPE               = 0x0002,
 871         LUDA_64BITHASH          = 0x0004,
 872
 873         /* The following attrs are used for MDT internal only,
 874          * not visible to client */
 875
 876         /* Something in the record is unknown, to be verified in further. */
 877         LUDA_UNKNOWN            = 0x0400,
 878         /* Ignore this record, go to next directly. */
 879         LUDA_IGNORE             = 0x0800,
 880         /* The system is upgraded, has beed or to be repaired (dryrun). */
 881         LUDA_UPGRADE            = 0x1000,
 882         /* The dirent has been repaired, or to be repaired (dryrun). */
 883         LUDA_REPAIR             = 0x2000,
 884         /* Only check but not repair the dirent inconsistency */
 885         LUDA_VERIFY_DRYRUN      = 0x4000,
 886         /* Verify the dirent consistency */
 887         LUDA_VERIFY             = 0x8000,
 888 };
 889
 890 #define LU_DIRENT_ATTRS_MASK    0xff00
 891
 892 /**
 893  * Layout of readdir pages, as transmitted on wire.
 894  */
 895 struct lu_dirent {
 896         /** valid if LUDA_FID is set. */
 897         struct lu_fid lde_fid;
 898         /** a unique entry identifier: a hash or an offset. */
 899         __u64         lde_hash;
 900         /** total record length, including all attributes. */
 901         __u16         lde_reclen;
 902         /** name length */
 903         __u16         lde_namelen;
 904         /** optional variable size attributes following this entry.
 905          *  taken from enum lu_dirent_attrs.
 906          */
 907         __u32         lde_attrs;
 908         /** name is followed by the attributes indicated in ->ldp_attrs, in
 909          *  their natural order. After the last attribute, padding bytes are
 910          *  added to make ->lde_reclen a multiple of 8.
 911          */
 912         char          lde_name[0];
 913 };
 914
 915 /*
 916  * Definitions of optional directory entry attributes formats.
 917  *
 918  * Individual attributes do not have their length encoded in a generic way. It
 919  * is assumed that consumer of an attribute knows its format. This means that
 920  * it is impossible to skip over an unknown attribute, except by skipping over all
 921  * remaining attributes (by using ->lde_reclen), which is not too
 922  * constraining, because new server versions will append new attributes at
 923  * the end of an entry.
 924  */
 925
 926 /**
 927  * Fid directory attribute: a fid of an object referenced by the entry. This
 928  * will be almost always requested by the client and supplied by the server.
 929  *
 930  * Aligned to 8 bytes.
 931  */
 932 /* To have compatibility with 1.8, lets have fid in lu_dirent struct. */
 933
 934 /**
 935  * File type.
 936  *
 937  * Aligned to 2 bytes.
 938  */
 939 struct luda_type {
 940         __u16 lt_type;
 941 };
 942
 943 struct lu_dirpage {
 944         __u64            ldp_hash_start;
 945         __u64            ldp_hash_end;
 946         __u32            ldp_flags;
 947         __u32            ldp_pad0;
 948         struct lu_dirent ldp_entries[0];
 949 };
 950
 951 enum lu_dirpage_flags {
 952         /**
 953          * dirpage contains no entry.
 954          */
 955         LDF_EMPTY   = 1 << 0,
 956         /**
 957          * last entry's lde_hash equals ldp_hash_end.
 958          */
 959         LDF_COLLIDE = 1 << 1
 960 };
 961
 962 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
 963 {
 964         if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
 965                 return NULL;
 966         else
 967                 return dp->ldp_entries;
 968 }
 969
 970 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
 971 {
 972         struct lu_dirent *next;
 973
 974         if (le16_to_cpu(ent->lde_reclen) != 0)
 975                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
 976         else
 977                 next = NULL;
 978
 979         return next;
 980 }
 981
 982 static inline size_t lu_dirent_calc_size(size_t namelen, __u16 attr)
 983 {
 984         size_t size;
 985
 986         if (attr & LUDA_TYPE) {
 987                 const size_t align = sizeof(struct luda_type) - 1;
 988                 size = (sizeof(struct lu_dirent) + namelen + align) & ~align;
 989                 size += sizeof(struct luda_type);
 990         } else
 991                 size = sizeof(struct lu_dirent) + namelen;
 992
 993         return (size + 7) & ~7;
 994 }
 995
 996 #define MDS_DIR_END_OFF 0xfffffffffffffffeULL
 997
 998 /**
 999  * MDS_READPAGE page size
1000  *
1001  * This is the directory page size packed in MDS_READPAGE RPC.
1002  * It's different than PAGE_CACHE_SIZE because the client needs to
1003  * access the struct lu_dirpage header packed at the beginning of
1004  * the "page" and without this there isn't any way to know find the
1005  * lu_dirpage header is if client and server PAGE_CACHE_SIZE differ.
1006  */
1007 #define LU_PAGE_SHIFT 12
1008 #define LU_PAGE_SIZE  (1UL << LU_PAGE_SHIFT)
1009 #define LU_PAGE_MASK  (~(LU_PAGE_SIZE - 1))
1010
1011 #define LU_PAGE_COUNT (1 << (PAGE_CACHE_SHIFT - LU_PAGE_SHIFT))
1012
1013 /** @} lu_dir */
1014
1015 struct lustre_handle {
1016         __u64 cookie;
1017 };
1018 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
1019
1020 static inline bool lustre_handle_is_used(const struct lustre_handle *lh)
1021 {
1022         return lh->cookie != 0;
1023 }
1024
1025 static inline bool lustre_handle_equal(const struct lustre_handle *lh1,
1026                                        const struct lustre_handle *lh2)
1027 {
1028         return lh1->cookie == lh2->cookie;
1029 }
1030
1031 static inline void lustre_handle_copy(struct lustre_handle *tgt,
1032                                       const struct lustre_handle *src)
1033 {
1034         tgt->cookie = src->cookie;
1035 }
1036
1037 struct lustre_handle_array {
1038         unsigned int            count;
1039         struct lustre_handle    handles[0];
1040 };
1041
1042 /* flags for lm_flags */
1043 #define MSGHDR_AT_SUPPORT               0x1
1044 #define MSGHDR_CKSUM_INCOMPAT18         0x2
1045
1046 #define lustre_msg lustre_msg_v2
1047 /* we depend on this structure to be 8-byte aligned */
1048 /* this type is only endian-adjusted in lustre_unpack_msg() */
1049 struct lustre_msg_v2 {
1050         __u32 lm_bufcount;
1051         __u32 lm_secflvr;
1052         __u32 lm_magic;
1053         __u32 lm_repsize;
1054         __u32 lm_cksum;
1055         __u32 lm_flags;
1056         __u32 lm_padding_2;
1057         __u32 lm_padding_3;
1058         __u32 lm_buflens[0];
1059 };
1060
1061 /* without gss, ptlrpc_body is put at the first buffer. */
1062 #define PTLRPC_NUM_VERSIONS     4
1063 struct ptlrpc_body_v3 {
1064         struct lustre_handle pb_handle;
1065         __u32 pb_type;
1066         __u32 pb_version;
1067         __u32 pb_opc;
1068         __u32 pb_status;
1069         __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
1070         __u16 pb_tag;      /* virtual slot idx for multiple modifying RPCs */
1071         __u16 pb_padding0;
1072         __u32 pb_padding1;
1073         __u64 pb_last_committed;
1074         __u64 pb_transno;
1075         __u32 pb_flags;
1076         __u32 pb_op_flags;
1077         __u32 pb_conn_cnt;
1078         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1079         __u32 pb_service_time; /* for rep, actual service time */
1080         __u32 pb_limit;
1081         __u64 pb_slv;
1082         /* VBR: pre-versions */
1083         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1084         __u64 pb_mbits; /**< match bits for bulk request */
1085         /* padding for future needs */
1086         __u64 pb_padding64_0;
1087         __u64 pb_padding64_1;
1088         __u64 pb_padding64_2;
1089         char  pb_jobid[LUSTRE_JOBID_SIZE];
1090 };
1091 #define ptlrpc_body     ptlrpc_body_v3
1092
1093 struct ptlrpc_body_v2 {
1094         struct lustre_handle pb_handle;
1095         __u32 pb_type;
1096         __u32 pb_version;
1097         __u32 pb_opc;
1098         __u32 pb_status;
1099         __u64 pb_last_xid; /* highest replied XID without lower unreplied XID */
1100         __u16 pb_tag;      /* virtual slot idx for multiple modifying RPCs */
1101         __u16 pb_padding0;
1102         __u32 pb_padding1;
1103         __u64 pb_last_committed;
1104         __u64 pb_transno;
1105         __u32 pb_flags;
1106         __u32 pb_op_flags;
1107         __u32 pb_conn_cnt;
1108         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
1109         __u32 pb_service_time; /* for rep, actual service time, also used for
1110                                   net_latency of req */
1111         __u32 pb_limit;
1112         __u64 pb_slv;
1113         /* VBR: pre-versions */
1114         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
1115         __u64 pb_mbits; /**< unused in V2 */
1116         /* padding for future needs */
1117         __u64 pb_padding64_0;
1118         __u64 pb_padding64_1;
1119         __u64 pb_padding64_2;
1120 };
1121
1122 /* message body offset for lustre_msg_v2 */
1123 /* ptlrpc body offset in all request/reply messages */
1124 #define MSG_PTLRPC_BODY_OFF             0
1125
1126 /* normal request/reply message record offset */
1127 #define REQ_REC_OFF                     1
1128 #define REPLY_REC_OFF                   1
1129
1130 /* ldlm request message body offset */
1131 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
1132 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
1133
1134 /* ldlm intent lock message body offset */
1135 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
1136 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
1137
1138 /* ldlm reply message body offset */
1139 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
1140 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
1141
1142 /** only use in req->rq_{req,rep}_swab_mask */
1143 #define MSG_PTLRPC_HEADER_OFF           31
1144
1145 /* Flags that are operation-specific go in the top 16 bits. */
1146 #define MSG_OP_FLAG_MASK   0xffff0000
1147 #define MSG_OP_FLAG_SHIFT  16
1148
1149 /* Flags that apply to all requests are in the bottom 16 bits */
1150 #define MSG_GEN_FLAG_MASK     0x0000ffff
1151 #define MSG_LAST_REPLAY           0x0001
1152 #define MSG_RESENT                0x0002
1153 #define MSG_REPLAY                0x0004
1154 /* #define MSG_AT_SUPPORT         0x0008
1155  * This was used in early prototypes of adaptive timeouts, and while there
1156  * shouldn't be any users of that code there also isn't a need for using this
1157  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
1158 #define MSG_DELAY_REPLAY          0x0010
1159 #define MSG_VERSION_REPLAY        0x0020
1160 #define MSG_REQ_REPLAY_DONE       0x0040
1161 #define MSG_LOCK_REPLAY_DONE      0x0080
1162
1163 /*
1164  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
1165  */
1166
1167 #define MSG_CONNECT_RECOVERING  0x00000001
1168 #define MSG_CONNECT_RECONNECT   0x00000002
1169 #define MSG_CONNECT_REPLAYABLE  0x00000004
1170 //#define MSG_CONNECT_PEER        0x8
1171 #define MSG_CONNECT_LIBCLIENT   0x00000010
1172 #define MSG_CONNECT_INITIAL     0x00000020
1173 #define MSG_CONNECT_ASYNC       0x00000040
1174 #define MSG_CONNECT_NEXT_VER    0x00000080 /* use next version of lustre_msg */
1175 #define MSG_CONNECT_TRANSNO     0x00000100 /* report transno */
1176
1177 /* Connect flags */
1178 #define OBD_CONNECT_RDONLY                0x1ULL /*client has read-only access*/
1179 #define OBD_CONNECT_INDEX                 0x2ULL /*connect specific LOV idx */
1180 #define OBD_CONNECT_MDS                   0x4ULL /*connect from MDT to OST */
1181 #define OBD_CONNECT_GRANT                 0x8ULL /*OSC gets grant at connect */
1182 #define OBD_CONNECT_SRVLOCK              0x10ULL /*server takes locks for cli */
1183 #define OBD_CONNECT_VERSION              0x20ULL /*Lustre versions in ocd */
1184 #define OBD_CONNECT_REQPORTAL            0x40ULL /*Separate non-IO req portal */
1185 #define OBD_CONNECT_ACL                  0x80ULL /*access control lists */
1186 #define OBD_CONNECT_XATTR               0x100ULL /*client use extended attr */
1187 #define OBD_CONNECT_CROW                0x200ULL /*MDS+OST create obj on write*/
1188 #define OBD_CONNECT_TRUNCLOCK           0x400ULL /*locks on server for punch */
1189 #define OBD_CONNECT_TRANSNO             0x800ULL /*replay sends init transno */
1190 #define OBD_CONNECT_IBITS              0x1000ULL /*support for inodebits locks*/
1191 #define OBD_CONNECT_JOIN               0x2000ULL /*files can be concatenated.
1192                                                   *We do not support JOIN FILE
1193                                                   *anymore, reserve this flags
1194                                                   *just for preventing such bit
1195                                                   *to be reused.*/
1196 #define OBD_CONNECT_ATTRFID            0x4000ULL /*Server can GetAttr By Fid*/
1197 #define OBD_CONNECT_NODEVOH            0x8000ULL /*No open hndl on specl nodes*/
1198 #define OBD_CONNECT_RMT_CLIENT        0x10000ULL /*Remote client */
1199 #define OBD_CONNECT_RMT_CLIENT_FORCE  0x20000ULL /*Remote client by force */
1200 #define OBD_CONNECT_BRW_SIZE          0x40000ULL /*Max bytes per rpc */
1201 #define OBD_CONNECT_QUOTA64           0x80000ULL /*Not used since 2.4 */
1202 #define OBD_CONNECT_MDS_CAPA         0x100000ULL /*MDS capability */
1203 #define OBD_CONNECT_OSS_CAPA         0x200000ULL /*OSS capability */
1204 #define OBD_CONNECT_CANCELSET        0x400000ULL /*Early batched cancels. */
1205 #define OBD_CONNECT_SOM              0x800000ULL /*Size on MDS */
1206 #define OBD_CONNECT_AT              0x1000000ULL /*client uses AT */
1207 #define OBD_CONNECT_LRU_RESIZE      0x2000000ULL /*LRU resize feature. */
1208 #define OBD_CONNECT_MDS_MDS         0x4000000ULL /*MDS-MDS connection */
1209 #define OBD_CONNECT_REAL            0x8000000ULL /*real connection */
1210 #define OBD_CONNECT_CHANGE_QS      0x10000000ULL /*Not used since 2.4 */
1211 #define OBD_CONNECT_CKSUM          0x20000000ULL /*support several cksum algos*/
1212 #define OBD_CONNECT_FID            0x40000000ULL /*FID is supported by server */
1213 #define OBD_CONNECT_VBR            0x80000000ULL /*version based recovery */
1214 #define OBD_CONNECT_LOV_V3        0x100000000ULL /*client supports LOV v3 EA */
1215 #define OBD_CONNECT_GRANT_SHRINK  0x200000000ULL /* support grant shrink */
1216 #define OBD_CONNECT_SKIP_ORPHAN   0x400000000ULL /* don't reuse orphan objids */
1217 #define OBD_CONNECT_MAX_EASIZE    0x800000000ULL /* preserved for large EA */
1218 #define OBD_CONNECT_FULL20       0x1000000000ULL /* it is 2.0 client */
1219 #define OBD_CONNECT_LAYOUTLOCK   0x2000000000ULL /* client uses layout lock */
1220 #define OBD_CONNECT_64BITHASH    0x4000000000ULL /* client supports 64-bits
1221                                                   * directory hash */
1222 #define OBD_CONNECT_MAXBYTES     0x8000000000ULL /* max stripe size */
1223 #define OBD_CONNECT_IMP_RECOV   0x10000000000ULL /* imp recovery support */
1224 #define OBD_CONNECT_JOBSTATS    0x20000000000ULL /* jobid in ptlrpc_body */
1225 #define OBD_CONNECT_UMASK       0x40000000000ULL /* create uses client umask */
1226 #define OBD_CONNECT_EINPROGRESS 0x80000000000ULL /* client handles -EINPROGRESS
1227                                                   * RPC error properly */
1228 #define OBD_CONNECT_GRANT_PARAM 0x100000000000ULL/* extra grant params used for
1229                                                   * finer space reservation */
1230 #define OBD_CONNECT_FLOCK_OWNER 0x200000000000ULL /* for the fixed 1.8
1231                                                    * policy and 2.x server */
1232 #define OBD_CONNECT_LVB_TYPE    0x400000000000ULL /* variable type of LVB */
1233 #define OBD_CONNECT_NANOSEC_TIME 0x800000000000ULL /* nanosecond timestamps */
1234 #define OBD_CONNECT_LIGHTWEIGHT 0x1000000000000ULL/* lightweight connection */
1235 #define OBD_CONNECT_SHORTIO     0x2000000000000ULL/* short io */
1236 #define OBD_CONNECT_PINGLESS    0x4000000000000ULL/* pings not required */
1237 #define OBD_CONNECT_FLOCK_DEAD  0x8000000000000ULL/* improved flock deadlock detection */
1238 #define OBD_CONNECT_DISP_STRIPE 0x10000000000000ULL/* create stripe disposition*/
1239 #define OBD_CONNECT_OPEN_BY_FID 0x20000000000000ULL /* open by fid won't pack
1240                                                        name in request */
1241 #define OBD_CONNECT_LFSCK      0x40000000000000ULL/* support online LFSCK */
1242 #define OBD_CONNECT_UNLINK_CLOSE 0x100000000000000ULL/* close file in unlink */
1243 #define OBD_CONNECT_MULTIMODRPCS 0x200000000000000ULL /* support multiple modify
1244                                                          RPCs in parallel */
1245 #define OBD_CONNECT_DIR_STRIPE   0x400000000000000ULL /* striped DNE dir */
1246 #define OBD_CONNECT_SUBTREE     0x800000000000000ULL /* fileset mount */
1247 #define OBD_CONNECT_LOCK_AHEAD   0x1000000000000000ULL /* lock ahead */
1248 /** bulk matchbits is sent within ptlrpc_body */
1249 #define OBD_CONNECT_BULK_MBITS   0x2000000000000000ULL
1250 #define OBD_CONNECT_OBDOPACK     0x4000000000000000ULL /* compact OUT obdo */
1251 #define OBD_CONNECT_FLAGS2       0x8000000000000000ULL /* second flags word */
1252 /* XXX README XXX:
1253  * Please DO NOT add flag values here before first ensuring that this same
1254  * flag value is not in use on some other branch.  Please clear any such
1255  * changes with senior engineers before starting to use a new flag.  Then,
1256  * submit a small patch against EVERY branch that ONLY adds the new flag,
1257  * updates obd_connect_names[] for lprocfs_rd_connect_flags(), adds the
1258  * flag to check_obd_connect_data(), and updates wiretests accordingly, so it
1259  * can be approved and landed easily to reserve the flag for future use. */
1260
1261 /* The MNE_SWAB flag is overloading the MDS_MDS bit only for the MGS
1262  * connection.  It is a temporary bug fix for Imperative Recovery interop
1263  * between 2.2 and 2.3 x86/ppc nodes, and can be removed when interop for
1264  * 2.2 clients/servers is no longer needed.  LU-1252/LU-1644. */
1265 #define OBD_CONNECT_MNE_SWAB             OBD_CONNECT_MDS_MDS
1266
1267 #define OCD_HAS_FLAG(ocd, flg)  \
1268         (!!((ocd)->ocd_connect_flags & OBD_CONNECT_##flg))
1269
1270
1271 #ifdef HAVE_LRU_RESIZE_SUPPORT
1272 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
1273 #else
1274 #define LRU_RESIZE_CONNECT_FLAG 0
1275 #endif
1276
1277 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
1278                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
1279                                 OBD_CONNECT_IBITS | \
1280                                 OBD_CONNECT_NODEVOH | OBD_CONNECT_ATTRFID | \
1281                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1282                                 OBD_CONNECT_RMT_CLIENT | \
1283                                 OBD_CONNECT_RMT_CLIENT_FORCE | \
1284                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_MDS_MDS | \
1285                                 OBD_CONNECT_FID | LRU_RESIZE_CONNECT_FLAG | \
1286                                 OBD_CONNECT_VBR | OBD_CONNECT_LOV_V3 | \
1287                                 OBD_CONNECT_FULL20 | \
1288                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_JOBSTATS | \
1289                                 OBD_CONNECT_EINPROGRESS | \
1290                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_UMASK | \
1291                                 OBD_CONNECT_LVB_TYPE | OBD_CONNECT_LAYOUTLOCK |\
1292                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_MAX_EASIZE |\
1293                                 OBD_CONNECT_FLOCK_DEAD | \
1294                                 OBD_CONNECT_DISP_STRIPE | OBD_CONNECT_LFSCK | \
1295                                 OBD_CONNECT_OPEN_BY_FID | \
1296                                 OBD_CONNECT_DIR_STRIPE | \
1297                                 OBD_CONNECT_BULK_MBITS | \
1298                                 OBD_CONNECT_MULTIMODRPCS)
1299
1300 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
1301                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
1302                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
1303                                 OBD_CONNECT_BRW_SIZE | \
1304                                 OBD_CONNECT_CANCELSET | OBD_CONNECT_AT | \
1305                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_CKSUM | \
1306                                 OBD_CONNECT_RMT_CLIENT | \
1307                                 OBD_CONNECT_RMT_CLIENT_FORCE | OBD_CONNECT_VBR | \
1308                                 OBD_CONNECT_MDS | OBD_CONNECT_SKIP_ORPHAN | \
1309                                 OBD_CONNECT_GRANT_SHRINK | OBD_CONNECT_FULL20 | \
1310                                 OBD_CONNECT_64BITHASH | OBD_CONNECT_MAXBYTES | \
1311                                 OBD_CONNECT_MAX_EASIZE | \
1312                                 OBD_CONNECT_EINPROGRESS | \
1313                                 OBD_CONNECT_JOBSTATS | \
1314                                 OBD_CONNECT_LIGHTWEIGHT | OBD_CONNECT_LVB_TYPE|\
1315                                 OBD_CONNECT_LAYOUTLOCK | OBD_CONNECT_FID | \
1316                                 OBD_CONNECT_PINGLESS | OBD_CONNECT_LFSCK | \
1317                                 OBD_CONNECT_BULK_MBITS | \
1318                                 OBD_CONNECT_GRANT_PARAM)
1319 #define ECHO_CONNECT_SUPPORTED (0)
1320 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT | \
1321                                 OBD_CONNECT_FULL20 | OBD_CONNECT_IMP_RECOV | \
1322                                 OBD_CONNECT_MNE_SWAB | OBD_CONNECT_PINGLESS |\
1323                                 OBD_CONNECT_BULK_MBITS)
1324
1325 /* Features required for this version of the client to work with server */
1326 #define CLIENT_CONNECT_MDT_REQD (OBD_CONNECT_IBITS | OBD_CONNECT_FID | \
1327                                  OBD_CONNECT_FULL20)
1328
1329 /* This structure is used for both request and reply.
1330  *
1331  * If we eventually have separate connect data for different types, which we
1332  * almost certainly will, then perhaps we stick a union in here. */
1333 struct obd_connect_data {
1334         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
1335         __u32 ocd_version;       /* lustre release version number */
1336         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
1337         __u32 ocd_index;         /* LOV index to connect to */
1338         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
1339         __u64 ocd_ibits_known;   /* inode bits this client understands */
1340         __u8  ocd_grant_blkbits; /* log2 of the backend filesystem blocksize */
1341         __u8  ocd_grant_inobits; /* log2 of the per-inode space consumption */
1342         __u16 ocd_grant_tax_kb;  /* extent insertion overhead, in 1K blocks */
1343         __u32 ocd_grant_max_blks;/* maximum number of blocks per extent */
1344         __u64 ocd_transno;       /* first transno from client to be replayed */
1345         __u32 ocd_group;         /* MDS group on OST */
1346         __u32 ocd_cksum_types;   /* supported checksum algorithms */
1347         __u32 ocd_max_easize;    /* How big LOV EA can be on MDS */
1348         __u32 ocd_instance;      /* instance # of this target */
1349         __u64 ocd_maxbytes;      /* Maximum stripe size in bytes */
1350         /* Fields after ocd_maxbytes are only accessible by the receiver
1351          * if the corresponding flag in ocd_connect_flags is set. Accessing
1352          * any field after ocd_maxbytes on the receiver without a valid flag
1353          * may result in out-of-bound memory access and kernel oops. */
1354         __u16 ocd_maxmodrpcs;    /* Maximum modify RPCs in parallel */
1355         __u16 padding0;          /* added 2.1.0. also fix lustre_swab_connect */
1356         __u32 padding1;          /* added 2.1.0. also fix lustre_swab_connect */
1357         __u64 ocd_connect_flags2;
1358         __u64 padding3;          /* added 2.1.0. also fix lustre_swab_connect */
1359         __u64 padding4;          /* added 2.1.0. also fix lustre_swab_connect */
1360         __u64 padding5;          /* added 2.1.0. also fix lustre_swab_connect */
1361         __u64 padding6;          /* added 2.1.0. also fix lustre_swab_connect */
1362         __u64 padding7;          /* added 2.1.0. also fix lustre_swab_connect */
1363         __u64 padding8;          /* added 2.1.0. also fix lustre_swab_connect */
1364         __u64 padding9;          /* added 2.1.0. also fix lustre_swab_connect */
1365         __u64 paddingA;          /* added 2.1.0. also fix lustre_swab_connect */
1366         __u64 paddingB;          /* added 2.1.0. also fix lustre_swab_connect */
1367         __u64 paddingC;          /* added 2.1.0. also fix lustre_swab_connect */
1368         __u64 paddingD;          /* added 2.1.0. also fix lustre_swab_connect */
1369         __u64 paddingE;          /* added 2.1.0. also fix lustre_swab_connect */
1370         __u64 paddingF;          /* added 2.1.0. also fix lustre_swab_connect */
1371 };
1372 /* XXX README XXX:
1373  * Please DO NOT use any fields here before first ensuring that this same
1374  * field is not in use on some other branch.  Please clear any such changes
1375  * with senior engineers before starting to use a new field.  Then, submit
1376  * a small patch against EVERY branch that ONLY adds the new field along with
1377  * the matching OBD_CONNECT flag, so that can be approved and landed easily to
1378  * reserve the flag for future use. */
1379
1380 /*
1381  * Supported checksum algorithms. Up to 32 checksum types are supported.
1382  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
1383  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
1384  * algorithm and also the OBD_FL_CKSUM* flags.
1385  */
1386 typedef enum {
1387         OBD_CKSUM_CRC32 = 0x00000001,
1388         OBD_CKSUM_ADLER = 0x00000002,
1389         OBD_CKSUM_CRC32C= 0x00000004,
1390 } cksum_type_t;
1391
1392 /*
1393  *   OST requests: OBDO & OBD request records
1394  */
1395
1396 /* opcodes */
1397 typedef enum {
1398         OST_REPLY      =  0,       /* reply ? */
1399         OST_GETATTR    =  1,
1400         OST_SETATTR    =  2,
1401         OST_READ       =  3,
1402         OST_WRITE      =  4,
1403         OST_CREATE     =  5,
1404         OST_DESTROY    =  6,
1405         OST_GET_INFO   =  7,
1406         OST_CONNECT    =  8,
1407         OST_DISCONNECT =  9,
1408         OST_PUNCH      = 10,
1409         OST_OPEN       = 11,
1410         OST_CLOSE      = 12,
1411         OST_STATFS     = 13,
1412         OST_SYNC       = 16,
1413         OST_SET_INFO   = 17,
1414         OST_QUOTACHECK = 18, /* not used since 2.4 */
1415         OST_QUOTACTL   = 19,
1416         OST_QUOTA_ADJUST_QUNIT = 20, /* not used since 2.4 */
1417         OST_LAST_OPC
1418 } ost_cmd_t;
1419 #define OST_FIRST_OPC  OST_REPLY
1420
1421 enum obdo_flags {
1422         OBD_FL_INLINEDATA   = 0x00000001,
1423         OBD_FL_OBDMDEXISTS  = 0x00000002,
1424         OBD_FL_DELORPHAN    = 0x00000004, /* if set in o_flags delete orphans */
1425         OBD_FL_NORPC        = 0x00000008, /* set in o_flags do in OSC not OST */
1426         OBD_FL_IDONLY       = 0x00000010, /* set in o_flags only adjust obj id*/
1427         OBD_FL_RECREATE_OBJS= 0x00000020, /* recreate missing obj */
1428         OBD_FL_DEBUG_CHECK  = 0x00000040, /* echo client/server debug check */
1429         OBD_FL_NO_USRQUOTA  = 0x00000100, /* the object's owner is over quota */
1430         OBD_FL_NO_GRPQUOTA  = 0x00000200, /* the object's group is over quota */
1431         OBD_FL_CREATE_CROW  = 0x00000400, /* object should be create on write */
1432         OBD_FL_SRVLOCK      = 0x00000800, /* delegate DLM locking to server */
1433         OBD_FL_CKSUM_CRC32  = 0x00001000, /* CRC32 checksum type */
1434         OBD_FL_CKSUM_ADLER  = 0x00002000, /* ADLER checksum type */
1435         OBD_FL_CKSUM_CRC32C = 0x00004000, /* CRC32C checksum type */
1436         OBD_FL_CKSUM_RSVD2  = 0x00008000, /* for future cksum types */
1437         OBD_FL_CKSUM_RSVD3  = 0x00010000, /* for future cksum types */
1438         OBD_FL_SHRINK_GRANT = 0x00020000, /* object shrink the grant */
1439         OBD_FL_MMAP         = 0x00040000, /* object is mmapped on the client.
1440                                            * XXX: obsoleted - reserved for old
1441                                            * clients prior than 2.2 */
1442         OBD_FL_RECOV_RESEND = 0x00080000, /* recoverable resent */
1443         OBD_FL_NOSPC_BLK    = 0x00100000, /* no more block space on OST */
1444         OBD_FL_FLUSH        = 0x00200000, /* flush pages on the OST */
1445         OBD_FL_SHORT_IO     = 0x00400000, /* short io request */
1446
1447         /* Note that while these checksum values are currently separate bits,
1448          * in 2.x we can actually allow all values from 1-31 if we wanted. */
1449         OBD_FL_CKSUM_ALL    = OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER |
1450                               OBD_FL_CKSUM_CRC32C,
1451
1452         /* mask for local-only flag, which won't be sent over network */
1453         OBD_FL_LOCAL_MASK   = 0xF0000000,
1454 };
1455
1456 /*
1457  * All LOV EA magics should have the same postfix, if some new version
1458  * Lustre instroduces new LOV EA magic, then when down-grade to an old
1459  * Lustre, even though the old version system does not recognizes such
1460  * new magic, it still can distinguish the corrupted cases by checking
1461  * the magic's postfix.
1462  */
1463 #define LOV_MAGIC_MAGIC 0x0BD0
1464 #define LOV_MAGIC_MASK  0xFFFF
1465
1466 #define LOV_MAGIC_V1            (0x0BD10000 | LOV_MAGIC_MAGIC)
1467 #define LOV_MAGIC_JOIN_V1       (0x0BD20000 | LOV_MAGIC_MAGIC)
1468 #define LOV_MAGIC_V3            (0x0BD30000 | LOV_MAGIC_MAGIC)
1469 #define LOV_MAGIC_MIGRATE       (0x0BD40000 | LOV_MAGIC_MAGIC)
1470 /* reserved for specifying OSTs */
1471 #define LOV_MAGIC_SPECIFIC      (0x0BD50000 | LOV_MAGIC_MAGIC)
1472 #define LOV_MAGIC               LOV_MAGIC_V1
1473
1474 /*
1475  * magic for fully defined striping
1476  * the idea is that we should have different magics for striping "hints"
1477  * (struct lov_user_md_v[13]) and defined ready-to-use striping (struct
1478  * lov_mds_md_v[13]). at the moment the magics are used in wire protocol,
1479  * we can't just change it w/o long way preparation, but we still need a
1480  * mechanism to allow LOD to differentiate hint versus ready striping.
1481  * so, at the moment we do a trick: MDT knows what to expect from request
1482  * depending on the case (replay uses ready striping, non-replay req uses
1483  * hints), so MDT replaces magic with appropriate one and now LOD can
1484  * easily understand what's inside -bzzz
1485  */
1486 #define LOV_MAGIC_V1_DEF  0x0CD10BD0
1487 #define LOV_MAGIC_V3_DEF  0x0CD30BD0
1488
1489 #define lov_pattern(pattern)            (pattern & ~LOV_PATTERN_F_MASK)
1490 #define lov_pattern_flags(pattern)      (pattern & LOV_PATTERN_F_MASK)
1491
1492 #define lov_ost_data lov_ost_data_v1
1493 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
1494         struct ost_id l_ost_oi;   /* OST object ID */
1495         __u32 l_ost_gen;          /* generation of this l_ost_idx */
1496         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
1497 };
1498
1499 #define lov_mds_md lov_mds_md_v1
1500 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
1501         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
1502         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1503         struct ost_id   lmm_oi;   /* LOV object ID */
1504         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1505         /* lmm_stripe_count used to be __u32 */
1506         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1507         __u16 lmm_layout_gen;     /* layout generation number */
1508         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1509 };
1510
1511 /**
1512  * Sigh, because pre-2.4 uses
1513  * struct lov_mds_md_v1 {
1514  *      ........
1515  *      __u64 lmm_object_id;
1516  *      __u64 lmm_object_seq;
1517  *      ......
1518  *      }
1519  * to identify the LOV(MDT) object, and lmm_object_seq will
1520  * be normal_fid, which make it hard to combine these conversion
1521  * to ostid_to FID. so we will do lmm_oi/fid conversion separately
1522  *
1523  * We can tell the lmm_oi by this way,
1524  * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
1525  * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
1526  * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
1527  *      lmm_oi.f_ver = 0
1528  *
1529  * But currently lmm_oi/lsm_oi does not have any "real" usages,
1530  * except for printing some information, and the user can always
1531  * get the real FID from LMA, besides this multiple case check might
1532  * make swab more complicate. So we will keep using id/seq for lmm_oi.
1533  */
1534
1535 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
1536                                  struct ost_id *oi)
1537 {
1538         oi->oi.oi_id = fid_oid(fid);
1539         oi->oi.oi_seq = fid_seq(fid);
1540 }
1541
1542 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
1543 {
1544         oi->oi.oi_seq = seq;
1545 }
1546
1547 static inline void lmm_oi_set_id(struct ost_id *oi, __u64 oid)
1548 {
1549         oi->oi.oi_id = oid;
1550 }
1551
1552 static inline __u64 lmm_oi_id(const struct ost_id *oi)
1553 {
1554         return oi->oi.oi_id;
1555 }
1556
1557 static inline __u64 lmm_oi_seq(const struct ost_id *oi)
1558 {
1559         return oi->oi.oi_seq;
1560 }
1561
1562 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
1563                                     const struct ost_id *src_oi)
1564 {
1565         dst_oi->oi.oi_id = le64_to_cpu(src_oi->oi.oi_id);
1566         dst_oi->oi.oi_seq = le64_to_cpu(src_oi->oi.oi_seq);
1567 }
1568
1569 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
1570                                     const struct ost_id *src_oi)
1571 {
1572         dst_oi->oi.oi_id = cpu_to_le64(src_oi->oi.oi_id);
1573         dst_oi->oi.oi_seq = cpu_to_le64(src_oi->oi.oi_seq);
1574 }
1575
1576 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
1577 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
1578
1579 /* This is the default MDT reply size allocated, should the striping be bigger,
1580  * it will be reallocated in mdt_fix_reply.
1581  * 100 stripes is a bit less than 2.5k of data */
1582 #define DEF_REP_MD_SIZE (sizeof(struct lov_mds_md) + \
1583                          100 * sizeof(struct lov_ost_data))
1584
1585 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
1586 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
1587 #define XATTR_USER_PREFIX       "user."
1588 #define XATTR_TRUSTED_PREFIX    "trusted."
1589 #define XATTR_SECURITY_PREFIX   "security."
1590
1591 #define XATTR_NAME_LOV          "trusted.lov"
1592 #define XATTR_NAME_LMA          "trusted.lma"
1593 #define XATTR_NAME_LMV          "trusted.lmv"
1594 #define XATTR_NAME_DEFAULT_LMV  "trusted.dmv"
1595 #define XATTR_NAME_LINK         "trusted.link"
1596 #define XATTR_NAME_FID          "trusted.fid"
1597 #define XATTR_NAME_VERSION      "trusted.version"
1598 #define XATTR_NAME_SOM          "trusted.som"
1599 #define XATTR_NAME_HSM          "trusted.hsm"
1600 #define XATTR_NAME_LFSCK_BITMAP "trusted.lfsck_bitmap"
1601 #define XATTR_NAME_DUMMY        "trusted.dummy"
1602
1603 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 8, 53, 0)
1604 # define XATTR_NAME_LFSCK_NAMESPACE_OLD "trusted.lfsck_namespace"
1605 #endif
1606
1607 #define XATTR_NAME_LFSCK_NAMESPACE "trusted.lfsck_ns"
1608 #define XATTR_NAME_MAX_LEN      32 /* increase this, if there is longer name. */
1609
1610 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
1611         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
1612         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
1613         struct ost_id   lmm_oi;   /* LOV object ID */
1614         __u32 lmm_stripe_size;    /* size of stripe in bytes */
1615         /* lmm_stripe_count used to be __u32 */
1616         __u16 lmm_stripe_count;   /* num stripes in use for this object */
1617         __u16 lmm_layout_gen;     /* layout generation number */
1618         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* must be 32bit aligned */
1619         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
1620 };
1621
1622 static inline __u32 lov_mds_md_size(__u16 stripes, __u32 lmm_magic)
1623 {
1624         if (lmm_magic == LOV_MAGIC_V3)
1625                 return sizeof(struct lov_mds_md_v3) +
1626                                 stripes * sizeof(struct lov_ost_data_v1);
1627         else
1628                 return sizeof(struct lov_mds_md_v1) +
1629                                 stripes * sizeof(struct lov_ost_data_v1);
1630 }
1631
1632 static inline __u32
1633 lov_mds_md_max_stripe_count(size_t buf_size, __u32 lmm_magic)
1634 {
1635         switch (lmm_magic) {
1636         case LOV_MAGIC_V1: {
1637                 struct lov_mds_md_v1 lmm;
1638
1639                 if (buf_size < sizeof(lmm))
1640                         return 0;
1641
1642                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1643         }
1644         case LOV_MAGIC_V3: {
1645                 struct lov_mds_md_v3 lmm;
1646
1647                 if (buf_size < sizeof(lmm))
1648                         return 0;
1649
1650                 return (buf_size - sizeof(lmm)) / sizeof(lmm.lmm_objects[0]);
1651         }
1652         default:
1653                 return 0;
1654         }
1655 }
1656
1657 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
1658 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
1659 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
1660 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
1661 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
1662 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
1663 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
1664 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
1665 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
1666 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
1667 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
1668 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
1669 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
1670 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
1671 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
1672 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
1673 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
1674 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
1675 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
1676 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
1677 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
1678 /*#define OBD_MD_FLOSCOPQ    (0x00400000ULL) osc opaque data, never used */
1679 /*      OBD_MD_FLCOOKIE    (0x00800000ULL)    obsolete in 2.8 */
1680 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
1681 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
1682 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write with ioepoch */
1683                                            /* ->mds if epoch opens or closes */
1684 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
1685 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
1686 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
1687 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
1688 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
1689
1690 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
1691 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
1692 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
1693 #define OBD_MD_TSTATE      (0x0000000800000000ULL) /* transient state field */
1694
1695 #define OBD_MD_FLXATTR       (0x0000001000000000ULL) /* xattr */
1696 #define OBD_MD_FLXATTRLS     (0x0000002000000000ULL) /* xattr list */
1697 #define OBD_MD_FLXATTRRM     (0x0000004000000000ULL) /* xattr remove */
1698 #define OBD_MD_FLACL         (0x0000008000000000ULL) /* ACL */
1699 #define OBD_MD_FLRMTPERM     (0x0000010000000000ULL) /* remote permission */
1700 #define OBD_MD_FLMDSCAPA     (0x0000020000000000ULL) /* MDS capability */
1701 #define OBD_MD_FLOSSCAPA     (0x0000040000000000ULL) /* OSS capability */
1702 #define OBD_MD_FLCKSPLIT     (0x0000080000000000ULL) /* Check split on server */
1703 #define OBD_MD_FLCROSSREF    (0x0000100000000000ULL) /* Cross-ref case */
1704 #define OBD_MD_FLGETATTRLOCK (0x0000200000000000ULL) /* Get IOEpoch attributes
1705                                                       * under lock; for xattr
1706                                                       * requests means the
1707                                                       * client holds the lock */
1708 #define OBD_MD_FLOBJCOUNT    (0x0000400000000000ULL) /* for multiple destroy */
1709
1710 #define OBD_MD_FLRMTLSETFACL (0x0001000000000000ULL) /* lfs lsetfacl case */
1711 #define OBD_MD_FLRMTLGETFACL (0x0002000000000000ULL) /* lfs lgetfacl case */
1712 #define OBD_MD_FLRMTRSETFACL (0x0004000000000000ULL) /* lfs rsetfacl case */
1713 #define OBD_MD_FLRMTRGETFACL (0x0008000000000000ULL) /* lfs rgetfacl case */
1714
1715 #define OBD_MD_FLDATAVERSION (0x0010000000000000ULL) /* iversion sum */
1716 #define OBD_MD_CLOSE_INTENT_EXECED (0x0020000000000000ULL) /* close intent
1717                                                               executed */
1718
1719 #define OBD_MD_DEFAULT_MEA   (0x0040000000000000ULL) /* default MEA */
1720
1721 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
1722                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
1723                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
1724                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
1725                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
1726
1727 #define OBD_MD_FLXATTRALL (OBD_MD_FLXATTR | OBD_MD_FLXATTRLS)
1728
1729 /* don't forget obdo_fid which is way down at the bottom so it can
1730  * come after the definition of llog_cookie */
1731
1732 enum hss_valid {
1733         HSS_SETMASK     = 0x01,
1734         HSS_CLEARMASK   = 0x02,
1735         HSS_ARCHIVE_ID  = 0x04,
1736 };
1737
1738 struct hsm_state_set {
1739         __u32   hss_valid;
1740         __u32   hss_archive_id;
1741         __u64   hss_setmask;
1742         __u64   hss_clearmask;
1743 };
1744
1745 /* ost_body.data values for OST_BRW */
1746
1747 #define OBD_BRW_READ            0x01
1748 #define OBD_BRW_WRITE           0x02
1749 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
1750 #define OBD_BRW_SYNC            0x08 /* this page is a part of synchronous
1751                                       * transfer and is not accounted in
1752                                       * the grant. */
1753 #define OBD_BRW_CHECK           0x10
1754 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
1755 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
1756 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
1757 #define OBD_BRW_NOQUOTA        0x100
1758 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
1759 #define OBD_BRW_ASYNC          0x400 /* Server may delay commit to disk */
1760 #define OBD_BRW_MEMALLOC       0x800 /* Client runs in the "kswapd" context */
1761 #define OBD_BRW_OVER_USRQUOTA 0x1000 /* Running out of user quota */
1762 #define OBD_BRW_OVER_GRPQUOTA 0x2000 /* Running out of group quota */
1763 #define OBD_BRW_SOFT_SYNC     0x4000 /* This flag notifies the server
1764                                       * that the client is running low on
1765                                       * space for unstable pages; asking
1766                                       * it to sync quickly */
1767
1768 #define OBD_OBJECT_EOF LUSTRE_EOF
1769
1770 #define OST_MIN_PRECREATE 32
1771 #define OST_MAX_PRECREATE 20000
1772
1773 struct obd_ioobj {
1774         struct ost_id   ioo_oid;        /* object ID, if multi-obj BRW */
1775         __u32           ioo_max_brw;    /* low 16 bits were o_mode before 2.4,
1776                                          * now (PTLRPC_BULK_OPS_COUNT - 1) in
1777                                          * high 16 bits in 2.4 and later */
1778         __u32           ioo_bufcnt;     /* number of niobufs for this object */
1779 };
1780
1781 #define IOOBJ_MAX_BRW_BITS      16
1782 #define IOOBJ_TYPE_MASK         ((1U << IOOBJ_MAX_BRW_BITS) - 1)
1783 #define ioobj_max_brw_get(ioo)  (((ioo)->ioo_max_brw >> IOOBJ_MAX_BRW_BITS) + 1)
1784 #define ioobj_max_brw_set(ioo, num)                                     \
1785 do { (ioo)->ioo_max_brw = ((num) - 1) << IOOBJ_MAX_BRW_BITS; } while (0)
1786
1787 /* multiple of 8 bytes => can array */
1788 struct niobuf_remote {
1789         __u64   rnb_offset;
1790         __u32   rnb_len;
1791         __u32   rnb_flags;
1792 };
1793
1794 /* lock value block communicated between the filter and llite */
1795
1796 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1797  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1798 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1799 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1800 #define OST_LVB_IS_ERR(blocks)                                          \
1801         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1802 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1803         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1804 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1805
1806 struct ost_lvb_v1 {
1807         __u64   lvb_size;
1808         __s64   lvb_mtime;
1809         __s64   lvb_atime;
1810         __s64   lvb_ctime;
1811         __u64   lvb_blocks;
1812 };
1813
1814 struct ost_lvb {
1815         __u64   lvb_size;
1816         __s64   lvb_mtime;
1817         __s64   lvb_atime;
1818         __s64   lvb_ctime;
1819         __u64   lvb_blocks;
1820         __u32   lvb_mtime_ns;
1821         __u32   lvb_atime_ns;
1822         __u32   lvb_ctime_ns;
1823         __u32   lvb_padding;
1824 };
1825
1826 /*
1827  *   lquota data structures
1828  */
1829
1830 #ifndef QUOTABLOCK_BITS
1831 # define QUOTABLOCK_BITS LUSTRE_QUOTABLOCK_BITS
1832 #endif
1833
1834 #ifndef QUOTABLOCK_SIZE
1835 # define QUOTABLOCK_SIZE LUSTRE_QUOTABLOCK_SIZE
1836 #endif
1837
1838 #ifndef toqb
1839 # define toqb lustre_stoqb
1840 #endif
1841
1842 /* The lquota_id structure is an union of all the possible identifier types that
1843  * can be used with quota, this includes:
1844  * - 64-bit user ID
1845  * - 64-bit group ID
1846  * - a FID which can be used for per-directory quota in the future */
1847 union lquota_id {
1848         struct lu_fid   qid_fid; /* FID for per-directory quota */
1849         __u64           qid_uid; /* user identifier */
1850         __u64           qid_gid; /* group identifier */
1851 };
1852
1853 /* quotactl management */
1854 struct obd_quotactl {
1855         __u32                   qc_cmd;
1856         __u32                   qc_type; /* see Q_* flag below */
1857         __u32                   qc_id;
1858         __u32                   qc_stat;
1859         struct obd_dqinfo       qc_dqinfo;
1860         struct obd_dqblk        qc_dqblk;
1861 };
1862
1863 #define Q_COPY(out, in, member) (out)->member = (in)->member
1864
1865 #define QCTL_COPY(out, in)              \
1866 do {                                    \
1867         Q_COPY(out, in, qc_cmd);        \
1868         Q_COPY(out, in, qc_type);       \
1869         Q_COPY(out, in, qc_id);         \
1870         Q_COPY(out, in, qc_stat);       \
1871         Q_COPY(out, in, qc_dqinfo);     \
1872         Q_COPY(out, in, qc_dqblk);      \
1873 } while (0)
1874
1875 /* Body of quota request used for quota acquire/release RPCs between quota
1876  * master (aka QMT) and slaves (ak QSD). */
1877 struct quota_body {
1878         struct lu_fid   qb_fid;     /* FID of global index packing the pool ID
1879                                       * and type (data or metadata) as well as
1880                                       * the quota type (user or group). */
1881         union lquota_id qb_id;      /* uid or gid or directory FID */
1882         __u32           qb_flags;   /* see below */
1883         __u32           qb_padding;
1884         __u64           qb_count;   /* acquire/release count (kbytes/inodes) */
1885         __u64           qb_usage;   /* current slave usage (kbytes/inodes) */
1886         __u64           qb_slv_ver; /* slave index file version */
1887         struct lustre_handle    qb_lockh;     /* per-ID lock handle */
1888         struct lustre_handle    qb_glb_lockh; /* global lock handle */
1889         __u64           qb_padding1[4];
1890 };
1891
1892 /* When the quota_body is used in the reply of quota global intent
1893  * lock (IT_QUOTA_CONN) reply, qb_fid contains slave index file FID. */
1894 #define qb_slv_fid      qb_fid
1895 /* qb_usage is the current qunit (in kbytes/inodes) when quota_body is used in
1896  * quota reply */
1897 #define qb_qunit        qb_usage
1898
1899 #define QUOTA_DQACQ_FL_ACQ      0x1  /* acquire quota */
1900 #define QUOTA_DQACQ_FL_PREACQ   0x2  /* pre-acquire */
1901 #define QUOTA_DQACQ_FL_REL      0x4  /* release quota */
1902 #define QUOTA_DQACQ_FL_REPORT   0x8  /* report usage */
1903
1904 /* Quota types currently supported */
1905 enum {
1906         LQUOTA_TYPE_USR = 0x00, /* maps to USRQUOTA */
1907         LQUOTA_TYPE_GRP = 0x01, /* maps to GRPQUOTA */
1908         LQUOTA_TYPE_MAX
1909 };
1910
1911 /* There are 2 different resource types on which a quota limit can be enforced:
1912  * - inodes on the MDTs
1913  * - blocks on the OSTs */
1914 enum {
1915         LQUOTA_RES_MD           = 0x01, /* skip 0 to avoid null oid in FID */
1916         LQUOTA_RES_DT           = 0x02,
1917         LQUOTA_LAST_RES,
1918         LQUOTA_FIRST_RES        = LQUOTA_RES_MD
1919 };
1920 #define LQUOTA_NR_RES (LQUOTA_LAST_RES - LQUOTA_FIRST_RES + 1)
1921
1922 /*
1923  * Space accounting support
1924  * Format of an accounting record, providing disk usage information for a given
1925  * user or group
1926  */
1927 struct lquota_acct_rec { /* 16 bytes */
1928         __u64 bspace;  /* current space in use */
1929         __u64 ispace;  /* current # inodes in use */
1930 };
1931
1932 /*
1933  * Global quota index support
1934  * Format of a global record, providing global quota settings for a given quota
1935  * identifier
1936  */
1937 struct lquota_glb_rec { /* 32 bytes */
1938         __u64 qbr_hardlimit; /* quota hard limit, in #inodes or kbytes */
1939         __u64 qbr_softlimit; /* quota soft limit, in #inodes or kbytes */
1940         __u64 qbr_time;      /* grace time, in seconds */
1941         __u64 qbr_granted;   /* how much is granted to slaves, in #inodes or
1942                               * kbytes */
1943 };
1944
1945 /*
1946  * Slave index support
1947  * Format of a slave record, recording how much space is granted to a given
1948  * slave
1949  */
1950 struct lquota_slv_rec { /* 8 bytes */
1951         __u64 qsr_granted; /* space granted to the slave for the key=ID,
1952                             * in #inodes or kbytes */
1953 };
1954
1955 /* Data structures associated with the quota locks */
1956
1957 /* Glimpse descriptor used for the index & per-ID quota locks */
1958 struct ldlm_gl_lquota_desc {
1959         union lquota_id gl_id;    /* quota ID subject to the glimpse */
1960         __u64           gl_flags; /* see LQUOTA_FL* below */
1961         __u64           gl_ver;   /* new index version */
1962         __u64           gl_hardlimit; /* new hardlimit or qunit value */
1963         __u64           gl_softlimit; /* new softlimit */
1964         __u64           gl_time;
1965         __u64           gl_pad2;
1966 };
1967 #define gl_qunit        gl_hardlimit /* current qunit value used when
1968                                       * glimpsing per-ID quota locks */
1969
1970 /* quota glimpse flags */
1971 #define LQUOTA_FL_EDQUOT 0x1 /* user/group out of quota space on QMT */
1972
1973 /* LVB used with quota (global and per-ID) locks */
1974 struct lquota_lvb {
1975         __u64   lvb_flags;      /* see LQUOTA_FL* above */
1976         __u64   lvb_id_may_rel; /* space that might be released later */
1977         __u64   lvb_id_rel;     /* space released by the slave for this ID */
1978         __u64   lvb_id_qunit;   /* current qunit value */
1979         __u64   lvb_pad1;
1980 };
1981
1982 /* LVB used with global quota lock */
1983 #define lvb_glb_ver  lvb_id_may_rel /* current version of the global index */
1984
1985 /* op codes */
1986 typedef enum {
1987         QUOTA_DQACQ     = 601,
1988         QUOTA_DQREL     = 602,
1989         QUOTA_LAST_OPC
1990 } quota_cmd_t;
1991 #define QUOTA_FIRST_OPC QUOTA_DQACQ
1992
1993 /*
1994  *   MDS REQ RECORDS
1995  */
1996
1997 /* opcodes */
1998 typedef enum {
1999         MDS_GETATTR             = 33,
2000         MDS_GETATTR_NAME        = 34,
2001         MDS_CLOSE               = 35,
2002         MDS_REINT               = 36,
2003         MDS_READPAGE            = 37,
2004         MDS_CONNECT             = 38,
2005         MDS_DISCONNECT          = 39,
2006         MDS_GETSTATUS           = 40,
2007         MDS_STATFS              = 41,
2008         MDS_PIN                 = 42, /* obsolete, never used in a release */
2009         MDS_UNPIN               = 43, /* obsolete, never used in a release */
2010         MDS_SYNC                = 44,
2011         MDS_DONE_WRITING        = 45, /* obsolete since 2.8.0 */
2012         MDS_SET_INFO            = 46,
2013         MDS_QUOTACHECK          = 47, /* not used since 2.4 */
2014         MDS_QUOTACTL            = 48,
2015         MDS_GETXATTR            = 49,
2016         MDS_SETXATTR            = 50, /* obsolete, now it's MDS_REINT op */
2017         MDS_WRITEPAGE           = 51,
2018         MDS_IS_SUBDIR           = 52, /* obsolete, never used in a release */
2019         MDS_GET_INFO            = 53,
2020         MDS_HSM_STATE_GET       = 54,
2021         MDS_HSM_STATE_SET       = 55,
2022         MDS_HSM_ACTION          = 56,
2023         MDS_HSM_PROGRESS        = 57,
2024         MDS_HSM_REQUEST         = 58,
2025         MDS_HSM_CT_REGISTER     = 59,
2026         MDS_HSM_CT_UNREGISTER   = 60,
2027         MDS_SWAP_LAYOUTS        = 61,
2028         MDS_LAST_OPC
2029 } mds_cmd_t;
2030
2031 #define MDS_FIRST_OPC    MDS_GETATTR
2032
2033
2034 /* opcodes for object update */
2035 typedef enum {
2036         OUT_UPDATE      = 1000,
2037         OUT_UPDATE_LAST_OPC
2038 } update_cmd_t;
2039
2040 #define OUT_UPDATE_FIRST_OPC    OUT_UPDATE
2041
2042 /*
2043  * Do not exceed 63
2044  */
2045
2046 typedef enum {
2047         REINT_SETATTR  = 1,
2048         REINT_CREATE   = 2,
2049         REINT_LINK     = 3,
2050         REINT_UNLINK   = 4,
2051         REINT_RENAME   = 5,
2052         REINT_OPEN     = 6,
2053         REINT_SETXATTR = 7,
2054         REINT_RMENTRY  = 8,
2055         REINT_MIGRATE  = 9,
2056         REINT_MAX
2057 } mds_reint_t, mdt_reint_t;
2058
2059 /* the disposition of the intent outlines what was executed */
2060 #define DISP_IT_EXECD        0x00000001
2061 #define DISP_LOOKUP_EXECD    0x00000002
2062 #define DISP_LOOKUP_NEG      0x00000004
2063 #define DISP_LOOKUP_POS      0x00000008
2064 #define DISP_OPEN_CREATE     0x00000010
2065 #define DISP_OPEN_OPEN       0x00000020
2066 #define DISP_ENQ_COMPLETE    0x00400000         /* obsolete and unused */
2067 #define DISP_ENQ_OPEN_REF    0x00800000
2068 #define DISP_ENQ_CREATE_REF  0x01000000
2069 #define DISP_OPEN_LOCK       0x02000000
2070 #define DISP_OPEN_LEASE      0x04000000
2071 #define DISP_OPEN_STRIPE     0x08000000
2072 #define DISP_OPEN_DENY       0x10000000
2073
2074 /* INODE LOCK PARTS */
2075 #define MDS_INODELOCK_LOOKUP 0x000001   /* For namespace, dentry etc, and also
2076                                          * was used to protect permission (mode,
2077                                          * owner, group etc) before 2.4. */
2078 #define MDS_INODELOCK_UPDATE 0x000002   /* size, links, timestamps */
2079 #define MDS_INODELOCK_OPEN   0x000004   /* For opened files */
2080 #define MDS_INODELOCK_LAYOUT 0x000008   /* for layout */
2081
2082 /* The PERM bit is added int 2.4, and it is used to protect permission(mode,
2083  * owner, group, acl etc), so to separate the permission from LOOKUP lock.
2084  * Because for remote directories(in DNE), these locks will be granted by
2085  * different MDTs(different ldlm namespace).
2086  *
2087  * For local directory, MDT will always grant UPDATE_LOCK|PERM_LOCK together.
2088  * For Remote directory, the master MDT, where the remote directory is, will
2089  * grant UPDATE_LOCK|PERM_LOCK, and the remote MDT, where the name entry is,
2090  * will grant LOOKUP_LOCK. */
2091 #define MDS_INODELOCK_PERM   0x000010
2092 #define MDS_INODELOCK_XATTR  0x000020   /* extended attributes */
2093
2094 #define MDS_INODELOCK_MAXSHIFT 5
2095 /* This FULL lock is useful to take on unlink sort of operations */
2096 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
2097
2098 /* NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
2099  * but was moved into name[1] along with the OID to avoid consuming the
2100  * name[2,3] fields that need to be used for the quota id (also a FID). */
2101 enum {
2102         LUSTRE_RES_ID_SEQ_OFF = 0,
2103         LUSTRE_RES_ID_VER_OID_OFF = 1,
2104         LUSTRE_RES_ID_WAS_VER_OFF = 2, /* see note above */
2105         LUSTRE_RES_ID_QUOTA_SEQ_OFF = 2,
2106         LUSTRE_RES_ID_QUOTA_VER_OID_OFF = 3,
2107         LUSTRE_RES_ID_HSH_OFF = 3
2108 };
2109
2110 #define MDS_STATUS_CONN 1
2111 #define MDS_STATUS_LOV 2
2112
2113 enum {
2114         /* these should be identical to their EXT4_*_FL counterparts, they are
2115          * redefined here only to avoid dragging in fs/ext4/ext4.h */
2116         LUSTRE_SYNC_FL = 0x00000008, /* Synchronous updates */
2117         LUSTRE_IMMUTABLE_FL = 0x00000010, /* Immutable file */
2118         LUSTRE_APPEND_FL = 0x00000020, /* writes to file may only append */
2119         LUSTRE_NODUMP_FL = 0x00000040, /* do not dump file */
2120         LUSTRE_NOATIME_FL = 0x00000080, /* do not update atime */
2121         LUSTRE_INDEX_FL = 0x00001000, /* hash-indexed directory */
2122         LUSTRE_DIRSYNC_FL = 0x00010000, /* dirsync behaviour (dir only) */
2123         LUSTRE_TOPDIR_FL = 0x00020000, /* Top of directory hierarchies*/
2124         LUSTRE_DIRECTIO_FL = 0x00100000, /* Use direct i/o */
2125         LUSTRE_INLINE_DATA_FL = 0x10000000, /* Inode has inline data. */
2126
2127         /* These flags will not be identical to any EXT4_*_FL counterparts,
2128          * and only reserved for lustre purpose. Note: these flags might
2129          * be conflict with some of EXT4 flags, so
2130          * 1. these conflict flags needs to be removed when the flag is
2131          * wired by la_flags see osd_attr_get().
2132          * 2. If these flags needs to be stored into inode, they will be
2133          * stored in LMA. see LMAI_XXXX */
2134         LUSTRE_ORPHAN_FL = 0x00002000,
2135
2136         LUSTRE_LMA_FL_MASKS = LUSTRE_ORPHAN_FL,
2137 };
2138
2139 /* LUSTRE_LMA_FL_MASKS defines which flags will be stored in LMA */
2140
2141 static inline int lma_to_lustre_flags(__u32 lma_flags)
2142 {
2143         return (lma_flags & LMAI_ORPHAN) ? LUSTRE_ORPHAN_FL : 0;
2144 }
2145
2146 static inline int lustre_to_lma_flags(__u32 la_flags)
2147 {
2148         return (la_flags & LUSTRE_ORPHAN_FL) ? LMAI_ORPHAN : 0;
2149 }
2150
2151
2152 #ifdef __KERNEL__
2153 /* Convert wire LUSTRE_*_FL to corresponding client local VFS S_* values
2154  * for the client inode i_flags.  The LUSTRE_*_FL are the Lustre wire
2155  * protocol equivalents of LDISKFS_*_FL values stored on disk, while
2156  * the S_* flags are kernel-internal values that change between kernel
2157  * versions.  These flags are set/cleared via FSFILT_IOC_{GET,SET}_FLAGS.
2158  * See b=16526 for a full history. */
2159 static inline int ll_ext_to_inode_flags(int flags)
2160 {
2161         return (((flags & LUSTRE_SYNC_FL)      ? S_SYNC      : 0) |
2162                 ((flags & LUSTRE_NOATIME_FL)   ? S_NOATIME   : 0) |
2163                 ((flags & LUSTRE_APPEND_FL)    ? S_APPEND    : 0) |
2164 #if defined(S_DIRSYNC)
2165                 ((flags & LUSTRE_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
2166 #endif
2167                 ((flags & LUSTRE_IMMUTABLE_FL) ? S_IMMUTABLE : 0));
2168 }
2169
2170 static inline int ll_inode_to_ext_flags(int iflags)
2171 {
2172         return (((iflags & S_SYNC)      ? LUSTRE_SYNC_FL      : 0) |
2173                 ((iflags & S_NOATIME)   ? LUSTRE_NOATIME_FL   : 0) |
2174                 ((iflags & S_APPEND)    ? LUSTRE_APPEND_FL    : 0) |
2175 #if defined(S_DIRSYNC)
2176                 ((iflags & S_DIRSYNC)   ? LUSTRE_DIRSYNC_FL   : 0) |
2177 #endif
2178                 ((iflags & S_IMMUTABLE) ? LUSTRE_IMMUTABLE_FL : 0));
2179 }
2180 #endif
2181
2182 /* 64 possible states */
2183 enum md_transient_state {
2184         MS_RESTORE      = (1 << 0),     /* restore is running */
2185 };
2186
2187 struct mdt_body {
2188         struct lu_fid mbo_fid1;
2189         struct lu_fid mbo_fid2;
2190         struct lustre_handle mbo_handle;
2191         __u64   mbo_valid;
2192         __u64   mbo_size; /* Offset, in the case of MDS_READPAGE */
2193         __s64   mbo_mtime;
2194         __s64   mbo_atime;
2195         __s64   mbo_ctime;
2196         __u64   mbo_blocks; /* XID, in the case of MDS_READPAGE */
2197         __u64   mbo_ioepoch;
2198         __u64   mbo_t_state; /* transient file state defined in
2199                               * enum md_transient_state
2200                               * was "ino" until 2.4.0 */
2201         __u32   mbo_fsuid;
2202         __u32   mbo_fsgid;
2203         __u32   mbo_capability;
2204         __u32   mbo_mode;
2205         __u32   mbo_uid;
2206         __u32   mbo_gid;
2207         __u32   mbo_flags;   /* LUSTRE_*_FL file attributes */
2208         __u32   mbo_rdev;
2209         __u32   mbo_nlink; /* #bytes to read in the case of MDS_READPAGE */
2210         __u32   mbo_unused2; /* was "generation" until 2.4.0 */
2211         __u32   mbo_suppgid;
2212         __u32   mbo_eadatasize;
2213         __u32   mbo_aclsize;
2214         __u32   mbo_max_mdsize;
2215         __u32   mbo_unused3; /* was max_cookiesize until 2.8 */
2216         __u32   mbo_uid_h; /* high 32-bits of uid, for FUID */
2217         __u32   mbo_gid_h; /* high 32-bits of gid, for FUID */
2218         __u32   mbo_padding_5; /* also fix lustre_swab_mdt_body */
2219         __u64   mbo_padding_6;
2220         __u64   mbo_padding_7;
2221         __u64   mbo_padding_8;
2222         __u64   mbo_padding_9;
2223         __u64   mbo_padding_10;
2224 }; /* 216 */
2225
2226 struct mdt_ioepoch {
2227         struct lustre_handle mio_handle;
2228         __u64 mio_unused1; /* was ioepoch */
2229         __u32 mio_unused2; /* was flags */
2230         __u32 mio_padding;
2231 };
2232
2233 /* permissions for md_perm.mp_perm */
2234 enum {
2235         CFS_SETUID_PERM = 0x01,
2236         CFS_SETGID_PERM = 0x02,
2237         CFS_SETGRP_PERM = 0x04,
2238         CFS_RMTACL_PERM = 0x08,
2239         CFS_RMTOWN_PERM = 0x10
2240 };
2241
2242 /* inode access permission for remote user, the inode info are omitted,
2243  * for client knows them. */
2244 struct mdt_remote_perm {
2245         __u32           rp_uid;
2246         __u32           rp_gid;
2247         __u32           rp_fsuid;
2248         __u32           rp_fsuid_h;
2249         __u32           rp_fsgid;
2250         __u32           rp_fsgid_h;
2251         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
2252         __u32           rp_padding;
2253 };
2254
2255 struct mdt_rec_setattr {
2256         __u32           sa_opcode;
2257         __u32           sa_cap;
2258         __u32           sa_fsuid;
2259         __u32           sa_fsuid_h;
2260         __u32           sa_fsgid;
2261         __u32           sa_fsgid_h;
2262         __u32           sa_suppgid;
2263         __u32           sa_suppgid_h;
2264         __u32           sa_padding_1;
2265         __u32           sa_padding_1_h;
2266         struct lu_fid   sa_fid;
2267         __u64           sa_valid;
2268         __u32           sa_uid;
2269         __u32           sa_gid;
2270         __u64           sa_size;
2271         __u64           sa_blocks;
2272         __s64           sa_mtime;
2273         __s64           sa_atime;
2274         __s64           sa_ctime;
2275         __u32           sa_attr_flags;
2276         __u32           sa_mode;
2277         __u32           sa_bias;      /* some operation flags */
2278         __u32           sa_padding_3;
2279         __u32           sa_padding_4;
2280         __u32           sa_padding_5;
2281 };
2282
2283 /*
2284  * Attribute flags used in mdt_rec_setattr::sa_valid.
2285  * The kernel's #defines for ATTR_* should not be used over the network
2286  * since the client and MDS may run different kernels (see bug 13828)
2287  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
2288  */
2289 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
2290 #define MDS_ATTR_UID           0x2ULL /* = 2 */
2291 #define MDS_ATTR_GID           0x4ULL /* = 4 */
2292 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
2293 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
2294 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
2295 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
2296 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
2297 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
2298 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
2299 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
2300 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
2301 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
2302 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
2303 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
2304 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
2305
2306 #ifndef FMODE_READ
2307 #define FMODE_READ               00000001
2308 #define FMODE_WRITE              00000002
2309 #endif
2310
2311 #define MDS_FMODE_CLOSED         00000000
2312 #define MDS_FMODE_EXEC           00000004
2313 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
2314 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
2315 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
2316
2317 #define MDS_OPEN_CREATED         00000010
2318 #define MDS_OPEN_CROSS           00000020
2319
2320 #define MDS_OPEN_CREAT           00000100
2321 #define MDS_OPEN_EXCL            00000200
2322 #define MDS_OPEN_TRUNC           00001000
2323 #define MDS_OPEN_APPEND          00002000
2324 #define MDS_OPEN_SYNC            00010000
2325 #define MDS_OPEN_DIRECTORY       00200000
2326
2327 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
2328 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
2329 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
2330 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
2331                                            * We do not support JOIN FILE
2332                                            * anymore, reserve this flags
2333                                            * just for preventing such bit
2334                                            * to be reused. */
2335
2336 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
2337 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
2338 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
2339 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
2340 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
2341                                               * hsm restore) */
2342 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
2343                                                 unlinked */
2344 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
2345                                               * delegation, succeed if it's not
2346                                               * being opened with conflict mode.
2347                                               */
2348 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
2349
2350 /* lustre internal open flags, which should not be set from user space */
2351 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
2352                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
2353                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
2354                               MDS_OPEN_RELEASE)
2355
2356 enum mds_op_bias {
2357         MDS_CHECK_SPLIT         = 1 << 0,
2358         MDS_CROSS_REF           = 1 << 1,
2359         MDS_VTX_BYPASS          = 1 << 2,
2360         MDS_PERM_BYPASS         = 1 << 3,
2361 /*      MDS_SOM                 = 1 << 4, obsolete since 2.8.0 */
2362         MDS_QUOTA_IGNORE        = 1 << 5,
2363         /* Was MDS_CLOSE_CLEANUP (1 << 6), No more used */
2364         MDS_KEEP_ORPHAN         = 1 << 7,
2365         MDS_RECOV_OPEN          = 1 << 8,
2366         MDS_DATA_MODIFIED       = 1 << 9,
2367         MDS_CREATE_VOLATILE     = 1 << 10,
2368         MDS_OWNEROVERRIDE       = 1 << 11,
2369         MDS_HSM_RELEASE         = 1 << 12,
2370         MDS_RENAME_MIGRATE      = 1 << 13,
2371         MDS_CLOSE_LAYOUT_SWAP   = 1 << 14,
2372 };
2373
2374 /* instance of mdt_reint_rec */
2375 struct mdt_rec_create {
2376         __u32           cr_opcode;
2377         __u32           cr_cap;
2378         __u32           cr_fsuid;
2379         __u32           cr_fsuid_h;
2380         __u32           cr_fsgid;
2381         __u32           cr_fsgid_h;
2382         __u32           cr_suppgid1;
2383         __u32           cr_suppgid1_h;
2384         __u32           cr_suppgid2;
2385         __u32           cr_suppgid2_h;
2386         struct lu_fid   cr_fid1;
2387         struct lu_fid   cr_fid2;
2388         struct lustre_handle cr_old_handle; /* handle in case of open replay */
2389         __s64           cr_time;
2390         __u64           cr_rdev;
2391         __u64           cr_ioepoch;
2392         __u64           cr_padding_1;   /* rr_blocks */
2393         __u32           cr_mode;
2394         __u32           cr_bias;
2395         /* use of helpers set/get_mrc_cr_flags() is needed to access
2396          * 64 bits cr_flags [cr_flags_l, cr_flags_h], this is done to
2397          * extend cr_flags size without breaking 1.8 compat */
2398         __u32           cr_flags_l;     /* for use with open, low  32 bits  */
2399         __u32           cr_flags_h;     /* for use with open, high 32 bits */
2400         __u32           cr_umask;       /* umask for create */
2401         __u32           cr_padding_4;   /* rr_padding_4 */
2402 };
2403
2404 static inline void set_mrc_cr_flags(struct mdt_rec_create *mrc, __u64 flags)
2405 {
2406         mrc->cr_flags_l = (__u32)(flags & 0xFFFFFFFFUll);
2407         mrc->cr_flags_h = (__u32)(flags >> 32);
2408 }
2409
2410 static inline __u64 get_mrc_cr_flags(struct mdt_rec_create *mrc)
2411 {
2412         return ((__u64)(mrc->cr_flags_l) | ((__u64)mrc->cr_flags_h << 32));
2413 }
2414
2415 /* instance of mdt_reint_rec */
2416 struct mdt_rec_link {
2417         __u32           lk_opcode;
2418         __u32           lk_cap;
2419         __u32           lk_fsuid;
2420         __u32           lk_fsuid_h;
2421         __u32           lk_fsgid;
2422         __u32           lk_fsgid_h;
2423         __u32           lk_suppgid1;
2424         __u32           lk_suppgid1_h;
2425         __u32           lk_suppgid2;
2426         __u32           lk_suppgid2_h;
2427         struct lu_fid   lk_fid1;
2428         struct lu_fid   lk_fid2;
2429         __s64           lk_time;
2430         __u64           lk_padding_1;   /* rr_atime */
2431         __u64           lk_padding_2;   /* rr_ctime */
2432         __u64           lk_padding_3;   /* rr_size */
2433         __u64           lk_padding_4;   /* rr_blocks */
2434         __u32           lk_bias;
2435         __u32           lk_padding_5;   /* rr_mode */
2436         __u32           lk_padding_6;   /* rr_flags */
2437         __u32           lk_padding_7;   /* rr_padding_2 */
2438         __u32           lk_padding_8;   /* rr_padding_3 */
2439         __u32           lk_padding_9;   /* rr_padding_4 */
2440 };
2441
2442 /* instance of mdt_reint_rec */
2443 struct mdt_rec_unlink {
2444         __u32           ul_opcode;
2445         __u32           ul_cap;
2446         __u32           ul_fsuid;
2447         __u32           ul_fsuid_h;
2448         __u32           ul_fsgid;
2449         __u32           ul_fsgid_h;
2450         __u32           ul_suppgid1;
2451         __u32           ul_suppgid1_h;
2452         __u32           ul_suppgid2;
2453         __u32           ul_suppgid2_h;
2454         struct lu_fid   ul_fid1;
2455         struct lu_fid   ul_fid2;
2456         __s64           ul_time;
2457         __u64           ul_padding_2;   /* rr_atime */
2458         __u64           ul_padding_3;   /* rr_ctime */
2459         __u64           ul_padding_4;   /* rr_size */
2460         __u64           ul_padding_5;   /* rr_blocks */
2461         __u32           ul_bias;
2462         __u32           ul_mode;
2463         __u32           ul_padding_6;   /* rr_flags */
2464         __u32           ul_padding_7;   /* rr_padding_2 */
2465         __u32           ul_padding_8;   /* rr_padding_3 */
2466         __u32           ul_padding_9;   /* rr_padding_4 */
2467 };
2468
2469 /* instance of mdt_reint_rec */
2470 struct mdt_rec_rename {
2471         __u32           rn_opcode;
2472         __u32           rn_cap;
2473         __u32           rn_fsuid;
2474         __u32           rn_fsuid_h;
2475         __u32           rn_fsgid;
2476         __u32           rn_fsgid_h;
2477         __u32           rn_suppgid1;
2478         __u32           rn_suppgid1_h;
2479         __u32           rn_suppgid2;
2480         __u32           rn_suppgid2_h;
2481         struct lu_fid   rn_fid1;
2482         struct lu_fid   rn_fid2;
2483         __s64           rn_time;
2484         __u64           rn_padding_1;   /* rr_atime */
2485         __u64           rn_padding_2;   /* rr_ctime */
2486         __u64           rn_padding_3;   /* rr_size */
2487         __u64           rn_padding_4;   /* rr_blocks */
2488         __u32           rn_bias;        /* some operation flags */
2489         __u32           rn_mode;        /* cross-ref rename has mode */
2490         __u32           rn_padding_5;   /* rr_flags */
2491         __u32           rn_padding_6;   /* rr_padding_2 */
2492         __u32           rn_padding_7;   /* rr_padding_3 */
2493         __u32           rn_padding_8;   /* rr_padding_4 */
2494 };
2495
2496 /* instance of mdt_reint_rec */
2497 struct mdt_rec_setxattr {
2498         __u32           sx_opcode;
2499         __u32           sx_cap;
2500         __u32           sx_fsuid;
2501         __u32           sx_fsuid_h;
2502         __u32           sx_fsgid;
2503         __u32           sx_fsgid_h;
2504         __u32           sx_suppgid1;
2505         __u32           sx_suppgid1_h;
2506         __u32           sx_suppgid2;
2507         __u32           sx_suppgid2_h;
2508         struct lu_fid   sx_fid;
2509         __u64           sx_padding_1;   /* These three are rr_fid2 */
2510         __u32           sx_padding_2;
2511         __u32           sx_padding_3;
2512         __u64           sx_valid;
2513         __s64           sx_time;
2514         __u64           sx_padding_5;   /* rr_ctime */
2515         __u64           sx_padding_6;   /* rr_size */
2516         __u64           sx_padding_7;   /* rr_blocks */
2517         __u32           sx_size;
2518         __u32           sx_flags;
2519         __u32           sx_padding_8;   /* rr_flags */
2520         __u32           sx_padding_9;   /* rr_padding_2 */
2521         __u32           sx_padding_10;  /* rr_padding_3 */
2522         __u32           sx_padding_11;  /* rr_padding_4 */
2523 };
2524
2525 /*
2526  * mdt_rec_reint is the template for all mdt_reint_xxx structures.
2527  * Do NOT change the size of various members, otherwise the value
2528  * will be broken in lustre_swab_mdt_rec_reint().
2529  *
2530  * If you add new members in other mdt_reint_xxx structres and need to use the
2531  * rr_padding_x fields, then update lustre_swab_mdt_rec_reint() also.
2532  */
2533 struct mdt_rec_reint {
2534         __u32           rr_opcode;
2535         __u32           rr_cap;
2536         __u32           rr_fsuid;
2537         __u32           rr_fsuid_h;
2538         __u32           rr_fsgid;
2539         __u32           rr_fsgid_h;
2540         __u32           rr_suppgid1;
2541         __u32           rr_suppgid1_h;
2542         __u32           rr_suppgid2;
2543         __u32           rr_suppgid2_h;
2544         struct lu_fid   rr_fid1;
2545         struct lu_fid   rr_fid2;
2546         __s64           rr_mtime;
2547         __s64           rr_atime;
2548         __s64           rr_ctime;
2549         __u64           rr_size;
2550         __u64           rr_blocks;
2551         __u32           rr_bias;
2552         __u32           rr_mode;
2553         __u32           rr_flags;
2554         __u32           rr_flags_h;
2555         __u32           rr_umask;
2556         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
2557 };
2558
2559 /* lmv structures */
2560 struct lmv_desc {
2561         __u32 ld_tgt_count;                /* how many MDS's */
2562         __u32 ld_active_tgt_count;         /* how many active */
2563         __u32 ld_default_stripe_count;     /* how many objects are used */
2564         __u32 ld_pattern;                  /* default hash pattern */
2565         __u64 ld_default_hash_size;
2566         __u64 ld_padding_1;                /* also fix lustre_swab_lmv_desc */
2567         __u32 ld_padding_2;                /* also fix lustre_swab_lmv_desc */
2568         __u32 ld_qos_maxage;               /* in second */
2569         __u32 ld_padding_3;                /* also fix lustre_swab_lmv_desc */
2570         __u32 ld_padding_4;                /* also fix lustre_swab_lmv_desc */
2571         struct obd_uuid ld_uuid;
2572 };
2573
2574 /* LMV layout EA, and it will be stored both in master and slave object */
2575 struct lmv_mds_md_v1 {
2576         __u32 lmv_magic;
2577         __u32 lmv_stripe_count;
2578         __u32 lmv_master_mdt_index;     /* On master object, it is master
2579                                          * MDT index, on slave object, it
2580                                          * is stripe index of the slave obj */
2581         __u32 lmv_hash_type;            /* dir stripe policy, i.e. indicate
2582                                          * which hash function to be used,
2583                                          * Note: only lower 16 bits is being
2584                                          * used for now. Higher 16 bits will
2585                                          * be used to mark the object status,
2586                                          * for example migrating or dead. */
2587         __u32 lmv_layout_version;       /* Used for directory restriping */
2588         __u32 lmv_padding1;
2589         __u64 lmv_padding2;
2590         __u64 lmv_padding3;
2591         char lmv_pool_name[LOV_MAXPOOLNAME + 1];        /* pool name */
2592         struct lu_fid lmv_stripe_fids[0];       /* FIDs for each stripe */
2593 };
2594
2595 #define LMV_MAGIC_V1    0x0CD20CD0    /* normal stripe lmv magic */
2596 #define LMV_MAGIC       LMV_MAGIC_V1
2597
2598 /* #define LMV_USER_MAGIC 0x0CD30CD0 */
2599 #define LMV_MAGIC_STRIPE 0x0CD40CD0 /* magic for dir sub_stripe */
2600
2601 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
2602  * and the higher part will be the flag to indicate the status of object,
2603  * for example the object is being migrated. And the hash function
2604  * might be interpreted differently with different flags. */
2605 #define LMV_HASH_TYPE_MASK 0x0000ffff
2606
2607 #define LMV_HASH_FLAG_MIGRATION 0x80000000
2608
2609 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 10, 53, 0)
2610 /* Since lustre 2.8, this flag will not be needed, instead this DEAD
2611  * and orphan flags will be stored in LMA (see LMAI_ORPHAN)
2612  * Keep this flag just for LFSCK, because it still might meet such
2613  * flag when it checks the old FS */
2614 #define LMV_HASH_FLAG_DEAD      0x40000000
2615 #endif
2616 #define LMV_HASH_FLAG_BAD_TYPE  0x20000000
2617
2618 /* The striped directory has ever lost its master LMV EA, then LFSCK
2619  * re-generated it. This flag is used to indicate such case. It is an
2620  * on-disk flag. */
2621 #define LMV_HASH_FLAG_LOST_LMV  0x10000000
2622
2623 /**
2624  * The FNV-1a hash algorithm is as follows:
2625  *      hash = FNV_offset_basis
2626  *      for each octet_of_data to be hashed
2627  *              hash = hash XOR octet_of_data
2628  *              hash = hash × FNV_prime
2629  *      return hash
2630  * http://en.wikipedia.org/wiki/Fowler–Noll–Vo_hash_function#FNV-1a_hash
2631  *
2632  * http://www.isthe.com/chongo/tech/comp/fnv/index.html#FNV-reference-source
2633  * FNV_prime is 2^40 + 2^8 + 0xb3 = 0x100000001b3ULL
2634  **/
2635 #define LUSTRE_FNV_1A_64_PRIME  0x100000001b3ULL
2636 #define LUSTRE_FNV_1A_64_OFFSET_BIAS 0xcbf29ce484222325ULL
2637 static inline __u64 lustre_hash_fnv_1a_64(const void *buf, size_t size)
2638 {
2639         __u64 hash = LUSTRE_FNV_1A_64_OFFSET_BIAS;
2640         const unsigned char *p = buf;
2641         size_t i;
2642
2643         for (i = 0; i < size; i++) {
2644                 hash ^= p[i];
2645                 hash *= LUSTRE_FNV_1A_64_PRIME;
2646         }
2647
2648         return hash;
2649 }
2650
2651 union lmv_mds_md {
2652         __u32                    lmv_magic;
2653         struct lmv_mds_md_v1     lmv_md_v1;
2654         struct lmv_user_md       lmv_user_md;
2655 };
2656
2657 static inline int lmv_mds_md_size(int stripe_count, unsigned int lmm_magic)
2658 {
2659         switch (lmm_magic) {
2660         case LMV_MAGIC_V1:{
2661                 struct lmv_mds_md_v1 *lmm1;
2662
2663                 return sizeof(*lmm1) + stripe_count *
2664                                        sizeof(lmm1->lmv_stripe_fids[0]);
2665         }
2666         default:
2667                 return -EINVAL;
2668         }
2669 }
2670
2671 static inline int lmv_mds_md_stripe_count_get(const union lmv_mds_md *lmm)
2672 {
2673         switch (le32_to_cpu(lmm->lmv_magic)) {
2674         case LMV_MAGIC_V1:
2675                 return le32_to_cpu(lmm->lmv_md_v1.lmv_stripe_count);
2676         case LMV_USER_MAGIC:
2677                 return le32_to_cpu(lmm->lmv_user_md.lum_stripe_count);
2678         default:
2679                 return -EINVAL;
2680         }
2681 }
2682
2683 static inline int lmv_mds_md_stripe_count_set(union lmv_mds_md *lmm,
2684                                               unsigned int stripe_count)
2685 {
2686         switch (le32_to_cpu(lmm->lmv_magic)) {
2687         case LMV_MAGIC_V1:
2688                 lmm->lmv_md_v1.lmv_stripe_count = cpu_to_le32(stripe_count);
2689                 break;
2690         case LMV_USER_MAGIC:
2691                 lmm->lmv_user_md.lum_stripe_count = cpu_to_le32(stripe_count);
2692                 break;
2693         default:
2694                 return -EINVAL;
2695         }
2696         return 0;
2697 }
2698
2699 enum fld_rpc_opc {
2700         FLD_QUERY       = 900,
2701         FLD_READ        = 901,
2702         FLD_LAST_OPC,
2703         FLD_FIRST_OPC   = FLD_QUERY
2704 };
2705
2706 enum seq_rpc_opc {
2707         SEQ_QUERY                       = 700,
2708         SEQ_LAST_OPC,
2709         SEQ_FIRST_OPC                   = SEQ_QUERY
2710 };
2711
2712 enum seq_op {
2713         SEQ_ALLOC_SUPER = 0,
2714         SEQ_ALLOC_META = 1
2715 };
2716
2717 enum fld_op {
2718         FLD_CREATE = 0,
2719         FLD_DELETE = 1,
2720         FLD_LOOKUP = 2,
2721 };
2722
2723 /* LFSCK opcodes */
2724 typedef enum {
2725         LFSCK_NOTIFY            = 1101,
2726         LFSCK_QUERY             = 1102,
2727         LFSCK_LAST_OPC,
2728         LFSCK_FIRST_OPC         = LFSCK_NOTIFY
2729 } lfsck_cmd_t;
2730
2731 /*
2732  *  LOV data structures
2733  */
2734
2735 #define LOV_MAX_UUID_BUFFER_SIZE  8192
2736 /* The size of the buffer the lov/mdc reserves for the
2737  * array of UUIDs returned by the MDS.  With the current
2738  * protocol, this will limit the max number of OSTs per LOV */
2739
2740 #define LOV_DESC_MAGIC 0xB0CCDE5C
2741 #define LOV_DESC_QOS_MAXAGE_DEFAULT 5  /* Seconds */
2742 #define LOV_DESC_STRIPE_SIZE_DEFAULT (1 << LNET_MTU_BITS)
2743
2744 /* LOV settings descriptor (should only contain static info) */
2745 struct lov_desc {
2746         __u32 ld_tgt_count;                /* how many OBD's */
2747         __u32 ld_active_tgt_count;         /* how many active */
2748         __u32 ld_default_stripe_count;     /* how many objects are used */
2749         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
2750         __u64 ld_default_stripe_size;      /* in bytes */
2751         __u64 ld_default_stripe_offset;    /* in bytes */
2752         __u32 ld_padding_0;                /* unused */
2753         __u32 ld_qos_maxage;               /* in second */
2754         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
2755         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
2756         struct obd_uuid ld_uuid;
2757 };
2758
2759 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
2760
2761 /*
2762  *   LDLM requests:
2763  */
2764 /* opcodes -- MUST be distinct from OST/MDS opcodes */
2765 typedef enum {
2766         LDLM_ENQUEUE     = 101,
2767         LDLM_CONVERT     = 102,
2768         LDLM_CANCEL      = 103,
2769         LDLM_BL_CALLBACK = 104,
2770         LDLM_CP_CALLBACK = 105,
2771         LDLM_GL_CALLBACK = 106,
2772         LDLM_SET_INFO    = 107,
2773         LDLM_LAST_OPC
2774 } ldlm_cmd_t;
2775 #define LDLM_FIRST_OPC LDLM_ENQUEUE
2776
2777 #define RES_NAME_SIZE 4
2778 struct ldlm_res_id {
2779         __u64 name[RES_NAME_SIZE];
2780 };
2781
2782 #define DLDLMRES        "[%#llx:%#llx:%#llx].%#llx"
2783 #define PLDLMRES(res)   (unsigned long long)(res)->lr_name.name[0],     \
2784                         (unsigned long long)(res)->lr_name.name[1],     \
2785                         (unsigned long long)(res)->lr_name.name[2],     \
2786                         (unsigned long long)(res)->lr_name.name[3]
2787
2788 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
2789                                const struct ldlm_res_id *res1)
2790 {
2791         return memcmp(res0, res1, sizeof(*res0)) == 0;
2792 }
2793
2794 /* lock types */
2795 typedef enum ldlm_mode {
2796         LCK_MINMODE     = 0,
2797         LCK_EX          = 1,
2798         LCK_PW          = 2,
2799         LCK_PR          = 4,
2800         LCK_CW          = 8,
2801         LCK_CR          = 16,
2802         LCK_NL          = 32,
2803         LCK_GROUP       = 64,
2804         LCK_COS         = 128,
2805         LCK_MAXMODE
2806 } ldlm_mode_t;
2807
2808 #define LCK_MODE_NUM    8
2809
2810 typedef enum ldlm_type {
2811         LDLM_PLAIN      = 10,
2812         LDLM_EXTENT     = 11,
2813         LDLM_FLOCK      = 12,
2814         LDLM_IBITS      = 13,
2815         LDLM_MAX_TYPE
2816 } ldlm_type_t;
2817
2818 #define LDLM_MIN_TYPE LDLM_PLAIN
2819
2820 struct ldlm_extent {
2821         __u64 start;
2822         __u64 end;
2823         __u64 gid;
2824 };
2825
2826 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
2827                                       const struct ldlm_extent *ex2)
2828 {
2829         return ex1->start <= ex2->end && ex2->start <= ex1->end;
2830 }
2831
2832 /* check if @ex1 contains @ex2 */
2833 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
2834                                       const struct ldlm_extent *ex2)
2835 {
2836         return ex1->start <= ex2->start && ex1->end >= ex2->end;
2837 }
2838
2839 struct ldlm_inodebits {
2840         __u64 bits;
2841 };
2842
2843 struct ldlm_flock_wire {
2844         __u64 lfw_start;
2845         __u64 lfw_end;
2846         __u64 lfw_owner;
2847         __u32 lfw_padding;
2848         __u32 lfw_pid;
2849 };
2850
2851 /* it's important that the fields of the ldlm_extent structure match
2852  * the first fields of the ldlm_flock structure because there is only
2853  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
2854  * this ever changes we will need to swab the union differently based
2855  * on the resource type. */
2856
2857 typedef union ldlm_wire_policy_data {
2858         struct ldlm_extent      l_extent;
2859         struct ldlm_flock_wire  l_flock;
2860         struct ldlm_inodebits   l_inodebits;
2861 } ldlm_wire_policy_data_t;
2862
2863 union ldlm_gl_desc {
2864         struct ldlm_gl_lquota_desc      lquota_desc;
2865 };
2866
2867 enum ldlm_intent_flags {
2868         IT_OPEN        = 0x00000001,
2869         IT_CREAT       = 0x00000002,
2870         IT_OPEN_CREAT  = 0x00000003,
2871         IT_READDIR     = 0x00000004,
2872         IT_GETATTR     = 0x00000008,
2873         IT_LOOKUP      = 0x00000010,
2874         IT_UNLINK      = 0x00000020,
2875         IT_TRUNC       = 0x00000040,
2876         IT_GETXATTR    = 0x00000080,
2877         IT_EXEC        = 0x00000100,
2878         IT_PIN         = 0x00000200,
2879         IT_LAYOUT      = 0x00000400,
2880         IT_QUOTA_DQACQ = 0x00000800,
2881         IT_QUOTA_CONN  = 0x00001000,
2882         IT_SETXATTR    = 0x00002000,
2883 };
2884
2885 struct ldlm_intent {
2886         __u64 opc;
2887 };
2888
2889 struct ldlm_resource_desc {
2890         enum ldlm_type     lr_type;
2891         __u32              lr_pad; /* also fix lustre_swab_ldlm_resource_desc */
2892         struct ldlm_res_id lr_name;
2893 };
2894
2895 struct ldlm_lock_desc {
2896         struct ldlm_resource_desc l_resource;
2897         enum ldlm_mode l_req_mode;
2898         enum ldlm_mode l_granted_mode;
2899         union ldlm_wire_policy_data l_policy_data;
2900 };
2901
2902 #define LDLM_LOCKREQ_HANDLES 2
2903 #define LDLM_ENQUEUE_CANCEL_OFF 1
2904
2905 struct ldlm_request {
2906         __u32 lock_flags;
2907         __u32 lock_count;
2908         struct ldlm_lock_desc lock_desc;
2909         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
2910 };
2911
2912 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
2913  * Otherwise, 2 are available. */
2914 #define ldlm_request_bufsize(count,type)                                \
2915 ({                                                                      \
2916         int _avail = LDLM_LOCKREQ_HANDLES;                              \
2917         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
2918         sizeof(struct ldlm_request) +                                   \
2919         (count > _avail ? count - _avail : 0) *                         \
2920         sizeof(struct lustre_handle);                                   \
2921 })
2922
2923 struct ldlm_reply {
2924         __u32 lock_flags;
2925         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
2926         struct ldlm_lock_desc lock_desc;
2927         struct lustre_handle lock_handle;
2928         __u64  lock_policy_res1;
2929         __u64  lock_policy_res2;
2930 };
2931
2932 #define ldlm_flags_to_wire(flags)    ((__u32)(flags))
2933 #define ldlm_flags_from_wire(flags)  ((__u64)(flags))
2934
2935 /*
2936  * Opcodes for mountconf (mgs and mgc)
2937  */
2938 typedef enum {
2939         MGS_CONNECT = 250,
2940         MGS_DISCONNECT,
2941         MGS_EXCEPTION,         /* node died, etc. */
2942         MGS_TARGET_REG,        /* whenever target starts up */
2943         MGS_TARGET_DEL,
2944         MGS_SET_INFO,
2945         MGS_CONFIG_READ,
2946         MGS_LAST_OPC
2947 } mgs_cmd_t;
2948 #define MGS_FIRST_OPC MGS_CONNECT
2949
2950 #define MGS_PARAM_MAXLEN 1024
2951 #define KEY_SET_INFO "set_info"
2952
2953 struct mgs_send_param {
2954         char             mgs_param[MGS_PARAM_MAXLEN];
2955 };
2956
2957 /* We pass this info to the MGS so it can write config logs */
2958 #define MTI_NAME_MAXLEN  64
2959 #define MTI_PARAM_MAXLEN 4096
2960 #define MTI_NIDS_MAX     32
2961 struct mgs_target_info {
2962         __u32            mti_lustre_ver;
2963         __u32            mti_stripe_index;
2964         __u32            mti_config_ver;
2965         __u32            mti_flags;
2966         __u32            mti_nid_count;
2967         __u32            mti_instance; /* Running instance of target */
2968         char             mti_fsname[MTI_NAME_MAXLEN];
2969         char             mti_svname[MTI_NAME_MAXLEN];
2970         char             mti_uuid[sizeof(struct obd_uuid)];
2971         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
2972         char             mti_params[MTI_PARAM_MAXLEN];
2973 };
2974
2975 struct mgs_nidtbl_entry {
2976         __u64           mne_version;    /* table version of this entry */
2977         __u32           mne_instance;   /* target instance # */
2978         __u32           mne_index;      /* target index */
2979         __u32           mne_length;     /* length of this entry - by bytes */
2980         __u8            mne_type;       /* target type LDD_F_SV_TYPE_OST/MDT */
2981         __u8            mne_nid_type;   /* type of nid(mbz). for ipv6. */
2982         __u8            mne_nid_size;   /* size of each NID, by bytes */
2983         __u8            mne_nid_count;  /* # of NIDs in buffer */
2984         union {
2985                 lnet_nid_t nids[0];     /* variable size buffer for NIDs. */
2986         } u;
2987 };
2988
2989 struct mgs_config_body {
2990         char     mcb_name[MTI_NAME_MAXLEN]; /* logname */
2991         __u64    mcb_offset;    /* next index of config log to request */
2992         __u16    mcb_type;      /* type of log: CONFIG_T_[CONFIG|RECOVER] */
2993         __u8     mcb_reserved;
2994         __u8     mcb_bits;      /* bits unit size of config log */
2995         __u32    mcb_units;     /* # of units for bulk transfer */
2996 };
2997
2998 struct mgs_config_res {
2999         __u64    mcr_offset;    /* index of last config log */
3000         __u64    mcr_size;      /* size of the log */
3001 };
3002
3003 /* Config marker flags (in config log) */
3004 #define CM_START       0x01
3005 #define CM_END         0x02
3006 #define CM_SKIP        0x04
3007 #define CM_UPGRADE146  0x08
3008 #define CM_EXCLUDE     0x10
3009 #define CM_START_SKIP (CM_START | CM_SKIP)
3010
3011 struct cfg_marker {
3012         __u32   cm_step;       /* aka config version */
3013         __u32   cm_flags;
3014         __u32   cm_vers;       /* lustre release version number */
3015         __u32   cm_padding;    /* 64 bit align */
3016         __s64   cm_createtime; /*when this record was first created */
3017         __s64   cm_canceltime; /*when this record is no longer valid*/
3018         char    cm_tgtname[MTI_NAME_MAXLEN];
3019         char    cm_comment[MTI_NAME_MAXLEN];
3020 };
3021
3022 /*
3023  * Opcodes for multiple servers.
3024  */
3025
3026 typedef enum {
3027         OBD_PING = 400,
3028         OBD_LOG_CANCEL,
3029         OBD_QC_CALLBACK, /* not used since 2.4 */
3030         OBD_IDX_READ,
3031         OBD_LAST_OPC
3032 } obd_cmd_t;
3033 #define OBD_FIRST_OPC OBD_PING
3034
3035 /**
3036  * llog contexts indices.
3037  *
3038  * There is compatibility problem with indexes below, they are not
3039  * continuous and must keep their numbers for compatibility needs.
3040  * See LU-5218 for details.
3041  */
3042 enum llog_ctxt_id {
3043         LLOG_CONFIG_ORIG_CTXT  =  0,
3044         LLOG_CONFIG_REPL_CTXT = 1,
3045         LLOG_MDS_OST_ORIG_CTXT = 2,
3046         LLOG_MDS_OST_REPL_CTXT = 3, /* kept just to avoid re-assignment */
3047         LLOG_SIZE_ORIG_CTXT = 4,
3048         LLOG_SIZE_REPL_CTXT = 5,
3049         LLOG_TEST_ORIG_CTXT = 8,
3050         LLOG_TEST_REPL_CTXT = 9, /* kept just to avoid re-assignment */
3051         LLOG_CHANGELOG_ORIG_CTXT = 12, /**< changelog generation on mdd */
3052         LLOG_CHANGELOG_REPL_CTXT = 13, /**< changelog access on clients */
3053         /* for multiple changelog consumers */
3054         LLOG_CHANGELOG_USER_ORIG_CTXT = 14,
3055         LLOG_AGENT_ORIG_CTXT = 15, /**< agent requests generation on cdt */
3056         LLOG_UPDATELOG_ORIG_CTXT = 16, /* update log */
3057         LLOG_UPDATELOG_REPL_CTXT = 17, /* update log */
3058         LLOG_MAX_CTXTS
3059 };
3060
3061 /** Identifier for a single log object */
3062 struct llog_logid {
3063         struct ost_id           lgl_oi;
3064         __u32                   lgl_ogen;
3065 } __attribute__((packed));
3066
3067 /** Records written to the CATALOGS list */
3068 #define CATLIST "CATALOGS"
3069 struct llog_catid {
3070         struct llog_logid       lci_logid;
3071         __u32                   lci_padding1;
3072         __u32                   lci_padding2;
3073         __u32                   lci_padding3;
3074 } __attribute__((packed));
3075
3076 /* Log data record types - there is no specific reason that these need to
3077  * be related to the RPC opcodes, but no reason not to (may be handy later?)
3078  */
3079 #define LLOG_OP_MAGIC 0x10600000
3080 #define LLOG_OP_MASK  0xfff00000
3081
3082 typedef enum {
3083         LLOG_PAD_MAGIC          = LLOG_OP_MAGIC | 0x00000,
3084         OST_SZ_REC              = LLOG_OP_MAGIC | 0x00f00,
3085         /* OST_RAID1_REC        = LLOG_OP_MAGIC | 0x01000, never used */
3086         MDS_UNLINK_REC          = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) |
3087                                   REINT_UNLINK, /* obsolete after 2.5.0 */
3088         MDS_UNLINK64_REC        = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3089                                   REINT_UNLINK,
3090         /* MDS_SETATTR_REC      = LLOG_OP_MAGIC | 0x12401, obsolete 1.8.0 */
3091         MDS_SETATTR64_REC       = LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) |
3092                                   REINT_SETATTR,
3093         OBD_CFG_REC             = LLOG_OP_MAGIC | 0x20000,
3094         /* PTL_CFG_REC          = LLOG_OP_MAGIC | 0x30000, obsolete 1.4.0 */
3095         LLOG_GEN_REC            = LLOG_OP_MAGIC | 0x40000,
3096         /* LLOG_JOIN_REC        = LLOG_OP_MAGIC | 0x50000, obsolete  1.8.0 */
3097         CHANGELOG_REC           = LLOG_OP_MAGIC | 0x60000,
3098         CHANGELOG_USER_REC      = LLOG_OP_MAGIC | 0x70000,
3099         HSM_AGENT_REC           = LLOG_OP_MAGIC | 0x80000,
3100         UPDATE_REC              = LLOG_OP_MAGIC | 0xa0000,
3101         LLOG_HDR_MAGIC          = LLOG_OP_MAGIC | 0x45539,
3102         LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
3103 } llog_op_type;
3104
3105 #define LLOG_REC_HDR_NEEDS_SWABBING(r) \
3106         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) == __swab32(LLOG_OP_MAGIC))
3107
3108 /** Log record header - stored in little endian order.
3109  * Each record must start with this struct, end with a llog_rec_tail,
3110  * and be a multiple of 256 bits in size.
3111  */
3112 struct llog_rec_hdr {
3113         __u32   lrh_len;
3114         __u32   lrh_index;
3115         __u32   lrh_type;
3116         __u32   lrh_id;
3117 };
3118
3119 struct llog_rec_tail {
3120         __u32   lrt_len;
3121         __u32   lrt_index;
3122 };
3123
3124 /* Where data follow just after header */
3125 #define REC_DATA(ptr)                                           \
3126         ((void *)((char *)ptr + sizeof(struct llog_rec_hdr)))
3127
3128 #define REC_DATA_LEN(rec)                                       \
3129         (rec->lrh_len - sizeof(struct llog_rec_hdr) -           \
3130          sizeof(struct llog_rec_tail))
3131
3132 static inline void *rec_tail(struct llog_rec_hdr *rec)
3133 {
3134         return (void *)((char *)rec + rec->lrh_len -
3135                         sizeof(struct llog_rec_tail));
3136 }
3137
3138 struct llog_logid_rec {
3139         struct llog_rec_hdr     lid_hdr;
3140         struct llog_logid       lid_id;
3141         __u32                   lid_padding1;
3142         __u64                   lid_padding2;
3143         __u64                   lid_padding3;
3144         struct llog_rec_tail    lid_tail;
3145 } __attribute__((packed));
3146
3147 struct llog_unlink_rec {
3148         struct llog_rec_hdr     lur_hdr;
3149         __u64                   lur_oid;
3150         __u32                   lur_oseq;
3151         __u32                   lur_count;
3152         struct llog_rec_tail    lur_tail;
3153 } __attribute__((packed));
3154
3155 struct llog_unlink64_rec {
3156         struct llog_rec_hdr     lur_hdr;
3157         struct lu_fid           lur_fid;
3158         __u32                   lur_count; /* to destroy the lost precreated */
3159         __u32                   lur_padding1;
3160         __u64                   lur_padding2;
3161         __u64                   lur_padding3;
3162         struct llog_rec_tail    lur_tail;
3163 } __attribute__((packed));
3164
3165 struct llog_setattr64_rec {
3166         struct llog_rec_hdr     lsr_hdr;
3167         struct ost_id           lsr_oi;
3168         __u32                   lsr_uid;
3169         __u32                   lsr_uid_h;
3170         __u32                   lsr_gid;
3171         __u32                   lsr_gid_h;
3172         __u64                   lsr_valid;
3173         struct llog_rec_tail    lsr_tail;
3174 } __attribute__((packed));
3175
3176 struct llog_size_change_rec {
3177         struct llog_rec_hdr     lsc_hdr;
3178         struct ll_fid           lsc_fid;
3179         __u32                   lsc_ioepoch;
3180         __u32                   lsc_padding1;
3181         __u64                   lsc_padding2;
3182         __u64                   lsc_padding3;
3183         struct llog_rec_tail    lsc_tail;
3184 } __attribute__((packed));
3185
3186 #define CHANGELOG_MAGIC 0xca103000
3187
3188 /** \a changelog_rec_type's that can't be masked */
3189 #define CHANGELOG_MINMASK (1 << CL_MARK)
3190 /** bits covering all \a changelog_rec_type's */
3191 #define CHANGELOG_ALLMASK 0XFFFFFFFF
3192 /** default \a changelog_rec_type mask. Allow all of them, except
3193  * CL_ATIME since it can really be time consuming, and not necessary
3194  * under normal use. */
3195 #define CHANGELOG_DEFMASK (CHANGELOG_ALLMASK & ~(1 << CL_ATIME))
3196
3197 /* changelog llog name, needed by client replicators */
3198 #define CHANGELOG_CATALOG "changelog_catalog"
3199
3200 struct changelog_setinfo {
3201         __u64 cs_recno;
3202         __u32 cs_id;
3203 } __attribute__((packed));
3204
3205 /** changelog record */
3206 struct llog_changelog_rec {
3207         struct llog_rec_hdr  cr_hdr;
3208         struct changelog_rec cr; /**< Variable length field */
3209         struct llog_rec_tail cr_do_not_use; /**< for_sizeof_only */
3210 } __attribute__((packed));
3211
3212 #define CHANGELOG_USER_PREFIX "cl"
3213
3214 struct llog_changelog_user_rec {
3215         struct llog_rec_hdr   cur_hdr;
3216         __u32                 cur_id;
3217         __u32                 cur_padding;
3218         __u64                 cur_endrec;
3219         struct llog_rec_tail  cur_tail;
3220 } __attribute__((packed));
3221
3222 enum agent_req_status {
3223         ARS_WAITING,
3224         ARS_STARTED,
3225         ARS_FAILED,
3226         ARS_CANCELED,
3227         ARS_SUCCEED,
3228 };
3229
3230 static inline const char *agent_req_status2name(enum agent_req_status ars)
3231 {
3232         switch (ars) {
3233         case ARS_WAITING:
3234                 return "WAITING";
3235         case ARS_STARTED:
3236                 return "STARTED";
3237         case ARS_FAILED:
3238                 return "FAILED";
3239         case ARS_CANCELED:
3240                 return "CANCELED";
3241         case ARS_SUCCEED:
3242                 return "SUCCEED";
3243         default:
3244                 return "UNKNOWN";
3245         }
3246 }
3247
3248 static inline bool agent_req_in_final_state(enum agent_req_status ars)
3249 {
3250         return ((ars == ARS_SUCCEED) || (ars == ARS_FAILED) ||
3251                 (ars == ARS_CANCELED));
3252 }
3253
3254 struct llog_agent_req_rec {
3255         struct llog_rec_hdr     arr_hdr;        /**< record header */
3256         __u32                   arr_status;     /**< status of the request */
3257                                                 /* must match enum
3258                                                  * agent_req_status */
3259         __u32                   arr_archive_id; /**< backend archive number */
3260         __u64                   arr_flags;      /**< req flags */
3261         __u64                   arr_compound_id;        /**< compound cookie */
3262         __u64                   arr_req_create; /**< req. creation time */
3263         __u64                   arr_req_change; /**< req. status change time */
3264         struct hsm_action_item  arr_hai;        /**< req. to the agent */
3265         struct llog_rec_tail    arr_tail; /**< record tail for_sizezof_only */
3266 } __attribute__((packed));
3267
3268 /* Old llog gen for compatibility */
3269 struct llog_gen {
3270         __u64 mnt_cnt;
3271         __u64 conn_cnt;
3272 } __attribute__((packed));
3273
3274 struct llog_gen_rec {
3275         struct llog_rec_hdr     lgr_hdr;
3276         struct llog_gen         lgr_gen;
3277         __u64                   padding1;
3278         __u64                   padding2;
3279         __u64                   padding3;
3280         struct llog_rec_tail    lgr_tail;
3281 };
3282
3283 /* flags for the logs */
3284 enum llog_flag {
3285         LLOG_F_ZAP_WHEN_EMPTY   = 0x1,
3286         LLOG_F_IS_CAT           = 0x2,
3287         LLOG_F_IS_PLAIN         = 0x4,
3288         LLOG_F_EXT_JOBID        = 0x8,
3289         LLOG_F_IS_FIXSIZE       = 0x10,
3290
3291         /* Note: Flags covered by LLOG_F_EXT_MASK will be inherited from
3292          * catlog to plain log, so do not add LLOG_F_IS_FIXSIZE here,
3293          * because the catlog record is usually fixed size, but its plain
3294          * log record can be variable */
3295         LLOG_F_EXT_MASK = LLOG_F_EXT_JOBID,
3296 };
3297
3298 /* On-disk header structure of each log object, stored in little endian order */
3299 #define LLOG_MIN_CHUNK_SIZE     8192
3300 #define LLOG_HEADER_SIZE        (96) /* sizeof (llog_log_hdr) + sizeof(llh_tail)
3301                                       * - sizeof(llh_bitmap) */
3302 #define LLOG_BITMAP_BYTES       (LLOG_MIN_CHUNK_SIZE - LLOG_HEADER_SIZE)
3303 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
3304
3305 struct llog_log_hdr {
3306         struct llog_rec_hdr     llh_hdr;
3307         __s64                   llh_timestamp;
3308         __u32                   llh_count;
3309         __u32                   llh_bitmap_offset;
3310         __u32                   llh_size;
3311         __u32                   llh_flags;
3312         /* for a catalog the first/oldest and still in-use plain slot is just
3313          * next to it. It will serve as the upper limit after Catalog has
3314          * wrapped around */
3315         __u32                   llh_cat_idx;
3316         struct obd_uuid         llh_tgtuuid;
3317         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32)-23];
3318         /* These fields must always be at the end of the llog_log_hdr.
3319          * Note: llh_bitmap size is variable because llog chunk size could be
3320          * bigger than LLOG_MIN_CHUNK_SIZE, i.e. sizeof(llog_log_hdr) > 8192
3321          * bytes, and the real size is stored in llh_hdr.lrh_len, which means
3322          * llh_tail should only be refered by LLOG_HDR_TAIL().
3323          * But this structure is also used by client/server llog interface
3324          * (see llog_client.c), it will be kept in its original way to avoid
3325          * compatiblity issue. */
3326         __u32                   llh_bitmap[LLOG_BITMAP_BYTES / sizeof(__u32)];
3327         struct llog_rec_tail    llh_tail;
3328 } __attribute__((packed));
3329 #undef LLOG_HEADER_SIZE
3330 #undef LLOG_BITMAP_BYTES
3331
3332 #define LLOG_HDR_BITMAP_SIZE(llh)       (__u32)((llh->llh_hdr.lrh_len - \
3333                                          llh->llh_bitmap_offset -       \
3334                                          sizeof(llh->llh_tail)) * 8)
3335 #define LLOG_HDR_BITMAP(llh)    (__u32 *)((char *)(llh) +               \
3336                                           (llh)->llh_bitmap_offset)
3337 #define LLOG_HDR_TAIL(llh)      ((struct llog_rec_tail *)((char *)llh + \
3338                                                  llh->llh_hdr.lrh_len - \
3339                                                  sizeof(llh->llh_tail)))
3340
3341 /** log cookies are used to reference a specific log file and a record therein */
3342 struct llog_cookie {
3343         struct llog_logid       lgc_lgl;
3344         __u32                   lgc_subsys;
3345         __u32                   lgc_index;
3346         __u32                   lgc_padding;
3347 } __attribute__((packed));
3348
3349 /** llog protocol */
3350 enum llogd_rpc_ops {
3351         LLOG_ORIGIN_HANDLE_CREATE       = 501,
3352         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
3353         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
3354         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
3355         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
3356         LLOG_ORIGIN_CONNECT             = 506,
3357         LLOG_CATINFO                    = 507,  /* deprecated */
3358         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
3359         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
3360         LLOG_LAST_OPC,
3361         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
3362 };
3363
3364 struct llogd_body {
3365         struct llog_logid  lgd_logid;
3366         __u32 lgd_ctxt_idx;
3367         __u32 lgd_llh_flags;
3368         __u32 lgd_index;
3369         __u32 lgd_saved_index;
3370         __u32 lgd_len;
3371         __u64 lgd_cur_offset;
3372 } __attribute__((packed));
3373
3374 struct llogd_conn_body {
3375         struct llog_gen         lgdc_gen;
3376         struct llog_logid       lgdc_logid;
3377         __u32                   lgdc_ctxt_idx;
3378 } __attribute__((packed));
3379
3380 /* Note: 64-bit types are 64-bit aligned in structure */
3381 struct obdo {
3382         __u64                   o_valid;        /* hot fields in this obdo */
3383         struct ost_id           o_oi;
3384         __u64                   o_parent_seq;
3385         __u64                   o_size;         /* o_size-o_blocks == ost_lvb */
3386         __s64                   o_mtime;
3387         __s64                   o_atime;
3388         __s64                   o_ctime;
3389         __u64                   o_blocks;       /* brw: cli sent cached bytes */
3390         __u64                   o_grant;
3391
3392         /* 32-bit fields start here: keep an even number of them via padding */
3393         __u32                   o_blksize;      /* optimal IO blocksize */
3394         __u32                   o_mode;         /* brw: cli sent cache remain */
3395         __u32                   o_uid;
3396         __u32                   o_gid;
3397         __u32                   o_flags;
3398         __u32                   o_nlink;        /* brw: checksum */
3399         __u32                   o_parent_oid;
3400         __u32                   o_misc;         /* brw: o_dropped */
3401
3402         __u64                   o_ioepoch;      /* epoch in ost writes */
3403         __u32                   o_stripe_idx;   /* holds stripe idx */
3404         __u32                   o_parent_ver;
3405         struct lustre_handle    o_handle;       /* brw: lock handle to prolong
3406                                                  * locks */
3407         struct llog_cookie      o_lcookie;      /* destroy: unlink cookie from
3408                                                  * MDS, obsolete in 2.8, reused
3409                                                  * in OSP */
3410         __u32                   o_uid_h;
3411         __u32                   o_gid_h;
3412
3413         __u64                   o_data_version; /* getattr: sum of iversion for
3414                                                  * each stripe.
3415                                                  * brw: grant space consumed on
3416                                                  * the client for the write */
3417         __u64                   o_padding_4;
3418         __u64                   o_padding_5;
3419         __u64                   o_padding_6;
3420 };
3421
3422 #define o_dirty   o_blocks
3423 #define o_undirty o_mode
3424 #define o_dropped o_misc
3425 #define o_cksum   o_nlink
3426 #define o_grant_used o_data_version
3427
3428 struct lfsck_request {
3429         __u32           lr_event;
3430         __u32           lr_index;
3431         __u32           lr_flags;
3432         __u32           lr_valid;
3433         union {
3434                 __u32   lr_speed;
3435                 __u32   lr_status;
3436                 __u32   lr_type;
3437         };
3438         __u16           lr_version;
3439         __u16           lr_active;
3440         __u16           lr_param;
3441         __u16           lr_async_windows;
3442         __u32           lr_flags2;
3443         struct lu_fid   lr_fid;
3444         struct lu_fid   lr_fid2;
3445         struct lu_fid   lr_fid3;
3446         __u64           lr_padding_1;
3447         __u64           lr_padding_2;
3448 };
3449
3450 struct lfsck_reply {
3451         __u32           lr_status;
3452         __u32           lr_padding_1;
3453         __u64           lr_repaired;
3454 };
3455
3456 enum lfsck_events {
3457         LE_LASTID_REBUILDING    = 1,
3458         LE_LASTID_REBUILT       = 2,
3459         LE_PHASE1_DONE          = 3,
3460         LE_PHASE2_DONE          = 4,
3461         LE_START                = 5,
3462         LE_STOP                 = 6,
3463         LE_QUERY                = 7,
3464         LE_FID_ACCESSED         = 8,
3465         LE_PEER_EXIT            = 9,
3466         LE_CONDITIONAL_DESTROY  = 10,
3467         LE_PAIRS_VERIFY         = 11,
3468         LE_SKIP_NLINK_DECLARE   = 13,
3469         LE_SKIP_NLINK           = 14,
3470         LE_SET_LMV_MASTER       = 15,
3471         LE_SET_LMV_SLAVE        = 16,
3472 };
3473
3474 enum lfsck_event_flags {
3475         LEF_TO_OST              = 0x00000001,
3476         LEF_FROM_OST            = 0x00000002,
3477         LEF_SET_LMV_HASH        = 0x00000004,
3478         LEF_SET_LMV_ALL         = 0x00000008,
3479         LEF_RECHECK_NAME_HASH   = 0x00000010,
3480         LEF_QUERY_ALL           = 0x00000020,
3481 };
3482
3483 static inline void lustre_set_wire_obdo(const struct obd_connect_data *ocd,
3484                                         struct obdo *wobdo,
3485                                         const struct obdo *lobdo)
3486 {
3487         *wobdo = *lobdo;
3488         wobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3489         if (ocd == NULL)
3490                 return;
3491
3492         if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3493             fid_seq_is_echo(ostid_seq(&lobdo->o_oi))) {
3494                 /* Currently OBD_FL_OSTID will only be used when 2.4 echo
3495                  * client communicate with pre-2.4 server */
3496                 wobdo->o_oi.oi.oi_id = fid_oid(&lobdo->o_oi.oi_fid);
3497                 wobdo->o_oi.oi.oi_seq = fid_seq(&lobdo->o_oi.oi_fid);
3498         }
3499 }
3500
3501 static inline void lustre_get_wire_obdo(const struct obd_connect_data *ocd,
3502                                         struct obdo *lobdo,
3503                                         const struct obdo *wobdo)
3504 {
3505         __u32 local_flags = 0;
3506
3507         if (lobdo->o_valid & OBD_MD_FLFLAGS)
3508                  local_flags = lobdo->o_flags & OBD_FL_LOCAL_MASK;
3509
3510         *lobdo = *wobdo;
3511         if (local_flags != 0) {
3512                 lobdo->o_valid |= OBD_MD_FLFLAGS;
3513                 lobdo->o_flags &= ~OBD_FL_LOCAL_MASK;
3514                 lobdo->o_flags |= local_flags;
3515         }
3516         if (ocd == NULL)
3517                 return;
3518
3519         if (unlikely(!(ocd->ocd_connect_flags & OBD_CONNECT_FID)) &&
3520             fid_seq_is_echo(wobdo->o_oi.oi.oi_seq)) {
3521                 /* see above */
3522                 lobdo->o_oi.oi_fid.f_seq = wobdo->o_oi.oi.oi_seq;
3523                 lobdo->o_oi.oi_fid.f_oid = wobdo->o_oi.oi.oi_id;
3524                 lobdo->o_oi.oi_fid.f_ver = 0;
3525         }
3526 }
3527
3528 /* request structure for OST's */
3529 struct ost_body {
3530         struct  obdo oa;
3531 };
3532
3533 /* Key for FIEMAP to be used in get_info calls */
3534 struct ll_fiemap_info_key {
3535         char            lfik_name[8];
3536         struct obdo     lfik_oa;
3537         struct fiemap   lfik_fiemap;
3538 };
3539
3540 void lustre_print_user_md(unsigned int level, struct lov_user_md *lum,
3541                           const char *msg);
3542
3543 /* Functions for dumping PTLRPC fields */
3544 void dump_rniobuf(struct niobuf_remote *rnb);
3545 void dump_ioo(struct obd_ioobj *nb);
3546 void dump_obdo(struct obdo *oa);
3547 void dump_ost_body(struct ost_body *ob);
3548 void dump_rcs(__u32 *rc);
3549
3550 #define IDX_INFO_MAGIC 0x3D37CC37
3551
3552 /* Index file transfer through the network. The server serializes the index into
3553  * a byte stream which is sent to the client via a bulk transfer */
3554 struct idx_info {
3555         __u32           ii_magic;
3556
3557         /* reply: see idx_info_flags below */
3558         __u32           ii_flags;
3559
3560         /* request & reply: number of lu_idxpage (to be) transferred */
3561         __u16           ii_count;
3562         __u16           ii_pad0;
3563
3564         /* request: requested attributes passed down to the iterator API */
3565         __u32           ii_attrs;
3566
3567         /* request & reply: index file identifier (FID) */
3568         struct lu_fid   ii_fid;
3569
3570         /* reply: version of the index file before starting to walk the index.
3571          * Please note that the version can be modified at any time during the
3572          * transfer */
3573         __u64           ii_version;
3574
3575         /* request: hash to start with:
3576          * reply: hash of the first entry of the first lu_idxpage and hash
3577          *        of the entry to read next if any */
3578         __u64           ii_hash_start;
3579         __u64           ii_hash_end;
3580
3581         /* reply: size of keys in lu_idxpages, minimal one if II_FL_VARKEY is
3582          * set */
3583         __u16           ii_keysize;
3584
3585         /* reply: size of records in lu_idxpages, minimal one if II_FL_VARREC
3586          * is set */
3587         __u16           ii_recsize;
3588
3589         __u32           ii_pad1;
3590         __u64           ii_pad2;
3591         __u64           ii_pad3;
3592 };
3593
3594 #define II_END_OFF      MDS_DIR_END_OFF /* all entries have been read */
3595
3596 /* List of flags used in idx_info::ii_flags */
3597 enum idx_info_flags {
3598         II_FL_NOHASH    = 1 << 0, /* client doesn't care about hash value */
3599         II_FL_VARKEY    = 1 << 1, /* keys can be of variable size */
3600         II_FL_VARREC    = 1 << 2, /* records can be of variable size */
3601         II_FL_NONUNQ    = 1 << 3, /* index supports non-unique keys */
3602         II_FL_NOKEY     = 1 << 4, /* client doesn't care about key */
3603 };
3604
3605 #define LIP_MAGIC 0x8A6D6B6C
3606
3607 /* 4KB (= LU_PAGE_SIZE) container gathering key/record pairs */
3608 struct lu_idxpage {
3609         /* 16-byte header */
3610         __u32   lip_magic;
3611         __u16   lip_flags;
3612         __u16   lip_nr;   /* number of entries in the container */
3613         __u64   lip_pad0; /* additional padding for future use */
3614
3615         /* key/record pairs are stored in the remaining 4080 bytes.
3616          * depending upon the flags in idx_info::ii_flags, each key/record
3617          * pair might be preceded by:
3618          * - a hash value
3619          * - the key size (II_FL_VARKEY is set)
3620          * - the record size (II_FL_VARREC is set)
3621          *
3622          * For the time being, we only support fixed-size key & record. */
3623         char    lip_entries[0];
3624 };
3625
3626 #define LIP_HDR_SIZE (offsetof(struct lu_idxpage, lip_entries))
3627
3628 /* Gather all possible type associated with a 4KB container */
3629 union lu_page {
3630         struct lu_dirpage       lp_dir; /* for MDS_READPAGE */
3631         struct lu_idxpage       lp_idx; /* for OBD_IDX_READ */
3632         char                    lp_array[LU_PAGE_SIZE];
3633 };
3634
3635 /* security opcodes */
3636 typedef enum {
3637         SEC_CTX_INIT            = 801,
3638         SEC_CTX_INIT_CONT       = 802,
3639         SEC_CTX_FINI            = 803,
3640         SEC_LAST_OPC,
3641         SEC_FIRST_OPC           = SEC_CTX_INIT
3642 } sec_cmd_t;
3643
3644 /*
3645  * capa related definitions
3646  */
3647 #define CAPA_HMAC_MAX_LEN       64
3648 #define CAPA_HMAC_KEY_MAX_LEN   56
3649
3650 /* NB take care when changing the sequence of elements this struct,
3651  * because the offset info is used in find_capa() */
3652 struct lustre_capa {
3653         struct lu_fid   lc_fid;         /** fid */
3654         __u64           lc_opc;         /** operations allowed */
3655         __u64           lc_uid;         /** file owner */
3656         __u64           lc_gid;         /** file group */
3657         __u32           lc_flags;       /** HMAC algorithm & flags */
3658         __u32           lc_keyid;       /** key# used for the capability */
3659         __u32           lc_timeout;     /** capa timeout value (sec) */
3660         __u32           lc_expiry;      /** expiry time (sec) */
3661         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
3662 } __attribute__((packed));
3663
3664 /** lustre_capa::lc_opc */
3665 enum {
3666         CAPA_OPC_BODY_WRITE   = 1<<0,  /**< write object data */
3667         CAPA_OPC_BODY_READ    = 1<<1,  /**< read object data */
3668         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /**< lookup object fid */
3669         CAPA_OPC_INDEX_INSERT = 1<<3,  /**< insert object fid */
3670         CAPA_OPC_INDEX_DELETE = 1<<4,  /**< delete object fid */
3671         CAPA_OPC_OSS_WRITE    = 1<<5,  /**< write oss object data */
3672         CAPA_OPC_OSS_READ     = 1<<6,  /**< read oss object data */
3673         CAPA_OPC_OSS_TRUNC    = 1<<7,  /**< truncate oss object */
3674         CAPA_OPC_OSS_DESTROY  = 1<<8,  /**< destroy oss object */
3675         CAPA_OPC_META_WRITE   = 1<<9,  /**< write object meta data */
3676         CAPA_OPC_META_READ    = 1<<10, /**< read object meta data */
3677 };
3678
3679 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
3680 #define CAPA_OPC_MDS_ONLY                                                   \
3681         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
3682          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
3683 #define CAPA_OPC_OSS_ONLY                                                   \
3684         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC |      \
3685          CAPA_OPC_OSS_DESTROY)
3686 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
3687 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
3688
3689 static inline bool lovea_slot_is_dummy(const struct lov_ost_data_v1 *obj)
3690 {
3691         /* zero area does not care about the bytes-order. */
3692         if (obj->l_ost_oi.oi.oi_id == 0 && obj->l_ost_oi.oi.oi_seq == 0 &&
3693             obj->l_ost_idx == 0 && obj->l_ost_gen == 0)
3694                 return true;
3695
3696         return false;
3697 }
3698
3699 /* lustre_capa::lc_hmac_alg */
3700 enum {
3701         CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
3702         CAPA_HMAC_ALG_MAX,
3703 };
3704
3705 #define CAPA_FL_MASK            0x00ffffff
3706 #define CAPA_HMAC_ALG_MASK      0xff000000
3707
3708 struct lustre_capa_key {
3709         __u64   lk_seq;       /**< mds# */
3710         __u32   lk_keyid;     /**< key# */
3711         __u32   lk_padding;
3712         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /**< key */
3713 } __attribute__((packed));
3714
3715 /** The link ea holds 1 \a link_ea_entry for each hardlink */
3716 #define LINK_EA_MAGIC 0x11EAF1DFUL
3717 struct link_ea_header {
3718         __u32 leh_magic;
3719         __u32 leh_reccount;
3720         __u64 leh_len;      /* total size */
3721         /* future use */
3722         __u32 padding1;
3723         __u32 padding2;
3724 };
3725
3726 /** Hardlink data is name and parent fid.
3727  * Stored in this crazy struct for maximum packing and endian-neutrality
3728  */
3729 struct link_ea_entry {
3730         /** __u16 stored big-endian, unaligned */
3731         unsigned char      lee_reclen[2];
3732         unsigned char      lee_parent_fid[sizeof(struct lu_fid)];
3733         char               lee_name[0];
3734 }__attribute__((packed));
3735
3736 /** fid2path request/reply structure */
3737 struct getinfo_fid2path {
3738         struct lu_fid   gf_fid;
3739         __u64           gf_recno;
3740         __u32           gf_linkno;
3741         __u32           gf_pathlen;
3742         char            gf_path[0];
3743 } __attribute__((packed));
3744
3745 /** path2parent request/reply structures */
3746 struct getparent {
3747         struct lu_fid   gp_fid;         /**< parent FID */
3748         __u32           gp_linkno;      /**< hardlink number */
3749         __u32           gp_name_size;   /**< size of the name field */
3750         char            gp_name[0];     /**< zero-terminated link name */
3751 } __attribute__((packed));
3752
3753 enum {
3754         LAYOUT_INTENT_ACCESS    = 0,
3755         LAYOUT_INTENT_READ      = 1,
3756         LAYOUT_INTENT_WRITE     = 2,
3757         LAYOUT_INTENT_GLIMPSE   = 3,
3758         LAYOUT_INTENT_TRUNC     = 4,
3759         LAYOUT_INTENT_RELEASE   = 5,
3760         LAYOUT_INTENT_RESTORE   = 6
3761 };
3762
3763 /* enqueue layout lock with intent */
3764 struct layout_intent {
3765         __u32 li_opc; /* intent operation for enqueue, read, write etc */
3766         __u32 li_flags;
3767         __u64 li_start;
3768         __u64 li_end;
3769 };
3770
3771 /**
3772  * On the wire version of hsm_progress structure.
3773  *
3774  * Contains the userspace hsm_progress and some internal fields.
3775  */
3776 struct hsm_progress_kernel {
3777         /* Field taken from struct hsm_progress */
3778         lustre_fid              hpk_fid;
3779         __u64                   hpk_cookie;
3780         struct hsm_extent       hpk_extent;
3781         __u16                   hpk_flags;
3782         __u16                   hpk_errval; /* positive val */
3783         __u32                   hpk_padding1;
3784         /* Additional fields */
3785         __u64                   hpk_data_version;
3786         __u64                   hpk_padding2;
3787 } __attribute__((packed));
3788
3789 /**
3790  * OUT_UPDATE RPC Format
3791  *
3792  * During the cross-ref operation, the Master MDT, which the client send the
3793  * request to, will disassembly the operation into object updates, then OSP
3794  * will send these updates to the remote MDT to be executed.
3795  *
3796  * An UPDATE_OBJ RPC does a list of updates.  Each update belongs to an
3797  * operation and does a type of modification to an object.
3798  *
3799  * Request Format
3800  *
3801  *   update_buf
3802  *   update (1st)
3803  *   update (2nd)
3804  *   ...
3805  *   update (ub_count-th)
3806  *
3807  * ub_count must be less than or equal to UPDATE_PER_RPC_MAX.
3808  *
3809  * Reply Format
3810  *
3811  *   update_reply
3812  *   rc [+ buffers] (1st)
3813  *   rc [+ buffers] (2st)
3814  *   ...
3815  *   rc [+ buffers] (nr_count-th)
3816  *
3817  * ur_count must be less than or equal to UPDATE_PER_RPC_MAX and should usually
3818  * be equal to ub_count.
3819  */
3820
3821 /**
3822  * Type of each update, if adding/deleting update, please also update
3823  * update_opcode in lustre/target/out_lib.c.
3824  */
3825 enum update_type {
3826         OUT_START               = 0,
3827         OUT_CREATE              = 1,
3828         OUT_DESTROY             = 2,
3829         OUT_REF_ADD             = 3,
3830         OUT_REF_DEL             = 4,
3831         OUT_ATTR_SET            = 5,
3832         OUT_ATTR_GET            = 6,
3833         OUT_XATTR_SET           = 7,
3834         OUT_XATTR_GET           = 8,
3835         OUT_INDEX_LOOKUP        = 9,
3836         OUT_INDEX_INSERT        = 10,
3837         OUT_INDEX_DELETE        = 11,
3838         OUT_WRITE               = 12,
3839         OUT_XATTR_DEL           = 13,
3840         OUT_PUNCH               = 14,
3841         OUT_READ                = 15,
3842         OUT_NOOP                = 16,
3843         OUT_LAST
3844 };
3845
3846 enum update_flag {
3847         UPDATE_FL_OST           = 0x00000001,   /* op from OST (not MDT) */
3848         UPDATE_FL_SYNC          = 0x00000002,   /* commit before replying */
3849         UPDATE_FL_COMMITTED     = 0x00000004,   /* op committed globally */
3850         UPDATE_FL_NOLOG         = 0x00000008    /* for idempotent updates */
3851 };
3852
3853 struct object_update_param {
3854         __u16   oup_len;        /* length of this parameter */
3855         __u16   oup_padding;
3856         __u32   oup_padding2;
3857         char    oup_buf[0];
3858 };
3859
3860 static inline size_t
3861 object_update_param_size(const struct object_update_param *param)
3862 {
3863         return cfs_size_round(sizeof(*param) + param->oup_len);
3864 }
3865
3866 /* object update */
3867 struct object_update {
3868         __u16           ou_type;                /* enum update_type */
3869         __u16           ou_params_count;        /* update parameters count */
3870         __u32           ou_result_size;         /* how many bytes can return */
3871         __u32           ou_flags;               /* enum update_flag */
3872         __u32           ou_padding1;            /* padding 1 */
3873         __u64           ou_batchid;             /* op transno on master */
3874         struct lu_fid   ou_fid;                 /* object to be updated */
3875         struct object_update_param ou_params[0]; /* update params */
3876 };
3877
3878 #define UPDATE_REQUEST_MAGIC_V1 0xBDDE0001
3879 #define UPDATE_REQUEST_MAGIC_V2 0xBDDE0002
3880 #define UPDATE_REQUEST_MAGIC    UPDATE_REQUEST_MAGIC_V2
3881 /* Hold object_updates sending to the remote OUT in single RPC */
3882 struct object_update_request {
3883         __u32                   ourq_magic;
3884         __u16                   ourq_count;     /* number of ourq_updates[] */
3885         __u16                   ourq_padding;
3886         struct object_update    ourq_updates[0];
3887 };
3888
3889 #define OUT_UPDATE_HEADER_MAGIC         0xBDDF0001
3890 #define OUT_UPDATE_MAX_INLINE_SIZE      4096
3891 /* Header for updates request between MDTs */
3892 struct out_update_header {
3893         __u32           ouh_magic;
3894         __u32           ouh_count;
3895         __u32           ouh_inline_length;
3896         __u32           ouh_reply_size;
3897         __u32           ouh_inline_data[0];
3898 };
3899
3900 struct out_update_buffer {
3901         __u32   oub_size;
3902         __u32   oub_padding;
3903 };
3904
3905 static inline size_t
3906 object_update_params_size(const struct object_update *update)
3907 {
3908         const struct object_update_param *param;
3909         size_t                           total_size = 0;
3910         unsigned int                     i;
3911
3912         param = &update->ou_params[0];
3913         for (i = 0; i < update->ou_params_count; i++) {
3914                 size_t size = object_update_param_size(param);
3915
3916                 param = (struct object_update_param *)((char *)param + size);
3917                 total_size += size;
3918         }
3919
3920         return total_size;
3921 }
3922
3923 static inline size_t
3924 object_update_size(const struct object_update *update)
3925 {
3926         return offsetof(struct object_update, ou_params[0]) +
3927                object_update_params_size(update);
3928 }
3929
3930 static inline struct object_update *
3931 object_update_request_get(const struct object_update_request *our,
3932                           unsigned int index, size_t *size)
3933 {
3934         void    *ptr;
3935         unsigned int i;
3936
3937         if (index >= our->ourq_count)
3938                 return NULL;
3939
3940         ptr = (void *)&our->ourq_updates[0];
3941         for (i = 0; i < index; i++)
3942                 ptr += object_update_size(ptr);
3943
3944         if (size != NULL)
3945                 *size = object_update_size(ptr);
3946
3947         return ptr;
3948 }
3949
3950
3951 /* the result of object update */
3952 struct object_update_result {
3953         __u32   our_rc;
3954         __u16   our_datalen;
3955         __u16   our_padding;
3956         __u32   our_data[0];
3957 };
3958
3959 #define UPDATE_REPLY_MAGIC_V1   0x00BD0001
3960 #define UPDATE_REPLY_MAGIC_V2   0x00BD0002
3961 #define UPDATE_REPLY_MAGIC      UPDATE_REPLY_MAGIC_V2
3962 /* Hold object_update_results being replied from the remote OUT. */
3963 struct object_update_reply {
3964         __u32   ourp_magic;
3965         __u16   ourp_count;
3966         __u16   ourp_padding;
3967         __u16   ourp_lens[0];
3968 };
3969
3970 static inline struct object_update_result *
3971 object_update_result_get(const struct object_update_reply *reply,
3972                          unsigned int index, size_t *size)
3973 {
3974         __u16 count = reply->ourp_count;
3975         unsigned int i;
3976         void *ptr;
3977
3978         if (index >= count)
3979                 return NULL;
3980
3981         ptr = (char *)reply +
3982               cfs_size_round(offsetof(struct object_update_reply,
3983                                       ourp_lens[count]));
3984         for (i = 0; i < index; i++) {
3985                 if (reply->ourp_lens[i] == 0)
3986                         return NULL;
3987
3988                 ptr += cfs_size_round(reply->ourp_lens[i]);
3989         }
3990
3991         if (size != NULL)
3992                 *size = reply->ourp_lens[index];
3993
3994         return ptr;
3995 }
3996
3997 /* read update result */
3998 struct out_read_reply {
3999         __u32   orr_size;
4000         __u32   orr_padding;
4001         __u64   orr_offset;
4002         char    orr_data[0];
4003 };
4004
4005 static inline void orr_cpu_to_le(struct out_read_reply *orr_dst,
4006                                  const struct out_read_reply *orr_src)
4007 {
4008         orr_dst->orr_size = cpu_to_le32(orr_src->orr_size);
4009         orr_dst->orr_padding = cpu_to_le32(orr_src->orr_padding);
4010         orr_dst->orr_offset = cpu_to_le64(orr_dst->orr_offset);
4011 }
4012
4013 static inline void orr_le_to_cpu(struct out_read_reply *orr_dst,
4014                                  const struct out_read_reply *orr_src)
4015 {
4016         orr_dst->orr_size = le32_to_cpu(orr_src->orr_size);
4017         orr_dst->orr_padding = le32_to_cpu(orr_src->orr_padding);
4018         orr_dst->orr_offset = le64_to_cpu(orr_dst->orr_offset);
4019 }
4020
4021 /** layout swap request structure
4022  * fid1 and fid2 are in mdt_body
4023  */
4024 struct mdc_swap_layouts {
4025         __u64           msl_flags;
4026 } __packed;
4027
4028 struct close_data {
4029         struct lustre_handle    cd_handle;
4030         struct lu_fid           cd_fid;
4031         __u64                   cd_data_version;
4032         __u64                   cd_reserved[8];
4033 };
4034
4035 /* Update llog format */
4036 struct update_op {
4037         struct lu_fid   uop_fid;
4038         __u16           uop_type;
4039         __u16           uop_param_count;
4040         __u16           uop_params_off[0];
4041 };
4042
4043 struct update_ops {
4044         struct update_op        uops_op[0];
4045 };
4046
4047 struct update_params {
4048         struct object_update_param      up_params[0];
4049 };
4050
4051 enum update_records_flag {
4052         UPDATE_RECORD_CONTINUE = 1 >> 0,
4053 };
4054 /*
4055  * This is the update record format used to store the updates in
4056  * disk. All updates of the operation will be stored in ur_ops.
4057  * All of parameters for updates of the operation will be stored
4058  * in ur_params.
4059  * To save the space of the record, parameters in ur_ops will only
4060  * remember their offset in ur_params, so to avoid storing duplicate
4061  * parameters in ur_params, which can help us save a lot space for
4062  * operation like creating striped directory.
4063  */
4064 struct update_records {
4065         __u64                   ur_master_transno;
4066         __u64                   ur_batchid;
4067         __u32                   ur_flags;
4068         /* If the operation includes multiple updates, then ur_index
4069          * means the index of the update inside the whole updates. */
4070         __u32                   ur_index;
4071         __u32                   ur_update_count;
4072         __u32                   ur_param_count;
4073         struct update_ops       ur_ops;
4074          /* Note ur_ops has a variable size, so comment out
4075           * the following ur_params, in case some use it directly
4076           * update_records->ur_params
4077           *
4078           * struct update_params        ur_params;
4079           */
4080 };
4081
4082 struct llog_update_record {
4083         struct llog_rec_hdr     lur_hdr;
4084         struct update_records   lur_update_rec;
4085         /* Note ur_update_rec has a variable size, so comment out
4086         * the following ur_tail, in case someone use it directly
4087         *
4088         * struct llog_rec_tail lur_tail;
4089         */
4090 };
4091
4092 /* nodemap records, uses 32 byte record length */
4093 #define LUSTRE_NODEMAP_NAME_LENGTH 16
4094 struct nodemap_cluster_rec {
4095         char    ncr_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
4096         __u8    ncr_flags;
4097         __u16   ncr_padding1;
4098         __u32   ncr_padding2;
4099         __u32   ncr_squash_uid;
4100         __u32   ncr_squash_gid;
4101 };
4102
4103 /* lnet_nid_t is 8 bytes */
4104 struct nodemap_range_rec {
4105         lnet_nid_t      nrr_start_nid;
4106         lnet_nid_t      nrr_end_nid;
4107         __u64           nrr_padding1;
4108         __u64           nrr_padding2;
4109 };
4110
4111 struct nodemap_id_rec {
4112         __u32   nir_id_fs;
4113         __u32   nir_padding1;
4114         __u64   nir_padding2;
4115         __u64   nir_padding3;
4116         __u64   nir_padding4;
4117 };
4118
4119 struct nodemap_global_rec {
4120         __u8    ngr_is_active;
4121         __u8    ngr_padding1;
4122         __u16   ngr_padding2;
4123         __u32   ngr_padding3;
4124         __u64   ngr_padding4;
4125         __u64   ngr_padding5;
4126         __u64   ngr_padding6;
4127 };
4128
4129 union nodemap_rec {
4130         struct nodemap_cluster_rec ncr;
4131         struct nodemap_range_rec nrr;
4132         struct nodemap_id_rec nir;
4133         struct nodemap_global_rec ngr;
4134 };
4135
4136 #endif
4137 /** @} lustreidl */