drivers/staging/lustre/lustre/include/lustre/lustre_idl.h

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