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