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