lustre/include/lustre/lustre_idl.h

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