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